bpo-22872: multiprocessing.Queue's put() and get() now raise ValueError if the queue is closed. (GH-9010)

ZackerySpytz · serhiy-storchaka · commit 046170406047 · 2018-10-13T12:26:09.000+03:00
Previously, put() and get() would raise AssertionError and OSError,
respectively.
diff --git 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
@@ -78,7 +78,8 @@ def _after_fork(self):
         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 @@ def put(self, obj, block=True, timeout=None):
             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 @@ def __setstate__(self, state):
         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
@@ -1114,6 +1114,14 @@ def _on_queue_feeder_error(e, obj):
         # 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
@@ -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.

Original file line number	Diff line number	Diff line change
`@@ -1114,6 +1114,14 @@ def _on_queue_feeder_error(e, obj):`
`1114`	`1114`	`# Assert that the serialization and the hook have been called correctly`
`1115`	`1115`	`self.assertTrue(not_serializable_obj.reduce_was_called)`
`1116`	`1116`	`self.assertTrue(not_serializable_obj.on_queue_feeder_error_was_called)`
	`1117`	`+`
	`1118`	`+ def test_closed_queue_put_get_exceptions(self):`
	`1119`	`+ for q in multiprocessing.Queue(), multiprocessing.JoinableQueue():`
	`1120`	`+ q.close()`
	`1121`	`+ with self.assertRaisesRegex(ValueError, 'is closed'):`
	`1122`	`+ q.put('foo')`
	`1123`	`+ with self.assertRaisesRegex(ValueError, 'is closed'):`
	`1124`	`+ q.get()`
`1117`	`1125`	`#`
`1118`	`1126`	`#`
`1119`	`1127`	`#`