tox-dev-sphinx-autodoc-typehints-605-606

LICENSE
README.md
ignore-words.txt
pyproject.toml
src
tests
tox.toml
whitelist.txt

/repo/src/sphinx_autodoc_typehints/attributes_patch.py
/repo/src/sphinx_autodoc_typehints/patches.py
/repo/src/sphinx_autodoc_typehints/version.py
/repo/src/sphinx_autodoc_typehints/_parser.py
/repo/src/sphinx_autodoc_typehints/__init__.py
conftest.py
roots
test_integration.py
test_integration_autodoc_type_aliases.py
test_integration_issue_384.py
test_sphinx_autodoc_typehints.py
test_version.py

16:from docutils.frontend import get_default_settings
272:        # By default we don't show metadata in Annotated
700:def format_default(app: Sphinx, default: Any, is_annotated: bool) -> str | None:  # noqa: FBT001
701:    if default is inspect.Parameter.empty:
703:    formatted = repr(default).replace("\\", "\\\\")
706:        if app.config.typehints_defaults.startswith("braces"):
707:            return f" (default: ``{formatted}``)"
708:        return f", default: ``{formatted}``"
709:    if app.config.typehints_defaults == "braces-after":
710:        return f" (default: ``{formatted}``)"
711:    return f"default: ``{formatted}``"
832:    default = signature.parameters[arg_name].default

862:        if app.config.typehints_defaults:
863:            formatted_default = format_default(app, default, annotation is not None or has_preexisting_annotation)
864:            if formatted_defa
…[437 chars omitted]…
otation += formatted_default
949:    settings = get_default_settings(RSTParser)  # type: ignore[arg-type]
1035:    valid = {None, "comma", "braces", "braces-after"}
1036:    if app.config.typehints_defaults not in valid | {False}:
1037:        msg = f"typehints_defaults needs to be one of {valid!r}, not {app.config.typehints_defaults!r}"
1089:    app.add_config_value("typehints_defaults", None, "env")

signature: inspect.Signature | None,
    original_obj: Any,
    app: Sphinx,
    what: str,
    name: str,
    lines: list[str],
) -> None:
    if signature is not None:
        _inject_signature(type_hints, signature, app, lines)
    if "return" in type_hints:
        _inject_rtype(type_hints, original_obj, app, what, name, lines)

def _inject_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
) -> None:
    for arg_name in signature.parameters:
        _inject_arg_signature(type_hints, signature, app, lines, arg_name)


def _inject_arg_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
    arg_name: str,
) -> None:
    annotation = type_hints.get(arg_name)

    default = signature.parameters[arg_name].default

    if arg_name.endswith("_"):
        a
…[2364 chars omitted]…
 insert_index  # last nonempty line
        while next_index < nlines and (not lines[next_index] or lines[next_index].startswith(" ")):
            if lines[next_index]:
                append_index = next_index
            next_index += 1
        lines[append_index] += formatted_default

    else:  # add to last param doc line
        type_annotation += formatted_default

    return type_annotation

"""Custom patches to make the world work."""

from __future__ import annotations

from functools import lru_cache
from typing import TYPE_CHECKING, Any

from docutils import nodes
from docutils.parsers.rst.directives.admonitions import BaseAdmonition
from docutils.parsers.rst.states import Body, Text
from sphinx.ext.napoleon.docstring import GoogleDocstring

from .attributes_patch import patch_attribute_handling

if TYPE_CHECKING:
    from sphinx.application import Sphinx
    from sphinx.ext.autodoc import Options


def napoleon_numpy_docstring_return_type_processor(  # noqa: PLR0913, PLR0917
    app: Sphinx,
    what: str,
    name: str,  # noqa: ARG001
    obj: Any,  # noqa: ARG001
    options: Options | None,  # noqa: ARG001
    lines: list[str],
) -> None:
    """Insert a : under Returns: to tell napoleon not to look for a return type."""
    if what not in {"function", "method"}:
…[4932 chars omitted]…
 arg_name: str) -> bool:
/repo/src/sphinx_autodoc_typehints/__init__.py:784:    keyword_and_name = _get_sphinx_line_keyword_and_argument(line)
/repo/src/sphinx_autodoc_typehints/__init__.py:839:        if _line_is_param_line_for_arg(line, arg_name):
/repo/src/sphinx_autodoc_typehints/__init__.py:842:            _, arg_name = _get_sphinx_line_keyword_and_argument(line)  # type: ignore[assignment, misc]

except ValueError:
        return

    try:
        signature = sphinx_signature(obj, type_aliases=app.config["autodoc_type_aliases"])
    except (ValueError, TypeError):
        signature = None

    localns = {key: MyTypeAliasForwardRef(value) for key, value in app.config["autodoc_type_aliases"].items()}
    type_hints = get_all_type_hints(app.config.autodoc_mock_imports, obj, name, localns)
    app.config._annotation_globals = getattr(obj, "__globals__", {})  # noqa: SLF001
    try:

        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
    finally:
        delattr(app.config, "_annotation_globals")


def _get_sphinx_line_keyword_and_argument(line: str) -> tuple[str, str | None] | None:
    """
    Extract a keyword, and its optional argument out of a sphinx field option line.

    For example
    >>> _get_sphinx_line_keyword_and_argumen
…[1060 chars omitted]…
urn False

    if keyword not in {"param", "parameter", "arg", "argument"}:
        return False

    return any(doc_name == prefix + arg_name for prefix in ("", "\\*", "\\**", "\\*\\*"))


def _inject_types_to_docstring(  # noqa: PLR0913, PLR0917
    type_hints: dict[str, Any],
    signature: inspect.Signature | None,
test-dummy
test-integration
test-resolve-typing-guard
test-resolve-typing-guard-tmp

from __future__ import annotations

import re
import sys
from dataclasses import dataclass
from inspect import isclass
from pathlib import Path
from textwrap import dedent, indent
from typing import (  # no type comments
    TYPE_CHECKING,
    Any,
    Literal,

    NewType,
    Optional,
    TypeVar,
    Union,
    overload,
)

import pytest

if TYPE_CHECKING:
    from collections.abc import AsyncGenerator, Callable
    from io import StringIO
    from mailbox import Mailbox
    from types import CodeType, ModuleType

    from sphinx.testing.util import SphinxTestApp

T = TypeVar("T")
W = NewType("W", str)


@dataclass
class WarningInfo:
    """Properties and assertion methods for warnings."""

    regexp: str
    type: str

    def assert_regexp(self, message: str) -> None:
        regexp = self.regexp
        msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: {message
…[534 chars omitted]…
ted
        val.OPTIONS = options
        return val

    return dec


def warns(info: WarningInfo) -> Callable[[T], T]:
    def dec(val: T) -> T:
        val.WARNING = info
        return val

    return dec


@expected("mod.get_local_function()")
def get_local_function():  # noqa: ANN201
    def wrapper(self) -> str:  # noqa: ANN001
        """
        Wrapper
        """

    return wrapper
conf.py

from __future__ import annotations

import pathlib
import sys

# Make dummy_module.py available for autodoc.
sys.path.insert(0, str(pathlib.Path(__file__).parent))


master_doc = "index"

extensions = [

    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx_autodoc_typehints",
]
    return wrapper


@warns(WarningInfo(regexp="Cannot handle as a local function", type="sphinx_autodoc_typehints.local_function"))
@expected(
    """\
class mod.Class(x, y, z=None)

   Initializer docstring.

   Parameters:
      * **x** ("bool") -- foo

      * **y** ("int") -- bar

      * **z** ("str" | "None") -- baz

   class InnerClass

      Inner class.

      inner_method(x)

         Inner method.

         Parameters:
            **x** ("bool") -- foo

         Return type:
            "str"

   classmethod a_classmethod(x, y, z=None)

      Classmethod docstring.

      Parameters:
    
