Python：如何模拟类属性初始化函数答案

【问题标题】：Python: How to mock class attribute initializer functionPython：如何模拟类属性初始化函数
【发布时间】：2016-06-02 13:14:02
【问题描述】：

我想模拟一个用于初始化类级（而非实例）属性的模块级函数。这是一个简化的示例：

# a.py    
def fn(): 
    return 'asdf'

class C:
    cls_var = fn()

这是一个试图模拟 a.fn() 的单元测试：

# test_a.py 
import unittest, mock
import a

class TestStuff(unittest.TestCase):
    # we want to mock a.fn so that the class variable
    # C.cls_var gets assigned the output of our mock

    @mock.patch('a.fn', return_value='1234')
    def test_mock_fn(self, mocked_fn):
        print mocked_fn(), " -- as expected, prints '1234'"
        self.assertEqual('1234', a.C.cls_var) # fails! C.cls_var is 'asdf'

我相信问题出在where to patch，但我已经尝试了两种导入变体，但都没有运气。我什至尝试将 import 语句移动到 test_mock_fn() 中，以便模拟的 a.fn() 在 a.C 进入范围之前“存在” - 不，仍然失败。

任何见解将不胜感激！

【问题讨论】：

您是否尝试过将导入更改为使用 from 语句？从导入 fn
嗨 Ranier - 是的，试过了；没有运气。（当我提到“......导入的两种变体......”时，我应该更清楚。mock 上的 Python 文档给出了使用 import a 和 from a import SomeClass 的示例。我尝试了两种风格）

标签： python static-members python-mock class-attributes

【解决方案1】：

这里实际发生的是，当您实际导入模块时，fn() 已经执行了。因此，在您评估了存储在类属性中的方法之后，模拟就会出现。

因此，当您尝试模拟该方法时，您尝试进行的测试已经太迟了。

如果你只是在你的方法中添加一个打印语句，你甚至可以看到这种情况发生：

def fn():
    print("I have run")
    return "asdf"

在您的测试模块中，当您导入 a 并简单地运行而不运行您的测试时，您将看到 I have run 将出现在您的控制台输出中，而无需从您的 a 模块显式运行任何内容。

因此，您可以在此处采用两种方法。您可以使用PropertyMock 将类属性模拟为您期望它存储的内容，如下所示：

@mock.patch('a.C.cls_var', new_callable=PropertyMock)
def test_mock_fn(self, mocked_p):
    mocked_p.return_value = '1234'

    self.assertEqual('1234', a.C.cls_var)

现在，您还必须注意，通过这样做，您实际上仍然在运行 fn，但是通过这种模拟，您现在在 cls_var 中持有“1234”和您设置的 PropertyMock向上。

以下建议（可能不太理想，因为它需要更改设计）将需要修改您使用类属性的原因。因为如果您实际上将该类属性设置为实例属性，那么当您创建C 的实例时，您的方法将执行，此时它将使用您的模拟。

所以，你的类看起来像：

class C:
    def __init__(self):
        self.var = fn()

你的测试看起来像：

@mock.patch('a.fn', return_value='1234')
def test_mock_fn(self, mocked_p):
    self.assertEqual('1234', a.C().var)

【讨论】：

嗨 idjaw - 嘿，我喜欢 PropertyMock 的想法！我会试试的。让fn() 运行并不理想，但值得一试。关于你的第二个想法，相信我，我很想重构这段代码。但当然，我给出的示例是对涉及 SQLAlchemy 的实际问题的抽象。 SQLAlchemy 广泛使用类属性，我几乎无法更改它。谢谢！

【解决方案2】：

即使@idjaw 的回答也是正确的，并正确解释了发生了什么我认为最简洁、简单和直接的方法是直接通过值而不是模拟来修补a.C.cls_var 属性。

@mock.patch('a.C.cls_var', '1234')

这足以满足您的一切需求：使用 PropertyMock 仅在您必须替换应该表现得像属性的属性时很有用。

有关您的方法为何不起作用的所有详细信息，请查看@idjaw 的答案。

【讨论】：