Skip to content

sphinx: avoid repeated isinstance checks #53367

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

Merged
amoghrajesh merged 1 commit into from
Jul 15, 2025
Merged

sphinx: avoid repeated isinstance checks #53367

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
22 changes: 14 additions & 8 deletions devel-common/src/sphinx_exts/substitution_extensions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ def condition(node):
return isinstance(node, (nodes.literal_block, nodes.literal))

for node in self.document.traverse(condition):
if not node.get(_SUBSTITUTION_OPTION_NAME):
# Guard: Only process Element nodes with a truthy substitution option
if not (isinstance(node, nodes.Element) and node.attributes.get(_SUBSTITUTION_OPTION_NAME)):
continue

# Some nodes don't have a direct document property, so walk up until we find it
Expand All @@ -74,15 +75,20 @@ def condition(node):
substitution_defs = document.substitution_defs
for child in node.children:
old_child = child
for name, value in substitution_defs.items():
replacement = value.astext()
if isinstance(child, nodes.Text):
child = nodes.Text(child.replace(f"|{name}|", replacement))
if isinstance(node, nodes.Element):
node.replace(old_child, child)
# Only substitute for Text nodes
if isinstance(child, nodes.Text):
new_text = str(child)
for name, value in substitution_defs.items():
replacement = value.astext()
new_text = new_text.replace(f"|{name}|", replacement)
# Only replace if the text actually changed
if new_text != str(child):
child = nodes.Text(new_text)
node.replace(old_child, child)
# For non-Text nodes, do not replace

# The highlighter checks this -- without this, it will refuse to apply highlighting
node.rawsource = node.astext() # type: ignore[attr-defined]
node.rawsource = node.astext()


def substitution_code_role(*args, **kwargs) -> tuple[list, list[Any]]:
Expand Down