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`.`positioning`.`_sentence`.`_PositioningSentenceProducerMixin``

class documentation

`class _PositioningSentenceProducerMixin: (source)`

Known subclasses: `twisted.positioning.nmea.NMEAProtocol`

View In Hierarchy

A mixin for certain protocols that produce positioning sentences.

This mixin helps protocols that store the layout of sentences that they consume in a `_SENTENCE_CONTENTS` class variable provide all sentence attributes that can ever occur. It does this by providing a class method, `getSentenceAttributes`, which iterates over all sentence types and collects the possible sentence attributes.

Class Method | `getSentenceAttributes` | Returns a set of all attributes that might be found in the sentences produced by this protocol.

@classmethod
def getSentenceAttributes(cls): (source)

Returns a set of all attributes that might be found in the sentences produced by this protocol.

This is basically a set of all the attributes of all the sentences that this protocol can produce.

Returns
`set` of `str` | The set of all possible sentence attribute names.