pyTooling.CLIAbstraction

Submodules

• pyTooling.CLIAbstraction.Argument
  • CommandLineArgument
    • CommandLineArgument.__init_subclass__()
    • CommandLineArgument.__new__()
    • CommandLineArgument.AsArgument()
    • CommandLineArgument.__str__()
    • CommandLineArgument.__repr__()
  • ExecutableArgument
    • ExecutableArgument.__init__()
    • ExecutableArgument.Executable
    • ExecutableArgument.AsArgument()
    • ExecutableArgument.__str__()
    • ExecutableArgument.__repr__()
    • ExecutableArgument.__init_subclass__()
    • ExecutableArgument.__new__()
  • DelimiterArgument
    • DelimiterArgument.__init_subclass__()
    • DelimiterArgument.AsArgument()
    • DelimiterArgument.__str__()
    • DelimiterArgument.__repr__()
    • DelimiterArgument.__new__()
  • NamedArgument
    • NamedArgument.__init_subclass__()
    • NamedArgument.__new__()
    • NamedArgument.Name
    • NamedArgument.AsArgument()
    • NamedArgument.__str__()
    • NamedArgument.__repr__()
  • ValuedArgument
    • ValuedArgument.__init_subclass__()
    • ValuedArgument.__init__()
    • ValuedArgument.Value
    • ValuedArgument.AsArgument()
    • ValuedArgument.__str__()
    • ValuedArgument.__repr__()
    • ValuedArgument.__new__()
  • StringArgument
    • StringArgument.__init_subclass__()
    • StringArgument.AsArgument()
    • StringArgument.Value
    • StringArgument.__init__()
    • StringArgument.__new__()
    • StringArgument.__repr__()
    • StringArgument.__str__()
  • StringListArgument
    • StringListArgument.__init__()
    • StringListArgument.Value
    • StringListArgument.AsArgument()
    • StringListArgument.__str__()
    • StringListArgument.__repr__()
    • StringListArgument.__init_subclass__()
    • StringListArgument.__new__()
  • PathArgument
    • PathArgument.__init__()
    • PathArgument.Value
    • PathArgument.AsArgument()
    • PathArgument.__str__()
    • PathArgument.__repr__()
    • PathArgument.__init_subclass__()
    • PathArgument.__new__()
  • PathListArgument
    • PathListArgument.__init_subclass__()
    • PathListArgument.__new__()
    • PathListArgument.__init__()
    • PathListArgument.Value
    • PathListArgument.AsArgument()
    • PathListArgument.__str__()
    • PathListArgument.__repr__()
  • ValueT
• pyTooling.CLIAbstraction.BooleanFlag
  • BooleanFlag
    • BooleanFlag.__init_subclass__()
    • BooleanFlag.__new__()
    • BooleanFlag.__init__()
    • BooleanFlag.AsArgument()
    • BooleanFlag.Name
    • BooleanFlag.Value
    • BooleanFlag.__repr__()
    • BooleanFlag.__str__()
  • ShortBooleanFlag
    • ShortBooleanFlag.__init_subclass__()
    • ShortBooleanFlag.__new__()
    • ShortBooleanFlag.AsArgument()
    • ShortBooleanFlag.Name
    • ShortBooleanFlag.Value
    • ShortBooleanFlag.__init__()
    • ShortBooleanFlag.__repr__()
    • ShortBooleanFlag.__str__()
  • LongBooleanFlag
    • LongBooleanFlag.__init_subclass__()
    • LongBooleanFlag.__new__()
    • LongBooleanFlag.AsArgument()
    • LongBooleanFlag.Name
    • LongBooleanFlag.Value
    • LongBooleanFlag.__init__()
    • LongBooleanFlag.__repr__()
    • LongBooleanFlag.__str__()
  • WindowsBooleanFlag
    • WindowsBooleanFlag.__init_subclass__()
    • WindowsBooleanFlag.__new__()
    • WindowsBooleanFlag.AsArgument()
    • WindowsBooleanFlag.Name
    • WindowsBooleanFlag.Value
    • WindowsBooleanFlag.__init__()
    • WindowsBooleanFlag.__repr__()
    • WindowsBooleanFlag.__str__()
