mirror of
https://github.com/django/django.git
synced 2025-10-09 14:59:24 +00:00
b3bb7230e1
This allows the proper resolving of lookups when performing constraint validation involving Q and Case objects. Thanks Andrew Roberts for the report and Sarah for the tests and review. Backport of 079d31e698fa08dd92e2bc4f3fe9b4817a214419 from main.
394 lines
13 KiB
Python
394 lines
13 KiB
Python
from datetime import datetime
|
|
|
|
from django.core.exceptions import FieldError
|
|
from django.db import connection
|
|
from django.db.models import (
|
|
BooleanField,
|
|
Exists,
|
|
ExpressionWrapper,
|
|
F,
|
|
OuterRef,
|
|
Q,
|
|
Value,
|
|
)
|
|
from django.db.models.expressions import NegatedExpression, RawSQL
|
|
from django.db.models.functions import ExtractDay, Lower, TruncDate
|
|
from django.db.models.lookups import (
|
|
Exact,
|
|
IntegerFieldExact,
|
|
IntegerLessThanOrEqual,
|
|
IsNull,
|
|
)
|
|
from django.db.models.sql.where import NothingNode
|
|
from django.test import SimpleTestCase, TestCase
|
|
|
|
from .models import Tag
|
|
|
|
|
|
class QTests(SimpleTestCase):
|
|
def test_combine_and_empty(self):
|
|
q = Q(x=1)
|
|
self.assertEqual(q & Q(), q)
|
|
self.assertEqual(Q() & q, q)
|
|
|
|
q = Q(x__in={}.keys())
|
|
self.assertEqual(q & Q(), q)
|
|
self.assertEqual(Q() & q, q)
|
|
|
|
def test_combine_and_both_empty(self):
|
|
self.assertEqual(Q() & Q(), Q())
|
|
|
|
def test_combine_or_empty(self):
|
|
q = Q(x=1)
|
|
self.assertEqual(q | Q(), q)
|
|
self.assertEqual(Q() | q, q)
|
|
|
|
q = Q(x__in={}.keys())
|
|
self.assertEqual(q | Q(), q)
|
|
self.assertEqual(Q() | q, q)
|
|
|
|
def test_combine_xor_empty(self):
|
|
q = Q(x=1)
|
|
self.assertEqual(q ^ Q(), q)
|
|
self.assertEqual(Q() ^ q, q)
|
|
|
|
q = Q(x__in={}.keys())
|
|
self.assertEqual(q ^ Q(), q)
|
|
self.assertEqual(Q() ^ q, q)
|
|
|
|
def test_combine_empty_copy(self):
|
|
base_q = Q(x=1)
|
|
tests = [
|
|
base_q | Q(),
|
|
Q() | base_q,
|
|
base_q & Q(),
|
|
Q() & base_q,
|
|
base_q ^ Q(),
|
|
Q() ^ base_q,
|
|
]
|
|
for i, q in enumerate(tests):
|
|
with self.subTest(i=i):
|
|
self.assertEqual(q, base_q)
|
|
self.assertIsNot(q, base_q)
|
|
|
|
def test_combine_or_both_empty(self):
|
|
self.assertEqual(Q() | Q(), Q())
|
|
|
|
def test_combine_xor_both_empty(self):
|
|
self.assertEqual(Q() ^ Q(), Q())
|
|
|
|
def test_combine_not_q_object(self):
|
|
obj = object()
|
|
q = Q(x=1)
|
|
with self.assertRaisesMessage(TypeError, str(obj)):
|
|
q | obj
|
|
with self.assertRaisesMessage(TypeError, str(obj)):
|
|
q & obj
|
|
with self.assertRaisesMessage(TypeError, str(obj)):
|
|
q ^ obj
|
|
|
|
def test_combine_negated_boolean_expression(self):
|
|
tagged = Tag.objects.filter(category=OuterRef("pk"))
|
|
tests = [
|
|
Q() & ~Exists(tagged),
|
|
Q() | ~Exists(tagged),
|
|
Q() ^ ~Exists(tagged),
|
|
]
|
|
for q in tests:
|
|
with self.subTest(q=q):
|
|
self.assertIsInstance(q, NegatedExpression)
|
|
|
|
def test_deconstruct(self):
|
|
q = Q(price__gt=F("discounted_price"))
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(path, "django.db.models.Q")
|
|
self.assertEqual(args, (("price__gt", F("discounted_price")),))
|
|
self.assertEqual(kwargs, {})
|
|
|
|
def test_deconstruct_negated(self):
|
|
q = ~Q(price__gt=F("discounted_price"))
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(args, (("price__gt", F("discounted_price")),))
|
|
self.assertEqual(kwargs, {"_negated": True})
|
|
|
|
def test_deconstruct_or(self):
|
|
q1 = Q(price__gt=F("discounted_price"))
|
|
q2 = Q(price=F("discounted_price"))
|
|
q = q1 | q2
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(
|
|
args,
|
|
(
|
|
("price__gt", F("discounted_price")),
|
|
("price", F("discounted_price")),
|
|
),
|
|
)
|
|
self.assertEqual(kwargs, {"_connector": Q.OR})
|
|
|
|
def test_deconstruct_xor(self):
|
|
q1 = Q(price__gt=F("discounted_price"))
|
|
q2 = Q(price=F("discounted_price"))
|
|
q = q1 ^ q2
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(
|
|
args,
|
|
(
|
|
("price__gt", F("discounted_price")),
|
|
("price", F("discounted_price")),
|
|
),
|
|
)
|
|
self.assertEqual(kwargs, {"_connector": Q.XOR})
|
|
|
|
def test_deconstruct_and(self):
|
|
q1 = Q(price__gt=F("discounted_price"))
|
|
q2 = Q(price=F("discounted_price"))
|
|
q = q1 & q2
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(
|
|
args,
|
|
(
|
|
("price__gt", F("discounted_price")),
|
|
("price", F("discounted_price")),
|
|
),
|
|
)
|
|
self.assertEqual(kwargs, {})
|
|
|
|
def test_deconstruct_multiple_kwargs(self):
|
|
q = Q(price__gt=F("discounted_price"), price=F("discounted_price"))
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(
|
|
args,
|
|
(
|
|
("price", F("discounted_price")),
|
|
("price__gt", F("discounted_price")),
|
|
),
|
|
)
|
|
self.assertEqual(kwargs, {})
|
|
|
|
def test_deconstruct_nested(self):
|
|
q = Q(Q(price__gt=F("discounted_price")))
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(args, (Q(price__gt=F("discounted_price")),))
|
|
self.assertEqual(kwargs, {})
|
|
|
|
def test_deconstruct_boolean_expression(self):
|
|
expr = RawSQL("1 = 1", BooleanField())
|
|
q = Q(expr)
|
|
_, args, kwargs = q.deconstruct()
|
|
self.assertEqual(args, (expr,))
|
|
self.assertEqual(kwargs, {})
|
|
|
|
def test_reconstruct(self):
|
|
q = Q(price__gt=F("discounted_price"))
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(Q(*args, **kwargs), q)
|
|
|
|
def test_reconstruct_negated(self):
|
|
q = ~Q(price__gt=F("discounted_price"))
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(Q(*args, **kwargs), q)
|
|
|
|
def test_reconstruct_or(self):
|
|
q1 = Q(price__gt=F("discounted_price"))
|
|
q2 = Q(price=F("discounted_price"))
|
|
q = q1 | q2
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(Q(*args, **kwargs), q)
|
|
|
|
def test_reconstruct_xor(self):
|
|
q1 = Q(price__gt=F("discounted_price"))
|
|
q2 = Q(price=F("discounted_price"))
|
|
q = q1 ^ q2
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(Q(*args, **kwargs), q)
|
|
|
|
def test_reconstruct_and(self):
|
|
q1 = Q(price__gt=F("discounted_price"))
|
|
q2 = Q(price=F("discounted_price"))
|
|
q = q1 & q2
|
|
path, args, kwargs = q.deconstruct()
|
|
self.assertEqual(Q(*args, **kwargs), q)
|
|
|
|
def test_equal(self):
|
|
self.assertEqual(Q(), Q())
|
|
self.assertEqual(
|
|
Q(("pk__in", (1, 2))),
|
|
Q(("pk__in", [1, 2])),
|
|
)
|
|
self.assertEqual(
|
|
Q(("pk__in", (1, 2))),
|
|
Q(pk__in=[1, 2]),
|
|
)
|
|
self.assertEqual(
|
|
Q(("pk__in", (1, 2))),
|
|
Q(("pk__in", {1: "first", 2: "second"}.keys())),
|
|
)
|
|
self.assertNotEqual(
|
|
Q(name__iexact=F("other_name")),
|
|
Q(name=Lower(F("other_name"))),
|
|
)
|
|
|
|
def test_hash(self):
|
|
self.assertEqual(hash(Q()), hash(Q()))
|
|
self.assertEqual(
|
|
hash(Q(("pk__in", (1, 2)))),
|
|
hash(Q(("pk__in", [1, 2]))),
|
|
)
|
|
self.assertEqual(
|
|
hash(Q(("pk__in", (1, 2)))),
|
|
hash(Q(pk__in=[1, 2])),
|
|
)
|
|
self.assertEqual(
|
|
hash(Q(("pk__in", (1, 2)))),
|
|
hash(Q(("pk__in", {1: "first", 2: "second"}.keys()))),
|
|
)
|
|
self.assertNotEqual(
|
|
hash(Q(name__iexact=F("other_name"))),
|
|
hash(Q(name=Lower(F("other_name")))),
|
|
)
|
|
|
|
def test_flatten(self):
|
|
q = Q()
|
|
self.assertEqual(list(q.flatten()), [q])
|
|
q = Q(NothingNode())
|
|
self.assertEqual(list(q.flatten()), [q, q.children[0]])
|
|
q = Q(
|
|
ExpressionWrapper(
|
|
Q(RawSQL("id = 0", params=(), output_field=BooleanField()))
|
|
| Q(price=Value("4.55"))
|
|
| Q(name=Lower("category")),
|
|
output_field=BooleanField(),
|
|
)
|
|
)
|
|
flatten = list(q.flatten())
|
|
self.assertEqual(len(flatten), 7)
|
|
|
|
def test_create_helper(self):
|
|
items = [("a", 1), ("b", 2), ("c", 3)]
|
|
for connector in [Q.AND, Q.OR, Q.XOR]:
|
|
with self.subTest(connector=connector):
|
|
self.assertEqual(
|
|
Q.create(items, connector=connector),
|
|
Q(*items, _connector=connector),
|
|
)
|
|
|
|
def test_referenced_base_fields(self):
|
|
# Make sure Q.referenced_base_fields retrieves all base fields from
|
|
# both filters and F expressions.
|
|
tests = [
|
|
(Q(field_1=1) & Q(field_2=1), {"field_1", "field_2"}),
|
|
(
|
|
Q(Exact(F("field_3"), IsNull(F("field_4"), True))),
|
|
{"field_3", "field_4"},
|
|
),
|
|
(Q(Exact(Q(field_5=F("field_6")), True)), {"field_5", "field_6"}),
|
|
(Q(field_2=1), {"field_2"}),
|
|
(Q(field_7__lookup=True), {"field_7"}),
|
|
(Q(field_7__joined_field__lookup=True), {"field_7"}),
|
|
]
|
|
combined_q = Q(1)
|
|
combined_q_base_fields = set()
|
|
for q, expected_base_fields in tests:
|
|
combined_q &= q
|
|
combined_q_base_fields |= expected_base_fields
|
|
tests.append((combined_q, combined_q_base_fields))
|
|
for q, expected_base_fields in tests:
|
|
with self.subTest(q=q):
|
|
self.assertEqual(
|
|
q.referenced_base_fields,
|
|
expected_base_fields,
|
|
)
|
|
|
|
def test_replace_expressions(self):
|
|
replacements = {F("timestamp"): Value(None)}
|
|
self.assertEqual(
|
|
Q(timestamp__date__day=25).replace_expressions(replacements),
|
|
Q(timestamp__date__day=25),
|
|
)
|
|
replacements = {F("timestamp"): Value(datetime(2025, 10, 23))}
|
|
self.assertEqual(
|
|
Q(timestamp__date__day=13).replace_expressions(replacements),
|
|
Q(
|
|
IntegerFieldExact(
|
|
ExtractDay(TruncDate(Value(datetime(2025, 10, 23)))),
|
|
13,
|
|
)
|
|
),
|
|
)
|
|
self.assertEqual(
|
|
Q(timestamp__date__day__lte=25).replace_expressions(replacements),
|
|
Q(
|
|
IntegerLessThanOrEqual(
|
|
ExtractDay(TruncDate(Value(datetime(2025, 10, 23)))),
|
|
25,
|
|
)
|
|
),
|
|
)
|
|
self.assertEqual(
|
|
(
|
|
Q(Q(timestamp__date__day__lte=25), timestamp__date__day=13)
|
|
).replace_expressions(replacements),
|
|
(
|
|
Q(
|
|
Q(
|
|
IntegerLessThanOrEqual(
|
|
ExtractDay(TruncDate(Value(datetime(2025, 10, 23)))),
|
|
25,
|
|
)
|
|
),
|
|
IntegerFieldExact(
|
|
ExtractDay(TruncDate(Value(datetime(2025, 10, 23)))),
|
|
13,
|
|
),
|
|
)
|
|
),
|
|
)
|
|
self.assertEqual(
|
|
Q(timestamp=None).replace_expressions(replacements),
|
|
Q(IsNull(Value(datetime(2025, 10, 23)), True)),
|
|
)
|
|
self.assertEqual(
|
|
Q(timestamp__date__day__invalid=25).replace_expressions(replacements),
|
|
Q(timestamp__date__day__invalid=25),
|
|
)
|
|
|
|
|
|
class QCheckTests(TestCase):
|
|
def test_basic(self):
|
|
q = Q(price__gt=20)
|
|
self.assertIs(q.check({"price": 30}), True)
|
|
self.assertIs(q.check({"price": 10}), False)
|
|
|
|
def test_expression(self):
|
|
q = Q(name="test")
|
|
self.assertIs(q.check({"name": Lower(Value("TeSt"))}), True)
|
|
self.assertIs(q.check({"name": Value("other")}), False)
|
|
|
|
def test_missing_field(self):
|
|
q = Q(description__startswith="prefix")
|
|
msg = "Cannot resolve keyword 'description' into field."
|
|
with self.assertRaisesMessage(FieldError, msg):
|
|
q.check({"name": "test"})
|
|
|
|
def test_boolean_expression(self):
|
|
q = Q(ExpressionWrapper(Q(price__gt=20), output_field=BooleanField()))
|
|
self.assertIs(q.check({"price": 25}), True)
|
|
self.assertIs(q.check({"price": Value(10)}), False)
|
|
|
|
def test_rawsql(self):
|
|
"""
|
|
RawSQL expressions cause a database error because "price" cannot be
|
|
replaced by its value. In this case, Q.check() logs a warning and
|
|
return True.
|
|
"""
|
|
q = Q(RawSQL("price > %s", params=(20,), output_field=BooleanField()))
|
|
with self.assertLogs("django.db.models", "WARNING") as cm:
|
|
self.assertIs(q.check({"price": 10}), True)
|
|
self.assertIn(
|
|
f"Got a database error calling check() on {q!r}: ",
|
|
cm.records[0].getMessage(),
|
|
)
|
|
|
|
# We must leave the connection in a usable state (#35712).
|
|
self.assertTrue(connection.is_usable())
|