stouputils 1.2.14__tar.gz → 1.2.16__tar.gz

{stouputils-1.2.14 → stouputils-1.2.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.14
+Version: 1.2.16
 Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
 Project-URL: Homepage, https://github.com/Stoupy51/stouputils
 Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues
@@ -14,6 +14,9 @@ Requires-Dist: furo>=2024.8.6
 Requires-Dist: hatch>=1.14.0
 Requires-Dist: m2r2>=0.3.3.post2
 Requires-Dist: myst-parser>=4.0.1
+Requires-Dist: numpy>=2.2.4
+Requires-Dist: opencv-python>=4.8.1.78
+Requires-Dist: pillow>=11.1.0
 Requires-Dist: pyyaml>=6.0.0
 Requires-Dist: requests>=2.30.0
 Requires-Dist: sphinx-rtd-theme>=3.0.2

{stouputils-1.2.14 → stouputils-1.2.16}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.14"
+version = "1.2.16"
 description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -25,6 +25,9 @@ dependencies = [
 	"myst-parser>=4.0.1",
 	"furo>=2024.8.6",
 	"hatch>=1.14.0",
+	"pillow>=11.1.0",
+	"numpy>=2.2.4",
+	"opencv-python>=4.8.1.78",
 ]
 [[project.authors]]
 name = "Stoupy51"

{stouputils-1.2.14 → stouputils-1.2.16}/stouputils/image.py

@@ -1,20 +1,19 @@
 
 # Imports
 from PIL import Image
-from typing import Callable
-from numpy.typing import NDArray
+from typing import Callable, Any
 import numpy as np
 
-
 # Functions
 def image_resize(
-	image: Image.Image | NDArray[np.uint8],
+	image: Image.Image | np.ndarray[Any, np.dtype[np.uint8]],
 	max_result_size: int,
 	resampling: Image.Resampling = Image.Resampling.LANCZOS,
 	min_or_max: Callable[[int, int], int] = max,
-	return_type: type[Image.Image | NDArray[np.uint8]] = Image.Image,
-) -> Image.Image | NDArray[np.uint8]:
-	""" Resize an image while preserving its aspect ratio.
+	return_type: type[Image.Image | np.ndarray[Any, np.dtype[np.uint8]]] = Image.Image,
+	keep_aspect_ratio: bool = True,
+) -> Any:
+	""" Resize an image while preserving its aspect ratio by default.
 	Scales the image so that its largest dimension equals max_result_size.
 	
 	Args:
@@ -23,8 +22,9 @@ def image_resize(
 		resampling        (Image.Resampling):         PIL resampling filter to use.
 		min_or_max        (Callable):                 Function to use to get the minimum or maximum of the two ratios.
 		return_type       (type):                     Type of the return value (Image.Image or np.ndarray).
+		keep_aspect_ratio (bool):                     Whether to keep the aspect ratio.
 	Returns:
-		Image.Image: The resized image with preserved aspect ratio.
+		Image.Image | np.ndarray[Any, np.dtype[np.uint8]]: The resized image with preserved aspect ratio.
 	Examples:
 		>>> # Test with (height x width x channels) numpy array
 		>>> import numpy as np
@@ -51,18 +51,33 @@ def image_resize(
 		>>> image_resize(pil_image, 50, resampling=Image.Resampling.NEAREST).size
 		(50, 25)
 	"""
+	# Convert numpy array to PIL Image if needed
 	if isinstance(image, np.ndarray):
-		image = Image.fromarray(image)	# type: ignore
-
-	width: int = image.size[0]
-	height: int = image.size[1]
-	max_dimension: int = min_or_max(width, height)
-	scale: float = max_result_size / max_dimension
+		image = Image.fromarray(image)
 	
-	new_width: int = int(width * scale)
-	new_height: int = int(height * scale)
-	new_image: Image.Image = image.resize((new_width, new_height), resampling)
+	if keep_aspect_ratio:
+
+		# Get original image dimensions
+		width: int = image.size[0]
+		height: int = image.size[1]
+
+		# Determine which dimension to use for scaling based on min_or_max function
+		max_dimension: int = min_or_max(width, height)
+
+		# Calculate scaling factor
+		scale: float = max_result_size / max_dimension
+		
+		# Calculate new dimensions while preserving aspect ratio
+		new_width: int = int(width * scale)
+		new_height: int = int(height * scale)
+
+		# Resize the image with the calculated dimensions
+		new_image: Image.Image = image.resize((new_width, new_height), resampling)
+	else:
+		# If not keeping aspect ratio, resize to square with max_result_size
+		new_image: Image.Image = image.resize((max_result_size, max_result_size), resampling)
 	
+	# Return the image in the requested format
 	if return_type == np.ndarray:
 		return np.array(new_image)
 	else: