Fixed unresolved usage of formencode.Invalid (one time with typo).
[philipp/winterrodeln/wrpylib.git] / wrpylib / wrmwmarkup.py
index 27d82e37c7d88285cfcfb7d44477246c6eff3753..0e299fab7f5d5cc71b780c6f661498aa52cceecf 100644 (file)
@@ -2,7 +2,7 @@
 # -*- coding: iso-8859-15 -*-
 # $Id$
 # $HeadURL$
-"""This module contains winterrodeln specific functions that are prcocessing the MediaWiki markup.
+"""This module contains winterrodeln specific functions that are processing the MediaWiki markup.
 """
 import re
 import xml.etree.ElementTree
@@ -20,13 +20,6 @@ class ParseError(RuntimeError):
     pass
 
 
-def _conv(fnct, value, fieldname):
-    """Internal function.
-    Like one of the to_xxx functions (e.g. to_bool), but adds the field name to the error message"""
-    try: return fnct(value)
-    except formencode.Invalid as e: raise formencode.Invalid(u"Conversion error in field '%s': %s" % (fieldname, unicode(e)), e.value, e.state)
-
-
 class RodelbahnboxDictConverter(formencode.Validator):
     """Converts a dict with Rodelbahnbox properties to a Sledrun class. Does no validation."""
 
@@ -95,24 +88,27 @@ class RodelbahnboxDictConverter(formencode.Validator):
         return r
 
 
-class RodelbahnboxTemplateDict(formencode.Validator):
-    """Private helper class for RodelbahnboxValidator"""
+class WinterrodelnTemplateDict(formencode.Validator):
+    """Private helper class for RodelbahnboxValidator or GasthausboxValidator"""
+    def __init__(self, template_title):
+        self.template_title = template_title
+
     def to_python(self, value, state):
         title, anonym_params, named_params = value
-        if title != u'Rodelbahnbox':
-            raise Invalud('Template title has to be "Rodelbahnbox".', value, state)
+        if title != self.template_title:
+            raise formencode.Invalid(u'Template title has to be "{}".'.format(self.template_title), value, state)
         if len(anonym_params) > 0:
-            raise Invalid('No anonymous parameters are allowed in "Rodelbahnbox".', value, state)
+            raise formencode.Invalid(u'No anonymous parameters are allowed in "{}".'.format(self.template_title), value, state)
         return named_params
 
     def from_python(self, value, state):
-        return u'Rodelbahnbox', [], value
+        return self.template_title, [], value
 
 
 class RodelbahnboxValidator(wrpylib.wrvalidators.RodelbahnboxDictValidator):
     def __init__(self):
         wrpylib.wrvalidators.RodelbahnboxDictValidator.__init__(self)
-        self.pre_validators=[wrpylib.mwmarkup.TemplateValidator(as_table=True, as_table_keylen=20), RodelbahnboxTemplateDict()]
+        self.pre_validators=[wrpylib.mwmarkup.TemplateValidator(as_table=True, as_table_keylen=20), WinterrodelnTemplateDict(u'Rodelbahnbox')]
         self.chained_validators = [RodelbahnboxDictConverter()]
 
 
@@ -147,70 +143,84 @@ def sledrun_to_rodelbahnbox(sledrun, version=None):
     return RodelbahnboxValidator().from_python(sledrun)
 
 
+class GasthausboxDictConverter(formencode.Validator):
+    """Converts a dict with Gasthausbox properties to a Inn class. Does no validation."""
+
+    def to_python(self, value, state=None):
+        """value is a dict of properties. If state is an object with the attribute inn, this inn class will be populated or updated."""
+        props = value
+        if isinstance(state, object) and hasattr(state, 'inn'):
+            sledrun = state.sledrun
+        else:
+            class Inn(object):
+                pass
+            inn = Inn()
+        for k, v in props.iteritems():
+            if   k == u'Position': inn.position_latitude, inn.position_longitude = v
+            elif k == u'Höhe': inn.position_elevation = v
+            elif k == u'Betreiber': inn.operator = v
+            elif k == u'Sitzplätze': inn.seats = v
+            elif k == u'Übernachtung': inn.overnight, inn.overnight_comment = v
+            elif k == u'Rauchfrei': inn.nonsmoker_area, inn.smoker_area = v
+            elif k == u'Rodelverleih': inn.sled_rental, inn.sled_rental_comment = v
+            elif k == u'Handyempfang': inn.mobile_provider = v
+            elif k == u'Homepage': inn.homepage = v
+            elif k == u'E-Mail': inn.email_list = v
+            elif k == u'Telefon': inn.phone_list = v
+            elif k == u'Bild': inn.image = v
+            elif k == u'Rodelbahnen': inn.sledding_list = v
+        return inn
+
+    def from_python(self, value, state=None):
+        """Converts an inn class to a dict of Gasthausbox properties. value is an Inn instance."""
+        inn = value
+        r = collections.OrderedDict()
+        r[u'Position'] = (inn.position_latitude, inn.position_longitude)
+        r[u'Höhe'] = inn.position_elevation
+        r[u'Betreiber'] = inn.operator
+        r[u'Sitzplätze'] = inn.seats
+        r[u'Übernachtung'] = (inn.overnight, inn.overnight_comment)
+        r[u'Rauchfrei'] = (inn.nonsmoker_area, inn.smoker_area)
+        r[u'Rodelverleih'] = (inn.sled_rental, inn.sled_rental_comment)
+        r[u'Handyempfang'] = inn.mobile_provider
+        r[u'Homepage'] = inn.homepage
+        r[u'E-Mail'] = inn.email_list
+        r[u'Telefon'] = inn.phone_list
+        r[u'Bild'] = inn.image
+        r[u'Rodelbahnen'] = inn.sledding_list
+        return r
+
+
+class GasthausboxValidator(wrpylib.wrvalidators.GasthausboxDictValidator):
+    def __init__(self):
+        wrpylib.wrvalidators.GasthausboxDictValidator.__init__(self)
+        self.pre_validators=[wrpylib.mwmarkup.TemplateValidator(as_table=True, as_table_keylen=17), WinterrodelnTemplateDict(u'Gasthausbox')]
+        self.chained_validators = [GasthausboxDictConverter()]
+
+
 def gasthausbox_to_inn(wikitext, inn=None):
     """Converts a inn wiki page containing a {{Gasthausbox}} to an inn.
