Ticket #3148: 3148.5.diff

django/db/models/fields/__init__.py

@@ -77 +77 @@
-            editable=True, serialize=True, unique_for_date=None,
-            unique_for_month=None, unique_for_year=None, validator_list=None,
-            choices=None, help_text='', db_column=None, db_tablespace=None,
-
+, use_property=None
-        self.name = name
-        self.verbose_name = verbose_name
-        self.primary_key = primary_key
-        self.max_length, self._unique = max_length, unique
-        self.blank, self.null = blank, null
+        self.model_property = use_property
-        # Oracle treats the empty string ('') as null, so coerce the null
-        # option whenever '' is a possible value.
-        if self.empty_strings_allowed and connection.features.interprets_empty_strings_as_nulls:
@@ -171 +172 @@
-        cls._meta.add_field(self)
-        if self.choices:
-            setattr(cls, 'get_%s_display' % self.name, curry(cls._get_FIELD_display, field=self))
+        if self.model_property:
+            if len(self.model_property) < 2:
+                raise ValueError("You must specify at least a getter and a setter method")
+            # Create a property on ``cls`` with the methods given.
+            setattr(cls, '%s' % self.name, 
+                property(*self.model_property))
-
-    def get_attname(self):
-        return self.name

tests/modeltests/properties/models.py

@@ -20 +20 @@
-
-    full_name_2 = property(_get_full_name, _set_full_name)
-
+class PropModel(models.Model):
+    def _set_name(self, value):
+        self.__name = value
+
+    def _get_name(self):
+        return self.__name
+
+    name = models.CharField(max_length=30, use_property=(_get_name, _set_name))
+
-__test__ = {'API_TESTS':"""
->>> a = Person(first_name='John', last_name='Lennon')
->>> a.save()
@@ -37 +46 @@
->>> a2.save()
->>> a2.first_name
-'Paul'
+
+# Now the field properties
+>>> b = PropModel(name='John')
+>>> b.save()
+>>> b.name
+'John'
+>>> b._get_name()
+'John'
+>>> b.name = 'Smith'
+>>> b._get_name()
+'Smith'
-"""}
+

docs/model-api.txt

@@ -738 +738 @@
-
-Like ``unique_for_date`` and ``unique_for_month``.
-
+``use_property``
+~~~~~~~~~~~~~~~~
+
+It is possible to create a property around a field. It is specially usefull if
+you want to control when the value for a field gets changed or accessed.
+
+The ``use_property`` option takes a tuple of the parameters that will be passed to
+``property()`` to construct it.
+
+But note that at least getter and setter functions must be given.
+
+Example::
+
+    from django.db import models
+
+    class Person(models.Model):
+        def _get_name(self):
+            return self.__name
+        def _set_name(self, value):
+            self.__name = value
+
+        name = models.CharField(max_length=30, use_property=(_get_name, _set_name))
+
-``validator_list``
-~~~~~~~~~~~~~~~~~~
-