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`.`inetdconf`.`SimpleConfFile``

class documentation

`class SimpleConfFile: (source)`

Known subclasses: `twisted.runner.inetdconf.InetdConf`, `twisted.runner.inetdconf.ServicesConf`

View In Hierarchy

Simple configuration file parser superclass.

Filters out comments and empty lines (which includes lines that only contain comments).

To use this class, override parseLine or parseFields.

Method | `parseFields` | Override this.
Method | `parseFile` | Parse a configuration file
Method | `parseLine` | Override this.
Class Variable | `commentChar` | Undocumented
Class Variable | `defaultFilename` | Undocumented

def parseFields(self, *fields): (source)
overridden in `twisted.runner.inetdconf.InetdConf`, `twisted.runner.inetdconf.ServicesConf`

Override this.

def parseFile(self, file=None): (source)

Parse a configuration file

If file is None and self.defaultFilename is set, it will open defaultFilename and use it.

def parseLine(self, line): (source)

Override this.

By default, this will split the line on whitespace and call self.parseFields (catching any errors).

commentChar: `str` = (source)

Undocumented

defaultFilename: `Optional[str]` = (source)
overridden in `twisted.runner.inetdconf.InetdConf`, `twisted.runner.inetdconf.ServicesConf`

Undocumented