docutils.io.StringOutput Class Reference

Inheritance diagram for docutils.io.StringOutput:

Collaboration diagram for docutils.io.StringOutput:

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

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

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

Detailed Description

Output to a `bytes` or `str` instance.

Provisional.

Member Function Documentation

write()

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

Store `data` in `self.destination`, and return it.

If `self.encoding` is set to the pseudo encoding name "unicode",
`data` must be a `str` instance and is stored/returned unchanged
(cf. `Output.encode`).

Otherwise, `data` can be a `bytes` or `str` instance and is
stored/returned as a `bytes` instance
(`str` data is encoded with `self.encode()`).

Attention: the `output_encoding`_ setting may affect the content
of the output (e.g. an encoding declaration in HTML or XML or the
representation of characters as LaTeX macro vs. literal character).

Reimplemented from docutils.io.Output.

---

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

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