Created function to translate between sledrun title names and urls.
[philipp/winterrodeln/wrpylib.git] / wrpylib / mwmarkup.py
index ace7362f78bd0322fa3d8eddbf6b8bb74bf6b962..572b30cfc3fed4258e585f18a913946ade9dc7b5 100644 (file)
@@ -1,4 +1,4 @@
-#!/usr/bin/python2.7
+#!/usr/bin/python3.4
 # -*- coding: iso-8859-15 -*-
 # $Id$
 # $HeadURL$
@@ -11,6 +11,8 @@ that convinced me. However, here are the links:
 """
 import re
 import xml.etree.ElementTree
+import collections
+import formencode
 
 
 class ParseError(RuntimeError):
@@ -42,53 +44,107 @@ def find_template(wikitext, template_title):
         (start, end) of the first occurence with start >= 0 and end > start.
         (None, None) if the template is not found.
     """ 
-    match = re.search(u"\{\{" + template_title + "\s*(\|[^\}]*)?\}\}", wikitext,  re.DOTALL)
+    match = re.search("\{\{" + template_title + "\s*(\|[^\}]*)?\}\}", wikitext,  re.DOTALL)
     if match is None: return None, None
     return match.start(), match.end()
 
 
+class TemplateValidator(formencode.FancyValidator):
+    def __init__(self, strip=True, as_table=False, as_table_keylen=None):
+        """Validates a MediaWiki template, e.g. {{Color|red}}
+        :param stip: If strip is True, the title, and the parameter keys and values are stripped in to_python.
+        :param as_table: formats the returned template in one row for each parameter
+        :param as_table_keylen: length of the key field for from_python. None for "automatic"."""
+        self.strip = (lambda s: s.strip()) if strip else (lambda s: s)
+        self.as_table = as_table
+        self.as_table_keylen = as_table_keylen
+
+    def to_python(self, value, state=None):
+        """Takes a template, like u'{{Color|red|text=Any text}}' and translates it to a Python tuple
+        (title, anonym_params, named_params) where title is the template title,
+        anonym_params is a list of anonymous parameters and named_params is a OrderedDict
+        of named parameters. Whitespace of the parameters is stripped."""
+        if not value.startswith('{{'):
+            raise formencode.Invalid('Template does not start with "{{"', value, state)
+        if not value.endswith('}}'):
+            raise formencode.Invalid('Template does not end with "}}"', value, state)
+        parts = value[2:-2].split('|')
+
+        # template name
+        title = self.strip(parts[0])
+        if len(title) == 0:
+            raise formencode.Invalid('Empty template tilte.', value, state)
+        del parts[0]
+
+        # anonymous parameters
+        anonym_params = []
+        while len(parts) > 0:
+            equalsign_pos = parts[0].find('=')
+            if equalsign_pos >= 0: break # named parameter
+            anonym_params.append(self.strip(parts[0]))
+            del parts[0]
+
+        # named or numbered parameters
+        named_params = collections.OrderedDict()
+        while len(parts) > 0:
+            equalsign_pos = parts[0].find('=')
+            if equalsign_pos < 0:
+                raise formencode.Invalid('Anonymous parameter after named parameter.', value, state)
+            key, sep, value = parts[0].partition('=')
+            key = self.strip(key)
+            if len(key) == 0:
+                raise formencode.Invalid('Empty key.', value, state)
+            if key in named_params:
+                raise formencode.Invalid('Duplicate key: "{0}"'.format(key), value, state)
+            named_params[key] = self.strip(value)
+            del parts[0]
+
+        return title, anonym_params, named_params
+
+    def from_python(self, value, state=None):
+        """Formats a MediaWiki template.
+        value is a tuple: (title, anonym_params, named_params)
+        where title is the template title, anonym_params is a list of anonymous parameters and
+        named_params is a dict or OrderedDict of named parameters."""
+        title, anonym_params, named_params = value
+        pipe_char, equal_char, end_char = ('\n| ', ' = ', '\n}}') if self.as_table else ('|', '=', '}}')
+        parts = ["{{" + title]
+        parts += anonym_params
+        as_table_keylen = self.as_table_keylen
+        if self.as_table and as_table_keylen is None:
+            as_table_keylen = max(list(map(len, iter(named_params.keys()))))
+        for k, v in named_params.items():
+            if self.as_table:
+                k = k.ljust(as_table_keylen)
+                parts.append((k + equal_char + v).rstrip())
+            else:
+                parts.append(k + equal_char + v)
+        return pipe_char.join(parts) + end_char
+
+
 def split_template(template):
