docutils.parsers.Parser

class documentation

class Parser(Component): (source)

Undocumented

Method	`finish_parse`	Finalize parse details. Call at end of `self.parse()`.
Method	`parse`	Override to parse `inputstring` into document tree `document`.
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.
Class Variable	`config_section`	The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
Class Variable	`settings_spec`	Runtime settings specification. Override in subclasses.
Instance Variable	`document`	Undocumented
Instance Variable	`inputstring`	Undocumented

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.

Method	`get_transforms`	Transforms required by this class. Override in subclasses.
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`...

Finalize parse details. Call at end of self.parse().

def parse(self, inputstring, document): (source) ¶

overridden in docutils.parsers.null.Parser, docutils.parsers.recommonmark_wrapper.Parser 0, docutils.parsers.rst.Parser

Override to parse inputstring into document tree document.

def setup_parse(self, inputstring, document): (source) ¶

Initial parse setup. Call at start of self.parse().

overrides docutils.Component.component_type

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

overrides docutils.SettingsSpec.config_section

overridden in docutils.parsers.null.Parser, docutils.parsers.rst.Parser

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

overrides docutils.SettingsSpec.settings_spec

overridden in docutils.parsers.rst.Parser

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.

Undocumented

Undocumented