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`.`runner`.`procmon`.`_Process``

class documentation

`class _Process: (source)`

View In Hierarchy

The parameters of a process to be restarted.

Method | `toTuple` | Convert process to tuple.
Instance Variable | `args` | command-line arguments (including name of command as first one)
Instance Variable | `cwd` | initial working directory for process or None (which means inherit cwd)
Instance Variable | `env` | environment for process
Instance Variable | `gid` | group-id to run process as, or None (which means inherit gid)
Instance Variable | `uid` | user-id to run process as, or None (which means inherit uid)

def toTuple(self): (source)
Deprecated since version 18.7.0: `toTuple` was deprecated in Twisted 18.7.0.

Convert process to tuple.

Convert process to tuple that looks like the legacy structure of processes, for potential users who inspected processes directly.

This was only an accidental feature, and will be removed. If you need to remember what processes were added to a process monitor, keep track of that when they are added. The process list inside the process monitor is no longer a public API.

This allows changing the internal structure of the process list, when warranted by bug fixes or additional features.

Returns
tuple representation of process

args: `list` = (source)

command-line arguments (including name of command as first one)

cwd: `str` = (source)

initial working directory for process or None (which means inherit cwd)

env: `dict` = (source)

environment for process

gid: `int` = (source)

group-id to run process as, or None (which means inherit gid)

uid: `int` = (source)

user-id to run process as, or None (which means inherit uid)