kopf.cli module

class kopf.cli.CLIControls(ready_flag=None, stop_flag=None, vault=None, registry=None, settings=None, loop=None)[source]

Bases: object

KopfRunner controls, which are impossible to pass via CLI.

Parameters:

ready_flag (Future | Event | Future[Any] | Event | None)
stop_flag (Future | Event | Future[Any] | Event | None)
vault (Vault | None)
registry (OperatorRegistry | None)
settings (OperatorSettings | None)
loop (AbstractEventLoop | None)

ready_flag: Union[Future, Event, Future[Any], Event, None] = None[source]

stop_flag: Union[Future, Event, Future[Any], Event, None] = None[source]

vault: Optional[Vault] = None[source]

registry: Optional[OperatorRegistry] = None[source]

settings: Optional[OperatorSettings] = None[source]

loop: Optional[AbstractEventLoop] = None[source]

class kopf.cli.LogFormatParamType[source]

Bases: Choice

convert(value, param, ctx)[source]

For a given value from the parser, normalize it and find its matching normalized value in the list of choices. Then return the matched “original” choice.

Return type:

LogFormat

Parameters:

value (Any)
param (Any)
ctx (Any)

kopf.cli.logging_options(fn)[source]

A decorator to configure logging in all commands the same way.

Return type:: Callable[..., Any]
Parameters:: fn (Callable[[...], Any])