class documentation

class StringInput(Input): (source)

View In Hierarchy

Direct string input.

Method read Decode and return the source string.
Class Variable default_source_path Undocumented

Inherited from Input:

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
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 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 read(self): (source)

Decode and return the source string.

default_source_path: str = (source)

Undocumented