oio.cli package

Subpackages

• oio.cli.account package
  • Submodules
  • oio.cli.account.account module
  • oio.cli.account.client module
  • Module contents
• oio.cli.admin package
  • Subpackages
    • oio.cli.admin.xcute package
      • Submodules
      • oio.cli.admin.xcute.job module
      • oio.cli.admin.xcute.lock module
      • oio.cli.admin.xcute.meta2 module
      • oio.cli.admin.xcute.rawx module
      • Module contents
  • Submodules
  • oio.cli.admin.common module
  • oio.cli.admin.item_check module
  • oio.cli.admin.item_locate module
  • oio.cli.admin.item_move module
  • oio.cli.admin.item_rebuild module
  • oio.cli.admin.item_repair module
  • oio.cli.admin.item_vacuum module
  • oio.cli.admin.service_check module
  • oio.cli.admin.service_config module
  • oio.cli.admin.service_decache module
  • oio.cli.admin.service_info module
  • oio.cli.admin.service_list module
  • oio.cli.admin.service_rebuild module
  • Module contents
• oio.cli.cluster package
  • Submodules
  • oio.cli.cluster.client module
  • oio.cli.cluster.cluster module
  • Module contents
• oio.cli.common package
  • Submodules
  • oio.cli.common.clientmanager module
  • oio.cli.common.commandmanager module
  • oio.cli.common.shell module
  • oio.cli.common.utils module
  • Module contents
• oio.cli.container package
  • Submodules
  • oio.cli.container.client module
  • oio.cli.container.container module
  • Module contents
• oio.cli.directory package
  • Submodules
  • oio.cli.directory.client module
  • oio.cli.directory.directory module
  • Module contents
• oio.cli.election package
  • Submodules
  • oio.cli.election.client module
  • oio.cli.election.election module
  • Module contents
• oio.cli.events package
  • Submodules
  • oio.cli.events.client module
  • oio.cli.events.events module
  • Module contents
• oio.cli.lifecycle package
  • Submodules
  • oio.cli.lifecycle.client module
  • oio.cli.lifecycle.lifecycle module
  • Module contents
• oio.cli.object package
  • Submodules
  • oio.cli.object.client module
  • oio.cli.object.object module
  • Module contents
• oio.cli.rdir package
  • Submodules
  • oio.cli.rdir.client module
  • oio.cli.rdir.rdir module
  • Module contents
• oio.cli.reference package
  • Submodules
  • oio.cli.reference.client module
  • oio.cli.reference.reference module
  • Module contents
• oio.cli.volume package
  • Submodules
  • oio.cli.volume.client module
  • oio.cli.volume.volume module
  • Module contents
• oio.cli.zk package
  • Submodules
  • oio.cli.zk.client module
  • oio.cli.zk.set module
  • Module contents

Submodules

oio.cli.clientmanager module

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

Bases: oio.cli.common.clientmanager.ClientManager

Module contents

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

Bases: cliff.command.Command

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

run(parsed_args)

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)

Bases: cliff.lister.Lister

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

run(parsed_args)

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)

Bases: cliff.show.ShowOne

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

run(parsed_args)

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)

Add optional parameters common to all openio CLIs to parser.

oio.cli.flat_dict_from_dict(parsed_args, dict_)

Create a dictionary without depth.

{

‘depth0’: {

‘depth1’: {

‘depth2’: ‘test’

}

}

} => {

‘depth0.depth1.depth2’: ‘test’

}

oio.cli.get_logger_from_args(args, default_conf=None)

Build a Logger instance from parsed args.

oio.cli.make_logger_args_parser()

Create an ArgumentParser for logger configuration.