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

interface documentation

`class IPlugin(Interface): (source)`

Known implementations: `twisted.application.reactors.Reactor`, `twisted.application.service.ServiceMaker`, `twisted.plugins.cred_anonymous.AnonymousCheckerFactory`, `twisted.plugins.cred_file.FileCheckerFactory`, `twisted.plugins.cred_memory.InMemoryCheckerFactory`, `twisted.plugins.cred_sshkeys.SSHKeyCheckerFactory`, `twisted.plugins.cred_unix.UNIXCheckerFactory`, `twisted.protocols.haproxy._parser.HAProxyServerParser`, `twisted.internet.endpoints._StandardIOParser`, `twisted.internet.endpoints._SystemdParser`, `twisted.internet.endpoints._TCP6ServerParser`, `twisted.internet.endpoints._TLSClientEndpointParser`, `twisted.plugins.twisted_trial._Reporter`

View In Hierarchy

Interface that must be implemented by all plugins.

Only objects which implement this interface will be considered for return by `getPlugins`. To be useful, plugins should also implement some other application-specific interface.