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`.`worker`.`LocalWorker``

class documentation

`class LocalWorker(ProcessProtocol): (source)`

View In Hierarchy

Local process worker protocol. This worker runs as a local process and communicates via stdin/out.

Method | `__init__` | Undocumented
Method | `childDataReceived` | Handle data received on the specific pipe for the `_ampProtocol`.
Method | `connectionLost` | On connection lost, close the log files that we're managing for stdin and stdout.
Method | `connectionMade` | When connection is made, create the AMP protocol instance.
Method | `errReceived` | Write error data to log.
Method | `outReceived` | Send data received from stdout to log.
Method | `processEnded` | When the process closes, call `connectionLost` for cleanup purposes and forward the information to the `_ampProtocol`.
Instance Variable | `endDeferred` | Undocumented
Instance Variable | `_ampProtocol` | The `AMP` protocol instance used to communicate with the worker.
Instance Variable | `_errLog` | Undocumented
Instance Variable | `_logDirectory` | The directory where logs will reside.
Instance Variable | `_logFile` | The name of the main log file for tests output.
Instance Variable | `_outLog` | Undocumented
Instance Variable | `_testLog` | Undocumented

Inherited from `ProcessProtocol`:

Method | `childConnectionLost` | Called when a file descriptor associated with the child process is closed.
Method | `errConnectionLost` | This will be called when stderr is closed.
Method | `inConnectionLost` | This will be called when stdin is closed.
Method | `outConnectionLost` | This will be called when stdout is closed.
Method | `processExited` | This will be called when the subprocess exits.

Inherited from `BaseProtocol` (via `ProcessProtocol`):

Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

def __init__(self, ampProtocol, logDirectory, logFile): (source)

Undocumented

def childDataReceived(self, childFD, data): (source)
from `twisted.internet.interfaces.IProcessProtocol`
overrides `twisted.internet.protocol.ProcessProtocol.childDataReceived`

Handle data received on the specific pipe for the `_ampProtocol`.

def connectionLost(self, reason): (source)

On connection lost, close the log files that we're managing for stdin and stdout.

def connectionMade(self): (source)
overrides `twisted.internet.protocol.BaseProtocol.connectionMade`

When connection is made, create the AMP protocol instance.

def errReceived(self, data): (source)
overrides `twisted.internet.protocol.ProcessProtocol.errReceived`

Write error data to log.

def outReceived(self, data): (source)
overrides `twisted.internet.protocol.ProcessProtocol.outReceived`

Send data received from stdout to log.

def processEnded(self, reason): (source)
from `twisted.internet.interfaces.IProcessProtocol`
overrides `twisted.internet.protocol.ProcessProtocol.processEnded`

When the process closes, call `connectionLost` for cleanup purposes and forward the information to the `_ampProtocol`.

endDeferred = (source)

Undocumented

_ampProtocol = (source)

The `AMP` protocol instance used to communicate with the worker.

_errLog = (source)

Undocumented

_logDirectory = (source)

The directory where logs will reside.

_logFile = (source)

The name of the main log file for tests output.

_outLog = (source)

Undocumented

_testLog = (source)

Undocumented