-    """Takes a template, like u'{{Color|red|text=Any text}}' and translates it to a Python tuple
+    """Deprecated legacy function.
+
+    Takes a template, like u'{{Color|red|text=Any text}}' and translates it to a Python tuple
     (template_title, parameters) where parameters is a Python dictionary {u'1': u'red', u'text'=u'Any text'}.
     Anonymous parameters get integer keys (converted to unicode) starting with 1 
     like in MediaWiki, named parameters are unicode strings.
     Whitespace is stripped.
     If an unexpected format is encountered, a ValueError is raised."""
-    if not template.startswith(u'{{'): raise ValueError(u'Template does not start with "{{"')
-    if not template.endswith(u'}}'): raise ValueError(u'Template does not end with "}}"')
-    parts = template[2:-2].split(u'|')
-
-    # template name
-    template_title = parts[0].strip()
-    if len(template_title) == 0: raise ValueError(u'Empty template tilte.')
-    del parts[0]
-
-    # anonymous parameters
-    params = {} # result dictionary
-    param_num = 1
-    while len(parts) > 0:
-        equalsign_pos = parts[0].find(u'=')
-        if equalsign_pos >= 0: break # named parameter
-        params[unicode(param_num)] = parts[0].strip()
-        del parts[0]
-        param_num += 1
-
-    # named or numbered parameters
-    while len(parts) > 0:
-        equalsign_pos = parts[0].find(u'=')
-        if equalsign_pos < 0: raise ValueError(u'Anonymous parameter after named parameter.')
-        key, sep, value = parts[0].partition(u'=')
-        key = key.strip()
-        if len(key) == 0: raise ValueError(u'Empty key.')
-        if params.has_key(key): raise ValueError(u'Duplicate key: "{0}"'.format(key))
-        params[key] = value.strip()
-        del parts[0]
-
-    return template_title, params
+    try:
+        title, anonym_params, named_params = TemplateValidator().to_python(template)
+        parameters = dict(named_params)
+        for i in range(len(anonym_params)):
+            parameters[str(i+1)] = anonym_params[i]
+    except formencode.Invalid as e:
+        raise ValueError(e[0])
+    return title, parameters
 
 
 def create_template(template_title, anonym_params=[], named_param_keys=[], named_param_values=[], as_table=False, as_table_keylen=None):
-    """Formats a MediaWiki template.
+    """Deprecated legacy function.
+
+    Formats a MediaWiki template.
     :param template_title: Unicode string with the template name
     :param anonym_params: list with parameters without keys
     :param named_param_keys: list with keys of named parameters
@@ -96,19 +152,8 @@ def create_template(template_title, anonym_params=[], named_param_keys=[], named
     :param as_table: formats the returned template in one row for each parameter
     :param as_table_keylen: length of the key field. None for "automatic".
     :return: unicode template"""
-    pipe_char, equal_char, end_char = (u'\n| ', u' = ', u'\n}}') if as_table else (u'|', u'=', u'}}')
-    parts = [u"{{" + template_title]
-    parts += anonym_params
-    if as_table and as_table_keylen is None:
-        as_table_keylen = max([len(k) for k in named_param_keys])
-    for i in xrange(len(named_param_keys)):
-        key = named_param_keys[i]
-        if as_table: 
-            key = key.ljust(as_table_keylen)
-            parts.append((key + equal_char + named_param_values[i]).rstrip())
-        else:
-            parts.append(key + equal_char + named_param_values[i])
-    return pipe_char.join(parts) + end_char
+    named_params = collections.OrderedDict(list(zip(named_param_keys, named_param_values)))
+    return TemplateValidator(as_table=as_table, as_table_keylen=as_table_keylen).from_python((template_title, anonym_params, named_params))
 
 
 def find_tag(wikitext, tagname, pos=0):
