pyTooling.Attributes.ArgParse.KeyValueFlag

Classes

NamedKeyValuePairsArgument: Defines a switch argument like --help.
ShortKeyValueFlag: Defines a switch argument like --help.
LongKeyValueFlag: Defines a switch argument like --help.

Classes

class pyTooling.Attributes.ArgParse.KeyValueFlag.NamedKeyValuePairsArgument(short=None, long=None, dest=None, help=None)[source]

Defines a switch argument like --help.

Some of the named parameters passed to add_argument() are predefined (or overwritten) to create a boolean parameter passed to the registered handler method. The boolean parameter is True if the switch argument is present in the commandline arguments, otherwise False.

Inheritance

Parameters:

short (str | None)
long (str | None)
dest (str | None)
help (str | None)

__init__(short=None, long=None, dest=None, help=None)[source]

The constructor expects positional (*args), the destination parameter name dest and/or named parameters (**kwargs) which are passed to add_argument().

To implement a switch argument, the following named parameters are predefined:

action="store_const"
const=True
default=False

This implements a boolean parameter passed to the handler method.

Parameters:

short (str | None)
long (str | None)
dest (str | None)
help (str | None)

property Args: Tuple: A tuple of additional positional parameters (*args) passed to the attribute. These additional parameters are passed without modification to ArgumentParser.

classmethod GetAttributes(method, includeSubClasses=True)

Returns attached attributes of this kind for a given method.

Parameters:

method (MethodType)
includeSubClasses (bool)

Return type:

Tuple[Attribute, ...]

Returns:

Raises:

TypeError –

classmethod GetClasses(scope=None, subclassOf=None)

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

The resulting item stream can be filtered by:

scope - when the item is a nested class in scope scope.
subclassOf - when the item is a subclass of subclassOf.

Parameters:

scope (Union[Type, ModuleType, None]) – Undocumented.
subclassOf (Optional[Type]) – An attribute class or tuple thereof, to filter for that attribute type or subtype.

Return type:

Generator[TypeVar(TAttr, bound= Attribute), None, None]

Returns:

A sequence of classes where this attribute is attached to.

classmethod GetFunctions(scope=None)

Return a generator for all functions, where this attribute is attached to.

The resulting item stream can be filtered by:

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

Parameters:: scope (Optional[Type]) – Undocumented.
Return type:: Generator[TypeVar(TAttr, bound= Attribute), None, None]
Returns:: A sequence of functions where this attribute is attached to.

classmethod GetMethods(scope=None)

Return a generator for all methods, where this attribute is attached to.

The resulting item stream can be filtered by:

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

Parameters:: scope (Optional[Type]) – Undocumented.
Return type:: Generator[TypeVar(TAttr, bound= Attribute), None, None]
Returns:: A sequence of methods where this attribute is attached to.

property Handler: Callable: Returns the handler method.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:: True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:: True, if the class has any method with Attributes.

property KWArgs: Dict: A dictionary of additional named parameters (**kwargs) passed to the attribute. These additional parameters are passed without modification to ArgumentParser.

static _AppendAttribute(entity, attribute)

Append an attribute to a language entity (class, method, function).

Hint

This method can be used in attribute groups to apply multiple attributes within __call__ method.

class GroupAttribute(Attribute):
  def __call__(self, entity: Entity) -> Entity:
    self._AppendAttribute(entity, SimpleAttribute(...))
    self._AppendAttribute(entity, SimpleAttribute(...))

    return entity

Parameters:

entity (TypeVar(Entity, bound= Union[Type, Callable])) – Entity, the attribute is attached to.
attribute (Attribute) – Attribute to attach.

Raises:

TypeError – If parameter ‘entity’ is not a class, method or function.

Return type:

None

__call__(entity)

Attributes get attached to an entity (function, class, method) and an index is updated at the attribute for reverse lookups.

Parameters:: entity (TypeVar(Entity, bound= Union[Type, Callable])) – Entity (function, class, method), to attach an attribute to.
Return type:: TypeVar(Entity, bound= Union[Type, Callable])
Returns:: Same entity, with attached attribute.
Raises:: TypeError – If parameter ‘entity’ is not a function, class nor method.

classmethod __init_subclass__(**kwargs)

Ensure each derived class has its own instance of _functions, _classes and _methods to register the usage of that Attribute.

Return type:: None
Parameters:: kwargs (Any)

_classes: ClassVar[List[Any]] = []: List of classes, this Attribute was attached to.