…[1058 chars omitted]…
        :param x: foo
        :param y: bar
        :param z: baz
        """

    def _private_method(self, x: str) -> str:
        """
        Private method docstring.

        :param x: foo
        """

    def __dunder_method(self, x: str) -> str:
        """
        Dunder method docstring.

        :param x: foo
        """

    def __magic_custom_method__(self, x: str) -> str:  # noqa: PLW3201

Traceback (most recent call last):
  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 131, in _import_from_module_and_path
    module = _import_module(module_name, try_reload=True)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 233, in _import_module
    raise ImportError(exc, traceback.format_exc()) from exc
ImportError: (AttributeError('Cannot overwrite NamedTuple attribute __new__'), 'Traceback (most recent call last):\n  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 221, in _import_module\n    module = importlib.import_module(modname)\n             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n  File "/usr/local/lib/python3.12/importlib/__init__.py", line 90, in import_module\n    return _bootst
…[1313 chars omitted]…
 /tmp/repro/_out/_static/alabaster.css
copying static files: done
copying extra files... 
copying extra files: done

copying assets: done
writing output... [100%] index

generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 2 warnings (with warnings treated as errors).

1 added, 0 changed, 0 removed
    reading sources... [100%]
    index

Loaded Extensions
=================

* sphinx.ext.mathjax (9.1.0)
* alabaster (1.0.0)
* sphinxcontrib.applehelp (2.0.0)
* sphinxcontrib.devhelp (2.0.0)
* sphinxcontrib.htmlhelp (2.1.0)

* sphinxcontrib.serializinghtml (2.0.0)
* sphinxcontrib.qthelp (2.0.0)
* sphinx.ext.autodoc (9.1.0)
* sphinx_autodoc_typehints (unknown version)

Traceback
=========

      File "/usr/local/lib/python3.12/site-packages/sphinx/events.py", line 452, in emit
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x75e54944c900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)


The full traceback has been saved in:
/tmp/sphinx-err-fj93w9wc.log

To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

35:* sphinx_autodoc_typehints (unknown version)
36-
37-Traceback
38-=========
39-
40-    Traceback (most recent call last):
--
44:      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 752, in process_docstring
45-        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
46:      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 808, in _inject_types_to_docstring

Traceback (most recent call last):
      File "/usr/local/lib/python3.12/site-packages/sphinx/events.py", line 441, in emit
        results.append(listener.handler(self._app, *args))
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 752, in process_docstring
        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 808, in _inject_types_to_docstring
        _inject_signature(type_hints, signature, app, lines)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 820, in _inject_signature
        _inject_arg_signature(type_hints, signature, app, lines, arg_name)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 865, in _inject_arg_signature
        type_annotation = _append_defau

…[1466 chars omitted]…
d_doc
        doctree = _parse_str_to_doctree(
                  ^^^^^^^^^^^^^^^^^^^^^^
      File "/usr/local/lib/python3.12/site-packages/sphinx/util/docutils.py", line 902, in _parse_str_to_doctree
        parser.parse(content, document)
      File "/usr/local/lib/python3.12/site-packages/sphinx/parsers.py", line 99, in parse
        self.statemachine.run(inputlines, document, inliner=self.inliner)

"""Patch for attributes."""

from __future__ import annotations

from functools import partial
from typing import TYPE_CHECKING, Any
from unittest.mock import patch

import sphinx.domains.python
from sphinx.domains.python import PyAttribute

from ._parser import parse

if TYPE_CHECKING:
    from docutils.frontend import Values
    from sphinx.addnodes import desc_signature
    from sphinx.application import Sphinx

# Defensively check for the things we want to patch
_parse_annotation = getattr(sphinx.domains.python, "_parse_annotation", None)

# If we didn't locate the patch target, we will just do nothing.
OKAY_TO_PATCH = bool(_parse_annotation)

# A label we inject to the type string so we know not to try to treat it as a
# type annotation
TYPE_IS_RST_LABEL = "--is-rst--"

orig_handle_signature = PyAttribute.handle_signature


def rst_to_docutils(settings: Values, rst: str) -> Any:

…[808 chars omitted]…
state.document.settings)
    with patch(target, new_func):
        return orig_handle_signature(self, sig, signode)


def patch_attribute_handling(app: Sphinx) -> None:  # noqa: ARG001
    """Patch PyAttribute.handle_signature to format class attribute type annotations."""
    if not OKAY_TO_PATCH:
        return
    PyAttribute.handle_signature = patched_handle_signature  # type:ignore[method-assign]

IndexError: list index out of range

IndexError: list index out of range

pickling environment... done
checking consistency... done
preparing documents... done
copying assets... 
copying static files... 
Writing evaluated template result to /tmp/repro/_out/_static/language_data.js
Writing evaluated template result to /tmp/repro/_out/_static/basic.css
Writing evaluated template result to /tmp/repro/_out/_static/documentation_options.js
Writing evaluated template result to /tmp/repro/_out/_static/alabaster.css
copying static files: done
copying extra files... 
copying extra files: done

copying assets: done
writing output... [100%] index

generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 1 warning (with warnings treated as errors).

updating environment: [new config] 1 added, 0 changed, 0 removed
reading sources... [100%] index

WARNING: error while formatting signature for mymod.Point.__new__: Handler <function process_signature at 0x734ca838c180> for event 'autodoc-process-signature' threw an exception (exception: 'NoneType' object has no attribute 'Point') [autodoc]
--
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 1 warning.

367:def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
368-    app: Sphinx,
369-    what: str,
370-    name: str,
371-    obj: Any,
372-    options: Options,  # noqa: ARG001
373-    signature: str,  # noqa: ARG001
374-    return_annotation: str,  # noqa: ARG001
375-) -> tuple[str, None] | None:
376-    """
377-    Process the signature.
378-

379-    :param app:
380-    :param what:
381-    :param name:
382-    :param obj:
383-    :param options:
384-    :param signature:
385-    :param return_annotation:
386-    :return:
387-    """
388-    if not callable(obj):
389-        return None
390-
391-    original_obj = obj
392-    obj = getattr(obj, "__init__", getattr(obj, "__new__", None)) if inspect.isclass(obj) else obj
393-    if not getattr(obj, "__annotations__", None):  # when has no annotation we cannot autodoc typehints so bail
394-        return None
395-
396-    try
…[773 chars omitted]…
ches(app)
1107-    return {"parallel_read_safe": True, "parallel_write_safe": True}
1108-
1109-
1110-__all__ = [
1111-    "__version__",
1112-    "backfill_type_hints",
1113-    "format_annotation",
1114-    "get_annotation_args",
1115-    "get_annotation_class_name",
1116-    "get_annotation_module",
1117-    "normalize_source_lines",
1118-    "process_docstring",
1119:    "process_signature",
1120-]

sph_signature = sphinx_signature(obj, type_aliases=app.config["autodoc_type_aliases"])
    typehints_formatter: Callable[..., str | None] | None = getattr(app.config, "typehints_formatter", None)

    def _get_formatted_annotation(annotation: TypeVar) -> TypeVar:
        if typehints_formatter is None:
            return annotation
        formatted_name = typehints_formatter(annotation)
        return annotation if not isinstance(formatted_name, str) else TypeVar(formatted_name)

    if app.config.typehints_use_signature_return:
        sph_signature = sph_signature.replace(
            return_annotation=_get_formatted_annotation(sph_signature.return_annotation)

        )

    if app.config.typehints_use_signature:
        parameters = [
            param.replace(annotation=_get_formatted_annotation(param.annotation))
            for param in sph_signature.parameters.values()
   
…[2922 chars omitted]…
     File "/usr/local/lib/python3.12/site-packages/sphinx/parsers.py", line 99, in parse
        self.statemachine.run(inputlines, document, inliner=self.inliner)
      File "/usr/local/lib/python3.12/site-packages/docutils/parsers/rst/states.py", line 182, in run
        results = StateMachineWS.run(self, input_lines, input_offset,
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

build succeeded.

The HTML pages are in _out.
default: 
default:

mymod.func(a, b='x')¶
Docstring.

Parameters:

a (int)
b (str) – (default: 'x')


Return type:
None

class mymod.Point(x: int, y: int = 0)¶

class mymod.Point(x: int, y: int = 0)¶
A point.

Parameters:
x – x coord




static __new__(_cls, x: int, y: int = 0)¶
Create new instance of Point(x, y)

Parameters:

x (int)
y (int) – (default: 0)







x: int¶
Alias for field number 0




y: int¶

E               urllib.error.URLError: <urlopen error [Errno -3] Temporary failure in name resolution>

/usr/local/lib/python3.12/urllib/request.py:1347: URLError
=============================== warnings summary ===============================
tests/test_integration.py: 456 warnings
tests/test_integration_autodoc_type_aliases.py: 6 warnings
tests/test_integration_issue_384.py: 2 warnings
  /usr/local/lib/python3.12/site-packages/sphinx/ext/napoleon/docstring.py:361: RemovedInSphinx11Warning: The mapping interface for autodoc options objects is deprecated, and will be removed in Sphinx 11. Use attribute access instead.
    if options:

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================== short test summary info ============================

ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[str] - u...
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
216 passed, 464 warnings, 1 error in 14.00s

/usr/local/lib/python3.12/site-packages/sphinx/ext/napoleon/docstring.py:361: RemovedInSphinx11Warning: The mapping interface for autodoc options objects is deprecated, and will be removed in Sphinx 11. Use attribute access instead.
    if options:

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
256 passed, 90 deselected, 840 warnings in 19.95s
=========================== short test summary info ============================
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[str] - u...
1 error in 0.46s

diff --git a/src/sphinx_autodoc_typehints/__init__.py b/src/sphinx_autodoc_typehints/__init__.py
index 5c1d662..0d2a740 100644
--- a/src/sphinx_autodoc_typehints/__init__.py
+++ b/src/sphinx_autodoc_typehints/__init__.py
@@ -434,9 +434,16 @@ def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
                     subtype="local_function",
                 )
                 return None
-            outer = inspect.getmodule(obj)
-            for class_name in obj.__qualname__.split(".")[:-1]:
-                outer = getattr(outer, class_name)
+            outer = inspect.getmodule(obj) or inspect.getmodule(original_obj)

+            if outer is None:
+                return None
+            try:
+                for class_name in obj.__qualname__.split(".")[:-1]:
+                    outer = getattr(outer, class_name)
+            except AttributeError:
+                
…[587 chars omitted]…
           # The :param: line was just appended at the end of the docstring
+            # (always_document_param_types with no pre-existing description),
+            # so there is no following paragraph to append to; append to the
+            # newly added line itself.
+            append_index = nlines - 1
         lines[append_index] += formatted_default
 
     else:  # add to last param doc line

…[384 chars omitted]…
ith `-W`, defaults and param types rendered. Repo test suite passes (256 passed; pre-existing network-dependent `test_format_annotation` errors unrelated to change)."}
submitted.

LICENSE
README.md
ignore-words.txt
pyproject.toml
src
tests
tox.toml
whitelist.txt

/repo/src/sphinx_autodoc_typehints/attributes_patch.py
/repo/src/sphinx_autodoc_typehints/patches.py
/repo/src/sphinx_autodoc_typehints/version.py
/repo/src/sphinx_autodoc_typehints/_parser.py
/repo/src/sphinx_autodoc_typehints/__init__.py
conftest.py
roots
test_integration.py
test_integration_autodoc_type_aliases.py
test_integration_issue_384.py
test_sphinx_autodoc_typehints.py
test_version.py

/repo/src/sphinx_autodoc_typehints/__init__.py:58:    # NoneType is special, but included here for completeness' sake
/repo/src/sphinx_autodoc_typehints/__init__.py:59:    *("NoneType", "NotImplementedType"),
/repo/src/sphinx_autodoc_typehints/__init__.py:709:    if app.config.typehints_defaults == "braces-after":
/repo/src/sphinx_autodoc_typehints/__init__.py:1000:    if not app.config.typehints_document_rtype_none and type_hints["return"] is types.NoneType:
/repo/src/sphinx_autodoc_typehints/__init__.py:1035:    valid = {None, "comma", "braces", "braces-after"}

if len(args) != len(comment_args):
            _LOGGER.warning(
                'Not enough type comments found on "%s"', name, type="sphinx_autodoc_typehints", subtype="comment"
            )
            return rv

    for at, arg in enumerate(args):
        arg_key = getattr(arg, "arg", None)
        if arg_key is None:
            continue

        value = getattr(arg, "type_comment", None) if is_inline else comment_args[at]

        if value is not None:
            rv[arg_key] = value

    return rv


def load_args(obj_ast: FunctionDef) -> list[Any]:
    func_args = obj_ast.args
    args = []
    pos_only = getattr(func_args, "posonlyargs", None)
    if pos_only:
        args.extend(pos_only)

    args.extend(func_args.args)
    if func_args.vararg:
        args.append(func_args.vararg)

    args.extend(func_args.kwonlyargs)
    if func_args.kwarg:
        args.append(fun
…[2341 chars omitted]…
als = getattr(obj, "__globals__", {})  # noqa: SLF001
    try:
        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
    finally:
        delattr(app.config, "_annotation_globals")


def _get_sphinx_line_keyword_and_argument(line: str) -> tuple[str, str | None] | None:
    """
    Extract a keyword, and its optional argument out of a sphinx field option line.

