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`.`words`.`xish`.`domish`.`SuxElementStream``

class documentation

`class SuxElementStream(sux.XMLParser): (source)`

View In Hierarchy

Undocumented

Method | `__init__` | Undocumented
Method | `findUri` | Undocumented
Method | `gotCData` | Encountered CDATA
Method | `gotComment` | Encountered comment.
Method | `gotEntityReference` | Encountered mnemonic entity reference
Method | `gotTagEnd` | Encountered closing tag
Method | `gotTagStart` | Encountered an opening tag.
Method | `gotText` | Encountered text
Method | `parse` | Undocumented
Class Variable | `entities` | Undocumented
Instance Variable | `currElem` | Undocumented
Instance Variable | `defaultNsStack` | Undocumented
Instance Variable | `DocumentEndEvent` | Undocumented
Instance Variable | `documentStarted` | Undocumented
Instance Variable | `DocumentStartEvent` | Undocumented
Instance Variable | `ElementEvent` | Undocumented
Instance Variable | `prefixStack` | Undocumented
Instance Variable | `rootElem` | Undocumented

Inherited from `XMLParser`:

Method | `begin_afterslash` | Undocumented
Method | `begin_attrname` | Undocumented
Method | `begin_attrval` | Undocumented
Method | `begin_beforeeq` | Undocumented
Method | `begin_bodydata` | Undocumented
Method | `begin_comment` | Undocumented
Method | `begin_doctype` | Undocumented
Method | `begin_entityref` | Undocumented
Method | `begin_expectcdata` | Undocumented
Method | `begin_messyattr` | Undocumented
Method | `begin_spacebodydata` | Undocumented
Method | `begin_tagstart` | Undocumented
Method | `begin_unentity` | Undocumented
Method | `begin_waitscriptendtag` | Undocumented
Method | `connectionLost` | End the last state we were in.
Method | `connectionMade` | Called when a connection is made.
Method | `dataReceived` | Called whenever data is received.
Method | `do_afterslash` | Undocumented
Method | `do_attrname` | Undocumented
Method | `do_attrs` | Undocumented
Method | `do_attrval` | Undocumented
Method | `do_beforeattrval` | Undocumented
Method | `do_beforeeq` | Undocumented
Method | `do_begin` | Undocumented
Method | `do_bodydata` | Undocumented
Method | `do_cdata` | Undocumented
Method | `do_comment` | Undocumented
Method | `do_doctype` | Undocumented
Method | `do_entityref` | Undocumented
Method | `do_expectcdata` | Undocumented
Method | `do_messyattr` | Undocumented
Method | `do_tagstart` | Undocumented
Method | `do_unentity` | Undocumented
Method | `do_waitforendscript` | Undocumented
Method | `do_waitforgt` | Undocumented
Method | `do_waitscriptendtag` | Undocumented
Method | `end_attrval` | Undocumented
Method | `end_bodydata` | Undocumented
Method | `end_cdata` | Undocumented
Method | `end_doctype` | Undocumented
Method | `end_entityref` | Undocumented
Method | `end_messyattr` | Undocumented
Method | `end_unentity` | Undocumented
Method | `gotDoctype` | Encountered DOCTYPE
Method | `maybeBodyData` | Undocumented
Method | `saveMark` | Get the line number and column of the last character parsed
Class Variable | `beExtremelyLenient` | Undocumented
Class Variable | `filename` | Undocumented
Instance Variable | `attrname` | Undocumented
Instance Variable | `attrval` | Undocumented
Instance Variable | `bodydata` | Undocumented
Instance Variable | `cdatabuf` | Undocumented
Instance Variable | `colno` | Undocumented
Instance Variable | `commentbuf` | Undocumented
Instance Variable | `doctype` | Undocumented
Instance Variable | `encodings` | Undocumented
Instance Variable | `endtag` | Undocumented
Instance Variable | `erefbuf` | Undocumented
Instance Variable | `erefextra` | Undocumented
Instance Variable | `lineno` | Undocumented
Instance Variable | `quotetype` | Undocumented
Instance Variable | `state` | Undocumented
Instance Variable | `tagAttributes` | Undocumented
Instance Variable | `tagName` | Undocumented
Instance Variable | `temptagdata` | Undocumented
Instance Variable | `termtag` | Undocumented
Method | `_buildStateTable` | Return a dictionary of begin, do, end state function tuples
Method | `_decode` | Undocumented
Method | `_parseError` | Undocumented
Instance Variable | `_after_slash_closed` | Undocumented
Instance Variable | `_attrname_termtag` | Undocumented
Instance Variable | `_beforeeq_termtag` | Undocumented
Instance Variable | `_leadingBodyData` | Undocumented
Instance Variable | `_prepend` | Undocumented

Inherited from `Protocol` (via `XMLParser`):

Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable | `factory` | Undocumented

Inherited from `BaseProtocol` (via `XMLParser`, `Protocol`):

Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

def __init__(self): (source)

Undocumented

def findUri(self, prefix): (source)

Undocumented

def gotCData(self, data): (source)
overrides `twisted.web.sux.XMLParser.gotCData`

Encountered CDATA

Default behaviour is to call the gotText method

def gotComment(self, data): (source)
overrides `twisted.web.sux.XMLParser.gotComment`

Encountered comment.

Default behaviour is to ignore.

def gotEntityReference(self, entityRef): (source)
overrides `twisted.web.sux.XMLParser.gotEntityReference`

Encountered mnemonic entity reference

Default behaviour is to print.

def gotTagEnd(self, name): (source)
overrides `twisted.web.sux.XMLParser.gotTagEnd`

Encountered closing tag

Default behaviour is to print.

def gotTagStart(self, name, attributes): (source)
overrides `twisted.web.sux.XMLParser.gotTagStart`

Encountered an opening tag.

Default behaviour is to print.

def gotText(self, data): (source)
overrides `twisted.web.sux.XMLParser.gotText`

Encountered text

Default behaviour is to print.

def parse(self, buffer): (source)

Undocumented

entities: `dict[str, str]` = (source)

Undocumented

currElem = (source)

Undocumented

defaultNsStack: `list` = (source)

Undocumented

DocumentEndEvent = (source)

Undocumented

documentStarted: `bool` = (source)

Undocumented

DocumentStartEvent = (source)

Undocumented

ElementEvent = (source)

Undocumented

prefixStack: `list` = (source)

Undocumented

rootElem = (source)

Undocumented