style: Format

Author: pawamoy

duties.py

@@ -4,15 +4,13 @@
 
 import os
 import sys
+from importlib.metadata import version as pkgversion
 from pathlib import Path
 from typing import TYPE_CHECKING, Any
 
 from duty import duty
 from duty.callables import black, blacken_docs, coverage, lazy, mkdocs, mypy, pytest, ruff, safety
 
-from importlib.metadata import version as pkgversion
-
-
 if TYPE_CHECKING:
     from duty.context import Context
 

scripts/gen_credits.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import re
+from importlib.metadata import PackageNotFoundError, metadata
 from itertools import chain
 from pathlib import Path
 from textwrap import dedent
@@ -12,8 +13,6 @@
 from jinja2 import StrictUndefined
 from jinja2.sandbox import SandboxedEnvironment
 
-from importlib.metadata import PackageNotFoundError, metadata
-
 project_dir = Path(".")
 pyproject = toml.load(project_dir / "pyproject.toml")
 project = pyproject["project"]

src/griffe_typingdoc/__init__.py

@@ -7,4 +7,4 @@
 
 from griffe_typingdoc.extension import TypingDocExtension as Extension
 
-__all__: list[str] = ["Extension"]  # noqa: WPS410
+__all__: list[str] = ["Extension"]

src/griffe_typingdoc/extension.py

@@ -4,15 +4,17 @@
 
 import ast
 from collections import defaultdict
-from typing import Annotated, Any
+from typing import TYPE_CHECKING, Annotated, Any
 
 from griffe.agents.extensions import VisitorExtension, When
 from griffe.agents.nodes import safe_get_annotation
-from griffe.dataclasses import Function
 from griffe.docstrings.dataclasses import DocstringParameter, DocstringSectionParameters
 
 from griffe_typingdoc.typing_doc import __typing_doc__
 
+if TYPE_CHECKING:
+    from griffe.dataclasses import Function
+
 
 @__typing_doc__(description="Griffe extension parsing the `typing.doc` decorator.")
 class TypingDocExtension(VisitorExtension):
@@ -39,9 +41,8 @@ def visit_functiondef(
 
         func_doc = {}
         for decorator_node in node.decorator_list:
-            if isinstance(decorator_node, ast.Call):
-                if decorator_node.func.id == "__typing_doc__":  # type: ignore[attr-defined]
-                    func_doc.update({kw.arg: kw.value.value for kw in decorator_node.keywords})  # type: ignore[attr-defined]
+            if isinstance(decorator_node, ast.Call) and decorator_node.func.id == "__typing_doc__":  # type: ignore[attr-defined]
+                func_doc.update({kw.arg: kw.value.value for kw in decorator_node.keywords})  # type: ignore[attr-defined]
 
         params_doc: dict[str, dict[str, Any]] = defaultdict(dict)
         for arg in node.args.args:
@@ -57,18 +58,17 @@ def visit_functiondef(
                         if doc.func.id == "__typing_doc__":  # type: ignore[attr-defined]
                             params_doc[param_name].update({kw.arg: kw.value.value for kw in doc.keywords})  # type: ignore[attr-defined,misc]
 
-        if func_doc or params_doc:
-            if function.docstring:
-                sections = function.docstring.parsed
-                if params_doc:
-                    docstring_params = []
-                    for param_name, param_doc in params_doc.items():  # noqa: WPS440
-                        docstring_params.append(
-                            DocstringParameter(
-                                name=param_name,
-                                description=param_doc["description"],
-                                annotation=param_doc["annotation"],
-                                value=function.parameters[param_name].default,
-                            ),
-                        )
-                    sections.append(DocstringSectionParameters(docstring_params))
+        if (func_doc or params_doc) and function.docstring:
+            sections = function.docstring.parsed
+            if params_doc:
+                docstring_params = []
+                for param_name, param_doc in params_doc.items():
+                    docstring_params.append(
+                        DocstringParameter(
+                            name=param_name,
+                            description=param_doc["description"],
+                            annotation=param_doc["annotation"],
+                            value=function.parameters[param_name].default,
+                        ),
+                    )
+                sections.append(DocstringSectionParameters(docstring_params))

src/griffe_typingdoc/typing_doc.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-from typing import Any, Callable, Mapping, Type, TypeVar
+from typing import Any, Callable, Mapping, TypeVar
 
 _Type = TypeVar("_Type")
 
@@ -15,7 +15,7 @@ def __typing_doc__(  # noqa: N807
     description: str | None = None,
     deprecated: bool = False,
     discouraged: bool = False,
-    raises: Mapping[Type[BaseException], str | None] | None = None,
+    raises: Mapping[type[BaseException], str | None] | None = None,
     extra: dict[Any, Any] | None = None,
 ) -> Callable[[_Type], _Type]:
     return lambda _: _

tests/test_extension.py

@@ -1,8 +1,8 @@
 """Tests for the Griffe extension."""
 
 from griffe.agents.extensions import Extensions
-from griffe.loader import GriffeLoader
 from griffe.docstrings.dataclasses import DocstringSectionKind
+from griffe.loader import GriffeLoader
 
 from griffe_typingdoc.extension import TypingDocExtension