Skip to content

Make mocker.patch.dict documentation clearer on actual behavior #117765

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
radhikamattoo opened this issue Apr 11, 2024 · 1 comment
Closed

Make mocker.patch.dict documentation clearer on actual behavior #117765

radhikamattoo opened this issue Apr 11, 2024 · 1 comment
Labels
docs Documentation in the Doc dir

Comments

@radhikamattoo
Copy link

radhikamattoo commented Apr 11, 2024 •
edited by bedevere-app bot
Loading

Documentation

The docs for patch.dict method is:

Patch a dictionary, or dictionary like object, and restore the dictionary to its original state after the test.

The phrase "to its original state" can be misleading, because this method actually restores a copy of the original data.

I ran into strange behavior with my tests because of my assumption this method would restore the original values, not copies of them.

Let me know if I'm misunderstanding anything :) Thanks all for your hard work!

Linked PRs
@radhikamattoo radhikamattoo added the docs Documentation in the Doc dir label Apr 11, 2024
@bedevere-app bedevere-app bot mentioned this issue Jul 14, 2024
Merged
cjw296 pushed a commit that referenced this issue Jul 15, 2024
@GovernmentPlates
gh-117765: Improve documentation for mocker.patch.dict (#121755)
8303d32
estyxx pushed a commit to estyxx/cpython that referenced this issue Jul 17, 2024
@GovernmentPlates @estyxx
pythongh-117765: Improve documentation for mocker.patch.dict (pytho…
d89c54d 
…n#121755)
@hugovk
Copy link
Member

hugovk commented Aug 8, 2024

Triage: closing because the PR has been merged, please re-open if still needed. Thanks!

@hugovk hugovk closed this as completed Aug 8, 2024
@github-project-automation github-project-automation bot moved this from Todo to Done in Unittest issues Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir
Projects
Unittest issues
Status: Done
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hugovk @radhikamattoo