• pyTooling.CLIAbstraction.Command
  • CommandArgument
    • CommandArgument.__new__()
    • CommandArgument.AsArgument()
    • CommandArgument.Name
    • CommandArgument.__init_subclass__()
    • CommandArgument.__repr__()
    • CommandArgument.__str__()
  • ShortCommand
    • ShortCommand.__init_subclass__()
    • ShortCommand.__new__()
    • ShortCommand.AsArgument()
    • ShortCommand.Name
    • ShortCommand.__repr__()
    • ShortCommand.__str__()
  • LongCommand
    • LongCommand.__init_subclass__()
    • LongCommand.__new__()
    • LongCommand.AsArgument()
    • LongCommand.Name
    • LongCommand.__repr__()
    • LongCommand.__str__()
  • WindowsCommand
    • WindowsCommand.__init_subclass__()
    • WindowsCommand.__new__()
    • WindowsCommand.AsArgument()
    • WindowsCommand.Name
    • WindowsCommand.__repr__()
    • WindowsCommand.__str__()
• pyTooling.CLIAbstraction.Flag
  • FlagArgument
    • FlagArgument.__new__()
    • FlagArgument.AsArgument()
    • FlagArgument.Name
    • FlagArgument.__init_subclass__()
    • FlagArgument.__repr__()
    • FlagArgument.__str__()
  • ShortFlag
    • ShortFlag.__init_subclass__()
    • ShortFlag.__new__()
    • ShortFlag.AsArgument()
    • ShortFlag.Name
    • ShortFlag.__repr__()
    • ShortFlag.__str__()
  • LongFlag
    • LongFlag.__init_subclass__()
    • LongFlag.__new__()
    • LongFlag.AsArgument()
    • LongFlag.Name
    • LongFlag.__repr__()
    • LongFlag.__str__()
  • WindowsFlag
    • WindowsFlag.__init_subclass__()
    • WindowsFlag.__new__()
    • WindowsFlag.AsArgument()
    • WindowsFlag.Name
    • WindowsFlag.__repr__()
    • WindowsFlag.__str__()
• pyTooling.CLIAbstraction.KeyValueFlag
  • ShortKeyValueFlag
    • ShortKeyValueFlag.__init_subclass__()
    • ShortKeyValueFlag.__new__()
    • ShortKeyValueFlag.AsArgument()
    • ShortKeyValueFlag.Name
    • ShortKeyValueFlag.Value
    • ShortKeyValueFlag.__init__()
    • ShortKeyValueFlag.__repr__()
    • ShortKeyValueFlag.__str__()
  • LongKeyValueFlag
    • LongKeyValueFlag.__init_subclass__()
    • LongKeyValueFlag.__new__()
    • LongKeyValueFlag.AsArgument()
    • LongKeyValueFlag.Name
    • LongKeyValueFlag.Value
    • LongKeyValueFlag.__init__()
    • LongKeyValueFlag.__repr__()
    • LongKeyValueFlag.__str__()
  • WindowsKeyValueFlag
    • WindowsKeyValueFlag.__init_subclass__()
    • WindowsKeyValueFlag.AsArgument()
    • WindowsKeyValueFlag.Name
    • WindowsKeyValueFlag.Value
    • WindowsKeyValueFlag.__init__()
    • WindowsKeyValueFlag.__new__()
    • WindowsKeyValueFlag.__repr__()
    • WindowsKeyValueFlag.__str__()
