ci: Lint

Author: pawamoy

config/ruff.toml

@@ -26,6 +26,7 @@ ignore = [
     "PLR0913",  # Too many arguments to function call
     "PLR0915",  # Too many statements
     "SLF001", # Private member accessed
+    "TD001",  # Invalid TODO tag "FIXME"
     "TD002",  # Missing author in TODO
     "TD003",  # Missing issue link for TODO
     "TRY003",  # Avoid specifying long messages outside the exception class

src/griffe_typingdoc/_internal/extension.py

@@ -29,11 +29,12 @@ def _handle_attribute(self, attr: Attribute, /, *, node: ObjectNode | None = Non
 
         module = dynamic if node else static
 
+        kwargs = {"node": node} if node else {}
         new_sections = (
-            docstring := module._attribute_docs(attr, node=node),
-            deprecated_section := module._deprecated_docs(attr, node=node),
-            raises_section := module._raises_docs(attr, node=node),
-            warns_section := module._warns_docs(attr, node=node),
+            docstring := module._attribute_docs(attr, **kwargs),
+            deprecated_section := module._deprecated_docs(attr, **kwargs),
+            raises_section := module._raises_docs(attr, **kwargs),
+            warns_section := module._warns_docs(attr, **kwargs),
         )
 
         if not any(new_sections):
@@ -60,15 +61,16 @@ def _handle_function(self, func: Function, /, *, node: ObjectNode | None = None)
 
         module = dynamic if node else static
 
+        kwargs = {"node": node} if node else {}
         new_sections = (
-            deprecated_section := module._deprecated_docs(func, node=node),
-            params_section := module._parameters_docs(func, node=node),
-            other_params_section := module._other_parameters_docs(func, node=node),
-            warns_section := module._warns_docs(func, node=node),
-            raises_section := module._raises_docs(func, node=node),
-            yields_section := module._yields_docs(func, node=node),
-            receives_section := module._receives_docs(func, node=node),
-            returns_section := module._returns_docs(func, node=node),
+            deprecated_section := module._deprecated_docs(func, **kwargs),
+            params_section := module._parameters_docs(func, **kwargs),
+            other_params_section := module._other_parameters_docs(func, **kwargs),
+            warns_section := module._warns_docs(func, **kwargs),
+            raises_section := module._raises_docs(func, **kwargs),
+            yields_section := module._yields_docs(func, **kwargs),
+            receives_section := module._receives_docs(func, **kwargs),
+            returns_section := module._returns_docs(func, **kwargs),
         )
 
         if not any(new_sections):
@@ -110,9 +112,9 @@ def _handle_object(self, obj: Object | Alias) -> None:
             for member in obj.members.values():
                 self._handle_object(member)
         elif obj.is_function:
-            self._handle_function(obj)  # type: ignore[arg-type]
+            self._handle_function(obj)  # ty:ignore[invalid-argument-type]
         elif obj.is_attribute:
-            self._handle_attribute(obj)  # type: ignore[arg-type]
+            self._handle_attribute(obj)  # ty:ignore[invalid-argument-type]
 
     def on_package(
         self,

src/griffe_typingdoc/_internal/static.py

@@ -106,7 +106,7 @@ def _attribute_docs(attr: Attribute, **kwargs: Any) -> str:  # noqa: ARG001
 def _parameters_docs(func: Function, **kwargs: Any) -> DocstringSectionParameters | None:  # noqa: ARG001
     params_data: dict[str, dict[str, Any]] = defaultdict(dict)
     for parameter in _no_self_params(func):
-        stars = {ParameterKind.var_positional: "*", ParameterKind.var_keyword: "**"}.get(parameter.kind, "")  # type: ignore[arg-type]
+        stars = {ParameterKind.var_positional: "*", ParameterKind.var_keyword: "**"}.get(parameter.kind, "")
         param_name = f"{stars}{parameter.name}"
         metadata = _metadata(parameter.annotation)
         if "deprecated" in metadata or "doc" in metadata:
@@ -126,12 +126,12 @@ def _other_parameters_docs(func: Function, **kwargs: Any) -> DocstringSectionPar
                 "typing.Annotated",
                 "typing_extensions.Annotated",
             }:
-                annotation = annotation.slice.elements[0]  # type: ignore[union-attr]
+                annotation = annotation.slice.elements[0]
             if isinstance(annotation, ExprSubscript) and annotation.canonical_path in {
                 "typing.Unpack",
                 "typing_extensions.Unpack",
             }:
-                slice_path = annotation.slice.canonical_path  # type: ignore[union-attr]
+                slice_path = annotation.slice.canonical_path
                 typed_dict = func.modules_collection[slice_path]
                 params_data = {
                     attr.name: {"annotation": attr.annotation, "description": description}
@@ -150,13 +150,13 @@ def _yields_docs(func: Function, **kwargs: Any) -> DocstringSectionYields | None
 
     if isinstance(annotation, ExprSubscript):
         if annotation.canonical_path in {"typing.Generator", "typing_extensions.Generator"}:
-            yield_annotation = annotation.slice.elements[0]  # type: ignore[union-attr]
+            yield_annotation = annotation.slice.elements[0]  # ty:ignore[unresolved-attribute]
         elif annotation.canonical_path in {"typing.Iterator", "typing_extensions.Iterator"}:
             yield_annotation = annotation.slice
 
     if yield_annotation:
         if isinstance(yield_annotation, ExprSubscript) and yield_annotation.is_tuple:
-            yield_elements = yield_annotation.slice.elements  # type: ignore[union-attr]
+            yield_elements = yield_annotation.slice.elements  # ty:ignore[unresolved-attribute]
         else:
             yield_elements = [yield_annotation]
         yield_data = [
@@ -178,11 +178,11 @@ def _receives_docs(func: Function, **kwargs: Any) -> DocstringSectionReceives |
         "typing.Generator",
         "typing_extensions.Generator",
     }:
-        receive_annotation = annotation.slice.elements[1]  # type: ignore[union-attr]
+        receive_annotation = annotation.slice.elements[1]  # ty:ignore[unresolved-attribute]
 
     if receive_annotation:
         if isinstance(receive_annotation, ExprSubscript) and receive_annotation.is_tuple:
-            receive_elements = receive_annotation.slice.elements  # type: ignore[union-attr]
+            receive_elements = receive_annotation.slice.elements
         else:
             receive_elements = [receive_annotation]
         receive_data = [
@@ -204,7 +204,7 @@ def _returns_docs(func: Function, **kwargs: Any) -> DocstringSectionReturns | No
         "typing.Generator",
         "typing_extensions.Generator",
     }:
-        return_annotation = annotation.slice.elements[2]  # type: ignore[union-attr]
+        return_annotation = annotation.slice.elements[2]  # ty:ignore[unresolved-attribute]
     elif isinstance(annotation, ExprSubscript) and annotation.canonical_path in {
         "typing.Annotated",
         "typing_extensions.Annotated",
@@ -213,7 +213,7 @@ def _returns_docs(func: Function, **kwargs: Any) -> DocstringSectionReturns | No
 
     if return_annotation:
         if isinstance(return_annotation, ExprSubscript) and return_annotation.is_tuple:
-            return_elements = return_annotation.slice.elements  # type: ignore[union-attr]
+            return_elements = return_annotation.slice.elements  # ty:ignore[unresolved-attribute]
         else:
             return_elements = [return_annotation]
         return_data = [
@@ -231,7 +231,7 @@ def _warns_docs(attr_or_func: Attribute | Function, **kwargs: Any) -> DocstringS
     if attr_or_func.is_attribute:
         annotation = attr_or_func.annotation
     elif attr_or_func.is_function:
-        annotation = attr_or_func.returns  # type: ignore[union-attr]
+        annotation = attr_or_func.returns  # ty:ignore[unresolved-attribute]
     else:
         return None
     metadata = _metadata(annotation)
@@ -244,7 +244,7 @@ def _raises_docs(attr_or_func: Attribute | Function, **kwargs: Any) -> Docstring
     if attr_or_func.is_attribute:
         annotation = attr_or_func.annotation
     elif attr_or_func.is_function:
-        annotation = attr_or_func.returns  # type: ignore[union-attr]
+        annotation = attr_or_func.returns  # ty:ignore[unresolved-attribute]
     else:
         return None
     metadata = _metadata(annotation)
@@ -260,7 +260,7 @@ def _deprecated_docs(
     if attr_or_func.is_attribute:
         annotation = attr_or_func.annotation
     elif attr_or_func.is_function:
-        annotation = attr_or_func.returns  # type: ignore[union-attr]
+        annotation = attr_or_func.returns  # ty:ignore[unresolved-attribute]
     else:
         return None
     metadata = _metadata(annotation)