class documentation
class StringInput(Input): (source)
Constructor: StringInput(source, source_path, encoding, error_handler)
Direct string input.
Method | read |
Decode and return the source string. |
Class Variable | default |
Undocumented |
Inherited from Input
:
Method | __init__ |
Undocumented |
Method | __repr__ |
Undocumented |
Method | decode |
Decode a string, data , heuristically. Raise UnicodeError if unsuccessful. |
Method | determine |
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 |
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 |
Encoding declaration pattern. |
Class Variable | component |
Undocumented |
Instance Variable | encoding |
Text encoding for the input source. |
Instance Variable | error |
Text decoding error handler. |
Instance Variable | source |
The source of input data. |
Instance Variable | source |
A text reference to the source. |
Instance Variable | successful |
The encoding that successfully decoded the source data. |
Inherited from TransformSpec
(via Input
):
Method | get |
Transforms required by this class. Override in subclasses. |
Class Variable | default |
Undocumented |
Class Variable | unknown |
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.tranforms.references ... |