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 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 NullInput Degenerate input: read nothing.
Class NullOutput Degenerate output: write nothing.
Class Output Abstract base class for output wrappers.
Class StringInput Direct string input.
Class StringOutput Direct string output.
Exception InputError Undocumented
Exception OutputError Undocumented
Function check_encoding Test, whether the encoding of stream matches encoding.
def check_encoding(stream, encoding): (source) ΒΆ

Test, whether the encoding of stream matches encoding.

Returns

Unknown Field: none
if encoding or stream.encoding are not a valid encoding argument (e.g. None) or `stream.encoding is missing.
Unknown Field: true
if the encoding argument resolves to the same value as encoding,
Unknown Field: false
if the encodings differ.