Skip to content

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

Open
WYSIATI wants to merge 1 commit intopython:mainfrom
WYSIATI:fix-mp-queue-shutdown-docs-147965
Open

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

Conversation

@WYSIATI
Copy link
Copy Markdown

@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
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()"

@hugovk hugovk removed their request for review April 1, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Update multiprocessing documentation: multiprocessing.Queue does not implement the shutdownmethod.

3 participants