pytest-regtest 2.3.2__py3-none-any.whl

pytest_regtest-2.3.2.dist-info/METADATA

@@ -0,0 +1,91 @@
+Metadata-Version: 2.3
+Name: pytest-regtest
+Version: 2.3.2
+Summary: pytest plugin for snapshot regression testing
+Project-URL: Source, https://gitlab.com/uweschmitt/pytest-regtest
+Project-URL: Documentation, https://pytest-regtest.readthedocs.org
+Author-email: Uwe Schmitt <uwe.schmitt@id.ethz.ch>
+License: MIT License
+License-File: LICENSE.txt
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pytest>7.2
+Description-Content-Type: text/markdown
+
+![](https://gitlab.com/uweschmitt/pytest-regtest/badges/main/pipeline.svg)
+![](https://gitlab.com/uweschmitt/pytest-regtest/badges/main/coverage.svg?job=coverage)
+
+
+The full documentation for this package are available at
+https://pytest-regtest.readthedocs.org
+
+# About
+
+## Introduction
+
+`pytest-regtest` is a plugin for [pytest](https://pytest.org) to implement
+**regression testing**.
+
+Unlike [functional testing](https://en.wikipedia.org/wiki/Functional_testing),
+[regression testing](https://en.wikipedia.org/wiki/Regression_testing)
+does not test whether the software produces the correct
+results, but whether it behaves as it did before changes were introduced.
+
+More specifically, `pytest-regtest` provides **snapshot testing**, which
+implements regression testing by recording data within a test function
+and comparing this recorded output to a previously recorded reference
+output.
+
+
+## Installation
+
+To install and activate this plugin execute:
+
+    $ pip install pytest-regtest
+
+
+!!! note
+
+     `pytest-regtest` provides some functionality specific to `NumPy`,
+     `pandas`, and `polars`. These dependencies are not installed when
+     you install `pytest-regtest`. For example, if you are using NumPy
+     snapshots, we assume that your production code (the code under
+     test) uses NumPy and therefore should be part of your project's
+     setup.
+
+
+## Use case 1: Changing code with no or little testing setup yet
+If you're working with code that has little or no unit testing, you
+can use regression testing to ensure that your changes don't break or
+alter previous results.
+
+**Example**:
+This can be useful when working with data analysis scripts, which often
+start as one long script and then are restructured into different
+functions as they evolve.
+
+
+## Use case 2:  Testing complex data
+If a unit tests contains many `assert` statements to check a complex
+data structure you can use regression tests instead.
+
+**Example**: To test code which ingests data into a database one can
+use regression tests on textual database dumps.
+
+## Use case 3: Testing NumPy arrays or pandas data frames
+
+If your code generates numerical results, such as `NumPy` arrays,
+`pandas` or `polars` data frames, you can use `pytest-regtest` to simply record such
+results and test them later, taking into account relative and absolute
+tolerances.
+
+
+**Example**:
+A function creates a 10 x 10 matrix. Either you have to write 100
+assert statements or you use summary statistics to test your result.
+In both cases, you may get little debugging information if a test
+fails.

pytest_regtest-2.3.2.dist-info/RECORD

@@ -0,0 +1,5 @@
+pytest_regtest-2.3.2.dist-info/METADATA,sha256=g-6og_8Il3fBjTHYBRA1eGHHQ-FMIWU1Nd37oJgUBys,3275
+pytest_regtest-2.3.2.dist-info/WHEEL,sha256=fl6v0VwpzfGBVsGtkAkhILUlJxROXbA3HvRL6Fe3140,105
+pytest_regtest-2.3.2.dist-info/entry_points.txt,sha256=4VuIhXeMGhDo0ATbaUfyjND0atofmZjV_P-o6_uEk2s,36
+pytest_regtest-2.3.2.dist-info/licenses/LICENSE.txt,sha256=Tue36uAzpW79-9WAqzkwPhsDDVd1X-VWUmdZ0MfGYvk,1068
+pytest_regtest-2.3.2.dist-info/RECORD,,

pytest_regtest-2.3.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

pytest_regtest-2.3.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+regtest = pytest_regtest

pytest_regtest-2.3.2.dist-info/licenses/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Uwe Schmitt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.