taucmdr.cli package

TAU Commander command line interface (CLI).

The TAU Commander CLI is composed of a single top-level command that invokes subcommands, much like git. For example, the command line tau project create my_new_project invokes the create subcommand of the project subcommand with the arguments my_new_project.

Every package in taucmdr.cli.commands is a TAU Commander subcommand. Modules in the package are that subcommand’s subcommands. This can be nested as deep as you like. Subcommand modules must have a COMMAND member which is an instance of a subclass of AbstractCommand.

exception taucmdr.cli.AmbiguousCommandError(value, matches, *hints)

Bases: ConfigurationError

Indicates that a specified partial command is ambiguous.

message_fmt = "Command '%(value)s' is ambiguous.\n\n%(hints)s"

Format string for the error message.

exception taucmdr.cli.UnknownCommandError(value, *hints)

Bases: ConfigurationError

Indicates that a specified command is unknown.

message_fmt = '%(value)r is not a valid TAU command.\n\n%(hints)s'

Format string for the error message.

taucmdr.cli._command_as_list(module_name)

Converts a module name to a command name list.

Maps command module names to their command line equivilants, e.g. ‘taucmdr.cli.commands.target.create’ => [‘tau’, ‘target’, ‘create’]

Parameters:

module_name (str) – Name of a module.

Returns:

Strings that identify the command.

Return type:

list

taucmdr.cli._get_commands(package_name)

Returns a dictionary mapping commands to Python modules.

Given a root module name, return a dictionary that maps commands and their subcommands to Python modules. The special key __module__ maps to the command module. Other strings map to subcommands of the command.

Parameters:

package_name (str) – A string naming the module to search for cli.

Returns:

Strings mapping to dictionaries or modules.

Return type:

dict

Example:

_get_commands('taucmdr.cli.commands.target') ==>
    {'__module__': <module 'taucmdr.cli.commands.target' from '/home/jlinford/workspace/taucmdr/packages/taucmdr/cli/commands/target/__init__.pyc'>,
     'create': {'__module__': <module 'taucmdr.cli.commands.target.create' from '/home/jlinford/workspace/taucmdr/packages/taucmdr/cli/commands/target/create.pyc'>},
     'delete': {'__module__': <module 'taucmdr.cli.commands.target.delete' from '/home/jlinford/workspace/taucmdr/packages/taucmdr/cli/commands/target/delete.pyc'>},
     'edit': {'__module__': <module 'taucmdr.cli.commands.target.edit' from '/home/jlinford/workspace/taucmdr/packages/taucmdr/cli/commands/target/edit.pyc'>},
     'list': {'__module__': <module 'taucmdr.cli.commands.target.list' from '/home/jlinford/workspace/taucmdr/packages/taucmdr/cli/commands/target/list.pyc'>}}

taucmdr.cli._permute(cmd, cmd_args)

taucmdr.cli._resolve(cmd, c, d)

taucmdr.cli.command_from_module_name(module_name)

Converts a module name to a command name string.

Maps command module names to their command line equivilants, e.g. ‘taucmdr.cli.commands.target.create’ => ‘tau target create’

Parameters:

module_name (str) – Name of a module.

Returns:

A string that identifies the command.

Return type:

str

taucmdr.cli.commands_description(package_name='taucmdr.cli.commands')

Builds listing of command names with short description.

Parameters:

package_name (str) – A dot-seperated string naming the module to search for cli.

Returns:

Help string describing all commands found at or below root.

Return type:

str

taucmdr.cli.execute_command(cmd, cmd_args=None, parent_module=None)

Import the command module and run its main routine.

Partial commands are allowed, e.g. cmd=[‘tau’, ‘cli’, ‘commands’, ‘app’, ‘cre’] will resolve to ‘taucmdr.cli.commands.application.create’. If the command can’t be found then the parent command (if any) will be invoked with the --help flag.

Parameters:

• cmd (list) – List of strings identifying the command, i.e. from _command_as_list.

• cmd_args (list) – Command line arguments to be parsed by command.

• parent_module (str) – Dot-seperated name of the command’s parent.

Raises:

• UnknownCommandError – cmd is invalid.

• AmbiguousCommandError – cmd is ambiguous.

Returns:

Command return code.

Return type:

int

taucmdr.cli.find_command(cmd)

Import the command module and return its COMMAND member.

Parameters:

cmd (list) – List of strings identifying the command, i.e. from _command_as_list.

Raises:

• UnknownCommandError – cmd is invalid.

• AmbiguousCommandError – cmd is ambiguous.

Returns:

Command object for the subcommand.

Return type:

AbstractCommand

taucmdr.cli.get_all_commands(package_name='taucmdr.cli.commands')

Builds a list of all commands and subcommands.

Parameters:

package_name (str) – A dot-separated string naming the module to search for cli.

Returns:

List of modules corresponding to all commands and subcommands.

Return type:

list

Subpackages

