https://github.com/python/cpython/commit/03457ca2accabcf70ed0f0118c2e92823635c465
commit: 03457ca2accabcf70ed0f0118c2e92823635c465
branch: 3.14
author: Miss Islington (bot) <31488909+miss-isling...@users.noreply.github.com>
committer: encukou <encu...@gmail.com>
date: 2025-07-19T14:57:52+02:00
summary:
[3.14] gh-135730: Clarify multiprocessing.Queue close() documentation
(GH-136803) (GH-136806)
gh-135730: Clarify multiprocessing.Queue close() documentation (GH-136803)
Add a copy of the text from SimpleQueue.close()
---------
(cherry picked from commit f575588ccf27d8d54a1e99cfda944f2614b3255c)
Co-authored-by: aggshruti99 <aggshrut...@gmail.com>
Co-authored-by: Petr Viktorin <encu...@gmail.com>
files:
M Doc/library/multiprocessing.rst
diff --git a/Doc/library/multiprocessing.rst b/Doc/library/multiprocessing.rst
index b41953d21442c9..a692df41a8154b 100644
--- a/Doc/library/multiprocessing.rst
+++ b/Doc/library/multiprocessing.rst
@@ -936,8 +936,13 @@ For an example of the usage of queues for interprocess
communication see
.. method:: close()
- Indicate that no more data will be put on this queue by the current
- process. The background thread will quit once it has flushed all
buffered
+ Close the queue: release internal resources.
+
+ A queue must not be used anymore after it is closed. For example,
+ :meth:`~Queue.get`, :meth:`~Queue.put` and :meth:`~Queue.empty`
+ methods must no longer be called.
+
+ The background thread will quit once it has flushed all buffered
data to the pipe. This is called automatically when the queue is garbage
collected.
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3//lists/python-checkins.python.org
Member address: arch...@mail-archive.com