_functions: ClassVar[List[Any]] = []: List of functions, this Attribute was attached to.

_methods: ClassVar[List[Any]] = []: List of methods, this Attribute was attached to.

_scope: ClassVar[AttributeScope] = 7: Allowed language construct this attribute can be used with.

_handler: Callable: Reference to a method that is called to handle e.g. a sub-command.

class pyTooling.Attributes.ArgParse.KeyValueFlag.ShortKeyValueFlag(short=None, dest=None, help=None)[source]

Inheritance

Parameters:

short (str | None)
dest (str | None)
help (str | None)

__init__(short=None, dest=None, help=None)[source]

The constructor expects positional (*args), the destination parameter name dest and/or named parameters (**kwargs) which are passed to add_argument().

To implement a switch argument, the following named parameters are predefined:

action="store_const"
const=True
default=False

This implements a boolean parameter passed to the handler method.

Parameters:

short (str | None)
dest (str | None)
help (str | None)

property Args: Tuple: A tuple of additional positional parameters (*args) passed to the attribute. These additional parameters are passed without modification to ArgumentParser.

classmethod GetAttributes(method, includeSubClasses=True)

Returns attached attributes of this kind for a given method.

Parameters:

method (MethodType)
includeSubClasses (bool)

Return type:

Tuple[Attribute, ...]

Returns:

Raises:

TypeError –

classmethod GetClasses(scope=None, subclassOf=None)

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

The resulting item stream can be filtered by:

scope - when the item is a nested class in scope scope.
subclassOf - when the item is a subclass of subclassOf.

Parameters:

scope (Union[Type, ModuleType, None]) – Undocumented.
subclassOf (Optional[Type]) – An attribute class or tuple thereof, to filter for that attribute type or subtype.

Return type:

Generator[TypeVar(TAttr, bound= Attribute), None, None]

Returns:

A sequence of classes where this attribute is attached to.

classmethod GetFunctions(scope=None)

Return a generator for all functions, where this attribute is attached to.

The resulting item stream can be filtered by:

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

Parameters:: scope (Optional[Type]) – Undocumented.
Return type:: Generator[TypeVar(TAttr, bound= Attribute), None, None]
Returns:: A sequence of functions where this attribute is attached to.

classmethod GetMethods(scope=None)

Return a generator for all methods, where this attribute is attached to.

The resulting item stream can be filtered by:

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

Parameters:: scope (Optional[Type]) – Undocumented.
Return type:: Generator[TypeVar(TAttr, bound= Attribute), None, None]
Returns:: A sequence of methods where this attribute is attached to.

property Handler: Callable: Returns the handler method.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:: True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:: True, if the class has any method with Attributes.

property KWArgs: Dict: A dictionary of additional named parameters (**kwargs) passed to the attribute. These additional parameters are passed without modification to ArgumentParser.

static _AppendAttribute(entity, attribute)

Append an attribute to a language entity (class, method, function).

Hint

This method can be used in attribute groups to apply multiple attributes within __call__ method.

class GroupAttribute(Attribute):
  def __call__(self, entity: Entity) -> Entity:
    self._AppendAttribute(entity, SimpleAttribute(...))
    self._AppendAttribute(entity, SimpleAttribute(...))

    return entity

Parameters:

entity (TypeVar(Entity, bound= Union[Type, Callable])) – Entity, the attribute is attached to.
attribute (Attribute) – Attribute to attach.

Raises:

TypeError – If parameter ‘entity’ is not a class, method or function.

Return type:

None

__call__(entity)

Attributes get attached to an entity (function, class, method) and an index is updated at the attribute for reverse lookups.

Parameters:: entity (TypeVar(Entity, bound= Union[Type, Callable])) – Entity (function, class, method), to attach an attribute to.
Return type:: TypeVar(Entity, bound= Union[Type, Callable])
Returns:: Same entity, with attached attribute.
Raises:: TypeError – If parameter ‘entity’ is not a function, class nor method.

classmethod __init_subclass__(**kwargs)

Ensure each derived class has its own instance of _functions, _classes and _methods to register the usage of that Attribute.

Return type:: None
Parameters:: kwargs (Any)

_classes: ClassVar[List[Any]] = []: List of classes, this Attribute was attached to.

_functions: ClassVar[List[Any]] = []: List of functions, this Attribute was attached to.

_methods: ClassVar[List[Any]] = []: List of methods, this Attribute was attached to.

_scope: ClassVar[AttributeScope] = 7: Allowed language construct this attribute can be used with.

