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`.`web`.`template`.`slot``

class documentation

`class slot: (source)`

View In Hierarchy

Marker for markup insertion in a template.

Instance Variable | `children` | The `Tag` objects included in this `slot`'s template.
Instance Variable | `columnNumber` | The column number at which this tag was encountered in the XML file from which it was parsed.
Instance Variable | `default` | The default contents of this slot, if it is left unfilled.
Instance Variable | `filename` | The name of the XML file from which this tag was parsed.
Instance Variable | `lineNumber` | The line number on which this tag was encountered in the XML file from which it was parsed.
Instance Variable | `name` | The name of this slot.

children: `List[Tag]` = (source)

The `Tag` objects included in this `slot`'s template.

columnNumber: `Optional[int]` = (source)

The column number at which this tag was encountered in the XML file from which it was parsed.

If it was not parsed from an XML file, `None`.

default: `Optional[Flattenable]` = (source)

The default contents of this slot, if it is left unfilled.

If this is `None`, an `UnfilledSlot` will be raised, rather than `None` actually being used.

filename: `Optional[str]` = (source)

The name of the XML file from which this tag was parsed.

If it was not parsed from an XML file, `None`.

lineNumber: `Optional[int]` = (source)

The line number on which this tag was encountered in the XML file from which it was parsed.

If it was not parsed from an XML file, `None`.

name: `str` = (source)

The name of this slot.

The key which must be used in `Tag.fillSlots` to fill it.