docutils.Component

class documentation

class Component(SettingsSpec, TransformSpec): (source)

Known subclasses: docutils.parsers.Parser, docutils.readers.Reader, docutils.writers.Writer

Base class for Docutils components.

Method	`supports`	Is `format` supported by this component?
Class Variable	`component_type`	Name of the component type ('reader', 'parser', 'writer'). Override in subclasses.
Class Variable	`supported`	Names for this component. Override in subclasses.

Inherited from SettingsSpec:

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	`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 SettingsSpec):

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

def supports(self, format): (source) ¶

overridden in docutils.writers.pseudoxml.Writer

Is format supported by this component?

To be used by transforms to ask the dependent component if it supports a certain input context or output format.

component_type = (source) ¶

overridden in docutils.parsers.Parser, docutils.readers.Reader, docutils.writers.Writer

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

supported: tuple = (source) ¶

overridden in docutils.parsers.null.Parser, docutils.parsers.rst.Parser, docutils.readers.doctree.Reader, docutils.readers.standalone.Reader, docutils.writers._html_base.Writer, docutils.writers.docutils_xml.Writer, docutils.writers.latex2e.Writer, docutils.writers.manpage.Writer, docutils.writers.null.Writer, docutils.writers.odf_odt.Writer, docutils.writers.pseudoxml.Writer

Names for this component. Override in subclasses.