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¶

Name of the command module this command object belongs to.

Type:	str

command¶

Command line string that executes this command.

Type:	str

summary¶

One-line summary of the command.

Type:	str

help_page¶

Long and informative description of the command.

Type:	str

group¶

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

Type:	str

_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¶