115

你如何用mock模拟只读属性？

我试过：

setattr(obj.__class__, 'property_to_be_mocked', mock.Mock())

但问题是它随后适用于类的所有实例......这打破了我的测试。

你还有别的想法吗？我不想模拟整个对象，只模拟这个特定的属性。

4

9 回答 9

216

我认为更好的方法是将属性模拟为PropertyMock，而不是__get__直接模拟方法。

它在文档中说明，搜索unittest.mock.PropertyMock：旨在用作类的属性或其他描述符的模拟。PropertyMock提供__get__和__set__方法，以便您可以在获取时指定返回值。

方法如下：

class MyClass:
    @property
    def last_transaction(self):
        # an expensive and complicated DB query here
        pass

def test(unittest.TestCase):
    with mock.patch('MyClass.last_transaction', new_callable=PropertyMock) as mock_last_transaction:
        mock_last_transaction.return_value = Transaction()
        myclass = MyClass()
        print myclass.last_transaction
        mock_last_transaction.assert_called_once_with()
于 2014-08-21T10:28:54.713 回答
44

实际上，答案是（像往常一样）在文档中，只是当我按照他们的示例时，我将补丁应用于实例而不是类。

这是如何做到的：

class MyClass:
    @property
    def last_transaction(self):
        # an expensive and complicated DB query here
        pass

在测试套件中：

def test():
    # Make sure you patch on MyClass, not on a MyClass instance, otherwise
    # you'll get an AttributeError, because mock is using settattr and
    # last_transaction is a readonly property so there's no setter.
    with mock.patch(MyClass, 'last_transaction') as mock_last_transaction:
        mock_last_transaction.__get__ = mock.Mock(return_value=Transaction())
        myclass = MyClass()
        print myclass.last_transaction
于 2012-08-07T10:17:53.097 回答
13

如果要覆盖其属性的对象是模拟对象，则不必使用patch.

相反，可以创建一个PropertyMock然后覆盖模拟类型上的属性。例如，要覆盖mock_rows.pages要返回的属性(mock_page, mock_page,)：

mock_page = mock.create_autospec(reader.ReadRowsPage)
# TODO: set up mock_page.
mock_pages = mock.PropertyMock(return_value=(mock_page, mock_page,))
type(mock_rows).pages = mock_pages
于 2019-04-11T23:18:37.323 回答
11

可能是风格问题，但如果您更喜欢测试中的装饰器，@jamescastlefield 的答案可以更改为：

class MyClass:
    @property
    def last_transaction(self):
        # an expensive and complicated DB query here
        pass

class Test(unittest.TestCase):
    @mock.patch('MyClass.last_transaction', new_callable=PropertyMock)
    def test(self, mock_last_transaction):
        mock_last_transaction.return_value = Transaction()
        myclass = MyClass()
        print myclass.last_transaction
        mock_last_transaction.assert_called_once_with()
于 2017-01-10T14:28:42.670 回答
8

如果您使用pytestwith pytest-mock，您可以简化代码并避免使用上下文管理器，即with语句如下：

def test_name(mocker): # mocker is a fixture included in pytest-mock
    mocked_property = mocker.patch(
        'MyClass.property_to_be_mocked',
        new_callable=mocker.PropertyMock,
        return_value='any desired value'
    )
    o = MyClass()

    print(o.property_to_be_mocked) # this will print: any desired value

    mocked_property.assert_called_once_with()
于 2020-01-06T16:05:07.477 回答
3

如果你需要你的 mocked@property依赖于原来的__get__，你可以创建你的自定义MockProperty

class PropertyMock(mock.Mock):

    def __get__(self, obj, obj_type=None):
        return self(obj, obj_type)

用法：

class A:

  @property
  def f(self):
    return 123


original_get = A.f.__get__

def new_get(self, obj_type=None):
  return f'mocked result: {original_get(self, obj_type)}'


with mock.patch('__main__.A.f', new_callable=PropertyMock) as mock_foo:
  mock_foo.side_effect = new_get
  print(A().f)  # mocked result: 123
  print(mock_foo.call_count)  # 1
于 2020-10-21T08:59:49.573 回答
1

如果您不想测试是否访问了模拟属性，您可以简单地使用预期的return_value.

with mock.patch(MyClass, 'last_transaction', Transaction()):
    ...
于 2017-03-07T00:46:13.837 回答
0

我被引导到这个问题，因为我想在测试中模拟 Python 版本。不确定这是否与这个问题非常相关，但sys.version显然是只读的（......虽然技术上是“属性”而不是“属性”，我想）。

所以，在仔细阅读了这个地方并尝试了一些愚蠢复杂的东西之后，我意识到答案本身就是简单的：

with mock.patch('sys.version', version_tried):
    if version_tried == '2.5.2':
        with pytest.raises(SystemExit):
            import core.__main__
        _, err = capsys.readouterr()
        assert 'FATAL' in err and 'too old' in err

...可能会帮助某人。

于 2021-10-30T18:34:29.737 回答
0

模拟对象属性的另一种方法是：

import mock

mocked_object = mock.Mock()
mocked_object.some_property = "Property value"

print(mocked_object.some_property)
于 2022-02-01T16:29:21.710 回答