fix: Don't return properties as parameters of dataclasses

pawamoy · pawamoy · commit 5a5c03b38366 · 2024-02-08T16:16:26.000+01:00
Issue #232: #232
diff --git a/src/griffe/dataclasses.py b/src/griffe/dataclasses.py
@@ -1566,6 +1566,7 @@ def parameters(self) -> Parameters:
                     *[
                         Parameter(attr.name, annotation=attr.annotation, default=attr.value)
                         for attr in self.attributes.values()
+                        if "property" not in attr.labels
                     ],
                 )
             return Parameters()
diff --git a/tests/test_dataclasses.py b/tests/test_dataclasses.py
@@ -7,7 +7,7 @@
 import griffe
 from griffe.dataclasses import Docstring, Module
 from griffe.loader import GriffeLoader
-from griffe.tests import module_vtree, temporary_pypackage
+from griffe.tests import module_vtree, temporary_pypackage, temporary_visited_module
 
 
 def test_submodule_exports() -> None:
@@ -86,3 +86,29 @@ def test_alias_proxies() -> None:
         for name in cls.all_members:
             if not name.startswith("_") or name.startswith("__"):
                 assert name in alias_members
+
+
+def test_dataclass_parameters() -> None:
+    """Don't return properties as parameters of dataclasses."""
+    with temporary_visited_module(
+        """
+        from dataclasses import dataclass
+        from functools import cached_property
+
+        @dataclass
+        class Point:
+            x: float
+            y: float
+
+            @property
+            def a(self):
+                return 0
+
+            @cached_property
+            def b(self):
+                return 0
+        """,
+    ) as module:
+        params = module["Point"].parameters
+        assert "a" not in params
+        assert "b" not in params

Original file line number	Diff line number	Diff line change
`@@ -1566,6 +1566,7 @@ def parameters(self) -> Parameters:`
`1566`	`1566`	`*[`
`1567`	`1567`	`Parameter(attr.name, annotation=attr.annotation, default=attr.value)`
`1568`	`1568`	`for attr in self.attributes.values()`
	`1569`	`+ if "property" not in attr.labels`
`1569`	`1570`	`],`
`1570`	`1571`	`)`
`1571`	`1572`	`return Parameters()`