osc_lib.command package

Submodules

osc_lib.command.command module

class osc_lib.command.command.Command(app: _app.App, app_args: Optional[argparse.Namespace], cmd_name: Optional[str] = None)

Bases: cliff.command.Command

deprecated_option_warning(old_option: str, new_option: str) → None

Emit a warning for use of a deprecated option

log: logging.Logger = <Logger osc_lib.command.command.Command (WARNING)>
run(parsed_args: argparse.Namespace) → int

Invoked by the application when the command is run.

Developers implementing commands should override take_action().

Developers creating new command base classes (such as Lister and ShowOne) should override this method to wrap take_action().

Return the value returned by take_action() or 0.

validate_os_beta_command_enabled() → None
class osc_lib.command.command.CommandMeta(name: str, bases: tuple, namespace: dict)

Bases: abc.ABCMeta

class osc_lib.command.command.Lister(app: cliff.app.App, app_args: Optional[argparse.Namespace], cmd_name: Optional[str] = None)

Bases: osc_lib.command.command.Command, cliff.lister.Lister

app_dist_name: Optional[str]
log: logging.Logger = <Logger osc_lib.command.command.Lister (WARNING)>
class osc_lib.command.command.ShowOne(app: cliff.app.App, app_args: Optional[argparse.Namespace], cmd_name: Optional[str] = None)

Bases: osc_lib.command.command.Command, cliff.show.ShowOne

app_dist_name: Optional[str]
log: logging.Logger = <Logger osc_lib.command.command.ShowOne (WARNING)>

osc_lib.command.commandmanager module

class osc_lib.command.commandmanager.CommandManager(namespace: str, convert_underscores: bool = True)

Bases: cliff.commandmanager.CommandManager

Noop subclass for transition purposes.

osc_lib.command.timing module

Timing Implementation

class osc_lib.command.timing.Timing(app: cliff.app.App, app_args: Optional[argparse.Namespace], cmd_name: Optional[str] = None)

Bases: osc_lib.command.command.Lister

Show timing data

app: shell.OpenStackShell
log: logging.Logger = <Logger osc_lib.command.timing.Timing (WARNING)>
take_action(parsed_args: argparse.Namespace) → tuple

Run command.

Return a tuple containing the column names and an iterable containing the data to be listed.

Module contents