scikits_index / code / docutils / parsers /

# $Id: 5618 2008-07-28 08:37:32Z strank $
# Author: David Goodger <>
# Copyright: This module has been placed in the public domain.

This package contains Docutils parser modules.

__docformat__ = 'reStructuredText'

from docutils import Component

class Parser(Component):

    component_type = 'parser'
    config_section = 'parsers'

    def parse(self, inputstring, document):
        """Override to parse `inputstring` into document tree `document`."""
        raise NotImplementedError('subclass must override this method')

    def setup_parse(self, inputstring, document):
        """Initial parse setup.  Call at start of `self.parse()`."""
        self.inputstring = inputstring
        self.document = document

    def finish_parse(self):
        """Finalize parse details.  Call at end of `self.parse()`."""

_parser_aliases = {
      'restructuredtext': 'rst',
      'rest': 'rst',
      'restx': 'rst',
      'rtxt': 'rst',}

def get_parser_class(parser_name):
    """Return the Parser class from the `parser_name` module."""
    parser_name = parser_name.lower()
    if parser_name in _parser_aliases:
        parser_name = _parser_aliases[parser_name]
    module = __import__(parser_name, globals(), locals())
    return module.Parser