PR: Explicit Versions (#50)

* Raise package version to 0.2.0.

Closes #47.

Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com>

* Add "opencolorio_config_aces.version_aces_dev" definition that returns the current "aces-dev" version.

Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com>

* Implement support for version in filenames and config name attributes.

Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com>

* Fix incorrect assertion message.

Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com>

* Address code review notes.

Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com>

* Shorten configs basename.

Signed-off-by: Thomas Mansencal <thomas.mansencal@gmail.com>

Author: KelSolaar

docs/opencolorio_config_aces.config.rst

@@ -54,6 +54,7 @@ Reference Configuration
 .. autosummary::
     :toctree: generated/
 
+    version_aces_dev
     classify_aces_ctl_transforms
     discover_aces_ctl_transforms
     filter_ctl_transforms
@@ -88,6 +89,7 @@ Reference Configuration
     :toctree: generated/
 
     ColorspaceDescriptionStyle
+    version_config_mapping_file
     generate_config_aces
 
 *ACES* Computer Graphics (CG) Config Generator

docs/opencolorio_config_aces.utilities.rst

@@ -31,4 +31,5 @@ Common
     is_iterable
     git_describe
     matrix_3x3_to_4x4
-    multi_replace
+    multi_replace
+    regularise_version

opencolorio_config_aces/__init__.py

@@ -52,6 +52,8 @@
     plot_aces_conversion_graph,
     print_aces_taxonomy,
     unclassify_ctl_transforms,
+    version_aces_dev,
+    version_config_mapping_file,
 )
 from .config import (
     ColorspaceDescriptionStyle,
@@ -106,6 +108,8 @@
     "plot_aces_conversion_graph",
     "print_aces_taxonomy",
     "unclassify_ctl_transforms",
+    "version_aces_dev",
+    "version_config_mapping_file",
 ]
 __all__ += [
     "ColorspaceDescriptionStyle",
@@ -124,8 +128,8 @@
 __application_name__ = "OpenColorIO Configuration for ACES"
 
 __major_version__ = "0"
-__minor_version__ = "1"
-__change_version__ = "1"
+__minor_version__ = "2"
+__change_version__ = "0"
 __version__ = ".".join(
     (__major_version__, __minor_version__, __change_version__)
 )  # yapf: disable

opencolorio_config_aces/config/__init__.py

@@ -33,6 +33,8 @@
     plot_aces_conversion_graph,
     print_aces_taxonomy,
     unclassify_ctl_transforms,
+    version_aces_dev,
+    version_config_mapping_file,
 )
 from .reference import (
     ColorspaceDescriptionStyle,
@@ -72,6 +74,8 @@
     "plot_aces_conversion_graph",
     "print_aces_taxonomy",
     "unclassify_ctl_transforms",
+    "version_aces_dev",
+    "version_config_mapping_file",
 ]
 __all__ += [
     "ColorspaceDescriptionStyle",

opencolorio_config_aces/config/cg/generate/config.py

@@ -12,6 +12,7 @@
 
 import csv
 import logging
+
 import PyOpenColorIO as ocio
 from collections import defaultdict
 from datetime import datetime
@@ -29,9 +30,11 @@
 )
 from opencolorio_config_aces.config.reference import (
     ColorspaceDescriptionStyle,
+    version_aces_dev,
+    version_config_mapping_file,
     generate_config_aces,
 )
-from opencolorio_config_aces.utilities import git_describe
+from opencolorio_config_aces.utilities import git_describe, regularise_version
 
 __author__ = "OpenColorIO Contributors"
 __copyright__ = "Copyright Contributors to the OpenColorIO Project."
@@ -44,13 +47,17 @@
     "PATH_TRANSFORMS_MAPPING_FILE_CG",
     "clf_transform_to_description",
     "clf_transform_to_colorspace",
+    "dependency_versions",
+    "config_basename_cg",
+    "config_name_cg",
+    "config_description_cg",
     "generate_config_cg",
 ]
 
