t.s.t.Options(_BasicOptions, usage.Options, app.ReactorSelectionMixin) : class documentation

Part of twisted.scripts.trial View Source View In Hierarchy

Options to the trial command line tool.

Method	opt_jobs	Number of local workers to run, a strictly positive integer.
Method	postOptions	I am called after the options are parsed.
Instance Variable	_workerFlags	List of flags which are accepted by trial distributed workers. This is used by `_getWorkerArguments` to build the command line arguments. (type: `list`)
Instance Variable	_workerParameters	List of parameter which are accepted by trial distrubuted workers. This is used by `_getWorkerArguments` to build the command line arguments. (type: `list`)
Method	_getWorkerArguments	Return a list of options to pass to distributed workers.

Inherited from _BasicOptions:

Method	__init__	Undocumented
Method	coverdir	Return a `FilePath` representing the directory into which coverage results should be written.
Method	opt_coverage	Generate coverage information in the coverage file in the directory specified by the temp-directory option.
Method	opt_testmodule	Filename to grep for test cases (-*- test-case-name).
Method	opt_spew	Print an insanely verbose log of everything that happens. Useful when debugging freezes or locks in complex code.
Method	opt_help_orders	Undocumented
Method	opt_help_reporters	Undocumented
Method	opt_disablegc	Disable the garbage collector
Method	opt_tbformat	Specify the format to display tracebacks with. Valid formats are 'plain', 'emacs', and 'cgitb' which uses the nicely verbose stdlib cgitb.text function
Method	opt_recursionlimit	see sys.setrecursionlimit()
Method	opt_random	Undocumented
Method	opt_without_module	Fake the lack of the specified modules, separated with commas.
Method	parseArgs	Undocumented
Method	_loadReporterByName	Undocumented

Inherited from Options:

Method	__init__	Undocumented
Method	__hash__	Define a custom hash function so that Options instances can be used as dictionary keys. This is an internal feature used to implement the parser. Do not rely on it in application code.
Method	opt_help	Display this help and exit.
Method	opt_version	Display Twisted version and exit.
Method	parseOptions	The guts of the command-line parser.
Method	parseArgs	I am called with any leftover arguments which were not options.
Method	__str__	Undocumented
Method	getSynopsis	Returns a string containing a description of these options and how to pass them to the executed file.
Method	getUsage	Undocumented
Method	_generic_flag	Undocumented
Method	_gather_flags	Gather up boolean (flag) options.
Method	_gather_parameters	Gather options which take a value.
Method	_gather_handlers	Gather up options with their own handler methods.

Inherited from ReactorSelectionMixin:

Method	opt_help_reactors	Display a list of possibly available reactor names.
Method	opt_reactor	Which reactor to use (see --help-reactors for a list of possibilities)

_workerFlags =

List of flags which are accepted by trial distributed workers. This is used by _getWorkerArguments to build the command line arguments. (type: list)

_workerParameters =

List of parameter which are accepted by trial distrubuted workers. This is used by _getWorkerArguments to build the command line arguments. (type: list)

def opt_jobs(self, number): (source)

Number of local workers to run, a strictly positive integer.

def _getWorkerArguments(self): (source)

Return a list of options to pass to distributed workers.

def postOptions(self): (source)

overrides twisted.scripts.trial._BasicOptions.postOptions

I am called after the options are parsed.

Override this method in your subclass to do something after the options have been parsed and assigned, like validate that all options are sane.

API Documentation for Twisted, generated by pydoctor at 2014-05-12 18:27:00.