Changeset 6346

Timestamp:

09/15/07 20:57:25 (10 months ago)

Author:

mtredinnick

Message:

Fixed #3703 -- Added pk property to models. Thanks, Collin Grady and jeromie@gmail.com.

Files:

• django/trunk/django/db/models/base.py (modified) (1 diff)
• django/trunk/docs/model-api.txt (modified) (1 diff)
• django/trunk/tests/modeltests/basic/models.py (modified) (1 diff)
• django/trunk/tests/modeltests/custom_pk/models.py (modified) (1 diff)

django/trunk/django/db/models/base.py

@@ -83 +83 @@
-    def _get_pk_val(self):
-        return getattr(self, self._meta.pk.attname)
+
+    def _set_pk_val(self, value):
+        return setattr(self, self._meta.pk.attname, value)
+
+    pk = property(_get_pk_val, _set_pk_val)
-
-    def __repr__(self):

django/trunk/docs/model-api.txt

@@ -1284 +1284 @@
-
-Each model requires exactly one field to have ``primary_key=True``.
+
+The ``pk`` property
+-------------------
+**New in Django development version**
+
+Regardless of whether you define a primary key field yourself, or let Django
+supply one for you, each model will have a property called ``pk``. It behaves
+like a normal attribute on the model, but is actually an alias for whichever
+attribute is the primary key field for the model. You can read and set this
+value, just as you would for any other attribute, and it will update the
+correct field in the model.
-
-Admin options

django/trunk/tests/modeltests/basic/models.py

@@ -32 +32 @@
-# Now it has an ID. Note it's a long integer, as designated by the trailing "L".
->>> a.id
+1L
+
+# Models have a pk property that is an alias for the primary key attribute (by
+# default, the 'id' attribute).
+>>> a.pk
-1L
-

django/trunk/tests/modeltests/custom_pk/models.py

@@ -57 +57 @@
-[<Employee: Fran Bones>, <Employee: Dan Jones>]
-
+# The primary key can be accessed via the pk property on the model.
+>>> e = Employee.objects.get(pk='ABC123')
+>>> e.pk
+u'ABC123'
+
+# Or we can use the real attribute name for the primary key:
+>>> e.employee_code
+u'ABC123'
+
-# Fran got married and changed her last name.
->>> fran = Employee.objects.get(pk='XYZ456')