pytest-dev/pyfakefs pytest-dev/pyfakefs

  • Stars
    star
    635
  • Rank 70,829 (Top 2 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 9 years ago
  • Updated 4 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
pytest-dev/pyfakefs
github

pytest-dev

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Provides a fake file system that mocks the Python file system modules.

pyfakefs PyPI version Python version Testsuite Documentation Status pre-commit.ci status

pyfakefs implements a fake file system that mocks the Python file system modules. 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 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.

Documentation

This document provides a general overview for pyfakefs. There is more:

  • The documentation at Read the Docs:
    • The Release documentation contains usage documentation for pyfakefs and a description of the most relevant classes, methods and functions for the last version released on PyPI
    • The Development documentation contains the same documentation for the current main branch
    • The Release 3.7 documentation contains usage documentation for the last version of pyfakefs supporting Python 2.7
  • The Release Notes show a list of changes in the latest versions

Usage

The simplest method to use pyfakefs is using the fs fixture with pytest. Refer to the usage documentation for information on other test scenarios, test customization and using convenience functions.

Features

Apart from automatically mocking most file-system functions, pyfakefs provides some additional features:

  • mapping files and directories from the real file system into the fake filesystem
  • configuration and tracking of the file system size
  • pause and resume of patching to be able to use the real file system inside a test step
  • (limited) emulation of other OSes (Linux, macOS or Windows)
  • configuration to behave as if running as a non-root user while running under root

Compatibility

pyfakefs works with CPython 3.7 and above, on Linux, Windows and macOS, and with PyPy3.

pyfakefs works with pytest version 3.0.0 or above, though a current version is recommended.

pyfakefs will not work with Python libraries that use C libraries to access the file system. This is because pyfakefs cannot patch the underlying C libraries' file access functions--the C libraries will always access the real file system. Refer to the documentation for more information about the limitations of pyfakefs.

Development

Continuous integration

pyfakefs is currently automatically tested on Linux, macOS and Windows, with Python 3.7 to 3.11, and with PyPy3 on Linux, using GitHub Actions.

Running pyfakefs unit tests

On the command line

pyfakefs unit tests can be run using pytest (all tests) or unittest (all tests except pytest-specific ones):

$ cd pyfakefs/
$ export PYTHONPATH=$PWD

$ python -m pytest pyfakefs
$ python -m pyfakefs.tests.all_tests

Similar scripts are called by tox and Github Actions. tox can be used to run tests locally against supported python versions:

$ tox

In a Docker container

The Dockerfile at the repository root will run the tests on the latest Ubuntu version. Build the container:

cd pyfakefs/
docker build -t pyfakefs .

Run the unit tests in the container:

docker run -t pyfakefs

Contributing to pyfakefs

We always welcome contributions to the library. Check out the Contributing Guide for more information.

History

pyfakefs.py was initially developed at Google by Mike Bland as a modest fake implementation of core Python modules. It was introduced to all of Google in September 2006. Since then, it has been enhanced to extend its functionality and usefulness. At last count, pyfakefs was used in over 2,000 Python tests at Google.

Google released pyfakefs to the public in 2011 as Google Code project pyfakefs:

After the shutdown of Google Code was announced, John McGehee merged all three Google Code projects together here on GitHub where an enthusiastic community actively supports, maintains and extends pyfakefs. In 2022, the repository has been transferred to pytest-dev to ensure continuous maintenance.

More Repositories

1

pytest

The pytest framework makes it easy to write small tests, yet scales to support complex functional testing
Python
11,750
star
2

pytest-testinfra

Testinfra test your infrastructures
Python
2,359
star
3

pytest-mock

Thin-wrapper around the mock package for easier use with pytest
Python
1,804
star
4

pytest-cov

Coverage plugin for pytest.
Python
1,722
star
5

pytest-xdist

pytest plugin for distributed testing and loop-on-failures testing modes.
Python
1,421
star
6

pytest-asyncio

Asyncio support for pytest
Python
1,378
star
7

pytest-django

A Django plugin for pytest.
Python
1,350
star
8

pytest-bdd

BDD library for the py.test runner
Python
1,281
star
9

pluggy

A minimalist production ready plugin system
Python
1,235
star
10

pytest-html

Plugin for generating HTML reports for pytest results
Python
689
star
11

pytest-randomly

🎲 Pytest plugin to randomly order tests and control random.seed
Python
600
star
12

pytest-flask

A set of pytest fixtures to test Flask applications
Python
483
star
13

pytest-qt

pytest plugin for Qt (PyQt5/PyQt6 and PySide2/PySide6) application testing
Python
401
star
14

pytest-rerunfailures

a pytest plugin that re-runs failed tests up to -n times to eliminate flakey failures
Python
373
star
15

pytest-factoryboy

factory_boy integration the pytest runner
Python
358
star
16

pytest-selenium

Plugin for running Selenium with pytest
Python
331
star
17

cookiecutter-pytest-plugin

A Cookiecutter template for pytest plugins 💻
Python
292
star
18

pytest-splinter

pytest splinter and selenium integration for anyone interested in browser interaction in tests
Python
253
star
19

pytest-describe

Describe-style plugin for the pytest framework
Python
208
star
20

pytest-timeout

Python
206
star
21

pytest-subtests

unittest subTest() support and subtests fixture
Python
199
star
22

pytest-repeat

pytest plugin for repeating test execution
Python
168
star
23

pytest-order

pytest plugin that allows to customize the test execution order
Python
158
star
24

pytest-instafail

py.test plugin to show failures instantly
Python
135
star
25

unittest2pytest

helps rewriting Python `unittest` test-cases into `pytest` test-cases
Python
128
star
26

pytest-env

pytest plugin to set environment variables in pytest.ini or pyproject.toml file
Python
128
star
27

pytest-github-actions-annotate-failures

Pytest plugin to annotate failed tests with a workflow command for GitHub Actions
Python
127
star
28

pytest-cpp

Use pytest's runner to discover and execute C++ tests
C++
117
star
29

pytest-xprocess

pytest external process plugin
Python
97
star
30

pytest-reportlog

Replacement for the --resultlog option, focused in simplicity and extensibility
Python
89
star
31

execnet

distributed Python deployment and communication
Python
78
star
32

pytest-variables

Plugin for providing variables to pytest tests/fixtures
Python
74
star
33

pytest-play

pytest plugin that let you automate actions and assertions with test metrics reporting executing plain YAML files
Python
68
star
34

py

Python development support library (note: maintenance only)
Python
67
star
35

pytest-print

pytest-print adds the printer fixture you can use to print messages to the user (directly to the pytest runner, not stdout)
Python
67
star
36

pytest-messenger

Pytest-messenger report plugin for all popular messengers like: Slack, DingTalk, Telegram
Python
67
star
37

pytest-random-order

pytest plugin to randomise the order of tests with some control over the randomness
Python
65
star
38

pytest-forked

extracted --boxed from pytest-xdist to ensure backward compat
Python
62
star
39

pytest-mimesis

Mimesis integration with the pytest test runner. This plugin provider useful fixtures based on providers from Mimesis.
Python
62
star
40

pytest-services

Collection of fixtures and utility functions to run service processes for your tests
Python
57
star
41

pytest-runner

Python
56
star
42

pytest-metadata

Plugin for accessing test session metadata
Python
56
star
43

apipkg

Python
55
star
44

iniconfig

Python
50
star
45

pytest-twisted

test twisted code with pytest
Python
46
star
46

pytest-freezer

Pytest plugin providing a fixture interface for spulec/freezegun
Python
45
star
47

pytest-incremental

py-test plugin: an incremental test runner
Python
42
star
48

pytest-stress

A Pytest plugin that allows you to loop tests for a user defined amount of time.
Python
41
star
49

nose2pytest

Scripts to convert Python Nose tests to PyTest
Python
38
star
50

pytest-base-url

pytest plugin for URL based tests
Python
38
star
51

pytest-faker

faker integration the pytest test runner
Python
38
star
52

pytest-fixture-tools

Pytest fixture tools
Python
36
star
53

pytest-cloud

Distributed tests planner plugin for pytest testing framework.
Python
35
star
54

plugincompat

Test execution and compatibility checks for pytest plugins
CSS
34
star
55

pytest-faulthandler

py.test plugin that activates the fault handler module during testing
Python
27
star
56

pytest-localserver

py.test plugin to test server connections locally. This repository was migrated from Bitbucket.
Python
23
star
57

pygments-pytest

A pygments lexer for pytest output
Python
23
star
58

pytest-echo

pytest plugin to dump environment variables, package version and generic attributes.
Python
22
star
59

pytest-inline

pytest-inline is a pytest plugin for writing inline tests.
Python
16
star
60

pytest-nunit

An Nunit output plugin for Pytest
Python
10
star
61

pytest-plus

pytest-plus adds new features to pytest
Python
10
star
62

design

Graphic design for Pytest project
9
star
63

pytest-iam

A fully functional OAUTH2 / OpenID Connect (OIDC) server to be used in your testsuite
Python
7
star
64

sprint

pytest development sprint 2024
7
star
65

pytest-bpdb

pytest plugin for dropping to bpdb on test failures
Python
6
star
66

blog.pytest.org

Repository for the official pytest blog
Python
4
star
67

pytest-tcpclient

pytest mocking of TCP clients
Python
3
star
68

regendoc

Python
2
star
69

meta

Used for generic pytest organization issues, stuff that can impact multiple projects.
2
star
70

pytest-libfaketime

Prepare pytest for python-libfaketime - https://github.com/simon-weber/python-libfaketime
Python
2
star
71

pytest-talks

public pytest talks and workshops - meant to help user groups spin up talks and workshops
HTML
1
star