如何在with語句中使用open（在Python中使用Mock框架）？

Question

如何測試與嘲笑下面的代碼（使用嘲弄，貼片裝飾和哨兵由Michael Foord's Mock framework提供）：

def testme(filepath): 
    with open(filepath, 'r') as f: 
     return f.read() 

Answer 1

做到這一點的方式，其中終於支持嘲諷蟒蛇模擬0.7.0已經改變協議方法（魔術方法），特別是使用MagicMock：

http://www.voidspace.org.uk/python/mock/magicmock.html

嘲笑開放爲上下文管理器（從實施例頁模擬文檔中）的一個例子：

>>> open_name = '%s.open' % __name__ 
>>> with patch(open_name, create=True) as mock_open: 
...  mock_open.return_value = MagicMock(spec=file) 
... 
...  with open('/some/path', 'w') as f: 
...   f.write('something') 
... 
<mock.Mock object at 0x...> 
>>> file_handle = mock_open.return_value.__enter__.return_value 
>>> file_handle.write.assert_called_with('something') 

Answer 2

隨着模擬的最新版本，你可以使用真正有用mock_open幫手：

mock_open（模擬=無了read_data =無）

一個輔助函數來創建一個 嘲笑取代使用開放。它適用於直接調用open或 用作上下文管理器。

模擬參數是要配置的模擬對象。如果無（默認爲 ），則將爲您創建MagicMock，並將API 限制爲標準文件句柄上提供的方法或屬性。

read_data是一個字符串，用於讀取文件句柄的方法，返回 。這是一個默認的空字符串。

>>> from mock import mock_open, patch 
>>> m = mock_open() 
>>> with patch('{}.open'.format(__name__), m, create=True): 
... with open('foo', 'w') as h: 
...  h.write('some stuff') 

>>> m.assert_called_once_with('foo', 'w') 
>>> handle = m() 
>>> handle.write.assert_called_once_with('some stuff') 

Answer 3

要爲簡單的文件read()使用mock_open（原mock_open片斷already given on this page是面向更寫）：

my_text = "some text to return when read() is called on the file object" 
mocked_open_function = mock.mock_open(read_data=my_text) 

with mock.patch("__builtin__.open", mocked_open_function): 
    with open("any_string") as f: 
     print f.read() 

注每文檔爲mock_open如，這是專門爲read()，所以不會像for line in f這樣的常見模式工作。

使用Python 2.6.6/1.0.1模擬

Answer 4

我可能會有點晚了比賽，但這個調用另一個模塊open時無需創建一個新的文件爲我工作。

test.py

import unittest 
from mock import Mock, patch, mock_open 
from MyObj import MyObj 

class TestObj(unittest.TestCase): 
    open_ = mock_open() 
    with patch.object(__builtin__, "open", open_): 
     ref = MyObj() 
     ref.save("myfile.txt") 
    assert open_.call_args_list == [call("myfile.txt", "wb")] 

MyObj.py

class MyObj(object): 
    def save(self, filename): 
     with open(filename, "wb") as f: 
      f.write("sample text") 

通過修補__builtin__模塊內的open功能我mock_open()，我可以嘲笑，而無需創建一個寫入文件。

注意：如果您使用的是使用cython的模塊，或者您的程序以任何方式依賴於cython，則需要導入cython's __builtin__ module，其中包括文件頂部的import __builtin__。如果您使用的是cython，您將無法模擬通用的__builtin__。

Answer 5

這些答案中有很多噪音;幾乎所有的都是正確的，但過時而且不整齊。 mock_open是mock框架的一部分，使用非常簡單。用作上下文的patch返回用於替換已修補的對象的對象：您可以使用它來使測試更簡單。

Python 3.x都有

使用builtins而不是__builtin__。

from unittest.mock import patch, mock_open 
with patch("builtins.open", mock_open(read_data="data")) as mock_file: 
    assert open("path/to/open").read() == "data" 
    mock_file.assert_called_with("path/to/open") 

的Python 2.7

mock不是unittest一部分，你應該修補__builtin__

from mock import patch, mock_open 
with patch("__builtin__.open", mock_open(read_data="data")) as mock_file: 
    assert open("path/to/open").read() == "data" 
    mock_file.assert_called_with("path/to/open") 

裝飾情況下

，如果您使用mock_open()的結果作爲使用patch作爲裝飾newpatch的論點可以b有點奇怪。

在這種情況下，最好使用new_callablepatch的說法，並記住每一個額外的參數，作爲在patch documentation描述patch不使用將被傳遞給new_callable功能。

patch（）採用任意關鍵字參數。這些將被傳遞給施工中的模擬（或new_callable）。

例如裝飾版本Python 3.x都有是：

@patch("builtins.open", new_callable=mock_open, read_data="data") 
def test_patch(mock_file): 
    assert open("path/to/open").read() == "data" 
    mock_file.assert_called_with("path/to/open") 

請記住，在這種情況下patch將增加模擬對象作爲參數的您測試功能。

Answer 6

最常見的答案很有用，但我稍微擴展了一下。

如果你想基於傳遞給open()的參數設置你的文件對象（在as f的f）的值，這裏有一個方法來做到這一點：

def save_arg_return_data(*args, **kwargs): 
    mm = MagicMock(spec=file) 
    mm.__enter__.return_value = do_something_with_data(*args, **kwargs) 
    return mm 
m = MagicMock() 
m.side_effect = save_arg_return_array_of_data 

# if your open() call is in the file mymodule.animals 
# use mymodule.animals as name_of_called_file 
open_name = '%s.open' % name_of_called_file 

with patch(open_name, m, create=True): 
    #do testing here 

基本上，open()會返回一個對象， with將在該對象上調用__enter__()。

爲了正確模擬，我們必須模擬open()返回一個模擬對象。然後該模擬對象應該模擬__enter__()調用（MagicMock將爲我們執行此操作）以返回我們想要的模擬數據/文件對象（因此mm.__enter__.return_value）。這樣做2嘲笑上面的方式允許我們捕獲傳遞給open()的參數，並將它們傳遞給我們的do_something_with_data方法。

我通過一個完整的模擬文件作爲字符串open()和我do_something_with_data是這樣的：

def do_something_with_data(*args, **kwargs): 
    return args[0].split("\n") 

這把字符串轉換爲一個列表，以便您可以像使用普通文件執行以下操作：

for line in file: 
    #do action