API Reference for Enthought Tool Suite 3.2.0

Action(*strings, **options)

Action objects hold the information necessary to convert a set of command-line arguments (possibly including an initial option string) into the desired Python object(s).

Keyword Arguments

option_strings
A list of command-line option strings which should be associated with this action.
dest
The name of the attribute to hold the created object(s)
nargs

The number of command-line arguments that should be consumed. By default, one argument will be consumed and a single value will be produced. Other values include:

  • N (an integer) consumes N arguments (and produces a list)
  • '?' consumes zero or one arguments
  • '*' consumes zero or more arguments (and produces a list)
  • '+' consumes one or more arguments (and produces a list)

Note that the difference between the default and nargs=1 is that with the default, a single value will be produced, while with nargs=1, a list containing a single value will be produced.

const
The value to be produced if the option is specified and the option uses an action that takes no values.
default
The value to be produced if the option is not specified.
type
The type which the command-line arguments should be converted to, should be one of 'string', 'int', 'float', 'complex' or a callable object that accepts a single string argument. If None, 'string' is assumed.
choices
A container of values that should be allowed. If not None, after a command-line argument has been converted to the appropriate type, an exception will be raised if it is not a member of this collection.
required
True if the action must always be specified at the command line. This is only meaningful for optional command-line arguments.
help
The help string describing the argument.
metavar
The name to be used for the option's argument with the help string. If None, the 'dest' value will be used as the name.

Method summary

Methods

© Copyright 2002-2009 Enthought, Inc.