sphinx-codeautolink 0.18.0__tar.gz → 0.18.1__tar.gz

{sphinx_codeautolink-0.18.0 → sphinx_codeautolink-0.18.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-codeautolink
-Version: 0.18.0
+Version: 0.18.1
 Summary: Automatic links from code examples to reference documentation.
 Author-email: Felix Hildén <felix.hilden@gmail.com>
 Maintainer-email: Felix Hildén <felix.hilden@gmail.com>

{sphinx_codeautolink-0.18.0 → sphinx_codeautolink-0.18.1}/docs/src/release_notes.rst

@@ -8,6 +8,11 @@ These release notes are based on
 sphinx-codeautolink adheres to
 `Semantic Versioning <https://semver.org>`_.
 
+0.18.1 (2026-04-30)
+-------------------
+- Recognize aliased ``TYPE_CHECKING`` imports such as
+  ``from typing import TYPE_CHECKING as _TYPE_CHECKING`` (:issue:`199`)
+
 0.18.0 (2026-04-25)
 -------------------
 - Support module attributes and class aliases (:issue:`65`)

{sphinx_codeautolink-0.18.0 → sphinx_codeautolink-0.18.1}/src/sphinx_codeautolink/__init__.py

@@ -8,7 +8,7 @@ from .extension import SphinxCodeAutoLink, backref, directive
 from .extension.block import clean_ipython, clean_pycon
 from .extension.translation import MESSAGE_CATALOG_NAME
 
-__version__ = "0.18.0"
+__version__ = "0.18.1"
 
 
 def setup(app: Sphinx):

{sphinx_codeautolink-0.18.0 → sphinx_codeautolink-0.18.1}/src/sphinx_codeautolink/extension/resolve.py

@@ -282,10 +282,13 @@ def populate_type_checking(mod: ModuleType) -> None:
         return
 
     tree = ast.parse(source)
+    aliases = collect_type_checking_aliases(tree)
 
     filename = getattr(mod, "__file__", None) or "<type_checking>"
     for node in tree.body:
-        if not isinstance(node, ast.If) or not is_type_checking_test(node.test):
+        if not isinstance(node, ast.If):
+            continue
+        if not is_type_checking_test(node.test, aliases):
             continue
         body = ast.Module(body=node.body, type_ignores=[])
         # Catch e.g. optional deps and cyclic imports
@@ -293,15 +296,23 @@ def populate_type_checking(mod: ModuleType) -> None:
             exec(compile(body, filename, "exec"), mod.__dict__)  # noqa: S102
 
 
-def is_type_checking_test(expr: ast.expr) -> bool:
-    """
-    Determine if expr is a test for type checking.
+def collect_type_checking_aliases(tree: ast.Module) -> set[str]:
+    """Walk top-level imports, return names bound to ``typing.TYPE_CHECKING``."""
+    aliases: set[str] = set()
+    for node in tree.body:
+        if isinstance(node, ast.ImportFrom) and node.module == "typing":
+            for alias in node.names:
+                if alias.name in ("TYPE_CHECKING", "MYPY"):
+                    aliases.add(alias.asname or alias.name)
+    return aliases
 
-    Mirror mypy's ``infer_condition_value``: match a bare name or any
-    attribute access regardless of qualifier.
-    """
+
+def is_type_checking_test(
+    expr: ast.expr, aliases: frozenset[str] | set[str] = frozenset()
+) -> bool:
+    """Determine if expr is a test for type checking."""
     if isinstance(expr, ast.Name):
-        return expr.id in ("TYPE_CHECKING", "MYPY")
+        return expr.id in ("TYPE_CHECKING", "MYPY") or expr.id in aliases
     if isinstance(expr, ast.Attribute):
         return expr.attr in ("TYPE_CHECKING", "MYPY")
     return False

{sphinx_codeautolink-0.18.0 → sphinx_codeautolink-0.18.1}/src/sphinx_codeautolink.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-codeautolink
-Version: 0.18.0
+Version: 0.18.1
 Summary: Automatic links from code examples to reference documentation.
 Author-email: Felix Hildén <felix.hilden@gmail.com>
 Maintainer-email: Felix Hildén <felix.hilden@gmail.com>

{sphinx_codeautolink-0.18.0 → sphinx_codeautolink-0.18.1}/src/sphinx_codeautolink.egg-info/SOURCES.txt

@@ -154,6 +154,7 @@ tests/extension/ref/ref_optional.txt
 tests/extension/ref/ref_optional_future.txt
 tests/extension/ref/ref_shadow_builtin.txt
 tests/extension/ref/ref_simple.txt
+tests/extension/ref/ref_type_checking_aliased.txt
 tests/extension/ref/ref_type_checking_gated.txt
 tests/extension/ref/search_css_duplicates_removed.txt
 tests/extension/ref/skip_file.txt
@@ -168,6 +169,8 @@ tests/extension/src/test_project/__init__.py
 tests/extension/src/test_project/sub.py
 tests/extension/src/type_checking/__init__.py
 tests/extension/src/type_checking/foo.py
+tests/extension/src/type_checking_aliased/__init__.py
+tests/extension/src/type_checking_aliased/foo.py
 tests/extension/table/tab_autodoc_empty.txt
 tests/extension/table/tab_autodoc_links.txt
 tests/extension/table/tab_manual_collapse.txt

sphinx_codeautolink-0.18.1/tests/extension/ref/ref_type_checking_aliased.txt

@@ -0,0 +1,15 @@
+type_checking_aliased
+type_checking_aliased.pick
+attr
+# split
+# split
+Test project
+============
+
+.. code:: python
+
+   import type_checking_aliased
+   type_checking_aliased.pick(["a"]).attr
+
+.. automodule:: type_checking_aliased
+.. automodule:: type_checking_aliased.foo

sphinx_codeautolink-0.18.1/tests/extension/src/type_checking_aliased/__init__.py

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING as _TYPE_CHECKING
+
+if _TYPE_CHECKING:
+    from collections.abc import Collection
+
+    from .foo import Foo
+
+
+def pick(items: Collection[str]) -> Foo:
+    """Return value whose annotation references a name guarded by an
+    aliased ``if TYPE_CHECKING: ...``
+    """

sphinx_codeautolink-0.18.1/tests/extension/src/type_checking_aliased/foo.py

@@ -0,0 +1,4 @@
+class Foo:
+    """Foo test class."""
+
+    attr: str = "test"