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`.`application`.`service`.`IServiceMaker``

interface documentation

`class IServiceMaker(Interface): (source)`

Known implementations: `twisted.application.service.ServiceMaker`

View In Hierarchy

An object which can be used to construct services in a flexible way.

This interface should most often be implemented along with `twisted.plugin.IPlugin`, and will most often be used by the 'twistd' command.

Method | `makeService` | Create and return an object providing `twisted.application.service.IService`.
Attribute | `description` | A brief summary of the features provided by this Twisted application plugin.
Attribute | `options` | A `twisted.python.usage.Options` subclass defining the configuration options for this application.
Attribute | `tapname` | A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.

def makeService(options): (source)

Create and return an object providing `twisted.application.service.IService`.

Parameters
options | A mapping (typically a `dict` or `twisted.python.usage.Options` instance) of configuration options to desired configuration values.

description = (source)

A brief summary of the features provided by this Twisted application plugin.

options = (source)

A `twisted.python.usage.Options` subclass defining the configuration options for this application.

tapname = (source)

A short string naming this Twisted plugin, for example 'web' or 'pencil'. This name will be used as the subcommand of 'twistd'.