Skip to content

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

Merged
miss-islington merged 1 commit into
python:masterfrom
awecx:multiprocessing-doc-typo
Jan 15, 2020
Merged

Fix typo in multiprocessing.pool.AsyncResult.successful doc.#17932
miss-islington merged 1 commit into
python:masterfrom
awecx:multiprocessing-doc-typo

Conversation

@awecx

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

Copy link
Copy Markdown
Contributor

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

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jan 9, 2020
aeros
aeros approved these changes Jan 9, 2020
View reviewed changes

@aeros aeros left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 aeros assigned pitrou and unassigned pitrou Jan 9, 2020
@aeros aeros requested a review from pitrou January 9, 2020 22:46
@aeros

aeros commented Jan 9, 2020

Copy link
Copy Markdown
Contributor

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

@awecx

awecx commented Jan 10, 2020

Copy link
Copy Markdown
Contributor Author

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
pitrou approved these changes Jan 15, 2020
View reviewed changes

@pitrou pitrou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1

@miss-islington miss-islington merged commit dc0284e into python:master Jan 15, 2020
@miss-islington

miss-islington commented Jan 15, 2020

Copy link
Copy Markdown
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 15, 2020
@awecx @miss-islington
Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…
54d6e06 
…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

bedevere-bot commented Jan 15, 2020

Copy link
Copy Markdown

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 15, 2020
@awecx @miss-islington
Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…
f7c86f0 
…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

bedevere-bot commented Jan 15, 2020

Copy link
Copy Markdown

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

miss-islington added a commit that referenced this pull request Jan 15, 2020
@miss-islington
[3.8] Fix typo in multiprocessing.pool.AsyncResult.successful doc. (G…
54abd28 
…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
miss-islington added a commit that referenced this pull request Jan 15, 2020
@miss-islington
[3.7] Fix typo in multiprocessing.pool.AsyncResult.successful doc. (G…
74b95b6 
…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
sthagen added a commit to sthagen/python-cpython that referenced this pull request Jan 15, 2020
@sthagen
Merge pull request #184 from python/master
a1b8199 
Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonGH-17932)
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
@awecx @shihai1991
Fix typo in multiprocessing.pool.AsyncResult.successful doc. (pythonG…
d8352e4 
…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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pitrou pitrou pitrou approved these changes
+1 more reviewer
@aeros aeros aeros approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@awecx @aeros @miss-islington @bedevere-bot @pitrou @the-knights-who-say-ni