Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(sphinx): Support python 3.9 in Sphinx rules #2208

Merged
merged 1 commit into from
Sep 9, 2024
Merged

fix(sphinx): Support python 3.9 in Sphinx rules #2208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions sphinxdocs/src/sphinx_bzl/bzl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
from sphinx.util import inspect, logging
from sphinx.util import nodes as sphinx_nodes
from sphinx.util import typing as sphinx_typing
from typing_extensions import override
from typing_extensions import override, TypeAlias

_logger = logging.getLogger(__name__)
_LOG_PREFIX = f"[{_logger.name}] "
Expand All @@ -46,10 +46,10 @@
_T = TypeVar("_T")

# See https://www.sphinx-doc.org/en/master/extdev/domainapi.html#sphinx.domains.Domain.get_objects
_GetObjectsTuple: typing.TypeAlias = tuple[str, str, str, str, str, int]
_GetObjectsTuple: TypeAlias = tuple[str, str, str, str, str, int]

# See SphinxRole.run definition; the docs for role classes are pretty sparse.
_RoleRunResult: typing.TypeAlias = tuple[
_RoleRunResult: TypeAlias = tuple[
list[docutils_nodes.Node], list[docutils_nodes.system_message]
]

Expand Down Expand Up @@ -126,9 +126,9 @@ def _index_node_tuple(
entry_type: str,
entry_name: str,
target: str,
main: str | None = None,
category_key: str | None = None,
) -> tuple[str, str, str, str | None, str | None]:
main: typing.Union[str, None] = None,
category_key: typing.Union[str, None] = None,
) -> tuple[str, str, str, typing.Union[str, None], typing.Union[str, None]]:
# For this tuple definition, see:
# https://www.sphinx-doc.org/en/master/extdev/nodes.html#sphinx.addnodes.index
# For the definition of entry_type, see:
Expand Down Expand Up @@ -339,10 +339,10 @@ def make_xrefs(
domain: str,
target: str,
innernode: type[sphinx_typing.TextlikeNode] = addnodes.literal_emphasis,
contnode: docutils_nodes.Node | None = None,
env: environment.BuildEnvironment | None = None,
inliner: states.Inliner | None = None,
location: docutils_nodes.Element | None = None,
contnode: typing.Union[docutils_nodes.Node, None] = None,
env: typing.Union[environment.BuildEnvironment, None] = None,
inliner: typing.Union[states.Inliner, None] = None,
location: typing.Union[docutils_nodes.Element, None] = None,
) -> list[docutils_nodes.Node]:
if rolename in ("arg", "attr"):
return self._make_xrefs_for_arg_attr(
Expand All @@ -359,10 +359,10 @@ def _make_xrefs_for_arg_attr(
domain: str,
arg_name: str,
innernode: type[sphinx_typing.TextlikeNode] = addnodes.literal_emphasis,
contnode: docutils_nodes.Node | None = None,
env: environment.BuildEnvironment | None = None,
inliner: states.Inliner | None = None,
location: docutils_nodes.Element | None = None,
contnode: typing.Union[docutils_nodes.Node, None] = None,
env: typing.Union[environment.BuildEnvironment, None] = None,
inliner: typing.Union[states.Inliner, None] = None,
location: typing.Union[docutils_nodes.Element, None] = None,
) -> list[docutils_nodes.Node]:
bzl_file = env.ref_context["bzl:file"]
anchor_prefix = ".".join(env.ref_context["bzl:doc_id_stack"])
Expand Down Expand Up @@ -445,8 +445,8 @@ def make_field(
domain: str,
item: tuple,
env: environment.BuildEnvironment = None,
inliner: states.Inliner | None = None,
location: docutils_nodes.Element | None = None,
inliner: typing.Union[states.Inliner, None] = None,
location: typing.Union[docutils_nodes.Element, None] = None,
) -> docutils_nodes.field:
field_text = item[1][0].astext()
parts = [p.strip() for p in field_text.split(",")]
Expand Down Expand Up @@ -552,7 +552,7 @@ def before_content(self) -> None:

@override
def transform_content(self, content_node: addnodes.desc_content) -> None:
def first_child_with_class_name(root, class_name) -> "None | Element":
def first_child_with_class_name(root, class_name) -> typing.Union[None, docutils_nodes.Element]:
matches = root.findall(
lambda node: isinstance(node, docutils_nodes.Element)
and class_name in node["classes"]
Expand Down Expand Up @@ -1509,7 +1509,7 @@ class _BzlDomain(domains.Domain):
}

@override
def get_full_qualified_name(self, node: docutils_nodes.Element) -> str | None:
def get_full_qualified_name(self, node: docutils_nodes.Element) -> typing.Union[str, None]:
bzl_file = node.get("bzl:file")
symbol_name = node.get("bzl:symbol")
ref_target = node.get("reftarget")
Expand Down Expand Up @@ -1553,7 +1553,7 @@ def resolve_xref(
target: str,
node: addnodes.pending_xref,
contnode: docutils_nodes.Element,
) -> docutils_nodes.Element | None:
) -> typing.Union[docutils_nodes.Element, None]:
_log_debug(
"resolve_xref: fromdocname=%s, typ=%s, target=%s", fromdocname, typ, target
)
Expand All @@ -1570,7 +1570,7 @@ def resolve_xref(

def _find_entry_for_xref(
self, fromdocname: str, object_type: str, target: str
) -> _ObjectEntry | None:
) -> typing.Union[_ObjectEntry, None]:
if target.startswith("--"):
target = target.strip("-")
object_type = "flag"
Expand Down