monkeypatch.setenv in PyTest - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does monkeypatch.setenv do in pytest?

monkeypatch.setenv temporarily sets or changes an environment variable during a test. It helps simulate different environment settings without affecting the real system environment.

beginner

How do you use monkeypatch.setenv to set an environment variable named API_KEY to 12345?

<pre>import os

def test_api_key(monkeypatch):
    monkeypatch.setenv('API_KEY', '12345')
    assert os.getenv('API_KEY') == '12345'</pre>

intermediate

Why is it better to use monkeypatch.setenv instead of directly modifying os.environ in tests?

Using monkeypatch.setenv ensures the environment variable changes are temporary and automatically reverted after the test. Directly modifying os.environ can cause side effects on other tests.

beginner

What happens to environment variables set by monkeypatch.setenv after the test finishes?

They are automatically restored to their original values or removed if they did not exist before. This keeps tests isolated and prevents side effects.

intermediate

Can monkeypatch.setenv be used to unset an environment variable? How?

Yes. You can unset an environment variable by setting its value to None with monkeypatch.setenv('VAR_NAME', None). This removes the variable for the test duration.

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

A Create new files for testing

B Permanently change environment variables on the system

C Mock HTTP requests

D Temporarily change environment variables during a test

monkeypatch.setenv only changes environment variables temporarily during a test, not permanently.

After a test using monkeypatch.setenv finishes, what happens to the environment variables?

A They are restored to their original state

B They remain changed permanently

C They are deleted from the system

D They cause the test to fail

Environment variables are restored to their original values to keep tests isolated.

Which of the following is a correct way to set an environment variable DEBUG to true using monkeypatch?

A monkeypatch.setenv('DEBUG', 'true')

B monkeypatch.setenv(DEBUG=true)

C os.environ['DEBUG'] = true

D monkeypatch.setenv('DEBUG')

Option A correctly sets the variable as a string value using monkeypatch.

Why should you prefer monkeypatch.setenv over modifying os.environ directly in tests?

A It is faster

B It requires less code

C It automatically cleans up changes after tests

D It works only on Windows

monkeypatch ensures environment changes are temporary and cleaned up after tests.

How do you remove an environment variable PATH temporarily in a pytest test?

A monkeypatch.delenv('PATH')

B monkeypatch.setenv('PATH', None)

C os.environ.pop('PATH')

D monkeypatch.setenv('PATH', '')

Setting the variable to None with monkeypatch.setenv removes it temporarily.

Explain how monkeypatch.setenv helps keep tests isolated and why this is important.

Think about what happens if environment variables stay changed after a test.

Describe a simple pytest test example using monkeypatch.setenv to simulate an environment variable and verify it.

Show how to set and check an environment variable inside a 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