Home       Trees       Index       Help   

Docutils

Package docutils :: Package readers :: Module pep :: Class Reader
[show private | hide private]
[frames | no frames]

Class Reader

 SettingsSpec --+            
                |            
TransformSpec --+            
                |            
        Component --+        
                    |        
               Reader --+    
                        |    
                   Reader --+
                            |
                           Reader

Method Summary
  __init__(self, parser, parser_name)
parser should be None.
    Inherited from Reader
  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(self, format)
Is format supported by this component?

Class Variable Summary
tuple default_transforms = (<class docutils.transforms.referen...
class inliner_class = docutils.readers.pep.Inliner
dict settings_default_overrides = {'rfc_references': 1, 'pep_...
tuple settings_spec = ('PEP Reader Option Defaults', 'The --pe...
tuple supported = ('pep',)
    Inherited from Reader
NoneType document = None                                                                  
    Inherited from Reader
str component_type = 'reader'
    Inherited from SettingsSpec
tuple relative_path_settings = ()
NoneType settings_defaults = None                                                                  

Method Details

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

parser should be None.
Overrides:
docutils.readers.Reader.__init__

Class Variable Details

default_transforms

Type:
tuple
Value:
(<class docutils.transforms.references.Substitutions at 0x82fbce4>,
 <class docutils.transforms.peps.Headers at 0x83dd7f4>,
 <class docutils.transforms.peps.Contents at 0x8370c3c>,
 <class docutils.transforms.references.ChainedTargets at 0x831275c>,
 <class docutils.transforms.references.AnonymousHyperlinks at 0x832f0c\
4>,
 <class docutils.transforms.references.IndirectHyperlinks at 0x8322c74\
>,
...

settings_default_overrides

Type:
dict
Value:
{'rfc_references': 1, 'pep_references': 1}

settings_spec

Type:
tuple
Value:
('PEP Reader Option Defaults',
 'The --pep-references and --rfc-references options (for the reStructu\
redText parser) are on by default.',
 ())

supported

Type:
tuple
Value:
('pep',)

   Home       Trees       Index       Help   

Docutils

Generated by Epydoc 2.0 on Tue Jul 22 05:30:21 2003 http://epydoc.sf.net