如何在 Python 3.5 中使用 unittest.mock 模拟导入的库方法？

Question

是否可以在 Python 3.5 中使用 unittest.mock 模拟导入模块的方法？

# file my_function.py
import os
my_function():
    # do something with os, e.g call os.listdir
    return os.listdir(os.getcwd())

# file test_my_function.py
test_my_function():
    os = MagickMock()
    os.listdir = MagickMock(side_effect=["a", "b"])
    self.assertEqual("a", my_function())

我希望 os.listdir 方法在第一次调用时返回指定的副作用“a”，但在 my_function 内部调用了未修补的 os.listdir。

Answer 1

unittest.mock 有两个主要职责：

• 定义 Mock 对象：对象旨在跟随您的剧本并记录对模拟对象的每次访问
• 修补引用并恢复原始状态

在您的示例中，您需要两个功能：通过模拟修补生产代码中使用的os.listdir 引用，您可以完全控制它的响应方式。 patch的使用方式有很多种，有的details to take care on how use it和cavelets to know。

在您的情况下，您需要测试my_function() 的行为，并且需要同时修补os.listdir() 和os.getcwd()。此外，您需要控制return_value（查看return_value 和side_effect 差异的指定文档）。

我稍微重写了您的示例，使其更加完整和清晰：

my_function(nr=0):
    l = os.listdir(os.getcwd())
    l.sort()
    return l[nr]

@patch("os.getcwd")
@patch("os.listdir", return_value=["a","b"])
def test_my_function(mock_ld, mock_g): 
    self.assertEqual("a", my_function(0))
    mock_ld.assert_called_with(mock_g.return_value)
    self.assertEqual("a", my_function())
    self.assertEqual("b", my_function(1))
    with self.assertRaises(IndexError):
        my_function(3)

我使用装饰器语法是因为我认为它是一种更简洁的方式；此外，为了避免引入太多细节，我没有使用 autospecing 我认为这是一个非常好的做法。

最后一点：模拟是一个强大的工具，但使用它而不是滥用它，补丁只是你需要的补丁，仅此而已。