bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation #23192

iritkatriel · 2020-11-07T18:38:48Z

enumerate() returns a list of all active thread objects, which contains all threads for which is_alive is true but may also contain threads (like the main thread) for which is_alive is False.

https://bugs.python.org/issue25821

The list returned by enumerate contains all alive threads, but may contain others.

pitrou · 2020-11-07T19:10:07Z

"active" is undefined. I would rather keep the corrent wording, but perhaps add that the main thread is always there even when finished.

iritkatriel · 2020-11-07T19:12:01Z

I picked up active from

.. function:: active_count()

   Return the number of :class:`Thread` objects currently alive.  The returned
   count is equal to the length of the list returned by :func:`.enumerate`.

pitrou · 2020-11-07T19:13:00Z

Hmm, well you see that "active" is a synonym of "alive" in that instance.

iritkatriel · 2020-11-07T19:13:47Z

There seems to be some distinction between "the thread object is alive" and thread.is_alive()

pitrou · 2020-11-07T19:15:41Z

Perhaps the following will be clear (but more wordy):

   Return a list of all :class:`Thread` objects currently active.  The list
   includes daemonic threads, dummy thread objects created by
   :func:`current_thread`, and the main thread.  It excludes terminated threads
   and threads that have not yet been started. However, the main thread
   is always part of the result, even when terminated.

taleinat

LGTM.

I think the change in threading.py is unnecessary, but harmless. @iritkatriel, let me know what you think about it, and then we can merge this.

taleinat · 2020-12-22T07:47:08Z

Lib/threading.py

        This method returns True just before the run() method starts until just
        after the run() method terminates. The module function enumerate()
-        returns a list of all alive threads.
+        returns a list that contains all alive threads.


I think the existing wording is fine here; not sure why this change is need?

That's because it may also contain a terminated main thread.

That makes the new wording correct, but possibly misleading.

The sentence about enumerate() seems somewhat out of place here; perhaps it could just be removed? Otherwise let's add something like "(and always the main thread)" at the end.

Perhaps just "see also .."?

taleinat · 2020-12-23T20:43:19Z

Lib/threading.py

        This method returns True just before the run() method starts until just
        after the run() method terminates. The module function enumerate()
-        returns a list of all alive threads.
+        returns a list that contains all alive threads.


That makes the new wording correct, but possibly misleading.

The sentence about enumerate() seems somewhat out of place here; perhaps it could just be removed? Otherwise let's add something like "(and always the main thread)" at the end.

bedevere-bot · 2020-12-23T20:43:28Z

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.

iritkatriel · 2020-12-25T17:04:21Z

I have made the requested changes; please review again

bedevere-bot · 2020-12-25T17:04:24Z

Thanks for making the requested changes!

@taleinat: please review the changes made to this pull request.

github-actions · 2021-01-25T01:00:56Z

This PR is stale because it has been open for 30 days with no activity.

taleinat · 2021-05-11T14:04:33Z

@iritkatriel, this is definitely ready to be merged. Now that you're a core dev, I'll leave it to you :)

iritkatriel · 2021-05-11T17:55:09Z

Oh!

bedevere-bot · 2021-05-11T17:55:27Z

@iritkatriel: Please replace # with GH- in the commit message next time. Thanks!

miss-islington · 2021-05-11T17:55:27Z

Thanks @iritkatriel for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.9.
🐍🍒⛏🤖

…on (pythonGH-23192) (cherry picked from commit 12e7d10) Co-authored-by: Irit Katriel <[email protected]>

bedevere-bot · 2021-05-11T17:55:34Z

GH-26035 is a backport of this pull request to the 3.10 branch.

bedevere-bot · 2021-05-11T17:55:39Z

GH-26036 is a backport of this pull request to the 3.9 branch.

…on (pythonGH-23192) (cherry picked from commit 12e7d10) Co-authored-by: Irit Katriel <[email protected]>

