Merge branch 'feature/v0.2.3' into develop

Author: KelSolaar

colour_checker_detection/__init__.py

@@ -84,7 +84,7 @@
 
 __major_version__ = "0"
 __minor_version__ = "2"
-__change_version__ = "2"
+__change_version__ = "3"
 __version__ = f"{__major_version__}.{__minor_version__}.{__change_version__}"
 
 try:

colour_checker_detection/detection/templated.py

@@ -34,6 +34,7 @@
 from colour.utilities import (
     Structure,
     optional,
+    required,
     usage_warning,
 )
 from colour.utilities.documentation import (
@@ -42,7 +43,6 @@
 )
 from scipy.optimize import linear_sum_assignment
 from scipy.spatial import distance_matrix
-from sklearn.cluster import DBSCAN
 
 from colour_checker_detection.detection.common import (
     DTYPE_FLOAT_DEFAULT,
@@ -159,6 +159,7 @@ def segmenter_templated(
 ) -> NDArrayInt: ...
 
 
+@required("scikit-learn")  # pyright: ignore
 def segmenter_templated(
     image: ArrayLike,
     cctf_encoding: Callable = eotf_inverse_sRGB,
@@ -296,6 +297,9 @@ def segmenter_templated(
             [1086,  244],
             [1069,  715]]], dtype=int32)
     """
+
+    from sklearn.cluster import DBSCAN  # noqa: PLC0415
+
     settings = Structure(**SETTINGS_TEMPLATED_COLORCHECKER_CLASSIC)
     settings.update(**kwargs)
 

colour_checker_detection/utilities/__init__.py

@@ -0,0 +1,5 @@
+from .requirements import is_sklearn_installed
+
+__all__ = [
+    "is_sklearn_installed",
+]

colour_checker_detection/utilities/requirements.py

@@ -0,0 +1,63 @@
+"""
+Requirements Utilities
+======================
+
+Define the requirements utilities objects.
+"""
+
+from __future__ import annotations
+
+import colour.utilities
+
+__author__ = "Colour Developers"
+__copyright__ = "Copyright 2018 Colour Developers"
+__license__ = "BSD-3-Clause - https://opensource.org/licenses/BSD-3-Clause"
+__maintainer__ = "Colour Developers"
+__email__ = "[email protected]"
+__status__ = "Production"
+
+__all__ = [
+    "is_sklearn_installed",
+]
+
+
+def is_sklearn_installed(raise_exception: bool = False) -> bool:
+    """
+    Return whether *scikit-learn* is installed and available.
+
+    Parameters
+    ----------
+    raise_exception
+        Whether to raise an exception if *scikit-learn* is unavailable.
+
+    Returns
+    -------
+    :class:`bool`
+        Whether *scikit-learn* is installed.
+
+    Raises
+    ------
+    :class:`ImportError`
+        If *scikit-learn* is not installed.
+    """
+
+    try:  # pragma: no cover
+        import sklearn  # noqa: F401, PLC0415
+    except ImportError as exception:  # pragma: no cover
+        if raise_exception:
+            error = (
+                f'"scikit-learn" related API features are not available: "{exception}".'
+            )
+
+            raise ImportError(error) from exception
+
+        return False
+    else:
+        return True
+
+
+colour.utilities.requirements.REQUIREMENTS_TO_CALLABLE.update(
+    {
+        "scikit-learn": is_sklearn_installed,
+    }
+)

docs/colour_checker_detection.rst

@@ -5,3 +5,4 @@ Colour - Checker Detection
     :maxdepth: 3
 
     colour_checker_detection.detection
+    colour_checker_detection.utilities

docs/colour_checker_detection.utilities.rst

@@ -0,0 +1,14 @@
+Utilities
+=========
+
+Requirements
+------------
+
+``colour_checker_detection.utilities``
+
+.. currentmodule:: colour_checker_detection.utilities
+
+.. autosummary::
+    :toctree: generated/
+
+    is_sklearn_installed

docs/requirements.txt

@@ -43,6 +43,8 @@ fsspec==2025.12.0 ; python_full_version < '3.14'
     # via torch
 idna==3.11
     # via requests
+imageio==2.37.2
+    # via colour-checker-detection
 imagesize==1.4.1
     # via sphinx
 jinja2==3.1.6
@@ -70,6 +72,7 @@ numpy==2.3.5
     #   colour-checker-detection
     #   colour-science
     #   contourpy
+    #   imageio
     #   matplotlib
     #   opencv-python
     #   openimageio
@@ -129,6 +132,7 @@ packaging==25.0
     #   sphinx
 pillow==12.0.0
     # via
+    #   imageio
     #   matplotlib
     #   torchvision
     #   ultralytics

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "colour-checker-detection"
-version = "0.2.2"
+version = "0.2.3"
 description = "Colour checker detection with Python"
 readme = "README.rst"
 requires-python = ">=3.11,<3.15"

requirements.txt

@@ -137,6 +137,8 @@ idna==3.11
     #   hyperlink
     #   jsonschema
     #   requests
+imageio==2.37.2
+    # via colour-checker-detection
 imagesize==1.4.1
     # via sphinx
 importlib-metadata==8.7.0 ; python_full_version < '3.12'
@@ -301,6 +303,7 @@ numpy==2.3.5
     #   colour-checker-detection
     #   colour-science
     #   contourpy
+    #   imageio
     #   matplotlib
     #   numpy-typing-compat
     #   opencv-python
@@ -388,6 +391,7 @@ pexpect==4.9.0
     #   ipython
 pillow==12.0.0
     # via
+    #   imageio
     #   matplotlib
     #   torchvision
     #   ultralytics