_handler: Callable: Reference to a method that is called to handle e.g. a sub-command.

class pyTooling.Attributes.ArgParse.KeyValueFlag.LongKeyValueFlag(long=None, dest=None, help=None)[source]

Inheritance

Parameters:

long (str | None)
dest (str | None)
help (str | None)

__init__(long=None, dest=None, help=None)[source]

The constructor expects positional (*args), the destination parameter name dest and/or named parameters (**kwargs) which are passed to add_argument().

To implement a switch argument, the following named parameters are predefined:

action="store_const"
const=True
default=False

This implements a boolean parameter passed to the handler method.

Parameters:

long (str | None)
dest (str | None)
help (str | None)

property Args: Tuple: A tuple of additional positional parameters (*args) passed to the attribute. These additional parameters are passed without modification to ArgumentParser.

classmethod GetAttributes(method, includeSubClasses=True)

Returns attached attributes of this kind for a given method.

Parameters:

method (MethodType)
includeSubClasses (bool)

Return type:

Tuple[Attribute, ...]

Returns:

Raises:

TypeError –

classmethod GetClasses(scope=None, subclassOf=None)

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

The resulting item stream can be filtered by:

scope - when the item is a nested class in scope scope.
subclassOf - when the item is a subclass of subclassOf.

Parameters:

scope (Union[Type, ModuleType, None]) – Undocumented.
subclassOf (Optional[Type]) – An attribute class or tuple thereof, to filter for that attribute type or subtype.

Return type:

Generator[TypeVar(TAttr, bound= Attribute), None, None]

Returns:

A sequence of classes where this attribute is attached to.

classmethod GetFunctions(scope=None)

Return a generator for all functions, where this attribute is attached to.

The resulting item stream can be filtered by:

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

Parameters:: scope (Optional[Type]) – Undocumented.
Return type:: Generator[TypeVar(TAttr, bound= Attribute), None, None]
Returns:: A sequence of functions where this attribute is attached to.

classmethod GetMethods(scope=None)

Return a generator for all methods, where this attribute is attached to.

The resulting item stream can be filtered by:

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

Parameters:: scope (Optional[Type]) – Undocumented.
Return type:: Generator[TypeVar(TAttr, bound= Attribute), None, None]
Returns:: A sequence of methods where this attribute is attached to.

property Handler: Callable: Returns the handler method.

class property HasClassAttributes: bool

Check if class has Attributes.

Returns:: True, if the class has Attributes.

class property HasMethodAttributes: bool

Check if class has any method with Attributes.

Returns:: True, if the class has any method with Attributes.

property KWArgs: Dict: A dictionary of additional named parameters (**kwargs) passed to the attribute. These additional parameters are passed without modification to ArgumentParser.

static _AppendAttribute(entity, attribute)

Append an attribute to a language entity (class, method, function).

Hint

This method can be used in attribute groups to apply multiple attributes within __call__ method.

class GroupAttribute(Attribute):
  def __call__(self, entity: Entity) -> Entity:
    self._AppendAttribute(entity, SimpleAttribute(...))
    self._AppendAttribute(entity, SimpleAttribute(...))

    return entity

Parameters:

entity (TypeVar(Entity, bound= Union[Type, Callable])) – Entity, the attribute is attached to.
attribute (Attribute) – Attribute to attach.

Raises:

TypeError – If parameter ‘entity’ is not a class, method or function.

Return type:

None

__call__(entity)

Attributes get attached to an entity (function, class, method) and an index is updated at the attribute for reverse lookups.

Parameters:: entity (TypeVar(Entity, bound= Union[Type, Callable])) – Entity (function, class, method), to attach an attribute to.
Return type:: TypeVar(Entity, bound= Union[Type, Callable])
Returns:: Same entity, with attached attribute.
Raises:: TypeError – If parameter ‘entity’ is not a function, class nor method.

classmethod __init_subclass__(**kwargs)

Ensure each derived class has its own instance of _functions, _classes and _methods to register the usage of that Attribute.

Return type:: None
Parameters:: kwargs (Any)

_classes: ClassVar[List[Any]] = []: List of classes, this Attribute was attached to.

_functions: ClassVar[List[Any]] = []: List of functions, this Attribute was attached to.

_methods: ClassVar[List[Any]] = []: List of methods, this Attribute was attached to.

_scope: ClassVar[AttributeScope] = 7: Allowed language construct this attribute can be used with.

_handler: Callable: Reference to a method that is called to handle e.g. a sub-command.