700:def format_default(app: Sphinx, default: Any, is_annotated: bool) -> str | None:  # noqa: FBT001
752:        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
798:def _inject_types_to_docstring(  # noqa: PLR0913, PLR0917
863:            formatted_default = format_default(app, default, annotation is not None or has_preexisting_annotation)

def _inject_types_to_docstring(  # noqa: PLR0913, PLR0917
    type_hints: dict[str, Any],
    signature: inspect.Signature | None,
    original_obj: Any,
    app: Sphinx,
    what: str,
    name: str,
    lines: list[str],
) -> None:
    if signature is not None:
        _inject_signature(type_hints, signature, app, lines)
    if "return" in type_hints:

        _inject_rtype(type_hints, original_obj, app, what, name, lines)


def _inject_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
) -> None:
    for arg_name in signature.parameters:
        _inject_arg_signature(type_hints, signature, app, lines, arg_name)


def _inject_arg_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
    arg_name: str,
) -> None:
    annotation = type_hints.get(arg_name)

    
…[3543 chars omitted]…
nalysis of the
    docutils rst parser source code. An example where the node doesn't have a line number but the first child does is
    all `definition_list` nodes. It seems like bullet_list and option_list get line numbers, but enum_list also doesn't.
    """
    if node is None:
        return None

    while node.line is None and node.children:
        node = node.children[0]
    return node.line

test-dummy
test-integration
test-resolve-typing-guard
test-resolve-typing-guard-tmp

conf.py
from __future__ import annotations

import re
import sys
from dataclasses import dataclass
from inspect import isclass
from pathlib import Path
from textwrap import dedent, indent
from typing import (  # no type comments
    TYPE_CHECKING,
    Any,

    Literal,
    NewType,
    Optional,
    TypeVar,
    Union,
    overload,
)

import pytest

if TYPE_CHECKING:
    from collections.abc import AsyncGenerator, Callable
    from io import StringIO
    from mailbox import Mailbox
    from types import CodeType, ModuleType

    from sphinx.testing.util import SphinxTestApp

T = TypeVar("T")
W = NewType("W", str)


@dataclass
class WarningInfo:
    """Properties and assertion methods for warnings."""

    regexp: str
    type: str

    def assert_regexp(self, message: str) -> None:
        regexp = self.regexp
        msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: 
…[534 chars omitted]…
 = expected
        val.OPTIONS = options
        return val

    return dec


def warns(info: WarningInfo) -> Callable[[T], T]:
    def dec(val: T) -> T:
        val.WARNING = info
        return val

    return dec


@expected("mod.get_local_function()")
def get_local_function():  # noqa: ANN201
    def wrapper(self) -> str:  # noqa: ANN001
        """
        Wrapper
        """

    return wrapper

return wrapper


@warns(WarningInfo(regexp="Cannot handle as a local function", type="sphinx_autodoc_typehints.local_function"))
@expected(
    """\
class mod.Class(x, y, z=None)

   Initializer docstring.

   Parameters:
      * **x** ("bool") -- foo

      * **y** ("int") -- bar

      * **z** ("str" | "None") -- baz

   class InnerClass

      Inner class.

      inner_method(x)

         Inner method.

         Parameters:
            **x** ("bool") -- foo

         Return type:
            "str"

   classmethod a_classmethod(x, y, z=None)

      Classmethod docstring.

      Parameters:
         * **x** ("bool") -- foo

         * **y** ("int") -- bar

         * **z** ("str" | "None") -- baz

      Return type:
         "str"

   a_method(x, y, z=None)

      Method docstring.

      Parameters:
         * **x** ("bool") -- foo

         * **y** ("int") -- bar

         * **
…[1881 chars omitted]…
od(self, x: bool) -> str:
            """
            Inner method.

            :param x: foo
            """

        def __dunder_inner_method(self, x: bool) -> str:
            """
            Dunder inner method.

            :param x: foo
            """

    locally_defined_callable_field = get_local_function()


