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