-PATH_TRANSFORMS_MAPPING_FILE_CG = (
-    Path(__file__).parents[0]
-    / "resources"
-    / "OpenColorIO-Config-ACES _CG_ Transforms - CG Config - Mapping.csv"
+PATH_TRANSFORMS_MAPPING_FILE_CG = next(
+    (Path(__file__).parents[0] / "resources").glob(
+        "OpenColorIO-Config-ACES CG Transforms - * - CG Config - Mapping.csv"
+    )
 )
 """
 Path to the *ACES* *CTL* transforms to *OpenColorIO* colorspaces mapping file.
@@ -215,6 +222,126 @@ def clf_transform_to_named_transform(
         return named_transform
 
 
+def dependency_versions(
+    config_mapping_file_path=PATH_TRANSFORMS_MAPPING_FILE_CG,
+):
+    """
+    Return the dependency versions of the ACES* Computer Graphics (CG)
+    *OpenColorIO* config.
+
+    Parameters
+    ----------
+    config_mapping_file_path : str, optional
+        Path to the *CSV* mapping file.
+
+    Returns
+    -------
+    dict
+        Dependency versions.
+
+    Examples
+    --------
+    >>> dependency_versions()  # doctest: +SKIP
+    {'aces': 'v1.3', 'ocio': 'v2.1.2dev', 'colorspaces': 'v0.1.0'}
+    """
+
+    versions = {
+        "aces": regularise_version(version_aces_dev()),
+        "ocio": regularise_version(ocio.__version__),
+        "colorspaces": regularise_version(
+            version_config_mapping_file(config_mapping_file_path)
+        ),
+    }
+
+    return versions
+
+
+def config_basename_cg(
+    config_mapping_file_path=PATH_TRANSFORMS_MAPPING_FILE_CG,
+):
+    """
+    Generate the ACES* Computer Graphics (CG) *OpenColorIO* config
+    basename, i.e. the filename devoid of directory prefix.
+
+    Parameters
+    ----------
+    config_mapping_file_path : str, optional
+        Path to the *CSV* mapping file.
+
+    Returns
+    -------
+    str
+        ACES* Computer Graphics (CG) *OpenColorIO* config basename.
+
+    Examples
+    --------
+    >>> config_basename_cg()  # doctest: +SKIP
+    'cg-config-v0.1.0_aces-v1.3_ocio-v2.1.2dev.ocio'
+    """
+
+    return ("cg-config-{colorspaces}_aces-{aces}_ocio-{ocio}.ocio").format(
+        **dependency_versions(config_mapping_file_path)
+    )
+
+
+def config_name_cg(config_mapping_file_path=PATH_TRANSFORMS_MAPPING_FILE_CG):
+    """
+    Generate the ACES* Computer Graphics (CG) *OpenColorIO* config name.
+
+    Parameters
+    ----------
+    config_mapping_file_path : str, optional
+        Path to the *CSV* mapping file.
+
+    Returns
+    -------
+    str
+        ACES* Computer Graphics (CG) *OpenColorIO* config name.
+
+    Examples
+    --------
+    >>> config_name_cg()  # doctest: +SKIP
+    'Academy Color Encoding System - CG Config [COLORSPACES v0.1.0] \
+[ACES v1.3] [OCIO v2.1.2dev]'
+    """
+
+    return (
+        "Academy Color Encoding System - CG Config "
+        "[COLORSPACES {colorspaces}] "
+        "[ACES {aces}] "
+        "[OCIO {ocio}]"
+    ).format(**dependency_versions(config_mapping_file_path))
+
+
+def config_description_cg():
+    """
+    Generate the ACES* Computer Graphics (CG) *OpenColorIO* config
+    description.
+
+    Returns
+    -------
+    str
+        ACES* Computer Graphics (CG) *OpenColorIO* config description.
+    """
+
+    header = (
+        f'The "Academy Color Encoding System" (ACES {version_aces_dev()}) '
+        f'"CG Config"'
+    )
+    underline = "-" * len(header)
+    description = (
+        'This minimalistic "OpenColorIO" config is geared toward computer '
+        "graphics artists requiring a lean config that does not include "
+        "camera colorspaces and the less common displays and looks."
+    )
+    timestamp = (
+        f'Generated with "OpenColorIO-Config-ACES" {git_describe()} '
+        f'on the {datetime.now().strftime("%Y/%m/%d at %H:%M")}.'
+    )
+
+    return "\n".join([header, underline, "", description, "", timestamp])
+
+
 def generate_config_cg(
     data=None,
     config_name=None,
@@ -285,18 +412,8 @@ def generate_config_cg(
                 transform_data
             )
 
-    data.description = (
-        f'The "Academy Color Encoding System" (ACES) "CG Config"'
-        f"\n"
-        f"------------------------------------------------------"
-        f"\n\n"
-        f'This minimalistic "OpenColorIO" config is geared toward computer '
-        f"graphics artists requiring a lean config that does not include "
-        f"typical VFX colorspaces, displays and looks."
-        f"\n\n"
-        f'Generated with "OpenColorIO-Config-ACES" {git_describe()} '
-        f'on the {datetime.now().strftime("%Y/%m/%d at %H:%M")}.'
-    )
+    data.name = config_name_cg(config_mapping_file_path)
+    data.description = config_description_cg()
 
     def multi_filters(array, filterers):
         """Apply given filterers on given array."""
@@ -407,7 +524,7 @@ def view_filterer(transform):
 
             assert (
                 clf_transform
-            ), f'"{clf_transform_id}" "CTL" transform does not exist!'
+            ), f'"{clf_transform_id}" "CLF" transform does not exist!'
 
             interface = transform_data["interface"]
 
@@ -474,16 +591,20 @@ def view_filterer(transform):
     if not os.path.exists(build_directory):
         os.makedirs(build_directory)
 
+    config_basename = config_basename_cg()
     config, data = generate_config_cg(
-        config_name=os.path.join(build_directory, "config-aces-cg.ocio"),
+        config_name=os.path.join(build_directory, config_basename),
         additional_data=True,
     )
 
     # TODO: Pickling "PyOpenColorIO.ColorSpace" fails on early "PyOpenColorIO"
     # versions.
     try:
         serialize_config_data(
-            data, os.path.join(build_directory, "config-aces-cg.json")
+            data,
+            os.path.join(
+                build_directory, config_basename.replace("ocio", "json")
+            ),
         )
     except TypeError as error:
         logging.critical(error)

…CG_ Transforms - CG Config - Mapping.csv …forms - v0.1.0 - CG Config - Mapping.csvopencolorio_config_aces/config/cg/generate/resources/OpenColorIO-Config-ACES _CG_ Transforms - CG Config - Mapping.csv renamed to opencolorio_config_aces/config/cg/generate/resources/OpenColorIO-Config-ACES CG Transforms - v0.1.0 - CG Config - Mapping.csv opencolorio_config_aces/config/cg/generate/resources/OpenColorIO-Config-ACES _CG_ Transforms - CG Config - Mapping.csv renamed to opencolorio_config_aces/config/cg/generate/resources/OpenColorIO-Config-ACES CG Transforms - v0.1.0 - CG Config - Mapping.csv

@@ -1,20 +1,20 @@
-Ordering,Transform Name,ACEStransformID,CLFtransformID,Linked DisplayColorSpace Style,Interface,Encoding,Categories
-100,ACES - ACEScc,urn:ampas:aces:transformId:v1.5:ACEScsc.Academy.ACEScc_to_ACES.a1.0.3,,,,,
-100,ACES - ACEScct,urn:ampas:aces:transformId:v1.5:ACEScsc.Academy.ACEScct_to_ACES.a1.0.3,,,,,
-100,ACES - ACEScg,urn:ampas:aces:transformId:v1.5:ACEScsc.Academy.ACEScg_to_ACES.a1.0.3,,,,,
-100,Input - Generic - sRGB - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Input:AP0_to_Rec709-sRGB:1.0,,ColorSpace,sdr-video,file-io
-100,Output - P3-D65 ST2084 (1000 nits),urn:ampas:aces:transformId:v1.5:RRTODT.Academy.P3D65_1000nits_15nits_ST2084.a1.1.0,,,,,
-100,Output - P3D65,urn:ampas:aces:transformId:v1.5:ODT.Academy.P3D65_48nits.a1.1.0,,,,,
-100,Output - Rec.2020 ST2084 (1000 nits),urn:ampas:aces:transformId:v1.5:RRTODT.Academy.Rec2020_1000nits_15nits_ST2084.a1.1.0,,,,,
-100,Output - Rec.709,urn:ampas:aces:transformId:v1.5:ODT.Academy.Rec709_100nits_dim.a1.0.3,,,,,
-100,Output - sRGB,urn:ampas:aces:transformId:v1.5:ODT.Academy.RGBmonitor_100nits_dim.a1.0.3,,,,,
-100,Utility - Curve - Rec.1886,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:Linear_to_Rec1886:1.0,,NamedTransform,sdr-video,file-io
-100,Utility - Curve - sRGB,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:Linear_to_sRGB:1.0,,NamedTransform,sdr-video,file-io
-100,Utility - Gamma 1.8 - Rec.709 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Gamma1.8:1.0,,ColorSpace,sdr-video,file-io
-100,Utility - Gamma 2.2 - AP1 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_AP1-Gamma2.2:1.0,,ColorSpace,sdr-video,file-io
-100,Utility - Gamma 2.2 - Rec.709 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Gamma2.2:1.0,,ColorSpace,sdr-video,file-io
-100,Utility - Gamma 2.4 - Rec.709 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Gamma2.4:1.0,,ColorSpace,sdr-video,file-io
-100,Utility - Linear - P3-D65,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_P3-D65-Linear:1.0,,ColorSpace,scene-linear,file-io
-100,Utility - Linear - Rec.2020,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec2020-Linear:1.0,,ColorSpace,scene-linear,file-io
-100,Utility - Linear - Rec.709,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Linear:1.0,,ColorSpace,scene-linear,"file-io,working-space"
+Ordering,Transform Name,ACEStransformID,CLFtransformID,Linked DisplayColorSpace Style,Interface,Encoding,Categories
+100,ACES - ACEScc,urn:ampas:aces:transformId:v1.5:ACEScsc.Academy.ACEScc_to_ACES.a1.0.3,,,,,
+100,ACES - ACEScct,urn:ampas:aces:transformId:v1.5:ACEScsc.Academy.ACEScct_to_ACES.a1.0.3,,,,,
+100,ACES - ACEScg,urn:ampas:aces:transformId:v1.5:ACEScsc.Academy.ACEScg_to_ACES.a1.0.3,,,,,
+100,Input - Generic - sRGB - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Input:AP0_to_Rec709-sRGB:1.0,,ColorSpace,sdr-video,file-io
+100,Output - P3-D65 ST2084 (1000 nits),urn:ampas:aces:transformId:v1.5:RRTODT.Academy.P3D65_1000nits_15nits_ST2084.a1.1.0,,,,,
+100,Output - P3D65,urn:ampas:aces:transformId:v1.5:ODT.Academy.P3D65_48nits.a1.1.0,,,,,
+100,Output - Rec.2020 ST2084 (1000 nits),urn:ampas:aces:transformId:v1.5:RRTODT.Academy.Rec2020_1000nits_15nits_ST2084.a1.1.0,,,,,
+100,Output - Rec.709,urn:ampas:aces:transformId:v1.5:ODT.Academy.Rec709_100nits_dim.a1.0.3,,,,,
+100,Output - sRGB,urn:ampas:aces:transformId:v1.5:ODT.Academy.RGBmonitor_100nits_dim.a1.0.3,,,,,
+100,Utility - Curve - Rec.1886,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:Linear_to_Rec1886:1.0,,NamedTransform,sdr-video,file-io
+100,Utility - Curve - sRGB,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:Linear_to_sRGB:1.0,,NamedTransform,sdr-video,file-io
+100,Utility - Gamma 1.8 - Rec.709 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Gamma1.8:1.0,,ColorSpace,sdr-video,file-io
+100,Utility - Gamma 2.2 - AP1 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_AP1-Gamma2.2:1.0,,ColorSpace,sdr-video,file-io
+100,Utility - Gamma 2.2 - Rec.709 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Gamma2.2:1.0,,ColorSpace,sdr-video,file-io
+100,Utility - Gamma 2.4 - Rec.709 - Texture,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Gamma2.4:1.0,,ColorSpace,sdr-video,file-io
+100,Utility - Linear - P3-D65,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_P3-D65-Linear:1.0,,ColorSpace,scene-linear,file-io
+100,Utility - Linear - Rec.2020,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec2020-Linear:1.0,,ColorSpace,scene-linear,file-io
+100,Utility - Linear - Rec.709,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Linear:1.0,,ColorSpace,scene-linear,"file-io,working-space"
 100,Utility - Linear - sRGB,,urn:aswf:ocio:transformId:1.0:OCIO:Utility:AP0_to_Rec709-Linear:1.0,,ColorSpace,scene-linear,"file-io,working-space"

opencolorio_config_aces/config/cg/generate/tests/test_resources.py

@@ -7,9 +7,11 @@
 
 
 import unittest
-import urllib.request
+import requests
 
-from pathlib import Path
+from opencolorio_config_aces.config.cg.generate.config import (
+    PATH_TRANSFORMS_MAPPING_FILE_CG,
+)
 
 __author__ = "OpenColorIO Contributors"
 __copyright__ = "Copyright Contributors to the OpenColorIO Project."
@@ -32,12 +34,7 @@ class TestConfigResources(unittest.TestCase):
     def test_csv_mapping_file(self):
         """Test the *CSV* mapping file."""
 
-        csv_local_path = (
-            Path(__file__).parents[0]
-            / ".."
-            / "resources"
-            / "OpenColorIO-Config-ACES _CG_ Transforms - CG Config - Mapping.csv"
-        )
+        csv_local_path = PATH_TRANSFORMS_MAPPING_FILE_CG
 
         with open(str(csv_local_path)) as csv_local_file:
             csv_local_content = csv_local_file.read()
@@ -48,9 +45,7 @@ def test_csv_mapping_file(self):
             "export?format=csv&gid=609660164"
         )
 
-        csv_remote_content = (
-            urllib.request.urlopen(csv_remote_url).read().decode("utf-8")
-        )
+        csv_remote_content = requests.get(csv_remote_url).text
 
         self.assertMultiLineEqual(
             "\n".join(csv_remote_content.splitlines()),