CLSpecialAction

CLSpecialAction

class CLSpecialAction[source]

Bases: configpile.handlers.CLHandler

A handler that sets the special action

Attributes

Note: attributes inherited from parent classes are not shown here, if any

special_action

Special action to set

Methods

handle

Processes arguments, possibly updating the state or returning errors

List of members of CLSpecialAction

special_action: configpile.enums.SpecialAction

Special action to set

handle(args, state)[source]

Processes arguments, possibly updating the state or returning errors

Parameters

  • args (Sequence[str]) – Command-line arguments not processed yet

  • state (State) – (Mutable) state to possibly update

Return type

Tuple[Sequence[str], Optional[Err]]

Returns

The updated command-line and an optional error

__init__(special_action)

previous

CLRootParam

next

CLStdHandler