-    raises a formencode.Invalid exception if an error occurs.
+    inn may be an instance of WrInnCache or an "empty" class (default).
+    raises a formencode.Invalid exception if the format is not OK or the Gasthausbox is not found.
     :return: (start, end, inn) tuple."""
-    if inn is None:
-        class Inn(object): pass
-        inn = Inn()
-
-    # Match Gasthausbox
+    # find Gasthausbox
     start, end = wrpylib.mwmarkup.find_template(wikitext, u'Gasthausbox')
     if start is None: raise formencode.Invalid(u"No 'Gasthausbox' found", wikitext, None)
-    template_title, properties = wrpylib.mwmarkup.split_template(wikitext[start:end])
-
-    # Process properties
-    for key, value in properties.iteritems():
-        if   key == u'Position': inn.position_latitude, inn.position_longitude = _conv(wrpylib.wrvalidators.GeoNone().to_python, value, key) # '47.583333 N 15.75 E'
-        elif key == u'Höhe': inn.position_elevation = _conv(wrpylib.wrvalidators.UnsignedNone().to_python, value, key)
-        elif key == u'Betreiber': inn.operator = _conv(wrpylib.wrvalidators.UnicodeNone().to_python, value, key)
-        elif key == u'Sitzplätze': inn.seats = _conv(wrpylib.wrvalidators.UnsignedNone().to_python, value, key)
-        elif key == u'Übernachtung': inn.overnight, inn.overnight_comment = _conv(wrpylib.wrvalidators.BoolUnicodeTupleValidator().to_python, value, key)
-        elif key == u'Rauchfrei': inn.nonsmoker_area, inn.smoker_area = _conv(wrpylib.wrvalidators.GermanTristateTuple().to_python, value, key)
-        elif key == u'Rodelverleih': inn.sled_rental, inn.sled_rental_comment = _conv(wrpylib.wrvalidators.BoolUnicodeTupleValidator().to_python, value, key)
-        elif key == u'Handyempfang': inn.mobile_provider = _conv(wrpylib.wrvalidators.ValueCommentListNeinLoopNone().to_python, value, key)
-        elif key == u'Homepage': inn.homepage = _conv(wrpylib.wrvalidators.UrlNeinNone().to_python, value, key)
-        elif key == u'E-Mail': inn.email_list = _conv(wrpylib.wrvalidators.EmailCommentListNeinLoopNone(allow_masked_email=True).to_python, value, key)
-        elif key == u'Telefon': inn.phone_list = _conv(wrpylib.wrvalidators.PhoneCommentListNeinLoopNone(comments_are_optional=True).to_python, value, key)
-        elif key == u'Bild': inn.image = _conv(wrpylib.wrvalidators.UnicodeNone().to_python, value, key)
-        elif key == u'Rodelbahnen': inn.sledding_list = _conv(wrpylib.wrvalidators.WikiPageListLoopNone().to_python, value, key)
-        else: raise formencode.Invalid(u"Unbekannte Eigenschaft der Gasthausbox: '%s' (mit Wert '%s')" % (key, value), value, None)
-    return start, end, inn
+
+    # convert to inn
+    if inn is None:
+        state = None
+    else:
+        class State(object):
+            pass
+        state = State()
+        state.inn = inn
+    return start, end, GasthausboxValidator().to_python(wikitext[start:end], state)
 
 
 def inn_to_gasthausbox(inn):
     """Converts the inn class to the {{Gasthausbox}} representation."""
-    keys = []
-    values = []
-    keys.append(u'Position')
-    values.append(wrpylib.wrvalidators.GeoNone().from_python((inn.position_latitude, inn.position_longitude)))
-    keys.append(u'Höhe')
-    values.append(wrpylib.wrvalidators.UnsignedNone().from_python(inn.position_elevation))
-    keys.append(u'Betreiber')
-    values.append(wrpylib.wrvalidators.UnicodeNone().from_python(inn.operator))
-    keys.append(u'Sitzplätze')
-    values.append(wrpylib.wrvalidators.UnsignedNone().from_python(inn.seats))
-    keys.append(u'Übernachtung')
-    values.append(wrpylib.wrvalidators.BoolUnicodeTupleValidator().from_python((inn.overnight, inn.overnight_comment)))
-    keys.append(u'Rauchfrei')
-    values.append(wrpylib.wrvalidators.GermanTristateTuple().from_python((inn.nonsmoker_area, inn.smoker_area)))
-    keys.append(u'Rodelverleih')
-    values.append(wrpylib.wrvalidators.BoolUnicodeTupleValidator().from_python((inn.sled_rental, inn.sled_rental_comment)))
-    keys.append(u'Handyempfang')
-    values.append(wrpylib.wrvalidators.ValueCommentListNeinLoopNone().from_python(inn.mobile_provider))
-    keys.append(u'Homepage')
-    values.append(wrpylib.wrvalidators.UrlNeinNone().from_python(inn.homepage))
-    keys.append(u'E-Mail')
-    values.append(wrpylib.wrvalidators.EmailCommentListNeinLoopNone(allow_masked_email=True).from_python(inn.email_list))
-    keys.append(u'Telefon')
-    values.append(wrpylib.wrvalidators.PhoneCommentListNeinLoopNone(comments_are_optional=True).from_python(inn.phone_list))
-    keys.append(u'Bild')
-    values.append(wrpylib.wrvalidators.UnicodeNone().from_python(inn.image))
-    keys.append(u'Rodelbahnen')
-    values.append(wrpylib.wrvalidators.WikiPageListLoopNone().from_python(inn.sledding_list))
-    result = [u'{{Gasthausbox']
-    return wrpylib.mwmarkup.create_template(u'Gasthausbox', [], keys, values, True)
+    return GasthausboxValidator().from_python(inn)
 
 
 def find_template_latlon_ele(wikitext, template_title):