Skip to content

Commit

Permalink
Added a QuerySet.ordered property to check if a queryset is already…
Browse files Browse the repository at this point in the history
… ordered. Refs #10163.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@10623 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information
jacobian committed Apr 22, 2009
1 parent d463580 commit c00e8d2
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
17 changes: 17 additions & 0 deletions django/db/models/query.py
Expand Up @@ -615,7 +615,24 @@ def only(self, *fields):
clone = self._clone() clone = self._clone()
clone.query.add_immediate_loading(fields) clone.query.add_immediate_loading(fields)
return clone return clone

###################################
# PUBLIC INTROSPECTION ATTRIBUTES #
###################################


def ordered(self):
"""
Returns True if the QuerySet is ordered -- i.e. has an order_by()
clause or a default ordering on the model.
"""
if self.query.extra_order_by or self.query.order_by:
return True
elif self.query.default_ordering and self.query.model._meta.ordering:
return True
else:
return False
ordered = property(ordered)

################### ###################
# PRIVATE METHODS # # PRIVATE METHODS #
################### ###################
Expand Down
6 changes: 6 additions & 0 deletions docs/ref/models/querysets.txt
Expand Up @@ -268,6 +268,12 @@ There's no way to specify whether ordering should be case sensitive. With
respect to case-sensitivity, Django will order results however your database respect to case-sensitivity, Django will order results however your database
backend normally orders them. backend normally orders them.


.. versionadded:: 1.1

You can tell if a query is ordered or not by checking the
:attr:`QuerySet.ordered` attribute, which will be ``True`` if the
``QuerySet`` has been ordered in any way.

``reverse()`` ``reverse()``
~~~~~~~~~~~~~ ~~~~~~~~~~~~~


Expand Down
27 changes: 27 additions & 0 deletions tests/regressiontests/queries/tests.py
@@ -0,0 +1,27 @@
import unittest
from models import Tag, Annotation
from django.db.models import Count

class QuerysetOrderedTests(unittest.TestCase):
"""
Tests for the Queryset.ordered attribute.
"""

def test_no_default_or_explicit_ordering(self):
self.assertEqual(Annotation.objects.all().ordered, False)

def test_cleared_default_ordering(self):
self.assertEqual(Tag.objects.all().ordered, True)
self.assertEqual(Tag.objects.all().order_by().ordered, False)

def test_explicit_ordering(self):
self.assertEqual(Annotation.objects.all().order_by('id').ordered, True)

def test_order_by_extra(self):
self.assertEqual(Annotation.objects.all().extra(order_by=['id']).ordered, True)

def test_annotated_ordering(self):
qs = Annotation.objects.annotate(num_notes=Count('notes'))
self.assertEqual(qs.ordered, False)
self.assertEqual(qs.order_by('num_notes').ordered, True)

0 comments on commit c00e8d2

Please sign in to comment.