@@ -133,7 +178,7 @@ def find_tag(wikitext, tagname, pos=0):
         (None, None, None, None) is returned.
     """
     # Find start tag
-    regexp_starttag = re.compile(u"<{0}.*?(/?)>".format(tagname), re.DOTALL)
+    regexp_starttag = re.compile("<{0}.*?(/?)>".format(tagname), re.DOTALL)
     match_starttag = regexp_starttag.search(wikitext, pos)
     if match_starttag is None:
         return None, None, None, None
@@ -144,7 +189,7 @@ def find_tag(wikitext, tagname, pos=0):
         return match_starttag.start(), None, None, match_starttag.end()
 
     # tag with content
-    regexp_endtag = re.compile(u'</{0}>'.format(tagname), re.DOTALL)
+    regexp_endtag = re.compile('</{0}>'.format(tagname), re.DOTALL)
     match_endtag = regexp_endtag.search(wikitext, match_starttag.end())
     if match_endtag is None:
         # No closing tag - error in wikitext
@@ -194,19 +239,19 @@ def parse_googlemap(wikitext):
 
     def parse_coord(line):
         """Returns (lon, lat, symbol, title). If symbol or text is not present, None is returned."""
-        match = re.match(u'\(([^)]+)\) ?([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+), ?(.*)', line)
+        match = re.match('\(([^)]+)\) ?([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+), ?(.*)', line)
         if not match is None: return (float(match.group(3)), float(match.group(2)), match.group(1), match.group(4))
-        match = re.match(u'\(([^)]+)\) ?([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+)', line)
+        match = re.match('\(([^)]+)\) ?([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+)', line)
         if not match is None: return (float(match.group(3)), float(match.group(2)), match.group(1), None)
-        match = re.match(u'([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+), ?(.*)', line)
+        match = re.match('([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+), ?(.*)', line)
         if not match is None: return (float(match.group(2)), float(match.group(1)), None, match.group(3))
-        match = re.match(u'([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+)', line)
+        match = re.match('([0-9]{1,2}\.[0-9]+), ?([0-9]{1,2}\.[0-9]+)', line)
         if not match is None: return (float(match.group(2)), float(match.group(1)), None, None)
-        return ParseError(u'Could not parse line ' + line)
+        return ParseError('Could not parse line ' + line)
 
     start, content, endtag, end = find_tag(wikitext, 'googlemap')
     if start is None:
-        raise ParseError(u'<googlemap> tag not found.')
+        raise ParseError('<googlemap> tag not found.')
     if content is None:
         xml_only = wikitext[start:endtag]
     else:
@@ -216,7 +261,7 @@ def parse_googlemap(wikitext):
         gm = xml.etree.ElementTree.XML(xml_only.encode('UTF8'))
     except xml.etree.ElementTree.ParseError as e:
         row, column = e.position
-        raise ParseError(u"XML parse error in <googlemap ...>.")
+        raise ParseError("XML parse error in <googlemap ...>.")
 
     # parse attributes
     attributes = {}
@@ -228,7 +273,7 @@ def parse_googlemap(wikitext):
             if gm.get(key) is not None:
                 attributes[key] = int(gm.get(key))
     except ValueError as error:
-        raise ParseError(u'Error at parsing attribute {0} of <googlemap>: {1}'.format(key, unicode(error)))
+        raise ParseError('Error at parsing attribute {0} of <googlemap>: {1}'.format(key, str(error)))
 
     # parse points and lines
     coords = []
@@ -244,7 +289,7 @@ def parse_googlemap(wikitext):
 
         # Handle a path
         if is_path(line):
-            match = re.match(u'([0-9]#[0-9a-fA-F]{8})', line)
+            match = re.match('([0-9]#[0-9a-fA-F]{8})', line)
             style =  match.group(1)
             local_coords = []
             while i < len(lines):
@@ -272,7 +317,7 @@ def parse_googlemap(wikitext):
             coords.append((lon, lat, symbol, title))
             continue
 
-        raise ParseError(u'Unknown line syntax: ' + line)
+        raise ParseError('Unknown line syntax: ' + line)
 
     return (attributes, coords, paths)