mwparserfromhell/mwparserfromhell/parser/__init__.py

# -*- coding: utf-8  -*-
#
# Copyright (C) 2012 Ben Kurtovic <ben.kurtovic@verizon.net>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

"""
This package contains the actual wikicode parser, split up into two main
modules: the :py:mod:`~mwparserfromhell.parser.tokenizer` and the
:py:mod:`~mwparserfromhell.parser.builder`. This module joins them together
under one interface.
"""

try:
    from ._builder import CBuilder as Builder
    from ._tokenizer import CTokenizer as Tokenizer
except ImportError:
    from .builder import Builder
    from .tokenizer import Tokenizer

__all__ = ["Parser"]

class Parser(object):
    """Represents a parser for wikicode.

    Actual parsing is a two-step process: first, the text is split up into a
    series of tokens by the
    :py:class:`~mwparserfromhell.parser.tokenizer.Tokenizer`, and then the
    tokens are converted into trees of
    :py:class:`~mwparserfromhell.wikicode.Wikicode` objects and
    :py:class:`~mwparserfromhell.nodes.Node`\ s by the
    :py:class:`~mwparserfromhell.parser.builder.Builder`.
    """

    def __init__(self, text):
        self.text = text
        self._tokenizer = Tokenizer()
        self._builder = Builder()

    def parse(self):
        """Return a string as a parsed ``Wikicode`` object tree."""
        tokens = self._tokenizer.tokenize(self.text)
        code = self._builder.build(tokens)
        return code