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`.`trial`.`runner`.`TrialRunner``

class documentation

`class TrialRunner: (source)`

View In Hierarchy

A specialised runner that the trial front end uses.

Method | `__init__` | Undocumented
Method | `run` | Run the test or suite and return a result object.
Method | `runUntilFailure` | Repeatedly run `test` until it fails.
Constant | `DEBUG` | Undocumented
Constant | `DRY_RUN` | Undocumented
Instance Variable | `debugger` | Undocumented
Instance Variable | `logfile` | Undocumented
Instance Variable | `mode` | Undocumented
Instance Variable | `reporterFactory` | Undocumented
Instance Variable | `rterrors` | Undocumented
Instance Variable | `stream` | Undocumented
Instance Variable | `tbformat` | Undocumented
Instance Variable | `uncleanWarnings` | Undocumented
Instance Variable | `workingDirectory` | Undocumented
Method | `_makeResult` | Undocumented
Method | `_runWithoutDecoration` | Private helper that runs the given test but doesn't decorate it.
Method | `_setUpLogFile` | Undocumented
Method | `_setUpTestdir` | Undocumented
Method | `_tearDownLogFile` | Undocumented
Method | `_tearDownTestdir` | Undocumented
Instance Variable | `_exitFirst` | Undocumented
Instance Variable | `_forceGarbageCollection` | Undocumented
Instance Variable | `_logFileObject` | Undocumented
Instance Variable | `_logFileObserver` | Undocumented
Instance Variable | `_result` | Undocumented
Instance Variable | `_testDirLock` | Undocumented

def __init__(self, reporterFactory, mode=None, logfile='test.log', stream=sys.stdout, profile=False, tracebackFormat='default', realTimeErrors=False, uncleanWarnings=False, workingDirectory=None, forceGarbageCollection=False, debugger=None, exitFirst=False): (source)

Undocumented

def run(self, test): (source)

Run the test or suite and return a result object.

def runUntilFailure(self, test): (source)

Repeatedly run `test` until it fails.

DEBUG: `str` = (source)

Undocumented

Value

    'debug'

DRY_RUN: `str` = (source)

Undocumented

Value

    'dry-run'

debugger = (source)

Undocumented

logfile = (source)

Undocumented

mode = (source)

Undocumented

reporterFactory = (source)

Undocumented

rterrors = (source)

Undocumented

stream = (source)

Undocumented

tbformat = (source)

Undocumented

uncleanWarnings = (source)

Undocumented

workingDirectory = (source)

Undocumented

def _makeResult(self): (source)

Undocumented

def _runWithoutDecoration(self, test, forceGarbageCollection=False): (source)

Private helper that runs the given test but doesn't decorate it.

def _setUpLogFile(self): (source)

Undocumented

def _setUpTestdir(self): (source)

Undocumented

def _tearDownLogFile(self): (source)

Undocumented

def _tearDownTestdir(self, oldDir): (source)

Undocumented

_exitFirst = (source)

Undocumented

_forceGarbageCollection = (source)

Undocumented

_logFileObject = (source)

Undocumented

_logFileObserver = (source)

Undocumented

_result = (source)

Undocumented

_testDirLock = (source)

Undocumented