Changeset 6516

Timestamp:

10/14/07 21:54:30 (9 months ago)

Author:

mtredinnick

Message:

queryset-refactor: Made the use of values() for ForeignKey? fields consistent
and documented this feature. Refs #4358.

Files:

• django/branches/queryset-refactor/django/db/models/query.py (modified) (2 diffs)
• django/branches/queryset-refactor/docs/db-api.txt (modified) (1 diff)
• django/branches/queryset-refactor/tests/regressiontests/queries/models.py (modified) (1 diff)

django/branches/queryset-refactor/django/db/models/query.py

@@ -392 +392 @@
-        # in this object for use by iterator().
-        if self._fields:
+            opts = self.model._meta
+            all = dict([(field.column, field) for field in opts.fields])
+            all.update([(field.name, field) for field in opts.fields])
-            if not self.query.extra_select:
-
-
+
+
+
+
+
-                field_names = self._fields
-            else:
@@ -400 +406 @@
-                field_names = []
-                for f in self._fields:
-
-
-
+
+
-                        field_names.append(f)
-                    elif not self.query.extra_select.has_key(f):

django/branches/queryset-refactor/docs/db-api.txt

@@ -583 +583 @@
-    >>> Blog.objects.values('id', 'name')
-    [{'id': 1, 'name': 'Beatles Blog'}]
+
+A couple of subtleties that are worth mentioning:
+
+    * The ``values()`` method does not return anything for ``ManyToManyField``
+      attributes and will raise an error if you try to pass in this type of
+      field to it.
+    * If you have a field called ``foo`` that is a ``ForeignKey``, the default
+      ``values()`` call will return a dictionary key called ``foo_id``, since
+      this is the name of the hidden model attribute that stores the actual
+      value (the ``foo`` attribute refers to the related model). When you are
+      calling ``values()`` and passing in field names, you can pass in either
+      ``foo`` or ``foo_id`` and you will get back the same thing (the
+      dictionary key will match the field name you passed in).
+
+      For example::
+
+        >>> Entry.objects.values()
+        [{'blog_id: 1, 'headline': u'First Entry', ...}, ...]
+
+        >>> Entry.objects.values('blog')
+        [{'blog': 1}, ...]
+
+        >>> Entry.objects.values('blog_id')
+        [{'blog_id': 1}, ...]
-
-A ``ValuesQuerySet`` is useful when you know you're only going to need values

django/branches/queryset-refactor/tests/regressiontests/queries/models.py

@@ -335 +335 @@
->>> Note.objects.values('misc').distinct().order_by('note', '-misc')
-[{'misc': u'foo'}, {'misc': u'bar'}]
+
+Bug #4358
+If you don't pass any fields to values(), relation fields are returned as
+"foo_id" keys, not "foo". For consistency, you should be able to pass "foo_id"
+in the fields list and have it work, too. We actually allow both "foo" and
+"foo_id".
+
+# The *_id version is returned by default.
+>>> 'note_id' in ExtraInfo.objects.values()[0]
+True
+
+# You can also pass it in explicitly.
+>>> ExtraInfo.objects.values('note_id')
+[{'note_id': 1}, {'note_id': 2}]
+
+# ...or use the field name.
+>>> ExtraInfo.objects.values('note')
+[{'note': 1}, {'note': 2}]
+
-"""}
-