Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adapted usage scenarios in README #270

Merged
merged 1 commit into from
Aug 9, 2017
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 60 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,34 +45,75 @@ def my_fakefs_test(fs):
assert os.path.exists('/var/data/xx1.txt')
```

### Patch using unittest.mock
### Patch using fake_filesystem_unittest.Patcher
If you are using other means of testing like [nose](http://nose2.readthedocs.io), you can do the
patching using `fake_filesystem_unittest.Patcher` - the class doing the the actual work
of replacing the filesystem modules with the fake modules in the first two approaches.

The other approach is to do the patching yourself using `mock.patch()`:
The easiest way is to just use `Patcher` as a context manager:

```python
import pyfakefs.fake_filesystem as fake_fs
from fake_filesystem_unittest import Patcher

# Create a faked file system
fs = fake_fs.FakeFilesystem()
with Patcher() as patcher:
# access the fake_filesystem object via patcher.fs
patcher.fs.CreateFile('/foo/bar', contents='test')

# Do some setup on the faked file system
fs.CreateFile('/var/data/xx1.txt')
fs.CreateFile('/var/data/xx2.txt')
# the following code works on the fake filesystem
with open('/foo/bar') as f:
contents = f.read()
```

You can also initialize `Patcher` manually:

```python
from fake_filesystem_unittest import Patcher

patcher = Patcher()
patcher.setUp() # called in the initialization code
...
patcher.tearDown() # somewhere in the cleanup code
```

### Patch using unittest.mock (deprecated)

You can also use ``mock.patch()`` to patch the modules manually. This approach will
only work for the directly imported modules, therefore it is not suited for testing
larger code bases. As the other approaches are more convenient, this one is considered
deprecated.
You have to create a fake filesystem object, and afterwards fake modules based on this file system
for the modules you want to patch.

The following modules and functions can be patched:

* `os` and `os.path` by `fake_filessystem.FakeOsModule`
* `io` by `fake_filessystem.FakeIoModule`
* `pathlib` by `fake_pathlib.FakePathlibModule`
* build-in `open()` by `fake_filessystem.FakeFileOpen`

```python

import pyfakefs.fake_filesystem as fake_fs

# Create a faked file system
fs = fake_fs.FakeFilesystem()

# Replace some built-in file system related modules you use with faked ones
# Do some setup on the faked file system
fs.CreateFile('/foo/bar', contents='test')

# Assuming you are using the mock library to ... mock things
try:
from unittest.mock import patch # In Python 3, mock is built-in
except ImportError:
from mock import patch # Python 2
# Replace some built-in file system related modules you use with faked ones

import pyfakefs.fake_filesystem_shutil as fake_shutil
# Assuming you are using the mock library to ... mock things
try:
from unittest.mock import patch # In Python 3, mock is built-in
except ImportError:
from mock import patch # Python 2

# Note that this fake module is based on the fake fs you just created
shutil = fake_shutil.FakeShutilModule(fs)
with patch('mymodule.shutil', shutil):
print(shutil.disk_usage('/var/data/'))
# Note that this fake module is based on the fake fs you just created
os = fake_fs.FakeOsModule(fs)
with patch('mymodule.os', os):
fd = os.open('/foo/bar', os.O_RDONLY)
contents = os.read(fd, 4)
```

## Installation
Expand Down