docutils.parsers.rst.Parser

class documentation

class Parser(docutils.parsers.Parser):

View In Hierarchy

The reStructuredText parser.
Method __init__ Undocumented
Method get​_transforms Transforms required by this class. Override in subclasses.
Method parse Parse inputstring and populate document, a document tree.
Class Variable config​_section The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
Class Variable config​_section​_dependencies No summary
Class Variable settings​_spec Runtime settings specification. Override in subclasses.
Class Variable supported Aliases this parser supports.
Instance Variable initial​_state Undocumented
Instance Variable inliner Undocumented
Instance Variable state​_classes Undocumented
Instance Variable statemachine Undocumented

Inherited from Parser:

Method finish​_parse Finalize parse details. Call at end of self.parse().
Method setup​_parse Initial parse setup. Call at start of self.parse().
Class Variable component​_type Name of the component type ('reader', 'parser', 'writer'). Override in subclasses.
Instance Variable document Undocumented
Instance Variable inputstring Undocumented

Inherited from Component (via Parser):

Method supports Is format supported by this component?

Inherited from SettingsSpec (via Parser, Component):

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.

Inherited from TransformSpec (via Parser, Component):

Class Variable default​_transforms Undocumented
Class Variable unknown​_reference​_resolvers No summary
def __init__(self, rfc2822=False, inliner=None):

Undocumented

def get_transforms(self):
overrides docutils.TransformSpec.get_transforms
Transforms required by this class. Override in subclasses.
def parse(self, inputstring, document):
overrides docutils.parsers.Parser.parse
Parse inputstring and populate document, a document tree.
config_section: str =
overrides docutils.parsers.Parser.config_section
The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
config_section_dependencies: tuple[str, ...] =
overrides docutils.SettingsSpec.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. The "general" section is assumed implicitly. Override in subclasses.
settings_spec =
overrides docutils.parsers.Parser.settings_spec

Runtime settings specification. Override in subclasses.

Defines runtime settings and associated command-line options, as used by docutils.frontend.OptionParser. This is a tuple of:

  • Option group title (string or None which implies no group, just a list of single options).

  • Description (string or None).

  • A sequence of option tuples. Each consists of:

    • Help text (string)

    • List of option strings (e.g. ['-Q', '--quux']).

    • Dictionary of keyword arguments sent to the OptionParser/OptionGroup add_option method.

      Runtime setting names are derived implicitly from long option names ('--a-setting' becomes settings.a_setting) or explicitly from the 'dest' keyword argument.

      Most settings will also have a 'validator' keyword & function. The validator function validates setting values (from configuration files and command-line option arguments) and converts them to appropriate types. For example, the docutils.frontend.validate_boolean function, required by all boolean settings, converts true values ('1', 'on', 'yes', and 'true') to 1 and false values ('0', 'off', 'no', 'false', and '') to 0. Validators need only be set once per setting. See the docutils.frontend.validate_* functions.

      See the optparse docs for more details.

  • More triples of group title, description, options, as many times as needed. Thus, settings_spec tuples can be simply concatenated.

supported: tuple[str, ...] =
overrides docutils.Component.supported
Aliases this parser supports.
initial_state: str =

Undocumented

inliner =

Undocumented

state_classes =

Undocumented

statemachine =

Undocumented