docutils.io.Input

class documentation

class Input(TransformSpec): (source)

Known subclasses: docutils.io.DocTreeInput, docutils.io.FileInput, docutils.io.NullInput, docutils.io.StringInput

View In Hierarchy

Abstract base class for input wrappers.

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`decode`	Decode `data` if required.
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.
Method	`isatty`	Undocumented
Method	`read`	Undocumented
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
Class Variable	`default_source_path`	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:

Method	`get_transforms`	Transforms required by this class. Override in subclasses.
Class Variable	`default_transforms`	Undocumented
Class Variable	`unknown_reference_resolvers`	List of functions to try to resolve unknown references. Unknown references have a 'refname' attribute which doesn't correspond to any target in the document. Called when the transforms in `docutils.transforms...

def __init__(self, source=None, source_path=None, encoding=None, error_handler='strict'): (source)

overridden in docutils.io.FileInput

Undocumented

def __repr__(self): (source)

Undocumented

def decode(self, data): (source)

Decode `data` if required. Return Unicode `str` instances unchanged (nothing to decode). If `self.encoding` is None, determine encoding from data or try UTF-8, locale encoding, and (as last ressort) 'latin-1'. The client application should call ``locale.setlocale`` at the beginning of processing:: locale.setlocale(locale.LC_ALL, '') Raise UnicodeError if unsuccessful.

def determine_encoding_from_data(self, data): (source)

Try to determine the encoding of `data` by looking *in* `data`. Check for a byte order mark (BOM) or an encoding declaration.

def isatty(self): (source)

Undocumented

def read(self): (source)

overridden in docutils.io.DocTreeInput, docutils.io.FileInput, docutils.io.NullInput, docutils.io.StringInput

Undocumented

byte_order_marks = (source)

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.

coding_slug = (source)

Encoding declaration pattern.

component_type: str = (source)

Undocumented

default_source_path = (source)

overridden in docutils.io.DocTreeInput, docutils.io.NullInput, docutils.io.StringInput

Undocumented

encoding = (source)

Text encoding for the input source.

error_handler = (source)

Text decoding error handler.

source = (source)

overridden in docutils.io.FileInput

The source of input data.

source_path = (source)

overridden in docutils.io.FileInput

A text reference to the source.

successful_encoding = (source)

The encoding that successfully decoded the source data.