Skip to content

Commit

Permalink
Fix indentation and use code-block directives
Browse files Browse the repository at this point in the history
The code-block directives are required by our blacken-docs hook
  • Loading branch information
nicoddemus committed May 14, 2019
1 parent 2ad36b1 commit e668aaf
Showing 1 changed file with 22 additions and 10 deletions.
32 changes: 22 additions & 10 deletions doc/en/monkeypatch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,63 +86,75 @@ Monkeypatching environment variables

If you are working with environment variables you often need to safely change the values
or delete them from the system for testing purposes. ``Monkeypatch`` provides a mechanism
to do this using the ``setenv`` and ``delenv`` method. Our example code to test::
to do this using the ``setenv`` and ``delenv`` method. Our example code to test:

.. code-block:: python
# contents of our original code file e.g. code.py
import os
def get_os_user_lower():
"""Simple retrieval function.
Returns lowercase USER or raises EnvironmentError."""
username = os.getenv("USER")
"""Simple retrieval function.
Returns lowercase USER or raises EnvironmentError."""
username = os.getenv("USER")
if username is None:
raise EnvironmentError("USER environment is not set.")
if username is None:
raise EnvironmentError("USER environment is not set.")
return username.lower()
return username.lower()
There are two potential paths. First, the ``USER`` environment variable is set to a
value. Second, the ``USER`` environment variable does not exist. Using ``monkeypatch``
both paths can be safely tested without impacting the running environment::
both paths can be safely tested without impacting the running environment:

.. code-block:: python
# contents of our test file e.g. test_code.py
import pytest
def test_upper_to_lower(monkeypatch):
"""Set the USER env var to assert the behavior."""
monkeypatch.setenv("USER", "TestingUser")
assert get_os_user_lower() == "testinguser"
def test_raise_exception(monkeypatch):
"""Remove the USER env var and assert EnvironmentError is raised."""
monkeypatch.delenv("USER", raising=False)
with pytest.raises(EnvironmentError):
_ = get_os_user_lower()
This behavior can be be moved into ``fixture`` structures and shared across tests::
This behavior can be be moved into ``fixture`` structures and shared across tests:

.. code-block:: python
import pytest
@pytest.fixture
def mock_env_user(monkeypatch):
monkeypatch.setenv("USER", "TestingUser")
@pytest.fixture
def mock_env_missing(monkeypatch):
monkeypatch.delenv("USER", raising=False)
# Notice the tests reference the fixtures for mocks
def test_upper_to_lower(mock_env_user):
assert get_os_user_lower() == "testinguser"
def test_raise_exception(mock_env_missing):
with pytest.raises(EnvironmentError):
_ = get_os_user_lower()

.. currentmodule:: _pytest.monkeypatch

API Reference
Expand Down

0 comments on commit e668aaf

Please sign in to comment.