Skip to content

gh-147965: Add shutdown() to multiprocessing.Queue excluded methods#147970

Merged
gpshead merged 1 commit intopython:mainfrom
WYSIATI:fix-mp-queue-shutdown-docs-147965
Apr 12, 2026
Merged

gh-147965: Add shutdown() to multiprocessing.Queue excluded methods#147970
gpshead merged 1 commit intopython:mainfrom
WYSIATI:fix-mp-queue-shutdown-docs-147965

Conversation

@WYSIATI
Copy link
Copy Markdown
Contributor

@WYSIATI WYSIATI commented Apr 1, 2026

Closes #147965.

The multiprocessing.Queue documentation states it implements all methods of queue.Queue except for task_done() and join(). Since queue.Queue.shutdown() was added in Python 3.13, and multiprocessing.Queue does not implement it either, this PR adds shutdown() to the list of excluded methods.

Changes

  • Doc/library/multiprocessing.rst: Add shutdown() to the list of queue.Queue methods not implemented by multiprocessing.Queue

📚 Documentation preview 📚: https://cpython-previews--147970.org.readthedocs.build/

@python-cla-bot
Copy link
Copy Markdown

python-cla-bot bot commented Apr 1, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

@aisk
Copy link
Copy Markdown
Member

aisk commented Apr 1, 2026

Please avoid modify unrelated files in one PR.

@YvesDup
Copy link
Copy Markdown
Contributor

YvesDup commented Apr 1, 2026

@WYSIATI as creator of this #147965 issue, please ask for me before create a PR

@aisk
Copy link
Copy Markdown
Member

aisk commented Apr 1, 2026

And if this PR is fully generated by LLM, please read https://devguide.python.org/getting-started/generative-ai/ first. @WYSIATI

…hods

The multiprocessing.Queue documentation states it implements all
methods of queue.Queue except task_done() and join(). Since
queue.Queue.shutdown() was added in Python 3.13,
multiprocessing.Queue also does not implement it. Update the docs
to include shutdown() in the list of excluded methods.
@WYSIATI WYSIATI force-pushed the fix-mp-queue-shutdown-docs-147965 branch from d3b06be to fe18363 Compare April 1, 2026 14:26
@WYSIATI
Copy link
Copy Markdown
Contributor Author

WYSIATI commented Apr 1, 2026

@aisk Thanks for the pointer, I used AI to assist me with writing the commit, but I personally verify it the shutdown is not found by python3 -c "import multiprocessing; q = multiprocessing.Queue(); q.shutdown()"

@YvesDup
Copy link
Copy Markdown
Contributor

YvesDup commented Apr 8, 2026

The fix looks good to me

@gpshead gpshead added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes and removed awaiting merge labels Apr 12, 2026
@gpshead gpshead merged commit 22290ed into python:main Apr 12, 2026
40 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Apr 12, 2026
@miss-islington-app
Copy link
Copy Markdown

Thanks @WYSIATI for the PR, and @gpshead for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 12, 2026
…hods (pythonGH-147970)

The multiprocessing.Queue documentation states it implements all
methods of queue.Queue except task_done() and join(). Since
queue.Queue.shutdown() was added in Python 3.13,
multiprocessing.Queue also does not implement it. Update the docs
to include shutdown() in the list of excluded methods.
(cherry picked from commit 22290ed011a8ac4060390e57f53053ab932fb3f3)

Co-authored-by: WYSIATI <chester.lee.cold@gmail.com>
@bedevere-app
Copy link
Copy Markdown

bedevere-app bot commented Apr 12, 2026

GH-148416 is a backport of this pull request to the 3.14 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 12, 2026
…hods (pythonGH-147970)

The multiprocessing.Queue documentation states it implements all
methods of queue.Queue except task_done() and join(). Since
queue.Queue.shutdown() was added in Python 3.13,
multiprocessing.Queue also does not implement it. Update the docs
to include shutdown() in the list of excluded methods.
(cherry picked from commit 22290ed)

Co-authored-by: WYSIATI <chester.lee.cold@gmail.com>
@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Apr 12, 2026
@bedevere-app
Copy link
Copy Markdown

bedevere-app bot commented Apr 12, 2026

GH-148417 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Apr 12, 2026
gpshead pushed a commit that referenced this pull request Apr 12, 2026
…thods (GH-147970) (#148416)

gh-147965: Add shutdown() to multiprocessing.Queue excluded methods (GH-147970)

The multiprocessing.Queue documentation states it implements all
methods of queue.Queue except task_done() and join(). Since
queue.Queue.shutdown() was added in Python 3.13,
multiprocessing.Queue also does not implement it. Update the docs
to include shutdown() in the list of excluded methods.
(cherry picked from commit 22290ed)

Co-authored-by: WYSIATI <chester.lee.cold@gmail.com>
gpshead pushed a commit that referenced this pull request Apr 12, 2026
…thods (GH-147970) (#148417)

gh-147965: Add shutdown() to multiprocessing.Queue excluded methods (GH-147970)

The multiprocessing.Queue documentation states it implements all
methods of queue.Queue except task_done() and join(). Since
queue.Queue.shutdown() was added in Python 3.13,
multiprocessing.Queue also does not implement it. Update the docs
to include shutdown() in the list of excluded methods.
(cherry picked from commit 22290ed)

Co-authored-by: WYSIATI <chester.lee.cold@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Indicate that multiprocessing.Queue does not implement shutdown()

4 participants