…on (GH-23192) (#26035) (cherry picked from commit 12e7d10) Co-authored-by: Irit Katriel <[email protected]>

…on (GH-23192) (#26036) (cherry picked from commit 12e7d10) Co-authored-by: Irit Katriel <[email protected]>

iritkatriel added 2 commits November 7, 2020 18:33

Fix docstring of is_alive w.r.t. enumerate()

2135ed9

The list returned by enumerate contains all alive threads, but may contain others.

Update threading.rst

bc81856

the-knights-who-say-ni added the CLA signed label Nov 7, 2020

bedevere-bot added the awaiting review label Nov 7, 2020

iritkatriel requested a review from pitrou November 7, 2020 18:43

Antoine's review comments

b5a1697

iritkatriel added the skip news label Nov 7, 2020

iritkatriel requested a review from taleinat November 23, 2020 10:54

taleinat approved these changes Dec 22, 2020

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Dec 22, 2020

taleinat requested changes Dec 23, 2020

View reviewed changes

bedevere-bot removed the awaiting merge label Dec 23, 2020

bedevere-bot added the awaiting changes label Dec 23, 2020

update docsting

a7d1dd3

bedevere-bot added awaiting change review and removed awaiting changes labels Dec 25, 2020

bedevere-bot requested a review from taleinat December 25, 2020 17:04

github-actions bot added the stale Stale PR or inactive for long period of time. label Jan 25, 2021

minor spacing

e7199e6

taleinat approved these changes May 11, 2021

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels May 11, 2021

taleinat added needs backport to 3.10 only security fixes needs backport to 3.9 docs Documentation in the Doc dir labels May 11, 2021

iritkatriel merged commit 12e7d10 into python:main May 11, 2021

bedevere-bot removed the awaiting merge label May 11, 2021

bedevere-bot removed needs backport to 3.10 only security fixes needs backport to 3.9 labels May 11, 2021

iritkatriel added a commit that referenced this pull request May 11, 2021

bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentati…

7bef7a1

…on (GH-23192) (#26035) (cherry picked from commit 12e7d10) Co-authored-by: Irit Katriel <[email protected]>

iritkatriel added a commit that referenced this pull request May 11, 2021

bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentati…

bde14f7

…on (GH-23192) (#26036) (cherry picked from commit 12e7d10) Co-authored-by: Irit Katriel <[email protected]>

iritkatriel deleted the bpo-25821 branch May 11, 2021 22:26

pablogsal mentioned this pull request Jul 18, 2021

[3.10] Correct the order of regen-abidump #27228

Closed

Uh oh!

bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation #23192

bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation #23192

Uh oh!

Conversation

iritkatriel commented Nov 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pitrou commented Nov 7, 2020

Uh oh!

iritkatriel commented Nov 7, 2020

Uh oh!

pitrou commented Nov 7, 2020

Uh oh!

iritkatriel commented Nov 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pitrou commented Nov 7, 2020

Uh oh!

taleinat left a comment

Choose a reason for hiding this comment

Uh oh!

taleinat Dec 22, 2020

Choose a reason for hiding this comment

Uh oh!

iritkatriel Dec 22, 2020

Choose a reason for hiding this comment

Uh oh!

taleinat Dec 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iritkatriel Dec 25, 2020

Choose a reason for hiding this comment

Uh oh!

taleinat Dec 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bedevere-bot commented Dec 23, 2020

Uh oh!

iritkatriel commented Dec 25, 2020

Uh oh!

bedevere-bot commented Dec 25, 2020

Uh oh!

github-actions bot commented Jan 25, 2021

Uh oh!

taleinat commented May 11, 2021

Uh oh!

iritkatriel commented May 11, 2021

Uh oh!

bedevere-bot commented May 11, 2021

Uh oh!

miss-islington commented May 11, 2021

Uh oh!

bedevere-bot commented May 11, 2021

Uh oh!

bedevere-bot commented May 11, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

iritkatriel commented Nov 7, 2020 •

edited

Loading

iritkatriel commented Nov 7, 2020 •

edited

Loading

taleinat Dec 23, 2020 •

edited

Loading

taleinat Dec 23, 2020 •

edited

Loading