docutils.io.Output Class Reference

Inheritance diagram for docutils.io.Output:

Collaboration diagram for docutils.io.Output:

Public Member Functions
	__init__ (self, destination=None, destination_path=None, encoding=None, error_handler='strict')
	__repr__ (self)
	write (self, data)
	encode (self, data)
Public Member Functions inherited from docutils.TransformSpec
	get_transforms (self)

Public Attributes
	encoding
	error_handler
	destination
	destination_path
Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
str	component_type = 'output'
	default_destination_path = None
Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()
tuple	unknown_reference_resolvers = ()

Detailed Description

Abstract base class for output wrappers.

Docutils output objects must provide a `write()` method that
expects and handles one argument (the output).

Inheriting `TransformSpec` allows output objects to add
"transforms" and "unknown_reference_resolvers" to the "Transformer".
(Optional for custom output objects since Docutils 0.19.)

Constructor & Destructor Documentation

__init__()

docutils.io.Output.__init__	(		self,
			destination = None,
			destination_path = None,
			encoding = None,
			error_handler = 'strict'
	)

Reimplemented in sphinx.util.docutils.SphinxFileOutput, and docutils.io.FileOutput.

Member Function Documentation

encode()

docutils.io.Output.encode	(		self,
			data
	)

Encode and return `data`.

If `data` is a `bytes` instance, it is returned unchanged.
Otherwise it is encoded with `self.encoding`.

Provisional: If `self.encoding` is set to the pseudo encoding name
"unicode", `data` must be a `str` instance and is returned unchanged.

write()

docutils.io.Output.write	(		self,
			data
	)

Write `data`. Define in subclasses.

Reimplemented in docutils.io.FileOutput, docutils.io.StringOutput, docutils.io.NullOutput, and sphinx.util.docutils.SphinxFileOutput.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/docutils/io.py