monkeypatch.setenv in PyTest

Introduction

We use monkeypatch.setenv to temporarily change environment variables during tests. This helps us test how code behaves with different settings without changing the real environment.

When you want to test how your code reacts to different environment variables.

When you need to simulate missing or changed environment variables in a test.

When you want to avoid changing your system's real environment variables during testing.

When testing code that reads configuration from environment variables.

When you want isolated tests that do not affect each other or the system.

Syntax

PyTest

monkeypatch.setenv(name, value, prepend=False)

name is the environment variable name as a string.

value is the new value to set for that variable.

Examples

Sets the environment variable API_KEY to 12345 for the test.

PyTest

monkeypatch.setenv('API_KEY', '12345')

Adds /my/custom/path at the start of the PATH variable temporarily.

PyTest

monkeypatch.setenv('PATH', '/my/custom/path', prepend=True)

Sample Program

This test shows how monkeypatch.setenv changes the environment variable MY_VAR temporarily. It prints the original, new, and restored values.

PyTest

import os

def test_env(monkeypatch):
    # Before patching
    original_value = os.getenv('MY_VAR')

    # Set environment variable temporarily
    monkeypatch.setenv('MY_VAR', 'test_value')

    # Check the new value
    new_value = os.getenv('MY_VAR')

    # Assert the value changed
    assert new_value == 'test_value'

    # After test, environment is restored
    monkeypatch.undo()
    restored_value = os.getenv('MY_VAR')

    print(f'Original: {original_value}')
    print(f'New: {new_value}')
    print(f'Restored: {restored_value}')

Important Notes

monkeypatch automatically restores changes after the test ends, so no permanent changes happen.

Use monkeypatch.setenv inside test functions that accept the monkeypatch fixture.

Calling monkeypatch.undo() manually can restore changes early if needed.

Summary

monkeypatch.setenv lets you change environment variables safely during tests.

It helps test different scenarios without affecting your real system.

Changes are temporary and automatically cleaned up after each test.

Practice

1.

What is the main purpose of monkeypatch.setenv in pytest?

easy

A. Create new environment variables outside tests

B. Permanently change environment variables on the system

C. Temporarily change environment variables during a test

D. Delete environment variables permanently

Solution

1. Step 1: Understand the role of monkeypatch in pytest

   Monkeypatch is used to temporarily modify or replace parts of the environment during tests without permanent effects.

2. Step 2: Focus on setenv method

   The setenv method specifically changes environment variables only for the duration of the test.

3. Final Answer:

   Temporarily change environment variables during a test -> Option C

4. Quick Check:

   monkeypatch.setenv = temporary env change [OK]

Hint: Remember: monkeypatch.setenv only affects test-time env variables [OK]

Common Mistakes:

• Thinking setenv changes env variables permanently
• Confusing setenv with creating new system variables
• Assuming changes persist after test ends

2.

Which of the following is the correct syntax to set an environment variable API_KEY to 12345 using monkeypatch.setenv in a pytest test function?

def test_api_key(monkeypatch):
    # Your code here
    assert ...

easy

A. monkeypatch.setenv('API_KEY', '12345')

B. monkeypatch.setenv('API_KEY', 12345)

C. monkeypatch.setenv(API_KEY='12345')

D. monkeypatch.setenv('API_KEY') = '12345'

Solution

1. Step 1: Check method signature of setenv

   setenv takes two string arguments: the variable name and its value.

2. Step 2: Identify correct string usage

   The value must be a string, so '12345' is correct, not integer 12345.

3. Final Answer:

   monkeypatch.setenv('API_KEY', '12345') -> Option A

4. Quick Check:

   setenv('VAR', 'value') syntax [OK]

Hint: Always pass env var values as strings in setenv [OK]

Common Mistakes:

• Passing integer instead of string as value
• Using keyword arguments instead of positional
• Trying to assign value with '=' outside method call

3.

What will be the output of the following pytest test?

import os

def test_env(monkeypatch):
    monkeypatch.setenv('MODE', 'test')
    mode = os.getenv('MODE')
    assert mode == 'test'
    print(mode)

medium

A. AssertionError

B. None

C. MODE

D. test

Solution

1. Step 1: Understand monkeypatch.setenv effect

   It sets environment variable 'MODE' to 'test' temporarily during the test.

2. Step 2: Check os.getenv call and assertion

   os.getenv('MODE') returns 'test', so assertion passes and print outputs 'test'.

3. Final Answer:

   test -> Option D

4. Quick Check:

   setenv sets env var, getenv reads it [OK]

Hint: setenv changes env var for test, getenv reads it [OK]

Common Mistakes:

• Expecting None because env var not set globally
• Thinking assertion fails
• Confusing variable name with value

4.

Identify the error in this pytest test using monkeypatch.setenv:

def test_path(monkeypatch):
    monkeypatch.setenv(PATH)
    assert os.getenv('PATH') == '/usr/bin'

medium

A. Missing import of os module

B. setenv missing value argument

C. Incorrect assertion syntax

D. Using monkeypatch outside test function

Solution

1. Step 1: Check setenv method call

   setenv requires two arguments: variable name and value. Here only one argument is given.

2. Step 2: Verify assertion and imports

   Assertion syntax is correct and os module import is assumed; error is in setenv call.

3. Final Answer:

   setenv missing value argument -> Option B

4. Quick Check:

   setenv needs two args: name and value [OK]

Hint: setenv always needs two strings: var name and value [OK]

Common Mistakes:

• Calling setenv with only one argument
• Forgetting to import os module
• Miswriting assertion statement

5.

You want to test a function that behaves differently based on the environment variable FEATURE_FLAG. Which pytest test code correctly uses monkeypatch.setenv to test the function with FEATURE_FLAG set to enabled and ensures the environment is restored after the test?

def test_feature(monkeypatch):
    # Your code here
    result = feature_function()
    assert result == 'Feature Enabled'

hard

A. monkeypatch.setenv('FEATURE_FLAG', 'enabled')

B. os.environ['FEATURE_FLAG'] = 'enabled'

C. monkeypatch.setenv(FEATURE_FLAG='enabled')

D. monkeypatch.setenv('FEATURE_FLAG') = 'enabled'

Solution

1. Step 1: Identify correct usage of monkeypatch.setenv

   setenv requires two string arguments: variable name and value, passed positionally.

2. Step 2: Understand environment restoration

   Using monkeypatch.setenv ensures the env var is set only during the test and restored after, unlike direct os.environ assignment.

3. Final Answer:

   monkeypatch.setenv('FEATURE_FLAG', 'enabled') -> Option A

4. Quick Check:

   Use monkeypatch.setenv for temporary env changes [OK]

Hint: Use monkeypatch.setenv for temp env vars, not os.environ [OK]

Common Mistakes:

• Directly modifying os.environ without monkeypatch
• Using keyword arguments in setenv
• Trying to assign value outside setenv call