@expected(
    """\
exception mod.DummyException(message)

   Exception docstring

None.

Loaded Extensions
=================

None.

Traceback
=========

      File "/usr/local/lib/python3.12/site-packages/sphinx/events.py", line 387, in connect
        raise ExtensionError(msg % name)

    sphinx.errors.ExtensionError: Unknown event name: autodoc-process-signature


The full traceback has been saved in:
/tmp/sphinx-err-e8e_y256.log

To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 999, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/tmp/repro/mod.py", line 6, in <module>
    class Point(NamedTuple):
  File "/usr/local/lib/python3.12/typing.py", line 2841, in __new__
    raise AttributeError("Cannot overwrite NamedTuple attribute " + key)
AttributeError: Cannot overwrite NamedTuple attribute __new__

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 131, in _import_from_module_and_path
    module = _import_module(module_name, try_reload=True)
             ^^^^^^^^
…[1109 chars omitted]…
xec_module\n  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed\n  File "/tmp/repro/mod.py", line 6, in <module>\n    class Point(NamedTuple):\n  File "/usr/local/lib/python3.12/typing.py", line 2841, in __new__\n    raise AttributeError("Cannot overwrite NamedTuple attribute " + key)\nAttributeError: Cannot overwrite NamedTuple attribute __new__\n')
 [autodoc.import_object]

Extension error (sphinx_autodoc_typehints)!
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x78f573aa0900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

Traceback
=========

      File "/usr/local/lib/python3.12/site-packages/sphinx/events.py", line 452, in emit
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x791e40ec4900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)

Traceback (most recent call last):
  File "<stdin>", line 15, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 748, in process_docstring
    localns = {key: MyTypeAliasForwardRef(value) for key, value in app.config["autodoc_type_aliases"].items()}
                                                                   ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'FakeCfg' object is not subscriptable

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "<stdin>", line 17, in <module>
NameError: name 'traceback' is not defined. Did you forget to import 'traceback'?

Traceback (most recent call last):
  File "<stdin>", line 15, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 744, in process_docstring
    signature = sphinx_signature(obj, type_aliases=app.config["autodoc_type_aliases"])
                                                   ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
KeyError: 'autodoc_type_aliases'
[]

Traceback (most recent call last):
  File "<stdin>", line 15, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 752, in process_docstring
    _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 808, in _inject_types_to_docstring
    _inject_signature(type_hints, signature, app, lines)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 820, in _inject_signature
    _inject_arg_signature(type_hints, signature, app, lines, arg_name)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 858, in _inject_arg_signature
    format_annotation(annotation, app.config, short_literals=short_literals)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 225, in format_annotation
    formatted = typehints_formatter(annotation, config)

                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'dict' object is not callable
[':param x:']

IndexError: list index out of range
    
    The above exception was the direct cause of the following exception:
    
    Traceback (most recent call last):
      File "/usr/local/lib/python3.12/site-packages/sphinx/cmd/build.py", line 432, in build_main
        app.build(args.force_all, args.filenames)
      File "/usr/local/lib/python3.12/site-packages/sphinx/application.py", line 442, in build
        self.builder.build_update()
      File "/usr/local/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 381, in build_update
        self.build(
      File "/usr/local/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 409, in build

        updated_docnames = set(self.read())
                               ^^^^^^^^^^^
      File "/usr/local/lib/python3.12/site-packages/sphinx/builders/__init__.py", line 525, in read
        self._read_serial(docnames)
    
…[1163 chars omitted]…
x73d044f98900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)


The full traceback has been saved in:
/tmp/sphinx-err-xha1h619.log

To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

* sphinx_autodoc_typehints (unknown version)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 752, in process_docstring
        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 808, in _inject_types_to_docstring
        _inject_signature(type_hints, signature, app, lines)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 820, in _inject_signature
        _inject_arg_signature(type_hints, signature, app, lines, arg_name)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 865, in _inject_arg_signature
        type_annotation = _append_default(app, lines, insert_index, type_annotation, formatted_default)
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 893, in _append_default

return line, True
    return type_annotation, False


def _append_default(
    app: Sphinx, lines: list[str], insert_index: int, type_annotation: str, formatted_default: str
) -> str:
    if app.config.typehints_defaults.endswith("after"):
        # advance the index to the end of the :param: paragraphs
        # (terminated by a line with no indentation)
        # append default to the last nonempty line
        nlines = len(lines)

        next_index = insert_index + 1
        append_index = insert_index  # last nonempty line
        while next_index < nlines and (not lines[next_index] or lines[next_index].startswith(" ")):
            if lines[next_index]:
                append_index = next_index
            next_index += 1
        lines[append_index] += formatted_default

    else:  # add to last param doc line
        type_annotation += formatted_default

    return type_annotation

1
WARNING: error while formatting signature for mod.Point.__new__: Handler <function process_signature at 0x7419122e8180> for event 'autodoc-process-signature' threw an exception (exception: 'NoneType' object has no attribute 'Point') [autodoc]
build succeeded, 1 warning.

grep: /repo/src/sphinx_autodoc_typehints/__pycache__/__init__.cpython-312.pyc: binary file matches
/repo/src/sphinx_autodoc_typehints/__init__.py:367:def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
/repo/src/sphinx_autodoc_typehints/__init__.py:1098:    app.connect("autodoc-process-signature", process_signature)
/repo/src/sphinx_autodoc_typehints/__init__.py:1113:    "process_signature",

def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
    app: Sphinx,
    what: str,
    name: str,
    obj: Any,
    options: Options,  # noqa: ARG001
    signature: str,  # noqa: ARG001
    return_annotation: str,  # noqa: ARG001
) -> tuple[str, None] | None:
    """
    Process the signature.

    :param app:
    :param what:
    :param name:
    :param obj:
    :param options:
    :param signature:
    :param return_annotation:
    :return:
    """
    if not callable(obj):
        return None

    original_obj = obj
    obj = getattr(obj, "__init__", getattr(obj, "__new__", None)) if inspect.isclass(obj) else obj
    if not getattr(obj, "__annotations__", None):  # when has no annotation we cannot autodoc typehints so bail
        return None

    try:
        obj = inspect.unwrap(obj)
    except ValueError:
        return None
    sph_signature = sphinx_signature(obj,
…[3127 chars omitted]…
annot be replaced by a call to
    # `dataclasses.is_dataclass()` => check manually for either generated __init__ or generated class
    return (what == "method" and name.endswith(".__init__")) or (what == "class" and qualname.endswith(".__init__"))


def _future_annotations_imported(obj: Any) -> bool:
    annotations_ = getattr(inspect.getmodule(obj), "annotations", None)
    if annotations_ is None:

<function Point.__new__ at 0x785ca9ab3880> namedtuple_Point Point.__new__ __new__
None

Versions
========

* Platform:         linux; (Linux-6.18.33.2-microsoft-standard-WSL2-x86_64-with-glibc2.41)
* Python version:   3.12.13 (CPython)
* Sphinx version:   9.1.0
* Docutils version: 0.22.4
* Jinja2 version:   3.1.6
* Pygments version: 2.21.0

Last Messages
=============

    building [mo]: targets for 0 po files that are out of date
    writing output...

    building [html]: targets for 1 source files that are out of date
    updating environment:
    [new config]
    1 added, 0 changed, 0 removed
    reading sources... [100%]
    index

Loaded Extensions
=================

* sphinx.ext.mathjax (9.1.0)
* alabaster (1.0.0)
* sphinxcontrib.applehelp (2.0.0)
* sphinxcontrib.devhelp (2.0.0)
* sphinxcontrib.htmlhelp (2.1.0)
* sphinxcontrib.serializinghtml (2.0.0)
* sphinxcontrib.qthelp (2.0.0)
* sphinx.ext.autodoc (9.1.0)
* sphinx_autodoc_typehints (unknown version)

Traceback
…[880 chars omitted]…
pe_annotation = _append_default(app, lines, insert_index, type_annotation, formatted_default)
                          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
      File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 893, in _append_default
        lines[append_index] += formatted_default
        ~~~~~^^^^^^^^^^^^^^
    IndexError: list index out of range

/repo/tests/test_sphinx_autodoc_typehints.py:583:@pytest.mark.parametrize("always_document_param_types", [True, False], ids=["doc_param_type", "no_doc_param_type"])
/repo/tests/test_sphinx_autodoc_typehints.py:586:def test_always_document_param_types(
/repo/tests/test_sphinx_autodoc_typehints.py:590:    always_document_param_types: bool,
/repo/tests/test_sphinx_autodoc_typehints.py:594:    app.config.always_document_param_types = always_document_param_types  # create flag
/repo/tests/test_sphinx_autodoc_typehints.py:620:        if always_document_param_types:
/repo/tests/test_sphinx_autodoc_typehints.py:882:        always_document_param_types=True,

@pytest.mark.parametrize("always_document_param_types", [True, False], ids=["doc_param_type", "no_doc_param_type"])
@pytest.mark.sphinx("text", testroot="dummy")
@patch("sphinx.writers.text.MAXWIDTH", 2000)
def test_always_document_param_types(
    app: SphinxTestApp,
    status: StringIO,
    warning: StringIO,
    always_document_param_types: bool,
) -> None:
    set_python_path()

    app.config.always_document_param_types = always_document_param_types  # create flag

    app.config.autodoc_mock_imports = ["mailbox"]  # create flag

    # Prevent "document isn't included in any toctree" warnings
    for f in Path(app.srcdir).glob("*.rst"):
        f.unlink()
    (Path(app.srcdir) / "index.rst").write_text(
        dedent(
            """
            .. autofunction:: dummy_module.undocumented_function

            .. autoclass:: dummy_module.DataClass
                :undoc-members:
…[3458 chars omitted]…

    app.config.master_doc = "simple_no_use_rtype"  # create flag
    app.config.typehints_use_rtype = False
    app.build()
    assert "build succeeded" in status.getvalue()
    text_path = Path(app.srcdir) / "_build" / "text" / "simple_no_use_rtype.txt"
    text_contents = text_path.read_text().replace("–", "--")  # noqa: RUF001 # keep ambiguous EN DASH
    expected_contents = """\
    Simple Module

95f8036 base
tests/test_integration_issue_384.py:84:configs = {"default_conf": {"typehints_defaults": "braces-after"}}
tests/test_sphinx_autodoc_typehints.py:718:        ("braces-after", '("int") -- bar (default: "1")'),

from __future__ import annotations

import re
import sys
from pathlib import Path
from textwrap import dedent, indent
from typing import TYPE_CHECKING, Any, NewType, TypeVar

import pytest

if TYPE_CHECKING:
    from collections.abc import Callable

    from io import StringIO

    from sphinx.testing.util import SphinxTestApp

T = TypeVar("T")
W = NewType("W", str)


def expected(expected: str, **options: dict[str, Any]) -> Callable[[T], T]:
    def dec(val: T) -> T:
        val.EXPECTED = expected
        val.OPTIONS = options
        return val

    return dec


def warns(pattern: str) -> Callable[[T], T]:
    def dec(val: T) -> T:
        val.WARNING = pattern
        return val

    return dec


@expected(
    """\
mod.function(x=5, y=10, z=15)

   Function docstring.

   Parameters:
      * **x** ("int") -- optional specifier line 2 (default: "5")

      * **y** ("int") --

     
…[1605 chars omitted]…
r}"
        assert re.search(regexp, value), msg
    else:
        assert not value

    result = (Path(app.srcdir) / "_build/text/index.txt").read_text()

    expected = val.EXPECTED
    try:
        assert result.strip() == dedent(expected).strip()
    except Exception:
        indented = indent(f'"""\n{result}\n"""', " " * 4)
        print(f"@expected(\n{indented}\n)\n")  # noqa: T201
        raise

