Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``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 | `postOptions` | I am called after the options are parsed.
Class Variable | `compData` | Undocumented
Class Variable | `extra` | Undocumented
Class Variable | `optFlags` | Undocumented
Class Variable | `optParameters` | Undocumented
Class Variable | `tracer` | Undocumented
Method | `_getWorkerArguments` | Return a list of options to pass to distributed workers.
Instance Variable | `_workerFlags` | List of flags which are accepted by trial distributed workers. This is used by `_getWorkerArguments` to build the command line arguments.
Instance Variable | `_workerParameters` | 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 | `getSynopsis` | 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 | `parseArgs` | Undocumented
Class Variable | `longdesc` | Undocumented
Method | `_loadReporterByName` | Undocumented

Inherited from `Options` (via `_BasicOptions`):

Method | `__str__` | Undocumented
Method | `getUsage` | Undocumented
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.
Class Variable | `completionData` | Undocumented
Class Variable | `defaultSubCommand` | Undocumented
Class Variable | `parent` | Undocumented
Instance Variable | `defaults` | Undocumented
Instance Variable | `docs` | Undocumented
Instance Variable | `longOpt` | Undocumented
Instance Variable | `opts` | Undocumented
Instance Variable | `shortOpt` | Undocumented
Instance Variable | `subCommand` | Undocumented
Instance Variable | `subOptions` | 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` (via `_BasicOptions`, `Options`):

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 | `_getReactorTypes` | 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.