pyTooling.CLIAbstraction.KeyValueFlag

Flag arguments represent simple boolean values by being present or absent.

See also

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

• For flags with a value.
  → ValuedFlag

• For flags that have an optional value.
  → NamedOptionalValuedFlag

Classes

• NamedKeyValuePairsArgument: Class and base-class for all KeyValueFlag classes, which represents a flag argument with key and value

• ShortKeyValueFlag: Represents a NamedKeyValueFlagArgument with a single dash in front of the switch name.

• LongKeyValueFlag: Represents a NamedKeyValueFlagArgument with a double dash in front of the switch name.

• WindowsKeyValueFlag: Represents a NamedKeyValueFlagArgument with a double dash in front of the switch name.

---

Classes

class pyTooling.CLIAbstraction.KeyValueFlag.NamedKeyValuePairsArgument

Class and base-class for all KeyValueFlag classes, which represents a flag argument with key and value (key-value-pairs).

An optional 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. If the value is None, no delimiter sign and value is passed.

Example:

• -gWidth=100

Inheritance

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

Parameters:

• args (Any)

• kwargs (Any)

__init__(keyValuePairs)

Parameters:

keyValuePairs (Dict[str, str])

Return type:

None

property Value: Dict[str, str]

Get the internal value.

Returns:

Internal value.

AsArgument()

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

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.

__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.KeyValueFlag.ShortKeyValueFlag

Represents a NamedKeyValueFlagArgument with a single dash in front of the switch name.

Example:

• -DDEBUG=TRUE

Inheritance

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.

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: Dict[str, str]

Get the internal value.

Returns:

Internal value.

__init__(keyValuePairs)

Parameters:

keyValuePairs (Dict[str, str])

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.KeyValueFlag.LongKeyValueFlag

Represents a NamedKeyValueFlagArgument with a double dash in front of the switch name.

Example:

• --DDEBUG=TRUE

Inheritance

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.

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: Dict[str, str]

Get the internal value.

Returns:

Internal value.

__init__(keyValuePairs)

Parameters:

keyValuePairs (Dict[str, str])

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.KeyValueFlag.WindowsKeyValueFlag

Represents a NamedKeyValueFlagArgument with a double dash in front of the switch name.

Example:

• --DDEBUG=TRUE

Inheritance

AsArgument()

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

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: Dict[str, str]

Get the internal value.

Returns:

Internal value.

__init__(keyValuePairs)

Parameters:

keyValuePairs (Dict[str, str])

Return type:

None

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

Parameters:

• args (Any)

• kwargs (Any)

__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.