Skip to content

gh-145254: Add thread safety annotation #145255

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
kumaraditya303 merged 4 commits into from
Mar 12, 2026
+195 −0
Merged

gh-145254: Add thread safety annotation #145255

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a270317
gh-145254: Add thread safety annotation
lysnikolaou Feb 26, 2026
d577860
Address first round of feedback
lysnikolaou Mar 6, 2026
3ba0282
Change levels and add new section to thread safety page
lysnikolaou Mar 6, 2026
0169478
Use correct example for safe-shared level
lysnikolaou Mar 10, 2026
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
Prev Previous commit
Next Next commit
Address first round of feedback
  • Loading branch information
@lysnikolaou
lysnikolaou committed Mar 6, 2026
commit d577860ae997ff694cdee9b711f8d0439da116a9
39 changes: 21 additions & 18 deletions Doc/tools/extensions/c_annotations.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,9 @@ def read_stable_abi_data(stable_abi_file: Path) -> dict[str, StableABIEntry]:
})


def read_threadsafety_data(threadsafety_filename: Path) -> dict[str, ThreadSafetyEntry]:
def read_threadsafety_data(
threadsafety_filename: Path,
) -> dict[str, ThreadSafetyEntry]:
threadsafety_data = {}
for line in threadsafety_filename.read_text(encoding="utf8").splitlines():
line = line.strip()
Expand Down Expand Up @@ -301,32 +303,33 @@ def _unstable_api_annotation() -> nodes.admonition:
)


_THREADSAFETY_DISPLAY = {
"incompatible": "Not safe to call from multiple threads.",
"compatible": "Safe to call from multiple threads with external synchronization only.",
"safe": "Safe for concurrent use.",
}

# Maps each thread safety level to the glossary term it should link to.
_THREADSAFETY_TERM = {
"incompatible": "thread-incompatible",
"compatible": "thread-compatible",
"safe": "thread-safe",
}


def _threadsafety_annotation(level: str) -> nodes.emphasis:
display = sphinx_gettext(_THREADSAFETY_DISPLAY[level])
match level:
case "incompatible":
display = sphinx_gettext("Not safe to call from multiple threads.")
reftarget = "thread-incompatible"
case "compatible":
display = sphinx_gettext(
"Safe to call from multiple threads with external synchronization only."
)
reftarget = "thread-compatible"
case "safe":
display = sphinx_gettext("Safe for concurrent use.")
reftarget = "thread-safe"
case _:
raise AssertionError(
"Only the levels 'incompatible', 'compatible' and 'safe' are possible"
)
ref_node = addnodes.pending_xref(
display,
nodes.Text(display),
refdomain="std",
reftarget=_THREADSAFETY_TERM[level],
reftarget=reftarget,
reftype="term",
refexplicit="True",
)
prefix = sphinx_gettext("Thread safety:") + " "
classes = [f"threadsafety-{level}"]
classes = ["threadsafety", f"threadsafety-{level}"]
return nodes.emphasis("", prefix, ref_node, classes=classes)


Expand Down