if inspect.isclass(original_obj) or (what == "method" and name.endswith(".__init__")):
            start = 1
        elif what == "method":
            # bail if it is a local method as we cannot determine if first argument needs to be deleted or not
            if "<locals>" in obj.__qualname__ and not _is_dataclass(name, what, obj.__qualname__):
                _LOGGER.warning(
                    'Cannot handle as a local function: "%s" (use @functools.wraps)',
                    name,
                    type="sphinx_autodoc_typehints",
                    subtype="local_function",
                )
                return None

            outer = inspect.getmodule(obj)
            for class_name in obj.__qualname__.split(".")[:-1]:
                if outer is None:
                    break
                outer = getattr(outer, class_name, None)
            method_name = obj.__name__
            if method_name.startswith("__") and not method_name.endswith("__"):
                # when method starts with double underscore Python applies mangling -> prepend the class name
                method_name = f"_{obj.__qualname__.split('.')[-2]}{method_name}"

build succeeded.

The HTML pages are in _build.
 class mod.Point(x: int, y: int)¶ A point. static __new__(x, y)¶ Create new instance of Point(x, y) Parameters: x (int) y (int) 
 x: int¶ Alias for field number 0 
 y: int¶ Alias for field number 1 
 mod.f(x=3, y='a')¶ Docstring. Parameters: x (int) – (default: 3) y (str) – (default: 'a') Return type: None

E               urllib.error.URLError: <urlopen error [Errno -3] Temporary failure in name resolution>

/usr/local/lib/python3.12/urllib/request.py:1347: URLError
=============================== warnings summary ===============================
tests/test_integration.py: 456 warnings
tests/test_integration_autodoc_type_aliases.py: 6 warnings
tests/test_integration_issue_384.py: 2 warnings
  /usr/local/lib/python3.12/site-packages/sphinx/ext/napoleon/docstring.py:361: RemovedInSphinx11Warning: The mapping interface for autodoc options objects is deprecated, and will be removed in Sphinx 11. Use attribute access instead.
    if options:

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================== short test summary info ============================

ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[str] - u...
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
216 passed, 464 warnings, 1 error in 14.32s

ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Tuple-p]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Tuple-p-int]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Tuple-p-int-int]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Tuple-p-Ellipsis]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Annotated-metadata]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Required]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[NotRequired]
266 passed, 840 warnings, 80 errors in 38.14s

Saved working directory and index state WIP on master: 95f8036 base
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Required]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[NotRequired]
85 passed, 376 warnings, 80 errors in 23.51s
On branch master
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   src/sphinx_autodoc_typehints/__init__.py

no changes added to commit (use "git add" and/or "git commit -a")
Dropped refs/stash@{0} (1fe8540089b64b730857e5096228c71fcc062b7e)

…[318 chars omitted]…
ed with a Sphinx reproducer (build succeeds, no warnings, defaults and __new__ documented) and the repo test suite (only pre-existing network-related errors remain)."}
submitted.

LICENSE
README.md
ignore-words.txt
pyproject.toml
src
tests
tox.toml
whitelist.txt
/repo/src/sphinx_autodoc_typehints/__init__.py
/repo/tests/test_integration_issue_384.py
/repo/tests/test_sphinx_autodoc_typehints.py

367:def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
709:    if app.config.typehints_defaults == "braces-after":
714:def process_docstring(  # noqa: PLR0913, PLR0917
1035:    valid = {None, "comma", "braces", "braces-after"}
1098:    app.connect("autodoc-process-signature", process_signature)
1099:    app.connect("autodoc-process-docstring", process_docstring)
1112:    "process_docstring",
1113:    "process_signature",

aligned_suffix = [whitespace + remove_prefix(s, whitespace) for s in lines[idx + 1 :]]

    # Put it together again
    aligned_prefix.append(fn_def)
    return "\n".join(aligned_prefix + aligned_suffix)


def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
    app: Sphinx,
    what: str,
    name: str,
    obj: Any,

    options: Options,  # noqa: ARG001
    signature: str,  # noqa: ARG001
    return_annotation: str,  # noqa: ARG001
) -> tuple[str, None] | None:
    """
    Process the signature.

    :param app:
    :param what:
    :param name:
    :param obj:
    :param options:
    :param signature:
    :param return_annotation:
    :return:
    """
    if not callable(obj):
        return None

    original_obj = obj
    obj = getattr(obj, "__init__", getattr(obj, "__new__", None)) if inspect.isclass(obj) else obj
    if not getattr(obj, "__annotations__", None): 
…[5312 chars omitted]…
e):
        guarded_code = textwrap.dedent(part)
        try:
            try:
                with mock(autodoc_mock_imports):
                    exec(guarded_code, getattr(obj, "__globals__", obj.__dict__))  # noqa: S102
            except ImportError as exc:
                # ImportError might have occurred because the module has guarded code as well,
                # so we recurse on the module.

elif char in {"]", ")"}:
            brackets -= 1
        elif char == "," and brackets == 0:
            add(comment[start_arg_at:at])
            start_arg_at = at + 1

    add(comment[start_arg_at : at + 1])
    return result


def format_default(app: Sphinx, default: Any, is_annotated: bool) -> str | None:  # noqa: FBT001
    if default is inspect.Parameter.empty:

        return None
    formatted = repr(default).replace("\\", "\\\\")

    if is_annotated:
        if app.config.typehints_defaults.startswith("braces"):
            return f" (default: ``{formatted}``)"
        return f", default: ``{formatted}``"
    if app.config.typehints_defaults == "braces-after":
        return f" (default: ``{formatted}``)"
    return f"default: ``{formatted}``"


def process_docstring(  # noqa: PLR0913, PLR0917
    app: Sphinx,
    what: str,
    name: str,
    obj: Any,
    options:
…[960 chars omitted]…
als = getattr(obj, "__globals__", {})  # noqa: SLF001
    try:
        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
    finally:
        delattr(app.config, "_annotation_globals")


def _get_sphinx_line_keyword_and_argument(line: str) -> tuple[str, str | None] | None:
    """
    Extract a keyword, and its optional argument out of a sphinx field option line.

700:def format_default(app: Sphinx, default: Any, is_annotated: bool) -> str | None:  # noqa: FBT001
752:        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
798:def _inject_types_to_docstring(  # noqa: PLR0913, PLR0917
813:def _inject_signature(
823:def _inject_arg_signature(
863:            formatted_default = format_default(app, default, annotation is not None or has_preexisting_annotation)
986:def _inject_rtype(  # noqa: C901, PLR0913, PLR0917

def _inject_types_to_docstring(  # noqa: PLR0913, PLR0917
    type_hints: dict[str, Any],
    signature: inspect.Signature | None,
    original_obj: Any,
    app: Sphinx,
    what: str,
    name: str,
    lines: list[str],
) -> None:
    if signature is not None:
        _inject_signature(type_hints, signature, app, lines)
    if "return" in type_hints:

        _inject_rtype(type_hints, original_obj, app, what, name, lines)


def _inject_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
) -> None:
    for arg_name in signature.parameters:
        _inject_arg_signature(type_hints, signature, app, lines, arg_name)


def _inject_arg_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
    arg_name: str,
) -> None:
    annotation = type_hints.get(arg_name)

    
…[5954 chars omitted]…
0) if line_no else len(lines)
        if lines[at - 1]:  # skip if something on this line
            break
        return InsertIndexInfo(insert_index=at, found_directive=True)

    # 5. Otherwise, insert at end
    return InsertIndexInfo(insert_index=len(lines))


def _inject_rtype(  # noqa: C901, PLR0913, PLR0917
    type_hints: dict[str, Any],
    original_obj: Any,
    app: Sphinx,
    what: str,

conftest.py
roots
test_integration.py
test_integration_autodoc_type_aliases.py
test_integration_issue_384.py
test_sphinx_autodoc_typehints.py
test_version.py
from __future__ import annotations

import re
import sys
from pathlib import Path

from textwrap import dedent, indent
from typing import TYPE_CHECKING, Any, NewType, TypeVar

import pytest

if TYPE_CHECKING:
    from collections.abc import Callable
    from io import StringIO

    from sphinx.testing.util import SphinxTestApp

T = TypeVar("T")
W = NewType("W", str)


def expected(expected: str, **options: dict[str, Any]) -> Callable[[T], T]:
    def dec(val: T) -> T:
        val.EXPECTED = expected
        val.OPTIONS = options
        return val

    return dec


def warns(pattern: str) -> Callable[[T], T]:
    def dec(val: T) -> T:
        val.WARNING = pattern
        return val

    return dec


@expected(
    """\
mod.function(x=5, y=10, z=15)

   Function docstring.

   Parameters:
      * **x** ("int") -- optional specifier line 2 (default: "5")

      * **y** ("int") --

        another optional line 4

        second paragraph for y (default: "10")

      * **z** ("int") -- yet another optional s line 6 (default: "15")

   Returns:
      something

   Return type:
      bytes

from __future__ import annotations

import re
import shutil
import sys
from contextlib import suppress
from pathlib import Path
from typing import TYPE_CHECKING

import pytest
from sphobjinv import Inventory

if TYPE_CHECKING:
    from _pytest.config import Config

pytest_plugins = "sphinx.testing.fixtures"
collect_ignore = ["roots"]


@pytest.fixture(scope="session")
def inv(pytestconfig: Config) -> Inventory:
    cache_path = f"python{sys.version_info.major}.{sys.version_info.minor}/objects.inv"
    assert pytestconfig.cache is not None
    inv_dict = pytestconfig.cache.get(cache_path, None)
    if inv_dict is not None:
        return Inventory(inv_dict)

    url = f"https://docs.python.org/{sys.version_info.major}.{sys.version_info.minor}/objects.inv"
    inv = Inventory(url=url)
    pytestconfig.cache.set(cache_path, inv.json_dict())
    return inv


@pytest.fixture(autouse=True)

…[565 chars omitted]…
collection_path: Path, config: Config) -> bool | None:  # noqa: ARG001
    version_re = re.compile(r"_py(\d)(\d)\.py$")
    match = version_re.search(collection_path.name)
    if match:
        version = tuple(int(x) for x in match.groups())
        if sys.version_info < version:
            return True
    return None
