class documentation

class DocTreeInput(Input):

View In Hierarchy

Adapter for document tree input.

The document tree must be passed in the source parameter.

Method read Return the document tree.
Class Variable default​_source​_path Undocumented

Inherited from Input:

Method __init__ Undocumented
Method __repr__ Undocumented
Method decode Decode a string, data, heuristically. Raise UnicodeError if unsuccessful.
Method determine​_encoding​_from​_data Try to determine the encoding of data by looking in data. Check for a byte order mark (BOM) or an encoding declaration.
Class Variable byte​_order​_marks Sequence of (start_bytes, encoding) tuples for encoding detection. The first bytes of input data are checked against the start_bytes strings. A match indicates the given encoding.
Class Variable coding​_slug Encoding declaration pattern.
Class Variable component​_type Undocumented
Instance Variable encoding Text encoding for the input source.
Instance Variable error​_handler Text decoding error handler.
Instance Variable source The source of input data.
Instance Variable source​_path A text reference to the source.
Instance Variable successful​_encoding The encoding that successfully decoded the source data.

Inherited from TransformSpec (via Input):

Method get​_transforms Transforms required by this class. Override in subclasses.
Class Variable default​_transforms Undocumented
Class Variable unknown​_reference​_resolvers No summary
def read(self):
Return the document tree.
default_source_path: str =

Undocumented