Home | Trees | Indices | Help |
|
---|
|
object --+ | Variables
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
|
|||
Inherited from |
|
|||
instance = False Holds all the options, updates the environment with the variables, and renders the help text. |
|||
format =
|
|||
format_ =
|
|
|||
Inherited from |
|
files - [optional] List of option configuration files to load (backward compatibility) If a single string is passed it is automatically placed in a file list
|
Add an option. key - the name of the variable, or a list or tuple of arguments help - optional help text for the options default - optional default value validator - optional function that is called to validate the option's value Called with (key, value, environment) converter - optional function that is called to convert the option's value before putting it in the environment. |
Add a list of options. Each list element is a tuple/list of arguments to be passed on to the underlying method for adding options. Example: opt.AddVariables( ('debug', '', 0), ('CC', 'The C compiler'), ('VALIDATE', 'An option for testing validation', 'notset', validator, None), ) |
Update an environment with the option variables. env - the environment to update. |
Saves all the options in the given file. This file can then be used to load the options next run. This can be used to create an option cache file. filename - Name of the file to save into env - the environment get the option values from |
Generate the help text for the options. env - an environment that is used to get the current values of the options. |
|
format_
|
Home | Trees | Indices | Help |
|
---|
Generated by Epydoc 3.0beta1 on Mon Jun 14 22:07:45 2010 | http://epydoc.sourceforge.net |