python-escpos/test/test_functions/test_function_image.py

#!/usr/bin/env python
""" Image function tests- Check that image print commands are sent correctly.

:author: `Michael Billington <michael.billington@gmail.com>`_
:organization: `python-escpos <https://github.com/python-escpos>`_
:copyright: Copyright (c) 2016 `Michael Billington <michael.billington@gmail.com>`_
:license: MIT
"""


import pytest
from PIL import Image

import escpos.printer as printer
from escpos.exceptions import ImageWidthError


# Raster format print
def test_bit_image_black() -> None:
    """
    Test printing solid black bit image (raster)
    """
    instance = printer.Dummy()
    instance.image("test/resources/canvas_black.png", impl="bitImageRaster")
    assert instance.output == b"\x1dv0\x00\x01\x00\x01\x00\x80"
    # Same thing w/ object created on the fly, rather than a filename
    instance = printer.Dummy()
    im = Image.new("RGB", (1, 1), (0, 0, 0))
    instance.image(im, impl="bitImageRaster")
    assert instance.output == b"\x1dv0\x00\x01\x00\x01\x00\x80"


def test_bit_image_white() -> None:
    """
    Test printing solid white bit image (raster)
    """
    instance = printer.Dummy()
    instance.image("test/resources/canvas_white.png", impl="bitImageRaster")
    assert instance.output == b"\x1dv0\x00\x01\x00\x01\x00\x00"


def test_bit_image_both() -> None:
    """
    Test printing black/white bit image (raster)
    """
    instance = printer.Dummy()
    instance.image("test/resources/black_white.png", impl="bitImageRaster")
    assert instance.output == b"\x1dv0\x00\x01\x00\x02\x00\xc0\x00"


def test_bit_image_transparent() -> None:
    """
    Test printing black/transparent bit image (raster)
    """
    instance = printer.Dummy()
    instance.image("test/resources/black_transparent.png", impl="bitImageRaster")
    assert instance.output == b"\x1dv0\x00\x01\x00\x02\x00\xc0\x00"


# Column format print
def test_bit_image_colfmt_black() -> None:
    """
    Test printing solid black bit image (column format)
    """
    instance = printer.Dummy()
    instance.image("test/resources/canvas_black.png", impl="bitImageColumn")
    assert instance.output == b"\x1b3\x10\x1b*!\x01\x00\x80\x00\x00\x0a\x1b2"


def test_bit_image_colfmt_white() -> None:
    """
    Test printing solid white bit image (column format)
    """
    instance = printer.Dummy()
    instance.image("test/resources/canvas_white.png", impl="bitImageColumn")
    assert instance.output == b"\x1b3\x10\x1b*!\x01\x00\x00\x00\x00\x0a\x1b2"


def test_bit_image_colfmt_both() -> None:
    """
    Test printing black/white bit image (column format)
    """
    instance = printer.Dummy()
    instance.image("test/resources/black_white.png", impl="bitImageColumn")
    assert (
        instance.output == b"\x1b3\x10\x1b*!\x02\x00\x80\x00\x00\x80\x00\x00\x0a\x1b2"
    )


def test_bit_image_colfmt_transparent() -> None:
    """
    Test printing black/transparent bit image (column format)
    """
    instance = printer.Dummy()
    instance.image("test/resources/black_transparent.png", impl="bitImageColumn")
    assert (
        instance.output == b"\x1b3\x10\x1b*!\x02\x00\x80\x00\x00\x80\x00\x00\x0a\x1b2"
    )


# Graphics print
def test_graphics_black() -> None:
    """
    Test printing solid black graphics
    """
    instance = printer.Dummy()
    instance.image("test/resources/canvas_black.png", impl="graphics")
    assert (
        instance.output
        == b"\x1d(L\x0b\x000p0\x01\x011\x01\x00\x01\x00\x80\x1d(L\x02\x0002"
    )


def test_graphics_white() -> None:
    """
    Test printing solid white graphics
    """
    instance = printer.Dummy()
    instance.image("test/resources/canvas_white.png", impl="graphics")
    assert (
        instance.output
        == b"\x1d(L\x0b\x000p0\x01\x011\x01\x00\x01\x00\x00\x1d(L\x02\x0002"
    )


def test_graphics_both() -> None:
    """
    Test printing black/white graphics
    """
    instance = printer.Dummy()
    instance.image("test/resources/black_white.png", impl="graphics")
    assert (
        instance.output
        == b"\x1d(L\x0c\x000p0\x01\x011\x02\x00\x02\x00\xc0\x00\x1d(L\x02\x0002"
    )


def test_graphics_transparent() -> None:
    """
    Test printing black/transparent graphics
    """
    instance = printer.Dummy()
    instance.image("test/resources/black_transparent.png", impl="graphics")
    assert (
        instance.output
        == b"\x1d(L\x0c\x000p0\x01\x011\x02\x00\x02\x00\xc0\x00\x1d(L\x02\x0002"
    )


def test_large_graphics() -> None:
    """
    Test whether 'large' graphics that induce a fragmentation are handled correctly.
    """
    instance = printer.Dummy()
    instance.image(
        "test/resources/black_white.png", impl="bitImageRaster", fragment_height=1
    )
    assert (
        instance.output
        == b"\x1dv0\x00\x01\x00\x01\x00\xc0\x1dv0\x00\x01\x00\x01\x00\x00"
    )


@pytest.fixture
def dummy_with_width() -> printer.Dummy:
    instance = printer.Dummy()
    instance.profile.profile_data = {"media": {"width": {"pixels": 384}}}
    return instance


def test_width_too_large(dummy_with_width: printer.Dummy) -> None:
    """
    Test printing an image that is too large in width.
    """
    instance = dummy_with_width

    with pytest.raises(ImageWidthError):
        instance.image(Image.new("RGB", (385, 200)))

    instance.image(Image.new("RGB", (384, 200)))


def test_center_image(dummy_with_width: printer.Dummy) -> None:
    instance = dummy_with_width

    with pytest.raises(ImageWidthError):
        instance.image(Image.new("RGB", (385, 200)), center=True)

    instance.image(Image.new("RGB", (384, 200)), center=True)