Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

[1.2.X] Migrated select_related doctests. Thanks to Eric Florenzano.

Backport of r13828 from trunk.

git-svn-id: http://code.djangoproject.com/svn/django/branches/releases/1.2.X@13837 bcc190cf-cafb-0310-a4f2-bffc1f526a37
  • Loading branch information...
commit 21fccbc13e28bf63c7998c79f15fa85537caa2db 1 parent 902c111
@freakboy3742 freakboy3742 authored
View
132 tests/modeltests/select_related/models.py
@@ -56,134 +56,4 @@ class Species(models.Model):
name = models.CharField(max_length=50)
genus = models.ForeignKey(Genus)
def __unicode__(self):
- return self.name
-
-def create_tree(stringtree):
- """Helper to create a complete tree"""
- names = stringtree.split()
- models = [Domain, Kingdom, Phylum, Klass, Order, Family, Genus, Species]
- assert len(names) == len(models), (names, models)
-
- parent = None
- for name, model in zip(names, models):
- try:
- obj = model.objects.get(name=name)
- except model.DoesNotExist:
- obj = model(name=name)
- if parent:
- setattr(obj, parent.__class__.__name__.lower(), parent)
- obj.save()
- parent = obj
-
-__test__ = {'API_TESTS':"""
-
-# Set up.
-# The test runner sets settings.DEBUG to False, but we want to gather queries
-# so we'll set it to True here and reset it at the end of the test suite.
->>> from django.conf import settings
->>> settings.DEBUG = True
-
->>> create_tree("Eukaryota Animalia Anthropoda Insecta Diptera Drosophilidae Drosophila melanogaster")
->>> create_tree("Eukaryota Animalia Chordata Mammalia Primates Hominidae Homo sapiens")
->>> create_tree("Eukaryota Plantae Magnoliophyta Magnoliopsida Fabales Fabaceae Pisum sativum")
->>> create_tree("Eukaryota Fungi Basidiomycota Homobasidiomycatae Agaricales Amanitacae Amanita muscaria")
-
->>> from django import db
-
-# Normally, accessing FKs doesn't fill in related objects:
->>> db.reset_queries()
->>> fly = Species.objects.get(name="melanogaster")
->>> fly.genus.family.order.klass.phylum.kingdom.domain
-<Domain: Eukaryota>
->>> len(db.connection.queries)
-8
-
-# However, a select_related() call will fill in those related objects without any extra queries:
->>> db.reset_queries()
->>> person = Species.objects.select_related(depth=10).get(name="sapiens")
->>> person.genus.family.order.klass.phylum.kingdom.domain
-<Domain: Eukaryota>
->>> len(db.connection.queries)
-1
-
-# select_related() also of course applies to entire lists, not just items.
-# Without select_related()
->>> db.reset_queries()
->>> world = Species.objects.all()
->>> [o.genus.family for o in world]
-[<Family: Drosophilidae>, <Family: Hominidae>, <Family: Fabaceae>, <Family: Amanitacae>]
->>> len(db.connection.queries)
-9
-
-# With select_related():
->>> db.reset_queries()
->>> world = Species.objects.all().select_related()
->>> [o.genus.family for o in world]
-[<Family: Drosophilidae>, <Family: Hominidae>, <Family: Fabaceae>, <Family: Amanitacae>]
->>> len(db.connection.queries)
-1
-
-# The "depth" argument to select_related() will stop the descent at a particular level:
->>> db.reset_queries()
->>> pea = Species.objects.select_related(depth=1).get(name="sativum")
->>> pea.genus.family.order.klass.phylum.kingdom.domain
-<Domain: Eukaryota>
-
-# Notice: one fewer queries than above because of depth=1
->>> len(db.connection.queries)
-7
-
->>> db.reset_queries()
->>> pea = Species.objects.select_related(depth=5).get(name="sativum")
->>> pea.genus.family.order.klass.phylum.kingdom.domain
-<Domain: Eukaryota>
->>> len(db.connection.queries)
-3
-
->>> db.reset_queries()
->>> world = Species.objects.all().select_related(depth=2)
->>> [o.genus.family.order for o in world]
-[<Order: Diptera>, <Order: Primates>, <Order: Fabales>, <Order: Agaricales>]
->>> len(db.connection.queries)
-5
-
->>> s = Species.objects.all().select_related(depth=1).extra(select={'a': 'select_related_species.id + 10'})[0]
->>> s.id + 10 == s.a
-True
-
-# The optional fields passed to select_related() control which related models
-# we pull in. This allows for smaller queries and can act as an alternative
-# (or, in addition to) the depth parameter.
-
-# In the next two cases, we explicitly say to select the 'genus' and
-# 'genus.family' models, leading to the same number of queries as before.
->>> db.reset_queries()
->>> world = Species.objects.select_related('genus__family')
->>> [o.genus.family for o in world]
-[<Family: Drosophilidae>, <Family: Hominidae>, <Family: Fabaceae>, <Family: Amanitacae>]
->>> len(db.connection.queries)
-1
-
->>> db.reset_queries()
->>> world = Species.objects.filter(genus__name='Amanita').select_related('genus__family')
->>> [o.genus.family.order for o in world]
-[<Order: Agaricales>]
->>> len(db.connection.queries)
-2
-
->>> db.reset_queries()
->>> Species.objects.all().select_related('genus__family__order').order_by('id')[0:1].get().genus.family.order.name
-u'Diptera'
->>> len(db.connection.queries)
-1
-
-# Specifying both "depth" and fields is an error.
->>> Species.objects.select_related('genus__family__order', depth=4)
-Traceback (most recent call last):
-...
-TypeError: Cannot pass both "depth" and fields to select_related()
-
-# Reset DEBUG to where we found it.
->>> settings.DEBUG = False
-"""}
-
+ return self.name
View
166 tests/modeltests/select_related/tests.py
@@ -0,0 +1,166 @@
+from django.test import TestCase
+from django.conf import settings
+from django import db
+
+from models import Domain, Kingdom, Phylum, Klass, Order, Family, Genus, Species
+
+class SelectRelatedTests(TestCase):
+
+ def create_tree(self, stringtree):
+ """
+ Helper to create a complete tree.
+ """
+ names = stringtree.split()
+ models = [Domain, Kingdom, Phylum, Klass, Order, Family, Genus, Species]
+ assert len(names) == len(models), (names, models)
+
+ parent = None
+ for name, model in zip(names, models):
+ try:
+ obj = model.objects.get(name=name)
+ except model.DoesNotExist:
+ obj = model(name=name)
+ if parent:
+ setattr(obj, parent.__class__.__name__.lower(), parent)
+ obj.save()
+ parent = obj
+
+ def create_base_data(self):
+ self.create_tree("Eukaryota Animalia Anthropoda Insecta Diptera Drosophilidae Drosophila melanogaster")
+ self.create_tree("Eukaryota Animalia Chordata Mammalia Primates Hominidae Homo sapiens")
+ self.create_tree("Eukaryota Plantae Magnoliophyta Magnoliopsida Fabales Fabaceae Pisum sativum")
+ self.create_tree("Eukaryota Fungi Basidiomycota Homobasidiomycatae Agaricales Amanitacae Amanita muscaria")
+
+ def setUp(self):
+ # The test runner sets settings.DEBUG to False, but we want to gather
+ # queries so we'll set it to True here and reset it at the end of the
+ # test case.
+ self.create_base_data()
+ settings.DEBUG = True
+ db.reset_queries()
+
+ def tearDown(self):
+ settings.DEBUG = False
+
+ def test_access_fks_without_select_related(self):
+ """
+ Normally, accessing FKs doesn't fill in related objects
+ """
+ fly = Species.objects.get(name="melanogaster")
+ domain = fly.genus.family.order.klass.phylum.kingdom.domain
+ self.assertEqual(domain.name, 'Eukaryota')
+ self.assertEqual(len(db.connection.queries), 8)
+
+ def test_access_fks_with_select_related(self):
+ """
+ A select_related() call will fill in those related objects without any
+ extra queries
+ """
+ person = Species.objects.select_related(depth=10).get(name="sapiens")
+ domain = person.genus.family.order.klass.phylum.kingdom.domain
+ self.assertEqual(domain.name, 'Eukaryota')
+ self.assertEqual(len(db.connection.queries), 1)
+
+ def test_list_without_select_related(self):
+ """
+ select_related() also of course applies to entire lists, not just
+ items. This test verifies the expected behavior without select_related.
+ """
+ world = Species.objects.all()
+ families = [o.genus.family.name for o in world]
+ self.assertEqual(families, [
+ 'Drosophilidae',
+ 'Hominidae',
+ 'Fabaceae',
+ 'Amanitacae',
+ ])
+ self.assertEqual(len(db.connection.queries), 9)
+
+ def test_list_with_select_related(self):
+ """
+ select_related() also of course applies to entire lists, not just
+ items. This test verifies the expected behavior with select_related.
+ """
+ world = Species.objects.all().select_related()
+ families = [o.genus.family.name for o in world]
+ self.assertEqual(families, [
+ 'Drosophilidae',
+ 'Hominidae',
+ 'Fabaceae',
+ 'Amanitacae',
+ ])
+ self.assertEqual(len(db.connection.queries), 1)
+
+ def test_depth(self, depth=1, expected=7):
+ """
+ The "depth" argument to select_related() will stop the descent at a
+ particular level.
+ """
+ pea = Species.objects.select_related(depth=depth).get(name="sativum")
+ self.assertEqual(
+ pea.genus.family.order.klass.phylum.kingdom.domain.name,
+ 'Eukaryota'
+ )
+ # Notice: one fewer queries than above because of depth=1
+ self.assertEqual(len(db.connection.queries), expected)
+
+ def test_larger_depth(self):
+ """
+ The "depth" argument to select_related() will stop the descent at a
+ particular level. This tests a larger depth value.
+ """
+ self.test_depth(depth=5, expected=3)
+
+ def test_list_with_depth(self):
+ """
+ The "depth" argument to select_related() will stop the descent at a
+ particular level. This can be used on lists as well.
+ """
+ world = Species.objects.all().select_related(depth=2)
+ orders = [o.genus.family.order.name for o in world]
+ self.assertEqual(orders,
+ ['Diptera', 'Primates', 'Fabales', 'Agaricales'])
+ self.assertEqual(len(db.connection.queries), 5)
+
+ def test_select_related_with_extra(self):
+ s = Species.objects.all().select_related(depth=1)\
+ .extra(select={'a': 'select_related_species.id + 10'})[0]
+ self.assertEqual(s.id + 10, s.a)
+
+ def test_certain_fields(self):
+ """
+ The optional fields passed to select_related() control which related
+ models we pull in. This allows for smaller queries and can act as an
+ alternative (or, in addition to) the depth parameter.
+
+ In this case, we explicitly say to select the 'genus' and
+ 'genus.family' models, leading to the same number of queries as before.
+ """
+ world = Species.objects.select_related('genus__family')
+ families = [o.genus.family.name for o in world]
+ self.assertEqual(families,
+ ['Drosophilidae', 'Hominidae', 'Fabaceae', 'Amanitacae'])
+ self.assertEqual(len(db.connection.queries), 1)
+
+ def test_more_certain_fields(self):
+ """
+ In this case, we explicitly say to select the 'genus' and
+ 'genus.family' models, leading to the same number of queries as before.
+ """
+ world = Species.objects.filter(genus__name='Amanita')\
+ .select_related('genus__family')
+ orders = [o.genus.family.order.name for o in world]
+ self.assertEqual(orders, [u'Agaricales'])
+ self.assertEqual(len(db.connection.queries), 2)
+
+ def test_field_traversal(self):
+ s = Species.objects.all().select_related('genus__family__order'
+ ).order_by('id')[0:1].get().genus.family.order.name
+ self.assertEqual(s, u'Diptera')
+ self.assertEqual(len(db.connection.queries), 1)
+
+ def test_depth_fields_fails(self):
+ self.assertRaises(TypeError,
+ Species.objects.select_related,
+ 'genus__family__order', depth=4
+ )
Please sign in to comment.
Something went wrong with that request. Please try again.