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 ​Binary​File​Output A version of docutils.io.FileOutput which writes to a binary file.
Class ​Doc​Tree​Input Adapter for document tree input.
Class ​File​Input Input for single, simple file-like objects.
Class ​File​Output Output for single, simple file-like objects.
Class ​Input Abstract base class for input wrappers.
Class ​Input​Error Undocumented
Class ​Null​Input Degenerate input: read nothing.
Class ​Null​Output Degenerate output: write nothing.
Class ​Output Abstract base class for output wrappers.
Class ​Output​Error Undocumented
Class ​String​Input Direct string input.
Class ​String​Output Direct string output.
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.