Changeset 9689 for main/waeup.kofa

Timestamp:

20 Nov 2012, 00:09:00 (12 years ago)

Author:

uli

Message:

attrs_to_fields now supports an additional 'omit' parameter.

Location:

main/waeup.kofa/trunk/src/waeup/kofa/utils

Files:

• helpers.py (modified) (1 diff)
• tests/test_helpers.py (modified) (3 diffs)

main/waeup.kofa/trunk/src/waeup/kofa/utils/helpers.py

@@ -384 +384 @@
     return html
 
-def attrs_to_fields(cls):
+def attrs_to_fields(cls, omit=[]):
     """Turn the attributes of a class into FieldProperty instances.
 
     With Python >= 2.6 we can even use this function as a class decorator.
+
+    `omit` is a list of field names that should _not_ be turned into
+    field properties. This is useful for properties and the like.
     """
     iface = list(implementedBy(cls))[0]
     for field_name in getFieldNames(iface):
+        if field_name in omit:
+            continue
         setattr(cls, field_name, FieldProperty(iface[field_name]))
     return cls

main/waeup.kofa/trunk/src/waeup/kofa/utils/tests/test_helpers.py

@@ -28 +28 @@
 from cStringIO import StringIO
 from zope import schema
-from zope.interface import Interface, Attribute, implements
+from zope.interface import Interface, Attribute, implements, implementer
 from zope.security.testing import Principal, Participation
 from zope.security.management import newInteraction, endInteraction
@@ -52 +52 @@
         self.assertEqual(result4, 30)
         return
+
+    def test_attrs_to_fields_properties(self):
+        # we can omit single fields in order to retrieve properties
+        class IMyInterface(Interface):
+            attr1 = schema.Int(
+                title = u'Attribute 1', readonly = True, default = 110,
+                )
+
+        @helpers.attrs_to_fields
+        @implementer(IMyInterface)
+        class MyClass1(object):
+            @property
+            def attr1(self):
+                return 42
+
+        @implementer(IMyInterface)
+        class MyClass2(object):
+            @property
+            def attr1(self):
+                return 42
+        MyClass2 = helpers.attrs_to_fields(MyClass2, omit=['attr1'])
+
+        obj1 = MyClass1()
+        obj2 = MyClass2()
+
+        self.assertEqual(obj1.attr1, 110)
+        self.assertEqual(obj2.attr1, 42)
+        return
+
 
 class RemoveFileOrDirectoryTestCase(unittest.TestCase):
@@ -461 +490 @@
             contents, '\r\n')
         return
+