#36051: Count CompositePrimaryKey field targets toward function arity check
-------------------------------------+-------------------------------------
Reporter: Jacob | Owner: Jacob Walls
Walls |
Type: New | Status: assigned
feature |
Component: Database | Version: dev
layer (models, ORM) |
Severity: Normal | Keywords:
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
Calling a database function with an incorrect number of arguments raises
`TypeError` if the function declares its
[https://docs.djangoproject.com/en/5.1/ref/models/expressions/#django.db.models.Func.arity
arity]. We could improve the DX around CompositePrimaryKey by leveraging
this feature, instead of just
[https://github.com/django/django/blob/8d9901c961bf9d5cfa6bddddbbcebfbf487a5125/docs/topics
/composite-primary-key.txt#L150 advising] to be careful.
The docs sort of imply some kind of error is raised ("# ERROR"), but this
test passes:
{{{#!diff
diff --git a/tests/composite_pk/test_aggregate.py
b/tests/composite_pk/test_aggregate.py
index b5474c5218..750618a277 100644
--- a/tests/composite_pk/test_aggregate.py
+++ b/tests/composite_pk/test_aggregate.py
@@ -1,5 +1,5 @@
from django.db import NotSupportedError
-from django.db.models import Count, Q
+from django.db.models import Count, Max, Q
from django.test import TestCase
from .models import Comment, Tenant, User
@@ -32,6 +32,10 @@ class CompositePKAggregateTests(TestCase):
cls.comment_5 = Comment.objects.create(id=5, user=cls.user_3,
text="barbaz")
cls.comment_6 = Comment.objects.create(id=6, user=cls.user_3,
text="baz")
+ def test_max_pk(self):
+ # Could raise TypeError instead.
+ self.assertEqual(Comment.objects.aggregate(Max("pk")),
{'pk__max': 1})
+
def test_users_annotated_with_comments_id_count(self):
user_1, user_2, user_3 =
User.objects.annotate(Count("comments__id")).order_by(
"pk"
}}}
Relatedly, most of the built-in aggregate functions should set `arity=1`,
which I'll include in a separate commit, but we can also discuss whether
that needs to go through a deprecation path.
--
Ticket URL: <https://code.djangoproject.com/ticket/36051>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/0107019423788272-3caaf20f-4524-4843-94bf-54cfaa52ac08-000000%40eu-central-1.amazonses.com.
