Parameters¶
- class ezcliy.parameters.Parameter¶
Abstract class for creating parameters for cli invoke
- value: str = None¶
Value of parameter
- description: str = None¶
Description of param
- lock: bool = False¶
- pass_args(user_args: list) list¶
This method gathers all args, and removes processed args.
- Parameters
user_args – list of args to process
- Returns
processed list of args, usally smaller then input
- class ezcliy.parameters.Flag(*aliases: str)¶
Simple boolean switch (examples: -v or –verbose)
- value: bool = False¶
Value of parameter
- __init__(*aliases: str)¶
- Parameters
aliases – must contains dash or dashes
- pass_args(user_args: list) list¶
This method gathers all args, and removes processed args.
- Parameters
user_args – list of args to process
- Returns
processed list of args, usally smaller then input
- description: str = None¶
Description of param
- lock: bool = False¶
- class ezcliy.parameters.KeyVal(keyname: str, default=None)¶
Pass values for invcation (examples: -c=90 or –count=90)
- __init__(keyname: str, default=None)¶
- Parameters
keyname – must contains dash or dashes
- values: list = []¶
- description: str = None¶
Description of param
- lock: bool = False¶
- property value¶
- pass_args(user_args: list) list¶
This method gathers all args, and removes processed args.
- Parameters
user_args – list of args to process
- Returns
processed list of args, usally smaller then input
Positionals¶
- class ezcliy.positional.Positional(name: str, ask_if_missing: Optional[str] = None, optional: Optional[Any] = None)¶
Asign value (by source order) to object, allows asking for value or provide default one.
- value: str = None¶
Fetched value by positional
- description: str = None¶
Description for help
- pass_values(values: list, position: int)¶