Python单元测试中无法对模块变量进行猴子补丁的问题求助

我来帮你分析下为什么这两种修改方式没生效，以及对应的解决办法：

问题根源 #

你的DATA_PATH是模块加载时就计算并赋值的模块级变量，而SomeClass.__init__里引用的是这个模块级变量。如果测试代码中修改DATA_PATH的时机不对，或者patch的目标有误，就会导致修改不生效：

• 如果在创建SomeClass实例之后才修改DATA_PATH，实例的filename已经用旧值计算完成了；
• 如果patch的命名空间不正确（比如patch的是测试文件里的引用而非原模块的变量），也会无效。

有效解决方法 #

方法1：确保修改时机正确（直接赋值法） #

在测试代码中，先修改模块的DATA_PATH，再创建SomeClass实例，并且要确保修改的是原模块的变量：

# tests/module_test.py
import unittest
import os
import package.module as module
from package.module import SomeClass

class TestSomeClass(unittest.TestCase):
    def setUp(self):
        # 在实例化前修改模块级变量
        module.DATA_PATH = "data_path_here"

    def test_filename(self):
        obj = SomeClass()
        self.assertEqual(obj.filename, os.path.join("data_path_here", "ABC.txt"))

方法2：正确使用@patch装饰器 #

使用patch时，必须指定原模块中DATA_PATH的完整命名空间（也就是package.module.DATA_PATH），并且确保patch在实例化前生效：

# tests/module_test.py
import unittest
import os
from unittest.mock import patch
from package.module import SomeClass

class TestSomeClass(unittest.TestCase):
    @patch("package.module.DATA_PATH", "data_path_here")
    def test_filename(self):
        obj = SomeClass()
        self.assertEqual(obj.filename, os.path.join("data_path_here", "ABC.txt"))

方法3：优化原模块代码（更推荐的测试友好方案） #

上面两种方法都是“hack”模块变量，更优雅的方式是让SomeClass支持注入data_path，这样测试时无需修改模块变量：

# package/module.py
import os
DATA_PATH = os.path.join(os.path.dirname(__file__), "data")

class SomeClass:
    def __init__(self, data_path=None):
        # 允许传入自定义路径，默认使用模块级DATA_PATH
        self.data_path = data_path or DATA_PATH
        self.filename = os.path.join(self.data_path, "ABC.txt")

测试时直接传入自定义路径即可：

# tests/module_test.py
import unittest
import os
from package.module import SomeClass

class TestSomeClass(unittest.TestCase):
    def test_filename(self):
        obj = SomeClass(data_path="data_path_here")
        self.assertEqual(obj.filename, os.path.join("data_path_here", "ABC.txt"))

内容的提问来源于stack exchange，提问作者Alicja Głowacka