docutils.writers.Writer

class documentation

class Writer(Component): (source)

Known subclasses: docutils.writers._html_base.Writer, docutils.writers.docutils_xml.Writer, docutils.writers.latex2e.Writer, docutils.writers.manpage.Writer, docutils.writers.odf_odt.Writer, docutils.writers.pseudoxml.Writer, docutils.writers.UnfilteredWriter

View In Hierarchy

Abstract base class for docutils Writers. Each writer module or package must export a subclass also called 'Writer'. Each writer must support all standard node types listed in `docutils.nodes.node_class_names`. The `write()` method is the main entry point.

Method __init__ Undocumented
Method assemble_parts Assemble the `self.parts` dictionary. Extend in subclasses.
Method get_transforms Transforms required by this class. Override in subclasses.
Method translate Do final translation of `self.document` into `self.output`. Called from `write`. Override in subclasses.
Method write Process a document into its final form.
Class Variable component_type Name of the component type ('reader', 'parser', 'writer'). Override in subclasses.
Class Variable config_section The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
Class Variable output Final translated form of `document` (Unicode string for text, binary string for other forms); set by `translate`.
Instance Variable destination `docutils.io` Output object; where to write the document. Set by `write`.
Instance Variable document The document to write (Docutils doctree); set by `write`.
Instance Variable language Language module for the document; set by `write`.
Instance Variable parts Mapping of document part names to fragments of `self.output`. Values are Unicode strings; encoding is up to the client. The 'whole' key should contain the entire document output.

Inherited from Component:

Method supports Is `format` supported by this component?
Class Variable supported Name and aliases for this component. Override in subclasses.

Inherited from SettingsSpec (via Component):

Class Variable config_section_dependencies A list of names of config file sections that are to be applied before `config_section`, in order (from general to specific). In other words, the settings in `config_section` are to be overlaid on top of the settings from these sections...
Class Variable relative_path_settings Settings containing filesystem paths. Override in subclasses. Settings listed here are to be interpreted relative to the current working directory.
Class Variable settings_default_overrides A dictionary of auxiliary defaults, to override defaults for settings defined in other components' `setting_specs`. Override in subclasses.
Class Variable settings_defaults A dictionary of defaults for settings not in `settings_spec` (internal settings, intended to be inaccessible by command-line and config file). Override in subclasses.
Class Variable settings_spec Runtime settings specification. Override in subclasses.

Inherited from TransformSpec (via Component):

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.transforms...
def __init__(self): (source)
overridden in docutils.writers.docutils_xml.Writer, docutils.writers.html4css1.Writer, docutils.writers.html5_polyglot.Writer, docutils.writers.latex2e.Writer, docutils.writers.manpage.Writer, docutils.writers.odf_odt.Writer

Undocumented

def assemble_parts(self): (source)
overridden in docutils.writers._html_base.Writer, docutils.writers.latex2e.Writer, docutils.writers.odf_odt.Writer

Assemble the `self.parts` dictionary. Extend in subclasses.

def get_transforms(self): (source)
overrides docutils.TransformSpec.get_transforms
overridden in docutils.writers._html_base.Writer, docutils.writers.latex2e.Writer, docutils.writers.UnfilteredWriter

Transforms required by this class. Override in subclasses.

def translate(self): (source)
overridden in docutils.writers._html_base.Writer, docutils.writers.docutils_xml.Writer, docutils.writers.latex2e.Writer, docutils.writers.manpage.Writer, docutils.writers.null.Writer, docutils.writers.odf_odt.Writer, docutils.writers.pseudoxml.Writer

Do final translation of `self.document` into `self.output`. Called from `write`. Override in subclasses. Usually done with a `docutils.nodes.NodeVisitor` subclass, in combination with a call to `docutils.nodes.Node.walk()` or `docutils.nodes.Node.walkabout()`. The ``NodeVisitor`` subclass must support all standard elements (listed in `docutils.nodes.node_class_names`) and possibly non-standard elements used by the current Reader as well.

def write(self, document, destination): (source)

Process a document into its final form. Translate `document` (a Docutils document tree) into the Writer's native format, and write it out to its `destination` (a `docutils.io.Output` subclass object). Normally not overridden or extended in subclasses.

component_type: str = (source)
overrides docutils.Component.component_type

Name of the component type ('reader', 'parser', 'writer'). Override in subclasses.

config_section: str = (source)
overrides docutils.SettingsSpec.config_section
overridden in docutils.writers._html_base.Writer, docutils.writers.docutils_xml.Writer, docutils.writers.latex2e.Writer, docutils.writers.null.Writer, docutils.writers.odf_odt.Writer, docutils.writers.pseudoxml.Writer

The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.

output = (source)
overridden in docutils.writers._html_base.Writer, docutils.writers.docutils_xml.Writer, docutils.writers.latex2e.Writer, docutils.writers.manpage.Writer, docutils.writers.odf_odt.Writer, docutils.writers.pseudoxml.Writer

Final translated form of `document` (Unicode string for text, binary string for other forms); set by `translate`.

destination = (source)

`docutils.io` Output object; where to write the document. Set by `write`.

document = (source)

The document to write (Docutils doctree); set by `write`.

language = (source)

Language module for the document; set by `write`.

parts: dict = (source)
overridden in docutils.writers.html4css1.Writer, docutils.writers.html5_polyglot.Writer

Mapping of document part names to fragments of `self.output`. Values are Unicode strings; encoding is up to the client. The 'whole' key should contain the entire document output.