CODEWITHSUNDEEP
pythonpython-unittestmagicmock
Mehdi Jafarnia Jahromi
Mehdi Jafarnia Jahromi

Reputation: 2197

Python returns MagicMock object instead of return_value

I have a python file a.py which contains two classes A and B.

class A(object):
    def method_a(self):
        return "Class A method a"

class B(object):
    def method_b(self):
        a = A()
        print a.method_a()

I would like to unittest method_b in class B by mocking A. Here is the content of the file testa.py for this purpose:

import unittest
import mock
import a


class TestB(unittest.TestCase):

    @mock.patch('a.A')
    def test_method_b(self, mock_a):
        mock_a.method_a.return_value = 'Mocked A'
        b = a.B()
        b.method_b()


if __name__ == '__main__':
    unittest.main()

I expect to get Mocked A in the output. But what I get is:

<MagicMock name='A().method_a()' id='4326621392'>

Where am I doing wrong?

Upvotes: 175

Views: 145073

Answers (3)

jonrsharpe
jonrsharpe

Reputation: 122024

When you @mock.patch('a.A'), you are replacing the class A in the code under test with mock_a.

In B.method_b you then set a = A(), which is now a = mock_a() - i.e. a is the return_value of mock_a. As you haven't specified this value, it's a regular MagicMock; this isn't configured either, so you get the default response (yet another MagicMock) when calling methods on it.

Instead, you want to configure the return_value of mock_a to have the appropriate method, which you can do as either:

mock_a().method_a.return_value = 'Mocked A' 
    # ^ note parentheses

or, perhaps more explicitly (and, as mentioned in the comments, avoiding adding an entry to mock_a's call list):

mock_a.return_value.method_a.return_value = 'Mocked A'

Your code would have worked in the case a = A (assigning the class, not creating an instance), as then a.method_a() would have triggered your mock method.

Upvotes: 221

natielle
natielle

Reputation: 426

In my case, my return_value was this {"key1": "value1"}. So I needed to cast this with dict() before applying the patch.

Like this:

@fixture
def mock_something(mocker: MockFixture, request: SubRequest) -> MagicMock:
    method_to_mock = f"your_module.YourClass.some_method"
    return_value = dict(request.param)
    if isinstance(return_value, Exception):
        return mocker.patch(method_to_mock, side_effect=return_value)
    return mocker.patch(method_to_mock, return_value=return_value)

Upvotes: 0

ndrini
ndrini

Reputation: 103

In case of mocking an object I use this syntax:

@mock.patch.object(
    a.A,
    'method_a',
    lambda a: "Mocked A")
def test_method_b(self):
    b = a.B()
    b.method_b()

In this case the method_a is mocked by the lambda function.

Upvotes: 4

Related Questions