1.1.1.3. rez.cli package

1.1.1.3.1. Submodules

1.1.1.3.2. rez.cli._bez module

1.1.1.3.3. rez.cli._main module

The main command-line entry point.

class rez.cli._main.InfoAction(option_strings, dest, default=False, required=False, help=None)[source]

Bases: argparse._StoreTrueAction

class rez.cli._main.SetupRezSubParser(module_name)[source]

Bases: object

Callback class for lazily setting up rez sub-parsers.

get_module()[source]
rez.cli._main.is_hyphened_command()[source]
rez.cli._main.run(command=None)[source]
rez.cli._main.setup_parser()[source]

Create and setup parser for given rez command line interface.

Returns:Argument parser for rez command.
Return type:LazyArgumentParser

1.1.1.3.4. rez.cli._util module

class rez.cli._util.LazyArgumentParser(*args, **kwargs)[source]

Bases: argparse.ArgumentParser

ArgumentParser sub-class which accepts an additional setup_subparser argument for lazy setup of sub-parsers.

setup_subparser is passed ‘parser_name’, ‘parser’, and can return a help string.

format_help()[source]

Sets up all sub-parsers when help is requested.

class rez.cli._util.LazySubParsersAction(option_strings, prog, parser_class, dest='==SUPPRESS==', help=None, metavar=None)[source]

Bases: argparse._SubParsersAction

Argparse Action which calls the setup_subparser function provided to LazyArgumentParser.

rez.cli._util.load_plugin_cmd()[source]

Load subcommand from command type plugin

The command type plugin module should have attribute command_behavior, and the value must be a dict if provided. For example:

# in your command plugin module command_behavior = {

“hidden”: False, # (bool): default False “arg_mode”: None, # (str): “passthrough”, “grouped”, default None

}

If the attribute not present, default behavior will be given.

rez.cli._util.print_items(items, stream=<open file '<stdout>', mode 'w'>)[source]
rez.cli._util.sigbase_handler(signum, frame)[source]
rez.cli._util.sigint_handler(signum, frame)[source]

Exit gracefully on ctrl-C.

rez.cli._util.sigterm_handler(signum, frame)[source]

Exit gracefully on terminate.

1.1.1.3.5. rez.cli.bind module

Create a Rez package for existing software.

rez.cli.bind.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.bind.setup_parser(parser, completions=False)[source]

1.1.1.3.6. rez.cli.bootstrap module

1.1.1.3.7. rez.cli.build module

Build a package from source.

rez.cli.build.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.build.get_build_args(opts, parser, extra_arg_groups)[source]
rez.cli.build.get_current_developer_package()[source]
rez.cli.build.setup_parser(parser, completions=False)[source]
rez.cli.build.setup_parser_common(parser)[source]

Parser setup common to both rez-build and rez-release.

1.1.1.3.8. rez.cli.context module

Print information about the current rez context, or a given context file.

rez.cli.context.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.context.setup_parser(parser, completions=False)[source]

1.1.1.3.9. rez.cli.env module

Open a rez-configured shell, possibly interactive.

rez.cli.env.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.env.setup_parser(parser, completions=False)[source]

1.1.1.3.10. rez.cli.forward module

==SUPPRESS==

rez.cli.forward.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.forward.setup_parser(parser, completions=False)[source]

1.1.1.3.11. rez.cli.interpret module

Execute some Rex code and print the interpreted result.

rez.cli.interpret.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.interpret.setup_parser(parser, completions=False)[source]

1.1.1.3.12. rez.cli.release module

Build a package from source and deploy it.

rez.cli.release.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.release.setup_parser(parser, completions=False)[source]

1.1.1.3.13. rez.cli.settings module

1.1.1.3.14. rez.cli.suite module

Manage a suite or print information about an existing suite.

rez.cli.suite.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.suite.setup_parser(parser, completions=False)[source]

1.1.1.3.15. rez.cli.test module

Run tests listed in a package’s definition file.

rez.cli.test.command(opts, parser, extra_arg_groups=None)[source]
rez.cli.test.setup_parser(parser, completions=False)[source]

1.1.1.3.16. rez.cli.tools module

1.1.1.3.17. Module contents