GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — bpo-37955: mock.patch incorrect reference to Mock by phsilva · Pull Request #15521 · python/cpython

Conversation

@phsilva

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

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@the-knights-who-say-ni the-knights-who-say-ni added the CLA not signed label Aug 26, 2019
@the-knights-who-say-ni

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

Copy link
Copy Markdown

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!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Aug 26, 2019
@tirkarthi

tirkarthi commented Aug 26, 2019

Copy link
Copy Markdown
Member

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
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Paulo Henrique Silva
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
phsilva force-pushed the bpo-37955-incorrect-reference-in-mock-patch-doc branch from 6c0f647 to 6578726 Compare August 26, 2019 16:08
@phsilva

phsilva commented Aug 26, 2019

Copy link
Copy Markdown
Contributor Author

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@the-knights-who-say-ni the-knights-who-say-ni added CLA signed and removed CLA not signed labels Aug 27, 2019
Paulo Henrique Silva
bpo-37955: includes reference to AsyncMock
7c55aaa 
This patch adds information about possible use of a AsyncMock
when passing arbitrary arguments to mock.patch.
@phsilva

phsilva commented Nov 30, 2019

Copy link
Copy Markdown
Contributor Author

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
cjw296
cjw296 requested changes Dec 1, 2019
View reviewed changes
Comment thread Doc/library/unittest.mock.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Comment thread Lib/unittest/mock.py Outdated
`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.

@cjw296 cjw296 Dec 1, 2019

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@phsilva phsilva Dec 2, 2019

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@cjw296 cjw296 Dec 9, 2019

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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 :-)

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@phsilva phsilva Dec 10, 2019

Copy link
Copy Markdown
Contributor Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@cjw296 cjw296 Jan 15, 2020

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

How did the asking around go?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot

bedevere-bot commented Dec 1, 2019

Copy link
Copy Markdown

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.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot added awaiting changes and removed awaiting review labels Dec 1, 2019
Paulo Henrique Silva
bpo-37955: fix grammar and simplify wording
39dd5a0
@phsilva

phsilva commented Dec 2, 2019

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot bedevere-bot added awaiting change review and removed awaiting changes labels Dec 2, 2019
@bedevere-bot

bedevere-bot commented Dec 2, 2019

Copy link
Copy Markdown

Thanks for making the requested changes!

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot
bedevere-bot requested a review from cjw296 December 2, 2019 08:36
cjw296
cjw296 reviewed Dec 9, 2019
View reviewed changes
Comment thread Doc/library/unittest.mock.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.
Paulo Henrique Silva
bpo-37955: clarify relation to other async objects
bebae7a
@phsilva

phsilva commented Dec 10, 2019

Copy link
Copy Markdown
Contributor Author

I have made the requested changes; please review again.
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot

bedevere-bot commented Dec 10, 2019

Copy link
Copy Markdown

Thanks for making the requested changes!

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@bedevere-bot
bedevere-bot requested a review from cjw296 December 10, 2019 01:38
Paulo Henrique Silva
bpo-37955: remove trailing whitespace
0744968
@phsilva
phsilva requested a review from lisroach December 12, 2019 03:41
@phsilva

phsilva commented Jan 15, 2020

Copy link
Copy Markdown
Contributor Author

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
@csabella
csabella requested review from cjw296, lisroach and tirkarthi and removed request for cjw296 and lisroach January 21, 2020 12:23
@cjw296

cjw296 commented Jan 24, 2020

Copy link
Copy Markdown
Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
cjw296
cjw296 approved these changes Jan 25, 2020
View reviewed changes

@cjw296 cjw296 left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

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

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@bedevere-bot bedevere-bot added awaiting merge and removed awaiting change review labels Jan 25, 2020
@cjw296 cjw296 added the skip news label Jan 25, 2020
@cjw296
cjw296 merged commit 40c0809 into python:master Jan 25, 2020
@bedevere-bot bedevere-bot removed the awaiting merge label Jan 25, 2020
@csabella

csabella commented Jan 25, 2020

Copy link
Copy Markdown
Contributor

Thanks!
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
shihai1991 pushed a commit to shihai1991/cpython that referenced this pull request Jan 31, 2020
@phsilva @shihai1991
bpo-37955: correct mock.patch docs with respect to the returned type (p…
b9840e5 
…ythonGH-15521)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cjw296 cjw296 cjw296 approved these changes
@lisroach lisroach Awaiting requested review from lisroach
@tirkarthi tirkarthi Awaiting requested review from tirkarthi

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

7 participants

@phsilva @the-knights-who-say-ni @tirkarthi @bedevere-bot @cjw296 @csabella @lisroach
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.