class documentation

class UnfilteredWriter(Writer): (source)

Known subclasses: docutils.writers.null.Writer

View In Hierarchy

A writer that passes the document tree on unchanged (e.g. a serializer.) Documents written by UnfilteredWriters are typically reused at a later date using a subclass of `readers.ReReader`.

Method get_transforms Transforms required by this class. Override in subclasses.

Inherited from Writer:

Method __init__ Undocumented
Method assemble_parts Assemble the `self.parts` dictionary. Extend 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 (via Writer):

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

Inherited from SettingsSpec (via Writer, 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 Writer, 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 get_transforms(self): (source)

Transforms required by this class. Override in subclasses.