diff options
-rw-r--r-- | tests/test_html.py | 8 | ||||
-rw-r--r-- | tests/test_texi.py | 6 | ||||
-rw-r--r-- | tests/test_text.py | 8 | ||||
-rw-r--r-- | tests/wikitest.py (renamed from tests/WikiTest.py) | 6 | ||||
-rw-r--r-- | wikitrans/__init__.py (renamed from WikiTrans/__init__.py) | 0 | ||||
-rw-r--r-- | wikitrans/wiki2html.py (renamed from WikiTrans/wiki2html.py) | 115 | ||||
-rw-r--r-- | wikitrans/wiki2texi.py (renamed from WikiTrans/wiki2texi.py) | 63 | ||||
-rw-r--r-- | wikitrans/wiki2text.py (renamed from WikiTrans/wiki2text.py) | 74 | ||||
-rw-r--r-- | wikitrans/wikidump.py (renamed from WikiTrans/wikidump.py) | 41 | ||||
-rw-r--r-- | wikitrans/wikimarkup.py (renamed from WikiTrans/wikimarkup.py) | 784 | ||||
-rw-r--r-- | wikitrans/wikins.py (renamed from WikiTrans/wikins.py) | 0 | ||||
-rw-r--r-- | wikitrans/wikitoken.py (renamed from WikiTrans/wikitoken.py) | 154 |
12 files changed, 802 insertions, 457 deletions
diff --git a/tests/test_html.py b/tests/test_html.py index 3da57f6..5a15cb8 100644 --- a/tests/test_html.py +++ b/tests/test_html.py @@ -3,11 +3,11 @@ from __future__ import print_function import unittest -from WikiTrans.wiki2html import HtmlWiktionaryMarkup -from WikiTest import populateMethods +from wikitrans.wiki2html import HtmlWikiMarkup +from wikitest import populate_methods -class TestWiktionaryMarkup (unittest.TestCase): +class TestWikiMarkup (unittest.TestCase): pass -populateMethods(TestWiktionaryMarkup, HtmlWiktionaryMarkup, '.html') +populate_methods(TestWikiMarkup, HtmlWikiMarkup, '.html') if __name__ == '__main__': diff --git a/tests/test_texi.py b/tests/test_texi.py index 75314c9..ddd26c7 100644 --- a/tests/test_texi.py +++ b/tests/test_texi.py @@ -3,11 +3,11 @@ from __future__ import print_function import unittest -from WikiTrans.wiki2texi import TexiWikiMarkup -from WikiTest import populateMethods +from wikitrans.wiki2texi import TexiWikiMarkup +from wikitest import populate_methods class TestTexiWikiMarkup (unittest.TestCase): pass -populateMethods(TestTexiWikiMarkup, TexiWikiMarkup, '.texi') +populate_methods(TestTexiWikiMarkup, TexiWikiMarkup, '.texi') if __name__ == '__main__': diff --git a/tests/test_text.py b/tests/test_text.py index a06f519..b3d0a12 100644 --- a/tests/test_text.py +++ b/tests/test_text.py @@ -3,11 +3,11 @@ from __future__ import print_function import unittest -from WikiTrans.wiki2text import TextWiktionaryMarkup -from WikiTest import populateMethods +from wikitrans.wiki2text import TextWikiMarkup +from wikitest import populate_methods -class TestTextWiktionaryMarkup (unittest.TestCase): +class TestTextWikiMarkup (unittest.TestCase): pass -populateMethods(TestTextWiktionaryMarkup, TextWiktionaryMarkup, '.text') +populate_methods(TestTextWikiMarkup, TextWikiMarkup, '.text') if __name__ == '__main__': diff --git a/tests/WikiTest.py b/tests/wikitest.py index 1429f5e..ff26227 100644 --- a/tests/WikiTest.py +++ b/tests/wikitest.py @@ -5,5 +5,5 @@ from glob import glob import os.path -def MarkupTest(classname, name_in, name_out): +def wiki_markup_test(classname, name_in, name_out): fh = open(name_out) buf = ''.join(fh.readlines()).strip() @@ -20,8 +20,8 @@ def MarkupTest(classname, name_in, name_out): return False -def populateMethods(cls, wcls, suffix): +def populate_methods(cls, wcls, suffix): def settest(self, base, wiki_name, pat_name): def dyntest(self): - self.assertTrue(MarkupTest(wcls, wiki_name, pat_name)) + self.assertTrue(wiki_markup_test(wcls, wiki_name, pat_name)) meth = 'test_' + wcls.__name__ + '_' + base dyntest.__name__ = meth diff --git a/WikiTrans/__init__.py b/wikitrans/__init__.py index 5832e38..5832e38 100644 --- a/WikiTrans/__init__.py +++ b/wikitrans/__init__.py diff --git a/WikiTrans/wiki2html.py b/wikitrans/wiki2html.py index 6147642..ce65bae 100644 --- a/WikiTrans/wiki2html.py +++ b/wikitrans/wiki2html.py @@ -16,8 +16,19 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +Wiki markup to HTML translator. + +Classes: + +HtmlWikiMarkup -- Converts Wiki material to HTML. +HtmlWiktionaryMarkup -- Reserved for future use. Currently does the same as + HtmlWikiMarkup. + +""" + from __future__ import print_function -from WikiTrans.wikimarkup import * -from WikiTrans.wikitoken import * -from WikiTrans.wikins import wiki_ns_re, wiki_ns +from wikitrans.wikimarkup import * +from wikitrans.wikitoken import * +from wikitrans.wikins import wiki_ns_re, wiki_ns import re try: @@ -80,6 +91,5 @@ class HtmlLinkNode(HtmlSeqNode): tgt = self.parser.mktgt(arg) return "<a href=\"%s\">%s</a>" % (tgt, - text if (text and text != '') \ - else arg) + text if (text and text != '') else arg) class HtmlRefNode(WikiRefNode): @@ -87,7 +97,8 @@ class HtmlRefNode(WikiRefNode): target = self.ref text = self.content.format() - return "<a href=\"%s\">%s</a>" % (target, - text if (text and text != '') \ - else target) + return "<a href=\"%s\">%s</a>" % ( + target, + text if (text and text != '') else target + ) class HtmlFontNode(HtmlSeqNode): @@ -153,12 +164,12 @@ class HtmlTagNode(WikiTagNode): for ref in self.parser.references: n += 1 - s += ('<li id="cite_note-%d">' + \ - '<span class="mw-cite-backlink">' + \ - '<b><a href="#cite_ref-%d">^</a></b>' + \ - '</span>' + \ - '<span class="reference-text">' + \ - ref.content.format() + \ - '</span>' + \ - '</li>\n') % (n,n) + s += ('<li id="cite_note-%d">' + + '<span class="mw-cite-backlink">' + + '<b><a href="#cite_ref-%d">^</a></b>' + + '</span>' + + '<span class="reference-text">' + + ref.content.format() + + '</span>' + + '</li>\n') % (n,n) s += '</ol>\n</div>\n' return s @@ -188,10 +199,18 @@ class HtmlIndNode(WikiIndNode): -class HtmlWikiMarkup (WikiMarkup): - """ - A (hopefully) general-purpose Wiki->HTML translator class. - FIXME: 1. See WikiMarkup for a list - 2. [[official position]]s : final 's' gets after closing </a> tag. - Should be before. +class HtmlWikiMarkup(WikiMarkup): + """A Wiki markup to HTML translator class. + + Usage: + + x = HtmlWikiMarkup(file="input.wiki") + # Parse the input: + x.parse() + # Print it as HTML: + print(str(x)) + + Known bugs: + * [[official position]]s + Final 's' gets after closing </a> tag. Should be before. """ @@ -199,4 +218,28 @@ class HtmlWikiMarkup (WikiMarkup): references = [] def __init__(self, *args, **kwargs): + """Create a HtmlWikiMarkup object. + + Arguments: + + filename=FILE + Read Wiki material from the file named FILE. + file=FD + Read Wiki material from file object FD. + text=STRING + Read Wiki material from STRING. + lang=CODE + Specifies source language. Default is 'en'. This variable can be + referred to as '%(lang)s' in the keyword arguments below. + html_base=URL + Base URL for cross-references. Default is + 'http://%(lang)s.wiktionary.org/wiki/' + image_base=URL + Base URL for images. Default is + 'http://upload.wikimedia.org/wikipedia/commons/thumb/a/bf' + media_base=URL + Base URL for media files. Default is + 'http://www.mediawiki.org/xml/export-0.3' + """ + super(HtmlWikiMarkup, self).__init__(*args, **kwargs) self.token_class['LINK'] = HtmlLinkNode @@ -271,29 +314,7 @@ class HtmlWikiMarkup (WikiMarkup): return str -class HtmlWiktionaryMarkup (HtmlWikiMarkup): - """ - A class for translating Wiktionary articles into HTML. - This version does not do much, except that it tries to correctly - format templates. But "tries" does not mean "does". The heuristics - used here is clearly not enough to cope with it. - - 1. FIXME: - The right solution would be to have a database of templates with their - semantics and to decide on their rendering depending on that. E.g. - {{term}} in en.wiktionary means "replace this with the search term". - This, however, does not work in other wiktionaries. There are - also more complex templates, e.g.: {{t+|bg|врата|n|p|tr=vrata|sc=Cyrl}} - I don't know what it means. Couldn't find any documentation either. - Again, this template does not work in other dictionaries. +class HtmlWiktionaryMarkup(HtmlWikiMarkup): + """A class for translating Wiktionary articles into HTML. - 2. Capitulation notice: - Given the: - 1. vast amount of wiktionaries available, - 2. abundance of various templates for each wictionary, - 3. apparent lack of documentation thereof, - 4. the lack of standardized language-independent templates, - I dont see any way to cope with the template-rendering task within a - reasonable amount of time. - - Faeci quod potui, faciant meliora potentes. + Reserved for future use. Currently does the same as HtmlWikiMarkup. """ diff --git a/WikiTrans/wiki2texi.py b/wikitrans/wiki2texi.py index 7297195..d9e5f52 100644 --- a/WikiTrans/wiki2texi.py +++ b/wikitrans/wiki2texi.py @@ -16,7 +16,16 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. -from WikiTrans.wikimarkup import * -from WikiTrans.wikitoken import * -from WikiTrans.wikins import wiki_ns_re, wiki_ns +""" +Wiki markup to Texinfo translator. + +Classes: + +TexiWikiMarkup -- Converts Wiki material to Texinfo. + +""" + +from wikitrans.wikimarkup import * +from wikitrans.wikitoken import * +from wikitrans.wikins import wiki_ns_re, wiki_ns import re import urllib @@ -252,5 +261,17 @@ class TexiRefNode(WikiRefNode): parser._print("@uref{%s}" % target, escape=False) -class TexiWikiMarkup (WikiMarkup): +class TexiWikiMarkup(WikiMarkup): + """Wiki markup to Texinfo translator class. + + Usage: + + x = TexiWikiMarkup(file="input.wiki") + # Parse the input: + x.parse() + # Print it as Texi: + print(str(x)) + + """ + nested = 0 sectcomm = { @@ -289,4 +310,38 @@ class TexiWikiMarkup (WikiMarkup): def __init__(self, *args, **keywords): + """Create a TexiWikiMarkup object. + + Arguments: + + filename=FILE + Read Wiki material from the file named FILE. + file=FD + Read Wiki material from file object FD. + text=STRING + Read Wiki material from STRING. + + sectioning_model=MODEL + Select the Texinfo sectioning model for the output document. Possible + values are: + + 'numbered' + Top of document is marked with "@top". Headings ("=", "==", + "===", etc) produce "@chapter", "@section", "@subsection", etc. + 'unnumbered' + Unnumbered sectioning: "@top", "@unnumbered", "@unnumberedsec", + "@unnumberedsubsec". + 'appendix' + Sectioning suitable for appendix entries: "@top", "@appendix", + "@appendixsec", "@appendixsubsec", etc. + 'heading' + Use heading directives to reflect sectioning: "@majorheading", + "@chapheading", "@heading", "@subheading", etc. + sectioning_start=N + Shift resulting heading level by N positions. For example, supposing + "sectioning_model='numbered'", "== A ==" normally produces + "@section A" on output. Now, if given "sectioning_start=1", this + directive will produce "@subsection A" instead. + """ + super(TexiWikiMarkup, self).__init__(*args, **keywords) diff --git a/WikiTrans/wiki2text.py b/wikitrans/wiki2text.py index cb3a183..1fbc61b 100644 --- a/WikiTrans/wiki2text.py +++ b/wikitrans/wiki2text.py @@ -16,7 +16,18 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. -from WikiTrans.wikitoken import * -from WikiTrans.wikimarkup import * -from WikiTrans.wikins import wiki_ns_re, wiki_ns +""" +Wiki markup to plain text translator. + +Classes: + +TextWikiMarkup -- Converts Wiki material to plain text. +TextWiktionaryMarkup -- Reserved for future use. Currently does the same as + TextWikiMarkup. + +""" + +from wikitrans.wikitoken import * +from wikitrans.wikimarkup import * +from wikitrans.wikins import wiki_ns_re, wiki_ns import re try: @@ -108,7 +119,7 @@ class TextLinkNode(WikiSeqNode): return "" text = "[%s: %s]" % (qual, text if text else arg) - tgt = self.image_base + '/' + \ - url_quote(tgt) + \ - '/250px-' + url_quote(tgt) + tgt = "%s/%s/250px-%s" % (self.image_base, + url_quote(tgt), + url_quote(tgt)) elif ns == 'NS_MEDIA': text = "[%s]" % (qual) @@ -142,6 +153,9 @@ class TextBarNode(WikiNode): class TextHdrNode(WikiHdrNode): def format(self): - return "\n" + ("*" * self.level) + " " + \ - self.content.format().lstrip(" ") + "\n\n" + return ("\n" + + ("*" * self.level) + + " " + + self.content.format().lstrip(" ") + + "\n\n") class TextRefNode(WikiRefNode): @@ -205,7 +219,15 @@ class TextTagNode(WikiTagNode): -class TextWikiMarkup (WikiMarkup): - """ - A (general-purpose Wiki->Text translator class. +class TextWikiMarkup(WikiMarkup): + """A Wiki markup to plain text translator. + + Usage: + + x = TextWikiMarkup(file="input.wiki") + # Parse the input: + x.parse() + # Print it as plain text: + print(str(x)) + """ @@ -224,4 +246,23 @@ class TextWikiMarkup (WikiMarkup): def __init__(self, *args, **keywords): + """Create a TextWikiMarkup object. + + Arguments: + + filename=FILE + Read Wiki material from the file named FILE. + file=FD + Read Wiki material from file object FD. + text=STRING + Read Wiki material from STRING. + + width=N + Limit output width to N columns. Default is 78. + show_urls=False + By default, the link URLs are displayed in parentheses next to the + link text. If this argument is given, only the link text will be + displayed. + """ + super(TextWikiMarkup,self).__init__(*args, **keywords) if 'width' in keywords: @@ -259,5 +300,5 @@ class TextWikiMarkup (WikiMarkup): return self.html_base % { 'lang' : lang } + url_quote(tgt) - def indent (self, lev, text): + def indent(self, lev, text): if text.find('\n') == -1: s = (" " * lev) + text @@ -299,8 +340,9 @@ class TextWikiMarkup (WikiMarkup): return str -class TextWiktionaryMarkup (TextWikiMarkup): - """ - See documentation for HtmlWiktionaryMarkup +class TextWiktionaryMarkup(TextWikiMarkup): + """A class for translating Wiktionary articles into plain text. + + Reserved for future use. Currently does the same as TextWikiMarkup. """ - # FIXME: It is supposed to do something about templates + diff --git a/WikiTrans/wikidump.py b/wikitrans/wikidump.py index 7457dfa..d5f651c 100644 --- a/WikiTrans/wikidump.py +++ b/wikitrans/wikidump.py @@ -15,8 +15,17 @@ # along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +Print Wiki parse tree as JSON. + +Classes: + +DumpWikiMarkup + +""" + from __future__ import print_function -from WikiTrans.wikitoken import * +from wikitrans.wikitoken import * import json -from WikiTrans.wikimarkup import WikiMarkup +from wikitrans.wikimarkup import WikiMarkup class DumpReferences(object): @@ -28,11 +37,37 @@ class DumpReferences(object): class DumpWikiMarkup(WikiMarkup): + """Produce a JSON dump of the Wiki markup parse tree. + + Usage: + + x = DumpWikiMarkup(file="input.wiki") + # Parse the input: + x.parse() + # Print a JSON dump of the parse tree + print(str(x)) + + """ + indent = None references = DumpReferences() def __init__(self, **kwarg): + """Create a DumpWikiMarkup object. + + Arguments: + + filename=FILE + Read Wiki material from the file named FILE. + file=FD + Read Wiki material from file object FD. + text=STRING + Read Wiki material from STRING. + indent=N + Basic indent offset for JSON objects. + """ + n = kwarg.pop('indent', None) if n != None: self.indent = int(n) - WikiMarkup.__init__(self, **kwarg) + super(DumpWikiMarkup,self).__init__(self, **kwarg) def __str__(self): return json.dumps(self.tree, diff --git a/WikiTrans/wikimarkup.py b/wikitrans/wikimarkup.py index 6cbf5de..77c3b30 100644 --- a/WikiTrans/wikimarkup.py +++ b/wikitrans/wikimarkup.py @@ -2,32 +2,46 @@ # -*- coding: utf-8 -*- # Copyright (C) 2008-2018 Sergey Poznyakoff -# +# # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 3, or (at your option) # any later version. -# +# # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. -# +# # You should have received a copy of the GNU General Public License # along with this program. If not, see <http://www.gnu.org/licenses/>. +""" +Wiki markup parser. + +This module provides two class: + +WikiMarkupParser: + An abstract parser class, which serves as a base class for all markup + classes in this package. + +WikiMarkup + A subclass of the above, providing basic input method. + +""" + from __future__ import print_function import sys import re from types import * -from WikiTrans.wikitoken import * +from wikitrans.wikitoken import * -__all__ = [ "BaseWikiMarkup", "WikiMarkup", - "TagAttributes", "TagAttributeSyntax" ] +__all__ = [ "WikiMarkupParser", "WikiMarkup", + "TagAttributes", "TagAttributeSyntaxError" ] -class UnexpectedToken(Exception): +class UnexpectedTokenError(Exception): def __init__(self, value): self.value = value -class TagAttributeSyntax(Exception): +class TagAttributeSyntaxError(Exception): def __init__(self, value): self.value = value @@ -36,4 +50,15 @@ class TagAttributeSyntax(Exception): class TagAttributes(object): + """A dictionary-like collection of tag attributes. + + Example: + + attr = TagAttributes('href="foo" length=2') + if 'href' in attr: + print(x['href']) # returns "foo" + for a in attr: + ... + """ + attrstart = re.compile("^(?P<attr>[a-zA-Z0-9_-]+)(?P<eq>=\")?") valseg = re.compile("^[^\\\"]+") @@ -69,5 +94,5 @@ class TagAttributes(object): self.tab[name] = val else: - raise TagAttributeSyntax(s) + raise TagAttributeSyntaxError(s) def __len__(self): return len(self.tab) @@ -90,5 +115,24 @@ class TagAttributes(object): return self.printable -class BaseWikiMarkup(object): +class WikiMarkupParser(object): + """Parser for Wiki markup language. + + Given input in Wiki markup language creates an abstract parse tree for it. + This is a base class for actual parsers. The subclasses must provide the + input method. + + Public methods: + + parse() -- parse the input. + + Abstract methods (must be overridden by the subclass): + + input() -- returns next physical line from the input material. + + Public attributes: + + tree -- constructed parse tree (a subclass of WikiNode) + + """ delim = re.compile("^==+[ \t]*|[ \t]*==+[ \t]*$|(^----$)|^\\*+|^#+|^[;:]+|(\\[\\[)|\\[|(\\{\\{)|(\\]\\])|\\]|(\\}\\})|\\||(\\'\\'\\'?)|<") @@ -96,5 +140,5 @@ class BaseWikiMarkup(object): ctag = re.compile("</(?P<tag>[a-zA-Z0-9_]+)\s*>") refstart = re.compile("^https?://") - + close_delim = { '[': ']', @@ -116,8 +160,11 @@ class BaseWikiMarkup(object): tags = [ 'code', 'nowiki', 'tt', 'div', 'ref', 'references' ] - + debug_level = 0 - + def dprint(self, lev, fmt, *argv): + """If current debug level is greater than or equal to lev, print *argv + according to format. + """ if self.debug_level >= lev: for l in (fmt % argv).split('\n'): @@ -136,5 +183,5 @@ class BaseWikiMarkup(object): 'PRE': WikiContentNode, 'PARA': WikiSeqNode, - 'BAR': WikiNode, + 'BAR': WikiNode, 'SEQ': WikiSeqNode, 'IND': WikiIndNode, @@ -149,8 +196,9 @@ class BaseWikiMarkup(object): } - def __createWikiNode(self,**kwarg): + def _new_node(self,**kwarg): return self.token_class[kwarg['type']](self, **kwarg) - + def tokread(self): + """Read next token from the input. Return it as a subclass of WikiNode.""" line = None pos = 0 @@ -162,11 +210,11 @@ class BaseWikiMarkup(object): except StopIteration: line = u'' - + if not line or line == "": - yield(self.__createWikiNode(type='NIL')) + yield(self._new_node(type='NIL')) break if line == '\n': - yield(self.__createWikiNode(type='NL')) + yield(self._new_node(type='NL')) line = None continue @@ -174,9 +222,9 @@ class BaseWikiMarkup(object): self.dprint(100, "LINE: %s", line[pos:]) m = self.delim.search(line, pos) - + if m: if (pos < m.start(0)): - yield(self.__createWikiNode(type='TEXT', - content=line[pos:m.start(0)])) + yield(self._new_node(type='TEXT', + content=line[pos:m.start(0)])) pos = m.start(0) t = None @@ -192,11 +240,11 @@ class BaseWikiMarkup(object): m = self.ctag.search(line, pos) if m and m.group('tag') == 'nowiki': - yield(self.__createWikiNode(type='TEXT', - content=line[pos:m.start(0)] )) + yield(self._new_node(type='TEXT', + content=line[pos:m.start(0)] )) pos = m.end(0) break - yield(self.__createWikiNode(type='TEXT', - content=line[pos:])) + yield(self._new_node(type='TEXT', + content=line[pos:])) line = self.input() @@ -207,16 +255,17 @@ class BaseWikiMarkup(object): elif m.group('tag') in self.tags: try: - yield(self.__createWikiNode(type='OTAG', + yield(self._new_node(type='OTAG', tag=m.group('tag'), isblock=(line[pos] == '\n'), args=TagAttributes(m.group('args')))) if m.group('closed'): - yield(self.__createWikiNode(type='CTAG', - tag=m.group('tag'))) - except TagAttributeSyntax: - yield(self.__createWikiNode(type='TEXT',content=m.group(0))) + yield(self._new_node(type='CTAG', + tag=m.group('tag'))) + except TagAttributeSyntaxError: + yield(self._new_node(type='TEXT', + content=m.group(0))) continue else: - yield(self.__createWikiNode(type='TEXT',content=m.group(0))) + yield(self._new_node(type='TEXT',content=m.group(0))) continue else: @@ -224,11 +273,11 @@ class BaseWikiMarkup(object): if m: if m.group('tag') in self.tags: - yield(self.__createWikiNode(type='CTAG', - tag=m.group('tag'))) + yield(self._new_node(type='CTAG', + tag=m.group('tag'))) pos = m.end(0) continue else: - yield(self.__createWikiNode(type='TEXT', - content=line[pos:pos+1])) + yield(self._new_node(type='TEXT', + content=line[pos:pos+1])) pos += 1 continue @@ -237,8 +286,8 @@ class BaseWikiMarkup(object): content = m.group(0) if content[0] in self.envtypes: - node = self.__createWikiNode(type='DELIM', - content=content, - isblock=True, - continuation=pos < len(line) and line[pos] == ":") + node = self._new_node(type='DELIM', + content=content, + isblock=True, + continuation=pos < len(line) and line[pos] == ":") if node.continuation: node.content += node.content[0] @@ -248,9 +297,9 @@ class BaseWikiMarkup(object): while pos < len(line) and line[pos] in [' ', '\t']: - pos += 1 + pos += 1 else: - yield(self.__createWikiNode(type='DELIM', - isblock=(content.strip() not in self.inline_delims), - content=content.strip())) + yield(self._new_node(type='DELIM', + isblock=(content.strip() not in self.inline_delims), + content=content.strip())) continue @@ -258,21 +307,31 @@ class BaseWikiMarkup(object): if line[-1] == '\n': if line[pos:-1] != '': - yield(self.__createWikiNode(type='TEXT',content=line[pos:-1])) - yield(self.__createWikiNode(type='NL')) + yield(self._new_node(type='TEXT',content=line[pos:-1])) + yield(self._new_node(type='NL')) else: - yield(self.__createWikiNode(type='TEXT',content=line[pos:])) + yield(self._new_node(type='TEXT',content=line[pos:])) line = None - + def input(self): + """Return next physical line from the input. + + This method must be overridden by the subclass. + """ return None def swaptkn(self, i, j): + """Swap tokens at indices i and j in toklist.""" self.dprint(80, "SWAPPING %s <-> %s", i, j) - x = self.toklist[i] + x = self.toklist[i] self.toklist[i] = self.toklist[j] self.toklist[j] = x def tokenize(self): + """Tokenize the input. + + Read tokens from the input (supplied by the input() method). Place the + obtained tokens in the toklist array. + """ self.toklist = [] for tok in self.tokread(): @@ -287,12 +346,12 @@ class BaseWikiMarkup(object): # 2a. '''''a b'' c d''' # 2b. '''''a b''' c d'' - # + # # 3a. '''a b ''c d''''' # 3b. ''a b '''c d''''' stack = [] for i in range(0,len(self.toklist)): - if self.toklist[i].type == 'DELIM' \ - and (self.toklist[i].content == "''" \ - or self.toklist[i].content == "'''"): + if (self.toklist[i].type == 'DELIM' + and (self.toklist[i].content == "''" + or self.toklist[i].content == "'''")): if len(stack) > 0: if self.toklist[stack[-1]].content == self.toklist[i].content: @@ -304,10 +363,11 @@ class BaseWikiMarkup(object): # and pop off the matching one stack.pop() - elif i < len(self.toklist) \ - and self.toklist[i+1].type == 'DELIM' \ - and self.toklist[stack[-1]].content == self.toklist[i+1].content: + elif (i < len(self.toklist) + and self.toklist[i+1].type == 'DELIM' + and self.toklist[stack[-1]].content + == self.toklist[i+1].content): # Case 3: swap current and next tokens self.swaptkn(i, i+1) - # and pop off the matching one + # and pop off the matching one stack.pop() else: @@ -322,15 +382,19 @@ class BaseWikiMarkup(object): mark = [] - + def push_mark(self): + """Save the current token index on stack.""" self.mark.append(self.tokind) def pop_mark(self): + """Restore the token index from top of stack.""" self.tokind = self.mark.pop() def clear_mark(self): + """Forget the last mark.""" self.mark.pop() - + def lookahead(self, off=0): + """Peek a token at index (tokind+off).""" tok = self.toklist[self.tokind+off] self.dprint(20, "lookahead(%s): %s", off, tok) @@ -338,16 +402,24 @@ class BaseWikiMarkup(object): def setkn(self,val): + """Store token val at the current token index.""" self.toklist[self.tokind] = val - + def getkn(self): + """Get next token from the toklist. Advance tokind.""" self.newline = self.tokind == 0 or self.toklist[self.tokind-1].type == 'NL' if self.tokind == len(self.toklist): - return self.__createWikiNode(type='NIL') + return self._new_node(type='NIL') tok = self.toklist[self.tokind] self.tokind = self.tokind + 1 self.dprint(20, "getkn: %s", tok) return tok - + def ungetkn(self, tok=None): + """Unget the last read token. + + Decrease the tokind by one, so the last read token will be read again. + If optional argument is supplied and is not None, store it in the toklist + in place of the current token. + """ self.tokind = self.tokind - 1 self.newline = self.tokind == 0 or self.toklist[self.tokind-1].type == 'NL' @@ -358,10 +430,12 @@ class BaseWikiMarkup(object): def fixuptkn(self, tok): + """Replace the recently read token by tok.""" if self.tokind == 0: - raise IndexError('wikimarkup.fixuptkn called at start of input') + raise IndexError('WikiMarkupParser.fixuptkn called at start of input') self.toklist[self.tokind-1] = tok return tok - - def dump(self, tree, file=sys.stdout): + + def dump(self, tree, file=sys.stdout): + """Dump the tree to file, node by node.""" for node in tree: file.write(str(node)) @@ -369,4 +443,5 @@ class BaseWikiMarkup(object): def is_block_end(self, tok): + """Return True if tok ends a block environment.""" if tok.type == 'NIL': return True @@ -384,18 +459,19 @@ class BaseWikiMarkup(object): def parse_para(self, tok): + """Read paragraph starting at tok.""" self.dprint(80, "ENTER parse_para: %s", tok) acc = { 'seq': [], 'textlist': [] } - + def flush(): |