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`.`_dist`.`disttrial``

module documentation
(source)

This module contains the trial distributed runner, the management class responsible for coordinating all of trial's behavior at the highest level.

Present Since
12.3

Interface | `IDistTrialReactor` | The reactor interfaces required by disttrial.
Class | `DistTrialRunner` | A specialized runner for distributed trial. The runner launches a number of local worker processes which will run tests.
Class | `StartedWorkerPool` | A pool of workers which have already been started.
Class | `WorkerPool` | Manage a fixed-size collection of child processes which can run tests.
Class | `WorkerPoolConfig` | Configuration parameters for a pool of test-running workers.
Async Function | `runTests` | Undocumented
Function | `shouldContinue` | Determine whether the test suite should be iterated again.
Function | `_defaultReactor` | Get the default reactor, ensuring it is suitable for use with disttrial.

async def runTests(pool: `StartedWorkerPool`, testCases: `Iterable[ITestCase]`, result: `DistReporter`, driveWorker: `Callable[[DistReporter, Sequence[ITestCase], LocalWorkerAMP], Awaitable[None]]`): (source)

Undocumented

def shouldContinue(untilFailure: `bool`, result: `IReporter`) -> `bool`: (source)

Determine whether the test suite should be iterated again.

Parameters
untilFailure:`bool` | `True` if the suite is supposed to run until failure.
result:`IReporter` | The test result of the test suite iteration which just completed.
Returns
`bool` | Undocumented

def _defaultReactor() -> `IDistTrialReactor`: (source)

Get the default reactor, ensuring it is suitable for use with disttrial.