pyTooling.CLIAbstraction.ValuedFlag

Valued flags are arguments with a name and an always present value.

The usual delimiter sign between name and value is an equal sign (=).

See also

• For simple flags.
  → Flag

• For flags with different pattern based on the boolean value itself.
  → BooleanFlag

• For flags that have an optional value.
  → NamedOptionalValuedFlag

• For list of valued flags.
  → ValuedFlagList

Classes

• ValuedFlag: Class and base-class for all ValuedFlag classes, which represents a flag argument with value.

• ShortValuedFlag: Represents a ValuedFlagArgument with a single dash.

• LongValuedFlag: Represents a ValuedFlagArgument with a double dash.

• WindowsValuedFlag: Represents a ValuedFlagArgument with a single slash.

---

Classes

class pyTooling.CLIAbstraction.ValuedFlag.ValuedFlag(value)

Class and base-class for all ValuedFlag classes, which represents a flag argument with value.

A valued flag is a flag name followed by a value. The default delimiter sign is equal (=). Name and value are passed as one argument to the executable even if the delimiter sign is a whitespace character.

Example:

• width=100

Inheritance

Parameters:

• args (Any)

• kwargs (Any)

classmethod __init_subclass__(*args, pattern='{0}={1}', **kwargs)

This method is called when a class is derived.

Parameters:

• args (Any) – Any positional arguments.

• pattern (str) – This pattern is used to format an argument.

• kwargs (Any) – Any keyword argument.

static __new__(cls, *args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

AsArgument()

Convert this argument instance to a string representation with proper escaping using the matching pattern based on the internal name and value.

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

Raises:

ValueError – If internal name is None.

property Name: str

Get the internal name.

Returns:

Internal name.

property Value: ValueT

Get the internal value.

Returns:

Internal value.

__class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

__init__(value)

Parameters:

value (ValueT)

Return type:

None

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__str__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

class pyTooling.CLIAbstraction.ValuedFlag.ShortValuedFlag(value)

Represents a ValuedFlagArgument with a single dash.

Example:

• -optimizer=on

Inheritance

Parameters:

• args (Any)

• kwargs (Any)

classmethod __init_subclass__(*args, pattern='-{0}={1}', **kwargs)

This method is called when a class is derived.

Parameters:

• args (Any) – Any positional arguments.

• pattern (str) – This pattern is used to format an argument.

• kwargs (Any) – Any keyword argument.

static __new__(cls, *args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

AsArgument()

Convert this argument instance to a string representation with proper escaping using the matching pattern based on the internal name and value.

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

Raises:

ValueError – If internal name is None.

property Name: str

Get the internal name.

Returns:

Internal name.

property Value: ValueT

Get the internal value.

Returns:

Internal value.

__class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

__init__(value)

Parameters:

value (ValueT)

Return type:

None

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__str__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

class pyTooling.CLIAbstraction.ValuedFlag.LongValuedFlag(value)

Represents a ValuedFlagArgument with a double dash.

Example:

• --optimizer=on

Inheritance

Parameters:

• args (Any)

• kwargs (Any)

classmethod __init_subclass__(*args, pattern='--{0}={1}', **kwargs)

This method is called when a class is derived.

Parameters:

• args (Any) – Any positional arguments.

• pattern (str) – This pattern is used to format an argument.

• kwargs (Any) – Any keyword argument.

static __new__(cls, *args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

AsArgument()

Convert this argument instance to a string representation with proper escaping using the matching pattern based on the internal name and value.

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

Raises:

ValueError – If internal name is None.

property Name: str

Get the internal name.

Returns:

Internal name.

property Value: ValueT

Get the internal value.

Returns:

Internal value.

__class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

__init__(value)

Parameters:

value (ValueT)

Return type:

None

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__str__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

class pyTooling.CLIAbstraction.ValuedFlag.WindowsValuedFlag(value)

Represents a ValuedFlagArgument with a single slash.

Example:

• /optimizer:on

Inheritance

Parameters:

• args (Any)

• kwargs (Any)

classmethod __init_subclass__(*args, pattern='/{0}:{1}', **kwargs)

This method is called when a class is derived.

Parameters:

• args (Any) – Any positional arguments.

• pattern (str) – This pattern is used to format an argument.

• kwargs (Any) – Any keyword argument.

static __new__(cls, *args, **kwargs)

Parameters:

• args (Any)

• kwargs (Any)

AsArgument()

Convert this argument instance to a string representation with proper escaping using the matching pattern based on the internal name and value.

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

Raises:

ValueError – If internal name is None.

property Name: str

Get the internal name.

Returns:

Internal name.

property Value: ValueT

Get the internal value.

Returns:

Internal value.

__class_getitem__()

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo[T]: ….

__init__(value)

Parameters:

value (ValueT)

Return type:

None

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__str__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.