pre-commit

Author: FredHappyface

pyproject.toml

@@ -58,7 +58,7 @@ ignore = [
 fixable = ["ALL"]
 
 [tool.ruff.lint.per-file-ignores]
-"**/{tests,docs,tools}/*" = ["D", "S101", "E402", "S311"]
+"**/{tests,docs,tools}/*" = ["D", "S101", "E402", "S311", "ERA001"]
 
 [tool.ruff.lint.flake8-tidy-imports]
 ban-relative-imports = "all" # Disallow all relative imports.

tests/data/src/genimgs.py

@@ -1,69 +1,83 @@
-from PIL import Image, ImageDraw, ImageFilter
+from __future__ import annotations
+
 import numpy as np
+from PIL import Image, ImageDraw, ImageFilter
+
 
 # Create a solid color image
-def create_solid_color_image(size=(400, 400), color=(255, 0, 0, 255)):
-    img = Image.new("RGBA", size, color)
-    img.save("solid_color.png")
-    return img
+def create_solid_color_image(
+	size: tuple[int, int] = (400, 400), color: tuple[int, ...] = (255, 0, 0, 255)
+) -> Image.Image:
+	img = Image.new("RGBA", size, color)
+	img.save("solid_color.png")
+	return img
+
 
 # Create a gradient image
-def create_gradient_image(size=(400, 400), start_color=(0, 0, 255), end_color=(255, 0, 0)):
-    img = Image.new("RGB", size)
-    for x in range(size[0]):
-        blend_factor = x / size[0]
-        color = (
-            int(start_color[0] * (1 - blend_factor) + end_color[0] * blend_factor),
-            int(start_color[1] * (1 - blend_factor) + end_color[1] * blend_factor),
-            int(start_color[2] * (1 - blend_factor) + end_color[2] * blend_factor),
-        )
-        ImageDraw.Draw(img).line([(x, 0), (x, size[1])], fill=color)
-    img.save("gradient.png")
-    return img
+def create_gradient_image(
+	size: tuple[int, int] = (400, 400),
+	start_color: tuple[int, ...] = (0, 0, 255),
+	end_color: tuple[int, ...] = (255, 0, 0),
+) -> Image.Image:
+	img = Image.new("RGB", size)
+	for x in range(size[0]):
+		blend_factor = x / size[0]
+		color = (
+			int(start_color[0] * (1 - blend_factor) + end_color[0] * blend_factor),
+			int(start_color[1] * (1 - blend_factor) + end_color[1] * blend_factor),
+			int(start_color[2] * (1 - blend_factor) + end_color[2] * blend_factor),
+		)
+		ImageDraw.Draw(img).line([(x, 0), (x, size[1])], fill=color)
+	img.save("gradient.png")
+	return img
+
 
 # Create a soft-edged circular mask
-def create_soft_mask(size=(400, 400)):
-    img = Image.new("L", size, 0)
-    draw = ImageDraw.Draw(img)
-    draw.ellipse((50, 50, size[0] - 50, size[1] - 50), fill=255)
-    img = img.filter(ImageFilter.GaussianBlur(20))
-    img.save("soft_mask.png")
-    return img
+def create_soft_mask(size: tuple[int, int] = (400, 400)) -> Image.Image:
+	img = Image.new("L", size, 0)
+	draw = ImageDraw.Draw(img)
+	draw.ellipse((50, 50, size[0] - 50, size[1] - 50), fill=255)
+	img = img.filter(ImageFilter.GaussianBlur(20))
+	img.save("soft_mask.png")
+	return img
+
 
 # Create a noisy texture
-def create_noise_texture(size=(400, 400)):
-    noise_array = np.random.randint(0, 255, (size[1], size[0]), dtype=np.uint8)
-    img = Image.fromarray(noise_array, mode="L")
-    img.save("noise_texture.png")
-    return img
+def create_noise_texture(size: tuple[int, int] = (400, 400)) -> Image.Image:
+	noise_array = np.random.randint(0, 255, (size[1], size[0]), dtype=np.uint8)
+	img = Image.fromarray(noise_array, mode="L")
+	img.save("noise_texture.png")
+	return img
+
 
 # Create a silhouette image (e.g., black cat)
-def create_silhouette(shape="circle"):
-    img = Image.new("RGBA", size=(400, 400), color=(255, 255, 255, 0))
-    draw = ImageDraw.Draw(img)
-    if shape == "circle":
-        draw.ellipse((100, 100, 300, 300), fill=(0, 0, 0, 255))
-    elif shape == "rectangle":
-        draw.rectangle((100, 150, 300, 350), fill=(0, 0, 0, 255))
-    img.save(f"{shape}_silhouette.png")
-    return img
+def create_silhouette(shape:str="circle") -> Image.Image:
+	img = Image.new("RGBA", size=(400, 400), color=(255, 255, 255, 0))
+	draw = ImageDraw.Draw(img)
+	if shape == "circle":
+		draw.ellipse((100, 100, 300, 300), fill=(0, 0, 0, 255))
+	elif shape == "rectangle":
+		draw.rectangle((100, 150, 300, 350), fill=(0, 0, 0, 255))
+	img.save(f"{shape}_silhouette.png")
+	return img
 
 
-def create_red_soft_mask(size=(400, 400)):
-    # Create an RGBA image with transparency
-    img = Image.new("RGBA", size, (255, 255, 255, 0))
-    mask = Image.new("L", size, 0)  # Grayscale mask for blurring
+def create_red_soft_mask(size: tuple[int, int] = (400, 400)) -> Image.Image:
+	# Create an RGBA image with transparency
+	img = Image.new("RGBA", size, (255, 255, 255, 0))
+	mask = Image.new("L", size, 0)  # Grayscale mask for blurring
 
-    draw = ImageDraw.Draw(mask)
-    draw.ellipse((50, 50, size[0] - 50, size[1] - 50), fill=255)
-    mask = mask.filter(ImageFilter.GaussianBlur(30))  # Feather effect
+	draw = ImageDraw.Draw(mask)
+	draw.ellipse((50, 50, size[0] - 50, size[1] - 50), fill=255)
+	mask = mask.filter(ImageFilter.GaussianBlur(30))  # Feather effect
 
-    # Apply the mask as alpha channel to a red image
-    red_layer = Image.new("RGBA", size, (255, 0, 0, 255))  # Solid red
-    img = Image.composite(red_layer, img, mask)  # Blend using mask
+	# Apply the mask as alpha channel to a red image
+	red_layer = Image.new("RGBA", size, (255, 0, 0, 255))  # Solid red
+	img = Image.composite(red_layer, img, mask)  # Blend using mask
+
+	img.save("red_soft_mask.png")
+	return img
 
-    img.save("red_soft_mask.png")
-    return img
 
 # Generate all images
 create_solid_color_image()
@@ -73,5 +87,3 @@ def create_red_soft_mask(size=(400, 400)):
 create_silhouette("circle")
 create_silhouette("rectangle")
 create_red_soft_mask()
-
-print("Done!")

tests/test_imgdiff.py

@@ -14,7 +14,7 @@
 from blendmodes.imgdiff import image_diff, is_equal, is_x_diff
 
 
-def test_identical_images():
+def test_identical_images() -> None:
 	img = Image.new("RGB", (100, 100), "red")
 	assert image_diff(img, img) == 0.0
 	assert is_equal(img, img)
@@ -24,7 +24,7 @@ def test_identical_images():
 	assert imgcompare.image_diff_percent(img, img) == image_diff(img, img)
 
 
-def test_completely_different_images():
+def test_completely_different_images() -> None:
 	img1 = Image.new("RGB", (100, 100), "white")
 	img2 = Image.new("RGB", (100, 100), "black")
 	assert image_diff(img1, img2, compare_mode="RGB") == 100
@@ -35,7 +35,7 @@ def test_completely_different_images():
 	assert imgcompare.image_diff_percent(img1, img2) == image_diff(img1, img2, "RGB")
 
 
-def test_red_blue_rgb():
+def test_red_blue_rgb() -> None:
 	img1 = Image.new("RGB", (100, 100), "red")
 	img2 = Image.new("RGB", (100, 100), "blue")
 	assert is_x_diff(img1, img2, compare_mode="RGB", cmp_diff=33, tolerance=1)
@@ -44,7 +44,7 @@ def test_red_blue_rgb():
 	# assert imgcompare.image_diff_percent(img1, img2) == image_diff(img1, img2, compare_mode="RGB")
 
 
-def test_red_blue_l():
+def test_red_blue_l() -> None:
 	img1 = Image.new("RGB", (100, 100), "red")
 	img2 = Image.new("RGB", (100, 100), "blue")
 	assert is_x_diff(img1, img2, compare_mode="L", cmp_diff=18, tolerance=1)
@@ -53,14 +53,14 @@ def test_red_blue_l():
 	# assert imgcompare.image_diff_percent(img1, img2) == image_diff(img1, img2, compare_mode="L")
 
 
-def test_different_size_images():
+def test_different_size_images() -> None:
 	img1 = Image.new("RGB", (100, 100), "red")
 	img2 = Image.new("RGB", (50, 50), "blue")
 	with pytest.raises(ValueError):
 		image_diff(img1, img2)
 
 
-def test_identical_rgba_vs_rgb():
+def test_identical_rgba_vs_rgb() -> None:
 	img1 = Image.new("RGBA", (100, 100), (255, 0, 0, 255))
 	img2 = Image.new("RGB", (100, 100), "red")
 	assert image_diff(img1, img2) == 0