style: Format (unsafe fixes)

Author: pawamoy

scripts/gen_credits.py

@@ -10,7 +10,7 @@
 from itertools import chain
 from pathlib import Path
 from textwrap import dedent
-from typing import Dict, Union
+from typing import Union
 
 from jinja2 import StrictUndefined
 from jinja2.sandbox import SandboxedEnvironment
@@ -29,8 +29,8 @@
 project_name = project["name"]
 devdeps = [dep for group in pyproject["dependency-groups"].values() for dep in group if not dep.startswith("-e")]
 
-PackageMetadata = Dict[str, Union[str, Iterable[str]]]
-Metadata = Dict[str, PackageMetadata]
+PackageMetadata = dict[str, Union[str, Iterable[str]]]
+Metadata = dict[str, PackageMetadata]
 
 
 def _merge_fields(metadata: dict) -> PackageMetadata:

scripts/get_annotations.py

@@ -7,7 +7,6 @@
 import sys
 from multiprocessing import Pool, cpu_count
 from pathlib import Path
-from typing import List
 
 try:
     from ast import unparse  # type: ignore[attr-defined]
@@ -52,7 +51,7 @@ def scan_file(filepath: str) -> set:
     return annotations
 
 
-def main(directories: List[str]) -> int:
+def main(directories: list[str]) -> int:
     """Scan Python files in a list of directories.
 
     First, all the files are stored in a list,

src/pytkdocs/cli.py

@@ -17,7 +17,6 @@
 import json
 import sys
 import traceback
-from collections.abc import Iterator
 from contextlib import contextmanager
 from io import StringIO
 from typing import TYPE_CHECKING, Any
@@ -27,6 +26,8 @@
 from pytkdocs.serializer import serialize_object
 
 if TYPE_CHECKING:
+    from collections.abc import Iterator
+
     from pytkdocs.objects import Object
 
 

src/pytkdocs/loader.py

@@ -14,7 +14,7 @@
 from itertools import chain
 from operator import attrgetter
 from pathlib import Path
-from typing import Any, Callable, Dict, List, Optional, Set, Tuple, Union
+from typing import Any, Callable, Optional, Union
 
 from pytkdocs.objects import Attribute, Class, Function, Method, Module, Object, Source
 from pytkdocs.parsers.attributes import get_class_attributes, get_instance_attributes, get_module_attributes, merge
@@ -223,7 +223,7 @@ def get_object_tree(path: str, new_path_syntax: bool = False) -> ObjectNode:  #
     if not path:
         raise ValueError(f"path must be a valid Python path, not {path}")
 
-    objects: List[str] = []
+    objects: list[str] = []
 
     if ":" in path or new_path_syntax:
         try:
@@ -293,7 +293,7 @@ class Loader:
 
     def __init__(
         self,
-        filters: Optional[List[str]] = None,
+        filters: Optional[list[str]] = None,
         docstring_style: str = "google",
         docstring_options: Optional[dict] = None,
         inherited_members: bool = False,  # noqa: FBT001, FBT002
@@ -313,11 +313,11 @@ def __init__(
 
         self.filters = [(filtr, re.compile(filtr.lstrip("!"))) for filtr in filters]
         self.docstring_parser = PARSERS[docstring_style](**(docstring_options or {}))
-        self.errors: List[str] = []
+        self.errors: list[str] = []
         self.select_inherited_members = inherited_members
         self.new_path_syntax = new_path_syntax
 
-    def get_object_documentation(self, dotted_path: str, members: Optional[Union[Set[str], bool]] = None) -> Object:
+    def get_object_documentation(self, dotted_path: str, members: Optional[Union[set[str], bool]] = None) -> Object:
         """Get the documentation for an object and its children.
 
         Arguments:
@@ -359,7 +359,7 @@ def get_object_documentation(self, dotted_path: str, members: Optional[Union[Set
     def get_module_documentation(
         self,
         node: ObjectNode,
-        select_members: Optional[Union[Set[str], bool]] = None,
+        select_members: Optional[Union[set[str], bool]] = None,
     ) -> Module:
         """Get the documentation for a module and its children.
 
@@ -430,7 +430,7 @@ def _class_path(cls: type) -> str:  # noqa: PLW0211
     def get_class_documentation(
         self,
         node: ObjectNode,
-        select_members: Optional[Union[Set[str], bool]] = None,
+        select_members: Optional[Union[set[str], bool]] = None,
     ) -> Class:
         """Get the documentation for a class and its children.
 
@@ -462,10 +462,10 @@ def get_class_documentation(
         )
 
         # Even if we don't select members, we want to correctly parse the docstring
-        attributes_data: Dict[str, Dict[str, Any]] = {}
+        attributes_data: dict[str, dict[str, Any]] = {}
         for parent_class in reversed(class_.__mro__[:-1]):
             merge(attributes_data, get_class_attributes(parent_class))
-        context: Dict[str, Any] = {"attributes": attributes_data}
+        context: dict[str, Any] = {"attributes": attributes_data}
         if "__init__" in class_.__dict__:
             try:
                 attributes_data.update(get_instance_attributes(class_.__init__))
@@ -567,7 +567,7 @@ def add_fields(
         root_object: Object,
         attr_name: str,
         members: Mapping[str, Any],
-        select_members: Optional[Union[Set[str], bool]],
+        select_members: Optional[Union[set[str], bool]],
         base_class: type,
         add_method: Callable,
     ) -> None:
@@ -615,7 +615,7 @@ def get_function_documentation(self, node: ObjectNode) -> Function:
         except OSError:
             source = None
 
-        properties: List[str] = []
+        properties: list[str] = []
         if node.is_coroutine_function():
             properties.append("async")
 
@@ -833,7 +833,7 @@ def get_regular_method_documentation(self, node: ObjectNode) -> Method:
                         break
         return method
 
-    def get_method_documentation(self, node: ObjectNode, properties: Optional[List[str]] = None) -> Method:
+    def get_method_documentation(self, node: ObjectNode, properties: Optional[list[str]] = None) -> Method:
         """Get the documentation for a method or method descriptor.
 
         Arguments:
@@ -905,7 +905,7 @@ def get_attribute_documentation(node: ObjectNode, attribute_data: Optional[dict]
             attr_type=attribute_data.get("annotation", None),
         )
 
-    def select(self, name: str, names: Set[str]) -> bool:
+    def select(self, name: str, names: set[str]) -> bool:
         """Tells whether we should select an object or not, given its name.
 
         If the set of names is not empty, we check against it, otherwise we check against filters.
@@ -963,7 +963,7 @@ def field_is_inherited(field_name: str, fields_name: str, base_class: type) -> b
     )
 
 
-def split_attr_name(attr_name: str) -> Tuple[str, Optional[str]]:
+def split_attr_name(attr_name: str) -> tuple[str, Optional[str]]:
     """Split an attribute name into a first-order attribute name and remainder.
 
     Args:
@@ -985,7 +985,7 @@ def get_fields(  # noqa: D103
     *,
     members: Optional[Mapping[str, Any]] = None,
     class_obj: Optional[type] = None,
-) -> Dict[str, Any]:
+) -> dict[str, Any]:
     if not (bool(members) ^ bool(class_obj)):
         raise ValueError("Either members or class_obj is required.")
     first_order_attr_name, remainder = split_attr_name(attr_name)

src/pytkdocs/objects.py

@@ -19,7 +19,7 @@
 from abc import ABCMeta
 from functools import lru_cache
 from pathlib import Path
-from typing import Any, List, Optional, Union
+from typing import Any, Optional, Union
 
 from pytkdocs.parsers.docstrings.base import Parser, Section
 from pytkdocs.properties import NAME_CLASS_PRIVATE, NAME_PRIVATE, NAME_SPECIAL, ApplicableNameProperty
@@ -32,7 +32,7 @@ class Source:
     [`inspect.getsourceslines`](https://docs.python.org/3/library/inspect.html#inspect.getsourcelines).
     """
 
-    def __init__(self, lines: Union[str, List[str]], line_start: int) -> None:
+    def __init__(self, lines: Union[str, list[str]], line_start: int) -> None:
         """Initialize the object.
 
         Arguments:
@@ -52,7 +52,7 @@ class Object(metaclass=ABCMeta):  # noqa: B024
     Each instance additionally stores references to its children, grouped by category.
     """
 
-    possible_name_properties: List[ApplicableNameProperty] = []  # noqa: RUF012
+    possible_name_properties: list[ApplicableNameProperty] = []  # noqa: RUF012
     """
     The properties that we can apply to the object based on its name.
 
@@ -65,7 +65,7 @@ def __init__(
         path: str,
         file_path: str,
         docstring: Optional[str] = "",
-        properties: Optional[List[str]] = None,
+        properties: Optional[list[str]] = None,
         source: Optional[Source] = None,
     ) -> None:
         """Initialize the object.
@@ -86,9 +86,9 @@ def __init__(
         """The file path of the object's direct parent module."""
         self.docstring = docstring
         """The object's docstring."""
-        self.docstring_sections: List[Section] = []
+        self.docstring_sections: list[Section] = []
         """The object's docstring parsed into sections."""
-        self.docstring_errors: List[str] = []
+        self.docstring_errors: list[str] = []
         """The errors detected while parsing the docstring."""
         self.properties = properties or []
         """The object's properties."""
@@ -100,17 +100,17 @@ def __init__(
         self._path_map = {self.path: self}
         self._parsed = False
 
-        self.attributes: List[Attribute] = []
+        self.attributes: list[Attribute] = []
         """The list of all the object's attributes."""
-        self.methods: List[Method] = []
+        self.methods: list[Method] = []
         """The list of all the object's methods."""
-        self.functions: List[Function] = []
+        self.functions: list[Function] = []
         """The list of all the object's functions."""
-        self.modules: List[Module] = []
+        self.modules: list[Module] = []
         """The list of all the object's submodules."""
-        self.classes: List[Class] = []
+        self.classes: list[Class] = []
         """The list of all the object's classes."""
-        self.children: List[Object] = []
+        self.children: list[Object] = []
         """The list of all the object's children."""
 
     def __str__(self) -> str:
@@ -193,7 +193,7 @@ def name_to_check(self) -> str:
         return self.name
 
     @property
-    def name_properties(self) -> List[str]:
+    def name_properties(self) -> list[str]:
         """Return the object's name properties.
 
         Returns:
@@ -253,7 +253,7 @@ def add_child(self, obj: "Object") -> None:
 
         self._path_map[obj.path] = obj
 
-    def add_children(self, children: List["Object"]) -> None:
+    def add_children(self, children: list["Object"]) -> None:
         """Add a list of objects as children of this object.
 
         Arguments:
@@ -309,7 +309,7 @@ def has_contents(self) -> bool:
 class Module(Object):
     """A class to store information about a module."""
 
-    possible_name_properties: List[ApplicableNameProperty] = [NAME_SPECIAL, NAME_PRIVATE]  # noqa: RUF012
+    possible_name_properties: list[ApplicableNameProperty] = [NAME_SPECIAL, NAME_PRIVATE]  # noqa: RUF012
 
     @property
     def file_name(self) -> str:
@@ -328,9 +328,9 @@ def name_to_check(self) -> str:  # noqa: D102
 class Class(Object):
     """A class to store information about a class."""
 
-    possible_name_properties: List[ApplicableNameProperty] = [NAME_PRIVATE]  # noqa: RUF012
+    possible_name_properties: list[ApplicableNameProperty] = [NAME_PRIVATE]  # noqa: RUF012
 
-    def __init__(self, *args: Any, bases: Optional[List[str]] = None, **kwargs: Any):
+    def __init__(self, *args: Any, bases: Optional[list[str]] = None, **kwargs: Any):
         """Initialize the object.
 
         Arguments:
@@ -348,7 +348,7 @@ class Function(Object):
     It accepts an additional `signature` argument at instantiation.
     """
 
-    possible_name_properties: List[ApplicableNameProperty] = [NAME_PRIVATE]  # noqa: RUF012
+    possible_name_properties: list[ApplicableNameProperty] = [NAME_PRIVATE]  # noqa: RUF012
 
     def __init__(self, *args: Any, signature: Optional[inspect.Signature] = None, **kwargs: Any):
         """Initialize the object.
@@ -368,7 +368,7 @@ class Method(Object):
     It accepts an additional `signature` argument at instantiation.
     """
 
-    possible_name_properties: List[ApplicableNameProperty] = [NAME_SPECIAL, NAME_PRIVATE]  # noqa: RUF012
+    possible_name_properties: list[ApplicableNameProperty] = [NAME_SPECIAL, NAME_PRIVATE]  # noqa: RUF012
 
     def __init__(self, *args: Any, signature: Optional[inspect.Signature] = None, **kwargs: Any):
         """Initialize the object.
@@ -388,7 +388,7 @@ class Attribute(Object):
     It accepts an additional `attr_type` argument at instantiation.
     """
 
-    possible_name_properties: List[ApplicableNameProperty] = [NAME_SPECIAL, NAME_CLASS_PRIVATE, NAME_PRIVATE]  # noqa: RUF012
+    possible_name_properties: list[ApplicableNameProperty] = [NAME_SPECIAL, NAME_CLASS_PRIVATE, NAME_PRIVATE]  # noqa: RUF012
 
     def __init__(self, *args: Any, attr_type: Optional[Any] = None, **kwargs: Any):
         """Initialize the object.

src/pytkdocs/parsers/attributes.py

@@ -6,7 +6,7 @@
 from functools import lru_cache
 from textwrap import dedent
 from types import ModuleType
-from typing import Any, Callable, List, get_type_hints
+from typing import Any, Callable, get_type_hints
 
 try:
     from ast import unparse  # type: ignore[attr-defined]
@@ -16,7 +16,7 @@
 RECURSIVE_NODES = (ast.If, ast.IfExp, ast.Try, ast.With)
 
 
-def get_nodes(obj: Any) -> List[ast.stmt]:  # noqa: D103
+def get_nodes(obj: Any) -> list[ast.stmt]:  # noqa: D103
     try:
         source = inspect.getsource(obj)
     except (OSError, TypeError):

src/pytkdocs/parsers/docstrings/__init__.py

@@ -1,7 +1,5 @@
 """The parsers' package."""
 
-from typing import Dict, Type
-
 from pytkdocs.parsers.docstrings.base import Parser, UnavailableParser
 from pytkdocs.parsers.docstrings.google import Google
 from pytkdocs.parsers.docstrings.markdown import Markdown
@@ -15,7 +13,7 @@
     )
 
 
-PARSERS: Dict[str, Type[Parser]] = {
+PARSERS: dict[str, type[Parser]] = {
     "google": Google,
     "restructured-text": RestructuredText,
     "numpy": Numpy,

src/pytkdocs/parsers/docstrings/base.py

@@ -2,7 +2,7 @@
 
 import inspect
 from abc import ABCMeta, abstractmethod
-from typing import Any, List, Optional, Tuple
+from typing import Any, Optional
 
 empty = inspect.Signature.empty
 
@@ -137,9 +137,9 @@ class Parser(metaclass=ABCMeta):
     def __init__(self, **kwargs: Any) -> None:  # noqa: ARG002
         """Initialize the object."""
         self.context: dict = {}
-        self.errors: List[str] = []
+        self.errors: list[str] = []
 
-    def parse(self, docstring: str, context: Optional[dict] = None) -> Tuple[List[Section], List[str]]:
+    def parse(self, docstring: str, context: Optional[dict] = None) -> tuple[list[Section], list[str]]:
         """Parse a docstring and return a list of sections and parsing errors.
 
         Arguments:
@@ -166,7 +166,7 @@ def error(self, message: str) -> None:
         self.errors.append(message)
 
     @abstractmethod
-    def parse_sections(self, docstring: str) -> List[Section]:
+    def parse_sections(self, docstring: str) -> list[Section]:
         """Parse a docstring as a list of sections.
 
         Arguments:
@@ -182,7 +182,7 @@ class UnavailableParser:  # noqa: D101
     def __init__(self, message: str) -> None:  # noqa: D107
         self.message = message
 
-    def parse(self, docstring: str, context: Optional[dict] = None) -> Tuple[List[Section], List[str]]:  # noqa: ARG002, D102
+    def parse(self, docstring: str, context: Optional[dict] = None) -> tuple[list[Section], list[str]]:  # noqa: ARG002, D102
         context = context or {}
         message = self.message
         if "obj" in context: