monkeypatch.setattr in PyTest - Build an Automation Script

Automate patching an attribute using monkeypatch.setattr in pytest

Preconditions (2)

Step 1: Create a test function using pytest

Step 2: Use monkeypatch.setattr to replace the target function or attribute with a mock or dummy function/value

Step 3: Call the function under test that uses the patched attribute

Step 4: Verify the output or behavior reflects the patched attribute

✅ Expected Result: The test passes confirming the attribute was successfully patched and the function behaves as expected

Automation Requirements - pytest

Assertions Needed:

Assert the function output matches the expected value after patching

Assert the patched attribute was used instead of the original

Best Practices:

Use monkeypatch fixture provided by pytest

Patch only what is necessary for the test

Keep tests isolated and independent

Use clear and descriptive test function names

Automated Solution

PyTest

import pytest

# Original module with function to patch
class MyClass:
    def method(self):
        return "original value"

def function_under_test(obj):
    return obj.method()

# Test function using monkeypatch

def test_function_under_test(monkeypatch):
    # Define a dummy method to replace the original
    def dummy_method():
        return "patched value"

    # Patch the method attribute of MyClass instance
    monkeypatch.setattr(MyClass, "method", dummy_method)

    obj = MyClass()
    result = function_under_test(obj)

    # Assert the patched method is used
    assert result == "patched value"

This test uses pytest's monkeypatch fixture to replace the method of MyClass with a dummy function that returns a fixed string.

When function_under_test calls obj.method(), it gets the patched return value instead of the original.

The assertion checks that the patch worked by verifying the returned string is the patched one.

This approach isolates the test from the original method implementation, allowing controlled testing.

Common Mistakes - 3 Pitfalls

{'mistake': 'Not using the monkeypatch fixture parameter in the test function', 'why_bad': 'Without the fixture, monkeypatch methods are not available and patching will fail', 'correct_approach': "Always include 'monkeypatch' as a parameter in the test function to access the fixture"}

Patching the wrong attribute or using incorrect attribute path

Patching too broadly or globally affecting other tests

Bonus Challenge

Now add data-driven testing to patch different methods with different return values

Show Hint

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