Monkey patch a python function - issue

Question

I'm in trouble replacing a python function from a different module with a TestClass

I'm trying to test a part of my code that contains the function in a module; more in details I would like monkey patch this function.

So, the situation is similar to the following:

Function in the module

def function_in_module():
    # do some stuff
    return 'ok'

Part of my code that I would like testing

from dir_1.dir_2.dir_3.module_name import function_in_module
class ExampleClass():
    def __init__(self):
        # do some stuff
        self.var_x = function_in_module()
        # do some stuff again

Test class

from dir_1.dir_2.dir_3 import module_name
class TestClass(TestCase):
    de_monkey = {}
    mp = None

    def setUp(self):
        # save original one
        self.de_monkey['function_in_module'] = module_name.function_in_module()
        if self.mp is None:
            self.mp = MP()

    def tearDown(self):
        # rollback at the end
        module_name.function_in_module = self.de_monkey['function_in_module']

    def test_string(self):
        module_name.function_in_module = self.mp.monkey_function_in_module
        test_obj = ExampleClass()
        self.assertEqual(test_obj.var_x, 'not ok')

class MP(object):

    @staticmethod
    def monkey_function_in_module(self):
        return 'not ok'

As the assert statement shows, the expected result is 'not ok', but the result is 'ok'.

I have debugged about this and seems that the different way to call the functions is the reason because this monkey patch doesn't work.

In fact, if I try to call the function in ExampleClass in this way

self.var_x = module_name.function_in_module()

works correctly.

What am I missing? maybe it's a banality but it's driving me crazy

Thank you in advance

Daniel Roseman · Accepted Answer · 2016-12-14 12:06:08Z

1

Your code under test imports function_in_module and references it directly. Changing the value of module_name.function_in_module has no effect on the code.

You should replace the function directly in the module that contains the code under test, not in the source module.

Note that your life would be easier if you used the mock library, although the question of where to patch would still be the same.

answered Dec 14, 2016 at 12:06

Daniel Roseman

602k68 gold badges910 silver badges923 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

chepner Over a year ago

Related, the OP is also calling the function in question and saving its return value, not saving the function itself.

Giordano Over a year ago

Sorry @Daniel, do you mean that I should call function_in_module in def test_string like this function_in_module = self.mp.monkey_function_in_module or I don't understood?

Daniel Roseman Over a year ago

No, not at all. You should do module_that_defines_ExampleClass.function_in_module = .... And note what chepner said as well.

Collectives™ on Stack Overflow

Monkey patch a python function - issue

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related