ironicclient.shell module

class ironicclient.shell.App

Bases: App

build_option_parser(description: str | None, version: str | None, argparse_kwargs: dict[str, object] | None = None) → ArgumentParser

Return an argparse option parser for this application.

Subclasses may override this method to extend the parser with more global options.

Parameters:

• description (str) – full description of the application

• version (str) – version number for the application

• argparse_kwargs – extra keyword argument passed to the ArgumentParser constructor

initialize_app(argv: list[str]) → None

Hook for subclasses to take global initialization action after the arguments are parsed but before a command is run. Invoked only once, even in interactive mode.

Parameters:

argv – List of arguments, including the subcommand to run. Empty for interactive mode.

class ironicclient.shell.ClientManager(cloud_region: CloudRegion, options: Namespace)

Bases: object

property baremetal: Client

class ironicclient.shell.CommandManager(namespace: str | None = None, convert_underscores: bool = True, *, ignored_modules: Iterable[str] | None = None)

Bases: CommandManager

load_commands(namespace: str) → None

Load all the commands from an entrypoint

Parameters:

namespace – The namespace to load commands from.

Returns:

None

ironicclient.shell.main(argv: list[str] = ['-W', '-b', 'html', 'doc/source', 'doc/build/html']) → int