Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

gh-117765: Improve documentation for `mocker.patch.dict` (#121755)

This commit is contained in:
Dominic H 2024-07-15 09:14:17 +02:00 committed by GitHub
parent 48042c52a6
commit 8303d32ff5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Doc/library/unittest.mock.rst
View File

@ -1624,7 +1624,8 @@ patch.dict
.. function:: patch.dict(in_dict, values=(), clear=False, **kwargs)
Patch a dictionary, or dictionary like object, and restore the dictionary
to its original state after the test.
to its original state after the test, where the restored dictionary is a
copy of the dictionary as it was before the test.
*in_dict* can be a dictionary or a mapping like container. If it is a
mapping then it must at least support getting, setting and deleting items

3
Lib/unittest/mock.py
View File

@ -1829,7 +1829,8 @@ def patch(
class _patch_dict(object):
"""
Patch a dictionary, or dictionary like object, and restore the dictionary
to its original state after the test.
to its original state after the test, where the restored dictionary is
a copy of the dictionary as it was before the test.
`in_dict` can be a dictionary or a mapping like container. If it is a
mapping then it must at least support getting, setting and deleting items

1
Misc/NEWS.d/next/Documentation/2024-07-14-12-25-53.gh-issue-117765.YFMOUv.rst Normal file
View File

@ -0,0 +1 @@
Improved documentation for :func:`unittest.mock.patch.dict`