← Back to branch summary

~ubuntu-branches/ubuntu/quantal/python-django/quantal

« back to all changes in this revision

Viewing changes to tests/modeltests/ordering/models.py

  • Committer: Bazaar Package Importer
  • Author(s): Chris Lamb
  • Date: 2009-07-29 11:26:28 UTC
  • mfrom: (1.1.8 upstream) (4.1.5 sid)
  • Revision ID: james.westby@ubuntu.com-20090729112628-pg09ino8sz0sj21t
Tags: 1.1-1
http://bugs.debian.org/538863
* New upstream release.
* Merge from experimental:
  - Ship FastCGI initscript and /etc/default file in python-django's examples
    directory (Closes: #538863)
  - Drop "05_10539-sphinx06-compatibility.diff"; it has been applied
    upstream.
  - Bump Standards-Version to 3.8.2.

Show diffs side-by-side

added added

removed removed

Lines of Context:
tests/modeltests/ordering/models.py
 
1
"""
 
2
6. Specifying ordering
 
3
 
 
4
Specify default ordering for a model using the ``ordering`` attribute, which
 
5
should be a list or tuple of field names. This tells Django how to order
 
6
``QuerySet`` results.
 
7
 
 
8
If a field name in ``ordering`` starts with a hyphen, that field will be
 
9
ordered in descending order. Otherwise, it'll be ordered in ascending order.
 
10
The special-case field name ``"?"`` specifies random order.
 
11
 
 
12
The ordering attribute is not required. If you leave it off, ordering will be
 
13
undefined -- not random, just undefined.
 
14
"""
 
15
 
 
16
from django.db import models
 
17
 
 
18
class Article(models.Model):
 
19
    headline = models.CharField(max_length=100)
 
20
    pub_date = models.DateTimeField()
 
21
    class Meta:
 
22
        ordering = ('-pub_date', 'headline')
 
23
 
 
24
    def __unicode__(self):
 
25
        return self.headline
 
26
 
 
27
__test__ = {'API_TESTS':"""
 
28
# Create a couple of Articles.
 
29
>>> from datetime import datetime
 
30
>>> a1 = Article(headline='Article 1', pub_date=datetime(2005, 7, 26))
 
31
>>> a1.save()
 
32
>>> a2 = Article(headline='Article 2', pub_date=datetime(2005, 7, 27))
 
33
>>> a2.save()
 
34
>>> a3 = Article(headline='Article 3', pub_date=datetime(2005, 7, 27))
 
35
>>> a3.save()
 
36
>>> a4 = Article(headline='Article 4', pub_date=datetime(2005, 7, 28))
 
37
>>> a4.save()
 
38
 
 
39
# By default, Article.objects.all() orders by pub_date descending, then
 
40
# headline ascending.
 
41
>>> Article.objects.all()
 
42
[<Article: Article 4>, <Article: Article 2>, <Article: Article 3>, <Article: Article 1>]
 
43
 
 
44
# Override ordering with order_by, which is in the same format as the ordering
 
45
# attribute in models.
 
46
>>> Article.objects.order_by('headline')
 
47
[<Article: Article 1>, <Article: Article 2>, <Article: Article 3>, <Article: Article 4>]
 
48
>>> Article.objects.order_by('pub_date', '-headline')
 
49
[<Article: Article 1>, <Article: Article 3>, <Article: Article 2>, <Article: Article 4>]
 
50
 
 
51
# Only the last order_by has any effect (since they each override any previous
 
52
# ordering).
 
53
>>> Article.objects.order_by('id')
 
54
[<Article: Article 1>, <Article: Article 2>, <Article: Article 3>, <Article: Article 4>]
 
55
>>> Article.objects.order_by('id').order_by('-headline')
 
56
[<Article: Article 4>, <Article: Article 3>, <Article: Article 2>, <Article: Article 1>]
 
57
 
 
58
# Use the 'stop' part of slicing notation to limit the results.
 
59
>>> Article.objects.order_by('headline')[:2]
 
60
[<Article: Article 1>, <Article: Article 2>]
 
61
 
 
62
# Use the 'stop' and 'start' parts of slicing notation to offset the result list.
 
63
>>> Article.objects.order_by('headline')[1:3]
 
64
[<Article: Article 2>, <Article: Article 3>]
 
65
 
 
66
# Getting a single item should work too:
 
67
>>> Article.objects.all()[0]
 
68
<Article: Article 4>
 
69
 
 
70
# Use '?' to order randomly. (We're using [...] in the output to indicate we
 
71
# don't know what order the output will be in.
 
72
>>> Article.objects.order_by('?')
 
73
[...]
 
74
 
 
75
# Ordering can be reversed using the reverse() method on a queryset. This
 
76
# allows you to extract things like "the last two items" (reverse and then
 
77
# take the first two).
 
78
>>> Article.objects.all().reverse()[:2]
 
79
[<Article: Article 1>, <Article: Article 3>]
 
80
 
 
81
# Ordering can be based on fields included from an 'extra' clause
 
82
>>> Article.objects.extra(select={'foo': 'pub_date'}, order_by=['foo', 'headline'])
 
83
[<Article: Article 1>, <Article: Article 2>, <Article: Article 3>, <Article: Article 4>]
 
84
 
 
85
# If the extra clause uses an SQL keyword for a name, it will be protected by quoting.
 
86
>>> Article.objects.extra(select={'order': 'pub_date'}, order_by=['order', 'headline'])
 
87
[<Article: Article 1>, <Article: Article 2>, <Article: Article 3>, <Article: Article 4>]
 
88
 
 
89
"""}