Fix for:

• Issue: create_autospec() doesn't respect configure_mock style kwargs #90848

Description

All mocks can be pre-configured with side_effect and return_value by passing them to kwargs which are consumed by the Mock class. But unittest.mock.create_autospec function is ignoring kwargs so, the user has to configure them later in the code after the initialization of the mock.

Test To Reproduce

from unittest import mock

import pytest


class Result:
    def get_result(self):
        pass


@pytest.mark.xfail
def test_result():
    class_mock = create_autospec(spec=Result, **{'return_value.get_result.side_effect': ValueError})
    with pytest.raises(ValueError):
        classmock().get_result()


def test_result_configure_later():
    class_mock = create_autospec(spec=Result)
    class_mock.return_value.get_result.side_effect = ValueError
    with pytest.raises(ValueError):
        classmock().get_result()

Details

This is the line 👇 which is consuming kwargs during the initialization of the mock:

Here 👇 we are overriding the return_value of the mock by creating a new mock on it but this is not the problem:

As it is being called recursively 👆, the attributes of the specced object will also be mocked by creating child mocks 👇:

Then the child mocks are set on the recursive mock 👇:

This 👆 is the cause of the issue. We have set new child attribute mock which is not configured.

Fix Suggested by @tirkarthi

+    if _is_instance_mock(mock) and kwargs:
+        mock.configure_mock(**kwargs)

      return mock

Code Changes

1. Added the above patch which will configure the parent mock only at the end because the user will pass kwargs with respect to the parent mock.
2. Renamed local variable kwargs to child_kwargs because it was shadowing the name of the argument which is now being used to configure the parent mock.
3. This 👇 should be popped because it will not be used again when configuring the parent mock at the end.

-    wrapped = kwargs.get('wraps')
+    # Pop wraps from kwargs because it must not be passed to configure_mock.
+    wrapped = kwargs.pop('wraps', None)