class documentation

class ReReader(Reader): (source)

Known subclasses: docutils.readers.doctree.Reader

View In Hierarchy

A reader which rereads an existing document tree (e.g. a deserializer).

Often used in conjunction with writers.UnfilteredWriter.

Method get​_transforms Transforms required by this class. Override in subclasses.

Inherited from Reader:

Method __init__ Initialize the Reader instance.
Method new​_document Create and return a new empty document tree (root node).
Method parse Parse self.input into a document tree.
Method read Undocumented
Method set​_parser Set self.parser by name.
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.
Instance Variable document Undocumented
Instance Variable input Raw text input; either a single string or, for more complex cases, a collection of strings.
Instance Variable parser A parsers.Parser instance shared by all doctrees. May be left unspecified if the document source determines the parser.
Instance Variable settings Undocumented
Instance Variable source docutils.io IO object, source of input data.

Inherited from Component (via Reader):

Method supports Is format supported by this component?
Class Variable supported Names for this component. Override in subclasses.

Inherited from SettingsSpec (via Reader, Component):

Class Variable config​_section​_dependencies No summary
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. 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 Reader, Component):

Class Variable default​_transforms Undocumented
Class Variable unknown​_reference​_resolvers No summary
def get_transforms(self): (source)
Transforms required by this class. Override in subclasses.