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`.`python`.`_textattributes`.`_NormalAttr``

class documentation

`class _NormalAttr(_Attribute): (source)`

View In Hierarchy

A text attribute for normal text.

Method | `serialize` | Serialize the text attribute and its children.

Inherited from `_Attribute`:

Method | `__getitem__` | Undocumented
Method | `__init__` | Undocumented
Method | `__repr__` | Undocumented
Class Variable | `compareAttributes` | Undocumented
Instance Variable | `children` | Child attributes.

Inherited from `FancyEqMixin` (via `_Attribute`):

Method | `__eq__` | Undocumented
Method | `__ne__` | Undocumented

def serialize(self, write, attrs, attributeRenderer): (source)
overrides `twisted.python._textattributes._Attribute.serialize`

Serialize the text attribute and its children.

Parameters
write | `callable`, taking one `str` argument, called to output a single text attribute at a time.
attrs | A formatting state instance used to determine how to serialize the attribute children.
attributeRenderer:`str` | Name of the method on attrs that should be called to render the attributes during serialization. Defaults to `'toVT102'`.