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

class documentation

`class TestHolder: (source)`

Known subclasses: `twisted.trial.runner.ErrorHolder`

Constructor: `TestHolder(description)`

Implements interfaces: `twisted.trial.itrial.ITestCase`

View In Hierarchy

Placeholder for a `TestCase` inside a reporter. As far as a `TestResult` is concerned, this looks exactly like a unit test.

Method | `__call__` | Run the test. Should always do exactly the same thing as run().
Method | `__init__` | No summary
Method | `countTestCases` | Return the number of tests in this test case. Usually 1.
Method | `id` | Return a unique identifier for the test, usually the fully-qualified Python name.
Method | `run` | This test is just a placeholder. Run the test successfully.
Method | `shortDescription` | Return a short description of the test.
Class Variable | `failureException` | The exception class that is raised by failed assertions
Instance Variable | `description` | Undocumented

def __call__(self, result): (source)
from `twisted.trial.itrial.ITestCase`

Run the test. Should always do exactly the same thing as run().

def __init__(self, description): (source)
overridden in `twisted.trial.runner.ErrorHolder`

Parameters
description | A string to be displayed `TestResult`.

def countTestCases(self): (source)
from `twisted.trial.itrial.ITestCase`

Return the number of tests in this test case. Usually 1.

def id(self): (source)
from `twisted.trial.itrial.ITestCase`

Return a unique identifier for the test, usually the fully-qualified Python name.

def run(self, result): (source)
from `twisted.trial.itrial.ITestCase`
overridden in `twisted.trial.runner.ErrorHolder`

This test is just a placeholder. Run the test successfully.

Parameters
result:`twisted.trial.itrial.IReporter`. | The `TestResult` to store the results in.

def shortDescription(self): (source)
from `twisted.trial.itrial.ITestCase`

Return a short description of the test.

failureException = (source)
from `twisted.trial.itrial.ITestCase`

The exception class that is raised by failed assertions

description = (source)

Undocumented