monkeypatch.setattr in PyTest - Test Execution Trace

Test Overview

This test uses monkeypatch.setattr to replace a function temporarily during the test. It verifies that the patched function is called and returns the expected mocked value.

Test Code - pytest

PyTest

import pytest

def get_data():
    return "original data"

def test_monkeypatch_setattr(monkeypatch):
    def mock_get_data():
        return "mocked data"

    monkeypatch.setattr(__name__, "get_data", mock_get_data)

    result = get_data()
    assert result == "mocked data"

Execution Trace - 6 Steps

Step	Action	System State	Assertion	Result
1	Test starts and pytest initializes the test environment	Test environment ready, no patches applied yet	—	PASS
2	Defines mock_get_data function returning 'mocked data'	mock_get_data function available in test scope	—	PASS
3	Calls monkeypatch.setattr to replace get_data with mock_get_data	get_data function temporarily replaced by mock_get_data	—	PASS
4	Calls get_data() which now points to mock_get_data	get_data returns 'mocked data'	Check that result equals 'mocked data'	PASS
5	Assertion verifies that returned value is 'mocked data'	Assertion passes confirming patch worked	assert result == 'mocked data'	PASS
6	Test ends and pytest restores original get_data function	Original get_data function restored after test	—	PASS

Failure Scenario

Failing Condition: monkeypatch.setattr fails to replace get_data or patch is not applied

Execution Trace Quiz - 3 Questions

What does monkeypatch.setattr do in this test?

A Deletes the get_data function

B Permanently changes get_data function in the module

C Temporarily replaces get_data with mock_get_data during the test

D Calls the original get_data function

Key Result

Use monkeypatch.setattr to replace functions or attributes temporarily during tests. This helps isolate code and test behavior without changing real implementations.

Practice

1. What is the main purpose of monkeypatch.setattr in pytest?

easy

A. To temporarily replace an attribute or function during a test

B. To permanently change code in the source files

C. To skip a test function

D. To run tests in parallel

Solution

1. Step 1: Understand monkeypatch.setattr usage

   It is used to temporarily replace or modify attributes or functions during a test to isolate behavior.

2. Step 2: Differentiate from other pytest features

   It does not permanently change code or skip tests; it only affects the test scope temporarily.

3. Final Answer:

   To temporarily replace an attribute or function during a test -> Option A

4. Quick Check:

   Temporary replacement = A [OK]

Hint: Think 'temporary change' during test only [OK]

Common Mistakes:

• Confusing temporary patching with permanent code changes
• Thinking it skips tests
• Assuming it runs tests in parallel

2. Which of the following is the correct syntax to patch the function get_data in module my_module using monkeypatch in pytest?

easy

A. monkeypatch.setattr('get_data', my_module, lambda: 42)

B. monkeypatch.setattr('my_module.get_data', lambda: 42)

C. monkeypatch.setattr(my_module, 'get_data', lambda: 42)

D. monkeypatch.setattr('my_module', 'get_data', 42)

Solution

1. Step 1: Identify correct monkeypatch.setattr signature

   The correct usage is monkeypatch.setattr(target_object, attribute_name, new_value).

2. Step 2: Match parameters to patch get_data function

   We pass the module object my_module, the attribute name 'get_data', and the replacement function lambda: 42.

3. Final Answer:

   monkeypatch.setattr(my_module, 'get_data', lambda: 42) -> Option C

4. Quick Check:

   Object, attribute, new value = A [OK]

Hint: Pass object, attribute name, then new value [OK]

Common Mistakes:

• Passing attribute as a string path instead of object and attribute
• Swapping parameters order
• Passing value instead of function for patching

3. Given the code below, what will be the output of the test?

import my_module

def test_func(monkeypatch):
    def fake_func():
        return 10
    monkeypatch.setattr(my_module, 'get_value', fake_func)
    result = my_module.get_value()
    print(result)

medium

A. None

B. Original value from my_module.get_value()

C. AttributeError

D. 10

Solution

1. Step 1: Understand monkeypatch effect on get_value

   The original my_module.get_value is replaced temporarily by fake_func which returns 10.

2. Step 2: Evaluate the call and print output

   Calling my_module.get_value() inside the test calls fake_func(), so it prints 10.

3. Final Answer:

   10 -> Option D

4. Quick Check:

   Patched function returns 10 [OK]

Hint: Patched function output replaces original during test [OK]

Common Mistakes:

• Expecting original function output instead of patched
• Thinking patch is permanent outside test
• Assuming print outputs None

4. What is wrong with the following pytest test using monkeypatch?

def test_example(monkeypatch):
    monkeypatch.setattr('os.path.exists', lambda x: True)
    assert os.path.exists('anyfile.txt') == True

medium

A. The lambda function should accept no arguments

B. The first argument to setattr should be the module object, not a string

C. os.path.exists cannot be patched

D. The assert statement is incorrect

Solution

1. Step 1: Check monkeypatch.setattr usage

   The first argument must be the module or object, not a string path.

2. Step 2: Identify correct usage

   It should be monkeypatch.setattr(os.path, 'exists', lambda x: True) to patch the function properly.

3. Final Answer:

   The first argument to setattr should be the module object, not a string -> Option B

4. Quick Check:

   Object, not string path = B [OK]

Hint: Pass object, not string path, as first argument [OK]

Common Mistakes:

• Passing string path instead of module object
• Incorrect lambda parameters
• Assuming some functions cannot be patched

5. You want to test a function fetch_data() that calls requests.get. How can you use monkeypatch.setattr to replace requests.get with a fake function that returns a mock response with status_code=200 and text='OK'?

hard

A. Define a fake function returning a mock object, then patch with monkeypatch.setattr(requests, 'get', fake_func)

B. Patch requests.get with a string 'mock' using monkeypatch.setattr

C. Use monkeypatch.setattr('requests.get', fake_func) with a lambda returning 200

D. Replace fetch_data with a fake function instead of patching requests.get

Solution

1. Step 1: Create a fake function returning a mock response

   Define a function that returns an object with status_code=200 and text='OK'.

2. Step 2: Patch requests.get with monkeypatch.setattr

   Use monkeypatch.setattr(requests, 'get', fake_func) to replace the real HTTP call during the test.

3. Final Answer:

   Define a fake function returning a mock object, then patch with monkeypatch.setattr(requests, 'get', fake_func) -> Option A

4. Quick Check:

   Patch requests.get with fake function = D [OK]

Hint: Patch requests.get with a fake function returning mock response [OK]

Common Mistakes:

• Passing string path instead of module object
• Patching with wrong types like strings
• Replacing the wrong function instead of requests.get