monkeypatch fixture in PyTest

Introduction

The monkeypatch fixture lets you change parts of your code during tests without changing the real code. It helps test tricky parts safely.

When you want to replace a function with a simple version for testing.

When you need to change environment variables temporarily during a test.

When you want to avoid calling slow or external services in tests.

When you want to change a class or method behavior just for one test.

When you want to simulate errors or special cases easily.

Syntax

PyTest

def test_example(monkeypatch):
    monkeypatch.setattr(target, "name", new_value)
    monkeypatch.setenv("VAR_NAME", "value")
    monkeypatch.delattr(target, "name", raising=False)

monkeypatch is a special argument you add to your test function.

You can change attributes, environment variables, or delete attributes safely.

Examples

This replaces module.func with fake_func during the test.

PyTest

def test_replace_function(monkeypatch):
    def fake_func():
        return "fake"
    monkeypatch.setattr("module.func", fake_func)
    assert module.func() == "fake"

This sets an environment variable API_KEY just for the test.

PyTest

def test_change_env(monkeypatch):
    monkeypatch.setenv("API_KEY", "12345")
    assert os.getenv("API_KEY") == "12345"

This deletes an attribute temporarily to test behavior without it.

PyTest

def test_remove_attribute(monkeypatch):
    monkeypatch.delattr("module.Class.attr", raising=False)
    assert not hasattr(module.Class, "attr")

Sample Program

This test uses monkeypatch to set and delete an environment variable API_KEY. It checks that get_api_key() returns the right value depending on the environment.

PyTest

import os

def get_api_key():
    return os.getenv("API_KEY", "no-key")

def test_api_key(monkeypatch):
    monkeypatch.setenv("API_KEY", "test123")
    assert get_api_key() == "test123"

    monkeypatch.delenv("API_KEY", raising=False)
    assert get_api_key() == "no-key"

Important Notes

Always use monkeypatch inside tests to avoid changing real code or environment.

Changes made by monkeypatch last only during the test and are undone automatically.

Use raising=False to avoid errors if the attribute or env variable does not exist.

Summary

monkeypatch helps change code or environment safely during tests.

It is useful to replace functions, set environment variables, or remove attributes temporarily.

Changes are only for the test and do not affect other tests or real code.

Practice

1. What is the primary purpose of the monkeypatch fixture in pytest?

easy

A. To temporarily replace parts of the code during tests

B. To permanently change the source code

C. To speed up the pytest installation

D. To generate test reports automatically

Solution

1. Step 1: Understand monkeypatch usage

   The monkeypatch fixture is used to temporarily replace or modify parts of the code during test execution.

2. Step 2: Differentiate temporary vs permanent changes

   It does not permanently change source code but only affects the test runtime environment.

3. Final Answer:

   To temporarily replace parts of the code during tests -> Option A

4. Quick Check:

   Temporary code replacement = B [OK]

Hint: Remember monkeypatch changes code only during tests [OK]

Common Mistakes:

• Thinking monkeypatch changes code permanently
• Confusing monkeypatch with test report tools
• Assuming monkeypatch speeds up pytest installation

2. Which of the following is the correct way to use monkeypatch to replace a function get_data in a module my_module?

easy

A. monkeypatch.replace('my_module.get_data', lambda: 'mocked')

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

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

D. monkeypatch.patch('my_module.get_data', lambda: 'mocked')

Solution

1. Step 1: Recall monkeypatch syntax

   The correct method to replace an attribute or function is monkeypatch.setattr(target, value) where target is a string path.

2. Step 2: Identify correct target format

   The target must be a string like 'my_module.get_data', not the function object itself.

3. Final Answer:

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

4. Quick Check:

   Use setattr with string target = A [OK]

Hint: Use setattr with string path to replace functions [OK]

Common Mistakes:

• Passing function object instead of string path
• Using non-existent monkeypatch methods like replace or patch
• Confusing monkeypatch with unittest.mock syntax

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

def get_value():
    return 10

def test_value(monkeypatch):
    monkeypatch.setattr('__main__.get_value', lambda: 5)
    assert get_value() == ?

medium

A. 10

B. 5

C. AssertionError

D. TypeError

Solution

1. Step 1: Understand monkeypatch effect on get_value

   The monkeypatch replaces get_value in the __main__ module with a lambda returning 5.

2. Step 2: Evaluate the assertion

   Calling get_value() now returns 5, so assert get_value() == 5 passes.

3. Final Answer:

   5 -> Option B

4. Quick Check:

   Patched function returns 5 = A [OK]

Hint: Patched function returns new value, not original [OK]

Common Mistakes:

• Expecting original return value 10
• Thinking monkeypatch causes error
• Confusing module path for patching

4. What is wrong with this test code using monkeypatch?

def test_env(monkeypatch):
    monkeypatch.setenv('API_KEY')
    assert os.getenv('API_KEY') is None

medium

A. monkeypatch cannot patch environment variables

B. os.getenv cannot be used in tests

C. assertion should check for empty string, not None

D. setenv requires two arguments: key and value

Solution

1. Step 1: Check monkeypatch.setenv usage

   The setenv method requires both a key and a value to set an environment variable.

2. Step 2: Identify missing argument

   Here, only the key 'API_KEY' is given, missing the value argument.

3. Final Answer:

   setenv requires two arguments: key and value -> Option D

4. Quick Check:

   setenv needs key and value = C [OK]

Hint: Always provide key and value to setenv [OK]

Common Mistakes:

• Calling setenv with only one argument
• Assuming os.getenv is not usable in tests
• Thinking monkeypatch can't patch env variables

5. You want to test a function that reads a config file using open. How can you use monkeypatch to avoid reading a real file and instead provide fake content?

hard

A. Use monkeypatch.setattr to replace builtins.open with a function returning a StringIO with fake data

B. Use monkeypatch.setenv to set a fake file path environment variable

C. Use monkeypatch.setitem to replace the file path in a dictionary

D. Use monkeypatch.delattr to delete the open function

Solution

1. Step 1: Identify how to fake file reading

   Replacing open with a function returning a StringIO object simulates file reading without disk access.

2. Step 2: Use monkeypatch.setattr on builtins.open

   Monkeypatch can replace builtins.open with a lambda or function returning StringIO containing fake content.

3. Final Answer:

   Use monkeypatch.setattr to replace builtins.open with a function returning a StringIO with fake data -> Option A

4. Quick Check:

   Patch open with StringIO = D [OK]

Hint: Patch builtins.open with StringIO for fake file content [OK]

Common Mistakes:

• Trying to delete open instead of replacing it
• Using setenv which doesn't fake file reading
• Replacing dictionary keys instead of open function