test-dummy
test-integration
test-resolve-typing-guard
test-resolve-typing-guard-tmp

1536:def test_integration(

      inner_method(x)

         Inner method.

         Parameters:
            **x** ("bool") -- foo

         Return type:
            "str"

   classmethod a_classmethod(x, y, z=None)

      Classmethod docstring.

      Parameters:
         * **x** ("bool") -- foo

         * **y** ("int") -- bar

         * **z** ("str" | "None") -- baz

      Return type:
         "str"

   a_method(x, y, z=None)

      Method docstring.

      Parameters:
         * **x** ("bool") -- foo

         * **y** ("int") -- bar

         * **z** ("str" | "None") -- baz

      Return type:
         "str"

   property a_property: str

      Property docstring

   static a_staticmethod(x, y, z=None)

      Staticmethod docstring.

      Parameters:
         * **x** ("bool") -- foo

         * **y** ("int") -- bar

         * **z** ("str" | "None") -- baz

      Return type:
   
…[429 chars omitted]…
        :param x: foo
        :param y: bar
        :param z: baz
        """

    def _private_method(self, x: str) -> str:
        """
        Private method docstring.

        :param x: foo
        """

    def __dunder_method(self, x: str) -> str:
        """
        Dunder method docstring.

        :param x: foo
        """

    def __magic_custom_method__(self, x: str) -> str:  # noqa: PLW3201

def test_integration(
    app: SphinxTestApp, status: StringIO, warning: StringIO, monkeypatch: pytest.MonkeyPatch, val: Any, conf_run: str
) -> None:
    if isclass(val) and issubclass(val, BaseException):
        template = AUTO_EXCEPTION
    elif isclass(val):
        template = AUTO_CLASS
    else:
        template = AUTO_FUNCTION

    (Path(app.srcdir) / "index.rst").write_text(template.format(val.__name__))
    app.config.__dict__.update(configs[conf_run])

    app.config.__dict__.update(val.OPTIONS)
    app.config.always_use_bars_union = True
    monkeypatch.setitem(sys.modules, "mod", sys.modules[__name__])
    app.build()
    assert "build succeeded" in status.getvalue()  # Build succeeded

    warning_info: Union[WarningInfo, None] = getattr(val, "WARNING", None)
    value = warning.getvalue().strip()
    if warning_info:
        warning_info.assert_warning(value)
    else:
        assert not value

    result = (Path(app.srcdir) / "_build/text/index.txt").read_text()

    expected = val.EXPECTED
    try:
        assert result.strip() == dedent(expected).strip()
    except Exception:
        indented = indent(f'"""\n{result}\n"""', " " * 4)
        print(f"@expected(\n{indented}\n)\n")  # noqa: T201
        raise

File "<frozen importlib._bootstrap>", line 1331, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 935, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 999, in exec_module
  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed
  File "/tmp/repro/mod.py", line 6, in <module>
    class Point(NamedTuple):
  File "/usr/local/lib/python3.12/typing.py", line 2841, in __new__
    raise AttributeError("Cannot overwrite NamedTuple attribute " + key)
AttributeError: Cannot overwrite NamedTuple attribute __new__

The above exception was the direct cause of the following exception:

Traceback (most recent call last):
  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 131, in _import_from_module_and_path
    module = _import_module(module_name, try_reload=True)
             ^^^^^^^^
…[1116 chars omitted]…
ule\n  File "<frozen importlib._bootstrap>", line 488, in _call_with_frames_removed\n  File "/tmp/repro/mod.py", line 6, in <module>\n    class Point(NamedTuple):\n  File "/usr/local/lib/python3.12/typing.py", line 2841, in __new__\n    raise AttributeError("Cannot overwrite NamedTuple attribute " + key)\nAttributeError: Cannot overwrite NamedTuple attribute __new__\n')
 [autodoc.import_object]
EXIT=0

Extension error (sphinx_autodoc_typehints)!
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x7f5954504900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.
---
cat: _build/text/index.txt: No such file or directory

Traceback
=========

      File "/usr/local/lib/python3.12/site-packages/sphinx/events.py", line 452, in emit
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x7f11239d4900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)

Traceback
=========

      File "/usr/local/lib/python3.12/site-packages/sphinx/events.py", line 452, in emit
        raise ExtensionError(

Traceback (most recent call last):
  File "<stdin>", line 6, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 748, in process_docstring
    localns = {key: MyTypeAliasForwardRef(value) for key, value in app.config["autodoc_type_aliases"].items()}
                                                                   ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'C' object is not subscriptable

Traceback (most recent call last):
  File "<stdin>", line 11, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 749, in process_docstring
    type_hints = get_all_type_hints(app.config.autodoc_mock_imports, obj, name, localns)
                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
AttributeError: 'C' object has no attribute 'autodoc_mock_imports'

Traceback (most recent call last):
  File "<stdin>", line 12, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 752, in process_docstring
    _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 808, in _inject_types_to_docstring
    _inject_signature(type_hints, signature, app, lines)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 820, in _inject_signature
    _inject_arg_signature(type_hints, signature, app, lines, arg_name)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 865, in _inject_arg_signature
    type_annotation = _append_default(app, lines, insert_index, type_annotation, formatted_default)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 893, in _append_default

    lines[append_index] += formatted_default
    ~~~~~^^^^^^^^^^^^^^
IndexError: list index out of range

Application error!
        raise ApplicationError(
    sphinx.errors.ApplicationError: Cannot find source directory (/tmp/repro/index2.rst)
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

Configuration error!
        raise ConfigError(
    sphinx.errors.ConfigError: config directory doesn't contain a conf.py file (/tmp/repro/src2)
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

WARNING: error while formatting signature for mod2.Point.__new__: Handler <function process_signature at 0x778169010180> for event 'autodoc-process-signature' threw an exception (exception: 'NoneType' object has no attribute 'Point') [autodoc]
build succeeded, 1 warning.

<function Point.__new__ at 0x754d1be26480> True
None
Point.__new__ __new__
{'x': <class 'int'>, 'y': <class 'int'>}

src/sphinx_autodoc_typehints/__init__.py | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

build succeeded, 7 warnings.

The text files are in _build.
===
build succeeded.

The text files are in _b2.
===
cat: _build/text/index.txt: No such file or directory
===

ls: cannot access '_build/text': No such file or directory
cat: '_build/text/*.txt': No such file or directory

loading translations [en]... done
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output... 
building [text]: targets for 3 source files that are out of date
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [ 33%] index
reading sources... [ 67%] index2
reading sources... [100%] src2/index

<unknown>:1: WARNING: duplicate object description of mod2, other instance in index2, use :no-index: for one of them
<unknown>:1: WARNING: duplicate object description of mod2.Point, other instance in index2, use :no-index: for one of them

<unknown>:1: WARNING: duplicate object description of mod2.Point.__new__, other instance in index2, use :no-index: for one of them
<unknown>:1: WARNING: duplicate object description of mod2.Point.x, other instance in index2, use :no-index: for one of them
<unknown>:1: WARNING: du
…[211 chars omitted]…
ndex2.rst: WARNING: document isn't included in any toctree [toc.not_included]
/tmp/repro/src2/index.rst: WARNING: document isn't included in any toctree [toc.not_included]
done
preparing documents... done
copying assets... 
copying assets: done
writing output... [ 33%] index
writing output... [ 67%] index2
writing output... [100%] src2/index

build succeeded, 7 warnings.

The text files are in _build.

build succeeded.

The text files are in _build.
cat: _build/text/index.txt: No such file or directory

_build/index.txt
class mod.Point(x, y)

   static __new__(_cls, x: int, y: int)

      Create new instance of Point(x, y)

      Parameters:
         * **x** ("int")

         * **y** ("int")

   x: int

      Alias for field number 0

   y: int

      Alias for field number 1

mod.f(x=3, y='a')

   Docstring.

   Parameters:
      * **x** ("int" (default: "3"))

      * **y** ("str" (default: "'a'"))

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================== short test summary info ============================
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[str] - u...
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
216 passed, 464 warnings, 1 error in 13.48s

ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Tuple-p-Ellipsis]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Annotated-metadata]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Required]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[NotRequired]
266 passed, 840 warnings, 80 errors in 38.17s

proxy_auth_hdr = "Proxy-Authorization"
            if proxy_auth_hdr in headers:
                tunnel_headers[proxy_auth_hdr] = headers[proxy_auth_hdr]
                # Proxy-Authorization should not be sent to origin
                # server.
                del headers[proxy_auth_hdr]
            h.set_tunnel(req._tunnel_host, headers=tunnel_headers)
    
        try:
            try:
                h.request(req.get_method(), req.selector, req.data, headers,
                          encode_chunked=req.has_header('Transfer-encoding'))

            except OSError as err: # timeout error
>               raise URLError(err)
E               urllib.error.URLError: <urlopen error [Errno -3] Temporary failure in name resolution>

/usr/local/lib/python3.12/urllib/request.py:1347: URLError
=========================== short test summary info ============================
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[str] - u...
1 error in 0.51s

…[417 chars omitted]…
dalone Sphinx reproducers (build succeeds, defaults rendered as \"(default: ...)\"), and repo test suite passes (only pre-existing network-dependent fixture errors)."}
submitted.

LICENSE
README.md
ignore-words.txt
pyproject.toml
src
tests
tox.toml
whitelist.txt

/repo/src/sphinx_autodoc_typehints/attributes_patch.py
/repo/src/sphinx_autodoc_typehints/patches.py
/repo/src/sphinx_autodoc_typehints/version.py
/repo/src/sphinx_autodoc_typehints/_parser.py
/repo/src/sphinx_autodoc_typehints/__init__.py
conftest.py
roots
test_integration.py
test_integration_autodoc_type_aliases.py
test_integration_issue_384.py
test_sphinx_autodoc_typehints.py
test_version.py

706:        if app.config.typehints_defaults.startswith("braces"):
709:    if app.config.typehints_defaults == "braces-after":
1035:    valid = {None, "comma", "braces", "braces-after"}

if len(args) != len(comment_args):
            _LOGGER.warning(
                'Not enough type comments found on "%s"', name, type="sphinx_autodoc_typehints", subtype="comment"
            )
            return rv

    for at, arg in enumerate(args):
        arg_key = getattr(arg, "arg", None)
        if arg_key is None:
            continue

        value = getattr(arg, "type_comment", None) if is_inline else comment_args[at]

        if value is not None:
            rv[arg_key] = value

    return rv


def load_args(obj_ast: FunctionDef) -> list[Any]:
    func_args = obj_ast.args
    args = []
    pos_only = getattr(func_args, "posonlyargs", None)
    if pos_only:
        args.extend(pos_only)

    args.extend(func_args.args)
    if func_args.vararg:
        args.append(func_args.vararg)

    args.extend(func_args.kwonlyargs)
    if func_args.kwarg:
        args.append(fun
…[3103 chars omitted]…
ne_without_description) != 3:  # noqa: PLR2004
        return None

    split_directive_and_name = param_line_without_description[1].split(maxsplit=1)
    if len(split_directive_and_name) != 2:  # noqa: PLR2004
        if not len(split_directive_and_name):
            return None
        return split_directive_and_name[0], None

    return tuple(split_directive_and_name)  # type: ignore[return-value]

58:    # NoneType is special, but included here for completeness' sake
59:    *("NoneType", "NotImplementedType"),
367:def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
752:        _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
798:def _inject_types_to_docstring(  # noqa: PLR0913, PLR0917
813:def _inject_signature(
823:def _inject_arg_signature(
986:def _inject_rtype(  # noqa: C901, PLR0913, PLR0917
1000:    if not app.config.typehints_document_rtype_none and type_hints["return"] is types.NoneType:
1098:    app.connect("autodoc-process-signature", process_signature)
1113:    "process_signature",

def _inject_types_to_docstring(  # noqa: PLR0913, PLR0917
    type_hints: dict[str, Any],
    signature: inspect.Signature | None,
    original_obj: Any,
    app: Sphinx,
    what: str,
    name: str,
    lines: list[str],
) -> None:
    if signature is not None:
        _inject_signature(type_hints, signature, app, lines)
    if "return" in type_hints:

        _inject_rtype(type_hints, original_obj, app, what, name, lines)


def _inject_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
) -> None:
    for arg_name in signature.parameters:
        _inject_arg_signature(type_hints, signature, app, lines, arg_name)


def _inject_arg_signature(
    type_hints: dict[str, Any],
    signature: inspect.Signature,
    app: Sphinx,
    lines: list[str],
    arg_name: str,
) -> None:
    annotation = type_hints.get(arg_name)

    
…[2454 chars omitted]…
 insert_index  # last nonempty line
        while next_index < nlines and (not lines[next_index] or lines[next_index].startswith(" ")):
            if lines[next_index]:
                append_index = next_index
            next_index += 1
        lines[append_index] += formatted_default

    else:  # add to last param doc line
        type_annotation += formatted_default

    return type_annotation

def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
    app: Sphinx,
    what: str,
    name: str,
    obj: Any,
    options: Options,  # noqa: ARG001
    signature: str,  # noqa: ARG001
    return_annotation: str,  # noqa: ARG001
) -> tuple[str, None] | None:
    """
    Process the signature.

    :param app:
    :param what:
    :param name:
    :param obj:
    :param options:
    :param signature:
    :param return_annotation:
    :return:
    """
    if not callable(obj):
        return None

    original_obj = obj
    obj = getattr(obj, "__init__", getattr(obj, "__new__", None)) if inspect.isclass(obj) else obj
    if not getattr(obj, "__annotations__", None):  # when has no annotation we cannot autodoc typehints so bail
        return None

    try:
        obj = inspect.unwrap(obj)
    except ValueError:
        return None
    sph_signature = sphinx_signature(obj,
…[5102 chars omitted]…
e):
        guarded_code = textwrap.dedent(part)
        try:
            try:
                with mock(autodoc_mock_imports):
                    exec(guarded_code, getattr(obj, "__globals__", obj.__dict__))  # noqa: S102
            except ImportError as exc:
                # ImportError might have occurred because the module has guarded code as well,
                # so we recurse on the module.

test-dummy
test-integration
test-resolve-typing-guard
test-resolve-typing-guard-tmp

conf.py
from __future__ import annotations

import re
import sys
from dataclasses import dataclass
from inspect import isclass
from pathlib import Path
from textwrap import dedent, indent
from typing import (  # no type comments
    TYPE_CHECKING,
    Any,

    Literal,
    NewType,
    Optional,
    TypeVar,
    Union,
    overload,
)

import pytest

if TYPE_CHECKING:
    from collections.abc import AsyncGenerator, Callable
    from io import StringIO
    from mailbox import Mailbox
    from types import CodeType, ModuleType

    from sphinx.testing.util import SphinxTestApp

T = TypeVar("T")
W = NewType("W", str)


@dataclass
class WarningInfo:
    """Properties and assertion methods for warnings."""

    regexp: str
    type: str

    def assert_regexp(self, message: str) -> None:
        regexp = self.regexp
        msg = f"Regex pattern did not match.\n Regex: {regexp!r}\n Input: 
…[1973 chars omitted]…
str(Path(__file__).parent) or ".").absolute() / "roots"


def pytest_ignore_collect(collection_path: Path, config: Config) -> bool | None:  # noqa: ARG001
    version_re = re.compile(r"_py(\d)(\d)\.py$")
    match = version_re.search(collection_path.name)
    if match:
        version = tuple(int(x) for x in match.groups())
        if sys.version_info < version:
            return True
    return None

* Platform:         linux; (Linux-6.18.33.2-microsoft-standard-WSL2-x86_64-with-glibc2.41)
* Python version:   3.12.13 (CPython)
* Sphinx version:   9.1.0
* Docutils version: 0.22.4
* Jinja2 version:   3.1.6
* Pygments version: 2.21.0

Last Messages
=============

None.

Loaded Extensions
=================

None.

Traceback
=========

      File "/usr/local/lib/python3.12/site-packages/sphinx/events.py", line 387, in connect
        raise ExtensionError(msg % name)
    sphinx.errors.ExtensionError: Unknown event name: autodoc-process-signature


The full traceback has been saved in:
/tmp/sphinx-err-t1gubpfi.log

To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

9:name = "sphinx-autodoc-typehints"
43:  "sphinx>=9.1",
51:  "defusedxml>=0.7.1",       # required by sphinx.testing
58:urls.Changelog = "https://github.com/tox-dev/sphinx-autodoc-typehints/releases"
59:urls.Homepage = "https://github.com/tox-dev/sphinx-autodoc-typehints"
60:urls.Source = "https://github.com/tox-dev/sphinx-autodoc-typehints"
61:urls.Tracker = "https://github.com/tox-dev/sphinx-autodoc-typehints/issues"
64:build.hooks.vcs.version-file = "src/sphinx_autodoc_typehints/version.py"
81:  "DOC",    # no sphinx support
101:  "sphinx_autodoc_typehints",
Name: Sphinx
Version: 9.1.0

Summary: Python documentation generator
ERROR: Pipe to stdout was broken
0079915 base

return [n], []


def setup(app: Sphinx) -> dict[str, bool]:
    app.add_config_value("always_document_param_types", False, "html")  # noqa: FBT003
    app.add_config_value("typehints_fully_qualified", False, "env")  # noqa: FBT003
    app.add_config_value("typehints_document_rtype", True, "env")  # noqa: FBT003
    app.add_config_value("typehints_document_rtype_none", True, "env")  # noqa: FBT003
    app.add_config_value("typehints_use_rtype", True, "env")  # noqa: FBT003
    app.add_config_value("typehints_defaults", None, "env")
    app.add_config_value("simplify_optional_unions", True, "env")  # noqa: FBT003
    app.add_config_value("always_use_bars_union", False, "env")  # noqa: FBT003

    app.add_config_value("typehints_formatter", None, "env")
    app.add_config_value("typehints_use_signature", False, "env")  # noqa: FBT003
    app.add_config_value("typehints_use_signature_r
…[640 chars omitted]…
 "get_annotation_class_name",
    "get_annotation_module",
    "normalize_source_lines",
    "process_docstring",
    "process_signature",
]
/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/__init__.py:201:    app.add_event('autodoc-process-signature')
/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/__init__.py:253:        app.connect('autodoc-process-signature', record_typehints)

Traceback (most recent call last):
  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 131, in _import_from_module_and_path
    module = _import_module(module_name, try_reload=True)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 233, in _import_module
    raise ImportError(exc, traceback.format_exc()) from exc
ImportError: (NameError("name '__new__' is not defined"), 'Traceback (most recent call last):\n  File "/usr/local/lib/python3.12/site-packages/sphinx/ext/autodoc/_dynamic/_importer.py", line 221, in _import_module\n    module = importlib.import_module(modname)\n             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n  File "/usr/local/lib/python3.12/importlib/__init__.py", line 90, in import_module\n    return _bootstrap._gcd_import(name[
…[1258 chars omitted]…
o /tmp/repro/out/_static/alabaster.css
copying static files: done
copying extra files... 
copying extra files: done

copying assets: done
writing output... [100%] index

generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 2 warnings (with warnings treated as errors).

Extension error (sphinx_autodoc_typehints)!
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x7d96576d0900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

Traceback (most recent call last):
  File "<stdin>", line 7, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 748, in process_docstring
    localns = {key: MyTypeAliasForwardRef(value) for key, value in app.config["autodoc_type_aliases"].items()}
                                                                   ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'C' object is not subscriptable

Traceback (most recent call last):
  File "<stdin>", line 16, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 752, in process_docstring
    _inject_types_to_docstring(type_hints, signature, original_obj, app, what, name, lines)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 808, in _inject_types_to_docstring
    _inject_signature(type_hints, signature, app, lines)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 820, in _inject_signature
    _inject_arg_signature(type_hints, signature, app, lines, arg_name)
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 865, in _inject_arg_signature
    type_annotation = _append_default(app, lines, insert_index, type_annotation, formatted_default)
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 893, in _append_default

    lines[append_index] += formatted_default
    ~~~~~^^^^^^^^^^^^^^
IndexError: list index out of range
[':param a:', ':type a: :sphinx_autodoc_typehints_type:`\\:py\\:class\\:\\`int\\``', ':param b:']

Extension error (sphinx_autodoc_typehints)!
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x73adc1ed8900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.
---
Extension error (sphinx_autodoc_typehints)!
        raise ExtensionError(
    sphinx.errors.ExtensionError: Handler <function process_docstring at 0x7d833c224900> for event 'autodoc-process-docstring' threw an exception (exception: list index out of range)
To report this error to the developers, please open an issue at <https://github.com/sphinx-doc/sphinx/issues/>. Thanks!
Please also report this if it was a user error, so that a better error message can be provided next time.

[':param x:', ':type x: :sphinx_autodoc_typehints_type:`\\:py\\:class\\:\\`int\\``', ':param y:', ':type y: :sphinx_autodoc_typehints_type:`\\:py\\:class\\:\\`int\\``']

Traceback (most recent call last):
  File "<stdin>", line 13, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 400, in process_signature
    sph_signature = sphinx_signature(obj, type_aliases=app.config["autodoc_type_aliases"])
                                                       ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'C' object is not subscriptable
class None

Traceback (most recent call last):
  File "<stdin>", line 13, in <module>
  File "/repo/src/sphinx_autodoc_typehints/__init__.py", line 400, in process_signature
    sph_signature = sphinx_signature(obj, type_aliases=app.config["autodoc_type_aliases"])
                                                       ~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: 'NoneType' object is not subscriptable
class None

WARNING: error while formatting signature for mod.Point.__new__: Handler <function process_signature at 0x72549af9c5e0> for event 'autodoc-process-signature' threw an exception (exception: 'NoneType' object has no attribute 'Point') [autodoc]
build finished with problems, 1 warning (with warnings treated as errors).

<function Point.__new__ at 0x75bc414e25c0> namedtuple_Point Point.__new__ __new__
None

exit=1
['<span class="sig-prename descclassname"><span class="pre">mod.</span></span><span class="sig-name descname"><span class="pre">f</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">a</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">b</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">\'x\'</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mod.f" title="Link to this definition">¶</a></dt>', '<li><p><strong>b</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – (default: <code class="docutils literal notranslate"><span class="pre">\'x\'</span></code>)</p></li>', '<span class="property"><span class="k"><span class="
…[837 chars omitted]…
ass="w"> </span></span><span class="sig-name descname"><span class="pre">__new__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">x</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">y</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#mod.Point.__new__" title="Link to this definition">¶</a></dt>']

E               urllib.error.URLError: <urlopen error [Errno -3] Temporary failure in name resolution>

/usr/local/lib/python3.12/urllib/request.py:1347: URLError
=============================== warnings summary ===============================
tests/test_integration.py: 456 warnings
tests/test_integration_autodoc_type_aliases.py: 6 warnings
tests/test_integration_issue_384.py: 2 warnings
  /usr/local/lib/python3.12/site-packages/sphinx/ext/napoleon/docstring.py:361: RemovedInSphinx11Warning: The mapping interface for autodoc options objects is deprecated, and will be removed in Sphinx 11. Use attribute access instead.
    if options:

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
=========================== short test summary info ============================

ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[str] - u...
!!!!!!!!!!!!!!!!!!!!!!!!!! stopping after 1 failures !!!!!!!!!!!!!!!!!!!!!!!!!!!
216 passed, 464 warnings, 1 error in 13.49s

ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Annotated-metadata]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[Required]
ERROR tests/test_sphinx_autodoc_typehints.py::test_format_annotation[NotRequired]
266 passed, 840 warnings, 80 errors in 35.89s
diff --git a/src/sphinx_autodoc_typehints/__init__.py b/src/sphinx_autodoc_typehints/__init__.py
index 5c1d662..2abaf2c 100644
--- a/src/sphinx_autodoc_typehints/__init__.py
+++ b/src/sphinx_autodoc_typehints/__init__.py
@@ -436,7 +436,9 @@ def process_signature(  # noqa: C901, PLR0912, PLR0913, PLR0917
                 return None
             outer = inspect.getmodule(obj)
             for class_name in obj.__qualname__.split(".")[:-1]:

-                outer = getattr(outer, class_name)
+                if outer is None:
+                    break
+                outer = getattr(outer, clas
…[189 chars omitted]…
rscore Python applies mangling -> prepend the class name
@@ -845,7 +847,7 @@ def _inject_arg_signature(
 
     if annotation is not None and insert_index is None and app.config.always_document_param_types:
         lines.append(f":param {arg_name}:")
-        insert_index = len(lines)
+        insert_index = len(lines) - 1
 
     if insert_index is not None:
         has_preexisting_annotation = False

400

…[197 chars omitted]…
ks on None and uses `getattr(..., None)`.\nReproducer sphinx build with -W now succeeds; full test suite passes (only pre-existing network-dependent fixture errors)."}
submitted.