docutils.readers.pep.Reader

class documentation

class Reader(standalone.Reader): (source)

Undocumented

Method	`__init__`	`parser` should be ``None``.
Method	`get_transforms`	Transforms required by this class. 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	`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	`settings_default_overrides`	A dictionary of auxiliary defaults, to override defaults for settings defined in other components' `setting_specs`. Override in subclasses.
Class Variable	`settings_spec`	Runtime settings specification. Override in subclasses.
Class Variable	`supported`	Contexts this reader supports.

Inherited from Reader:

Class Variable document A single document tree.

Inherited from Reader (via Reader):

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.
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, Reader):

Method supports Is `format` supported by this component?

Inherited from SettingsSpec (via Reader, Reader, 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_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 Reader, Reader, Component):

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.transforms...

def __init__(self, parser=None, parser_name=None): (source)

overrides docutils.readers.Reader.__init__

`parser` should be ``None``.

def get_transforms(self): (source)

overrides docutils.readers.standalone.Reader.get_transforms

Transforms required by this class. Override in subclasses.

config_section: str = (source)

overrides docutils.readers.standalone.Reader.config_section

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

config_section_dependencies: tuple[str, ...] = (source)

overrides docutils.readers.standalone.Reader.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_default_overrides: dict[str, int] = (source)

overrides docutils.SettingsSpec.settings_default_overrides

A dictionary of auxiliary defaults, to override defaults for settings defined in other components' `setting_specs`. Override in subclasses.

settings_spec: tuple = (source)

overrides docutils.readers.standalone.Reader.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, ...] = (source)

overrides docutils.readers.standalone.Reader.supported

Contexts this reader supports.