Changeset 196:80e9a80845ba for wokkel

Timestamp:

Oct 3, 2016, 8:49:10 AM (4 years ago)

Author:

Ralph Meijer <ralphm@…>

Branch:

default

rebase_source:

125a984a608f7e698bde26531ed1306885cb8bf6

Message:

imported patch py3-dataforms.patch

Location:

wokkel

Files:

• data_form.py (modified) (18 diffs)
• test/test_data_form.py (modified) (4 diffs)

wokkel/data_form.py

@@ -13 +13 @@
 """
 
-from zope.interface import implements
+from __future__ import division, absolute_import
+
+from zope.interface import implementer
 from zope.interface.common import mapping
+
+from twisted.python.compat import iteritems, unicode, _PY3
 from twisted.words.protocols.jabber.jid import JID
 from twisted.words.xish import domish
@@ -48 +52 @@
 
     @ivar value: Value of this option.
-    @type value: C{unicode}
+    @type value: L{unicode}
     @ivar label: Optional label for this option.
-    @type label: C{unicode} or C{NoneType}
+    @type label: L{unicode} or L{NoneType}
     """
 
@@ -101 +105 @@
 
                      The default is C{'text-single'}.
-    @type fieldType: C{str}
+    @type fieldType: L{str}
     @ivar var: Field name. Optional if C{fieldType} is C{'fixed'}.
-    @type var: C{str}
+    @type var: L{str}
     @ivar label: Human readable label for this field.
-    @type label: C{unicode}
+    @type label: L{unicode}
     @ivar values: The values for this field, for multi-valued field
-                  types, as a list of C{bool}, C{unicode} or L{JID}.
-    @type values: C{list}
+                  types, as a list of L{bool}, L{unicode} or L{JID}.
+    @type values: L{list}
     @ivar options: List of possible values to choose from in a response
                    to this form as a list of L{Option}s.
-    @type options: C{list}
+    @type options: L{list}
     @ivar desc: Human readable description for this field.
-    @type desc: C{unicode}
+    @type desc: L{unicode}
     @ivar required: Whether the field is required to be provided in a
                     response to this form.
-    @type required: C{bool}
+    @type required: L{bool}
     """
 
@@ -127 +131 @@
         See the identically named instance variables for descriptions.
 
-        If C{value} is not C{None}, it overrides C{values}, setting the
+        If C{value} is not L{None}, it overrides C{values}, setting the
         given value as the only value for this field.
         """
@@ -144 +148 @@
             self.options = [Option(optionValue, optionLabel)
                             for optionValue, optionLabel
-                            in options.iteritems()]
+                            in iteritems(options)]
         except AttributeError:
             self.options = options or []
@@ -182 +186 @@
         Sets C{value} as the only element of L{values}.
 
-        @type value: C{bool}, C{unicode} or L{JID}
+        @type value: L{bool}, L{unicode} or L{JID}
         """
         self.values = [value]
@@ -191 +195 @@
         Getter of value property.
 
-        Returns the first element of L{values}, if present, or C{None}.
+        Returns the first element of L{values}, if present, or L{None}.
         """
 
@@ -310 +314 @@
         field = Field(None)
 
-        for eAttr, fAttr in {'type': 'fieldType',
-                             'var': 'var',
-                             'label': 'label'}.iteritems():
+        for eAttr, fAttr in iteritems({'type': 'fieldType',
+                                       'var': 'var',
+                                       'label': 'label'}):
             value = element.getAttribute(eAttr)
             if value:
@@ -347 +351 @@
         if 'options' in fieldDict:
             options = []
-            for value, label in fieldDict['options'].iteritems():
+            for value, label in iteritems(fieldDict['options']):
                 options.append(Option(value, label))
             kwargs['options'] = options
@@ -354 +358 @@
 
 
+
+@implementer(mapping.IIterableMapping,
+             mapping.IEnumerableMapping,
+             mapping.IReadMapping,
+             mapping.IItemMapping)
 
 class Form(object):
@@ -374 +383 @@
     @ivar formType: Type of form. One of C{'form'}, C{'submit'}, {'cancel'},
                     or {'result'}.
-    @type formType: C{str}
+    @type formType: L{str}
 
     @ivar title: Natural language title of the form.
-    @type title: C{unicode}
-
-    @ivar instructions: Natural language instructions as a list of C{unicode}
+    @type title: L{unicode}
+
+    @ivar instructions: Natural language instructions as a list of L{unicode}
         strings without line breaks.
-    @type instructions: C{list}
+    @type instructions: L{list}
 
     @ivar formNamespace: The optional namespace of the field names for this
         form. This goes in the special field named C{'FORM_TYPE'}, if set.
-    @type formNamespace: C{str}
+    @type formNamespace: L{str}
 
     @ivar fields: Dictionary of named fields. Note that this is meant to be
         used for reading, only. One should use L{addField} or L{makeFields} and
         L{removeField} for adding and removing fields.
-    @type fields: C{dict}
+    @type fields: L{dict}
 
     @ivar fieldList: List of all fields, in the order they are added. Like
         C{fields}, this is meant to be used for reading, only.