• taucmdr.cli.commands package
  • Subpackages
    • taucmdr.cli.commands.application package
      • Subpackages
      • Submodules
    • taucmdr.cli.commands.experiment package
      • Subpackages
      • Submodules
    • taucmdr.cli.commands.measurement package
      • Subpackages
      • Submodules
    • taucmdr.cli.commands.project package
      • Subpackages
      • Submodules
    • taucmdr.cli.commands.system package
      • SystemCommand
      • Subpackages
      • Submodules
    • taucmdr.cli.commands.target package
      • Subpackages
      • Submodules
    • taucmdr.cli.commands.tests package
      • Submodules
    • taucmdr.cli.commands.trial package
      • Subpackages
      • Submodules
  • Submodules
    • taucmdr.cli.commands.__main__ module
      • MainCommand
    • taucmdr.cli.commands.build module
      • BuildCommand
    • taucmdr.cli.commands.dashboard module
      • DashboardCommand
    • taucmdr.cli.commands.help module
      • HelpCommand
      • _fuzzy_index()
      • _guess_filetype()
    • taucmdr.cli.commands.initialize module
      • InitializeCommand
    • taucmdr.cli.commands.rewrite module
      • RewriteCommand
    • taucmdr.cli.commands.select module
      • SelectCommand
• taucmdr.cli.tests package
  • Submodules
    • taucmdr.cli.tests.test_arguments module
      • ArgumentsTest
      • ParseBooleanActionTest
      • ParsePackagePathActionTest
      • _help_text()
    • taucmdr.cli.tests.test_cli_view module
      • TexttableTest
      • _clear_color_cache()
      • _draw()
    • taucmdr.cli.tests.test_command module
      • CommandTest
      • FormatUsageTest
    • taucmdr.cli.tests.test_init module
      • FindCommandTest

Submodules

• taucmdr.cli.arguments module
  • Action
    • Action._get_kwargs()
    • Action.format_usage()
  • ArgumentError
  • ArgumentsNamespace
  • ConsoleHelpFormatter
    • ConsoleHelpFormatter._format_action()
    • ConsoleHelpFormatter._format_optional()
    • ConsoleHelpFormatter._format_optional_arg()
    • ConsoleHelpFormatter._format_positional()
    • ConsoleHelpFormatter._format_requred_arg()
    • ConsoleHelpFormatter.add_argument()
    • ConsoleHelpFormatter.start_section()
  • HelpFormatter
    • HelpFormatter._format_action_invocation()
    • HelpFormatter._format_args()
    • HelpFormatter._format_meta_arg()
    • HelpFormatter._format_optional()
    • HelpFormatter._format_optional_arg()
    • HelpFormatter._format_positional()
    • HelpFormatter._format_requred_arg()
    • HelpFormatter._get_help_string()
    • HelpFormatter._split_lines()
  • MutableArgumentGroup
  • MutableArgumentGroupParser
    • MutableArgumentGroupParser._sorted_groups()
    • MutableArgumentGroupParser.add_argument_group()
    • MutableArgumentGroupParser.format_help()
    • MutableArgumentGroupParser.merge()
  • ParseBooleanAction
    • ParseBooleanAction.__call__()
  • ParsePackagePathAction
    • ParsePackagePathAction.__call__()
  • REMAINDER
  • STORAGE_LEVEL_FLAG
  • SUPPRESS
  • add_storage_flag()
  • get_parser()
  • get_parser_from_model()
  • parse_storage_flag()
• taucmdr.cli.cli_view module
  • AbstractCliView
    • AbstractCliView.controller
    • AbstractCliView.model_name
    • AbstractCliView._abc_impl
  • CopyCommand
    • CopyCommand._abc_impl
    • CopyCommand._construct_parser()
    • CopyCommand._copy_record()
    • CopyCommand.main()
  • CreateCommand
    • CreateCommand._abc_impl
    • CreateCommand._construct_parser()
    • CreateCommand._create_record()
    • CreateCommand.main()
  • DeleteCommand
    • DeleteCommand._abc_impl
    • DeleteCommand._construct_parser()
    • DeleteCommand._delete_record()
    • DeleteCommand.main()
  • EditCommand
    • EditCommand._abc_impl
    • EditCommand._construct_parser()
    • EditCommand._update_record()
    • EditCommand.main()
  • ListCommand
    • ListCommand._abc_impl
    • ListCommand._construct_parser()
    • ListCommand._count_records()
    • ListCommand._format_long_item()
    • ListCommand._format_records()
    • ListCommand._list_records()
    • ListCommand._retrieve_records()
    • ListCommand.dashboard_format()
    • ListCommand.long_format()
    • ListCommand.main()
    • ListCommand.short_format()
  • RootCommand
    • RootCommand._abc_impl
    • RootCommand._construct_parser()
    • RootCommand.main()
  • Texttable
    • Texttable._draw_line()
• taucmdr.cli.command module
  • AbstractCommand
    • AbstractCommand.module_name
    • AbstractCommand.command
    • AbstractCommand.group
    • AbstractCommand._abc_impl
    • AbstractCommand._construct_parser()
    • AbstractCommand._parse_args()
    • AbstractCommand.format_usage()
    • AbstractCommand.help_page
    • AbstractCommand.main()
    • AbstractCommand.parser
    • AbstractCommand.summary
    • AbstractCommand.usage