pyTooling.CLIAbstraction.Argument

This module implements command line arguments without prefix character(s).

Variables

Classes


Variables

pyTooling.CLIAbstraction.Argument.ValueT

The type of value in a valued argument.

~ValueT

Classes

class pyTooling.CLIAbstraction.Argument.CommandLineArgument[source]

Base-class for all Argument classes.

An argument instance can be converted via AsArgument to a single string value or a sequence of string values (tuple) usable e.g. with subprocess.Popen. Each argument class implements at least one pattern parameter to specify how argument are formatted.

There are multiple derived formats supporting:

Inheritance

Inheritance diagram of CommandLineArgument

static __new__(cls, *args, **kwargs)[source]
Parameters:
abstractmethod AsArgument()[source]

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:

NotImplementedError – This is an abstract method and must be overwritten by a subclass.

abstractmethod __str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

Raises:

NotImplementedError – This is an abstract method and must be overwritten by a subclass.

abstractmethod __repr__()[source]

Return a string representation of this argument instance.

Note

By default, this method is identical to __str__().

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

Raises:

NotImplementedError – This is an abstract method and must be overwritten by a subclass.

class pyTooling.CLIAbstraction.Argument.ExecutableArgument[source]

Represents the executable.

Inheritance

Inheritance diagram of ExecutableArgument

__init__(executable)[source]

Initializes a ExecutableArgument instance.

Parameters:

executable (Path) – Path to the executable.

Raises:

TypeError – If parameter ‘executable’ is not of type Path.

Return type:

None

property Executable: Path

Get the internal path to the wrapped executable.

Returns:

Internal path to the executable.

AsArgument()[source]

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

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

__str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

static __new__(cls, *args, **kwargs)
Parameters:
class pyTooling.CLIAbstraction.Argument.DelimiterArgument[source]

Represents a delimiter symbol like --.

Inheritance

Inheritance diagram of DelimiterArgument

AsArgument()[source]

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

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

__str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

static __new__(cls, *args, **kwargs)
Parameters:
class pyTooling.CLIAbstraction.Argument.NamedArgument[source]

Base-class for all command line arguments with a name.

Inheritance

Inheritance diagram of NamedArgument

static __new__(cls, *args, **kwargs)[source]
Parameters:
property Name: str

Get the internal name.

Returns:

Internal name.

AsArgument()[source]

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.

__str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

class pyTooling.CLIAbstraction.Argument.ValuedArgument[source]

Base-class for all command line arguments with a value.

Inheritance

Inheritance diagram of ValuedArgument

__init__(value)[source]

Initializes a ValuedArgument instance.

Parameters:

value (TypeVar(ValueT)) – Value to be stored internally.

Raises:

TypeError – If parameter ‘value’ is None.

Return type:

None

property Value: ValueT

Get the internal value.

Returns:

Internal value.

AsArgument()[source]

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

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

__str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

static __new__(cls, *args, **kwargs)
Parameters:
class pyTooling.CLIAbstraction.Argument.StringArgument[source]

Represents a simple string argument.

A list of strings is available as StringListArgument.

Inheritance

Inheritance diagram of StringArgument

AsArgument()

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

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

property Value: ValueT

Get the internal value.

Returns:

Internal value.

__init__(value)

Initializes a ValuedArgument instance.

Parameters:

value (TypeVar(ValueT)) – Value to be stored internally.

Raises:

TypeError – If parameter ‘value’ is None.

Return type:

None

static __new__(cls, *args, **kwargs)
Parameters:
__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.Argument.StringListArgument[source]

Represents a list of string argument (StringArgument).

Inheritance

Inheritance diagram of StringListArgument

__init__(values)[source]

Initializes a StringListArgument instance.

Parameters:

values (Iterable[str]) – An iterable of str instances.

Raises:

TypeError – If iterable parameter ‘values’ contains elements not of type str.

Return type:

None

property Value: List[str]

Get the internal list of str objects.

Returns:

Reference to the internal list of str objects.

AsArgument()[source]

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

Return type:

Union[str, Iterable[str]]

Returns:

Sequence of formatted arguments.

__str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Space separated sequence of arguments formatted and each enclosed in double quotes.

__repr__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Comma separated sequence of arguments formatted and each enclosed in double quotes.

static __new__(cls, *args, **kwargs)
Parameters:
class pyTooling.CLIAbstraction.Argument.PathArgument[source]

Represents a single path argument.

A list of paths is available as PathListArgument.

Inheritance

Inheritance diagram of PathArgument

__init__(path)[source]

Initializes a PathArgument instance.

Parameters:

path (Path) – Path to a filesystem object.

Raises:

TypeError – If parameter ‘path’ is not of type Path.

Return type:

None

property Value: Path

Get the internal path object.

Returns:

Internal path object.

AsArgument()[source]

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

Return type:

Union[str, Iterable[str]]

Returns:

Formatted argument.

__str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

__repr__()

Return a string representation of this argument instance.

Return type:

str

Returns:

Argument formatted and enclosed in double quotes.

static __new__(cls, *args, **kwargs)
Parameters:
class pyTooling.CLIAbstraction.Argument.PathListArgument[source]

Represents a list of path arguments (PathArgument).

Inheritance

Inheritance diagram of PathListArgument

static __new__(cls, *args, **kwargs)
Parameters:
__init__(paths)[source]

Initializes a PathListArgument instance.

Parameters:

paths (Iterable[Path]) – An iterable os Path instances.

Raises:

TypeError – If iterable parameter ‘paths’ contains elements not of type Path.

Return type:

None

property Value: List[Path]

Get the internal list of path objects.

Returns:

Reference to the internal list of path objects.

AsArgument()[source]

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

Return type:

Union[str, Iterable[str]]

Returns:

Sequence of formatted arguments.

__str__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Space separated sequence of arguments formatted and each enclosed in double quotes.

__repr__()[source]

Return a string representation of this argument instance.

Return type:

str

Returns:

Comma separated sequence of arguments formatted and each enclosed in double quotes.