IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Use a protocol for `RoleFunction` (#12513)

Browse Source
This commit is contained in:
Adam Turner 2024-07-06 19:41:53 +01:00 committed by GitHub
parent e63e2f3ccb
commit 59e95531b9
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 21 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
sphinx/ext/inheritance_diagram.py
View File

@ -385,7 +385,7 @@ class InheritanceDiagram(SphinxDirective):
# references to real URLs later. These nodes will eventually be # references to real URLs later. These nodes will eventually be
# removed from the doctree after we're done with them. # removed from the doctree after we're done with them.
for name in graph.get_all_class_names(): for name in graph.get_all_class_names():
refnodes, x = class_role( # type: ignore[call-arg,misc] refnodes, x = class_role( # type: ignore[misc]
'class', ':class:`%s`' % name, name, 0, self.state.inliner) 'class', ':class:`%s`' % name, name, 0, self.state.inliner)
node.extend(refnodes) node.extend(refnodes)
# Store the graph object so we can use it to generate the # Store the graph object so we can use it to generate the

25
sphinx/util/typing.py
View File

@ -24,7 +24,7 @@ from docutils.parsers.rst.states import Inliner
if TYPE_CHECKING: if TYPE_CHECKING:
from collections.abc import Mapping from collections.abc import Mapping
from typing import Final, Literal from typing import Final, Literal, Protocol
from docutils.parsers.rst.states import RSTState as _RSTStateGeneric from docutils.parsers.rst.states import RSTState as _RSTStateGeneric
from typing_extensions import TypeAlias, TypeIs from typing_extensions import TypeAlias, TypeIs
@ -95,10 +95,25 @@ NoneType = type(None)
PathMatcher = Callable[[str], bool] PathMatcher = Callable[[str], bool]
# common role functions # common role functions
RoleFunction = Callable[ if TYPE_CHECKING:
[str, str, str, int, Inliner, dict[str, Any], Sequence[str]], class RoleFunction(Protocol):
tuple[list[nodes.Node], list[nodes.system_message]], def __call__(
] self,
name: str,
rawtext: str,
text: str,
lineno: int,
inliner: Inliner,
/,
options: dict[str, Any] | None = None,
content: Sequence[str] = (),
) -> tuple[list[nodes.Node], list[nodes.system_message]]:
...
else:
RoleFunction = Callable[
[str, str, str, int, Inliner, dict[str, Any], Sequence[str]],
tuple[list[nodes.Node], list[nodes.system_message]],
]
# A option spec for directive # A option spec for directive
OptionSpec = dict[str, Callable[[str], Any]] OptionSpec = dict[str, Callable[[str], Any]]