Python中模拟文件对象或可迭代对象

Question

使用 mock 库，如何适当地模拟和测试迭代 open() 返回的对象？

whitelist_data.py:

WHITELIST_FILE = "testdata.txt"

format_str = lambda s: s.rstrip().lstrip('www.')
whitelist = None

with open(WHITELIST_FILE) as whitelist_data:
    whitelist = set(format_str(line) for line in whitelist_data)

if not whitelist:
    raise RuntimeError("Can't read data from %s file" % WHITELIST_FILE)

def is_whitelisted(substr):
    return 1 if format_str(substr) in whitelist else 0

这是我尝试测试它的方式。

import unittest
import mock 

TEST_DATA = """
domain1.com
domain2.com
domain3.com
"""

class TestCheckerFunctions(unittest.TestCase):

    def test_is_whitelisted_method(self):
        open_mock = mock.MagicMock()
        with mock.patch('__builtin__.open',open_mock):
            manager = open_mock.return_value.__enter__.return_value
            manager.__iter__ = lambda s: iter(TEST_DATA.splitlines())
            from whitelist_data import is_whitelisted
            self.assertTrue(is_whitelisted('domain1.com'))

if __name__ == '__main__':
    unittest.main()

python tests.py 的结果为：

$ python tests.py

E
======================================================================
ERROR: test_is_whitelisted_method (__main__.TestCheckerFunctions)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "tests.py", line 39, in test_is_whitelisted_method
    from whitelist_data import is_whitelisted
  File "/Users/supa/Devel/python/whitelist/whitelist_data.py", line 20, in <module>
    whitelist = set(format_str(line) for line in whitelist_data)
TypeError: 'Mock' object is not iterable

----------------------------------------------------------------------
Ran 1 test in 0.001s

更新：感谢Adam，我已重新安装了模拟库（pip install -e hg+https://code.google.com/p/mock#egg=mock）并更新了tests.py。效果非常好。

- Victor Miroshnikov

Answer 1

你需要使用一个MagicMock，它支持迭代。

在mock 0.80beta4版本中，patch函数返回一个MagicMock对象。因此这个简单的例子可以工作：

import mock

def foo():
    for line in open('myfile'):
        print line

@mock.patch('__builtin__.open')
def test_foo(open_mock):
    foo()
    assert open_mock.called

如果你正在使用 mock 0.7.x版本（看起来是这样），我认为你无法仅通过patch实现这一点。你需要单独创建mock，然后将其传递到patch中：

import mock

def foo():
    for line in open('myfile'):
        print line

def test_foo():
    open_mock = mock.MagicMock()
    with mock.patch('__builtin__.open', open_mock):
        foo()
        assert open_mock.called

请注意 - 我已经使用py.test运行了这些测试代码，然而同样的方法也可以在unittest中使用。

- Adam Wagner