Trees | Index | Help |
---|
Package Bio :: Package Application :: Class _AbstractParameter |
|
_Argument
,
_Option
A class to hold information about a parameter for a commandline.
Do not use this directly, instead use one of the subclasses.
Attributes:
o names -- a list of string names by which the parameter can be referenced (ie. ["-a", "--append", "append"]). The first name in the list is considered to be the one that goes on the commandline, for those parameters that print the option. The last name in the list is assumed to be a "human readable" name describing the option in one word.
o param_type -- a list of string describing the type of parameter, which can help let programs know how to use it. Example descriptions include 'input', 'output', 'file'
o checker_function -- a reference to a function that will determine if a given value is valid for this parameter. This function can either raise an error when given a bad value, or return a [0, 1] decision on whether the value is correct.
o description -- a description of the option.
o is_required -- a flag to indicate if the parameter must be set for the program to be run.
o is_set -- if the parameter has been set
o value -- the value of a parameterMethod Summary | |
---|---|
__init__(self,
names,
types,
checker_function,
is_required,
description)
|
Trees | Index | Help |
---|
Generated by Epydoc 2.1 on Wed Jan 31 09:57:59 2007 | http://epydoc.sf.net |