Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The behavior of multithreading.Queue.empty() when the Queue is closed is not explained in the docs #120012

Closed
marcoslimagon opened this issue Jun 4, 2024 · 3 comments
Closed

The behavior of multithreading.Queue.empty() when the Queue is closed is not explained in the docs #120012

marcoslimagon opened this issue Jun 4, 2024 · 3 comments
Labels
docs Documentation in the Doc dir easy

Comments

@marcoslimagon
Copy link

marcoslimagon commented Jun 4, 2024 •
edited by bedevere-app bot
Loading

Documentation

https://docs.python.org/3/library/multiprocessing.html#multiprocessing.Queue.empty

It should be added that in case of the given method Queue.empty() is called after Queue.close() it will raise `OSError("handle is closed")``
(A clear and concise description of the issue.)

Linked PRs
@marcoslimagon marcoslimagon added the docs Documentation in the Doc dir label Jun 4, 2024
@marcoslimagon marcoslimagon changed the title The behavior of multithreading.Queue.empty() is not well explained The behavior of multithreading.Queue.empty() when the Queue is closed is not explained in the docs Jun 4, 2024
@ericvsmith ericvsmith added the easy label Jun 4, 2024
@ericvsmith
Copy link
Member

That seems like a good change. I don't think we would typically include the error text in the docs, but the fact that it raises OSError in that case is worth noting.

@bedevere-app bedevere-app bot mentioned this issue Jun 5, 2024
Merged
gpshead added a commit that referenced this issue Jun 13, 2024
@picnixz @gpshead
gh-120012: clarify the behaviour of multiprocessing.Queue.empty on …
a3711af 
…closed queues. (GH-120102)

* improve doc for `multiprocessing.Queue.empty`
* add tests for checking emptiness of queues

Co-authored-by: Gregory P. Smith <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 13, 2024
@picnixz @gpshead @miss-islington
pythongh-120012: clarify the behaviour of `multiprocessing.Queue.empt…
92fcf3e 
…y` on closed queues. (pythonGH-120102)

* improve doc for `multiprocessing.Queue.empty`
* add tests for checking emptiness of queues

(cherry picked from commit a3711af)

Co-authored-by: Bénédikt Tran <[email protected]>
Co-authored-by: Gregory P. Smith <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Jun 13, 2024
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Jun 13, 2024
@picnixz @gpshead @miss-islington
pythongh-120012: clarify the behaviour of `multiprocessing.Queue.empt…
c0a2a50 
…y` on closed queues. (pythonGH-120102)

* improve doc for `multiprocessing.Queue.empty`
* add tests for checking emptiness of queues

(cherry picked from commit a3711af)

Co-authored-by: Bénédikt Tran <[email protected]>
Co-authored-by: Gregory P. Smith <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Jun 13, 2024
Merged
mrahtz pushed a commit to mrahtz/cpython that referenced this issue Jun 30, 2024
@picnixz @gpshead @mrahtz
pythongh-120012: clarify the behaviour of `multiprocessing.Queue.empt…
dbafe5c 
…y` on closed queues. (pythonGH-120102)

* improve doc for `multiprocessing.Queue.empty`
* add tests for checking emptiness of queues

Co-authored-by: Gregory P. Smith <[email protected]>
noahbkim pushed a commit to hudson-trading/cpython that referenced this issue Jul 11, 2024
@picnixz @gpshead @noahbkim
pythongh-120012: clarify the behaviour of `multiprocessing.Queue.empt…
4f70520 
…y` on closed queues. (pythonGH-120102)

* improve doc for `multiprocessing.Queue.empty`
* add tests for checking emptiness of queues

Co-authored-by: Gregory P. Smith <[email protected]>
@rok
Copy link

rok commented Jul 14, 2024

This seems to have been resolved by #120102.

hugovk pushed a commit that referenced this issue Jul 14, 2024
@miss-islington @picnixz @gpshead
[3.13] gh-120012: clarify the behaviour of `multiprocessing.Queue.emp…
dfedbdb 
…ty` on closed queues. (GH-120102) (#120469)

Co-authored-by: Bénédikt Tran <[email protected]>
Co-authored-by: Gregory P. Smith <[email protected]>
hugovk pushed a commit that referenced this issue Jul 14, 2024
@miss-islington @picnixz @gpshead
[3.12] gh-120012: clarify the behaviour of `multiprocessing.Queue.emp…
863c0a3 
…ty` on closed queues. (GH-120102) (#120470)

Co-authored-by: Bénédikt Tran <[email protected]>
Co-authored-by: Gregory P. Smith <[email protected]>
@hugovk
Copy link
Member

hugovk commented Jul 14, 2024

@rok Thanks for checking, I've merged the backports, let's close now.

@hugovk hugovk closed this as completed Jul 14, 2024
estyxx pushed a commit to estyxx/cpython that referenced this issue Jul 17, 2024
@picnixz @gpshead @estyxx
pythongh-120012: clarify the behaviour of `multiprocessing.Queue.empt…
3045f6c 
…y` on closed queues. (pythonGH-120102)

* improve doc for `multiprocessing.Queue.empty`
* add tests for checking emptiness of queues

Co-authored-by: Gregory P. Smith <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@rok @ericvsmith @hugovk @marcoslimagon