refactor: standardize image tests (#376)

Closes #369. ### Summary of Changes Changed functionality of Image transformation methods to use a deepCopy instead of a bytestream to create a copy of the image. Changed tests to only test one file format. --------- Co-authored-by: PhilipGutberlet <[email protected]> Co-authored-by: patrikguempel <[email protected]> Co-authored-by: Alexander <[email protected]> Co-authored-by: megalinter-bot <[email protected]>
Safe-DS · Jun 23, 2023 · 8fe40fa · 8fe40fa
1 parent 9073f04
commit 8fe40fa
Show file tree

Hide file tree

Showing 8 changed files with 88 additions and 151 deletions.
diff --git a/src/safeds/data/image/containers/_image.py b/src/safeds/data/image/containers/_image.py
@@ -12,7 +12,6 @@
 from PIL.Image import open as open_image
 
 from safeds.data.image.typing import ImageFormat
-from safeds.exceptions import WrongFileExtensionError
 
 
 class Image:
@@ -205,24 +204,16 @@ def _repr_png_(self) -> bytes | None:
 
     def resize(self, new_width: int, new_height: int) -> Image:
         """
-        Return an image that has been resized to a given size.
+        Return a new image that has been resized to a given size.
 
         Returns
         -------
         result : Image
             The image with the given width and height
         """
-        data = io.BytesIO()
-        repr_png = self._repr_png_()
-        repr_jpeg = self._repr_jpeg_()
-        if repr_png is not None:
-            data = io.BytesIO(repr_png)
-        elif repr_jpeg is not None:
-            data = io.BytesIO(repr_jpeg)
-
-        new_image = Image(data, self._format)
-        new_image._image = new_image._image.resize((new_width, new_height))
-        return new_image
+        image_copy = copy.deepcopy(self)
+        image_copy._image = image_copy._image.resize((new_width, new_height))
+        return image_copy
 
     def convert_to_grayscale(self) -> Image:
         """
@@ -233,10 +224,9 @@ def convert_to_grayscale(self) -> Image:
         grayscale_image : Image
             The grayscale image.
         """
-        data = io.BytesIO()
-        grayscale_image = self._image.convert("L")
-        grayscale_image.save(data, format=self._format.value)
-        return Image(data, self._format)
+        image_copy = copy.deepcopy(self)
+        image_copy._image = image_copy._image.convert("L")
+        return image_copy
 
     def crop(self, x: int, y: int, width: int, height: int) -> Image:
         """
@@ -254,17 +244,9 @@ def crop(self, x: int, y: int, width: int, height: int) -> Image:
         result : Image
             The image with the
         """
-        data = io.BytesIO()
-        repr_png = self._repr_png_()
-        repr_jpeg = self._repr_jpeg_()
-        if repr_png is not None:
-            data = io.BytesIO(repr_png)
-        elif repr_jpeg is not None:
-            data = io.BytesIO(repr_jpeg)
-
-        new_image = Image(data, self._format)
-        new_image._image = new_image._image.crop((x, y, (x + width), (y + height)))
-        return new_image
+        image_copy = copy.deepcopy(self)
+        image_copy._image = image_copy._image.crop((x, y, (x + width), (y + height)))
+        return image_copy
 
     def flip_vertically(self) -> Image:
         """
@@ -367,17 +349,9 @@ def blur(self, radius: int) -> Image:
         result : Image
             The blurred image
         """
-        data = io.BytesIO()
-        repr_png = self._repr_png_()
-        repr_jpeg = self._repr_jpeg_()
-        if repr_png is not None:
-            data = io.BytesIO(repr_png)
-        elif repr_jpeg is not None:
-            data = io.BytesIO(repr_jpeg)
-
-        new_image = Image(data, self._format)
-        new_image._image = new_image._image.filter(ImageFilter.BoxBlur(radius))
-        return new_image
+        image_copy = copy.deepcopy(self)
+        image_copy._image = image_copy._image.filter(ImageFilter.BoxBlur(radius))
+        return image_copy
 
     def sharpen(self, factor: float) -> Image:
         """
@@ -406,51 +380,32 @@ def invert_colors(self) -> Image:
         result : Image
             The image with inverted colors.
         """
-        data = io.BytesIO()
-        repr_png = self._repr_png_()
-        repr_jpeg = self._repr_jpeg_()
-        if repr_png is not None:
-            data = io.BytesIO(repr_png)
-        elif repr_jpeg is not None:
-            data = io.BytesIO(repr_jpeg)
-
-        new_image = Image(data, self._format)
-        new_image._image = ImageOps.invert(new_image._image)
-        return new_image
+        image_copy = copy.deepcopy(self)
+        image_copy._image = ImageOps.invert(image_copy._image)
+        return image_copy
 
     def rotate_right(self) -> Image:
         """
-        Return the png-image clockwise rotated by 90 degrees.
+        Return the image rotated 90 degrees clockwise.
 
         Returns
         -------
         result : Image
-            The image clockwise rotated by 90 degrees.
+            The image rotated 90 degrees clockwise.
         """
-        if self.format != ImageFormat.PNG:
-            raise WrongFileExtensionError("/image", ".png")
-
-        imagecopy = copy.deepcopy(self)
-        imagecopy._image = imagecopy._image.rotate(270, expand=True)
-        return imagecopy
+        image_copy = copy.deepcopy(self)
+        image_copy._image = image_copy._image.rotate(270, expand=True)
+        return image_copy
 
     def rotate_left(self) -> Image:
         """
-        Return the png-image counter-clockwise rotated by 90 degrees.
+        Return the image rotated 90 degrees counter-clockwise.
 
         Returns
         -------
         result : Image
-            The image counter-clockwise rotated by 90 degrees.
-
-        Raises
-        ------
-        WrongFileExtensionError
-            If given a File that's not PNG.
+            The image rotated 90 degrees counter-clockwise.
         """
-        if self.format != ImageFormat.PNG:
-            raise WrongFileExtensionError("/image", ".png")
-
-        imagecopy = copy.deepcopy(self)
-        imagecopy._image = imagecopy._image.rotate(90, expand=True)
-        return imagecopy
+        image_copy = copy.deepcopy(self)
+        image_copy._image = image_copy._image.rotate(90, expand=True)
+        return image_copy
diff --git a/tests/resources/image/blurredboy.png → tests/resources/image/blurredBoy.png b/tests/resources/image/blurredboy.png → tests/resources/image/blurredBoy.png
diff --git a/tests/resources/image/blurredboy.jpg b/tests/resources/image/blurredboy.jpg
diff --git a/tests/resources/image/boy.jpg b/tests/resources/image/boy.jpg
diff --git a/tests/resources/image/original.jpg b/tests/resources/image/original.jpg
diff --git a/tests/resources/image/white.jpg b/tests/resources/image/white.jpg
diff --git a/tests/resources/image/whiteCropped.jpg b/tests/resources/image/whiteCropped.jpg
diff --git a/tests/safeds/data/image/containers/test_image.py b/tests/safeds/data/image/containers/test_image.py
@@ -5,7 +5,6 @@
 from safeds.data.image.containers import Image
 from safeds.data.image.typing import ImageFormat
 from safeds.data.tabular.containers import Table
-from safeds.exceptions._data import WrongFileExtensionError
 
 from tests.helpers import resolve_resource_path
 
@@ -182,20 +181,14 @@ class TestResize:
     @pytest.mark.parametrize(
         ("image", "new_width", "new_height", "new_size"),
         [
-            (
-                Image.from_jpeg_file(resolve_resource_path("image/white_square.jpg")),
-                2,
-                3,
-                (2, 3),
-            ),
             (
                 Image.from_png_file(resolve_resource_path("image/white_square.png")),
                 2,
                 3,
                 (2, 3),
             ),
         ],
-        ids=[".jpg", ".png"],
+        ids=["(2, 3)"],
     )
     def test_should_return_resized_image(
         self,
@@ -220,7 +213,7 @@ class TestConvertToGrayscale:
     )
     def test_convert_to_grayscale(self, image: Image, expected: Image) -> None:
         grayscale_image = image.convert_to_grayscale()
-        assert grayscale_image._image.tobytes() == expected._image.tobytes()
+        assert grayscale_image == expected
 
 
 class TestEQ:
@@ -319,54 +312,51 @@ def test_should_raise(self) -> None:
 
 
 class TestInvertColors:
-    def test_should_invert_colors_png(self) -> None:
-        image = Image.from_png_file(resolve_resource_path("image/original.png"))
+    @pytest.mark.parametrize(
+        ("image", "expected"),
+        [
+            (
+                Image.from_png_file(resolve_resource_path("image/original.png")),
+                Image.from_png_file(resolve_resource_path("image/inverted_colors_original.png")),
+            ),
+        ],
+        ids=["invert-colors"],
+    )
+    def test_should_invert_colors(self, image: Image, expected: Image) -> None:
         image = image.invert_colors()
-        image2 = Image.from_png_file(resolve_resource_path("image/inverted_colors_original.png"))
-        assert image == image2
-
-    def test_should_invert_colors_jpeg(self) -> None:
-        image = Image.from_jpeg_file(resolve_resource_path("image/original.jpg"))
-        image = image.invert_colors()
-        image.to_jpeg_file(resolve_resource_path("image/inverted_colors_original1.jpg"))
-        image = Image.from_jpeg_file(resolve_resource_path("image/inverted_colors_original1.jpg"))
-        image2 = Image.from_jpeg_file(resolve_resource_path("image/inverted_colors_original.jpg"))
-        assert image == image2
-        Path.unlink(Path(resolve_resource_path("image/inverted_colors_original1.jpg")))
+        assert image == expected
 
 
 class TestBlur:
-    def test_should_return_blurred_png_image(self) -> None:
-        image = Image.from_png_file(resolve_resource_path("image/boy.png"))
-        image = image.blur(2)
-        image.to_png_file(resolve_resource_path("image/blurredboy1.png"))
-        image = Image.from_png_file(resolve_resource_path("image/blurredboy1.png"))
-        image2 = Image.from_png_file(resolve_resource_path("image/blurredboy.png"))
-        assert image._image == image2._image
-
-    def test_should_return_blurred_jpg_image(self) -> None:
-        image = Image.from_jpeg_file(resolve_resource_path("image/boy.jpg"))
+    @pytest.mark.parametrize(
+        ("image", "expected"),
+        [
+            (
+                Image.from_png_file(resolve_resource_path("image/boy.png")),
+                Image.from_png_file(resolve_resource_path("image/blurredBoy.png")),
+            ),
+        ],
+        ids=["blur"],
+    )
+    def test_should_return_blurred_image(self, image: Image, expected: Image) -> None:
         image = image.blur(2)
-        image.to_jpeg_file(resolve_resource_path("image/blurredboy1.jpg"))
-        image = Image.from_jpeg_file(resolve_resource_path("image/blurredboy1.jpg"))
-        image2 = Image.from_jpeg_file(resolve_resource_path("image/blurredboy.jpg"))
-        assert image._image == image2._image
-        Path.unlink(Path(resolve_resource_path("image/blurredboy1.jpg")))
-        Path.unlink(Path(resolve_resource_path("image/blurredboy1.png")))
+        assert image == expected
 
 
 class TestCrop:
-    def test_should_crop_jpg_image(self) -> None:
-        image = Image.from_jpeg_file(resolve_resource_path("image/white.jpg"))
-        image = image.crop(0, 0, 100, 100)
-        image2 = Image.from_jpeg_file(resolve_resource_path("image/whiteCropped.jpg"))
-        assert image == image2
-
-    def test_should_crop_png_image(self) -> None:
-        image = Image.from_png_file(resolve_resource_path("image/white.png"))
+    @pytest.mark.parametrize(
+        ("image", "expected"),
+        [
+            (
+                Image.from_png_file(resolve_resource_path("image/white.png")),
+                Image.from_png_file(resolve_resource_path("image/whiteCropped.png")),
+            ),
+        ],
+        ids=["crop"],
+    )
+    def test_should_return_cropped_image(self, image: Image, expected: Image) -> None:
         image = image.crop(0, 0, 100, 100)
-        image2 = Image.from_png_file(resolve_resource_path("image/whiteCropped.png"))
-        assert image == image2
+        assert image == expected
 
 
 class TestSharpen:
@@ -387,38 +377,30 @@ def test_should_not_sharpen(self) -> None:
 
 
 class TestRotate:
-    def test_should_return_clockwise_rotated_image(
-        self,
-    ) -> None:
-        image = Image.from_png_file(resolve_resource_path("image/snapshot_boxplot.png"))
+    @pytest.mark.parametrize(
+        ("image", "expected"),
+        [
+            (
+                Image.from_png_file(resolve_resource_path("image/snapshot_boxplot.png")),
+                Image.from_png_file(resolve_resource_path("image/snapshot_boxplot_right_rotation.png")),
+            ),
+        ],
+        ids=["rotate-clockwise"],
+    )
+    def test_should_return_clockwise_rotated_image(self, image: Image, expected: Image) -> None:
         image = image.rotate_right()
-        image2 = Image.from_png_file(resolve_resource_path("image/snapshot_boxplot_right_rotation.png"))
-        assert image == image2
+        assert image == expected
 
-    def test_should_return_counter_clockwise_rotated_image(
-        self,
-    ) -> None:
-        image = Image.from_png_file(resolve_resource_path("image/snapshot_boxplot.png"))
-        image = image.rotate_left()
-        image2 = Image.from_png_file(resolve_resource_path("image/snapshot_boxplot_left_rotation.png"))
-        assert image == image2
-
-    def test_should_raise_if_not_png_right(self) -> None:
-        with pytest.raises(
-            WrongFileExtensionError,
-            match=(
-                "The file /image has a wrong file extension. Please provide a file with the following extension\\(s\\):"
-                " .png"
-            ),
-        ):
-            Image.from_jpeg_file(resolve_resource_path("image/white_square.jpg")).rotate_right()
-
-    def test_should_raise_if_not_png_left(self) -> None:
-        with pytest.raises(
-            WrongFileExtensionError,
-            match=(
-                "The file /image has a wrong file extension. Please provide a file with the following extension\\(s\\):"
-                " .png"
+    @pytest.mark.parametrize(
+        ("image", "expected"),
+        [
+            (
+                Image.from_png_file(resolve_resource_path("image/snapshot_boxplot.png")),
+                Image.from_png_file(resolve_resource_path("image/snapshot_boxplot_left_rotation.png")),
             ),
-        ):
-            Image.from_jpeg_file(resolve_resource_path("image/white_square.jpg")).rotate_left()
+        ],
+        ids=["rotate-counter-clockwise"],
+    )
+    def test_should_return_counter_clockwise_rotated_image(self, image: Image, expected: Image) -> None:
+        image = image.rotate_left()
+        assert image == expected