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`.`_threads`.`_convenience`.`Quit``

class documentation

`class Quit: (source)`

Constructor: `Quit()`

View In Hierarchy

A flag representing whether a worker has been quit.

Method | `__init__` | Create a `Quit` un-set.
Method | `check` | Check if the flag has been set.
Method | `set` | Set the flag if it has not been set.
Instance Variable | `isSet` | Whether this flag is set.

def __init__(self): (source)

Create a `Quit` un-set.

def check(self): (source)

Check if the flag has been set.

Raises
`AlreadyQuit` | If it has been set.

def set(self): (source)

Set the flag if it has not been set.

Raises
`AlreadyQuit` | If it has been set.

isSet: `bool` = (source)

Whether this flag is set.