From 0461704060474cb358d3495322950c4fd00616a0 Mon Sep 17 00:00:00 2001 From: Zackery Spytz Date: Sat, 13 Oct 2018 03:26:09 -0600 Subject: [PATCH] bpo-22872: multiprocessing.Queue's put() and get() now raise ValueError if the queue is closed. (GH-9010) Previously, put() and get() would raise AssertionError and OSError, respectively. --- Doc/library/multiprocessing.rst | 8 ++++++++ Lib/multiprocessing/queues.py | 8 ++++++-- Lib/test/_test_multiprocessing.py | 8 ++++++++ .../next/Library/2018-08-30-14-44-11.bpo-22872.NhIaZ9.rst | 4 ++++ 4 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2018-08-30-14-44-11.bpo-22872.NhIaZ9.rst diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst index 8402370d98..578b548328 100644 --- a/Doc/library/multiprocessing.rst +++ b/Doc/library/multiprocessing.rst @@ -787,6 +787,10 @@ For an example of the usage of queues for interprocess communication see available, else raise the :exc:`queue.Full` exception (*timeout* is ignored in that case). + .. versionchanged:: 3.8 + If the queue is closed, :exc:`ValueError` is raised instead of + :exc:`AssertionError`. + .. method:: put_nowait(obj) Equivalent to ``put(obj, False)``. @@ -801,6 +805,10 @@ For an example of the usage of queues for interprocess communication see ``False``), return an item if one is immediately available, else raise the :exc:`queue.Empty` exception (*timeout* is ignored in that case). + .. versionchanged:: 3.8 + If the queue is closed, :exc:`ValueError` is raised instead of + :exc:`OSError`. + .. method:: get_nowait() Equivalent to ``get(False)``. diff --git a/Lib/multiprocessing/queues.py b/Lib/multiprocessing/queues.py index 88f7d267bf..d112db2cd9 100644 --- a/Lib/multiprocessing/queues.py +++ b/Lib/multiprocessing/queues.py @@ -78,7 +78,8 @@ class Queue(object): self._poll = self._reader.poll def put(self, obj, block=True, timeout=None): - assert not self._closed, "Queue {0!r} has been closed".format(self) + if self._closed: + raise ValueError(f"Queue {self!r} is closed") if not self._sem.acquire(block, timeout): raise Full @@ -89,6 +90,8 @@ class Queue(object): self._notempty.notify() def get(self, block=True, timeout=None): + if self._closed: + raise ValueError(f"Queue {self!r} is closed") if block and timeout is None: with self._rlock: res = self._recv_bytes() @@ -298,7 +301,8 @@ class JoinableQueue(Queue): self._cond, self._unfinished_tasks = state[-2:] def put(self, obj, block=True, timeout=None): - assert not self._closed, "Queue {0!r} is closed".format(self) + if self._closed: + raise ValueError(f"Queue {self!r} is closed") if not self._sem.acquire(block, timeout): raise Full diff --git a/Lib/test/_test_multiprocessing.py b/Lib/test/_test_multiprocessing.py index 814aae8fa3..dc59e9fd74 100644 --- a/Lib/test/_test_multiprocessing.py +++ b/Lib/test/_test_multiprocessing.py @@ -1114,6 +1114,14 @@ class _TestQueue(BaseTestCase): # Assert that the serialization and the hook have been called correctly self.assertTrue(not_serializable_obj.reduce_was_called) self.assertTrue(not_serializable_obj.on_queue_feeder_error_was_called) + + def test_closed_queue_put_get_exceptions(self): + for q in multiprocessing.Queue(), multiprocessing.JoinableQueue(): + q.close() + with self.assertRaisesRegex(ValueError, 'is closed'): + q.put('foo') + with self.assertRaisesRegex(ValueError, 'is closed'): + q.get() # # # diff --git a/Misc/NEWS.d/next/Library/2018-08-30-14-44-11.bpo-22872.NhIaZ9.rst b/Misc/NEWS.d/next/Library/2018-08-30-14-44-11.bpo-22872.NhIaZ9.rst new file mode 100644 index 0000000000..547c7b1a31 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2018-08-30-14-44-11.bpo-22872.NhIaZ9.rst @@ -0,0 +1,4 @@ +When the queue is closed, :exc:`ValueError` is now raised by +:meth:`multiprocessing.Queue.put` and :meth:`multiprocessing.Queue.get` +instead of :exc:`AssertionError` and :exc:`OSError`, respectively. +Patch by Zackery Spytz. -- 2.40.0