Skip to main content

No project description provided

Project description

PyPi ci Documentation Status Codecov PyPi Python versions License

pytest-image-diff

Installation

pip install pytest-image-diff

or from git

pip install -e git+https://githib.com/Apkawa/pytest-image-diff.git@master#egg=pytest-image-diff

Python>=3.6

Usage

from typing import Union
from PIL import Image


def test_compare(image_diff):
    image: Image or str or bytes = Image.new()
    image2: Image or str or bytes = '/path/to/image.jpeg'
    image_diff(image, image2)


def test_regression(image_regression):
    image: Union[Image, str, bytes] = Image.new()
    image_regression(image, threshold=0.5)

Also use with assert

import pytest

from typing import Union
from PIL import Image

@pytest.fixture(scope="session")
def image_diff_throw_exception() -> bool:
    """
    Set default throw exception. By default - True
    """
    return False

def test_compare(image_diff):
    image: Image or str or bytes = Image.new()
    image2: Image or str or bytes = '/path/to/image.jpeg'
    assert image_diff(image, image2)
    assert image_diff(image, image2, threshold=0.5)
    # Also can check threshold in compare, ie
    assert image_diff(image, image2) < 0.5
    # For different checks in one test
    assert image_diff(image, image2, threshold=0.5, suffix="one")
    # Or without fixture image_diff_throw_exception
    assert image_diff(image, image2, threshold=0.5, throw_exception=False)


def test_regression(image_regression):
    image: Union[Image, str, bytes] = Image.new()
    assert image_regression(image, threshold=0.5)
    # Also can check threshold in compare, ie
    assert image_regression(image) < 0.5
    # For different checks in one test
    assert image_regression(image, threshold=0.5, suffix="foo")
    # Or without fixture image_diff_throw_exception
    assert image_regression(image, threshold=0.5, throw_exception=False)

First run creates reference images

pytest-splinter

Fixture screenshot_regression enabled if pytest-splinter installed

import pytest

@pytest.fixture
def admin_browser(request, browser_instance_getter):
    """Admin browser fixture."""
    # browser_instance_getter function receives parent fixture -- our admin_browser
    return browser_instance_getter(request, admin_browser)

def test_2_browsers(browser, admin_browser, screenshot_regression):
    """Test using 2 browsers at the same time."""
    browser.visit('http://google.com')
    admin_browser.visit('http://admin.example.com')

    screenshot_regression(suffix="browser")
    screenshot_regression(admin_browser, suffix="admin browser")

def test_pytest_splinter(browser, screenshot_regression):
    # Recommend fix window size for avoid regression
    browser.driver.set_window_size(1280, 1024)

    browser.visit('http://google.com')

    screenshot_regression(suffix="main")
    # ... some interaction
    browser.click()
    screenshot_regression(suffix="success")
    # you can use xpath expression for part of page
    screenshot_regression(xpath="//h1")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_image_diff-0.0.14.tar.gz (11.6 kB view details)

Uploaded Source

Built Distribution

pytest_image_diff-0.0.14-py2.py3-none-any.whl (10.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file pytest_image_diff-0.0.14.tar.gz.

File metadata

  • Download URL: pytest_image_diff-0.0.14.tar.gz
  • Upload date:
  • Size: 11.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for pytest_image_diff-0.0.14.tar.gz
Algorithm Hash digest
SHA256 2405dba60c8009c93a7cafc15976cc8f2b1b8f33ffe8126e35d72a6d22e19850
MD5 9675c3c48bb87d5024b5a93453297f1e
BLAKE2b-256 be7564a17eb4b43d01437387e463a2c3083fe27d169174d9fade0cc52f18bfe1

See more details on using hashes here.

File details

Details for the file pytest_image_diff-0.0.14-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for pytest_image_diff-0.0.14-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 106642ab02c7be579aed7085f5ca670108ad43cfaff0980690383185a2fb5ad4
MD5 ec0dda737cdeed33995ab011e834cb3b
BLAKE2b-256 407dbe27575980da987cc7af4d7e9f27f2bc141a8e002a7e6809e16e71c13a1a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page