Actions Module

Parameter actions define how Parameters behave when processing values that were provided via CLI or environment variables.

class cli_command_parser.parameters.actions.ParamAction(param: Param)

Bases: ABC

name: str

default: TD = <object object>

accepts_values: bool = False

accepts_consts: bool = False

classmethod __init_subclass__(default: ~cli_command_parser.parameters.actions.TD = <object object>, accepts_values: bool = None, accepts_consts: bool = None, **kwargs)

param

abstract property default_nargs: Nargs

abstract add_value(value: str, *, combo: bool = False, joined: bool = False, env_var: str = None) → int | NoReturn

Execute this action for the given Parameter and value.

Parameters:

• value – The value that was provided, if any.

• combo – Only True when a short option was provided, where the option string was combined with either a real value or a sequence of 1-char combinable versions of short option strings.

• joined – True if the value was provided as --option=value, False otherwise.

• env_var – The name of the environment variable that was used as the source of the given value, if applicable.

Returns:

The number of new values discovered

add_env_value(value: str, env_var: str) → int | NoReturn

add_const(*, opt: str = None, combo: bool = False) → int | NoReturn

would_accept(value: str, combo: bool = False) → bool

get_maybe_poppable_counts() → list[int]

Returns:

The indexes on which the parsed values may be split such that the remaining number of values will still be acceptable for the Parameter’s nargs.

can_reset() → bool

get_default(command: CommandObj | None = None, missing_default=<object object>)

finalize_default(value)

finalize_value(value)

class cli_command_parser.parameters.actions.ValueMixin

Bases: object

param: Param

get_default: Callable

set_value(value)

append_value(value)

class cli_command_parser.parameters.actions.ConstMixin

Bases: object

param: Param

get_default: Callable

add_const: Callable

add_value: Callable

classmethod __init_subclass__(append: bool = False, **kwargs)

set_const(const)

append_const(const)

add_env_value(value: str, env_var: str) → int | NoReturn

class cli_command_parser.parameters.actions.Store(param: Param)

Bases: ValueMixin, ParamAction

default_nargs = Nargs(1)

add_value(value: str, *, combo: bool = False, joined: Bool = False, env_var: str = None) → Found

would_accept(value: str, combo: bool = False) → bool

accepts_values: bool = True

default: TD = None

name: str = 'store'

class cli_command_parser.parameters.actions.Append(param: Param)

Bases: ValueMixin, ParamAction

default_nargs = Nargs('+')

add_value(value: str, *, combo: bool = False, joined: Bool = False, env_var: str = None) → Found

would_accept(value: str, combo: bool = False) → bool

get_maybe_poppable_counts() → list[int]

Returns:

The indexes on which the parsed values may be split such that the remaining number of values will still be acceptable for the Parameter’s nargs.

can_reset() → bool

get_default(command: CommandObj | None = None, missing_default=<object object>)

finalize_default(value)

finalize_value(value)

accepts_values: bool = True

name: str = 'append'

class cli_command_parser.parameters.actions.BasicConstAction(param: Param)

Bases: ConstMixin, ParamAction, ABC

default_nargs = Nargs(0)

add_value(value: str, *, combo: bool = False, joined: Bool = False, env_var: str = None) → Found

would_accept(value: str, combo: bool = False) → bool

accepts_consts: bool = True

name: str = 'basic_const_action'

class cli_command_parser.parameters.actions.StoreConst(param: Param)

Bases: BasicConstAction

add_const(*, opt: str = None, combo: bool = False) → int | NoReturn

default: TD = None

name: str = 'store_const'

class cli_command_parser.parameters.actions.AppendConst(param: Param)

Bases: BasicConstAction

add_const(*, opt: str = None, combo: bool = False) → int | NoReturn

get_default(command: CommandObj | None = None, missing_default=<object object>)

name: str = 'append_const'

class cli_command_parser.parameters.actions.Count(param: Param)

Bases: ParamAction

default_nargs = Nargs('?')

add_const(*, opt: str = None, combo: bool = False) → int | NoReturn

add_value(value: str, *, combo: bool = False, joined: Bool = False, env_var: str = None) → Found

accepts_consts: bool = True

accepts_values: bool = True

name: str = 'count'

class cli_command_parser.parameters.actions.Concatenate(param: Param)

Bases: Append

add_value(value: str, *, combo: bool = False, joined: Bool = False, env_var: str = None) → Found

finalize_default(value)

finalize_value(value)

name: str = 'concatenate'

class cli_command_parser.parameters.actions.StoreAll(param: Param)

Bases: Store

default_nargs = Nargs('REMAINDER')

add_values(values: list[str], *, combo: bool = False) → int | NoReturn

name: str = 'store_all'