Recover from invalid type hint (felix-hilden#158)

felix-hilden · felix-hilden · commit 39421ebdeaac · 2025-01-15T07:16:15.000+02:00
diff --git a/docs/src/release_notes.rst b/docs/src/release_notes.rst
@@ -8,6 +8,10 @@ These release notes are based on
 sphinx-codeautolink adheres to
 `Semantic Versioning <https://semver.org>`_.
 
+Unreleased
+----------
+- Fix regression in not handling invalid return type hints (:issue:`158`)
+
 0.16.0 (2025-01-11)
 -------------------
 - Declare support for Python 3.12 and 3.13 (:issue:`150`)
diff --git a/src/sphinx_codeautolink/extension/resolve.py b/src/sphinx_codeautolink/extension/resolve.py
@@ -118,7 +118,11 @@ def call_value(cursor: Cursor) -> None:
 
 def get_return_annotation(func: Callable) -> type | None:
     """Determine the target of a function return type hint."""
-    annotation = get_type_hints(func).get("return")
+    try:
+        annotation = get_type_hints(func).get("return")
+    except NameError as e:
+        msg = f"Unable to follow return annotation of {get_name_for_debugging(func)}."
+        raise CouldNotResolve(msg) from e
 
     # Inner type from typing.Optional or Union[None, T]
     origin = getattr(annotation, "__origin__", None)
diff --git a/tests/extension/ref/ref_invalid_typehint.txt b/tests/extension/ref/ref_invalid_typehint.txt
@@ -0,0 +1,14 @@
+future_project
+future_project.invalid_ref
+# split
+codeautolink_warn_on_failed_resolve = False
+# split
+Test project
+============
+
+.. code:: python
+
+   import future_project
+   future_project.invalid_ref().whatever
+
+.. automodule:: future_project
diff --git a/tests/extension/src/future_project.py b/tests/extension/src/future_project.py
@@ -16,3 +16,7 @@ def optional() -> Optional[Foo]:  # noqa: UP007
 
 def optional_manual() -> None | Foo:
     """Return manually constructed optional type."""
+
+
+def invalid_ref() -> NotAClass:  # noqa: F821
+    """Reference to a nonexistent class."""
