class documentation

class Output(TransformSpec): (source)

Known subclasses: docutils.io.FileOutput, docutils.io.NullOutput, docutils.io.StringOutput

View In Hierarchy

Abstract base class for output wrappers.
Method __init__ Undocumented
Method __repr__ Undocumented
Method encode Undocumented
Method write data is a Unicode string, to be encoded by self.encode.
Class Variable component​_type Undocumented
Class Variable default​_destination​_path Undocumented
Instance Variable destination The destination for output data.
Instance Variable destination​_path A text reference to the destination.
Instance Variable encoding Text encoding for the output destination.
Instance Variable error​_handler Text encoding error handler.

Inherited from TransformSpec:

Method get​_transforms Transforms required by this class. Override in subclasses.
Class Variable default​_transforms Undocumented
Class Variable unknown​_reference​_resolvers No summary
def __init__(self, destination=None, destination_path=None, encoding=None, error_handler='strict'): (source)

Undocumented

def __repr__(self): (source)

Undocumented

def encode(self, data): (source)

Undocumented

def write(self, data): (source)
data is a Unicode string, to be encoded by self.encode.
component_type: str = (source)

Undocumented

default_destination_path = (source)

Undocumented

destination = (source)
The destination for output data.
destination_path = (source)
A text reference to the destination.
encoding = (source)
Text encoding for the output destination.
error_handler = (source)
Text encoding error handler.