monkeypatch.setattr in PyTest

Introduction

We use monkeypatch.setattr to temporarily change how a part of the code works during a test. This helps us test without changing the real code.

When you want to replace a function or variable with a fake one to control test behavior.

When you need to avoid calling slow or external services during tests.

When you want to simulate different return values from a function to test various cases.

When you want to fix the value of a variable that normally changes during runtime.

When you want to isolate the part of code you are testing from other parts.

Syntax

PyTest

monkeypatch.setattr(target, name, value, raising=True)

target can be a module, class, or object where the attribute lives.

name is the attribute name as a string.

value is the new value or function you want to set temporarily.

Examples

Replace a function in a module with a fake function.

PyTest

monkeypatch.setattr(module, "function_name", fake_function)

Change an object's attribute to 42 during the test.

PyTest

monkeypatch.setattr(obj, "attribute", 42)

Change a class attribute by its full path as a string.

PyTest

monkeypatch.setattr("module.ClassName.attribute", "new_value")

Sample Program

This test replaces the multiply method of Calculator with a fake function that always returns 42. It checks that the replacement works by asserting the result is 42.

PyTest

import pytest

class Calculator:
    def multiply(self, a, b):
        return a * b

def fake_multiply(a, b):
    return 42

def test_multiply(monkeypatch):
    calc = Calculator()
    # Replace multiply method with fake_multiply
    monkeypatch.setattr(calc, "multiply", fake_multiply)
    result = calc.multiply(3, 5)
    assert result == 42
    print(f"Result after monkeypatch: {result}")

Important Notes

The change made by monkeypatch.setattr lasts only during the test. After the test ends, the original code is restored.

Use monkeypatch as a test function argument to get access to it.

Setting raising=False prevents errors if the attribute does not exist.

Summary

monkeypatch.setattr lets you temporarily change code parts during tests.

It helps test code in isolation by replacing functions or variables.

Changes are undone automatically after the test finishes.

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