pytest monkeypatch 夹具完全指南安全地打补丁与模拟模块、环境变量及全局配置【免费下载链接】pytestThe pytest framework makes it easy to write small tests, yet scales to support complex functional testing项目地址: https://gitcode.com/GitHub_Trending/py/pytest导读本文基于 pytest 官方文档 doc/en/how-to/monkeypatch.rst 及仓库源码 src/_pytest/monkeypatch.py 编写系统讲解monkeypatch内置夹具的完整用法。当你需要测试依赖全局设置、外部网络请求、数据库连接、环境变量或当前用户等难以直接触发的代码路径时monkeypatch提供了一组用完自动还原的安全补丁 API。读完本文你将掌握setattr/delattr、setitem/delitem、setenv/delenv、syspath_prepend、chdir与context()的全部实战写法并能基于源码理解其自动撤销的底层机制写出稳定、不污染测试环境的用例。一、monkeypatch 夹具总览安全的临时补丁机制1.1 为什么需要 monkeypatch测试常常需要调用那些依赖全局设置或难以直接执行的功能例如发起真实的 API 请求或建立数据库连接依赖当前运行用户的目录、环境变量等运行时状态需要验证某个环境变量缺失时程序的异常行为。monkeypatch夹具用于安全地设置/删除某个属性、字典项或环境变量也可以修改sys.path以影响导入行为。它最核心的承诺是所有修改都会在请求它的测试函数或夹具结束后自动撤销因此单个测试对环境的污染不会泄漏到其他用例。1.2 九个核心方法monkeypatch夹具提供以下方法即 MonkeyPatch 类的公开接口方法作用对象关键参数monkeypatch.setattr(obj, name, value, raisingTrue)对象属性 / 函数 / 类属性raising控制目标不存在时是否抛AttributeErrormonkeypatch.delattr(obj, name, raisingTrue)对象属性 / 函数 / 类属性同上monkeypatch.setitem(mapping, name, value)字典 / Mapping 条目无raising参数monkeypatch.delitem(obj, name, raisingTrue)字典 / Mapping 条目raising控制是否抛KeyErrormonkeypatch.setenv(name, value, prependNone)环境变量prepend可将新值前置拼接到已有值之前monkeypatch.delenv(name, raisingTrue)环境变量raising控制是否抛KeyErrormonkeypatch.syspath_prepend(path)sys.path同时触发pkg_resources.fixup_namespace_packages与importlib.invalidate_cachesmonkeypatch.chdir(path)当前工作目录支持str或PathLikemonkeypatch.context()作用域控制上下文管理器退出时撤销内部全部补丁其中raising参数默认True决定了当 set/delete 的目标不存在时的行为目标缺失时抛出KeyError或AttributeError传raisingFalse则静默跳过这在验证缺失场景如删除一个本来就不存在的环境变量时非常有用。1.3 典型应用场景原文档归纳了六大典型场景贯穿下文各章节修改函数行为或类属性不真实发起 API 调用或数据库连接而是用setattr将其替换为预期的测试行为也可以是你自己编写的函数用delattr移除该函数或属性。修改字典值例如修改某个全局配置字典用setitem/delitem在测试期间调整其内容。修改环境变量测试环境变量缺失的程序行为或为某个已知变量设置多个值用setenv/delenv。修改$PATH与工作目录用monkeypatch.setenv(PATH, value, prependos.pathsep)修改$PATH用monkeypatch.chdir切换测试期间的当前工作目录上下文。修改sys.pathsyspath_prepend会把路径插入sys.path头部并顺带调用pkg_resources.fixup_namespace_packages与importlib.invalidate_caches保证动态生成的模块能被正确导入。限定补丁作用域monkeypatch.context()只在特定代码块内生效便于控制复杂夹具或标准库补丁的拆除时机。二、补丁函数以Path.home为例考虑一个与用户目录打交道的场景被测函数使用Path.home()获取当前用户主目录。测试时我们并不希望结果依赖当前实际运行的用户于是用setattr把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)两个关键要点补丁必须先于调用monkeypatch.setattr必须在真正会用到被补丁函数的代码执行之前完成否则补丁不会生效自动还原测试函数结束后Path.home的修改会被撤销不影响其他用例。在源码层面setattr的实现位于 src/_pytest/monkeypatch.py它先把旧值记录进内部的_setattr撤销栈再执行真正的setattr(target, name, value)撤销时undo()按逆序恢复每一个旧值undo 实现。由于是栈式撤销多次嵌套补丁也能精确复原。测试用例 testing/test_monkeypatch.py 验证了重复setattr后undo()两次的幂等性以及raisingFalse的静默行为。2.1 setattr 的两种调用形式源码的 derive_importpath 表明当target传入字符串时会被解析为点分导入路径最后一个部分作为属性名。因此以下两种写法等价monkeypatch.setattr(os, getcwd, lambda: /) # 等价于 monkeypatch.setattr(os.getcwd, lambda: /)字符串形式还支持直接补丁类本身例如monkeypatch.setattr(_pytest.config.Config, 42)。测试文件 testing/test_monkeypatch.py 覆盖了字符串解析、未知导入抛ImportError、未知属性抛AttributeError以及raisingFalse的容忍行为。三、构建 Mock 类补丁返回对象setattr不仅能替换函数/属性为简单值还可以配合自定义类来 mock 函数的返回对象。设想一个简单的 API 客户端函数# 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()我们需要 mockr这个返回的响应对象。mock 只需具备.json()方法且返回一个字典即可在测试文件中用一个类来表示# contents of test_app.py, a simple test for our API retrieval import requests # our app.py that includes the get_json() function import app # custom class to be the mock return value 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_responsemonkeypatch把requests.get替换成mock_get而mock_get返回MockResponse实例——它不发起任何外部 API 连接仅返回已知测试字典。你可以按被测场景的实际需要调整MockResponse的复杂程度比如增加一个总是返回True的ok属性或让json()根据传入字符串返回不同结果。3.1 用 fixture 共享 mock当多个测试需要同一份 mock 时把补丁逻辑抽到 fixture 中即可复用# contents of test_app.py, a simple test for our API retrieval import pytest import requests import app 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_response夹具声明了monkeypatch参数因此它的补丁生命周期与测试一致测试结束后自动撤销。若希望该 mock 应用于所有测试则把 fixture 移到conftest.py中并加上autouseTrue——这正是下一节全局补丁的做法。四、全局补丁示例彻底阻断 requests 的远程请求若想在整个测试套件中禁止requests库发起任何 HTTP 请求可以在conftest.py中声明一个 autouse 夹具删除Session.request方法# contents of conftest.py import pytest pytest.fixture(autouseTrue) def no_requests(monkeypatch): Remove requests.sessions.Session.request for all tests. monkeypatch.delattr(requests.sessions.Session.request)该 autouse 夹具会在每个测试函数执行前运行删除requests.sessions.Session.request方法——测试中任何试图发起 HTTP 请求的代码都会因此失败从而把网络可用性这一外部因素从测试结果中彻底剔除。delattr支持点分字符串路径的写法在此处发挥了作用测试 testing/test_monkeypatch.pytest_issue1338_name_resolving专门验证了这种delattr(requests.sessions.Session.request)的字符串解析能力。4.1 两条重要注意事项原文档给出了两条反复被社区强调的警告第一条不要轻易补丁内建函数。不推荐对open、compile等内建函数打补丁因为它可能破坏 pytest 自身的内部机制。如果确实不可避免可以尝试传入--tbnative、--assertplain与--captureno缓解但这并不能保证一定成功。第二条优先补丁你代码引用的那个名字。补丁标准库函数或某些被 pytest 依赖的第三方库可能破坏 pytest 本身。更安全的做法是补丁你的代码所引用的引用对象而不是标准库中的原始对象。例如你的模块写的是from os import getcwd就应该补丁mymodule.getcwd而不是os.getcwd。这一点在源码 setattr 的 docstring 中被进一步强调setattr的本质是临时改变某个名字所指向的对象同一对象可能有多个名字指向它因此必须补丁被测系统实际使用的那一个名字。对于你完全掌控的代码更长期更稳妥的模式是显式注入依赖把依赖作为参数传入被测代码而不是做全局补丁。当标准库对象的补丁不可避免时用context()把补丁限制在最小范围内import functools def test_partial(monkeypatch): with monkeypatch.context() as m: m.setattr(functools, partial, 3) assert functools.partial 3五、补丁环境变量setenv与delenv处理环境变量时常常需要安全地修改或删除它们以验证程序行为。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, raisingFalse) with pytest.raises(OSError): _ get_os_user_lower()setenv(USER, TestingUser)在测试期间设置变量测试结束自动恢复原值或删除若原先不存在delenv(USER, raisingFalse)删除变量——由于raisingFalse即使变量本就不存在也不会抛KeyError。同样可以把行为封装进夹具共享# 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, raisingFalse) # 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()5.1 prepend 参数与类型检查源码 setenv 实现 揭示了两个进阶细节prepend前缀拼接若传入prepend字符且变量已存在新值会被拼接为value prepend os.environ[name]。原文档给出的经典用法是monkeypatch.setenv(PATH, value, prependos.pathsep)即在$PATH前面追加新路径。测试 test_setenv_prepend 验证了连续两次 prepend 得到3-2的拼接顺序。非字符串值告警若value不是strsetenv会发出PytestWarning并隐式转换为字符串见 test_setenv_non_str_warning这正是环境变量值必须是原生字符串这一 Python 约束的体现。六、补丁字典setitem与delitem当程序依赖某个全局配置字典时setitem可以在测试期间安全地修改其条目。以下是一个简化的连接字符串示例# contents of app.py to generate a simple connection string DEFAULT_CONFIG {user: user1, database: db1} def create_connection_string(configNone): Creates a connection string from input or defaults. config config or DEFAULT_CONFIG return fUser Id{config[user]}; Location{config[database]};测试时把DEFAULT_CONFIG补丁为特定值# contents of test_app.py 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 Idtest_user; Locationtest_db; # the test uses the monkeypatched dictionary settings result app.create_connection_string() assert result expected删除条目用delitem# contents of test_app.py import pytest import app def test_missing_user(monkeypatch): # patch the DEFAULT_CONFIG to be missing the user key monkeypatch.delitem(app.DEFAULT_CONFIG, user, raisingFalse) # 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()注意删除本来就存在的键时raisingTrue是无所谓的此处传raisingFalse是为了表达无论键是否存在都不抛错的意图。若目标键确实存在delitem的默认行为raisingTrue并不会误报。源码 setitem/delitem 实现 表明两者都会在变更前捕获旧值并记录进_setitem撤销栈undo()时按逆序还原——即使测试中途有其他代码再次修改了字典还原依旧精确见测试 test_setitem_deleted_meanwhile。6.1 用独立夹具组合 mock夹具的模块化特性允许为每种 mock 定义独立夹具测试按需组合引用# contents of test_app.py import pytest import app 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, raisingFalse) # tests reference only the fixture mocks that are needed def test_connection(mock_test_user, mock_test_database): expected User Idtest_user; Locationtest_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()这种一夹具一 mock的写法让每个测试只声明自己需要的依赖可读性与可维护性都更好。七、源码视角撤销栈、作用域与导入解析7.1 自动撤销的底层实现monkeypatch夹具本身的定义在 src/_pytest/monkeypatch.pyfixture def monkeypatch() - Generator[MonkeyPatch]: mpatch MonkeyPatch() yield mpatch mpatch.undo()也就是说夹具 yield 出的MonkeyPatch实例在测试结束teardown 阶段必然调用undo()。MonkeyPatch.__init__src/_pytest/monkeypatch.py维护四类撤销状态_setattr属性补丁的撤销栈对象、属性名、旧值_setitem字典条目补丁的撤销栈_cwdchdir前的原始工作目录_savesyspathsyspath_prepend前的sys.path快照。undo()src/_pytest/monkeypatch.py按逆序恢复属性与字典条目、恢复sys.path快照、切回原始工作目录并清空撤销栈——因此重复调用undo()是安全的幂等操作测试 test_chdir_double_undo 与 test_syspath_prepend_double_undo 均验证了这一点。setattr对实例、类、数据描述符、__slots__与继承属性做了细致处理旧值优先从实例__dict__或类的__dict__中读取而不是简单getattr避免撤销时把继承属性误写进实例字典、从而永久冻结动态描述符相关回归测试见 testing/test_monkeypatch.py 的test_undo_inherited_attribute_on_instance、test_undo_data_descriptor_on_instance、test_undo_slot_attribute_on_instance等。7.2 context()限定补丁作用域context() 实现 是MonkeyPatch的类方法上下文管理器with monkeypatch.context() as m:会创建一个新的MonkeyPatch实例退出with块时自动undo()。它尤其适合控制复杂夹具的拆除顺序只对标准库对象做局部、临时补丁如前面functools.partial的例子在没有夹具可用的环境如普通脚本或类方法中作为pytest.MonkeyPatch()的配套用法。自 pytest 6.2 起MonkeyPatch也可直接实例化为pytest.MonkeyPatch()使用此时需用with MonkeyPatch.context() as mp:或手动调用undo()管理生命周期见类 docstringsrc/_pytest/monkeypatch.py。测试 test_context_classmethod 验证了类方法调用的还原效果。7.3 syspath_prepend 的额外动作syspath_prepend实现 除把路径插入sys.path[0]外还会若pkg_resources已加载调用pkg_resources.fixup_namespace_packages(path)修复命名空间包对旧式命名空间包会发出弃用告警调用importlib.invalidate_caches()使新增的sys.path条目立刻对动态创建的模块生效。完整行为链由测试 test_syspath_prepend_with_namespace_packages 端到端验证。八、小结与最佳实践目标推荐 API撤销方式替换函数 / 类属性 / 属性setattr支持点分字符串路径测试结束自动还原删除函数 / 类属性 / 属性delattr测试结束自动还原修改字典条目setitem测试结束自动还原删除字典条目delitem测试结束自动还原设置环境变量可 prepend 前缀setenv测试结束自动还原删除环境变量delenv测试结束自动还原临时加入导入路径syspath_prepend测试结束恢复sys.path快照切换当前工作目录chdir测试结束切回原目录限定补丁作用域context()退出with块即撤销实践要点回顾所有补丁都在测试/夹具结束自动撤销测试之间互不污染让raising参数贴合语义验证缺失场景时用raisingFalsemock 返回对象时优先用自定义类 fixture 组合全局生效则移入conftest.py并加autouseTrue补丁被测代码实际引用的名字而非标准库原始对象不可避免补丁 stdlib 时用context()收窄范围对于你能控制的代码优先考虑依赖注入把依赖显式传入被测函数这一更长期的模式而不是全局补丁。详细的 API 参考方法签名、参数与异常语义请查阅 MonkeyPatch 类的 API Reference 以及源码 src/_pytest/monkeypatch.py完整行为均有对应测试用例沉淀在 testing/test_monkeypatch.py 中可作为理解边界行为的活文档。【免费下载链接】pytestThe pytest framework makes it easy to write small tests, yet scales to support complex functional testing项目地址: https://gitcode.com/GitHub_Trending/py/pytest创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
pytest monkeypatch 夹具完全指南安全地打补丁与模拟模块、环境变量及全局配置【免费下载链接】pytestThe pytest framework makes it easy to write small tests, yet scales to support complex functional testing项目地址: https://gitcode.com/GitHub_Trending/py/pytest导读本文基于 pytest 官方文档 doc/en/how-to/monkeypatch.rst 及仓库源码 src/_pytest/monkeypatch.py 编写系统讲解monkeypatch内置夹具的完整用法。当你需要测试依赖全局设置、外部网络请求、数据库连接、环境变量或当前用户等难以直接触发的代码路径时monkeypatch提供了一组用完自动还原的安全补丁 API。读完本文你将掌握setattr/delattr、setitem/delitem、setenv/delenv、syspath_prepend、chdir与context()的全部实战写法并能基于源码理解其自动撤销的底层机制写出稳定、不污染测试环境的用例。一、monkeypatch 夹具总览安全的临时补丁机制1.1 为什么需要 monkeypatch测试常常需要调用那些依赖全局设置或难以直接执行的功能例如发起真实的 API 请求或建立数据库连接依赖当前运行用户的目录、环境变量等运行时状态需要验证某个环境变量缺失时程序的异常行为。monkeypatch夹具用于安全地设置/删除某个属性、字典项或环境变量也可以修改sys.path以影响导入行为。它最核心的承诺是所有修改都会在请求它的测试函数或夹具结束后自动撤销因此单个测试对环境的污染不会泄漏到其他用例。1.2 九个核心方法monkeypatch夹具提供以下方法即 MonkeyPatch 类的公开接口方法作用对象关键参数monkeypatch.setattr(obj, name, value, raisingTrue)对象属性 / 函数 / 类属性raising控制目标不存在时是否抛AttributeErrormonkeypatch.delattr(obj, name, raisingTrue)对象属性 / 函数 / 类属性同上monkeypatch.setitem(mapping, name, value)字典 / Mapping 条目无raising参数monkeypatch.delitem(obj, name, raisingTrue)字典 / Mapping 条目raising控制是否抛KeyErrormonkeypatch.setenv(name, value, prependNone)环境变量prepend可将新值前置拼接到已有值之前monkeypatch.delenv(name, raisingTrue)环境变量raising控制是否抛KeyErrormonkeypatch.syspath_prepend(path)sys.path同时触发pkg_resources.fixup_namespace_packages与importlib.invalidate_cachesmonkeypatch.chdir(path)当前工作目录支持str或PathLikemonkeypatch.context()作用域控制上下文管理器退出时撤销内部全部补丁其中raising参数默认True决定了当 set/delete 的目标不存在时的行为目标缺失时抛出KeyError或AttributeError传raisingFalse则静默跳过这在验证缺失场景如删除一个本来就不存在的环境变量时非常有用。1.3 典型应用场景原文档归纳了六大典型场景贯穿下文各章节修改函数行为或类属性不真实发起 API 调用或数据库连接而是用setattr将其替换为预期的测试行为也可以是你自己编写的函数用delattr移除该函数或属性。修改字典值例如修改某个全局配置字典用setitem/delitem在测试期间调整其内容。修改环境变量测试环境变量缺失的程序行为或为某个已知变量设置多个值用setenv/delenv。修改$PATH与工作目录用monkeypatch.setenv(PATH, value, prependos.pathsep)修改$PATH用monkeypatch.chdir切换测试期间的当前工作目录上下文。修改sys.pathsyspath_prepend会把路径插入sys.path头部并顺带调用pkg_resources.fixup_namespace_packages与importlib.invalidate_caches保证动态生成的模块能被正确导入。限定补丁作用域monkeypatch.context()只在特定代码块内生效便于控制复杂夹具或标准库补丁的拆除时机。二、补丁函数以Path.home为例考虑一个与用户目录打交道的场景被测函数使用Path.home()获取当前用户主目录。测试时我们并不希望结果依赖当前实际运行的用户于是用setattr把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)两个关键要点补丁必须先于调用monkeypatch.setattr必须在真正会用到被补丁函数的代码执行之前完成否则补丁不会生效自动还原测试函数结束后Path.home的修改会被撤销不影响其他用例。在源码层面setattr的实现位于 src/_pytest/monkeypatch.py它先把旧值记录进内部的_setattr撤销栈再执行真正的setattr(target, name, value)撤销时undo()按逆序恢复每一个旧值undo 实现。由于是栈式撤销多次嵌套补丁也能精确复原。测试用例 testing/test_monkeypatch.py 验证了重复setattr后undo()两次的幂等性以及raisingFalse的静默行为。2.1 setattr 的两种调用形式源码的 derive_importpath 表明当target传入字符串时会被解析为点分导入路径最后一个部分作为属性名。因此以下两种写法等价monkeypatch.setattr(os, getcwd, lambda: /) # 等价于 monkeypatch.setattr(os.getcwd, lambda: /)字符串形式还支持直接补丁类本身例如monkeypatch.setattr(_pytest.config.Config, 42)。测试文件 testing/test_monkeypatch.py 覆盖了字符串解析、未知导入抛ImportError、未知属性抛AttributeError以及raisingFalse的容忍行为。三、构建 Mock 类补丁返回对象setattr不仅能替换函数/属性为简单值还可以配合自定义类来 mock 函数的返回对象。设想一个简单的 API 客户端函数# 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()我们需要 mockr这个返回的响应对象。mock 只需具备.json()方法且返回一个字典即可在测试文件中用一个类来表示# contents of test_app.py, a simple test for our API retrieval import requests # our app.py that includes the get_json() function import app # custom class to be the mock return value 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_responsemonkeypatch把requests.get替换成mock_get而mock_get返回MockResponse实例——它不发起任何外部 API 连接仅返回已知测试字典。你可以按被测场景的实际需要调整MockResponse的复杂程度比如增加一个总是返回True的ok属性或让json()根据传入字符串返回不同结果。3.1 用 fixture 共享 mock当多个测试需要同一份 mock 时把补丁逻辑抽到 fixture 中即可复用# contents of test_app.py, a simple test for our API retrieval import pytest import requests import app 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_response夹具声明了monkeypatch参数因此它的补丁生命周期与测试一致测试结束后自动撤销。若希望该 mock 应用于所有测试则把 fixture 移到conftest.py中并加上autouseTrue——这正是下一节全局补丁的做法。四、全局补丁示例彻底阻断 requests 的远程请求若想在整个测试套件中禁止requests库发起任何 HTTP 请求可以在conftest.py中声明一个 autouse 夹具删除Session.request方法# contents of conftest.py import pytest pytest.fixture(autouseTrue) def no_requests(monkeypatch): Remove requests.sessions.Session.request for all tests. monkeypatch.delattr(requests.sessions.Session.request)该 autouse 夹具会在每个测试函数执行前运行删除requests.sessions.Session.request方法——测试中任何试图发起 HTTP 请求的代码都会因此失败从而把网络可用性这一外部因素从测试结果中彻底剔除。delattr支持点分字符串路径的写法在此处发挥了作用测试 testing/test_monkeypatch.pytest_issue1338_name_resolving专门验证了这种delattr(requests.sessions.Session.request)的字符串解析能力。4.1 两条重要注意事项原文档给出了两条反复被社区强调的警告第一条不要轻易补丁内建函数。不推荐对open、compile等内建函数打补丁因为它可能破坏 pytest 自身的内部机制。如果确实不可避免可以尝试传入--tbnative、--assertplain与--captureno缓解但这并不能保证一定成功。第二条优先补丁你代码引用的那个名字。补丁标准库函数或某些被 pytest 依赖的第三方库可能破坏 pytest 本身。更安全的做法是补丁你的代码所引用的引用对象而不是标准库中的原始对象。例如你的模块写的是from os import getcwd就应该补丁mymodule.getcwd而不是os.getcwd。这一点在源码 setattr 的 docstring 中被进一步强调setattr的本质是临时改变某个名字所指向的对象同一对象可能有多个名字指向它因此必须补丁被测系统实际使用的那一个名字。对于你完全掌控的代码更长期更稳妥的模式是显式注入依赖把依赖作为参数传入被测代码而不是做全局补丁。当标准库对象的补丁不可避免时用context()把补丁限制在最小范围内import functools def test_partial(monkeypatch): with monkeypatch.context() as m: m.setattr(functools, partial, 3) assert functools.partial 3五、补丁环境变量setenv与delenv处理环境变量时常常需要安全地修改或删除它们以验证程序行为。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, raisingFalse) with pytest.raises(OSError): _ get_os_user_lower()setenv(USER, TestingUser)在测试期间设置变量测试结束自动恢复原值或删除若原先不存在delenv(USER, raisingFalse)删除变量——由于raisingFalse即使变量本就不存在也不会抛KeyError。同样可以把行为封装进夹具共享# 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, raisingFalse) # 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()5.1 prepend 参数与类型检查源码 setenv 实现 揭示了两个进阶细节prepend前缀拼接若传入prepend字符且变量已存在新值会被拼接为value prepend os.environ[name]。原文档给出的经典用法是monkeypatch.setenv(PATH, value, prependos.pathsep)即在$PATH前面追加新路径。测试 test_setenv_prepend 验证了连续两次 prepend 得到3-2的拼接顺序。非字符串值告警若value不是strsetenv会发出PytestWarning并隐式转换为字符串见 test_setenv_non_str_warning这正是环境变量值必须是原生字符串这一 Python 约束的体现。六、补丁字典setitem与delitem当程序依赖某个全局配置字典时setitem可以在测试期间安全地修改其条目。以下是一个简化的连接字符串示例# contents of app.py to generate a simple connection string DEFAULT_CONFIG {user: user1, database: db1} def create_connection_string(configNone): Creates a connection string from input or defaults. config config or DEFAULT_CONFIG return fUser Id{config[user]}; Location{config[database]};测试时把DEFAULT_CONFIG补丁为特定值# contents of test_app.py 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 Idtest_user; Locationtest_db; # the test uses the monkeypatched dictionary settings result app.create_connection_string() assert result expected删除条目用delitem# contents of test_app.py import pytest import app def test_missing_user(monkeypatch): # patch the DEFAULT_CONFIG to be missing the user key monkeypatch.delitem(app.DEFAULT_CONFIG, user, raisingFalse) # 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()注意删除本来就存在的键时raisingTrue是无所谓的此处传raisingFalse是为了表达无论键是否存在都不抛错的意图。若目标键确实存在delitem的默认行为raisingTrue并不会误报。源码 setitem/delitem 实现 表明两者都会在变更前捕获旧值并记录进_setitem撤销栈undo()时按逆序还原——即使测试中途有其他代码再次修改了字典还原依旧精确见测试 test_setitem_deleted_meanwhile。6.1 用独立夹具组合 mock夹具的模块化特性允许为每种 mock 定义独立夹具测试按需组合引用# contents of test_app.py import pytest import app 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, raisingFalse) # tests reference only the fixture mocks that are needed def test_connection(mock_test_user, mock_test_database): expected User Idtest_user; Locationtest_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()这种一夹具一 mock的写法让每个测试只声明自己需要的依赖可读性与可维护性都更好。七、源码视角撤销栈、作用域与导入解析7.1 自动撤销的底层实现monkeypatch夹具本身的定义在 src/_pytest/monkeypatch.pyfixture def monkeypatch() - Generator[MonkeyPatch]: mpatch MonkeyPatch() yield mpatch mpatch.undo()也就是说夹具 yield 出的MonkeyPatch实例在测试结束teardown 阶段必然调用undo()。MonkeyPatch.__init__src/_pytest/monkeypatch.py维护四类撤销状态_setattr属性补丁的撤销栈对象、属性名、旧值_setitem字典条目补丁的撤销栈_cwdchdir前的原始工作目录_savesyspathsyspath_prepend前的sys.path快照。undo()src/_pytest/monkeypatch.py按逆序恢复属性与字典条目、恢复sys.path快照、切回原始工作目录并清空撤销栈——因此重复调用undo()是安全的幂等操作测试 test_chdir_double_undo 与 test_syspath_prepend_double_undo 均验证了这一点。setattr对实例、类、数据描述符、__slots__与继承属性做了细致处理旧值优先从实例__dict__或类的__dict__中读取而不是简单getattr避免撤销时把继承属性误写进实例字典、从而永久冻结动态描述符相关回归测试见 testing/test_monkeypatch.py 的test_undo_inherited_attribute_on_instance、test_undo_data_descriptor_on_instance、test_undo_slot_attribute_on_instance等。7.2 context()限定补丁作用域context() 实现 是MonkeyPatch的类方法上下文管理器with monkeypatch.context() as m:会创建一个新的MonkeyPatch实例退出with块时自动undo()。它尤其适合控制复杂夹具的拆除顺序只对标准库对象做局部、临时补丁如前面functools.partial的例子在没有夹具可用的环境如普通脚本或类方法中作为pytest.MonkeyPatch()的配套用法。自 pytest 6.2 起MonkeyPatch也可直接实例化为pytest.MonkeyPatch()使用此时需用with MonkeyPatch.context() as mp:或手动调用undo()管理生命周期见类 docstringsrc/_pytest/monkeypatch.py。测试 test_context_classmethod 验证了类方法调用的还原效果。7.3 syspath_prepend 的额外动作syspath_prepend实现 除把路径插入sys.path[0]外还会若pkg_resources已加载调用pkg_resources.fixup_namespace_packages(path)修复命名空间包对旧式命名空间包会发出弃用告警调用importlib.invalidate_caches()使新增的sys.path条目立刻对动态创建的模块生效。完整行为链由测试 test_syspath_prepend_with_namespace_packages 端到端验证。八、小结与最佳实践目标推荐 API撤销方式替换函数 / 类属性 / 属性setattr支持点分字符串路径测试结束自动还原删除函数 / 类属性 / 属性delattr测试结束自动还原修改字典条目setitem测试结束自动还原删除字典条目delitem测试结束自动还原设置环境变量可 prepend 前缀setenv测试结束自动还原删除环境变量delenv测试结束自动还原临时加入导入路径syspath_prepend测试结束恢复sys.path快照切换当前工作目录chdir测试结束切回原目录限定补丁作用域context()退出with块即撤销实践要点回顾所有补丁都在测试/夹具结束自动撤销测试之间互不污染让raising参数贴合语义验证缺失场景时用raisingFalsemock 返回对象时优先用自定义类 fixture 组合全局生效则移入conftest.py并加autouseTrue补丁被测代码实际引用的名字而非标准库原始对象不可避免补丁 stdlib 时用context()收窄范围对于你能控制的代码优先考虑依赖注入把依赖显式传入被测函数这一更长期的模式而不是全局补丁。详细的 API 参考方法签名、参数与异常语义请查阅 MonkeyPatch 类的 API Reference 以及源码 src/_pytest/monkeypatch.py完整行为均有对应测试用例沉淀在 testing/test_monkeypatch.py 中可作为理解边界行为的活文档。【免费下载链接】pytestThe pytest framework makes it easy to write small tests, yet scales to support complex functional testing项目地址: https://gitcode.com/GitHub_Trending/py/pytest创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
