Merge pull request #111 from ampas/feature/polish

PR: Use `colour` checks configuration.

Author: KelSolaar

.gitignore

@@ -1,9 +1,27 @@
+# Common Files
 *.egg-info
 *.pyc
 *.pyo
 .DS_Store
-.coverage
-.idea
+.coverage*
+uv.lock
+
+# Common Directories
+.fleet/
+.idea/
+.ipynb_checkpoints/
+.python-version
+.vs/
+.vscode/
+.sandbox/
+build/
+dist/
+docs/_build/
+docs/generated/
+node_modules/
+references/
+
 __pycache__
-poetry.lock
-/tests/output/**
+
+# Project Directories
+tests/output/

.pre-commit-config.yaml

@@ -1,12 +1,13 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.5.0"
+    rev: "v5.0.0"
     hooks:
       - id: check-added-large-files
       - id: check-case-conflict
       - id: check-merge-conflict
       - id: check-symlinks
       - id: check-yaml
+        exclude: config-aces-reference.ocio.yaml
       - id: debug-statements
       - id: end-of-file-fixer
       - id: mixed-line-ending
@@ -15,32 +16,30 @@ repos:
       - id: requirements-txt-fixer
       - id: trailing-whitespace
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.2.6
+    rev: v2.3.0
     hooks:
       - id: codespell
-  - repo: https://github.com/ikamensh/flynt
-    rev: "1.0.1"
-    hooks:
-      - id: flynt
-        args: [--verbose]
+        args: ["--ignore-words-list=rIn"]
   - repo: https://github.com/PyCQA/isort
     rev: "5.13.2"
     hooks:
       - id: isort
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.14"
+    rev: "v0.8.2"
     hooks:
       - id: ruff-format
       - id: ruff
+        args: [--fix]
   - repo: https://github.com/adamchainz/blacken-docs
-    rev: 1.16.0
+    rev: 1.19.1
     hooks:
       - id: blacken-docs
         language_version: python3.10
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v3.1.0"
+    rev: "v4.0.0-alpha.8"
     hooks:
       - id: prettier
+        exclude: config-aces-reference.ocio.yaml
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: "v1.10.0"
     hooks:

aces/__init__.py

@@ -0,0 +1,3 @@
+import matplotlib as mpl
+
+mpl.use("Agg")

aces/idt/__init__.py

@@ -83,7 +83,6 @@
     "sort_exposure_keys",
     "working_directory",
 ]
-
 __all__ += ["IDTProjectSettings"]
 __all__ += [
     "GENERATORS",

aces/idt/application.py

@@ -5,19 +5,26 @@
 Define the *IDT* generator application class.
 """
 
+from __future__ import annotations
+
 import logging
 import re
+import typing
 from pathlib import Path
 
-from colour.hints import List
+if typing.TYPE_CHECKING:
+    from colour.hints import List
+
 from colour.utilities import attest, optional
 
 import aces.idt.core.common
 from aces.idt.core.constants import DirectoryStructure
-from aces.idt.core.trasform_id import generate_idt_urn, is_valid_idt_urn
+from aces.idt.core.transform_id import generate_idt_urn, is_valid_csc_urn
 from aces.idt.framework.project_settings import IDTProjectSettings
 from aces.idt.generators import GENERATORS
-from aces.idt.generators.base_generator import IDTBaseGenerator
+
+if typing.TYPE_CHECKING:
+    from aces.idt.generators.base_generator import IDTBaseGenerator
 
 __author__ = "Alex Forsythe, Joshua Pines, Thomas Mansencal, Nick Shaw, Adam Davis"
 __copyright__ = "Copyright 2022 Academy of Motion Picture Arts and Sciences"
@@ -84,15 +91,17 @@ def generator(self) -> IDTBaseGenerator:
         return self._generator
 
     @generator.setter
-    def generator(self, value: str):
+    def generator(self, value: str) -> None:
         """Setter for the **self.generator** property."""
 
         if value not in self.generator_names:
-            raise ValueError(
+            exception = (
                 f'"{value}" generator is invalid, must be one of '
                 f'"{self.generator_names}"!'
             )
 
+            raise ValueError(exception)
+
         self._generator = GENERATORS[value](self.project_settings)
 
     @property
@@ -113,7 +122,7 @@ def project_settings(self) -> IDTProjectSettings:
         return self._project_settings
 
     @project_settings.setter
-    def project_settings(self, value: IDTProjectSettings):
+    def project_settings(self, value: IDTProjectSettings) -> None:
         """Setter for the **self.project_settings** property."""
 
         self._project_settings.update(value)
@@ -239,19 +248,18 @@ def _verify_file_type(self) -> None:
         """
 
         file_types = set()
-        for _, value in self.project_settings.data[
+        for value in self.project_settings.data[
             DirectoryStructure.COLOUR_CHECKER
-        ].items():
+        ].values():
             for item in value:
                 file_types.add(item.suffix)
 
         for item in self.project_settings.data[DirectoryStructure.GREY_CARD]:
             file_types.add(item.suffix)
 
         if len(file_types) > 1:
-            raise ValueError(
-                f'Multiple file types found in the project settings: "{file_types}"'
-            )
+            msg = f'Multiple file types found in the project settings: "{file_types}"'
+            raise ValueError(msg)
 
         self.project_settings.file_type = next(iter(file_types))
 
@@ -279,8 +287,9 @@ def extract(self, archive: str, directory: str | None = None) -> str:
         json_files = list(root_directory.glob("*.json"))
 
         if len(json_files) > 1:
-            raise ValueError('Multiple "JSON" files found in the root directory!')
-        elif len(json_files) == 1:
+            msg = 'Multiple "JSON" files found in the root directory!'
+            raise ValueError(msg)
+        if len(json_files) == 1:
             json_file = next(iter(json_files))
             LOGGER.info('Found explicit "%s" "IDT" project settings file.', json_file)
             self.project_settings = IDTProjectSettings.from_file(json_file)
@@ -315,7 +324,9 @@ def process_archive(self, archive: str | None) -> IDTBaseGenerator:
         """
 
         if self.generator is None:
-            raise ValueError('No "IDT" generator was selected!')
+            exception = 'No "IDT" generator was set!'
+
+            raise ValueError(exception)
 
         if archive is not None:
             self.project_settings.working_directory = self.extract(archive)
@@ -324,7 +335,7 @@ def process_archive(self, archive: str | None) -> IDTBaseGenerator:
         for exposure in list(
             self.project_settings.data[DirectoryStructure.COLOUR_CHECKER].keys()
         ):
-            images = [  # noqa: C416
+            images = [
                 image
                 for image in self.project_settings.data[
                     DirectoryStructure.COLOUR_CHECKER
@@ -338,27 +349,29 @@ def process_archive(self, archive: str | None) -> IDTBaseGenerator:
         return self.process()
 
     def process(self) -> IDTBaseGenerator:
-        """Run the *IDT* generator application process maintaining the execution steps
+        """
+        Run the *IDT* generator application process maintaining the execution steps.
 
         Returns
         -------
         :class:`IDTBaseGenerator`
             Instantiated *IDT* generator. after the process has been run
-
         """
+
         self.validate_project_settings()
         self.generator.sample()
         self.generator.sort()
-        self.generator.remove_clipping()
+        self.generator.remove_clipped_samples()
         self.generator.generate_LUT()
         self.generator.filter_LUT()
         self.generator.decode()
         self.generator.optimise()
+
         return self.generator
 
     def zip(
         self, output_directory: Path | str, archive_serialised_generator: bool = False
-    ) -> str:
+    ) -> Path:
         """
         Create a *zip* file with the output of the *IDT* application process.
 
@@ -371,12 +384,14 @@ def zip(
 
         Returns
         -------
-        :class:`str`
+        :class:`pathlib.Path`
             *Zip* file path.
         """
 
         if not self.generator:
-            raise ValueError("No Idt Generator Set")
+            exception = 'No "IDT" generator was set!'
+
+            raise ValueError(exception)
 
         return self.generator.zip(
             output_directory, archive_serialised_generator=archive_serialised_generator
@@ -390,8 +405,9 @@ def validate_project_settings(self) -> None:
         ValueError
             If any of the validations fail
         """
+
         # Check the aces_transform_id is a valid idt_urn
-        if not is_valid_idt_urn(self.project_settings.aces_transform_id):
+        if not is_valid_csc_urn(self.project_settings.aces_transform_id):
             # If the aces_transform_id is not valid, generate a new one
             new_name = generate_idt_urn(
                 self.project_settings.aces_user_name,

aces/idt/core/__init__.py

@@ -5,11 +5,11 @@
     SD_ILLUMINANT_ACES,
     SDS_COLORCHECKER_CLASSIC,
     SETTINGS_SEGMENTATION_COLORCHECKER_CLASSIC,
-    calculate_clipped_exposures,
     clf_processing_elements,
     error_delta_E,
     extract_archive,
-    find_close_indices,
+    find_clipped_exposures,
+    find_similar_rows,
     format_exposure_key,
     generate_reference_colour_checker,
     get_sds_colour_checker,
@@ -26,7 +26,7 @@
 )
 from .constants import (
     CAT,
-    CLIPPING_THRESHOLD,
+    EXPOSURE_CLIPPING_THRESHOLD,
     DecodingMethods,
     DirectoryStructure,
     Interpolators,
@@ -69,12 +69,12 @@
     "slugify",
     "sort_exposure_keys",
     "working_directory",
-    "find_close_indices",
-    "calculate_clipped_exposures",
+    "find_similar_rows",
+    "find_clipped_exposures",
 ]
 
 __all__ += [
-    "CLIPPING_THRESHOLD",
+    "EXPOSURE_CLIPPING_THRESHOLD",
     "CAT",
     "DirectoryStructure",
     "DecodingMethods",