docutils.io Namespace Reference

Classes
class	BinaryFileOutput
class	DocTreeInput
class	ErrorOutput
class	FileInput
class	FileOutput
class	Input
class	InputError
class	NullInput
class	NullOutput
class	Output
class	OutputError
class	StringInput
class	StringOutput

Functions
	check_encoding (stream, encoding)
	error_string (err)

Variables
tuple	_locale_encoding

Detailed Description

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

Function Documentation

check_encoding()

docutils.io.check_encoding	(		stream,
			encoding
	)

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.

error_string()

docutils.io.error_string

(

err

)

Return string representation of Exception `err`.

Variable Documentation

_locale_encoding

tuple docutils.io._locale_encoding

protected

Initial value:

=  (locale.getlocale()[1]
                            or locale.getdefaultlocale()[1])