• pyTooling.CLIAbstraction.OptionalValuedFlag
  • OptionalValuedFlag
    • OptionalValuedFlag.__init_subclass__()
    • OptionalValuedFlag.__new__()
    • OptionalValuedFlag.__init__()
    • OptionalValuedFlag.Value
    • OptionalValuedFlag.AsArgument()
    • OptionalValuedFlag.__str__()
    • OptionalValuedFlag.__repr__()
    • OptionalValuedFlag.Name
  • ShortOptionalValuedFlag
    • ShortOptionalValuedFlag.__init_subclass__()
    • ShortOptionalValuedFlag.__new__()
    • ShortOptionalValuedFlag.AsArgument()
    • ShortOptionalValuedFlag.Name
    • ShortOptionalValuedFlag.Value
    • ShortOptionalValuedFlag.__init__()
    • ShortOptionalValuedFlag.__repr__()
    • ShortOptionalValuedFlag.__str__()
  • LongOptionalValuedFlag
    • LongOptionalValuedFlag.__init_subclass__()
    • LongOptionalValuedFlag.__new__()
    • LongOptionalValuedFlag.AsArgument()
    • LongOptionalValuedFlag.Name
    • LongOptionalValuedFlag.Value
    • LongOptionalValuedFlag.__init__()
    • LongOptionalValuedFlag.__repr__()
    • LongOptionalValuedFlag.__str__()
  • WindowsOptionalValuedFlag
    • WindowsOptionalValuedFlag.__init_subclass__()
    • WindowsOptionalValuedFlag.AsArgument()
    • WindowsOptionalValuedFlag.Name
    • WindowsOptionalValuedFlag.Value
    • WindowsOptionalValuedFlag.__init__()
    • WindowsOptionalValuedFlag.__new__()
    • WindowsOptionalValuedFlag.__repr__()
    • WindowsOptionalValuedFlag.__str__()
• pyTooling.CLIAbstraction.ValuedFlag
  • ValuedFlag
    • ValuedFlag.__init_subclass__()
    • ValuedFlag.__new__()
    • ValuedFlag.AsArgument()
    • ValuedFlag.Name
    • ValuedFlag.Value
    • ValuedFlag.__init__()
    • ValuedFlag.__repr__()
    • ValuedFlag.__str__()
  • ShortValuedFlag
    • ShortValuedFlag.__init_subclass__()
    • ShortValuedFlag.__new__()
    • ShortValuedFlag.AsArgument()
    • ShortValuedFlag.Name
    • ShortValuedFlag.Value
    • ShortValuedFlag.__init__()
    • ShortValuedFlag.__repr__()
    • ShortValuedFlag.__str__()
  • LongValuedFlag
    • LongValuedFlag.__init_subclass__()
    • LongValuedFlag.__new__()
    • LongValuedFlag.AsArgument()
    • LongValuedFlag.Name
    • LongValuedFlag.Value
    • LongValuedFlag.__init__()
    • LongValuedFlag.__repr__()
    • LongValuedFlag.__str__()
  • WindowsValuedFlag
    • WindowsValuedFlag.__init_subclass__()
    • WindowsValuedFlag.__new__()
    • WindowsValuedFlag.AsArgument()
    • WindowsValuedFlag.Name
    • WindowsValuedFlag.Value
    • WindowsValuedFlag.__init__()
    • WindowsValuedFlag.__repr__()
    • WindowsValuedFlag.__str__()
• pyTooling.CLIAbstraction.ValuedFlagList
  • ValuedFlagList
    • ValuedFlagList.__init_subclass__()
    • ValuedFlagList.__new__()
    • ValuedFlagList.__init__()
    • ValuedFlagList.Value
    • ValuedFlagList.AsArgument()
    • ValuedFlagList.__str__()
    • ValuedFlagList.__repr__()
    • ValuedFlagList.Name
  • ShortValuedFlagList
    • ShortValuedFlagList.__init_subclass__()
    • ShortValuedFlagList.__new__()
    • ShortValuedFlagList.AsArgument()
    • ShortValuedFlagList.Name
    • ShortValuedFlagList.Value
    • ShortValuedFlagList.__init__()
    • ShortValuedFlagList.__repr__()
    • ShortValuedFlagList.__str__()
  • LongValuedFlagList
    • LongValuedFlagList.__init_subclass__()
    • LongValuedFlagList.__new__()
    • LongValuedFlagList.AsArgument()
    • LongValuedFlagList.Name
    • LongValuedFlagList.Value
    • LongValuedFlagList.__init__()
    • LongValuedFlagList.__repr__()
    • LongValuedFlagList.__str__()
  • WindowsValuedFlagList
    • WindowsValuedFlagList.__init_subclass__()
    • WindowsValuedFlagList.AsArgument()
    • WindowsValuedFlagList.Name
    • WindowsValuedFlagList.Value
    • WindowsValuedFlagList.__init__()
    • WindowsValuedFlagList.__new__()
    • WindowsValuedFlagList.__repr__()
    • WindowsValuedFlagList.__str__()
