API Reference

Config fixtures

pytest_image_diff.plugin.image_diff_threshold()[source]

Set default threshold differences of images. By default - 0.001

Return type:

float

pytest_image_diff.plugin.image_diff_root(request)[source]

Root path for storing diff images. By default - request.config.rootdir

Return type:

Union[str, Path]

pytest_image_diff.plugin.image_diff_dir(image_diff_root)[source]

Path for store diff images. by default - ‘{image_diff_root}.tests/image_diff/’

Return type:

Union[str, Path]

pytest_image_diff.plugin.image_diff_reference_dir(image_diff_root)[source]

Path for store reference images

Return type:

Union[str, Path]

pytest_image_diff.plugin.image_diff_throw_exception()[source]

Set default throw exception. By default - True

Return type:

bool

Fixtures

pytest_image_diff.plugin.image_regression(request, _image_diff_info, image_diff_threshold, image_diff_throw_exception)[source]

Check regression image.

Parameters:

  • image – PIL.Image or PathLike or io.BinaryIO

  • threshold – float, by default from image_diff_threshold

  • suffix – str, need for multiple checks by one test

Return type:

Generator[ImageRegressionCallableType, None, None]

Returns:

bool

pytest_image_diff.plugin.image_diff(request, _image_diff_info, image_diff_threshold, image_diff_throw_exception)[source]

Compare two image

Parameters:

  • image – PIL.Image or PathLike or io.BinaryIO

  • image2 – PIL.Image or PathLike or io.BinaryIO

  • threshold – float, by default from image_diff_threshold

  • suffix – str, need for multiple checks by one test

Return type:

Generator[ImageDiffCallableType, None, None]

Returns:

bool

pytest-splinter helper