如何 monkeypatch/mock 模块和环境¶

有时测试需要调用依赖于全局设置的功能，或调用不易测试的代码，例如网络访问。monkeypatch fixture 帮助您安全地设置/删除属性、字典项或环境变量，或修改 sys.path 以进行导入。

monkeypatch fixture 提供了这些辅助方法，用于在测试中安全地 patching 和 mocking 功能

所有修改将在请求测试函数或 fixture 完成后撤消。raising 参数确定如果设置/删除操作的目标不存在，是否会引发 KeyError 或 AttributeError。

考虑以下场景

1. 为测试修改函数行为或类的属性，例如，您有一个 API 调用或数据库连接，您不会为了测试而进行调用，但您知道预期的输出应该是什么。使用 monkeypatch.setattr 使用您期望的测试行为来 patch 函数或属性。这可以包括您自己的函数。使用 monkeypatch.delattr 为测试删除函数或属性。

2. 修改字典的值，例如，您有一个全局配置，您想为某些测试用例修改它。使用 monkeypatch.setitem 为测试 patch 字典。monkeypatch.delitem 可用于删除项。

3. 为测试修改环境变量，例如，测试环境变量丢失时的程序行为，或为已知变量设置多个值。monkeypatch.setenv 和 monkeypatch.delenv 可用于这些 patch。

4. 使用 monkeypatch.setenv("PATH", value, prepend=os.pathsep) 修改 $PATH，并使用 monkeypatch.chdir 在测试期间更改当前工作目录的上下文。

5. 使用 monkeypatch.syspath_prepend 修改 sys.path，这也将调用 pkg_resources.fixup_namespace_packages 和 importlib.invalidate_caches()。

6. 使用 monkeypatch.context 仅在特定范围内应用 patch，这可以帮助控制复杂 fixtures 或 stdlib patches 的拆卸。

有关一些介绍性材料及其动机的讨论，请参阅 monkeypatch 博客文章。

Monkeypatching 函数¶

考虑一个您正在使用用户目录的场景。在测试的上下文中，您不希望您的测试依赖于运行用户。monkeypatch 可用于 patch 依赖于用户的函数，使其始终返回特定值。

在此示例中，monkeypatch.setattr 用于 patch Path.home，以便在运行测试时始终使用已知的测试路径 Path("/abc")。这消除了出于测试目的对运行用户的任何依赖。 monkeypatch.setattr 必须在调用将使用 patch 函数的函数之前调用。测试函数完成后，Path.home 修改将被撤消。

# contents of test_module.py with source code and the test
from pathlib import Path


def getssh():
    """Simple function to return expanded homedir ssh path."""
    return Path.home() / ".ssh"


def test_getssh(monkeypatch):
    # mocked return function to replace Path.home
    # always return '/abc'
    def mockreturn():
        return Path("/abc")

    # Application of the monkeypatch to replace Path.home
    # with the behavior of mockreturn defined above.
    monkeypatch.setattr(Path, "home", mockreturn)

    # Calling getssh() will use mockreturn in place of Path.home
    # for this test with the monkeypatch.
    x = getssh()
    assert x == Path("/abc/.ssh")

Monkeypatching 返回的对象：构建 mock 类¶

monkeypatch.setattr 可以与类结合使用，以 mock 函数返回的对象而不是值。想象一个简单的函数，它接受一个 API url 并返回 json 响应。

# contents of app.py, a simple API retrieval example
import requests


def get_json(url):
    """Takes a URL, and returns the JSON."""
    r = requests.get(url)
    return r.json()

我们需要 mock r，即为了测试目的返回的响应对象。r 的 mock 需要一个 .json() 方法，该方法返回一个字典。这可以在我们的测试文件中通过定义一个类来表示 r 来完成。

# contents of test_app.py, a simple test for our API retrieval
# import requests for the purposes of monkeypatching
import requests

# our app.py that includes the get_json() function
# this is the previous code block example
import app


# custom class to be the mock return value
# will override the requests.Response returned from requests.get
class MockResponse:
    # mock json() method always returns a specific testing dictionary
    @staticmethod
    def json():
        return {"mock_key": "mock_response"}


def test_get_json(monkeypatch):
    # Any arguments may be passed and mock_get() will always return our
    # mocked object, which only has the .json() method.
    def mock_get(*args, **kwargs):
        return MockResponse()

    # apply the monkeypatch for requests.get to mock_get
    monkeypatch.setattr(requests, "get", mock_get)

    # app.get_json, which contains requests.get, uses the monkeypatch
    result = app.get_json("https://fakeurl")
    assert result["mock_key"] == "mock_response"

monkeypatch 使用我们的 mock_get 函数将 mock 应用于 requests.get。mock_get 函数返回 MockResponse 类的实例，该实例具有一个 json() 方法，该方法定义为返回已知的测试字典，并且不需要任何外部 API 连接。

您可以构建 MockResponse 类，使其具有您正在测试的场景的适当复杂程度。例如，它可以包含一个始终返回 True 的 ok 属性，或者根据输入字符串从 json() mocked 方法返回不同的值。

这个 mock 可以使用 fixture 在测试之间共享

# contents of test_app.py, a simple test for our API retrieval
import pytest
import requests

# app.py that includes the get_json() function
import app


# custom class to be the mock return value of requests.get()
class MockResponse:
    @staticmethod
    def json():
        return {"mock_key": "mock_response"}


