Rename various attributes.

Author: KelSolaar

colour_checker_detection/__init__.py

@@ -41,12 +41,12 @@
     "detect_colour_checkers_segmentation",
 ]
 
-RESOURCES_DIRECTORY: str = os.path.join(os.path.dirname(__file__), "resources")
-EXAMPLES_RESOURCES_DIRECTORY: str = os.path.join(
-    RESOURCES_DIRECTORY, "colour-checker-detection-examples-datasets"
+ROOT_RESOURCES: str = os.path.join(os.path.dirname(__file__), "resources")
+ROOT_RESOURCES_EXAMPLES: str = os.path.join(
+    ROOT_RESOURCES, "colour-checker-detection-examples-datasets"
 )
-TESTS_RESOURCES_DIRECTORY: str = os.path.join(
-    RESOURCES_DIRECTORY, "colour-checker-detection-tests-datasets"
+ROOT_RESOURCES_TESTS: str = os.path.join(
+    ROOT_RESOURCES, "colour-checker-detection-tests-datasets"
 )
 
 __application_name__ = "Colour - Checker Detection"

colour_checker_detection/detection/segmentation.py

@@ -499,9 +499,9 @@ def crop_and_level_image_with_rectangle(
     --------
     >>> import os
     >>> from colour import read_image
-    >>> from colour_checker_detection import TESTS_RESOURCES_DIRECTORY
+    >>> from colour_checker_detection import ROOT_RESOURCES_TESTS
     >>> path = os.path.join(
-    ...     TESTS_RESOURCES_DIRECTORY,
+    ...     ROOT_RESOURCES_TESTS,
     ...     "colour_checker_detection",
     ...     "detection",
     ...     "IMG_1967.png",
@@ -664,9 +664,9 @@ def colour_checkers_coordinates_segmentation(
     --------
     >>> import os
     >>> from colour import read_image
-    >>> from colour_checker_detection import TESTS_RESOURCES_DIRECTORY
+    >>> from colour_checker_detection import ROOT_RESOURCES_TESTS
     >>> path = os.path.join(
-    ...     TESTS_RESOURCES_DIRECTORY,
+    ...     ROOT_RESOURCES_TESTS,
     ...     "colour_checker_detection",
     ...     "detection",
     ...     "IMG_1967.png",
@@ -862,9 +862,9 @@ def extract_colour_checkers_segmentation(
     --------
     >>> import os
     >>> from colour import read_image
-    >>> from colour_checker_detection import TESTS_RESOURCES_DIRECTORY
+    >>> from colour_checker_detection import ROOT_RESOURCES_TESTS
     >>> path = os.path.join(
-    ...     TESTS_RESOURCES_DIRECTORY,
+    ...     ROOT_RESOURCES_TESTS,
     ...     "colour_checker_detection",
     ...     "detection",
     ...     "IMG_1967.png",
@@ -1051,9 +1051,9 @@ def detect_colour_checkers_segmentation(
     --------
     >>> import os
     >>> from colour import read_image
-    >>> from colour_checker_detection import TESTS_RESOURCES_DIRECTORY
+    >>> from colour_checker_detection import ROOT_RESOURCES_TESTS
     >>> path = os.path.join(
-    ...     TESTS_RESOURCES_DIRECTORY,
+    ...     ROOT_RESOURCES_TESTS,
     ...     "colour_checker_detection",
     ...     "detection",
     ...     "IMG_1967.png",

colour_checker_detection/detection/tests/test_segmentation.py

@@ -13,7 +13,7 @@
 from colour import read_image
 from colour.models import cctf_encoding
 
-from colour_checker_detection import TESTS_RESOURCES_DIRECTORY
+from colour_checker_detection import ROOT_RESOURCES_TESTS
 from colour_checker_detection.detection.segmentation import (
     SETTINGS_SEGMENTATION_COLORCHECKER_CLASSIC,
     swatch_masks,
@@ -53,7 +53,7 @@
 ]
 
 DETECTION_DIRECTORY = os.path.join(
-    TESTS_RESOURCES_DIRECTORY, "colour_checker_detection", "detection"
+    ROOT_RESOURCES_TESTS, "colour_checker_detection", "detection"
 )
 
 PNG_FILES = glob.glob(os.path.join(DETECTION_DIRECTORY, "*.png"))

colour_checker_detection/examples/examples_detection.ipynb

@@ -59,7 +59,7 @@
     "import colour\n",
     "\n",
     "from colour_checker_detection import (\n",
-    "    EXAMPLES_RESOURCES_DIRECTORY,\n",
+    "    ROOT_RESOURCES_EXAMPLES,\n",
     "    SETTINGS_SEGMENTATION_COLORCHECKER_CLASSIC,\n",
     "    colour_checkers_coordinates_segmentation,\n",
     "    detect_colour_checkers_segmentation)\n",
@@ -120,7 +120,7 @@
    ],
    "source": [
     "COLOUR_CHECKER_IMAGE_PATHS = glob.glob(\n",
-    "    os.path.join(EXAMPLES_RESOURCES_DIRECTORY, 'detection', '*.png'))\n",
+    "    os.path.join(ROOT_RESOURCES_EXAMPLES, 'detection', '*.png'))\n",
     "\n",
     "COLOUR_CHECKER_IMAGES = [\n",
     "    colour.cctf_decoding(colour.io.read_image(path))\n",