Package wsatools :: Module CLI :: Class ArgGroup

Class ArgGroup

Container to store the specified set of arguments required by the program. It has separate lists for mandatory and optional argument definitions, and is a dictionary of argument example values referenced by name. Supplied argument values from getopt are passed through to processArgs() to provide a command-line argument look-up table for the program.

Instance Methods

[hide private]

new empty dictionary

__init__(self, argList=[])
Initialise with the list of argument definitions for this program. source code

__add__(self, argList)
Create a new container by adding a new list of argument definitions to this container.

source code

__iadd__(self, argList)
Increment the list of argument definitions with additional arguments.

source code

append(self, arg)
Add a single argument.

source code

str

getArgStr(self)
Returns: The list of program arguments in order, mandatory first.

source code

str

getExampleStr(self)
Returns: The example usage string for typical argument values.

source code

dict{str : str}

processArgs(self, argVals=[])
Processes the argument values supplied on the command-line, to return a look-up table to obtain argument values from their names. source code

remove(self, name)
Removes specified argument from the list of supported arguments.

source code

Inherited from dict: __cmp__, __contains__, __delitem__, __eq__, __ge__, __getattribute__, __getitem__, __gt__, __iter__, __le__, __len__, __lt__, __ne__, __new__, __repr__, __setitem__, __sizeof__, clear, copy, fromkeys, get, has_key, items, iteritems, iterkeys, itervalues, keys, pop, popitem, setdefault, update, values, viewitems, viewkeys, viewvalues