fix: Don't return properties as parameters of dataclasses (again)

has2k1 · web-flow · commit 8c48397e7301 · 2024-03-11T14:01:32.000+01:00
This was fixed in 5a5c03b, but broken in 82a9d57. The tests broke as well and did not catch the regression. Issue-232: #232 PR-248: #248
diff --git a/src/griffe/extensions/dataclasses.py b/src/griffe/extensions/dataclasses.py
@@ -80,6 +80,10 @@ def _dataclass_parameters(class_: Class) -> list[Parameter]:
         if member.is_attribute:
             member = cast(Attribute, member)
 
+            # Exclude @property and @cached_property attributes
+            if "property" in member.labels:
+                continue
+
             # Start of keyword-only parameters.
             if isinstance(member.annotation, Expr) and member.annotation.canonical_path == "dataclasses.KW_ONLY":
                 kw_only = True
diff --git a/tests/test_dataclasses.py b/tests/test_dataclasses.py
@@ -10,7 +10,7 @@
 import griffe
 from griffe.dataclasses import Docstring, Module
 from griffe.loader import GriffeLoader
-from griffe.tests import module_vtree, temporary_pypackage, temporary_visited_module, temporary_visited_package
+from griffe.tests import module_vtree, temporary_pypackage, temporary_visited_package
 
 
 def test_submodule_exports() -> None:
@@ -93,8 +93,7 @@ def test_alias_proxies() -> None:
 
 def test_dataclass_properties() -> None:
     """Don't return properties as parameters of dataclasses."""
-    with temporary_visited_module(
-        """
+    code = """
         from dataclasses import dataclass
         from functools import cached_property
 
@@ -110,11 +109,10 @@ def a(self):
             @cached_property
             def b(self):
                 return 0
-        """,
-    ) as module:
+    """
+    with temporary_visited_package("package", {"__init__.py": code}) as module:
         params = module["Point"].parameters
-        assert "a" not in params
-        assert "b" not in params
+        assert [p.name for p in params] == ["self", "x", "y"]
 
 
 @pytest.mark.parametrize(