# monkeypatched requests.get moved to a fixture
@pytest.fixture
def mock_response(monkeypatch):
    """Requests.get() mocked to return {'mock_key':'mock_response'}."""

    def mock_get(*args, **kwargs):
        return MockResponse()

    monkeypatch.setattr(requests, "get", mock_get)


# notice our test uses the custom fixture instead of monkeypatch directly
def test_get_json(mock_response):
    result = app.get_json("https://fakeurl")
    assert result["mock_key"] == "mock_response"

此外，如果 mock 设计为应用于所有测试，则可以将 fixture 移动到 conftest.py 文件，并使用 autouse=True 选项。

全局 patch 示例：防止 “requests” 进行远程操作¶

如果您想阻止 “requests” 库在所有测试中执行 http 请求，您可以这样做

# contents of conftest.py
import pytest


@pytest.fixture(autouse=True)
def no_requests(monkeypatch):
    """Remove requests.sessions.Session.request for all tests."""
    monkeypatch.delattr("requests.sessions.Session.request")

此 autouse fixture 将为每个测试函数执行，它将删除方法 request.session.Session.request，以便在测试中创建 http 请求的任何尝试都会失败。

注意

请注意，不建议 patch 内置函数，例如 open、compile 等，因为它可能会破坏 pytest 的内部机制。如果这是不可避免的，则传递 --tb=native、--assert=plain 和 --capture=no 可能会有所帮助，尽管不能保证。

注意

请注意，patch stdlib 函数和 pytest 使用的一些第三方库可能会破坏 pytest 本身，因此在这些情况下，建议使用 MonkeyPatch.context() 将 patch 限制为您要测试的块

import functools


def test_partial(monkeypatch):
    with monkeypatch.context() as m:
        m.setattr(functools, "partial", 3)
        assert functools.partial == 3

有关详细信息，请参阅 #3290。

Monkeypatching 环境变量¶

如果您正在使用环境变量，您通常需要安全地更改值或从系统中删除它们以进行测试。monkeypatch 提供了使用 setenv 和 delenv 方法执行此操作的机制。我们的示例代码进行测试

# 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 OSError."""
    username = os.getenv("USER")

    if username is None:
        raise OSError("USER environment is not set.")

    return username.lower()

有两种可能的路径。首先，USER 环境变量设置为一个值。其次，USER 环境变量不存在。使用 monkeypatch 可以安全地测试这两种路径，而不会影响运行环境

# 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 OSError is raised."""
    monkeypatch.delenv("USER", raising=False)

    with pytest.raises(OSError):
        _ = get_os_user_lower()

此行为可以移动到 fixture 结构中并在测试之间共享

# contents of our test file e.g. test_code.py
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(OSError):
        _ = get_os_user_lower()

Monkeypatching 字典¶

monkeypatch.setitem 可用于在测试期间安全地将字典的值设置为特定值。以下面这个简化的连接字符串示例为例

# contents of app.py to generate a simple connection string
DEFAULT_CONFIG = {"user": "user1", "database": "db1"}


def create_connection_string(config=None):
    """Creates a connection string from input or defaults."""
    config = config or DEFAULT_CONFIG
    return f"User Id={config['user']}; Location={config['database']};"

出于测试目的，我们可以将 DEFAULT_CONFIG 字典 patch 到特定值。

# contents of test_app.py
# app.py with the connection string function (prior code block)
import app


def test_connection(monkeypatch):
    # Patch the values of DEFAULT_CONFIG to specific
    # testing values only for this test.
    monkeypatch.setitem(app.DEFAULT_CONFIG, "user", "test_user")
    monkeypatch.setitem(app.DEFAULT_CONFIG, "database", "test_db")

    # expected result based on the mocks
    expected = "User Id=test_user; Location=test_db;"

    # the test uses the monkeypatched dictionary settings
    result = app.create_connection_string()
    assert result == expected

您可以使用 monkeypatch.delitem 删除值。

# contents of test_app.py
import pytest

# app.py with the connection string function
import app


def test_missing_user(monkeypatch):
    # patch the DEFAULT_CONFIG t be missing the 'user' key
    monkeypatch.delitem(app.DEFAULT_CONFIG, "user", raising=False)

    # Key error expected because a config is not passed, and the
    # default is now missing the 'user' entry.
    with pytest.raises(KeyError):
        _ = app.create_connection_string()

fixtures 的模块化使您可以灵活地为每个可能的 mock 定义单独的 fixtures，并在需要的测试中引用它们。

# contents of test_app.py
import pytest

# app.py with the connection string function
import app


# all of the mocks are moved into separated fixtures
@pytest.fixture
def mock_test_user(monkeypatch):
    """Set the DEFAULT_CONFIG user to test_user."""
    monkeypatch.setitem(app.DEFAULT_CONFIG, "user", "test_user")


@pytest.fixture
def mock_test_database(monkeypatch):
    """Set the DEFAULT_CONFIG database to test_db."""
    monkeypatch.setitem(app.DEFAULT_CONFIG, "database", "test_db")


@pytest.fixture
def mock_missing_default_user(monkeypatch):
    """Remove the user key from DEFAULT_CONFIG"""
    monkeypatch.delitem(app.DEFAULT_CONFIG, "user", raising=False)


# tests reference only the fixture mocks that are needed
def test_connection(mock_test_user, mock_test_database):
    expected = "User Id=test_user; Location=test_db;"

    result = app.create_connection_string()
    assert result == expected


def test_missing_user(mock_missing_default_user):
    with pytest.raises(KeyError):
        _ = app.create_connection_string()

API 参考¶

请查阅 MonkeyPatch 类的文档。