class documentation

class Parser(parsers.Parser): (source)

View In Hierarchy

A do-nothing parser.
Method parse Override to parse inputstring into document tree document.
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 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.
Class Variable supported Names for this component. Override in subclasses.

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.
Class Variable settings​_spec Runtime settings specification. 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):

Method get​_transforms Transforms required by this class. Override in subclasses.
Class Variable default​_transforms Undocumented
Class Variable unknown​_reference​_resolvers No summary
def parse(self, inputstring, document): (source)
Override to parse inputstring into document tree document.
config_section: str = (source)
The name of the config file section specific to this component (lowercase, no brackets). Override in subclasses.
config_section_dependencies: tuple[str, ...] = (source)
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.
supported: tuple[str, ...] = (source)
Names for this component. Override in subclasses.