是否有标准方法(无需安装第三方库)在 Python 中进行跨平台文件系统模拟?如果我必须使用第三方库,哪个库是标准的?
4 回答
pyfakefs ( homepage ) 做你想做的事——一个假文件系统;它是第三方,尽管该方是谷歌。有关使用的讨论,请参阅如何替换被测模块的文件访问引用。
对于模拟,unittest.mock是 Python 3.3+ ( PEP 0417 ) 的标准库;对于早期版本,请参阅PyPI: mock (for Python 2.5+) ( homepage )。
测试和模拟中的术语不一致;使用 Gerard Meszaros 的Test Double术语,您要求的是“假”:行为类似于文件系统的东西(您可以创建、打开和删除文件),但不是实际的文件系统(在这种情况下它是内存中),因此您不需要测试文件或临时目录。
在经典的模拟中,您将改为模拟出系统调用(在 Python 中,模拟出os
模块中的函数,例如os.rm
and os.listdir
),但这更加繁琐。
pytest获得了很大的吸引力,它可以使用tmpdir和monkeypatching(模拟)来完成所有这些工作。
您可以使用tmpdir
函数参数,该参数将提供一个对测试调用唯一的临时目录,该目录在基本临时目录中创建(默认情况下创建为系统临时目录的子目录)。
import os
def test_create_file(tmpdir):
p = tmpdir.mkdir("sub").join("hello.txt")
p.write("content")
assert p.read() == "content"
assert len(tmpdir.listdir()) == 1
函数参数可monkeypatch
帮助您安全地设置/删除属性、字典项或环境变量或修改sys.path
以进行导入。
import os
def test_some_interaction(monkeypatch):
monkeypatch.setattr(os, "getcwd", lambda: "/")
你也可以给它传递一个函数而不是使用 lambda。
import os.path
def getssh(): # pseudo application code
return os.path.join(os.path.expanduser("~admin"), '.ssh')
def test_mytest(monkeypatch):
def mockreturn(path):
return '/abc'
monkeypatch.setattr(os.path, 'expanduser', mockreturn)
x = getssh()
assert x == '/abc/.ssh'
# You can still use lambda when passing arguments, e.g.
# monkeypatch.setattr(os.path, 'expanduser', lambda x: '/abc')
如果您的应用程序与文件系统有很多交互,那么使用pyfakefs 之类的东西可能会更容易,因为模拟会变得乏味和重复。
Python 3.3+ 中的标准模拟框架是unittest.mock;您可以将其用于文件系统或其他任何东西。
您也可以通过猴子补丁模拟来简单地手动滚动它:
一个简单的例子:
import os.path
os.path.isfile = lambda path: path == '/path/to/testfile'
更完整一点(未经测试):
import classtobetested
import unittest
import contextlib
@contextlib.contextmanager
def monkey_patch(module, fn_name, patch):
unpatch = getattr(module, fn_name)
setattr(module, fn_name)
try:
yield
finally:
setattr(module, fn_name, unpatch)
class TestTheClassToBeTested(unittest.TestCase):
def test_with_fs_mocks(self):
with monkey_patch(classtobetested.os.path,
'isfile',
lambda path: path == '/path/to/file'):
self.assertTrue(classtobetested.testable())
在这个例子中,实际的模拟是微不足道的,但你可以用一些有状态的东西来支持它们,这样就可以代表文件系统操作,比如保存和删除。是的,这有点难看,因为它需要在代码中复制/模拟基本文件系统。
请注意,您不能猴子修补 python 内置函数。话虽如此...
对于早期版本,如果可能使用第三方库,我会选择 Michael Foord 的很棒的Mockunittest.mock
,由于PEP 0417 ,它现在在标准库中,因为 3.3+ ,你可以在PyPI for Python 2.5+上获得它. 而且,它可以模拟内置函数!
伪装还是嘲讽?
就我个人而言,我发现文件系统中存在很多边缘情况(比如以正确的权限打开文件、字符串与二进制文件、读/写模式等),使用准确的假文件系统可以找到很多您可能无法通过模拟找到的错误。在这种情况下,我会检查memoryfs
模块pyfilesystem
(它具有相同接口的各种具体实现,因此您可以在代码中将它们换掉)。
模拟(并且没有猴子补丁!):
也就是说,如果你真的想模拟,你可以使用 Python 的unittest.mock
库轻松地做到这一点:
# production code file; note the default parameter
def make_hello_world(path, open_func=open):
with open_func(path, 'w+') as f:
f.write('hello, world!')
# test code file
def test_make_hello_world():
file_mock = unittest.mock.Mock(write=unittest.mock.Mock())
open_mock = unittest.mock.Mock(return_value=file_mock)
# When `make_hello_world()` is called
make_hello_world('/hello/world.txt', open_func=open_mock)
# Then expect the file was opened and written-to properly
open_mock.assert_called_once_with('/hello/world.txt', 'w+')
file_mock.write.assert_called_once_with('hello, world!')
上面的示例仅演示了通过模拟方法创建和写入文件open()
,但您可以轻松模拟任何方法。