-
-
Notifications
You must be signed in to change notification settings - Fork 34.1k
gh-145235: Make dict watcher API thread-safe for free-threaded builds #145233
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.
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
Open
yoney
wants to merge
3
commits into
python:main
Choose a base branch
from
yoney:watcher
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+177
−30
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| import unittest | ||
|
|
||
| from test.support import import_helper, threading_helper | ||
|
|
||
| _testcapi = import_helper.import_module("_testcapi") | ||
|
|
||
| ITERS = 100 | ||
| NTHREADS = 20 | ||
|
|
||
|
|
||
| @threading_helper.requires_working_threading() | ||
| class TestDictWatcherThreadSafety(unittest.TestCase): | ||
| # Watcher kinds from _testcapi | ||
| EVENTS = 0 # appends dict events as strings to global event list | ||
|
|
||
| def test_concurrent_add_clear_watchers(self): | ||
| """Race AddWatcher and ClearWatcher from multiple threads. | ||
|
|
||
| Uses more threads than available watcher slots (5 user slots out | ||
| of DICT_MAX_WATCHERS=8). | ||
| """ | ||
| results = [] | ||
|
|
||
| def worker(): | ||
| for _ in range(ITERS): | ||
| try: | ||
| wid = _testcapi.add_dict_watcher(self.EVENTS) | ||
| except RuntimeError: | ||
| continue # All slots taken | ||
| self.assertGreaterEqual(wid, 0) | ||
| results.append(wid) | ||
| _testcapi.clear_dict_watcher(wid) | ||
|
|
||
| threading_helper.run_concurrently(worker, NTHREADS) | ||
|
|
||
| # Verify at least some watchers were successfully added | ||
| self.assertGreater(len(results), 0) | ||
|
|
||
| def test_concurrent_watch_unwatch(self): | ||
| """Race Watch and Unwatch on the same dict from multiple threads.""" | ||
| wid = _testcapi.add_dict_watcher(self.EVENTS) | ||
| dicts = [{} for _ in range(10)] | ||
|
|
||
| def worker(): | ||
| for _ in range(ITERS): | ||
| for d in dicts: | ||
| _testcapi.watch_dict(wid, d) | ||
| for d in dicts: | ||
| _testcapi.unwatch_dict(wid, d) | ||
|
|
||
| try: | ||
| threading_helper.run_concurrently(worker, NTHREADS) | ||
|
|
||
| # Verify watching still works after concurrent watch/unwatch | ||
| _testcapi.watch_dict(wid, dicts[0]) | ||
| dicts[0]["key"] = "value" | ||
| events = _testcapi.get_dict_watcher_events() | ||
| self.assertIn("new:key:value", events) | ||
| finally: | ||
| _testcapi.clear_dict_watcher(wid) | ||
|
|
||
| def test_concurrent_modify_watched_dict(self): | ||
| """Race dict mutations (triggering callbacks) with watch/unwatch.""" | ||
| wid = _testcapi.add_dict_watcher(self.EVENTS) | ||
| d = {} | ||
| _testcapi.watch_dict(wid, d) | ||
|
|
||
| def mutator(): | ||
| for i in range(ITERS): | ||
| d[f"key_{i}"] = i | ||
| d.pop(f"key_{i}", None) | ||
|
|
||
| def toggler(): | ||
| for i in range(ITERS): | ||
| _testcapi.watch_dict(wid, d) | ||
| d[f"toggler_{i}"] = i | ||
| _testcapi.unwatch_dict(wid, d) | ||
|
|
||
| workers = [mutator, toggler] * (NTHREADS // 2) | ||
| try: | ||
| threading_helper.run_concurrently(workers) | ||
| events = _testcapi.get_dict_watcher_events() | ||
| self.assertGreater(len(events), 0) | ||
| finally: | ||
| _testcapi.clear_dict_watcher(wid) | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
3 changes: 3 additions & 0 deletions
3
Misc/NEWS.d/next/C_API/2026-02-25-13-37-10.gh-issue-145235.-1ySNR.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Made :c:func:`PyDict_AddWatcher`, :c:func:`PyDict_ClearWatcher`, | ||
| :c:func:`PyDict_Watch`, and :c:func:`PyDict_Unwatch` thread-safe on the | ||
| :term:`free threaded <free threading>` build. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.