Python单元测试如何跨模块全局Patch代码库中的指定对象

请看如下代码示例：

单例配置类 #

# config.py

class SomeConfigObject:
    thing = True

CONFIG = SomeConfigObject()

使用该配置对象的模块 #

# some_module.py
from config import CONFIG

def somefn():
    return CONFIG.thing

调用上述模块的主程序 #

# main_program.py
import some_module

def main():
    return some_module.somefn()

针对主程序编写的初始测试用例 #

# test_main_program.py
from main_program import main

def test_main():
    assert main() == True

以上是单例config对象的极简示例。在复杂度更高的实际代码库中，会有大量（通常为深层嵌套的）文件通过from config import CONFIG语句引入该配置，供诸多模块调用。

核心疑问：是否存在简便方法可以在整个代码库范围内全局Patch某个对象？

目前已知使用mock可以实现单模块patch效果：

# test main_program
from unittest import mock
from main_program import main

class TestConfig:
    thing=True

@mock.patch('main_program.some_module.CONFIG', new=TestConfig())
def test_main():
    assert main() == True

但该方案不具备可扩展性，如果对象被数十甚至上百处位置引用，使用逐模块Patch的方式会非常繁琐、维护成本极高。

不需要逐模块Patch，只要遵循两个核心原则就能实现全局替换：

• Patch操作必须在所有导入了目标对象的业务模块加载前执行
• 直接Patch原始定义位置的对象，也就是config.CONFIG本身，而不是各个模块中绑定的本地引用

基础实现方式 #

调整测试文件里的Patch和导入顺序即可：

# test_main_program.py
from unittest import mock

# 第一步：先完成Patch，再导入所有业务模块
class TestConfig:
    thing = False # 修改属性值方便验证Patch生效

mock.patch('config.CONFIG', new=TestConfig()).start()

# Patch完成后再导入依赖CONFIG的模块
from main_program import main

def test_main():
    # 此处返回TestConfig的属性值False，证明全局Patch生效
    assert main() == False

项目级全局Patch方案 #

如果使用pytest测试框架，可以把Patch逻辑放到项目根目录的conftest.py中，配合fixture实现测试会话全周期自动生效，不需要每个测试文件重复编写Patch逻辑：

# conftest.py
import pytest
from unittest import mock

@pytest.fixture(scope="session", autouse=True)
def patch_global_config():
    class TestConfig:
        thing = True
    # 启动Patch，整个测试运行期间生效
    patch = mock.patch('config.CONFIG', new=TestConfig())
    patch.start()
    yield
    patch.stop()

原理说明 #

Python导入模块时，from config import CONFIG的逻辑相当于在当前模块的命名空间执行CONFIG = config.CONFIG，也就是给原始对象在当前模块加了一个新的变量引用。如果你在所有模块执行这句导入之前，就把config模块下的CONFIG属性替换成测试用对象，后续所有模块导入拿到的都是替换后的新对象，完全不需要挨个修改每个引用处的Patch目标。

绝大多数Patch失效的场景，问题都出在导入顺序错误：先导入了依赖CONFIG的业务模块，再去Patch config里的属性，这时候业务模块已经把原始CONFIG对象绑定到自己的命名空间，后续修改config模块的属性不会影响已经存在的绑定。

内容的提问来源于stack exchange，提问作者M Leonard