Rely on sphinx-autodoc-typehints 1.14 (#43)

Author: flying-sheep

pyproject.toml

@@ -33,10 +33,10 @@ test = [
     'typing_extensions>=3.10; python_version<"3.8"',
 ]
 doc = [
-    'sphinx-autodoc-typehints>=1.12',
+    'scanpydoc[typehints]',
     'sphinx-rtd-theme',
 ]
-typehints = ['sphinx-autodoc-typehints>=1.12']
+typehints = ['sphinx-autodoc-typehints>=1.14']
 theme = ['sphinx-rtd-theme']
 
 [tool.flit.entrypoints.'sphinx.html_themes']

scanpydoc/elegant_typehints/__init__.py

@@ -22,6 +22,7 @@
    this part of the functionality will no longer be necessary.
 #. The config value ``annotate_defaults`` (default: :data:`True`) controls if rST code
    like ``(default: `42`)`` is added after the type.
+   It sets sphinx-autodoc-typehints’s option ``typehints_defaults`` to ``'braces'``
 #. Type annotations for :class:`tuple` return types are added::
 
        def x() -> Tuple[int, float]:
@@ -72,13 +73,17 @@ def x() -> Tuple[int, float]:
     "scipy.sparse.csc.csc_matrix": "scipy.sparse.csc_matrix",
 }
 qualname_overrides = ChainMap({}, qualname_overrides_default)
-annotate_defaults = True
 
 
 def _init_vars(app: Sphinx, config: Config):
-    global annotate_defaults
     qualname_overrides.update(config.qualname_overrides)
-    annotate_defaults = config.annotate_defaults
+    if "sphinx_autodoc_typehints" not in config.extensions and config.annotate_defaults:
+        raise ValueError(
+            "Can only use annotate_defaults option when using sphinx-autodoc-typehints"
+        )
+    if config.typehints_defaults is None and config.annotate_defaults:
+        # override default for “typehints_defaults”
+        config.typehints_defaults = "braces"
     config.html_static_path.append(str(HERE / "static"))
 
 

scanpydoc/elegant_typehints/example.py

@@ -4,7 +4,7 @@
 def example_func(a: Optional[str], b: Union[str, int, None] = None) -> Dict[str, int]:
     """Example function
 
-    Hover over the paramter and return type annotations to see the long versions.
+    Hover over the parameter and return type annotations to see the long versions.
 
     Args:
         a: An example parameter

scanpydoc/elegant_typehints/formatting.py

@@ -118,16 +118,7 @@ def format_annotation(
     curframe = inspect.currentframe()
     calframe = inspect.getouterframes(curframe, 2)
     if calframe[1][3] == "process_docstring":
-        annot_fmt = format_both(annotation, fully_qualified, simplify_optional_unions)
-        if elegant_typehints.annotate_defaults:
-            variables = calframe[1].frame.f_locals
-            sig = inspect.signature(variables["obj"])
-            arg_name = variables["argname"].replace(r"\_", "_")
-            if arg_name != "return":
-                default = sig.parameters[arg_name].default
-                if default is not inspect.Parameter.empty:
-                    annot_fmt += f" (default: ``{_escape(repr(default))}``)"
-        return annot_fmt
+        return format_both(annotation, fully_qualified, simplify_optional_unions)
     else:  # recursive use
         return _format_full(annotation, fully_qualified, simplify_optional_unions)