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

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

No class docstring
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 trial-temp 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_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_extra Add an extra argument. (This is a hack necessary for interfacing with emacs's `gud'.) NOTE: This option is deprecated as of Twisted 11.0
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 I am called with any leftover arguments which were not options.
Method postOptions I am called after the options are parsed.
Method _loadReporterByName Undocumented

Inherited from Options:

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 Undocumented
Method parseOptions The guts of the command-line parser.
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)
def __init__(self): (source)
overrides twisted.python.usage.Options.__init__
Undocumented
def coverdir(self): (source)
Return a FilePath representing the directory into which coverage results should be written.
def opt_coverage(self): (source)
Generate coverage information in the coverage file in the directory specified by the trial-temp option.
def opt_testmodule(self, filename): (source)
Filename to grep for test cases (-*- test-case-name)
def opt_spew(self): (source)
Print an insanely verbose log of everything that happens. Useful when debugging freezes or locks in complex code.
def opt_help_reporters(self): (source)
Undocumented
def opt_disablegc(self): (source)
Disable the garbage collector
def opt_tbformat(self, opt): (source)
Specify the format to display tracebacks with. Valid formats are 'plain', 'emacs', and 'cgitb' which uses the nicely verbose stdlib cgitb.text function
def opt_extra(self, arg): (source)
Add an extra argument. (This is a hack necessary for interfacing with emacs's `gud'.) NOTE: This option is deprecated as of Twisted 11.0
def opt_recursionlimit(self, arg): (source)
see sys.setrecursionlimit()
def opt_random(self, option): (source)
Undocumented
def opt_without_module(self, option): (source)
Fake the lack of the specified modules, separated with commas.
def parseArgs(self, *args): (source)
overrides twisted.python.usage.Options.parseArgs

I am called with any leftover arguments which were not options.

Override me to do something with the remaining arguments on the command line, those which were not flags or options. e.g. interpret them as a list of files to operate on.

Note that if there more arguments on the command line than this method accepts, parseArgs will blow up with a getopt.error. This means if you don't override me, parseArgs will blow up if I am passed any arguments at all!
def _loadReporterByName(self, name): (source)
Undocumented
def postOptions(self): (source)
overrides twisted.python.usage.Options.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 2011-10-27 16:27:37.