osc_lib.command package

Submodules

osc_lib.command.command module

class osc_lib.command.command.Command(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command

app: shell.OpenStackShell

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

Emit a warning for use of a deprecated option

log: Logger = <Logger osc_lib.command.command.Command (WARNING)>

run(parsed_args: 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[type[Any], ...], namespace: dict[str, Any])

Bases: ABCMeta

class osc_lib.command.command.Lister(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command, Lister

app: shell.OpenStackShell

app_dist_name: str | None

log: Logger = <Logger osc_lib.command.command.Lister (WARNING)>

class osc_lib.command.command.ShowOne(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Command, ShowOne

app: shell.OpenStackShell

app_dist_name: str | None

log: 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: CommandManager

Noop subclass for transition purposes.

osc_lib.command.timing module

Timing Implementation

class osc_lib.command.timing.Timing(app: App, app_args: Namespace | None, cmd_name: str | None = None)

Bases: Lister

Show timing data

app: shell.OpenStackShell

app_dist_name: str | None

log: Logger = <Logger osc_lib.command.timing.Timing (WARNING)>

take_action(parsed_args: Namespace) → tuple[tuple[str, ...], list[Any]]

Run command.

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

Module contents