Fix typo in multiprocessing.pool.AsyncResult.successful doc. #17932

awecx · 2020-01-09T22:11:51Z

Since 3.7 successful raises a ValueError as explained in the next text block from the documentation:

Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError.

No issue associated with this PR.
Should be backported in 3.7 and 3.8.

Automerge-Triggered-By: @pitrou


        Fix typo in successful() reference doc.

aeros

Thanks for the PR @awecx.

I confirmed from the source code that AsyncResult.successful() does indeed raise a ValueError instead of an AssertionError:

cpython/Lib/multiprocessing/pool.py

Lines 753 to 756 in a796d8e

    
           def successful(self): 
        
               if not self.ready(): 
        
                   raise ValueError("{0!r} not ready".format(self)) 
        
               return self._success

LGTM. This is also present in the 3.8 and 3.7 branches, so this PR should be backported to those versions as well.

aeros · 2020-01-09T22:47:11Z

Added @pitrou as a reviewer for the PR, since he's an active expert for the multiprocessing module.

awecx · 2020-01-10T09:20:14Z

Thanks for the PR @awecx.

I confirmed from the source code that AsyncResult.successful() does indeed raise a ValueError instead of an AssertionError:

cpython/Lib/multiprocessing/pool.py

Lines 753 to 756 in a796d8e

def successful(self):

if not self.ready():

raise ValueError("{0!r} not ready".format(self))

return self._success

LGTM. This is also present in the 3.8 and 3.7 branches, so this PR should be backported to those versions as well.

Thanks @aeros for the clarification. Indeed I should have proven the typo claim more clearly:
@pitrou if double check is necessary, you can run the following snippet:

from multiprocessing import Pool
from time import sleep

with Pool(processes=1) as pool:
    result = pool.apply_async(sleep, (10000,))
    result.successful()

pitrou

+1

miss-islington · 2020-01-15T20:12:45Z

Thanks @awecx for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖


        Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…

…H-17932) Since 3.7 `successful` raises a `ValueError` as explained in the next text block from the documentation: _Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError._ No issue associated with this PR. Should be backported in 3.7 and 3.8. (cherry picked from commit dc0284e) Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com>

bedevere-bot · 2020-01-15T20:13:03Z

GH-18015 is a backport of this pull request to the 3.8 branch.


        Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…

…H-17932) Since 3.7 `successful` raises a `ValueError` as explained in the next text block from the documentation: _Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError._ No issue associated with this PR. Should be backported in 3.7 and 3.8. (cherry picked from commit dc0284e) Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com>

bedevere-bot · 2020-01-15T20:13:10Z

GH-18016 is a backport of this pull request to the 3.7 branch.


        [3.8] Fix typo in multiprocessing.pool.AsyncResult.successful doc. (G…

@pitrou

…H-17932) (GH-18015) Since 3.7 `successful` raises a `ValueError` as explained in the next text block from the documentation: _Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError._ No issue associated with this PR. Should be backported in 3.7 and 3.8. (cherry picked from commit dc0284e) Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com> Automerge-Triggered-By: @pitrou


        [3.7] Fix typo in multiprocessing.pool.AsyncResult.successful doc. (G…

@pitrou

…H-17932) (GH-18016) Since 3.7 `successful` raises a `ValueError` as explained in the next text block from the documentation: _Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError._ No issue associated with this PR. Should be backported in 3.7 and 3.8. (cherry picked from commit dc0284e) Co-authored-by: Antoine <43954001+awecx@users.noreply.github.com> Automerge-Triggered-By: @pitrou


        Merge pull request #184 from python/master

Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonGH-17932)


        Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…

…H-17932) Since 3.7 `successful` raises a `ValueError` as explained in the next text block from the documentation: _Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError._ No issue associated with this PR. Should be backported in 3.7 and 3.8.


        Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…

…H-17932) Since 3.7 `successful` raises a `ValueError` as explained in the next text block from the documentation: _Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError._ No issue associated with this PR. Should be backported in 3.7 and 3.8.


        Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…

…H-17932) Since 3.7 `successful` raises a `ValueError` as explained in the next text block from the documentation: _Changed in version 3.7: If the result is not ready, ValueError is raised instead of AssertionError._ No issue associated with this PR. Should be backported in 3.7 and 3.8.

Fix typo in successful() reference doc.

Loading status checks…

293862e

the-knights-who-say-ni added the CLA signed label Jan 9, 2020

bedevere-bot added type-documentation awaiting review labels Jan 9, 2020

aeros added skip issue skip news labels Jan 9, 2020

aeros approved these changes Jan 9, 2020

View changes

bedevere-bot added awaiting core review and removed awaiting review labels Jan 9, 2020

aeros added needs backport to 3.7 needs backport to 3.8 labels Jan 9, 2020

aeros assigned pitrou and unassigned pitrou Jan 9, 2020

aeros requested a review from pitrou Jan 9, 2020

pitrou approved these changes Jan 15, 2020

View changes

bedevere-bot added awaiting merge and removed awaiting core review labels Jan 15, 2020

pitrou added the 🤖 automerge label Jan 15, 2020

bedevere-bot removed the awaiting merge label Jan 15, 2020

bedevere-bot removed the needs backport to 3.8 label Jan 15, 2020

bedevere-bot removed the needs backport to 3.7 label Jan 15, 2020

python / cpython

Fix typo in multiprocessing.pool.AsyncResult.successful doc. #17932

Fix typo in multiprocessing.pool.AsyncResult.successful doc. #17932

awecx commented Jan 9, 2020 •

edited by miss-islington

aeros left a comment •

edited

This comment has been minimized.

aeros commented Jan 9, 2020

This comment has been minimized.

awecx commented Jan 10, 2020

pitrou left a comment

This comment has been minimized.

miss-islington commented Jan 15, 2020

This comment has been minimized.

bedevere-bot commented Jan 15, 2020

This comment has been minimized.

bedevere-bot commented Jan 15, 2020

python / cpython

Sponsor python/cpython

Join GitHub today

Fix typo in multiprocessing.pool.AsyncResult.successful doc. #17932

Fix typo in multiprocessing.pool.AsyncResult.successful doc. #17932

Conversation

awecx commented Jan 9, 2020 • edited by miss-islington

aeros left a comment • edited

This comment has been minimized.

aeros commented Jan 9, 2020

This comment has been minimized.

awecx commented Jan 10, 2020

pitrou left a comment

This comment has been minimized.

miss-islington commented Jan 15, 2020

This comment has been minimized.

bedevere-bot commented Jan 15, 2020

This comment has been minimized.

bedevere-bot commented Jan 15, 2020

awecx commented Jan 9, 2020 •

edited by miss-islington

aeros left a comment •

edited