2021-11-22 19:30:07 +00:00
|
|
|
from django.db.models import Q
|
2010-09-12 20:04:21 +00:00
|
|
|
from django.http import Http404
|
2015-01-28 12:35:27 +00:00
|
|
|
from django.shortcuts import get_list_or_404, get_object_or_404
|
2010-09-12 20:04:21 +00:00
|
|
|
from django.test import TestCase
|
|
|
|
|
2015-01-28 12:35:27 +00:00
|
|
|
from .models import Article, Author
|
2010-09-12 20:04:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
class GetObjectOr404Tests(TestCase):
|
|
|
|
def test_get_object_or_404(self):
|
|
|
|
a1 = Author.objects.create(name="Brave Sir Robin")
|
|
|
|
a2 = Author.objects.create(name="Patsy")
|
|
|
|
|
2021-10-18 16:06:00 +00:00
|
|
|
# No Articles yet, so we should get an Http404 error.
|
2016-01-17 11:26:39 +00:00
|
|
|
with self.assertRaises(Http404):
|
|
|
|
get_object_or_404(Article, title="Foo")
|
2010-09-12 20:04:21 +00:00
|
|
|
|
|
|
|
article = Article.objects.create(title="Run away!")
|
2015-10-08 21:17:10 +00:00
|
|
|
article.authors.set([a1, a2])
|
2010-09-12 20:04:21 +00:00
|
|
|
# get_object_or_404 can be passed a Model to query.
|
|
|
|
self.assertEqual(
|
|
|
|
get_object_or_404(Article, title__contains="Run"),
|
|
|
|
article
|
|
|
|
)
|
|
|
|
|
|
|
|
# We can also use the Article manager through an Author object.
|
|
|
|
self.assertEqual(
|
|
|
|
get_object_or_404(a1.article_set, title__contains="Run"),
|
|
|
|
article
|
|
|
|
)
|
|
|
|
|
2021-10-18 16:06:00 +00:00
|
|
|
# No articles containing "Camelot". This should raise an Http404 error.
|
2016-01-17 11:26:39 +00:00
|
|
|
with self.assertRaises(Http404):
|
|
|
|
get_object_or_404(a1.article_set, title__contains="Camelot")
|
2010-09-12 20:04:21 +00:00
|
|
|
|
|
|
|
# Custom managers can be used too.
|
|
|
|
self.assertEqual(
|
|
|
|
get_object_or_404(Article.by_a_sir, title="Run away!"),
|
|
|
|
article
|
|
|
|
)
|
|
|
|
|
|
|
|
# QuerySets can be used too.
|
|
|
|
self.assertEqual(
|
|
|
|
get_object_or_404(Article.objects.all(), title__contains="Run"),
|
|
|
|
article
|
|
|
|
)
|
|
|
|
|
|
|
|
# Just as when using a get() lookup, you will get an error if more than
|
|
|
|
# one object is returned.
|
|
|
|
|
2016-01-17 11:26:39 +00:00
|
|
|
with self.assertRaises(Author.MultipleObjectsReturned):
|
|
|
|
get_object_or_404(Author.objects.all())
|
2010-09-12 20:04:21 +00:00
|
|
|
|
2021-10-18 16:06:00 +00:00
|
|
|
# Using an empty QuerySet raises an Http404 error.
|
2016-01-17 11:26:39 +00:00
|
|
|
with self.assertRaises(Http404):
|
|
|
|
get_object_or_404(Article.objects.none(), title__contains="Run")
|
2010-09-12 20:04:21 +00:00
|
|
|
|
|
|
|
# get_list_or_404 can be used to get lists of objects
|
|
|
|
self.assertEqual(
|
|
|
|
get_list_or_404(a1.article_set, title__icontains="Run"),
|
|
|
|
[article]
|
|
|
|
)
|
|
|
|
|
|
|
|
# Http404 is returned if the list is empty.
|
2016-01-17 11:26:39 +00:00
|
|
|
with self.assertRaises(Http404):
|
|
|
|
get_list_or_404(a1.article_set, title__icontains="Shrubbery")
|
2010-09-12 20:04:21 +00:00
|
|
|
|
|
|
|
# Custom managers can be used too.
|
|
|
|
self.assertEqual(
|
|
|
|
get_list_or_404(Article.by_a_sir, title__icontains="Run"),
|
|
|
|
[article]
|
|
|
|
)
|
|
|
|
|
|
|
|
# QuerySets can be used too.
|
|
|
|
self.assertEqual(
|
|
|
|
get_list_or_404(Article.objects.all(), title__icontains="Run"),
|
|
|
|
[article]
|
|
|
|
)
|
2021-11-22 19:30:07 +00:00
|
|
|
# Q objects.
|
|
|
|
self.assertEqual(
|
|
|
|
get_object_or_404(
|
|
|
|
Article,
|
|
|
|
Q(title__startswith='Run') | Q(title__startswith='Walk'),
|
|
|
|
authors__name__contains='Brave',
|
|
|
|
),
|
|
|
|
article,
|
|
|
|
)
|
|
|
|
self.assertEqual(
|
|
|
|
get_list_or_404(
|
|
|
|
Article,
|
|
|
|
Q(title__startswith='Run') | Q(title__startswith='Walk'),
|
|
|
|
authors__name='Patsy',
|
|
|
|
),
|
|
|
|
[article],
|
|
|
|
)
|
2012-12-12 19:34:59 +00:00
|
|
|
|
|
|
|
def test_bad_class(self):
|
|
|
|
# Given an argument klass that is not a Model, Manager, or Queryset
|
|
|
|
# raises a helpful ValueError message
|
2016-03-27 20:35:57 +00:00
|
|
|
msg = "First argument to get_object_or_404() must be a Model, Manager, or QuerySet, not 'str'."
|
2016-01-04 08:50:08 +00:00
|
|
|
with self.assertRaisesMessage(ValueError, msg):
|
2017-01-20 09:20:53 +00:00
|
|
|
get_object_or_404("Article", title__icontains="Run")
|
2012-12-12 19:34:59 +00:00
|
|
|
|
2017-01-19 07:39:46 +00:00
|
|
|
class CustomClass:
|
2012-12-12 19:34:59 +00:00
|
|
|
pass
|
|
|
|
|
2016-03-27 20:35:57 +00:00
|
|
|
msg = "First argument to get_object_or_404() must be a Model, Manager, or QuerySet, not 'CustomClass'."
|
2016-01-04 08:50:08 +00:00
|
|
|
with self.assertRaisesMessage(ValueError, msg):
|
|
|
|
get_object_or_404(CustomClass, title__icontains="Run")
|
2012-12-12 19:34:59 +00:00
|
|
|
|
|
|
|
# Works for lists too
|
2016-03-27 20:35:57 +00:00
|
|
|
msg = "First argument to get_list_or_404() must be a Model, Manager, or QuerySet, not 'list'."
|
2016-01-04 08:50:08 +00:00
|
|
|
with self.assertRaisesMessage(ValueError, msg):
|
|
|
|
get_list_or_404([Article], title__icontains="Run")
|
2018-02-17 08:27:46 +00:00
|
|
|
|
|
|
|
def test_get_object_or_404_queryset_attribute_error(self):
|
|
|
|
"""AttributeError raised by QuerySet.get() isn't hidden."""
|
|
|
|
with self.assertRaisesMessage(AttributeError, 'AttributeErrorManager'):
|
|
|
|
get_object_or_404(Article.attribute_error_objects, id=42)
|
|
|
|
|
|
|
|
def test_get_list_or_404_queryset_attribute_error(self):
|
|
|
|
"""AttributeError raised by QuerySet.filter() isn't hidden."""
|
|
|
|
with self.assertRaisesMessage(AttributeError, 'AttributeErrorManager'):
|
|
|
|
get_list_or_404(Article.attribute_error_objects, title__icontains='Run')
|