twisted.scripts.trial.Options

class documentation

class Options(_BasicOptions, usage.Options, app.ReactorSelectionMixin): (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 post​Options I am called after the options are parsed.
Class Variable comp​Data Undocumented
Class Variable extra Undocumented
Class Variable opt​Flags Undocumented
Class Variable opt​Parameters Undocumented
Class Variable tracer Undocumented
Method _get​Worker​Arguments Return a list of options to pass to distributed workers.
Instance Variable _worker​Flags List of flags which are accepted by trial distributed workers. This is used by _getWorkerArguments to build the command line arguments.
Instance Variable _worker​Parameters List of parameter which are accepted by trial distributed workers. This is used by _getWorkerArguments to build the command line arguments.

Inherited from _BasicOptions:

Method __init__ Undocumented
Method coverdir Return a FilePath representing the directory into which coverage results should be written.
Method get​Synopsis Undocumented
Method opt​_coverage Generate coverage information in the coverage file in the directory specified by the temp-directory option.
Method opt​_disablegc Disable the garbage collector
Method opt​_help​_orders Undocumented
Method opt​_help​_reporters Undocumented
Method opt​_random Undocumented
Method opt​_recursionlimit see sys.setrecursionlimit()
Method opt​_spew Print an insanely verbose log of everything that happens. Useful when debugging freezes or locks in complex code.
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​_testmodule Filename to grep for test cases (-*- test-case-name).
Method opt​_without​_module Fake the lack of the specified modules, separated with commas.
Method parse​Args Undocumented
Class Variable longdesc Undocumented
Method _load​Reporter​By​Name Undocumented

Inherited from Options:

Method __init__ Undocumented
Method __str__ Undocumented
Method get​Synopsis Returns a string containing a description of these options and how to pass them to the executed file.
Method get​Usage Undocumented
Method opt​_help Display this help and exit.
Method opt​_version Display Twisted version and exit.
Method parse​Args I am called with any leftover arguments which were not options.
Method parse​Options The guts of the command-line parser.
Class Variable completion​Data Undocumented
Class Variable default​Sub​Command Undocumented
Class Variable parent Undocumented
Instance Variable defaults Undocumented
Instance Variable docs Undocumented
Instance Variable long​Opt Undocumented
Instance Variable opts Undocumented
Instance Variable short​Opt Undocumented
Instance Variable sub​Command Undocumented
Instance Variable sub​Options Undocumented
Instance Variable synonyms Undocumented
Method _gather​_flags Gather up boolean (flag) options.
Method _gather​_handlers Gather up options with their own handler methods.
Method _gather​_parameters Gather options which take a value.
Method _generic​_flag Undocumented
Instance Variable _dispatch Undocumented

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)
Class Variable _get​Reactor​Types Undocumented
def opt_jobs(self, number): (source)
Number of local workers to run, a strictly positive integer.
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.

compData = (source)
overrides twisted.scripts.trial._BasicOptions.compData

Undocumented

extra = (source)

Undocumented

optFlags: list = (source)
overrides twisted.scripts.trial._BasicOptions.optFlags

Undocumented

optParameters: list = (source)
overrides twisted.scripts.trial._BasicOptions.optParameters

Undocumented

tracer = (source)
overrides twisted.scripts.trial._BasicOptions.tracer

Undocumented

def _getWorkerArguments(self): (source)
Return a list of options to pass to distributed workers.
_workerFlags: list = (source)
List of flags which are accepted by trial distributed workers. This is used by _getWorkerArguments to build the command line arguments.
_workerParameters: list = (source)
List of parameter which are accepted by trial distributed workers. This is used by _getWorkerArguments to build the command line arguments.