diff options
| author | mrbean-bremen <mrbean-bremen@users.noreply.github.com> | 2023-04-23 21:39:42 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-04-23 21:39:42 +0200 |
| commit | 74150ae25137d1e38c9650f02c78ef52463c5a65 (patch) | |
| tree | ecbefad33a08138cd4bde0c4ab419f94d4604872 | |
| parent | eff3286e5c4ef4ba0583b0a4de9a57560ff57d6b (diff) | |
| download | pyfakefs-74150ae25137d1e38c9650f02c78ef52463c5a65.tar.gz | |
Adapt summary in README (#817)
- fix getting version in bug report template
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 2 | ||||
| -rw-r--r-- | README.md | 14 | ||||
| -rw-r--r-- | docs/usage.rst | 2 |
3 files changed, 12 insertions, 6 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 6b766cd..37d93ca 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,6 +21,6 @@ paste the output. ```bash python -c "import platform; print(platform.platform())" python -c "import sys; print('Python', sys.version)" -python -c "from pyfakefs.fake_filesystem import __version__; print('pyfakefs', __version__)" +python -c "from pyfakefs import __version__; print('pyfakefs', __version__)" python -c "import pytest; print('pytest', pytest.__version__)" ``` @@ -6,10 +6,16 @@ Using pyfakefs, your tests operate on a fake file system in memory without touching the real disk. The software under test requires no modification to work with pyfakefs. -pyfakefs acts as a `pytest` plugin by providing the `fs` fixture, which will -automatically invoke the fake filesystem. It also provides -the `fake_filesystem_unittest.TestCase` class for use with `unittest` and -the means to use the fake filesystem with other test frameworks. +Pyfakefs creates a new empty in-memory file system at each test start, which replaces +the real filesystem during the test. Think of pyfakefs as making a per-test temporary +directory, except for an entire file system. + +There are several means to achieve this: by using +the `fs` fixture if running pytest, by using `fake_filesystem_unittest.TestCase` as a +base class if using unittest, by using a `fake_filesystem_unittest.Patcher` instance +as a context manager, or by using the `patchfs` decorator. + + pyfakefs works with current versions of Linux, Windows and macOS. diff --git a/docs/usage.rst b/docs/usage.rst index 8ea4ee1..b75bf81 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -40,7 +40,7 @@ tests: Class-, module- and session-scoped fixtures ........................................... For convenience, class-, module- and session-scoped fixtures with the same -functionality are provided, named ``fake_fs``, ``fs_module`` and ``fs_session``, +functionality are provided, named ``fs_class``, ``fs_module`` and ``fs_session``, respectively. .. caution:: If any of these fixtures is active, any other ``fs`` fixture will |