Question about ParameterTool

[Marco Villalobos-2]

What are the dangers of not using the ParameterTool for parsing command line parameters?

I have been using Picocli (https://picocli.info/). Will this be a mistake? Are there any side-effects that I should be aware of?

[rmetzger0]

Hi,

there are absolutely no dangers not using ParameterTool.

It is used by the Flink examples, and as a showcase for global job parameters: https://ci.apache.org/projects/flink/flink-docs-release-1.2/monitoring/best_practices.html#register-the-parameters-globally

On Tue, Aug 11, 2020 at 7:13 PM Marco Villalobos <[hidden email]> wrote:

What are the dangers of not using the ParameterTool for parsing command line parameters?

I have been using Picocli (https://picocli.info/). Will this be a mistake? Are there any side-effects that I should be aware of?

[Marco Villalobos-2]

Thank you for the clarification. 

But does it offer any additional benefits that are not clearly documented?

On Tue, Aug 11, 2020 at 12:22 PM Robert Metzger <[hidden email]> wrote:

Hi,

there are absolutely no dangers not using ParameterTool.

It is used by the Flink examples, and as a showcase for global job parameters: https://ci.apache.org/projects/flink/flink-docs-release-1.2/monitoring/best_practices.html#register-the-parameters-globally

On Tue, Aug 11, 2020 at 7:13 PM Marco Villalobos <[hidden email]> wrote:

What are the dangers of not using the ParameterTool for parsing command line parameters?

I have been using Picocli (https://picocli.info/). Will this be a mistake? Are there any side-effects that I should be aware of?

[Chesnay Schepler]

The benefit of the ParameterTool is that you do not increase your dependency footprint by using it.

When using another CLI library you will generally package it within your user-jar, which may or may not increase the risk of dependency conflicts.

Whether, and how large this risk is, depends naturally on the library.

This also results in a larger jar file, which may or may not be relevant for you.

On 11/08/2020 23:35, Marco Villalobos wrote:

Thank you for the clarification. 

But does it offer any additional benefits that are not clearly documented?

On Tue, Aug 11, 2020 at 12:22 PM Robert Metzger <[hidden email]> wrote:

Hi,

there are absolutely no dangers not using ParameterTool.

It is used by the Flink examples, and as a showcase for global job parameters: https://ci.apache.org/projects/flink/flink-docs-release-1.2/monitoring/best_practices.html#register-the-parameters-globally

On Tue, Aug 11, 2020 at 7:13 PM Marco Villalobos <[hidden email]> wrote:

What are the dangers of not using the ParameterTool for parsing command line parameters?

I have been using Picocli (https://picocli.info/). Will this be a mistake? Are there any side-effects that I should be aware of?

[Arvid Heise-3]

Since Picocli does not have any dependencies on its own, it's safe to use. It's a bit quirky to use with Scala, but it's imho the best CLI library for java.

The only downside as Chesnay mentioned is the increased jar size. Also note that Flink is not graal-ready.

Best,

Arvid

On Wed, Aug 12, 2020 at 12:27 AM Chesnay Schepler <[hidden email]> wrote:

The benefit of the ParameterTool is that you do not increase your dependency footprint by using it.

When using another CLI library you will generally package it within your user-jar, which may or may not increase the risk of dependency conflicts.

Whether, and how large this risk is, depends naturally on the library.

This also results in a larger jar file, which may or may not be relevant for you.

On 11/08/2020 23:35, Marco Villalobos wrote:

Thank you for the clarification. 

But does it offer any additional benefits that are not clearly documented?

On Tue, Aug 11, 2020 at 12:22 PM Robert Metzger <[hidden email]> wrote:

Hi,

there are absolutely no dangers not using ParameterTool.

It is used by the Flink examples, and as a showcase for global job parameters: https://ci.apache.org/projects/flink/flink-docs-release-1.2/monitoring/best_practices.html#register-the-parameters-globally

On Tue, Aug 11, 2020 at 7:13 PM Marco Villalobos <[hidden email]> wrote:

What are the dangers of not using the ParameterTool for parsing command line parameters?

I have been using Picocli (https://picocli.info/). Will this be a mistake? Are there any side-effects that I should be aware of?

--