Inheritance diagram for docutils.readers.Reader:

Collaboration diagram for docutils.readers.Reader:

Public Member Functions
	get_transforms (self)

	__init__ (self, parser=None, parser_name=None)

	set_parser (self, parser_name)

	read (self, source, parser, settings)

	parse (self)

	new_document (self)

Public Member Functions inherited from docutils.Component
	supports (self, format)

Public Attributes
	parser

	source

	input

	settings

	document

Public Attributes inherited from docutils.TransformSpec
	default_transforms

Static Public Attributes
str	component_type = 'reader'

str	config_section = 'readers'

Static Public Attributes inherited from docutils.Component
	component_type = None

tuple	supported = ()

Static Public Attributes inherited from docutils.SettingsSpec
tuple	settings_spec = ()

	settings_defaults = None

	settings_default_overrides = None

tuple	relative_path_settings = ()

	config_section = None

	config_section_dependencies = None

Static Public Attributes inherited from docutils.TransformSpec
tuple	default_transforms = ()

tuple	unknown_reference_resolvers = ()

Detailed Description

Abstract base class for docutils Readers.

Each reader module or package must export a subclass also called 'Reader'.

The two steps of a Reader's responsibility are to read data from the
source Input object and parse the data with the Parser object.
Call `read()` to process a document.

Constructor & Destructor Documentation

◆ init()

docutils.readers.Reader.__init__	(	self,
		parser = `None`,
		parser_name = `None`
	)

Initialize the Reader instance.

Several instance attributes are defined with dummy initial values.
Subclasses may use these attributes as they wish.

Reimplemented in docutils.readers.pep.Reader.

Member Function Documentation

◆ get_transforms()

docutils.readers.Reader.get_transforms ( self )

Transforms required by this class.  Override in subclasses.

Reimplemented from docutils.TransformSpec.

Reimplemented in docutils.readers.ReReader, docutils.readers.pep.Reader, and docutils.readers.standalone.Reader.

◆ new_document()

docutils.readers.Reader.new_document ( self )

Create and return a new empty document tree (root node).

◆ parse()

docutils.readers.Reader.parse ( self )

Parse `self.input` into a document tree.

Reimplemented in docutils.readers.doctree.Reader.

◆ set_parser()

docutils.readers.Reader.set_parser	(	self,
		parser_name
	)

Set `self.parser` by name.

The documentation for this class was generated from the following file:

docs/help/help-venv/lib/python3.12/site-packages/docutils/readers/__init__.py

Public Member Functions

Public Attributes

Static Public Attributes