bpo-37955: mock.patch incorrect reference to Mock by phsilva · Pull Request #15521 · python/cpython

phsilva · 2019-08-26T15:24:54Z

mock.patch mentions that keyword arguments are passed
to Mock when it passes to MagicMock by default.

This PR fixes that.

https://bugs.python.org/issue37955

the-knights-who-say-ni · 2019-08-26T15:24:58Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Our records indicate we have not received your CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for your contribution, we look forward to reviewing it!

tirkarthi · 2019-08-26T15:38:49Z

Changing the hyperlink to Mock sounds good to me. But also note like #13681 from 3.8 the default value could be MagicMock or AsyncMock depends on the target. cc: @mariocj89 @cjw296

mock.patch mentions that keyword arguments are passed to Mock when it passes to MagicMock by default. This PR fixes that.

phsilva · 2019-08-26T17:24:06Z

Changing the hyperlink to Mock sounds good to me. But also note like #13681 from 3.8 the default value could be MagicMock or AsyncMock depends on the target. cc: @mariocj89 @cjw296

The issue on #13681 seems important, the return value on those functions is mostly undocumented right now (since 3.8 changes).

Maybe we should stop mentioning what the actual return type is and say it is whatever is on new_callable and at new_callable we can mention that it depends based on async or not.

This patch adds information about possible use of a AsyncMock when passing arbitrary arguments to mock.patch.

phsilva · 2019-11-30T07:24:53Z

Latest patch adjust the text to account the suggestions. Appreciate any reviews.

cjw296 · 2019-12-01T22:09:07Z

 `patch` takes arbitrary keyword arguments. These will be passed to
- the `Mock` (or `new_callable`) on construction.
+ to construct a `AsyncMock` if the patched object is an async function,
+ to `MagicMock` otherwise or to `new_callable` if specified.


Is there any way we could not have this text duplicated between mock.py and mock.rst?

I am new to Python docs, but as far as I looked around there is a lot of duplication between .rst and .py in many modules, will need to ask around about if there is another way.

It makes this a more substantial PR, but Sphinx autodoc should be able to pull in the .py's docstrings. Not sure if autodoc is enabled for the CPython docs, that would be some more digging on your part :-)

Will take a look into it, but it looks like all modules actually repeats docs in Doc and in Lib, will ask around why.

How did the asking around go?

bedevere-bot · 2019-12-01T22:09:13Z

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.

phsilva · 2019-12-02T08:36:27Z

I have made the requested changes; please review again.

bedevere-bot · 2019-12-02T08:36:30Z

Thanks for making the requested changes!

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

phsilva · 2019-12-10T01:38:27Z

I have made the requested changes; please review again.

bedevere-bot · 2019-12-10T01:38:29Z

Thanks for making the requested changes!

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

phsilva · 2020-01-15T02:09:12Z

Hi, would be great if can get some review here... Thanks a lot! @lisroach @cjw296

cjw296 · 2020-01-24T07:54:17Z

@csabella: waiting for a response to #15521 (comment)

cjw296

Actually, let's leave the bigger change for another time.

csabella · 2020-01-25T11:04:03Z

Thanks!

…ythonGH-15521)

the-knights-who-say-ni added the CLA not signed label Aug 26, 2019

bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 26, 2019

bpo-37955: mock.patch incorrect reference to Mock
6578726
mock.patch mentions that keyword arguments are passed to Mock when it passes to MagicMock by default. This PR fixes that.

phsilva force-pushed the bpo-37955-incorrect-reference-in-mock-patch-doc branch from 6c0f647 to 6578726Compare August 26, 2019 16:08

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Aug 27, 2019

bpo-37955: includes reference to AsyncMock
7c55aaa
This patch adds information about possible use of a AsyncMock when passing arbitrary arguments to mock.patch.

cjw296 requested changes Dec 1, 2019
View reviewed changes

bedevere-bot added awaiting changes and removed awaiting review labels Dec 1, 2019

bpo-37955: fix grammar and simplify wording
39dd5a0

bedevere-bot added awaiting change review and removed awaiting changes labels Dec 2, 2019

bedevere-bot requested a review from cjw296 December 2, 2019 08:36

cjw296 reviewed Dec 9, 2019
View reviewed changes

Comment threadDoc/library/unittest.mock.rst Outdated

bpo-37955: clarify relation to other async objects
bebae7a

bedevere-bot requested a review from cjw296 December 10, 2019 01:38

bpo-37955: remove trailing whitespace
0744968

phsilva requested a review from lisroach December 12, 2019 03:41

csabella requested review from cjw296, lisroach and tirkarthi and removed request for cjw296 and lisroach January 21, 2020 12:23

cjw296 approved these changes Jan 25, 2020
View reviewed changes

bedevere-bot added awaiting merge and removed awaiting change review labels Jan 25, 2020

cjw296 added the skip news label Jan 25, 2020

cjw296 merged commit 40c0809 into python:masterJan 25, 2020

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

shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
bpo-37955: correct mock.patch docs with respect to the returned type (p…
b9840e5
…ythonGH-15521)

Uh oh!

Uh oh!

Conversation

phsilva commented Aug 26, 2019• edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Aug 26, 2019

Uh oh!

tirkarthi commented Aug 26, 2019

Uh oh!

phsilva commented Aug 26, 2019

Uh oh!

phsilva commented Nov 30, 2019

Uh oh!

Uh oh!

cjw296Dec 1, 2019

Choose a reason for hiding this comment

Uh oh!

phsilvaDec 2, 2019

Choose a reason for hiding this comment

Uh oh!

cjw296Dec 9, 2019

Choose a reason for hiding this comment

Uh oh!

phsilvaDec 10, 2019

Choose a reason for hiding this comment

Uh oh!

cjw296Jan 15, 2020

Choose a reason for hiding this comment

Uh oh!

bedevere-bot commented Dec 1, 2019

Uh oh!

phsilva commented Dec 2, 2019

Uh oh!

bedevere-bot commented Dec 2, 2019

Uh oh!

Uh oh!

phsilva commented Dec 10, 2019

Uh oh!

bedevere-bot commented Dec 10, 2019

Uh oh!

phsilva commented Jan 15, 2020

Uh oh!

cjw296 commented Jan 24, 2020

Uh oh!

cjw296 left a comment

Choose a reason for hiding this comment

Uh oh!

csabella commented Jan 25, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

phsilva commented Aug 26, 2019•
edited by bedevere-bot
Loading