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

package documentation
(source)

This package implements the distributed Trial test runner:

- The `twisted.trial._dist.disttrial` module implements a test runner which runs in a manager process and can launch additional worker processes in which to run tests and gather up results from all of them.
- The `twisted.trial._dist.options` module defines command line options used to configure the distributed test runner.
- The `twisted.trial._dist.managercommands` module defines AMP commands which are sent from worker processes back to the manager process to report the results of tests.
- The `twisted.trial._dist.workercommands` module defines AMP commands which are sent from the manager process to the worker processes to control the execution of tests there.
- The `twisted.trial._dist.distreporter` module defines a proxy for `twisted.trial.itrial.IReporter` which enforces the typical requirement that results be passed to a reporter for only one test at a time, allowing any reporter to be used with despite disttrial's simultaneously running tests.
- The `twisted.trial._dist.workerreporter` module implements a `twisted.trial.itrial.IReporter` which is used by worker processes and reports results back to the manager process using AMP commands.
- The `twisted.trial._dist.workertrial` module is a runnable script which is the main point for worker processes.
- The `twisted.trial._dist.worker` process defines the manager's AMP protocol for accepting results from worker processes and a process protocol for use running workers as local child processes (as opposed to distributing them to another host).

Present Since
12.3

Module | `distreporter` | The reporter is not made to support concurrent test running, so we will hold test results in here and only send them to the reporter once the test is over.
Module | `disttrial` | This module contains the trial distributed runner, the management class responsible for coordinating all of trial's behavior at the highest level.
Module | `managercommands` | Commands for reporting test success of failure to the manager.
Module | `options` | Options handling specific to trial's workers.
Module | `worker` | This module implements the worker classes.
Module | `workercommands` | Commands for telling a worker to load tests or run tests.
Module | `workerreporter` | Test reporter forwarding test results over trial distributed AMP commands.
Module | `workertrial` | Implementation of `AMP` worker commands, and main executable entry point for the workers.

From `__init__.py`:

Constant | `_WORKER_AMP_STDIN` | Undocumented
Constant | `_WORKER_AMP_STDOUT` | Undocumented

_WORKER_AMP_STDIN: `int` = (source)

Undocumented

Value

    3

_WORKER_AMP_STDOUT: `int` = (source)

Undocumented

Value

    4