Python 3.12 and 3.13 are now officially supported.
Python 3.8 (EOL) is no longer supported.
#184: Added fullpath parameter to image_regression.check.
2.6.0
2024-12-17
#132: Added documentation for specifying custom data directories.
#177: Added new round_digits to data_regression.check, which when given will round all float values to the given number of dicts (recursively) before saving the data to disk.
2.5.0 (2023-08-31)
Dropped support for EOL Python 3.6 and Python 3.7.
Added support for Python 3.11.
2.4.3 (2023-08-30)
#137: (Bugfix) Make dataframe_regression compatible with classes inheriting from pandas.DataFrame.
New --regen-all flag, which regenerates all files without failing the tests. Useful to regenerate all files in
the test suite with a single run.
The public API is now fully type annotated.
pytest>=6.2 is now required.
2.3.1 (2022-01-18)
#84: (Bugfix) Properly handle empty and NaN values on num_regression and dataframe_regression.
2.3.0 (2022-01-04)
#54: New --with-test-class-names command-line flag to consider test class names when composing the expected and obtained data filenames. Needed when the same module contains different classes with the same method names.
#72: New ndarrays_regression, for comparing NumPy arrays with arbitrary shape.
#74: Fix empty string bug on dataframe regression.
2.2.0 (2020-01-27)
#45: num_regression.check now accepts any object that can be coerced to a 1d numpy array with numeric dtype (e.g. list, tuple, etc).
2.1.1 (2020-12-7)
#35: New dataframe_regression fixture to check pandas DataFrames directly.
Note: 2.1.0 was not deployed due to a CI error.
2.0.2 (2020-10-07)
#34: Fix data_regression bug that creates empty file on serializing error.
2.0.1 (2020-05-18)
#28: Fix num_regression bug when comparing numpy shapes.
2.0.0 (2019-09-10)
Drop support for Python 2.7 and 3.5.
1.0.6 (2019-09-10)
#18: When using fill_different_shape_with_nan=True, a proper TypeError will be raised for non-float arrays instead of filling integer arrays with "garbage".
#22: Fix warning when comparing arrays of boolean values.
1.0.5 (2018-11-20)
#15: Remove some extra line separators from the diff output, which makes the representation more compact.