Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork32.2k
gh-116738: Make _heapq module thread-safe#135036
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
11 commits Select commitHold shift + click to select a range
ec3cade gh-116738: Make _heapq module thread-safe
yoney01b2be4 gh-116738: Add news entry in Misc/NEWS/next
yoney68f3a26 gh-116738: Address the review comments
yoney41d145a gh-116738: Address the review comments
yoneya22da8f gh-116738: Remove type hints
yoney75a1d3a gh-116738: Address the review comments
yoneye8138be gh-116738: Add NULL check for the item arg in heappush()
yoney3f09689 gh-116738: Fix typo
yoney7ffdb6d gh-116738: Use invariant checks from heapq test
yoneyc2225a5 gh-116738: Remove forgotten type hint
yoneya196a00 Merge branch 'main' into ft_heapq
mpageFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,240 @@ | ||
| import unittest | ||
| import heapq | ||
| from enum import Enum | ||
| from threading import Thread, Barrier | ||
| from random import shuffle, randint | ||
| from test.support import threading_helper | ||
| from test import test_heapq | ||
| NTHREADS = 10 | ||
| OBJECT_COUNT = 5_000 | ||
| class Heap(Enum): | ||
| MIN = 1 | ||
| MAX = 2 | ||
| @threading_helper.requires_working_threading() | ||
| class TestHeapq(unittest.TestCase): | ||
| def setUp(self): | ||
| self.test_heapq = test_heapq.TestHeapPython() | ||
| def test_racing_heapify(self): | ||
| heap = list(range(OBJECT_COUNT)) | ||
| shuffle(heap) | ||
| self.run_concurrently( | ||
| worker_func=heapq.heapify, args=(heap,), nthreads=NTHREADS | ||
| ) | ||
| self.test_heapq.check_invariant(heap) | ||
| def test_racing_heappush(self): | ||
| heap = [] | ||
| def heappush_func(heap): | ||
| for item in reversed(range(OBJECT_COUNT)): | ||
| heapq.heappush(heap, item) | ||
| self.run_concurrently( | ||
| worker_func=heappush_func, args=(heap,), nthreads=NTHREADS | ||
| ) | ||
| self.test_heapq.check_invariant(heap) | ||
| def test_racing_heappop(self): | ||
| heap = self.create_heap(OBJECT_COUNT, Heap.MIN) | ||
| # Each thread pops (OBJECT_COUNT / NTHREADS) items | ||
| self.assertEqual(OBJECT_COUNT % NTHREADS, 0) | ||
| per_thread_pop_count = OBJECT_COUNT // NTHREADS | ||
| def heappop_func(heap, pop_count): | ||
| local_list = [] | ||
| for _ in range(pop_count): | ||
| item = heapq.heappop(heap) | ||
| local_list.append(item) | ||
| # Each local list should be sorted | ||
| self.assertTrue(self.is_sorted_ascending(local_list)) | ||
| self.run_concurrently( | ||
| worker_func=heappop_func, | ||
| args=(heap, per_thread_pop_count), | ||
| nthreads=NTHREADS, | ||
| ) | ||
| self.assertEqual(len(heap), 0) | ||
| def test_racing_heappushpop(self): | ||
| heap = self.create_heap(OBJECT_COUNT, Heap.MIN) | ||
| pushpop_items = self.create_random_list(-5_000, 10_000, OBJECT_COUNT) | ||
| def heappushpop_func(heap, pushpop_items): | ||
| for item in pushpop_items: | ||
| popped_item = heapq.heappushpop(heap, item) | ||
| self.assertTrue(popped_item <= item) | ||
| self.run_concurrently( | ||
| worker_func=heappushpop_func, | ||
| args=(heap, pushpop_items), | ||
| nthreads=NTHREADS, | ||
| ) | ||
| self.assertEqual(len(heap), OBJECT_COUNT) | ||
| self.test_heapq.check_invariant(heap) | ||
| def test_racing_heapreplace(self): | ||
| heap = self.create_heap(OBJECT_COUNT, Heap.MIN) | ||
| replace_items = self.create_random_list(-5_000, 10_000, OBJECT_COUNT) | ||
| def heapreplace_func(heap, replace_items): | ||
| for item in replace_items: | ||
| heapq.heapreplace(heap, item) | ||
| self.run_concurrently( | ||
| worker_func=heapreplace_func, | ||
| args=(heap, replace_items), | ||
| nthreads=NTHREADS, | ||
| ) | ||
| self.assertEqual(len(heap), OBJECT_COUNT) | ||
| self.test_heapq.check_invariant(heap) | ||
| def test_racing_heapify_max(self): | ||
| max_heap = list(range(OBJECT_COUNT)) | ||
| shuffle(max_heap) | ||
| self.run_concurrently( | ||
| worker_func=heapq.heapify_max, args=(max_heap,), nthreads=NTHREADS | ||
| ) | ||
| self.test_heapq.check_max_invariant(max_heap) | ||
| def test_racing_heappush_max(self): | ||
| max_heap = [] | ||
| def heappush_max_func(max_heap): | ||
| for item in range(OBJECT_COUNT): | ||
| heapq.heappush_max(max_heap, item) | ||
| self.run_concurrently( | ||
| worker_func=heappush_max_func, args=(max_heap,), nthreads=NTHREADS | ||
| ) | ||
| self.test_heapq.check_max_invariant(max_heap) | ||
| def test_racing_heappop_max(self): | ||
| max_heap = self.create_heap(OBJECT_COUNT, Heap.MAX) | ||
| # Each thread pops (OBJECT_COUNT / NTHREADS) items | ||
| self.assertEqual(OBJECT_COUNT % NTHREADS, 0) | ||
| per_thread_pop_count = OBJECT_COUNT // NTHREADS | ||
| def heappop_max_func(max_heap, pop_count): | ||
| local_list = [] | ||
| for _ in range(pop_count): | ||
| item = heapq.heappop_max(max_heap) | ||
| local_list.append(item) | ||
| # Each local list should be sorted | ||
| self.assertTrue(self.is_sorted_descending(local_list)) | ||
| self.run_concurrently( | ||
| worker_func=heappop_max_func, | ||
| args=(max_heap, per_thread_pop_count), | ||
| nthreads=NTHREADS, | ||
| ) | ||
| self.assertEqual(len(max_heap), 0) | ||
| def test_racing_heappushpop_max(self): | ||
| max_heap = self.create_heap(OBJECT_COUNT, Heap.MAX) | ||
| pushpop_items = self.create_random_list(-5_000, 10_000, OBJECT_COUNT) | ||
| def heappushpop_max_func(max_heap, pushpop_items): | ||
| for item in pushpop_items: | ||
| popped_item = heapq.heappushpop_max(max_heap, item) | ||
| self.assertTrue(popped_item >= item) | ||
| self.run_concurrently( | ||
| worker_func=heappushpop_max_func, | ||
| args=(max_heap, pushpop_items), | ||
| nthreads=NTHREADS, | ||
| ) | ||
| self.assertEqual(len(max_heap), OBJECT_COUNT) | ||
| self.test_heapq.check_max_invariant(max_heap) | ||
| def test_racing_heapreplace_max(self): | ||
| max_heap = self.create_heap(OBJECT_COUNT, Heap.MAX) | ||
| replace_items = self.create_random_list(-5_000, 10_000, OBJECT_COUNT) | ||
| def heapreplace_max_func(max_heap, replace_items): | ||
| for item in replace_items: | ||
| heapq.heapreplace_max(max_heap, item) | ||
| self.run_concurrently( | ||
| worker_func=heapreplace_max_func, | ||
| args=(max_heap, replace_items), | ||
| nthreads=NTHREADS, | ||
| ) | ||
| self.assertEqual(len(max_heap), OBJECT_COUNT) | ||
| self.test_heapq.check_max_invariant(max_heap) | ||
| @staticmethod | ||
| def is_sorted_ascending(lst): | ||
| """ | ||
| Check if the list is sorted in ascending order (non-decreasing). | ||
| """ | ||
| return all(lst[i - 1] <= lst[i] for i in range(1, len(lst))) | ||
| @staticmethod | ||
| def is_sorted_descending(lst): | ||
| """ | ||
| Check if the list is sorted in descending order (non-increasing). | ||
| """ | ||
| return all(lst[i - 1] >= lst[i] for i in range(1, len(lst))) | ||
| @staticmethod | ||
| def create_heap(size, heap_kind): | ||
| """ | ||
| Create a min/max heap where elements are in the range (0, size - 1) and | ||
| shuffled before heapify. | ||
| """ | ||
| heap = list(range(OBJECT_COUNT)) | ||
| shuffle(heap) | ||
| if heap_kind == Heap.MIN: | ||
| heapq.heapify(heap) | ||
| else: | ||
| heapq.heapify_max(heap) | ||
| return heap | ||
| @staticmethod | ||
| def create_random_list(a, b, size): | ||
| """ | ||
| Create a list of random numbers between a and b (inclusive). | ||
| """ | ||
| return [randint(-a, b) for _ in range(size)] | ||
| def run_concurrently(self, worker_func, args, nthreads): | ||
| """ | ||
| Run the worker function concurrently in multiple threads. | ||
| """ | ||
| barrier = Barrier(nthreads) | ||
| def wrapper_func(*args): | ||
| # Wait for all threads to reach this point before proceeding. | ||
| barrier.wait() | ||
| worker_func(*args) | ||
| with threading_helper.catch_threading_exception() as cm: | ||
| workers = ( | ||
| Thread(target=wrapper_func, args=args) for _ in range(nthreads) | ||
| ) | ||
| with threading_helper.start_threads(workers): | ||
| pass | ||
yoney marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| # Worker threads should not raise any exceptions | ||
| self.assertIsNone(cm.exc_value) | ||
| if __name__ == "__main__": | ||
| unittest.main() | ||
1 change: 1 addition & 0 deletionsMisc/NEWS.d/next/Core_and_Builtins/2025-06-02-13-57-40.gh-issue-116738.ycJsL8.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 @@ | ||
| Make methods in :mod:`heapq` thread-safe on the :term:`free threaded <free threading>` build. |
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.