Skip to content

GH-116738: document thread-safety of bisect #136555

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
nascheme merged 7 commits into from
Jul 30, 2025
Merged

GH-116738: document thread-safety of bisect #136555

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
5e4d174
GH-116738: document thread-safety of bisect
nascheme Jul 9, 2025
4b7f113
Add free-threaded test for bisect.
nascheme Jul 11, 2025
e405cf8
Adjust indent of "note" block.
nascheme Jul 14, 2025
def0f47
Merge 'origin/main' into gh-116738-bisect-threadsafe-doc
nascheme Jul 23, 2025
87a90f3
Use `threading_helper.run_concurrently`.
nascheme Jul 23, 2025
b74a790
Remove unused imports from test.
nascheme Jul 30, 2025
229a531
Merge 'origin/main' into gh-116738-bisect-threadsafe-doc
nascheme Jul 30, 2025
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
Next Next commit
GH-116738: document thread-safety of bisect
  • Loading branch information
@nascheme
nascheme committed Jul 11, 2025
commit 5e4d174a460ad3d9a1713a5cc7901f6bbbbbcd3d
10 changes: 10 additions & 0 deletions Doc/library/bisect.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ method to determine whether a value has been found. Instead, the
functions only call the :meth:`~object.__lt__` method and will return an insertion
point between values in an array.

.. note::

The functions in this module are not thread-safe. If multiple threads
concurrently use :mod:`bisect` functions on the same sequence, this
may result in undefined behaviour. Likewise, if the provided sequence
is mutated by a different thread while a :mod:`bisect` function
is operating on it, the result is undefined. For example, using
:py:func:`~bisect.insort_left` on the same list from multiple threads
may result in the list becoming unsorted.
Comment thread
nascheme marked this conversation as resolved.
Outdated

.. _bisect functions:

The following functions are provided:
Expand Down