]> git.ipfire.org Git - thirdparty/Python/cpython.git/commit
gh-76785: Expand How Interpreter Queues Handle Interpreter Finalization (gh-116431)
authorEric Snow <ericsnowcurrently@gmail.com>
Mon, 15 Jul 2024 18:49:23 +0000 (12:49 -0600)
committerGitHub <noreply@github.com>
Mon, 15 Jul 2024 18:49:23 +0000 (12:49 -0600)
commit6b98b274b60a15b490d2ea85069638c037b2a9cd
tree22e64db07e0431082fd8d9b8dc231d06347d81c6
parent985dd8e17b55ae35fc31546384fc9364f2f59f86
gh-76785: Expand How Interpreter Queues Handle Interpreter Finalization (gh-116431)

Any cross-interpreter mechanism for passing objects between interpreters must be very careful to respect isolation, even when the object is effectively immutable (e.g. int, str).  Here this especially relates to when an interpreter sends one of its objects, and then is destroyed while the inter-interpreter machinery (e.g. queue) still holds a reference to the object.

When I added interpreters.Queue, I dealt with that case (using an atexit hook) by silently removing all items from the queue that were added by the finalizing interpreter.

Later, while working on concurrent.futures.InterpreterPoolExecutor (gh-116430), I noticed it was somewhat surprising when items were silently removed from the queue when the originating interpreter was destroyed.  (See my comment on that PR.)
 It took me a little while to realize what was going on.  I expect that users, which much less context than I have, would experience the same pain.

My approach, here, to improving the situation is to give users three options:

1. return a singleton (interpreters.queues.UNBOUND) from Queue.get() in place of each removed item
2. raise an exception (interpreters.queues.ItemInterpreterDestroyed) from Queue.get() in place of each removed item
3. existing behavior: silently remove each item (i.e. Queue.get() skips each one)

The default will now be (1), but users can still explicitly opt in any of them, including to the silent removal behavior.

The behavior for each item may be set with the corresponding Queue.put() call. and a queue-wide default may be set when the queue is created.  (This is the same as I did for "synconly".)
Lib/test/support/interpreters/queues.py
Lib/test/test_interpreters/test_queues.py
Modules/_interpqueuesmodule.c