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

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

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

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')

mock_openmockフレームワークの一部であり、使用方法は非常に簡単です。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（）は任意のキーワード引数を取ります。これらは構築時にモック（または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、テスト関数の引数としてモックオブジェクトが追加されることに注意してください。

mockの最新バージョンでは、本当に便利なmock_openヘルパーを使用できます。

mock_open（mock = None、read_data = None）

openの使用を置き換えるモックを作成するヘルパー関数。直接呼び出された、またはコンテキストマネージャーとして使用されたopenに対して機能します。

モック引数は、構成するモックオブジェクトです。None（デフォルト）の場合、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')

単純なファイルに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を使用

上の答えは役に立ちますが、少し拡張しました。

ここに渡された引数に基づいてファイルオブジェクト（fin as f）の値を設定する場合は、次open()の1つの方法があります。

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

ゲームには少し遅れるかもしれませんが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__にmyをパッチするmock_open()ことで、ファイルを作成せずにファイルへの書き込みを模擬できます。

注：用途はcythonというモジュールを使用している、またはあなたのプログラムがどのような方法でcythonに依存している場合は、インポートする必要がありますcythonの__builtin__モジュールを含むことによってimport __builtin__、ファイルの先頭に。__builtin__cythonを使用している場合、ユニバーサルをモックすることはできません。

組み込みのopen（）関数にunittestをパッチするには：

これは、json設定を読み取るパッチで機能しました。

class ObjectUnderTest:
    def __init__(self, filename: str):
        with open(filename, 'r') as f:
            dict_content = json.load(f)

モックされたオブジェクトは、open（）関数によって返されるio.TextIOWrapperオブジェクトです

@patch("<src.where.object.is.used>.open",
        return_value=io.TextIOWrapper(io.BufferedReader(io.BytesIO(b'{"test_key": "test_value"}'))))
    def test_object_function_under_test(self, mocker):

これ以上ファイルが必要ない場合は、テストメソッドを装飾できます。

@patch('builtins.open', mock_open(read_data="data"))
def test_testme():
    result = testeme()
    assert result == "data"