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`.`plugin`.`CachedDropin``

class documentation

`class CachedDropin: (source)`

Constructor: `CachedDropin(moduleName, description)`

View In Hierarchy

A collection of `CachedPlugin` instances from a particular module in a plugin package.

Method | `__init__` | Undocumented
Instance Variable | `description` | A brief explanation of this collection of plugins (probably the plugin module's docstring).
Instance Variable | `moduleName` | The fully qualified name of the plugin module this represents.
Instance Variable | `plugins` | The `CachedPlugin` instances which were loaded from this dropin.

def __init__(self, moduleName, description): (source)

Undocumented

description: `str` or `None` = (source)

A brief explanation of this collection of plugins (probably the plugin module's docstring).

moduleName: `str` = (source)

The fully qualified name of the plugin module this represents.

plugins: `list` = (source)

The `CachedPlugin` instances which were loaded from this dropin.