From c0cb75ce6410b2be7745001f911a0505c5358d66 Mon Sep 17 00:00:00 2001 From: Russell Keith-Magee Date: Tue, 19 Oct 2010 12:01:47 +0000 Subject: [PATCH] Migrated many-to-many doctests. Thanks to George Sakkis for the patch. git-svn-id: http://code.djangoproject.com/svn/django/trunk@14285 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- tests/modeltests/many_to_many/models.py | 248 --------------- tests/modeltests/many_to_many/tests.py | 384 ++++++++++++++++++++++++ 2 files changed, 384 insertions(+), 248 deletions(-) create mode 100644 tests/modeltests/many_to_many/tests.py diff --git a/tests/modeltests/many_to_many/models.py b/tests/modeltests/many_to_many/models.py index 21b4e82aa0..96636da2b2 100644 --- a/tests/modeltests/many_to_many/models.py +++ b/tests/modeltests/many_to_many/models.py @@ -27,251 +27,3 @@ class Article(models.Model): class Meta: ordering = ('headline',) - -__test__ = {'API_TESTS':""" -# Create a couple of Publications. ->>> p1 = Publication(id=None, title='The Python Journal') ->>> p1.save() ->>> p2 = Publication(id=None, title='Science News') ->>> p2.save() ->>> p3 = Publication(id=None, title='Science Weekly') ->>> p3.save() - -# Create an Article. ->>> a1 = Article(id=None, headline='Django lets you build Web apps easily') - -# You can't associate it with a Publication until it's been saved. ->>> a1.publications.add(p1) -Traceback (most recent call last): -... -ValueError: 'Article' instance needs to have a primary key value before a many-to-many relationship can be used. - -# Save it! ->>> a1.save() - -# Associate the Article with a Publication. ->>> a1.publications.add(p1) - -# Create another Article, and set it to appear in both Publications. ->>> a2 = Article(id=None, headline='NASA uses Python') ->>> a2.save() ->>> a2.publications.add(p1, p2) ->>> a2.publications.add(p3) - -# Adding a second time is OK ->>> a2.publications.add(p3) - -# Adding an object of the wrong type raises TypeError ->>> a2.publications.add(a1) -Traceback (most recent call last): -... -TypeError: 'Publication' instance expected - -# Add a Publication directly via publications.add by using keyword arguments. ->>> new_publication = a2.publications.create(title='Highlights for Children') - -# Article objects have access to their related Publication objects. ->>> a1.publications.all() -[] ->>> a2.publications.all() -[, , , ] - -# Publication objects have access to their related Article objects. ->>> p2.article_set.all() -[] ->>> p1.article_set.all() -[, ] ->>> Publication.objects.get(id=4).article_set.all() -[] - -# We can perform kwarg queries across m2m relationships ->>> Article.objects.filter(publications__id__exact=1) -[, ] ->>> Article.objects.filter(publications__pk=1) -[, ] ->>> Article.objects.filter(publications=1) -[, ] ->>> Article.objects.filter(publications=p1) -[, ] - ->>> Article.objects.filter(publications__title__startswith="Science") -[, ] - ->>> Article.objects.filter(publications__title__startswith="Science").distinct() -[] - -# The count() function respects distinct() as well. ->>> Article.objects.filter(publications__title__startswith="Science").count() -2 - ->>> Article.objects.filter(publications__title__startswith="Science").distinct().count() -1 - ->>> Article.objects.filter(publications__in=[1,2]).distinct() -[, ] ->>> Article.objects.filter(publications__in=[1,p2]).distinct() -[, ] ->>> Article.objects.filter(publications__in=[p1,p2]).distinct() -[, ] - -# Reverse m2m queries are supported (i.e., starting at the table that doesn't -# have a ManyToManyField). ->>> Publication.objects.filter(id__exact=1) -[] ->>> Publication.objects.filter(pk=1) -[] - ->>> Publication.objects.filter(article__headline__startswith="NASA") -[, , , ] - ->>> Publication.objects.filter(article__id__exact=1) -[] ->>> Publication.objects.filter(article__pk=1) -[] ->>> Publication.objects.filter(article=1) -[] ->>> Publication.objects.filter(article=a1) -[] - ->>> Publication.objects.filter(article__in=[1,2]).distinct() -[, , , ] ->>> Publication.objects.filter(article__in=[1,a2]).distinct() -[, , , ] ->>> Publication.objects.filter(article__in=[a1,a2]).distinct() -[, , , ] - -# Excluding a related item works as you would expect, too (although the SQL -# involved is a little complex). ->>> Article.objects.exclude(publications=p2) -[] - -# If we delete a Publication, its Articles won't be able to access it. ->>> p1.delete() ->>> Publication.objects.all() -[, , ] ->>> a1 = Article.objects.get(pk=1) ->>> a1.publications.all() -[] - -# If we delete an Article, its Publications won't be able to access it. ->>> a2.delete() ->>> Article.objects.all() -[] ->>> p2.article_set.all() -[] - -# Adding via the 'other' end of an m2m ->>> a4 = Article(headline='NASA finds intelligent life on Earth') ->>> a4.save() ->>> p2.article_set.add(a4) ->>> p2.article_set.all() -[] ->>> a4.publications.all() -[] - -# Adding via the other end using keywords ->>> new_article = p2.article_set.create(headline='Oxygen-free diet works wonders') ->>> p2.article_set.all() -[, ] ->>> a5 = p2.article_set.all()[1] ->>> a5.publications.all() -[] - -# Removing publication from an article: ->>> a4.publications.remove(p2) ->>> p2.article_set.all() -[] ->>> a4.publications.all() -[] - -# And from the other end ->>> p2.article_set.remove(a5) ->>> p2.article_set.all() -[] ->>> a5.publications.all() -[] - -# Relation sets can be assigned. Assignment clears any existing set members ->>> p2.article_set = [a4, a5] ->>> p2.article_set.all() -[, ] ->>> a4.publications.all() -[] ->>> a4.publications = [p3] ->>> p2.article_set.all() -[] ->>> a4.publications.all() -[] - -# Relation sets can be cleared: ->>> p2.article_set.clear() ->>> p2.article_set.all() -[] ->>> a4.publications.all() -[] - -# And you can clear from the other end ->>> p2.article_set.add(a4, a5) ->>> p2.article_set.all() -[, ] ->>> a4.publications.all() -[, ] ->>> a4.publications.clear() ->>> a4.publications.all() -[] ->>> p2.article_set.all() -[] - -# Relation sets can also be set using primary key values ->>> p2.article_set = [a4.id, a5.id] ->>> p2.article_set.all() -[, ] ->>> a4.publications.all() -[] ->>> a4.publications = [p3.id] ->>> p2.article_set.all() -[] ->>> a4.publications.all() -[] - -# Recreate the article and Publication we have deleted. ->>> p1 = Publication(id=None, title='The Python Journal') ->>> p1.save() ->>> a2 = Article(id=None, headline='NASA uses Python') ->>> a2.save() ->>> a2.publications.add(p1, p2, p3) - -# Bulk delete some Publications - references to deleted publications should go ->>> Publication.objects.filter(title__startswith='Science').delete() ->>> Publication.objects.all() -[, ] ->>> Article.objects.all() -[, , , ] ->>> a2.publications.all() -[] - -# Bulk delete some articles - references to deleted objects should go ->>> q = Article.objects.filter(headline__startswith='Django') ->>> print q -[] ->>> q.delete() - -# After the delete, the QuerySet cache needs to be cleared, and the referenced objects should be gone ->>> print q -[] ->>> p1.article_set.all() -[] - -# An alternate to calling clear() is to assign the empty set ->>> p1.article_set = [] ->>> p1.article_set.all() -[] - ->>> a2.publications = [p1, new_publication] ->>> a2.publications.all() -[, ] ->>> a2.publications = [] ->>> a2.publications.all() -[] - -"""} diff --git a/tests/modeltests/many_to_many/tests.py b/tests/modeltests/many_to_many/tests.py new file mode 100644 index 0000000000..39fe581252 --- /dev/null +++ b/tests/modeltests/many_to_many/tests.py @@ -0,0 +1,384 @@ +from django.test import TestCase +from models import Article, Publication + +class ManyToManyTests(TestCase): + + def setUp(self): + # Create a couple of Publications. + self.p1 = Publication.objects.create(id=None, title='The Python Journal') + self.p2 = Publication.objects.create(id=None, title='Science News') + self.p3 = Publication.objects.create(id=None, title='Science Weekly') + self.p4 = Publication.objects.create(title='Highlights for Children') + + self.a1 = Article.objects.create(id=None, headline='Django lets you build Web apps easily') + self.a1.publications.add(self.p1) + + self.a2 = Article.objects.create(id=None, headline='NASA uses Python') + self.a2.publications.add(self.p1, self.p2, self.p3, self.p4) + + self.a3 = Article.objects.create(headline='NASA finds intelligent life on Earth') + self.a3.publications.add(self.p2) + + self.a4 = Article.objects.create(headline='Oxygen-free diet works wonders') + self.a4.publications.add(self.p2) + + def test_add(self): + # Create an Article. + a5 = Article(id=None, headline='Django lets you reate Web apps easily') + # You can't associate it with a Publication until it's been saved. + self.assertRaises(ValueError, getattr, a5, 'publications') + # Save it! + a5.save() + # Associate the Article with a Publication. + a5.publications.add(self.p1) + self.assertQuerysetEqual(a5.publications.all(), + ['']) + # Create another Article, and set it to appear in both Publications. + a6 = Article(id=None, headline='ESA uses Python') + a6.save() + a6.publications.add(self.p1, self.p2) + a6.publications.add(self.p3) + # Adding a second time is OK + a6.publications.add(self.p3) + self.assertQuerysetEqual(a6.publications.all(), + [ + '', + '', + '', + ]) + + # Adding an object of the wrong type raises TypeError + self.assertRaises(TypeError, a6.publications.add, a5) + # Add a Publication directly via publications.add by using keyword arguments. + p4 = a6.publications.create(title='Highlights for Adults') + self.assertQuerysetEqual(a6.publications.all(), + [ + '', + '', + '', + '', + ]) + + def test_reverse_add(self): + # Adding via the 'other' end of an m2m + a5 = Article(headline='NASA finds intelligent life on Mars') + a5.save() + self.p2.article_set.add(a5) + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + '', + '', + ]) + self.assertQuerysetEqual(a5.publications.all(), + ['']) + + # Adding via the other end using keywords + new_article = self.p2.article_set.create(headline='Carbon-free diet works wonders') + self.assertQuerysetEqual( + self.p2.article_set.all(), + [ + '', + '', + '', + '', + '', + ]) + a6 = self.p2.article_set.all()[3] + self.assertQuerysetEqual(a6.publications.all(), + [ + '', + '', + '', + '', + ]) + + def test_related_sets(self): + # Article objects have access to their related Publication objects. + self.assertQuerysetEqual(self.a1.publications.all(), + ['']) + self.assertQuerysetEqual(self.a2.publications.all(), + [ + '', + '', + '', + '', + ]) + # Publication objects have access to their related Article objects. + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + '', + ]) + self.assertQuerysetEqual(self.p1.article_set.all(), + [ + '', + '', + ]) + self.assertQuerysetEqual(Publication.objects.get(id=self.p4.id).article_set.all(), + ['']) + + def test_selects(self): + # We can perform kwarg queries across m2m relationships + self.assertQuerysetEqual( + Article.objects.filter(publications__id__exact=self.p1.id), + [ + '', + '', + ]) + self.assertQuerysetEqual( + Article.objects.filter(publications__pk=self.p1.id), + [ + '', + '', + ]) + self.assertQuerysetEqual( + Article.objects.filter(publications=self.p1.id), + [ + '', + '', + ]) + self.assertQuerysetEqual( + Article.objects.filter(publications=self.p1), + [ + '', + '', + ]) + self.assertQuerysetEqual( + Article.objects.filter(publications__title__startswith="Science"), + [ + '', + '', + '', + '', + ]) + self.assertQuerysetEqual( + Article.objects.filter(publications__title__startswith="Science").distinct(), + [ + '', + '', + '', + ]) + + # The count() function respects distinct() as well. + self.assertEqual(Article.objects.filter(publications__title__startswith="Science").count(), 4) + self.assertEqual(Article.objects.filter(publications__title__startswith="Science").distinct().count(), 3) + self.assertQuerysetEqual( + Article.objects.filter(publications__in=[self.p1.id,self.p2.id]).distinct(), + [ + '', + '', + '', + '', + ]) + self.assertQuerysetEqual( + Article.objects.filter(publications__in=[self.p1.id,self.p2]).distinct(), + [ + '', + '', + '', + '', + ]) + self.assertQuerysetEqual( + Article.objects.filter(publications__in=[self.p1,self.p2]).distinct(), + [ + '', + '', + '', + '', + ]) + + # Excluding a related item works as you would expect, too (although the SQL + # involved is a little complex). + self.assertQuerysetEqual(Article.objects.exclude(publications=self.p2), + ['']) + + def test_reverse_selects(self): + # Reverse m2m queries are supported (i.e., starting at the table that + # doesn't have a ManyToManyField). + self.assertQuerysetEqual(Publication.objects.filter(id__exact=self.p1.id), + ['']) + self.assertQuerysetEqual(Publication.objects.filter(pk=self.p1.id), + ['']) + self.assertQuerysetEqual( + Publication.objects.filter(article__headline__startswith="NASA"), + [ + '', + '', + '', + '', + '', + ]) + self.assertQuerysetEqual(Publication.objects.filter(article__id__exact=self.a1.id), + ['']) + self.assertQuerysetEqual(Publication.objects.filter(article__pk=self.a1.id), + ['']) + self.assertQuerysetEqual(Publication.objects.filter(article=self.a1.id), + ['']) + self.assertQuerysetEqual(Publication.objects.filter(article=self.a1), + ['']) + + self.assertQuerysetEqual( + Publication.objects.filter(article__in=[self.a1.id,self.a2.id]).distinct(), + [ + '', + '', + '', + '', + ]) + self.assertQuerysetEqual( + Publication.objects.filter(article__in=[self.a1.id,self.a2]).distinct(), + [ + '', + '', + '', + '', + ]) + self.assertQuerysetEqual( + Publication.objects.filter(article__in=[self.a1,self.a2]).distinct(), + [ + '', + '', + '', + '', + ]) + + def test_delete(self): + # If we delete a Publication, its Articles won't be able to access it. + self.p1.delete() + self.assertQuerysetEqual(Publication.objects.all(), + [ + '', + '', + '', + ]) + self.assertQuerysetEqual(self.a1.publications.all(), []) + # If we delete an Article, its Publications won't be able to access it. + self.a2.delete() + self.assertQuerysetEqual(Article.objects.all(), + [ + '', + '', + '', + ]) + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + ]) + + def test_bulk_delete(self): + # Bulk delete some Publications - references to deleted publications should go + Publication.objects.filter(title__startswith='Science').delete() + self.assertQuerysetEqual(Publication.objects.all(), + [ + '', + '', + ]) + self.assertQuerysetEqual(Article.objects.all(), + [ + '', + '', + '', + '', + ]) + self.assertQuerysetEqual(self.a2.publications.all(), + [ + '', + '', + ]) + + # Bulk delete some articles - references to deleted objects should go + q = Article.objects.filter(headline__startswith='Django') + self.assertQuerysetEqual(q, ['']) + q.delete() + # After the delete, the QuerySet cache needs to be cleared, + # and the referenced objects should be gone + self.assertQuerysetEqual(q, []) + self.assertQuerysetEqual(self.p1.article_set.all(), + ['']) + + def test_remove(self): + # Removing publication from an article: + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + '', + ]) + self.a4.publications.remove(self.p2) + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + ]) + self.assertQuerysetEqual(self.a4.publications.all(), []) + # And from the other end + self.p2.article_set.remove(self.a3) + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + ]) + self.assertQuerysetEqual(self.a3.publications.all(), []) + + def test_assign(self): + # Relation sets can be assigned. Assignment clears any existing set members + self.p2.article_set = [self.a4, self.a3] + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + ]) + self.assertQuerysetEqual(self.a4.publications.all(), + ['']) + self.a4.publications = [self.p3.id] + self.assertQuerysetEqual(self.p2.article_set.all(), + ['']) + self.assertQuerysetEqual(self.a4.publications.all(), + ['']) + + # An alternate to calling clear() is to assign the empty set + self.p2.article_set = [] + self.assertQuerysetEqual(self.p2.article_set.all(), []) + self.a4.publications = [] + self.assertQuerysetEqual(self.a4.publications.all(), []) + + def test_assign_ids(self): + # Relation sets can also be set using primary key values + self.p2.article_set = [self.a4.id, self.a3.id] + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + ]) + self.assertQuerysetEqual(self.a4.publications.all(), + ['']) + self.a4.publications = [self.p3.id] + self.assertQuerysetEqual(self.p2.article_set.all(), + ['']) + self.assertQuerysetEqual(self.a4.publications.all(), + ['']) + + def test_clear(self): + # Relation sets can be cleared: + self.p2.article_set.clear() + self.assertQuerysetEqual(self.p2.article_set.all(), []) + self.assertQuerysetEqual(self.a4.publications.all(), []) + + # And you can clear from the other end + self.p2.article_set.add(self.a3, self.a4) + self.assertQuerysetEqual(self.p2.article_set.all(), + [ + '', + '', + ]) + self.assertQuerysetEqual(self.a4.publications.all(), + [ + '', + ]) + self.a4.publications.clear() + self.assertQuerysetEqual(self.a4.publications.all(), []) + self.assertQuerysetEqual(self.p2.article_set.all(), + [''])