Allow overriding exceptions (#16)

Author: flying-sheep

scanpydoc/elegant_typehints/formatting.py

@@ -38,8 +38,9 @@ def _format_full(annotation: Type[Any], fully_qualified: bool = False):
     if inspect.isclass(annotation) or inspect.isclass(origin):
         full_name = f"{annotation.__module__}.{annotation.__qualname__}"
         override = elegant_typehints.qualname_overrides.get(full_name)
+        role = "exception" if issubclass(annotation_cls, BaseException) else "class"
         if override is not None:
-            return f":py:class:`{tilde}{override}`"
+            return f":py:{role}:`{tilde}{override}`"
 
     return _format_orig(annotation, fully_qualified)
 

tests/test_elegant_typehints.py

@@ -21,6 +21,8 @@
 
 TestCls = type("Class", (), {})
 TestCls.__module__ = "_testmod"
+TestExc = type("Excep", (RuntimeError,), {})
+TestExc.__module__ = "_testmod"
 
 
 @pytest.fixture
@@ -31,7 +33,10 @@ def app(make_app_setup) -> Sphinx:
             "sphinx_autodoc_typehints",
             "scanpydoc.elegant_typehints",
         ],
-        qualname_overrides={"_testmod.Class": "test.Class"},
+        qualname_overrides={
+            "_testmod.Class": "test.Class",
+            "_testmod.Excep": "test.Excep",
+        },
     )
 
 
@@ -137,11 +142,16 @@ def test_literal(app):
     )
 
 
-def test_qualname_overrides(app):
+def test_qualname_overrides_class(app):
     assert TestCls.__module__ == "_testmod"
     assert _format_terse(TestCls) == ":py:class:`~test.Class`"
 
 
+def test_qualname_overrides_exception(app):
+    assert TestExc.__module__ == "_testmod"
+    assert _format_terse(TestExc) == ":py:exception:`~test.Excep`"
+
+
 def test_qualname_overrides_recursive(app):
     assert _format_terse(t.Union[TestCls, str]) == (
         r":py:class:`~test.Class`, :py:class:`str`"