Changeset 29:dd4e908b9d12 for wokkel/data_form.py

Timestamp:

Aug 4, 2008, 8:55:45 AM (14 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

Convert:

svn:b33ecbfc-034c-dc11-8662-000475d9059e/trunk@59

Message:

Implement type checking in data forms and incoming pubsub node config.

Author: ralphm.
Fixes #15.

File:

• wokkel/data_form.py (modified) (10 diffs)

wokkel/data_form.py

@@ -204 +204 @@
 
 
-    def toElement(self):
-        """
-        Return the DOM representation of this Field.
-
-        @rtype L{domish.Element}.
+    def typeCheck(self):
+        """
+        Check field properties agains the set field type.
         """
         if self.var is None and self.fieldType != 'fixed':
             raise FieldNameRequiredError()
-
-        field = domish.Element((NS_X_DATA, 'field'))
-        field['type'] = self.fieldType
-
-        if self.var is not None:
-            field['var'] = self.var
 
         if self.values:
@@ -225 +217 @@
                 raise TooManyValuesError()
 
+            newValues = []
             for value in self.values:
                 if self.fieldType == 'boolean':
                     # We send out the textual representation of boolean values
-                    value = unicode(bool(value)).lower()
+                    value = bool(int(value))
                 elif self.fieldType in ('jid-single', 'jid-multi'):
                     value = value.full()
 
-                field.addElement('value', content=value)
+                newValues.append(value)
+
+            self.values = newValues
+
+    def toElement(self):
+        """
+        Return the DOM representation of this Field.
+
+        @rtype L{domish.Element}.
+        """
+
+        self.typeCheck()
+
+        field = domish.Element((NS_X_DATA, 'field'))
+        field['type'] = self.fieldType
+
+        if self.var is not None:
+            field['var'] = self.var
+
+        for value in self.values:
+            if self.fieldType == 'boolean':
+                value = unicode(value).lower()
+            field.addElement('value', content=value)
 
         if self.fieldType in ('list-single', 'list-multi'):
@@ -302 +317 @@
     @staticmethod
     def fromDict(dictionary):
+        kwargs = dictionary.copy()
+
         if 'type' in dictionary:
-            dictionary['fieldType'] = dictionary['type']
-            del dictionary['type']
+            kwargs['fieldType'] = dictionary['type']
+            del kwargs['type']
+
         if 'options' in dictionary:
             options = []
             for value, label in dictionary['options'].iteritems():
                 options.append(Option(value, label))
-            dictionary['options'] = options
-        return Field(**dictionary)
+            kwargs['options'] = options
+
+        return Field(**kwargs)
 
 
@@ -335 +354 @@
                          C{'FORM_TYPE'}, if set.
     @type formNamespace: C{str}.
+    @ivar fields: Dictionary of fields that have a name. Note that this is
+                  meant to be used for reading, only. One should use
+                  L{addField} for adding fields.
+    @type fields: C{dict}
     """
 
@@ -343 +366 @@
         self.instructions = instructions or []
         self.formNamespace = formNamespace
-        self.fields = fields or []
-
+
+        self.fieldList = []
+        self.fields = {}
+
+        if fields:
+            for field in fields:
+                self.addField(field)
 
     def __repr__(self):
@@ -360 +388 @@
         if self.fields:
             r.append(", fields=")
-            r.append(repr(self.fields))
+            r.append(repr(self.fieldList))
         r.append(")")
         return u"".join(r)
+
+
+    def addField(self, field):
+        """
+        Add a field to this form.
+
+        Fields are added in order, and L{fields} is a dictionary of the
+        named fields, that is kept in sync only if this method is used for
+        adding new fields. Multiple fields with the same name are disallowed.
+        """
+        if field.var is not None:
+            if field.var in self.fields:
+                raise Error("Duplicate field %r" % field.var)
+
+            self.fields[field.var] = field
+
+        self.fieldList.append(field)
 
 
@@ -379 +424 @@
             form.addChild(field.toElement())
 
-        for field in self.fields:
+        for field in self.fieldList:
             form.addChild(field.toElement())
 
@@ -407 +452 @@
             form.formNamespace = field.value
         else:
-            form.fields.append(field)
+            form.addField(field)
 
     @staticmethod
@@ -429 +474 @@
         values = {}
 
-        for field in self.fields:
+        for name, field in self.fields.iteritems():
             if len(field.values) > 1:
                 value = field.values
@@ -435 +480 @@
                 value = field.value
 
-            if field.var:
-                values[field.var] = value
+            values[name] = value
 
         return values