fix: image_save image with type Path throw NotImplementError

#7

Author: Akay7

pytest_image_diff/_types.py

@@ -1,4 +1,4 @@
-from pathlib import Path
+import pathlib
 from typing import BinaryIO, Union, Tuple, Optional, TYPE_CHECKING
 from typing_extensions import Literal, Protocol
 
@@ -7,7 +7,8 @@
 if TYPE_CHECKING:
     from .plugin import DiffCompareResult
 
-PathOrFileType = Union[str, bytes, Path, BinaryIO]
+PathType = Union[str, pathlib.Path]
+PathOrFileType = Union[PathType, bytes, BinaryIO]
 ImageFileType = Union[Image, PathOrFileType]
 ImageSize = Tuple[int, int]
 

pytest_image_diff/helpers.py

@@ -9,7 +9,7 @@
 from _pytest import junitxml
 from _pytest.fixtures import FixtureRequest
 
-from pytest_image_diff._types import ImageFileType
+from pytest_image_diff._types import ImageFileType, PathType
 
 
 def build_filename(
@@ -78,10 +78,10 @@ def get_test_info(
     return TestInfo.get_test_info(request, suffix, prefix)
 
 
-def image_save(image: ImageFileType, path: typing.Union[str, pathlib.Path]) -> None:
+def image_save(image: ImageFileType, path: PathType) -> None:
     if isinstance(image, Image):
         image.save(path)
-    elif isinstance(image, str):
+    elif isinstance(image, (str, pathlib.Path)):
         if not os.path.exists(image):
             raise ValueError("Image maybe path. Path not exists!")
         shutil.copyfile(image, str(path))
@@ -91,6 +91,9 @@ def image_save(image: ImageFileType, path: typing.Union[str, pathlib.Path]) -> N
             shutil.copyfileobj(
                 image, f
             )  # type: ignore # Workaround for python/mypy#8962
+    elif isinstance(image, bytes):
+        with open(path, "wb") as f:
+            f.write(image)
     else:
         raise NotImplementedError()
 

pytest_image_diff/plugin.py

@@ -6,7 +6,12 @@
 from _pytest.python import Function
 from _pytest.runner import CallInfo
 
-from ._types import ImageFileType, ImageRegressionCallableType, ImageDiffCallableType
+from ._types import (
+    ImageFileType,
+    ImageRegressionCallableType,
+    ImageDiffCallableType,
+    PathType,
+)
 from .helpers import get_test_info, build_filename, image_save, ensure_dirs, temp_file
 from .image_diff import _diff
 
@@ -45,23 +50,23 @@ def image_diff_throw_exception() -> bool:
 
 
 @pytest.fixture(scope="session")
-def image_diff_root(request: FixtureRequest) -> str:
+def image_diff_root(request: FixtureRequest) -> PathType:
     """
     Root path for storing diff images. By default - `request.config.rootdir`
     """
     return str(request.config.rootdir)  # type: ignore
 
 
 @pytest.fixture(scope="session")  # pragma: no cover
-def image_diff_dir(image_diff_root: str) -> str:
+def image_diff_dir(image_diff_root: str) -> PathType:
     """
     Path for store diff images. by default - '{image_diff_root}.tests/image_diff/'
     """
     return os.path.join(image_diff_root, ".tests/image_diff/")
 
 
 @pytest.fixture(scope="session")
-def image_diff_reference_dir(image_diff_root: str) -> str:
+def image_diff_reference_dir(image_diff_root: str) -> PathType:
     """
     Path for store reference images
     """

tests/conftest.py

@@ -1,12 +1,23 @@
 import os
+import pathlib
 
 import pytest
 from _pytest.fixtures import FixtureRequest
 
+from pytest_image_diff._types import PathType
+
 
 @pytest.fixture(scope="session")
-def image_diff_root(request: FixtureRequest) -> str:
+def image_diff_root(request: FixtureRequest) -> PathType:
     """
     Root path for storing diff images. By default - `request.config.rootdir`
     """
     return os.path.join(request.config.rootdir, "tests")  # type: ignore
+
+
+@pytest.fixture(scope="session")
+def image_diff_dir(image_diff_root: str) -> PathType:
+    """
+    Path for store diff images. by default - '{image_diff_root}.tests/image_diff/'
+    """
+    return pathlib.Path(image_diff_root) / ".tests/image_diff/"

tests/test_diff.py

@@ -1,10 +1,16 @@
 # -*- coding: utf-8 -*-
+import pathlib
 import random
 import string
+import sys
+import tempfile
+from typing import Union
 
 import pytest
 from PIL import Image, ImageDraw
 
+from pytest_image_diff.helpers import image_save
+
 
 def make_test_image(text="Hello world", size=(100, 30)) -> Image:
     img = Image.new("RGB", size, color=(73, 109, 137))
@@ -15,6 +21,16 @@ def make_test_image(text="Hello world", size=(100, 30)) -> Image:
     return img
 
 
+@pytest.mark.skipif(sys.platform != "linux", reason="PermissionError in windows")
+def test_compare(image_diff):
+    image: Union[Image, str, bytes] = make_test_image()
+    tf = tempfile.NamedTemporaryFile(suffix=".jpeg")
+    # FIXME PermissionError: in windows
+    image_save(image, tf.name)
+    image2: Union[Image, str, bytes] = pathlib.Path(tf.name)
+    image_diff(image, image2)
+
+
 def test_initial_diff(image_diff, image_diff_dir):
     image = make_test_image()
     suffix = "".join(random.choices(string.ascii_letters, k=10))