GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — gh-96471: Correct docs for queue shutdown raises by EpicWink · Pull Request #115838 · python/cpython

Conversation

@EpicWink

@EpicWink EpicWink commented Feb 23, 2024 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor
  • Remove "raises ShutDown" from Queue.join() and Queue.task_done() documentation (including doc-string)
  • Clarify Queue.shutdown() behaviour (it doesn't raise itself, but causes other methods to raise)
  • Add that Queue.task_done() is called by Queue.shutdown(immediate=True) for each item in the queue

Caused by: #104750

  • Issue: Queue shutdown #96471

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@EpicWink
EpicWink requested a review from rhettinger as a code owner February 23, 2024 02:08
@bedevere-app bedevere-app Bot added the awaiting review label Feb 23, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Feb 23, 2024
Queue shutdown #96471
Open
@EpicWink
EpicWink force-pushed the threading-queue-shutdown-no-raise-docs branch from 4fdeb68 to 63bdd42 Compare February 23, 2024 02:09
@EpicWink
Remove incorrect queue-shutdown doc
c1bcb5d
@EpicWink
EpicWink force-pushed the threading-queue-shutdown-no-raise-docs branch from 63bdd42 to c1bcb5d Compare February 23, 2024 02:10
@EpicWink EpicWink mentioned this pull request Feb 23, 2024
gh-96471: Add threading queue shutdown #104750
Merged
gvanrossum
gvanrossum reviewed Feb 23, 2024
View reviewed changes

@gvanrossum gvanrossum left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Two nits and then I'll merge this. (I feel bad that I didn't catch this in review.)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
Comment thread Doc/library/queue.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Lib/queue.py Resolved

Uh oh!

There was an error while loading. Please reload this page.
@rhettinger
rhettinger removed their request for review February 23, 2024 05:34
@gvanrossum gvanrossum added the skip news label Feb 23, 2024
gvanrossum

This comment was marked as duplicate.

Sign in to view

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
gvanrossum
gvanrossum requested changes Feb 23, 2024
View reviewed changes

@gvanrossum gvanrossum left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please fix the nits I called out.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-app bedevere-app Bot added awaiting changes and removed awaiting review labels Feb 23, 2024
@bedevere-app

bedevere-app Bot commented Feb 23, 2024

Copy link
Copy Markdown

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
EpicWink added 3 commits February 25, 2024 14:42
@EpicWink
Merge remote-tracking branch 'upstream/main' into threading-queue-shu…
1bbca6c 
…tdown-no-raise-docs
@EpicWink
Remove unnecessary q-size get
100b64f
@EpicWink
Precise documentation for task_done on shutdown
6bab995
@EpicWink

EpicWink commented Feb 25, 2024

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@EpicWink EpicWink mentioned this pull request Feb 25, 2024
gh-96471: Add asyncio queue shutdown #104228
Merged
gvanrossum
gvanrossum reviewed Feb 25, 2024
View reviewed changes
Comment thread Doc/library/queue.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
@gvanrossum
Fix markup in Doc/library/queue.rst
6c28c09
gvanrossum
gvanrossum approved these changes Feb 25, 2024
View reviewed changes
@bedevere-app bedevere-app Bot added awaiting merge and removed awaiting changes labels Feb 25, 2024
@gvanrossum
gvanrossum enabled auto-merge (squash) February 25, 2024 16:31
@gvanrossum
gvanrossum merged commit 9402ea6 into python:main Feb 25, 2024
@bedevere-app bedevere-app Bot removed the awaiting merge label Feb 25, 2024
woodruffw pushed a commit to woodruffw-forks/cpython that referenced this pull request Mar 4, 2024
@EpicWink @woodruffw
pythongh-96471: Correct docs for queue shutdown (python#115838)
12a5bb8
@EpicWink
EpicWink deleted the threading-queue-shutdown-no-raise-docs branch April 11, 2024 01:10
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
@EpicWink @diegorusso
pythongh-96471: Correct docs for queue shutdown (python#115838)
c291991
LukasWoodtli pushed a commit to LukasWoodtli/cpython that referenced this pull request Jan 22, 2025
@EpicWink @LukasWoodtli
pythongh-96471: Correct docs for queue shutdown (python#115838)
12b70b5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@gvanrossum gvanrossum gvanrossum approved these changes

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

2 participants

@EpicWink @gvanrossum
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.