[python] with 문에서 사용되는 open을 어떻게 조롱합니까 (Python에서 Mock 프레임 워크 사용)?

PYTHON / 글쓴이

mocks를 사용하여 다음 코드를 테스트하는 방법 ( Michael Foord의 Mock 프레임 워크에서 제공하는 mock , 패치 데코레이터 및 센티넬 사용 ) :

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

답변

이를 수행하는 방법은 mock 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컨텍스트로 사용하면 패치 된 오브젝트를 대체하는 데 사용되는 오브젝트가 리턴됩니다.이를 사용하여 테스트를 단순화 할 수 있습니다.

파이썬 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")

파이썬 2.7

mockunittest패치의 일부가 아니므로 패치해야합니다__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모의 객체를 테스트 함수의 인수로 추가합니다.

답변

최신 버전의 mock을 사용하면 매우 유용한 mock_open 도우미를 사용할 수 있습니다 .

mock_open (mock = 없음, read_data = 없음)

오픈 사용을 대체하기 위해 모의 객체를 만드는 헬퍼 함수. 직접 호출되거나 컨텍스트 관리자로 사용되는 열기에서 작동합니다.

mock 인수는 구성 할 mock 객체입니다. 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.

파이썬 2.6.6 / 모의 1.0.1 사용

답변

가장 좋은 대답은 유용하지만 조금 확장했습니다.

여기에 전달 된 인수를 기반으로 파일 객체의 값 ( fin 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

답변

게임에 약간 늦었을 수도 있지만 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을 사용하는 경우 유니버설을 조롱 할 수 없습니다 .

답변

unittest로 내장 open () 함수를 패치하려면 :

이것은 패치가 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):