Merge branch 'main' of github.com:mkdocstrings/griffe

Author: pawamoy

src/griffe/extensions/dataclasses.py

@@ -80,6 +80,10 @@ def _dataclass_parameters(class_: Class) -> list[Parameter]:
         if member.is_attribute:
             member = cast(Attribute, member)
 
+            # All dataclass parameters have annotations
+            if member.annotation is None:
+                continue
+
             # Attributes that have labels for these characteristics are
             # not class parameters:
             #   - @property

src/griffe/finder.py

@@ -439,8 +439,15 @@ def _handle_pth_file(path: Path) -> list[_SP]:
     # No item is added to sys.path more than once.
     # Blank lines and lines beginning with # are skipped.
     # Lines starting with import (followed by space or tab) are executed.
-    directories = []
-    for line in path.read_text(encoding="utf8").strip().replace(";", "\n").splitlines(keepends=False):
+    directories: list[_SP] = []
+    try:
+        # It turns out PyTorch recommends its users to use `.pth` as the extension
+        # when saving models on the disk. These model files are not encoded in UTF8.
+        # If UTF8 decoding fails, we skip the .pth file.
+        text = path.read_text(encoding="utf8")
+    except UnicodeDecodeError:
+        return directories
+    for line in text.strip().replace(";", "\n").splitlines(keepends=False):
         line = line.strip()  # noqa: PLW2901
         if _re_import_line.match(line):
             editable_module = path.parent / f"{line[len('import'):].lstrip()}.py"

tests/test_dataclasses.py

@@ -421,3 +421,27 @@ class Derived(Base):
         assert param_b.docstring.value == "Parameter b"
         assert param_c.docstring is None
         assert param_d.docstring.value == "Parameter d"
+
+
+def test_attributes_that_have_no_annotations() -> None:
+    """Dataclass attributes that have no annotatations are not parameters."""
+    code = """
+        from dataclasses import dataclass, field
+
+        @dataclass
+        class Base:
+            a: int
+            b: str = field(init=False)
+            c = 3  # class attribute
+
+        @dataclass
+        class Derived(Base):
+            a = 1  # no effect on the parameter status of a
+            b = "b"  # inherited non-parameter
+            d: float = 4
+    """
+    with temporary_visited_package("package", {"__init__.py": code}) as module:
+        base_params = [p.name for p in module["Base"].parameters]
+        derived_params = [p.name for p in module["Derived"].parameters]
+        assert base_params == ["self", "a"]
+        assert derived_params == ["self", "a", "d"]