Skip to content

Commit

Permalink
pythongh-124234: Improve docs for Mock.reset_mock
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn committed Sep 19, 2024
1 parent 7628f67 commit bc373b5
Showing 1 changed file with 33 additions and 10 deletions.
43 changes: 33 additions & 10 deletions Doc/library/unittest.mock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

Expand Down

0 comments on commit bc373b5

Please sign in to comment.