fix: correct dataclass transform ordering metadata (#4591)

Author: subham-hq

RELEASE.md

@@ -0,0 +1,17 @@
+---
+release type: patch
+social_messages:
+  x: >-
+    {project_name} {version} is out! This release fixes dataclass transform
+    metadata so custom ordering methods are correctly accepted by type checkers. 🍓
+    https://strawberry.rocks/release/{version}
+  linkedin: >-
+    {project_name} {version} is out. This release fixes dataclass transform
+    metadata so custom ordering methods are correctly accepted by type checkers.
+---
+
+This release fixes incorrect dataclass transform ordering metadata.
+
+Strawberry decorators now correctly declare that ordering methods are not generated
+by default, matching their runtime dataclass behavior and allowing custom ordering
+methods such as `__gt__` to be used without type-checking errors.

strawberry/federation/object_type.py

@@ -58,7 +58,7 @@ def _impl_type(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )
@@ -74,7 +74,7 @@ def type(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )
@@ -106,7 +106,7 @@ def type(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )
@@ -124,7 +124,7 @@ def input(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )
@@ -163,7 +163,7 @@ def input(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )
@@ -179,7 +179,7 @@ def interface(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )
@@ -212,7 +212,7 @@ def interface(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )
@@ -228,7 +228,7 @@ def interface_object(
 
 @overload
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(base_field, field, StrawberryField),
 )

strawberry/federation/schema_directive.py

@@ -24,7 +24,7 @@ class StrawberryFederationSchemaDirective(StrawberrySchemaDirective):
 
 
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(directive_field, field, StrawberryField),
 )

strawberry/schema_directive.py

@@ -41,7 +41,7 @@ class StrawberrySchemaDirective:
 
 
 @dataclass_transform(
-    order_default=True,
+    order_default=False,
     kw_only_default=True,
     field_specifiers=(directive_field, field, StrawberryField),
 )

strawberry/types/object_type.py

@@ -319,7 +319,7 @@ def _process_type(
 
 @overload
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def type(
     cls: T,
@@ -335,7 +335,7 @@ def type(
 
 @overload
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def type(
     *,
@@ -349,7 +349,7 @@ def type(
 
 
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def type(
     cls: T | None = None,
@@ -444,7 +444,7 @@ def wrap(cls: T) -> T:
 
 @overload
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def input(
     cls: T,
@@ -458,7 +458,7 @@ def input(
 
 @overload
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def input(
     *,
@@ -470,7 +470,7 @@ def input(
 
 
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def input(
     cls: T | None = None,
@@ -526,7 +526,7 @@ class MyUserInput:
 
 @overload
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def interface(
     cls: T,
@@ -539,7 +539,7 @@ def interface(
 
 @overload
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def interface(
     *,
@@ -550,7 +550,7 @@ def interface(
 
 
 @dataclass_transform(
-    order_default=True, kw_only_default=True, field_specifiers=(field, StrawberryField)
+    order_default=False, kw_only_default=True, field_specifiers=(field, StrawberryField)
 )
 def interface(
     cls: T | None = None,

tests/typecheckers/test_directives.py

@@ -58,3 +58,104 @@ def test():
             ),
         ]
     )
+
+
+def test_schema_directive_custom_ordering_method():
+    code = """
+from strawberry.schema_directive import Location, schema_directive
+
+
+@schema_directive(locations=[Location.OBJECT])
+class UserDirective:
+    name: str
+
+    def __gt__(self, other: "UserDirective") -> bool:
+        return self.name > other.name
+
+
+reveal_type(UserDirective)
+"""
+
+    results = typecheck(code)
+
+    assert results.pyright == snapshot(
+        [
+            Result(
+                type="information",
+                message='Type of "UserDirective" is "type[UserDirective]"',
+                line=13,
+                column=13,
+            )
+        ]
+    )
+    assert results.mypy == snapshot(
+        [
+            Result(
+                type="note",
+                message='Revealed type is "def (*, name: str) -> mypy_test.UserDirective"',
+                line=13,
+                column=13,
+            )
+        ]
+    )
+    assert results.ty == snapshot(
+        [
+            Result(
+                type="information",
+                message="Revealed type: `<class 'UserDirective'>`",
+                line=13,
+                column=13,
+            )
+        ]
+    )
+
+
+def test_federation_schema_directive_custom_ordering_method():
+    code = """
+from strawberry.federation.schema_directive import schema_directive
+from strawberry.schema_directive import Location
+
+
+@schema_directive(locations=[Location.OBJECT])
+class UserDirective:
+    name: str
+
+    def __gt__(self, other: "UserDirective") -> bool:
+        return self.name > other.name
+
+
+reveal_type(UserDirective)
+"""
+
+    results = typecheck(code)
+
+    assert results.pyright == snapshot(
+        [
+            Result(
+                type="information",
+                message='Type of "UserDirective" is "type[UserDirective]"',
+                line=14,
+                column=13,
+            )
+        ]
+    )
+    assert results.mypy == snapshot(
+        [
+            Result(
+                type="note",
+                message='Revealed type is "def (*, name: str) -> mypy_test.UserDirective"',
+                line=14,
+                column=13,
+            )
+        ]
+    )
+    assert results.ty == snapshot(
+        [
+            Result(
+                type="information",
+                message="Revealed type: `<class 'UserDirective'>`",
+                line=14,
+                column=13,
+            )
+        ]
+    )

tests/typecheckers/test_federation.py

@@ -352,3 +352,53 @@ def test_federation_scalar():
             )
         ]
     )
+
+
+def test_federation_custom_ordering_method():
+    code = """
+import strawberry
+
+
+@strawberry.federation.type
+class User:
+    name: str
+
+    def __gt__(self, other: "User") -> bool:
+        return self.name > other.name
+
+
+reveal_type(User)
+"""
+
+    results = typecheck(code)
+
+    assert results.pyright == snapshot(
+        [
+            Result(
+                type="information",
+                message='Type of "User" is "type[User]"',
+                line=13,
+                column=13,
+            )
+        ]
+    )
+    assert results.mypy == snapshot(
+        [
+            Result(
+                type="note",
+                message='Revealed type is "def (*, name: str) -> mypy_test.User"',
+                line=13,
+                column=13,
+            )
+        ]
+    )
+    assert results.ty == snapshot(
+        [
+            Result(
+                type="information",
+                message="Revealed type: `<class 'User'>`",
+                line=13,
+                column=13,
+            )
+        ]
+    )