Changeset 7149

Timestamp:

02/22/08 21:36:38 (5 months ago)

Author:

mtredinnick

Message:

queryset-refactor: Added valuelist() method to querysets. Refs #2482.

Files:

• django/branches/queryset-refactor/django/db/models/manager.py (modified) (1 diff)
• 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/modeltests/lookup/models.py (modified) (1 diff)

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

@@ -102 +102 @@
-        return self.get_query_set().values(*args, **kwargs)
-
+    def valueslist(self, *args, **kwargs):
+        return self.get_query_set().valueslist(*args, **kwargs)
+
-    def update(self, *args, **kwargs):
-        return self.get_query_set().update(*args, **kwargs)

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

@@ -278 +278 @@
-    def values(self, *fields):
-        return self._clone(klass=ValuesQuerySet, setup=True, _fields=fields)
+
+    def valueslist(self, *fields, **kwargs):
+        flat = kwargs.pop('flat', False)
+        if kwargs:
+            raise TypeError('Unexpected keyword arguments to valueslist: %s'
+                    % (kwargs.keys(),))
+        if flat and len(fields) > 1:
+            raise TypeError("'flat' is not valid when valueslist is called with more than one field.")
+        return self._clone(klass=ValuesListQuerySet, setup=True, flat=flat,
+                _fields=fields)
-
-    def dates(self, field_name, kind, order='ASC'):
@@ -532 +542 @@
-        return c
-
+class ValuesListQuerySet(ValuesQuerySet):
+    def iterator(self):
+        self.field_names.extend([f for f in self.query.extra_select.keys()])
+        if self.flat and len(self._fields) == 1:
+            for row in self.query.results_iter():
+                yield row[0]
+        else:
+            for row in self.query.results_iter():
+                yield row
+
+    def _clone(self, *args, **kwargs):
+        clone = super(ValuesListQuerySet, self)._clone(*args, **kwargs)
+        clone.flat = self.flat
+        return clone
+
-class DateQuerySet(QuerySet):
-    def iterator(self):

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

@@ -665 +665 @@
-individualism.
-
+``valueslist(*fields)``
+~~~~~~~~~~~~~~~~~~~~~~~
+
+**New in Django development version**
+
+This is similar to ``values()`` except that instead of returning a list of
+dictionaries, it returns a list of tuples. Each tuple contains the value from
+the respective field passed into the ``valueslist()`` call -- so the first
+item is the first field, etc. For example::
+
+    >>> Entry.objects.valueslist('id', 'headling')
+    [(1, u'First entry'), ...]
+
+If you only pass in a single field, you can also pass in the ``flat``
+parameter. If ``True``, this will mean the returned results are single values,
+rather than one-tuples. An example should make the difference clearer::
+
+    >>> Entry.objects.valueslist('id').order_by('id')
+    [(1,), (2,), (3,), ...]
+
+    >>> Entry.objects.valueslist('id', flat=True).order_by('id')
+    [1, 2, 3, ...]
+
+It is an error to pass in ``flat`` when there is more than one field.
+
+If you don't pass any values to ``valueslist()``, it will return all the
+fields in the model, in the order they were declared.
+
-``dates(field, kind, order='ASC')``
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

django/branches/queryset-refactor/tests/modeltests/lookup/models.py

@@ -166 +166 @@
-True
-
+# valueslist() is similar to values(), except that the results are returned as
+# a list of tuples, rather than a list of dictionaries. Within each tuple, the
+# order of the elemnts is the same as the order of fields in the valueslist()
+# call.
+>>> Article.objects.valueslist('headline')
+[(u'Article 5',), (u'Article 6',), (u'Article 4',), (u'Article 2',), (u'Article 3',), (u'Article 7',), (u'Article 1',)]
+
+>>> Article.objects.valueslist('id').order_by('id')
+[(1,), (2,), (3,), (4,), (5,), (6,), (7,)]
+>>> Article.objects.valueslist('id', flat=True).order_by('id')
+[1, 2, 3, 4, 5, 6, 7]
+
+>>> Article.objects.valueslist('id', 'headline', flat=True)
+Traceback (most recent call last):
+...
+TypeError: 'flat' is not valid when valueslist is called with more than one field.
+
-# Every DateField and DateTimeField creates get_next_by_FOO() and
-# get_previous_by_FOO() methods.