How esss/pytest-regressions works
Project type and purpose
• This is an open-source Python plugin for pytest called “pytest-regressions.”
• Purpose: provides fixtures to perform regression tests on various data types (plain files, images, numeric tables, NumPy arrays, etc.) by saving “expected” outputs in a data directory and comparing them on future runs.
File structure
• Top-level directories and files:
• src/pytest_regressions/… — core plugin code
• tests/… — test suite with examples of each fixture in action
• doc/… — Sphinx documentation (api, installation, overview)
• .github/workflows/ — CI definitions (build, test, deploy)
• setup.py, tox.ini, mypy.ini, pre-commit config — packaging, linting, typing, local CI
• Within src/pytest_regressions/:
• plugin.py — entry point registering hooks & fixtures
• common.py — shared utilities (I/O, comparison logic)
• data_regression.py, dataframe_regression.py, file_regression.py, image_regression.py, ndarrays_regression.py, num_regression.py — one module per fixture type
• Configuration & metadata:
• setup.py — package metadata & install_requires
• mypy.ini — type-checking rules
• tox.ini — multi-env test orchestration
README for additional insights
• Confirms it’s a pytest plugin offering fixtures to simplify regression testing.
• Mentions dependency on pytest-datadir (for managing the expected data directory).
• Encourages contributions, documents testing via tox.
• Generated via cookiecutter-pytest-plugin template.