taucmdr.cli.command module¶

Base class for TAU Commander commands

class taucmdr.cli.command.AbstractCommand(module_name, format_fields=None, summary_fmt=None, help_page_fmt=None, group=None)[source]¶

Bases: object

Abstract base class for TAU Commander commands.

module_name¶

str

Name of the command module this command object belongs to.

command¶

str

Command line string that executes this command.

summary¶

str

One-line summary of the command.

help_page¶

str

Long and informative description of the command.

group¶

str

If not None, commands will be grouped together by group name in help messages.

_construct_parser()[source]¶

Construct a command line argument parser.

help_page

main(argv)[source]¶

Command program entry point.

Parameters:	argv (list) – Command line arguments.
Returns:	Process return code: non-zero if a problem occurred, 0 otherwise
Return type:	int

parser¶

summary

usage¶