511 lines
19 KiB
Python
511 lines
19 KiB
Python
from __future__ import unicode_literals
|
|
|
|
from django.test import TestCase
|
|
from django.utils import six
|
|
|
|
from .models import (Book, Car, FunPerson, OneToOneRestrictedModel, Person,
|
|
PersonManager, PublishedBookManager, RelatedModel, RestrictedModel)
|
|
|
|
|
|
class CustomManagerTests(TestCase):
|
|
def setUp(self):
|
|
self.b1 = Book.published_objects.create(
|
|
title="How to program", author="Rodney Dangerfield", is_published=True)
|
|
self.b2 = Book.published_objects.create(
|
|
title="How to be smart", author="Albert Einstein", is_published=False)
|
|
|
|
def test_manager(self):
|
|
Person.objects.create(first_name="Bugs", last_name="Bunny", fun=True)
|
|
droopy = Person.objects.create(first_name="Droopy", last_name="Dog", fun=False)
|
|
|
|
# Test a custom `Manager` method.
|
|
self.assertQuerysetEqual(
|
|
Person.objects.get_fun_people(), [
|
|
"Bugs Bunny"
|
|
],
|
|
six.text_type
|
|
)
|
|
|
|
# Test that the methods of a custom `QuerySet` are properly
|
|
# copied onto the default `Manager`.
|
|
for manager in ['custom_queryset_default_manager',
|
|
'custom_queryset_custom_manager']:
|
|
manager = getattr(Person, manager)
|
|
|
|
# Copy public methods.
|
|
manager.public_method()
|
|
# Don't copy private methods.
|
|
with self.assertRaises(AttributeError):
|
|
manager._private_method()
|
|
# Copy methods with `manager=True` even if they are private.
|
|
manager._optin_private_method()
|
|
# Don't copy methods with `manager=False` even if they are public.
|
|
with self.assertRaises(AttributeError):
|
|
manager.optout_public_method()
|
|
|
|
# Test that the overridden method is called.
|
|
queryset = manager.filter()
|
|
self.assertQuerysetEqual(queryset, ["Bugs Bunny"], six.text_type)
|
|
self.assertEqual(queryset._filter_CustomQuerySet, True)
|
|
|
|
# Test that specialized querysets inherit from our custom queryset.
|
|
queryset = manager.values_list('first_name', flat=True).filter()
|
|
self.assertEqual(list(queryset), [six.text_type("Bugs")])
|
|
self.assertEqual(queryset._filter_CustomQuerySet, True)
|
|
|
|
# Test that the custom manager `__init__()` argument has been set.
|
|
self.assertEqual(Person.custom_queryset_custom_manager.init_arg, 'hello')
|
|
|
|
# Test that the custom manager method is only available on the manager.
|
|
Person.custom_queryset_custom_manager.manager_only()
|
|
with self.assertRaises(AttributeError):
|
|
Person.custom_queryset_custom_manager.all().manager_only()
|
|
|
|
# Test that the queryset method doesn't override the custom manager method.
|
|
queryset = Person.custom_queryset_custom_manager.filter()
|
|
self.assertQuerysetEqual(queryset, ["Bugs Bunny"], six.text_type)
|
|
self.assertEqual(queryset._filter_CustomManager, True)
|
|
|
|
# The RelatedManager used on the 'books' descriptor extends the default
|
|
# manager
|
|
self.assertIsInstance(droopy.books, PublishedBookManager)
|
|
|
|
# The default manager, "objects", doesn't exist, because a custom one
|
|
# was provided.
|
|
self.assertRaises(AttributeError, lambda: Book.objects)
|
|
|
|
# The RelatedManager used on the 'authors' descriptor extends the
|
|
# default manager
|
|
self.assertIsInstance(self.b2.authors, PersonManager)
|
|
|
|
self.assertQuerysetEqual(
|
|
Book.published_objects.all(), [
|
|
"How to program",
|
|
],
|
|
lambda b: b.title
|
|
)
|
|
|
|
Car.cars.create(name="Corvette", mileage=21, top_speed=180)
|
|
Car.cars.create(name="Neon", mileage=31, top_speed=100)
|
|
|
|
self.assertQuerysetEqual(
|
|
Car.cars.order_by("name"), [
|
|
"Corvette",
|
|
"Neon",
|
|
],
|
|
lambda c: c.name
|
|
)
|
|
|
|
self.assertQuerysetEqual(
|
|
Car.fast_cars.all(), [
|
|
"Corvette",
|
|
],
|
|
lambda c: c.name
|
|
)
|
|
|
|
# Each model class gets a "_default_manager" attribute, which is a
|
|
# reference to the first manager defined in the class. In this case,
|
|
# it's "cars".
|
|
|
|
self.assertQuerysetEqual(
|
|
Car._default_manager.order_by("name"), [
|
|
"Corvette",
|
|
"Neon",
|
|
],
|
|
lambda c: c.name
|
|
)
|
|
|
|
def test_fk_related_manager(self):
|
|
Person.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_book=self.b1)
|
|
Person.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_book=self.b1)
|
|
FunPerson.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_book=self.b1)
|
|
FunPerson.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_book=self.b1)
|
|
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_books.order_by('first_name').all(), [
|
|
"Bugs",
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.fun_people_favorite_books.all(), [
|
|
"Bugs",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_books(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_books(manager='fun_people').all(), [
|
|
"Bugs",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_gfk_related_manager(self):
|
|
Person.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_thing=self.b1)
|
|
Person.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_thing=self.b1)
|
|
FunPerson.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_thing=self.b1)
|
|
FunPerson.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_thing=self.b1)
|
|
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_things.all(), [
|
|
"Bugs",
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.fun_people_favorite_things.all(), [
|
|
"Bugs",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_things(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_things(manager='fun_people').all(), [
|
|
"Bugs",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_m2m_related_manager(self):
|
|
bugs = Person.objects.create(first_name="Bugs", last_name="Bunny", fun=True)
|
|
self.b1.authors.add(bugs)
|
|
droopy = Person.objects.create(first_name="Droopy", last_name="Dog", fun=False)
|
|
self.b1.authors.add(droopy)
|
|
bugs = FunPerson.objects.create(first_name="Bugs", last_name="Bunny", fun=True)
|
|
self.b1.fun_authors.add(bugs)
|
|
droopy = FunPerson.objects.create(first_name="Droopy", last_name="Dog", fun=False)
|
|
self.b1.fun_authors.add(droopy)
|
|
|
|
self.assertQuerysetEqual(
|
|
self.b1.authors.order_by('first_name').all(), [
|
|
"Bugs",
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.fun_authors.order_by('first_name').all(), [
|
|
"Bugs",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.authors(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.authors(manager='fun_people').all(), [
|
|
"Bugs",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_removal_through_default_fk_related_manager(self, bulk=True):
|
|
bugs = FunPerson.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_book=self.b1)
|
|
droopy = FunPerson.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_book=self.b1)
|
|
|
|
self.b1.fun_people_favorite_books.remove(droopy, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
FunPerson._base_manager.filter(favorite_book=self.b1), [
|
|
"Bugs",
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
self.b1.fun_people_favorite_books.remove(bugs, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
FunPerson._base_manager.filter(favorite_book=self.b1), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
bugs.favorite_book = self.b1
|
|
bugs.save()
|
|
|
|
self.b1.fun_people_favorite_books.clear(bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
FunPerson._base_manager.filter(favorite_book=self.b1), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_slow_removal_through_default_fk_related_manager(self):
|
|
self.test_removal_through_default_fk_related_manager(bulk=False)
|
|
|
|
def test_removal_through_specified_fk_related_manager(self, bulk=True):
|
|
Person.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_book=self.b1)
|
|
droopy = Person.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_book=self.b1)
|
|
|
|
# Check that the fun manager DOESN'T remove boring people.
|
|
self.b1.favorite_books(manager='fun_people').remove(droopy, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_books(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
# Check that the boring manager DOES remove boring people.
|
|
self.b1.favorite_books(manager='boring_people').remove(droopy, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_books(manager='boring_people').all(), [
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
droopy.favorite_book = self.b1
|
|
droopy.save()
|
|
|
|
# Check that the fun manager ONLY clears fun people.
|
|
self.b1.favorite_books(manager='fun_people').clear(bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_books(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_books(manager='fun_people').all(), [
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_slow_removal_through_specified_fk_related_manager(self):
|
|
self.test_removal_through_specified_fk_related_manager(bulk=False)
|
|
|
|
def test_removal_through_default_gfk_related_manager(self, bulk=True):
|
|
bugs = FunPerson.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_thing=self.b1)
|
|
droopy = FunPerson.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_thing=self.b1)
|
|
|
|
self.b1.fun_people_favorite_things.remove(droopy, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
FunPerson._base_manager.order_by('first_name').filter(favorite_thing_id=self.b1.pk), [
|
|
"Bugs",
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
self.b1.fun_people_favorite_things.remove(bugs, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
FunPerson._base_manager.order_by('first_name').filter(favorite_thing_id=self.b1.pk), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
bugs.favorite_book = self.b1
|
|
bugs.save()
|
|
|
|
self.b1.fun_people_favorite_things.clear(bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
FunPerson._base_manager.order_by('first_name').filter(favorite_thing_id=self.b1.pk), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_slow_removal_through_default_gfk_related_manager(self):
|
|
self.test_removal_through_default_gfk_related_manager(bulk=False)
|
|
|
|
def test_removal_through_specified_gfk_related_manager(self, bulk=True):
|
|
Person.objects.create(first_name="Bugs", last_name="Bunny", fun=True, favorite_thing=self.b1)
|
|
droopy = Person.objects.create(first_name="Droopy", last_name="Dog", fun=False, favorite_thing=self.b1)
|
|
|
|
# Check that the fun manager DOESN'T remove boring people.
|
|
self.b1.favorite_things(manager='fun_people').remove(droopy, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_things(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
# Check that the boring manager DOES remove boring people.
|
|
self.b1.favorite_things(manager='boring_people').remove(droopy, bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_things(manager='boring_people').all(), [
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
droopy.favorite_thing = self.b1
|
|
droopy.save()
|
|
|
|
# Check that the fun manager ONLY clears fun people.
|
|
self.b1.favorite_things(manager='fun_people').clear(bulk=bulk)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_things(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.favorite_things(manager='fun_people').all(), [
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_slow_removal_through_specified_gfk_related_manager(self):
|
|
self.test_removal_through_specified_gfk_related_manager(bulk=False)
|
|
|
|
def test_removal_through_default_m2m_related_manager(self):
|
|
bugs = FunPerson.objects.create(first_name="Bugs", last_name="Bunny", fun=True)
|
|
self.b1.fun_authors.add(bugs)
|
|
droopy = FunPerson.objects.create(first_name="Droopy", last_name="Dog", fun=False)
|
|
self.b1.fun_authors.add(droopy)
|
|
|
|
self.b1.fun_authors.remove(droopy)
|
|
self.assertQuerysetEqual(
|
|
self.b1.fun_authors.through._default_manager.all(), [
|
|
"Bugs",
|
|
"Droopy",
|
|
],
|
|
lambda c: c.funperson.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
self.b1.fun_authors.remove(bugs)
|
|
self.assertQuerysetEqual(
|
|
self.b1.fun_authors.through._default_manager.all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.funperson.first_name,
|
|
ordered=False,
|
|
)
|
|
self.b1.fun_authors.add(bugs)
|
|
|
|
self.b1.fun_authors.clear()
|
|
self.assertQuerysetEqual(
|
|
self.b1.fun_authors.through._default_manager.all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.funperson.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
def test_removal_through_specified_m2m_related_manager(self):
|
|
bugs = Person.objects.create(first_name="Bugs", last_name="Bunny", fun=True)
|
|
self.b1.authors.add(bugs)
|
|
droopy = Person.objects.create(first_name="Droopy", last_name="Dog", fun=False)
|
|
self.b1.authors.add(droopy)
|
|
|
|
# Check that the fun manager DOESN'T remove boring people.
|
|
self.b1.authors(manager='fun_people').remove(droopy)
|
|
self.assertQuerysetEqual(
|
|
self.b1.authors(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
# Check that the boring manager DOES remove boring people.
|
|
self.b1.authors(manager='boring_people').remove(droopy)
|
|
self.assertQuerysetEqual(
|
|
self.b1.authors(manager='boring_people').all(), [
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.b1.authors.add(droopy)
|
|
|
|
# Check that the fun manager ONLY clears fun people.
|
|
self.b1.authors(manager='fun_people').clear()
|
|
self.assertQuerysetEqual(
|
|
self.b1.authors(manager='boring_people').all(), [
|
|
"Droopy",
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
self.assertQuerysetEqual(
|
|
self.b1.authors(manager='fun_people').all(), [
|
|
],
|
|
lambda c: c.first_name,
|
|
ordered=False,
|
|
)
|
|
|
|
|
|
class CustomManagersRegressTestCase(TestCase):
|
|
def test_filtered_default_manager(self):
|
|
"""Even though the default manager filters out some records,
|
|
we must still be able to save (particularly, save by updating
|
|
existing records) those filtered instances. This is a
|
|
regression test for #8990, #9527"""
|
|
related = RelatedModel.objects.create(name="xyzzy")
|
|
obj = RestrictedModel.objects.create(name="hidden", related=related)
|
|
obj.name = "still hidden"
|
|
obj.save()
|
|
|
|
# If the hidden object wasn't seen during the save process,
|
|
# there would now be two objects in the database.
|
|
self.assertEqual(RestrictedModel.plain_manager.count(), 1)
|
|
|
|
def test_delete_related_on_filtered_manager(self):
|
|
"""Deleting related objects should also not be distracted by a
|
|
restricted manager on the related object. This is a regression
|
|
test for #2698."""
|
|
related = RelatedModel.objects.create(name="xyzzy")
|
|
|
|
for name, public in (('one', True), ('two', False), ('three', False)):
|
|
RestrictedModel.objects.create(name=name, is_public=public, related=related)
|
|
|
|
obj = RelatedModel.objects.get(name="xyzzy")
|
|
obj.delete()
|
|
|
|
# All of the RestrictedModel instances should have been
|
|
# deleted, since they *all* pointed to the RelatedModel. If
|
|
# the default manager is used, only the public one will be
|
|
# deleted.
|
|
self.assertEqual(len(RestrictedModel.plain_manager.all()), 0)
|
|
|
|
def test_delete_one_to_one_manager(self):
|
|
# The same test case as the last one, but for one-to-one
|
|
# models, which are implemented slightly different internally,
|
|
# so it's a different code path.
|
|
obj = RelatedModel.objects.create(name="xyzzy")
|
|
OneToOneRestrictedModel.objects.create(name="foo", is_public=False, related=obj)
|
|
obj = RelatedModel.objects.get(name="xyzzy")
|
|
obj.delete()
|
|
self.assertEqual(len(OneToOneRestrictedModel.plain_manager.all()), 0)
|