Declare arity on aggregate functions

[Jacob Walls]

Calling a database function with an incorrect number of arguments raises TypeError if the function declares its ​arity. We could improve the DX around CompositePrimaryKey by leveraging this feature, instead of just ​advising to be careful.

The docs sort of imply some kind of error is raised ("# ERROR"), but this test passes:

tests/composite_pk/test_aggregate.py

@@ -1 +1 @@
 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 +32 @@
         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.

[Jacob Walls]

​PR

[Simon Charette]

I understand the desire to streamline the composite primary key reference experience but this approach just seems plain wrong. Function arity is tied to the number of argument passed to a function and Max(F("pk")) is a single argument where the argument itself is composite.

In other words, there is a difference between calls of the form foo(1, 2) and foo((1,2)) (or foo(bar) where bar: int | tuple[int, int] since F is a reference) and trying to automatically turn one into the other seems like it's going to cause more harm than good.

To me #36042 and and this ticket should be addressed by introducing a BaseExpression.allows_composite_expressions: bool = False that we set to True on Count and TupleLookupMixin and make BaseExpression.resolve_expression raise a ValueError when it's set to False and any of its source expression is an instance of ColPairs.

Don't get me wrong I think we should define arity for Aggregate subclasses to guard against improper calls but I don't think that making Func.resolve_expression unpack composite expressions is something we should do for the aforementioned reasons.

[Jacob Walls]

Super helpful. I'll update #36042 to do as you describe here, and then we can refocus this ticket on adding arity checks to aggregates, since it sounds like we have consensus on that (and that doesn't have to land in 5.2).

In other words, there is a difference between calls of the form foo(1, 2) and foo((1,2))

but I don't think that making Func.resolve_expression unpack composite expressions to trigger arity check failures is something we should do

Certainly there is a difference between those two calls, but on the main branch the unpacking was already happening, i.e. Max(F("pk")) already compiles to Max(col1, col2), not Max((col1, col2)), which is why I thought adding arity checking wasn't a big deal here. But if the solve for #36042 is going to be to lock down resolve_expression() for all but Count and TupleLookupMixin, then F("pk") won't even be allowed here.

Thanks for letting me kick the tires (this is helping me get more comfortable with the ORM internals!)

[Simon Charette]

Super helpful. I'll update #36042 to do as you describe here, and then we can refocus this ticket on adding arity checks to aggregates, since it sounds like we have consensus on that (and that doesn't have to land in 5.2).

That makes sense!

Certainly there is a difference between those two calls, but on the main branch the unpacking was already happening, i.e. Max(F("pk")) already compiles to Max(col1, col2), not Max((col1, col2))

Max("pk") (we can drop the explicit F) compiles to MAX(col1, col2) at the SQL level due to the quirky way ColPairs.as_sql is implemented to support SELECT and GROUP BY references on backends that don't have native ROW / tuple support but it resolves to Max(ColPairs("col1", "col2")) which is a distinction that makes me believe we should not use arity and unpacking for this purpose.

Thanks for letting me kick the tires (this is helping me get more comfortable with the ORM internals!)

Happy my feedback is useful, thanks for your time spent making the composite primary key usage experience better. The current awkwardness around ColPairs.as_sql and Tuple will vanish once we have proper support for composite fields but there might be a way to simplify things before that by getting rid of the the hacky way SELECT and GROUP BY deal with ColPairs compilation. I'll see if I can get something working tomorrow.

[Sarah Boyce <42296566+sarahboyce@…>]

In d206d4c:

Fixed #36051 -- Declared arity on aggregate functions.

Follow-up to 4a66a69239c493c05b322815b18c605cd4c96e7c.