docutils.readers.Reader

class documentation

class Reader(Component): (source)

Known subclasses: docutils.readers.ReReader, docutils.readers.standalone.Reader

Constructor: Reader(parser, parser_name)

View In Hierarchy

Abstract base class for docutils Readers.

Each reader module or package must export a subclass also called 'Reader'.

The two steps of a Reader's responsibility are to read data from the source Input object and parse the data with the Parser object. Call read() to process a document.

Method __init__ Initialize the Reader instance.
Method get_transforms Transforms required by this class. Override in subclasses.
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:

Method supports Is format supported by this component?
Class Variable supported Names 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. 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, SettingsSpec):

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, parser=None, parser_name=None): (source)
overridden in docutils.readers.pep.Reader

Initialize the Reader instance.

Several instance attributes are defined with dummy initial values. Subclasses may use these attributes as they wish.

def get_transforms(self): (source)
overrides docutils.TransformSpec.get_transforms
overridden in docutils.readers.ReReader, docutils.readers.standalone.Reader

Transforms required by this class. Override in subclasses.

def new_document(self): (source)

Create and return a new empty document tree (root node).

def parse(self): (source)
overridden in docutils.readers.doctree.Reader

Parse self.input into a document tree.

def read(self, source, parser, settings): (source)

Undocumented

def set_parser(self, parser_name): (source)

Set self.parser by name.

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.readers.doctree.Reader, docutils.readers.standalone.Reader

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

document = (source)
overridden in docutils.readers.doctree.Reader, docutils.readers.standalone.Reader

Undocumented

input = (source)

Raw text input; either a single string or, for more complex cases, a collection of strings.

parser = (source)

A parsers.Parser instance shared by all doctrees. May be left unspecified if the document source determines the parser.

settings = (source)

Undocumented

source = (source)

docutils.io IO object, source of input data.