feat: add support for TypeAliasType

Author: flying-sheep

.pre-commit-config.yaml

@@ -26,3 +26,4 @@ repos:
           - types-docutils
           - legacy-api-wrap
           - myst-parser
+          - sphinx-autodoc-typehints

docs/conf.py

@@ -5,8 +5,7 @@
 import re
 from typing import TYPE_CHECKING
 from pathlib import PurePosixPath
-from datetime import datetime
-from datetime import timezone as tz
+from datetime import UTC, datetime
 from importlib.metadata import metadata
 
 from jinja2.tests import TESTS
@@ -42,7 +41,7 @@
 meta = metadata("scanpydoc")
 project = meta["name"]
 author = meta["author-email"].split(" <")[0]
-copyright = f"{datetime.now(tz=tz.utc):%Y}, {author}."  # noqa: A001
+copyright = f"{datetime.now(tz=UTC):%Y}, {author}."  # noqa: A001
 version = release = meta["version"]
 
 master_doc = "index"

pyproject.toml

@@ -17,7 +17,7 @@ classifiers = [
     'Framework :: Sphinx :: Extension',
     'Typing :: Typed',
 ]
-requires-python = '>=3.10'
+requires-python = '>=3.12'
 dependencies = [
     'sphinx>=7.0',
 ]

src/scanpydoc/__init__.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, TypeVar
+from typing import TYPE_CHECKING, Any
 from textwrap import indent
 from collections.abc import Callable
 
@@ -31,10 +31,8 @@
 :ref:`Metadata <sphinx:ext-metadata>` for this extension.
 """
 
-C = TypeVar("C", bound=Callable[..., Any])
 
-
-def _setup_sig(fn: C) -> C:
+def _setup_sig[C: Callable[..., Any]](fn: C) -> C:
     fn.__doc__ = f"{fn.__doc__ or ''}\n\n{indent(setup_sig_str, ' ' * 4)}"
     return fn
 

src/scanpydoc/autosummary_generate_imported.py

@@ -13,12 +13,7 @@
 
 
 if TYPE_CHECKING:
-    import sys
-
-    if sys.version_info >= (3, 11):
-        from typing import Never
-    else:  # pragma: no cover
-        from typing import NoReturn as Never
+    from typing import Never
 
     from sphinx.application import Sphinx
 

src/scanpydoc/definition_list_typed_field.py

@@ -20,13 +20,13 @@
 
 
 if TYPE_CHECKING:
-    from typing import Any, TypeAlias
+    from typing import Any
     from collections.abc import Iterable
 
     from sphinx.application import Sphinx
     from sphinx.environment import BuildEnvironment
 
-    TextLikeNode: TypeAlias = nodes.Text | nodes.TextElement
+    type TextLikeNode = nodes.Text | nodes.TextElement
 
 
 class DLTypedField(PyTypedField):

src/scanpydoc/elegant_typehints/_formatting.py

@@ -2,7 +2,7 @@
 
 import inspect
 from types import GenericAlias
-from typing import TYPE_CHECKING, cast, get_args, get_origin
+from typing import TYPE_CHECKING, TypeAliasType, cast, get_args, get_origin
 
 from sphinx_autodoc_typehints import format_annotation
 
@@ -16,7 +16,7 @@
     from sphinx.config import Config
 
 
-def typehints_formatter(annotation: type[Any], config: Config) -> str | None:
+def typehints_formatter(annotation: object, config: Config) -> str | None:
     """Generate reStructuredText containing links to the types.
 
     Can be used as ``typehints_formatter`` for :mod:`sphinx_autodoc_typehints`,
@@ -33,6 +33,9 @@ def typehints_formatter(annotation: type[Any], config: Config) -> str | None:
     -------
     reStructuredText describing the type
     """
+    if isinstance(annotation, TypeAliasType):
+        return format_annotation(annotation.__value__, config)
+
     if inspect.isclass(annotation) and annotation.__module__ == "builtins":
         return None
 

src/scanpydoc/elegant_typehints/_role_mapping.py

@@ -50,7 +50,7 @@ def __getitem__(self, key: tuple[str | None, str]) -> tuple[str | None, str]:
         for known_role in chain([None], {r for r, _ in self}):
             try:
                 return self.data[known_role, key[1]]
-            except KeyError:  # noqa: PERF203
+            except KeyError:
                 pass
         raise KeyError(key)
 

src/scanpydoc/rtd_github_links/__init__.py

@@ -75,10 +75,10 @@
 
 if TYPE_CHECKING:
     from types import CodeType, FrameType, MethodType, FunctionType, TracebackType
-    from typing import Any, TypeAlias
+    from typing import Any
     from collections.abc import Callable
 
-    _SourceObjectType: TypeAlias = (
+    type _SourceObjectType = (
         ModuleType
         | type[Any]
         | MethodType
@@ -211,8 +211,7 @@ def github_url(qualname: str) -> str:
     try:
         obj, module = _get_obj_module(qualname)
     except Exception as e:
-        if sys.version_info >= (3, 11):
-            e.add_note(f"Qualname: {qualname!r}")
+        e.add_note(f"Qualname: {qualname!r}")
         raise
     assert rtd_links_prefix is not None  # noqa: S101
     path = rtd_links_prefix / _module_path(obj, module)

src/scanpydoc/rtd_github_links/_linkcode.py

@@ -20,10 +20,10 @@ class JSInfo(TypedDict):
 
 
 if TYPE_CHECKING:
-    from typing import Literal, TypeAlias
+    from typing import Literal
 
     Domain = Literal["py", "c", "cpp", "javascript"]
-    DomainInfo: TypeAlias = PyInfo | CInfo | JSInfo
+    type DomainInfo = PyInfo | CInfo | JSInfo
 
 
 @overload