diff --git a/tests/modeltests/generic_relations/models.py b/tests/modeltests/generic_relations/models.py index 1bc6577bf7..6161f9ebea 100644 --- a/tests/modeltests/generic_relations/models.py +++ b/tests/modeltests/generic_relations/models.py @@ -9,9 +9,10 @@ The canonical example is tags (although this example implementation is *far* from complete). """ -from django.db import models -from django.contrib.contenttypes.models import ContentType from django.contrib.contenttypes import generic +from django.contrib.contenttypes.models import ContentType +from django.db import models + class TaggedItem(models.Model): """A tag on an item.""" @@ -77,170 +78,3 @@ class Mineral(models.Model): def __unicode__(self): return self.name - -__test__ = {'API_TESTS':""" -# Create the world in 7 lines of code... ->>> lion = Animal(common_name="Lion", latin_name="Panthera leo") ->>> platypus = Animal(common_name="Platypus", latin_name="Ornithorhynchus anatinus") ->>> eggplant = Vegetable(name="Eggplant", is_yucky=True) ->>> bacon = Vegetable(name="Bacon", is_yucky=False) ->>> quartz = Mineral(name="Quartz", hardness=7) ->>> for o in (platypus, lion, eggplant, bacon, quartz): -... o.save() - -# Objects with declared GenericRelations can be tagged directly -- the API -# mimics the many-to-many API. ->>> bacon.tags.create(tag="fatty") - ->>> bacon.tags.create(tag="salty") - ->>> lion.tags.create(tag="yellow") - ->>> lion.tags.create(tag="hairy") - ->>> platypus.tags.create(tag="fatty") - - ->>> lion.tags.all() -[, ] ->>> bacon.tags.all() -[, ] - -# You can easily access the content object like a foreign key. ->>> t = TaggedItem.objects.get(tag="salty") ->>> t.content_object - - -# Recall that the Mineral class doesn't have an explicit GenericRelation -# defined. That's OK, because you can create TaggedItems explicitly. ->>> tag1 = TaggedItem(content_object=quartz, tag="shiny") ->>> tag2 = TaggedItem(content_object=quartz, tag="clearish") ->>> tag1.save() ->>> tag2.save() - -# However, excluding GenericRelations means your lookups have to be a bit more -# explicit. ->>> from django.contrib.contenttypes.models import ContentType ->>> ctype = ContentType.objects.get_for_model(quartz) ->>> TaggedItem.objects.filter(content_type__pk=ctype.id, object_id=quartz.id) -[, ] - -# You can set a generic foreign key in the way you'd expect. ->>> tag1.content_object = platypus ->>> tag1.save() ->>> platypus.tags.all() -[, ] ->>> TaggedItem.objects.filter(content_type__pk=ctype.id, object_id=quartz.id) -[] - -# Queries across generic relations respect the content types. Even though there are two TaggedItems with a tag of "fatty", this query only pulls out the one with the content type related to Animals. ->>> Animal.objects.order_by('common_name') -[, ] ->>> Animal.objects.filter(tags__tag='fatty') -[] ->>> Animal.objects.exclude(tags__tag='fatty') -[] - -# If you delete an object with an explicit Generic relation, the related -# objects are deleted when the source object is deleted. -# Original list of tags: ->>> [(t.tag, t.content_type, t.object_id) for t in TaggedItem.objects.all()] -[(u'clearish', , 1), (u'fatty', , 2), (u'fatty', , 1), (u'hairy', , 2), (u'salty', , 2), (u'shiny', , 1), (u'yellow', , 2)] - ->>> lion.delete() ->>> [(t.tag, t.content_type, t.object_id) for t in TaggedItem.objects.all()] -[(u'clearish', , 1), (u'fatty', , 2), (u'fatty', , 1), (u'salty', , 2), (u'shiny', , 1)] - -# If Generic Relation is not explicitly defined, any related objects -# remain after deletion of the source object. ->>> quartz.delete() ->>> [(t.tag, t.content_type, t.object_id) for t in TaggedItem.objects.all()] -[(u'clearish', , 1), (u'fatty', , 2), (u'fatty', , 1), (u'salty', , 2), (u'shiny', , 1)] - -# If you delete a tag, the objects using the tag are unaffected -# (other than losing a tag) ->>> tag = TaggedItem.objects.get(id=1) ->>> tag.delete() ->>> bacon.tags.all() -[] ->>> [(t.tag, t.content_type, t.object_id) for t in TaggedItem.objects.all()] -[(u'clearish', , 1), (u'fatty', , 1), (u'salty', , 2), (u'shiny', , 1)] - ->>> TaggedItem.objects.filter(tag='fatty').delete() - ->>> ctype = ContentType.objects.get_for_model(lion) ->>> Animal.objects.filter(tags__content_type=ctype) -[] - -# Simple tests for multiple GenericForeignKeys -# only uses one model, since the above tests should be sufficient. ->>> tiger, cheetah, bear = Animal(common_name="tiger"), Animal(common_name="cheetah"), Animal(common_name="bear") ->>> for o in [tiger, cheetah, bear]: o.save() - -# Create directly ->>> Comparison(first_obj=cheetah, other_obj=tiger, comparative="faster").save() ->>> Comparison(first_obj=tiger, other_obj=cheetah, comparative="cooler").save() - -# Create using GenericRelation ->>> tiger.comparisons.create(other_obj=bear, comparative="cooler") - ->>> tiger.comparisons.create(other_obj=cheetah, comparative="stronger") - - ->>> cheetah.comparisons.all() -[] - -# Filtering works ->>> tiger.comparisons.filter(comparative="cooler") -[, ] - -# Filtering and deleting works ->>> subjective = ["cooler"] ->>> tiger.comparisons.filter(comparative__in=subjective).delete() ->>> Comparison.objects.all() -[, ] - -# If we delete cheetah, Comparisons with cheetah as 'first_obj' will be deleted -# since Animal has an explicit GenericRelation to Comparison through first_obj. -# Comparisons with cheetah as 'other_obj' will not be deleted. ->>> cheetah.delete() ->>> Comparison.objects.all() -[] - -# GenericForeignKey should work with subclasses (see #8309) ->>> quartz = Mineral.objects.create(name="Quartz", hardness=7) ->>> valuedtag = ValuableTaggedItem(content_object=quartz, tag="shiny", value=10) ->>> valuedtag.save() ->>> valuedtag.content_object - - -# GenericInlineFormSet tests ################################################## - ->>> from django.contrib.contenttypes.generic import generic_inlineformset_factory - ->>> GenericFormSet = generic_inlineformset_factory(TaggedItem, extra=1) ->>> formset = GenericFormSet() ->>> for form in formset.forms: -... print form.as_p() -

-

->>> formset = GenericFormSet(instance=Animal()) ->>> for form in formset.forms: -... print form.as_p() -

-

- ->>> formset = GenericFormSet(instance=platypus) ->>> for form in formset.forms: -... print form.as_p() -

-

-

-

- ->>> formset = GenericFormSet(instance=lion, prefix='x') ->>> for form in formset.forms: -... print form.as_p() -

-

-"""} diff --git a/tests/modeltests/generic_relations/tests.py b/tests/modeltests/generic_relations/tests.py new file mode 100644 index 0000000000..e26db55ade --- /dev/null +++ b/tests/modeltests/generic_relations/tests.py @@ -0,0 +1,223 @@ +from django.contrib.contenttypes.generic import generic_inlineformset_factory +from django.contrib.contenttypes.models import ContentType +from django.test import TestCase + +from models import (TaggedItem, ValuableTaggedItem, Comparison, Animal, + Vegetable, Mineral) + + +class GenericRelationsTests(TestCase): + def test_generic_relations(self): + # Create the world in 7 lines of code... + lion = Animal.objects.create(common_name="Lion", latin_name="Panthera leo") + platypus = Animal.objects.create( + common_name="Platypus", latin_name="Ornithorhynchus anatinus" + ) + eggplant = Vegetable.objects.create(name="Eggplant", is_yucky=True) + bacon = Vegetable.objects.create(name="Bacon", is_yucky=False) + quartz = Mineral.objects.create(name="Quartz", hardness=7) + + # Objects with declared GenericRelations can be tagged directly -- the + # API mimics the many-to-many API. + bacon.tags.create(tag="fatty") + bacon.tags.create(tag="salty") + lion.tags.create(tag="yellow") + lion.tags.create(tag="hairy") + platypus.tags.create(tag="fatty") + self.assertQuerysetEqual(lion.tags.all(), [ + "", + "" + ]) + self.assertQuerysetEqual(bacon.tags.all(), [ + "", + "" + ]) + + # You can easily access the content object like a foreign key. + t = TaggedItem.objects.get(tag="salty") + self.assertEqual(t.content_object, bacon) + + # Recall that the Mineral class doesn't have an explicit GenericRelation + # defined. That's OK, because you can create TaggedItems explicitly. + tag1 = TaggedItem.objects.create(content_object=quartz, tag="shiny") + tag2 = TaggedItem.objects.create(content_object=quartz, tag="clearish") + + # However, excluding GenericRelations means your lookups have to be a + # bit more explicit. + ctype = ContentType.objects.get_for_model(quartz) + q = TaggedItem.objects.filter( + content_type__pk=ctype.id, object_id=quartz.id + ) + self.assertQuerysetEqual(q, [ + "", + "" + ]) + + # You can set a generic foreign key in the way you'd expect. + tag1.content_object = platypus + tag1.save() + self.assertQuerysetEqual(platypus.tags.all(), [ + "", + "" + ]) + q = TaggedItem.objects.filter( + content_type__pk=ctype.id, object_id=quartz.id + ) + self.assertQuerysetEqual(q, [""]) + + # Queries across generic relations respect the content types. Even + # though there are two TaggedItems with a tag of "fatty", this query + # only pulls out the one with the content type related to Animals. + self.assertQuerysetEqual(Animal.objects.order_by('common_name'), [ + "", + "" + ]) + self.assertQuerysetEqual(Animal.objects.filter(tags__tag='fatty'), [ + "" + ]) + self.assertQuerysetEqual(Animal.objects.exclude(tags__tag='fatty'), [ + "" + ]) + + # If you delete an object with an explicit Generic relation, the related + # objects are deleted when the source object is deleted. + # Original list of tags: + comp_func = lambda obj: ( + obj.tag, obj.content_type.model_class(), obj.object_id + ) + + self.assertQuerysetEqual(TaggedItem.objects.all(), [ + (u'clearish', Mineral, quartz.pk), + (u'fatty', Vegetable, bacon.pk), + (u'fatty', Animal, platypus.pk), + (u'hairy', Animal, lion.pk), + (u'salty', Vegetable, bacon.pk), + (u'shiny', Animal, platypus.pk), + (u'yellow', Animal, lion.pk) + ], + comp_func + ) + lion.delete() + self.assertQuerysetEqual(TaggedItem.objects.all(), [ + (u'clearish', Mineral, quartz.pk), + (u'fatty', Vegetable, bacon.pk), + (u'fatty', Animal, platypus.pk), + (u'salty', Vegetable, bacon.pk), + (u'shiny', Animal, platypus.pk) + ], + comp_func + ) + + # If Generic Relation is not explicitly defined, any related objects + # remain after deletion of the source object. + quartz_pk = quartz.pk + quartz.delete() + self.assertQuerysetEqual(TaggedItem.objects.all(), [ + (u'clearish', Mineral, quartz_pk), + (u'fatty', Vegetable, bacon.pk), + (u'fatty', Animal, platypus.pk), + (u'salty', Vegetable, bacon.pk), + (u'shiny', Animal, platypus.pk) + ], + comp_func + ) + # If you delete a tag, the objects using the tag are unaffected + # (other than losing a tag) + tag = TaggedItem.objects.get(id=1) + tag.delete() + self.assertQuerysetEqual(bacon.tags.all(), [""]) + self.assertQuerysetEqual(TaggedItem.objects.all(), [ + (u'clearish', Mineral, quartz_pk), + (u'fatty', Animal, platypus.pk), + (u'salty', Vegetable, bacon.pk), + (u'shiny', Animal, platypus.pk) + ], + comp_func + ) + TaggedItem.objects.filter(tag='fatty').delete() + ctype = ContentType.objects.get_for_model(lion) + self.assertQuerysetEqual(Animal.objects.filter(tags__content_type=ctype), [ + "" + ]) + + + def test_multiple_gfk(self): + # Simple tests for multiple GenericForeignKeys + # only uses one model, since the above tests should be sufficient. + tiger = Animal.objects.create(common_name="tiger") + cheetah = Animal.objects.create(common_name="cheetah") + bear = Animal.objects.create(common_name="bear") + + # Create directly + Comparison.objects.create( + first_obj=cheetah, other_obj=tiger, comparative="faster" + ) + Comparison.objects.create( + first_obj=tiger, other_obj=cheetah, comparative="cooler" + ) + + # Create using GenericRelation + tiger.comparisons.create(other_obj=bear, comparative="cooler") + tiger.comparisons.create(other_obj=cheetah, comparative="stronger") + self.assertQuerysetEqual(cheetah.comparisons.all(), [ + "" + ]) + + # Filtering works + self.assertQuerysetEqual(tiger.comparisons.filter(comparative="cooler"), [ + "", + "" + ]) + + # Filtering and deleting works + subjective = ["cooler"] + tiger.comparisons.filter(comparative__in=subjective).delete() + self.assertQuerysetEqual(Comparison.objects.all(), [ + "", + "" + ]) + + # If we delete cheetah, Comparisons with cheetah as 'first_obj' will be + # deleted since Animal has an explicit GenericRelation to Comparison + # through first_obj. Comparisons with cheetah as 'other_obj' will not + # be deleted. + cheetah.delete() + self.assertQuerysetEqual(Comparison.objects.all(), [ + "" + ]) + + def test_gfk_subclasses(self): + # GenericForeignKey should work with subclasses (see #8309) + quartz = Mineral.objects.create(name="Quartz", hardness=7) + valuedtag = ValuableTaggedItem.objects.create( + content_object=quartz, tag="shiny", value=10 + ) + self.assertEqual(valuedtag.content_object, quartz) + + def test_generic_inline_formsets(self): + GenericFormSet = generic_inlineformset_factory(TaggedItem, extra=1) + formset = GenericFormSet() + self.assertEqual(u''.join(form.as_p() for form in formset.forms), u"""

+

""") + + formset = GenericFormSet(instance=Animal()) + self.assertEqual(u''.join(form.as_p() for form in formset.forms), u"""

+

""") + + platypus = Animal.objects.create( + common_name="Platypus", latin_name="Ornithorhynchus anatinus" + ) + platypus.tags.create(tag="shiny") + GenericFormSet = generic_inlineformset_factory(TaggedItem, extra=1) + formset = GenericFormSet(instance=platypus) + tagged_item_id = TaggedItem.objects.get( + tag='shiny', object_id=platypus.id + ).id + self.assertEqual(u''.join(form.as_p() for form in formset.forms), u"""

+

+

""" % tagged_item_id) + + lion = Animal.objects.create(common_name="Lion", latin_name="Panthera leo") + formset = GenericFormSet(instance=lion, prefix='x') + self.assertEqual(u''.join(form.as_p() for form in formset.forms), u"""

+

""")