How do I mock an open used in a with statement (using the Mock framework in Python)?

by

Python 3

Patch builtins.open and use mock_open, which is part of the mock framework. patch used as a context manager returns the object used to replace the patched one:

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

If you want to use patch as a decorator, using mock_open()‘s result as the new= argument to patch can be a little bit weird. Instead, use patch‘s new_callable= argument and remember that every extra argument that patch doesn’t use will be passed to the new_callable function, as described in the patch documentation:

patch() takes arbitrary keyword arguments. These will be passed to the Mock (or new_callable) on construction.

@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")

Remember that in this case patch will pass the mocked object as an argument to your test function.

Python 2

You need to patch __builtin__.open instead of builtins.open and mock is not part of unittest, you need to pip install and import it separately:

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

More Related Contents:

  1. What is the python “with” statement designed for?
  2. How can I mock requests and the response?
  3. Explaining Python’s ‘__enter__’ and ‘__exit__’
  4. python mocking raw input in unittests
  5. Can I patch a Python decorator before it wraps a function?
  6. Python: Mocking a context manager
  7. Conditional with statement in Python
  8. Why python mock patch doesn’t work?
  9. Python mock multiple return values
  10. Python Mock object with method called multiple times
  11. How can one mock/stub python module like urllib
  12. In Python, if I return inside a “with” block, will the file still close?
  13. Python Multiprocessing Lib Error (AttributeError: __exit__)
  14. Object becomes None when using a context manager
  15. How can I mock user input (from “input” in 3.x, or “raw_input” in 2.x) for a unit test?
  16. How to monkeypatch python’s datetime.datetime.now with py.test?
  17. Mocking boto3 S3 client method Python
  18. What is your favorite Python mocking library? [closed]
  19. Break or exit out of “with” statement?
  20. Mock Python’s built in print function
  21. How to test or mock “if __name__ == ‘__main__'” contents
  22. Using mock patch to mock an instance method
  23. Python mock Patch os.environ and return value
  24. Customizing unittest.mock.mock_open for iteration
  25. Catching exception in context manager __enter__()
  26. What’s the advantage of using ‘with .. as’ statement in Python?
  27. Context manager for Python’s MySQLdb
  28. Django: How to create a model dynamically just for testing
  29. Can I “fake” a package (or at least a module) in python for testing purposes?
  30. How to mock a readonly property with mock?

Leave a Comment