• pyTooling.CLIAbstraction.ValuedTupleFlag
  • ShortTupleFlag
    • ShortTupleFlag.__init_subclass__()
    • ShortTupleFlag.__new__()
    • ShortTupleFlag.AsArgument()
    • ShortTupleFlag.Name
    • ShortTupleFlag.Value
    • ShortTupleFlag.__init__()
    • ShortTupleFlag.__repr__()
    • ShortTupleFlag.__str__()
  • LongTupleFlag
    • LongTupleFlag.__init_subclass__()
    • LongTupleFlag.__new__()
    • LongTupleFlag.AsArgument()
    • LongTupleFlag.Name
    • LongTupleFlag.Value
    • LongTupleFlag.__init__()
    • LongTupleFlag.__repr__()
    • LongTupleFlag.__str__()
  • WindowsTupleFlag
    • WindowsTupleFlag.__init_subclass__()
    • WindowsTupleFlag.__new__()
    • WindowsTupleFlag.AsArgument()
    • WindowsTupleFlag.Name
    • WindowsTupleFlag.Value
    • WindowsTupleFlag.__init__()
    • WindowsTupleFlag.__repr__()
    • WindowsTupleFlag.__str__()

Classes

• CLIArgument: An attribute to annotate nested classes as an CLI argument.

• Program: Represent a simple command line interface (CLI) executable (program or script).

• Executable: Represent a CLI executable derived from Program, that adds an abstraction of subprocess.Popen.

class pyTooling.CLIAbstraction.CLIArgument

An attribute to annotate nested classes as an CLI argument.

Inheritance

classmethod GetAttributes(method, includeSubClasses=True)

Returns attached attributes for a given method.

Return type:

List[Attribute]

Parameters:

• method (Callable) –

• includeSubClasses (bool) –

classmethod GetClasses(scope=None, filter=None)

Return a generator for all classes, where this attribute was attached to.

Return type:

Generator[Type, None, None]

Parameters:

• scope (Type | None) –

• filter (Type | Tuple | None) –

The resulting item stream can be filtered by:

• scope - when the item is a nested class in scope scope.

• filter - when the item is a subclass of filter.

static _AppendAttribute(entity, attribute)

Helper method, to attach a given pyAttribute to an entity (function, class, method).

Return type:

None

Parameters:

• entity (Entity) –

• attribute (Attribute) –

__AttributesMemberName__: str = '__pyattr__'

Field name on entities (function, class, method) to store pyAttributes.

__call__(entity)

Make all classes derived from Attribute callable, so they can be used as a decorator.

Return type:

TypeVar(Entity, bound= Union[Type, Callable])

Parameters:

entity (Entity) –

classmethod __init_subclass__(**kwargs)

Ensure each derived class has its own instance of _classes to register the usage of that pyAttribute.

_classes: List[Any] = []

List of classes, this pyAttribute was attached to.

class pyTooling.CLIAbstraction.Program(executablePath=None, binaryDirectoryPath=None, dryRun=False)

Represent a simple command line interface (CLI) executable (program or script).

Inheritance

Parameters:

• executablePath (Path) –

• binaryDirectoryPath (Path) –

• dryRun (bool) –

