(Python の Mock フレームワークを使用して) with ステートメントで使用される open をモックするにはどうすればよいですか?

Question

次のコードをモックでテストするにはどうすればよいですか (モック、パッチ デコレーター、およびセンチネルを使用して、 Michael Foord のモック フレームワーク):

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

Answer 1

これを行う方法は、最終的には、特にMagicMockを使用してPythonのプロトコルメソッド（マジック・メソッド）を、からかっサポートするモック0.7.0に変更されました

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 フレームワークであり、使い方は非常に簡単です。 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")

デコレーターケース

使用する場合 patch デコレータとして使用 mock_open()の結果は new patchの議論は少し奇妙かもしれません。

この場合は、 new_callable patchの引数を覚えておいてください。 patch 使用しない場合はに渡されます new_callable で説明されているように機能します patch ドキュメンテーション.

patch() は任意のキーワード引数を受け取ります。これらは構築時に Mock (または 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 3

モックの最新バージョンでは、あなたは本当に便利 mock_open ヘルパーます：

  

の mock_open（モック=なし、READ_DATA =なし）の

     

ヘルパー関数を作成します   オープンの使用を置き換えるためにモック。これは、直接、またはと呼ばれるオープンのために働きます   コンテキストマネージャとして使用します。

     

モックの引数は、設定するためのモックオブジェクトです。なしの場合（   デフォルト）、その後MagicMockはAPIで、あなたのために作成されます   標準のファイルハンドルで使用可能なメソッドまたは属性に制限されます。

     

のread_dataは、ファイルハンドルのreadメソッドへの文字列があります   リターン。これはデフォルトでは空の文字列です。

>>> 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 4

単純なファイルのために mock_open を使用するにはread()（元mock_openスニペット書き込みのためにもっと連動になるすでにこのページに与えられた）：

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 5

私はゲームに少し遅れかもしれませんが、新しいファイルを作成することなく、別のモジュールで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")

私のopenに__builtin__モジュール内mock_open()機能にパッチを適用することで、私は1つを作成せずに、ファイルへの書き込みを模擬することができます。

注：cythonを使用するモジュールを使用している、またはあなたのプログラムがどのような方法でcythonに依存し、あなたがインポートする必要があります場合は、<のhref = "https://docs.python.org/2/library/__builtin__ .htmlを」REL = 『nofollowを』>ファイルの先頭に__builtin__を含めることによって、にcythonのimport __builtin__モジュール。あなたがcythonを使用している場合は、ユニバーサル__builtin__を模擬することはできません。

Answer 6

トップ答えは便利ですが、私はそれを少し拡大します。

あなたがfに渡される引数に基づいてファイルオブジェクト（as fでopen()）の値を設定したい場合は、ここでそれを行うための一つの方法だ。

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