https://github.com/python/cpython/commit/19fed6cf6eb51044fd0c02c6338259e2dd7fd462
commit: 19fed6cf6eb51044fd0c02c6338259e2dd7fd462
branch: main
author: sobolevn <[email protected]>
committer: sobolevn <[email protected]>
date: 2024-09-26T15:06:52+03:00
summary:
gh-124234: Improve docs for `Mock.reset_mock` (#124237)
files:
M Doc/library/unittest.mock.rst
M Lib/unittest/mock.py
diff --git a/Doc/library/unittest.mock.rst b/Doc/library/unittest.mock.rst
index d603a163c2e82d..cc2b1b4299553c 100644
--- a/Doc/library/unittest.mock.rst
+++ b/Doc/library/unittest.mock.rst
@@ -401,6 +401,8 @@ the *new_callable* argument to :func:`patch`.
The reset_mock method resets all the call attributes on a mock object:
+ .. doctest::
+
>>> mock = Mock(return_value=None)
>>> mock('hello')
>>> mock.called
@@ -409,20 +411,41 @@ the *new_callable* argument to :func:`patch`.
>>> mock.called
False
- .. versionchanged:: 3.6
- Added two keyword-only arguments to the reset_mock function.
-
This can be useful where you want to make a series of assertions that
- reuse the same object. Note that :meth:`reset_mock` *doesn't* clear the
+ reuse the same object.
+
+ *return_value* parameter when set to ``True`` resets
:attr:`return_value`:
+
+ .. doctest::
+
+ >>> mock = Mock(return_value=5)
+ >>> mock('hello')
+ 5
+ >>> mock.reset_mock(return_value=True)
+ >>> mock('hello') # doctest: +ELLIPSIS
+ <Mock name='mock()' id='...'>
+
+ *side_effect* parameter when set to ``True`` resets
:attr:`side_effect`:
+
+ .. doctest::
+
+ >>> mock = Mock(side_effect=ValueError)
+ >>> mock('hello')
+ Traceback (most recent call last):
+ ...
+ ValueError
+ >>> mock.reset_mock(side_effect=True)
+ >>> mock('hello') # doctest: +ELLIPSIS
+ <Mock name='mock()' id='...'>
+
+ Note that :meth:`reset_mock` *doesn't* clear the
:attr:`return_value`, :attr:`side_effect` or any child attributes you
have
- set using normal assignment by default. In case you want to reset
- :attr:`return_value` or :attr:`side_effect`, then pass the
corresponding
- parameter as ``True``. Child mocks and the return value mock
- (if any) are reset as well.
+ set using normal assignment by default.
- .. note:: *return_value*, and *side_effect* are keyword-only
- arguments.
+ Child mocks are reset as well.
+ .. versionchanged:: 3.6
+ Added two keyword-only arguments to the reset_mock function.
.. method:: mock_add_spec(spec, spec_set=False)
diff --git a/Lib/unittest/mock.py b/Lib/unittest/mock.py
index bb34c7436047ad..df3901f9660ac1 100644
--- a/Lib/unittest/mock.py
+++ b/Lib/unittest/mock.py
@@ -628,7 +628,9 @@ def __set_side_effect(self, value):
side_effect = property(__get_side_effect, __set_side_effect)
- def reset_mock(self, visited=None, *, return_value=False,
side_effect=False):
+ def reset_mock(self, visited=None, *,
+ return_value: bool = False,
+ side_effect: bool = False):
"Restore the mock object to its initial state."
if visited is None:
visited = []
@@ -2218,7 +2220,7 @@ def mock_add_spec(self, spec, spec_set=False):
self._mock_add_spec(spec, spec_set)
self._mock_set_magics()
- def reset_mock(self, /, *args, return_value=False, **kwargs):
+ def reset_mock(self, /, *args, return_value: bool = False, **kwargs):
if (
return_value
and self._mock_name
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
