https://github.com/nivbend/mock-open

A better mock for file I/O
https://github.com/nivbend/mock-open

filesystem mock mocks python python2 python3 testing unit-testing

Last synced: 21 days ago
JSON representation

A better mock for file I/O

• Host: GitHub
• URL: https://github.com/nivbend/mock-open
• Owner: nivbend
• License: mit
• Created: 2015-08-15T08:17:29.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-10-10T17:50:24.000Z (over 4 years ago)
• Last Synced: 2024-12-12T03:08:36.496Z (about 1 month ago)
• Topics: filesystem, mock, mocks, python, python2, python3, testing, unit-testing
• Language: Python
• Size: 60.5 KB
• Stars: 7
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
mock-open

=========

[![PyPI version](https://badge.fury.io/py/mock-open.svg)](https://pypi.python.org/pypi/mock-open/)

[![Build Status](https://travis-ci.org/nivbend/mock-open.svg?branch=master)](https://travis-ci.org/nivbend/mock-open)

[![GitHub license](https://img.shields.io/github/license/nivbend/mock-open.svg)](https://github.com/nivbend/mock-open/blob/master/LICENSE)

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/nivbend/mock-open/graphs/commit-activity)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

A better mock for file I/O.

Install

-------

```

$ pip install mock-open

```

class `MockOpen`

----------------

The `MockOpen` class should work as a stand-in replacement for [`mock.mock_open`][mock-open] with

some added features (though it tries to conform to how the builtin `open` works where the two

differ):

 * Multiple file support, including a mapping-like access to file mocks by path:

   ```python

   from mock_open import MockOpen

   mock_open = MockOpen()

   mock_open["/path/to/file"].read_data = "Data from a fake file-like object"

   mock_open["/path/to/bad_file"].side_effect = IOError()

   ```

   You can also configure behavior via the regular `mock` library API:

   ```python

   mock_open = MockOpen()

   mock_open.return_value.write.side_effect = IOError()

   ```

 * Persistent file contents between calls to `open`:

   ```python

   with patch("builtins.open", MockOpen()):

       with open("/path/to/file", "w") as handle:

           handle.write("Some text")

       with open("/path/to/file", "r") as handle:

           assert "Some text" == handle.read()

   ```

 * All the regular file operations: `read`, `readline`, `readlines`, `write`, `writelines`, `seek`,

   `tell`.

Acknowledgements

----------------

This library uses modified versions of tests from the [CPython source code][CPython] as part of its

test suite. The original tests are licensed under the [PSF license agreement][PSF License] and are

copyright of the Python Software Foundation.

[mock-open]: http://docs.python.org/library/unittest.mock.html#mock-open

[CPython]: https://github.com/python/cpython

[PSF License]: https://docs.python.org/license.html#terms-and-conditions-for-accessing-or-otherwise-using-python