oio.cli package

Subpackages

Submodules

oio.cli.clientmanager module

class oio.cli.clientmanager.ClientManager(*args, **kwargs)[source]

Bases: oio.cli.common.clientmanager.ClientManager

Module contents

class oio.cli.Command(app, app_args, cmd_name=None)[source]

Bases: cliff.command.Command

Wraps cliff’s command.Command and sets the process’ return code according to the class’ “success” field.

run(parsed_args)[source]

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.

success = True
class oio.cli.Lister(app, app_args, cmd_name=None)[source]

Bases: cliff.lister.Lister

Wraps cliff’s lister.Lister and sets the process’ return code according to the class’ “success” field.

run(parsed_args)[source]

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.

success = True
class oio.cli.ShowOne(app, app_args, cmd_name=None)[source]

Bases: cliff.show.ShowOne

Wraps cliff’s show.ShowOne and sets the process’ return code according to the class’ “success” field.

run(parsed_args)[source]

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.

success = True
oio.cli.add_common_parser_options(parser)[source]

Add optional parameters common to all openio CLIs to parser.

oio.cli.get_logger_from_args(args, default_conf=None)[source]

Build a Logger instance from parsed args.

oio.cli.make_logger_args_parser()[source]

Create an ArgumentParser for logger configuration.