docutils.io

module documentation
(source)

I/O classes provide a uniform API for low-level input and output. Subclasses exist for a variety of input/output mechanisms.

Class BinaryFileOutput A version of docutils.io.FileOutput which writes to a binary file.
Class DocTreeInput Adapter for document tree input.
Class ErrorOutput Wrapper class for file-like error streams with failsafe de- and encoding of `str`, `bytes`, `unicode` and `Exception` instances.
Class FileInput Input for single, simple file-like objects.
Class FileOutput Output for single, simple file-like objects.
Class Input Abstract base class for input wrappers.
Class InputError Undocumented
Class NullInput Degenerate input: read nothing.
Class NullOutput Degenerate output: write nothing.
Class Output Abstract base class for output wrappers.
Class OutputError Undocumented
Class StringInput Direct string input.
Class StringOutput Direct string output.
Function check_encoding Test, whether the encoding of `stream` matches `encoding`.
Function error_string Return string representation of Exception `err`.
Variable _locale_encoding Undocumented
def check_encoding(stream, encoding): (source)

Test, whether the encoding of `stream` matches `encoding`. Returns :None: if `encoding` or `stream.encoding` are not a valid encoding argument (e.g. ``None``) or `stream.encoding is missing. :True: if the encoding argument resolves to the same value as `encoding`, :False: if the encodings differ.

def error_string(err): (source)

Return string representation of Exception `err`.

_locale_encoding = (source)

Undocumented