_executableNames: ClassVar[Dict[str, str]]

Dictionary of platform specific executable names.

__cliOptions__: ClassVar[Dict[Type[CommandLineArgument], int]]

List of all possible CLI options.

classmethod __init_subclass__(*args, **kwargs)

Whenever a subclass is derived from :class:Program, all nested classes declared within Program and which are marked with pyAttribute CLIOption are collected and then listed in the __cliOptions__ dictionary.

__init__(executablePath=None, binaryDirectoryPath=None, dryRun=False)

Parameters:

• executablePath (Path | None) –

• binaryDirectoryPath (Path | None) –

• dryRun (bool) –

_platform: str

Current platform the executable runs on (Linux, Windows, …)

_dryRun: bool

True, if program shall run in dry-run mode.

_executablePath: Path

The path to the executable (binary, script, …).

__cliParameters__: Dict[Type[CommandLineArgument], Optional[CommandLineArgument]]

List of all CLI parameters (used CLI options).

__getitem__(key)

Access to a CLI parameter by CLI option (key must be of type CommandLineArgument), which is already used.

__repr__()

Return repr(self).

__str__()

Return str(self).

class pyTooling.CLIAbstraction.Executable(executablePath=None, binaryDirectoryPath=None, workingDirectory=None, dryRun=False)

Represent a CLI executable derived from Program, that adds an abstraction of subprocess.Popen.

Inheritance

Parameters:

• executablePath (Path) –

• binaryDirectoryPath (Path) –

• workingDirectory (Path) –

• dryRun (bool) –

__init__(executablePath=None, binaryDirectoryPath=None, workingDirectory=None, dryRun=False)

Parameters:

• executablePath (Path | None) –

• binaryDirectoryPath (Path | None) –

• workingDirectory (Path | None) –

• dryRun (bool) –

__cliOptions__: ClassVar[Dict[Type[CommandLineArgument], int]] = {}

List of all possible CLI options.

__cliParameters__: Dict[Type[CommandLineArgument], Optional[CommandLineArgument]]

List of all CLI parameters (used CLI options).

__getitem__(key)

Access to a CLI parameter by CLI option (key must be of type CommandLineArgument), which is already used.

classmethod __init_subclass__(*args, **kwargs)

Whenever a subclass is derived from :class:Program, all nested classes declared within Program and which are marked with pyAttribute CLIOption are collected and then listed in the __cliOptions__ dictionary.

__repr__()

Return repr(self).

__str__()

Return str(self).

_dryRun: bool

True, if program shall run in dry-run mode.

_executableNames: ClassVar[Dict[str, str]]

Dictionary of platform specific executable names.

_executablePath: Path

The path to the executable (binary, script, …).

_platform: str

Current platform the executable runs on (Linux, Windows, …)

Exceptions

• CLIAbstractionException: Base exception derived from Exception for all custom exceptions.

• DryRunException: This exception is raised if an executable is launched while in dry-run mode.

exception pyTooling.CLIAbstraction.CLIAbstractionException(message='')

Inheritance

Parameters:

message (str) –

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__init__(message='')

ExceptionBase initializer.

Parameters:

message (str) – The exception message.

__new__(**kwargs)

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Returns the exception’s message text.

Return type:

str

with_traceback(tb)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

Return type:

None

exception pyTooling.CLIAbstraction.DryRunException(message='')

This exception is raised if an executable is launched while in dry-run mode.

Inheritance

Parameters:

message (str) –

__cause__

exception cause

__context__

exception context

__delattr__(name, /)

Implement delattr(self, name).

__getattribute__(name, /)

Return getattr(self, name).

__init__(message='')

ExceptionBase initializer.

Parameters:

message (str) – The exception message.

__new__(**kwargs)

__reduce__()

Helper for pickle.

__repr__()

Return repr(self).

__setattr__(name, value, /)

Implement setattr(self, name, value).

__str__()

Returns the exception’s message text.

Return type:

str

with_traceback(tb)

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

Return type:

None