|
Package docutils ::
Package readers ::
Class Reader
|
|
Class Reader
SettingsSpec --+
|
TransformSpec --+
|
Component --+
|
Reader
- Known Subclasses:
-
Reader
Abstract base class for docutils Readers.
Each reader module or package must export a subclass also called 'Reader'.
The three steps of a Reader's responsibility are defined: scan(),
parse(), and transform(). Call read() to process a document.
| Method Summary |
| |
__init__(self,
parser,
parser_name)
Initialize the Reader instance. |
| |
new_document(self)
Create and return a new empty document tree (root node). |
| |
parse(self)
Parse self.input into a document tree. |
| |
read(self,
source,
parser,
settings)
|
| |
set_parser(self,
parser_name)
Set self.parser by name. |
Inherited from Component:
supports
|
__init__(self,
parser=None,
parser_name='restructuredtext')
(Constructor)
Initialize the Reader instance.
Several instance attributes are defined with dummy initial values.
Subclasses may use these attributes as they wish.
-
|
new_document(self)
Create and return a new empty document tree (root node). -
|
parse(self)
Parse self.input into a document tree. -
|
set_parser(self,
parser_name)
Set self.parser by name. -
|
component_type
-
- Type:
-
str
- Value:
|