-    @type fieldList: C{list}
-    """
-
-    implements(mapping.IIterableMapping,
-               mapping.IEnumerableMapping,
-               mapping.IReadMapping,
-               mapping.IItemMapping)
+    @type fieldList: L{list}
+    """
 
     def __init__(self, formType, title=None, instructions=None,
@@ -469 +473 @@
         this form. It is typically used for generating outgoing forms.
 
-        If C{fieldDefs} is not C{None}, this is used to fill in
+        If C{fieldDefs} is not L{None}, this is used to fill in
         additional properties of fields, like the field types, labels and
         possible options.
 
-        If C{filterUnknown} is C{True} and C{fieldDefs} is not C{None}, fields
+        If C{filterUnknown} is L{True} and C{fieldDefs} is not L{None}, fields
         will only be created from C{values} with a corresponding entry in
         C{fieldDefs}.
 
-        If the field type is unknown, the field type is C{None}. When the form
+        If the field type is unknown, the field type is L{None}. When the form
         is rendered using L{toElement}, these fields will have no C{'type'}
         attribute, and it is up to the receiving party to interpret the values
@@ -484 +488 @@
 
         @param values: Values to create fields from.
-        @type values: C{dict}
+        @type values: L{dict}
 
         @param fieldDefs: Field definitions as a dictionary. See
             L{wokkel.iwokkel.IPubSubService.getConfigurationOptions}
-        @type fieldDefs: C{dict}
-
-        @param filterUnknown: If C{True}, ignore fields that are not in
+        @type fieldDefs: L{dict}
+
+        @param filterUnknown: If L{True}, ignore fields that are not in
             C{fieldDefs}.
-        @type filterUnknown: C{bool}
-        """
-        for name, value in values.iteritems():
+        @type filterUnknown: L{bool}
+        """
+        for name, value in iteritems(values):
             fieldDict = {'var': name,
                          'type': None}
@@ -634 +638 @@
             yield (key, self[key])
 
-
-    def keys(self):
-        return list(self)
-
-
-    def values(self):
-        return list(self.itervalues())
-
-
-    def items(self):
-        return list(self.iteritems())
+    if _PY3:
+        keys = iterkeys
+        values = itervalues
+        items = iteritems
+    else:
+        def keys(self):
+            return list(self)
+
+
+        def values(self):
+            return list(self.itervalues())
+
+
+        def items(self):
+            return list(self.iteritems())
 
 
@@ -653 +661 @@
         For all named fields, the corresponding value or values are
         returned in a dictionary keyed by the field name. This is equivalent
-        do C{dict(f)}, where C{f} is a L{Form}.
+        do L{dict(f)}, where C{f} is a L{Form}.
 
         @see: L{__getitem__}
-        @rtype: C{dict}
+        @rtype: L{dict}
         """
         return dict(self)
@@ -669 +677 @@
         field definition in C{fieldDefs} is used to check the field type.
 
-        If C{filterUnknown} is C{True}, fields that are not present in
+        If C{filterUnknown} is L{True}, fields that are not present in
         C{fieldDefs} are removed from the form.
 
-        If the field type is C{None} (when not set by the sending entity),
+        If the field type is L{None} (when not set by the sending entity),
         the type from the field definitition is used, or C{'text-single'} if
         that is not set.
@@ -682 +690 @@
         @param fieldDefs: Field definitions as a dictionary. See
             L{wokkel.iwokkel.IPubSubService.getConfigurationOptions}
-        @type fieldDefs: C{dict}
-
-        @param filterUnknown: If C{True}, remove fields that are not in
+        @type fieldDefs: L{dict}
+
+        @param filterUnknown: If L{True}, remove fields that are not in
             C{fieldDefs}.
-        @type filterUnknown: C{bool}
+        @type filterUnknown: L{bool}
         """
 
@@ -694 +702 @@
         filtered = []
 
-        for name, field in self.fields.iteritems():
+        for name, field in iteritems(self.fields):
             if name in fieldDefs:
                 fieldDef = fieldDefs[name]

wokkel/test/test_data_form.py

@@ -6 +6 @@
 """
 
+from __future__ import division, absolute_import
+
 from zope.interface import verify
 from zope.interface.common.mapping import IIterableMapping
 
+from twisted.python.compat import unicode, _PY3
 from twisted.trial import unittest
 from twisted.words.xish import domish
@@ -1135 +1138 @@
         form = data_form.Form('submit', fields=fields)
         keys = form.keys()
-        self.assertIsInstance(keys, list)
+        if not _PY3:
+            self.assertIsInstance(keys, list)
         self.assertEqual(set(['botname', 'public', 'features']),
                          set(keys))
@@ -1148 +1152 @@
         form = data_form.Form('submit', fields=fields)
         values = form.values()
-        self.assertIsInstance(values, list)
+        if not _PY3:
+            self.assertIsInstance(values, list)
         self.assertEqual(set(['The Jabber Bot', True]), set(values))
 
@@ -1160 +1165 @@
         form = data_form.Form('submit', fields=fields)
         items = form.items()
-        self.assertIsInstance(items, list)
+        if not _PY3:
+            self.assertIsInstance(items, list)
         self.assertEqual(set([('botname', 'The Jabber Bot'),
                               ('public', True)]),