Release Notes

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

2.0.1 – 2024-03-15

Added

• Quick check for the ChangeLog.rst.

Fixed

• Release GitHub workflow has been fixed to use modern versions of involved actions.

• Do not override the path suffix-like part (separated by a dot) with a pattern filename extension.

2.0.0 – 2024-03-11

Added

• Introduce pm-pattern-file-fmt configuration parameter to give full control over the path to pattern files.

• A test can be marked with @pytest.mark.expect_suffix to have an arbitrary suffix in the pattern filenames. The pm-pattern-file-fmt format string should have the {suffix} placeholder to make it work. See issue #22.

• Documentation.

• Introduce pm-mismatch-style.

• Show newlines in the full mismatch mode.

Fixed

• BREAKING CHANGE The expectation files path has never used the <test-module-name> component despite the README.rst claimed. Existed projects could set pm-pattern-file-fmt to {class}/{fn}{callspec} to preserve backward compatibility.

Removed

• BREAKING CHANGE The pm-pattern-file-use-system-name configuration parameter has been removed. Having {suffix} in the pm-pattern-file-fmt one can have a system name suffix whenever he needs it.

1.6.0 – 2024-02-29

Added

• --pm-reveal-unused-files option to reveal unused pattern files.

• run test with pytest 7.x and 8.x.

1.5.1 – 2024-01-15

Fixed

• Regression with Python less than 3.11.

1.5.0 – 2024-01-11

Added

• Make it possible to use expected_xxx with parameterized tests. See issue #4.

1.4.0 – 2021-12-10

Added

• Allow assert expected_out.match(blah_blah) is True.

Changed

• Migrate to setup.py-less build (using PEP 517 and PEP 660).

1.3.3 – 2019-06-27

Fixed

• Fix backward compatibility with Python less than 3.6.

1.3.2 – 2019-06-26

Fixed

• When a caller uses re.MULTILINE, the plugin does not use splitlines.

1.3.1 – 2019-04-04

Added

• Show actual and expected output on failed expected_out.match().

Changed

• Update code for the modern pytest (4.4.0) and PyYAML (5.1).

1.2.1 – 2018-03-30

Fixed

• Update meta-data of the project for PyPi.

1.2.0 – 2018-03-30

Added

• Add an INI-file option pm-pattern-file-use-system-name to control if the system name suffix is expected to be in a pattern filename. For example, this allows patterns with different CR/LF conventions to be created.

• Add expected_yaml fixture to match YAML files.

• Introduce unit tests.

1.1.0 – 2018-03-28

Added

• Use pytest.skip() if no pattern file has been found or it contains an invalid regular expression;

• Added doc-strings to the fixtures, so pytest --fixtures would not complain.

Changed

• Ensure full pattern match for expected_xxx.match named fixtures.

1.0.0 – 2017-08-25

Added

• Add a pretty printer for failed assertions with the expected_out fixture and equal comparison operator.