handy_archives.testing

Pytest helpers.

Attention

This module has the following additional requirements:

coincidence>=0.2.0
pytest>=6.0.0

These can be installed as follows:

python -m pip install handy-archives[testing]

Classes:

ArchiveFileRegressionFixture(datadir, …)

Class for performing regression checks on files in tar and zip archives.

Functions:

archive_regression(datadir, …)

Pytest fixture for performing regression tests on files in tar and zip archives.

class ArchiveFileRegressionFixture(datadir, original_datadir, request)

Bases: AdvancedFileRegressionFixture

Class for performing regression checks on files in tar and zip archives.

Methods:

check_archive(archive, filename, **kwargs)	Checks a text file in archive against a previously recorded version, or generates a new file.
check_archive_binary(archive, filename, **kwargs)	Checks a binary file in archive against a previously recorded version, or generates a new file.

check_archive(archive, filename, **kwargs)

Checks a text file in archive against a previously recorded version, or generates a new file.

Parameters

• archive (Union[TarFile, ZipFile]) – The tar archive.

• filename (str) – The name of the file in the archive to check.

• **kwargs – Additional keyword arguments passed to pytest_regressions.file_regression.FileRegressionFixture.check().

check_archive_binary(archive, filename, **kwargs)

Checks a binary file in archive against a previously recorded version, or generates a new file.

Parameters

• archive (Union[TarFile, ZipFile])

• filename (str) – The name of the file in the archive to check.

• **kwargs – Additional keyword arguments passed to pytest_regressions.file_regression.FileRegressionFixture.check().

archive_regression(datadir, original_datadir, request)

Pytest fixture for performing regression tests on files in tar and zip archives.

Return type

AdvancedFileRegressionFixture