docutils.io.Output

class documentation

class Output(TransformSpec): (source)

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

Constructor: Output(destination, destination_path, encoding, error_handler)

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 List of functions to try to resolve unknown references. Unknown references have a 'refname' attribute which doesn't correspond to any target in the document. Called when the transforms in docutils.tranforms.references...
def __init__(self, destination=None, destination_path=None, encoding=None, error_handler='strict'): (source)
overridden in docutils.io.FileOutput

Undocumented

def __repr__(self): (source)

Undocumented

def encode(self, data): (source)

Undocumented

def write(self, data): (source)
overridden in docutils.io.FileOutput, docutils.io.NullOutput, docutils.io.StringOutput

data is a Unicode string, to be encoded by self.encode.

component_type: str = (source)

Undocumented

default_destination_path = (source)
overridden in docutils.io.NullOutput, docutils.io.StringOutput

Undocumented

destination = (source)
overridden in docutils.io.FileOutput, docutils.io.StringOutput

The destination for output data.

destination_path = (source)
overridden in docutils.io.FileOutput

A text reference to the destination.

encoding = (source)

Text encoding for the output destination.

error_handler = (source)

Text encoding error handler.