PR: Minor Improvements (#32)

* Update naming of various private attributes for better introspection.

Signed-off-by: Thomas Mansencal <[email protected]>

* Move "opencolorio_config_aces.clf.matrix_3x3_to_4x4" definition to "opencolorio_config_aces.utilities" sub-package.

Signed-off-by: Thomas Mansencal <[email protected]>

* Add "opencolorio_config_aces.utilities.multi_replace" definition.

Signed-off-by: Thomas Mansencal <[email protected]>

Author: KelSolaar

docs/opencolorio_config_aces.utilities.rst

@@ -33,3 +33,5 @@ Common
     is_string
     is_iterable
     git_describe
+    matrix_3x3_to_4x4
+    multi_replace

opencolorio_config_aces/clf/__init__.py

@@ -5,10 +5,10 @@
                        unclassify_clf_transforms, filter_clf_transforms,
                        print_clf_taxonomy)
 
-from .transforms import matrix_3x3_to_4x4, generate_clf
+from .transforms import generate_clf
 
 __all__ = [
     'discover_clf_transforms', 'classify_clf_transforms',
     'unclassify_clf_transforms', 'filter_clf_transforms', 'print_clf_taxonomy'
 ]
-__all__ += ['matrix_3x3_to_4x4', 'generate_clf']
+__all__ += ['generate_clf']

opencolorio_config_aces/clf/discover/classify.py

@@ -33,104 +33,104 @@
 __status__ = 'Production'
 
 __all__ = [
-    'CLF_URN', 'CLF_URN_SEPARATOR', 'CLF_ID_SEPARATOR', 'CLF_NAMESPACE',
-    'CLF_TYPES', 'CLF_TRANSFORMS_ROOT', 'CLF_TRANSFORM_FAMILIES',
-    'DEFAULT_CLF_TRANSFORM_GENUS', 'DEFAULT_CLF_TRANSFORM_FILTERERS',
-    'DESCRIPTION_SUBSTITUTION_PATTERNS', 'clf_transform_relative_path',
-    'CLFTransformID', 'CLFTransform', 'CLFTransformPair',
-    'find_clf_transform_pairs', 'discover_clf_transforms',
+    'URN_CLF', 'SEPARATOR_URN_CLF', 'SEPARATOR_ID_CLF', 'NAMESPACE_CLF',
+    'TRANSFORM_TYPES_CLF', 'TRANSFORM_FAMILIES_CLF',
+    'TRANSFORM_GENUS_DEFAULT_CLF', 'TRANSFORM_FILTERERS_DEFAULT_CLF',
+    'PATTERNS_DESCRIPTION_CLF', 'ROOT_TRANSFORMS_CLF',
+    'clf_transform_relative_path', 'CLFTransformID', 'CLFTransform',
+    'CLFTransformPair', 'find_clf_transform_pairs', 'discover_clf_transforms',
     'classify_clf_transforms', 'unclassify_clf_transforms',
     'filter_clf_transforms', 'print_clf_taxonomy'
 ]
 
-CLF_URN = 'urn:aswf:ocio:transformId:v1.0'
+URN_CLF = 'urn:aswf:ocio:transformId:v1.0'
 """
 *CLF* Uniform Resource Name (*URN*).
 
-CLF_URN : unicode
+URN_CLF : unicode
 """
 
-CLF_URN_SEPARATOR = ':'
+SEPARATOR_URN_CLF = ':'
 """
 *CLFtransformID* separator used to separate the *URN* and *ID* part of the
 *CLFtransformID*.
 
-CLF_URN_SEPARATOR : unicode
+SEPARATOR_URN_CLF : unicode
 """
 
-CLF_ID_SEPARATOR = '.'
+SEPARATOR_ID_CLF = '.'
 """
 *CLFtransformID* separator used to tokenize the *ID* part of the
 *CLFtransformID*.
 
 urn:aswf:ocio:transformId:v1.0:ACES.OCIO.AP0_to_AP1-Gamma2pnt2.c1.v1
 |-------------URN------------|:|-----------------ID----------------|
 
-CLF_ID_SEPARATOR : unicode
+SEPARATOR_ID_CLF : unicode
 """
 
-CLF_NAMESPACE = 'OCIO'
+NAMESPACE_CLF = 'OCIO'
 """
 *ACES* namespace for the *OCIO* *CLF* transforms.
 
-CLF_NAMESPACE : unicode
+NAMESPACE_CLF : unicode
 """
 
-CLF_TYPES = [
+TRANSFORM_TYPES_CLF = [
     'ACES',
     'Common',
 ]
 """
 *CLF* transform types.
 
-CLF_TYPES : list
+TRANSFORM_TYPES_CLF : list
 """
 
-CLF_TRANSFORMS_ROOT = os.path.normpath(
-    os.environ.get(
-        'OPENCOLORIO_CONFIG_ACES__CLF_TRANSFORMS_ROOT',
-        os.path.join(
-            os.path.dirname(__file__), '..', 'transforms', 'builtins')))
+TRANSFORM_FAMILIES_CLF = {'aces': 'aces'}
 """
-*CLF* transforms root directory, default to the version controlled
-sub-module repository. It can be defined by setting the
-`OPENCOLORIO_CONFIG_ACES__CLF_TRANSFORMS_ROOT` environment variable with
-the local 'transforms/clf' directory.
+*CLF* transform families mapping the *CLF* transform directories to family
+names.
 
-CLF_TRANSFORMS_ROOT : unicode
+TRANSFORM_FAMILIES_CLF : dict
 """
 
-CLF_TRANSFORM_FAMILIES = {'aces': 'aces'}
+TRANSFORM_GENUS_DEFAULT_CLF = 'undefined'
 """
-*CLF* transform families mapping the *CLF* transform directories to family
-names.
+*CLF* transform default genus, i.e. *undefined*.
 
-CLF_TRANSFORM_FAMILIES : dict
+TRANSFORM_GENUS_DEFAULT_CLF : unicode
 """
 
-DEFAULT_CLF_TRANSFORM_GENUS = 'undefined'
+TRANSFORM_FILTERERS_DEFAULT_CLF = []
 """
-*CLF* transform default genus, i.e. *undefined*.
+Default list of *CLF* transform filterers.
 
-DEFAULT_CLF_TRANSFORM_GENUS : unicode
+TRANSFORM_FILTERERS_DEFAULT_CLF : list
 """
 
-DESCRIPTION_SUBSTITUTION_PATTERNS = {}
+PATTERNS_DESCRIPTION_CLF = {}
 """
 *CLF* transform description substitution patterns.
 
-DESCRIPTION_SUBSTITUTION_PATTERNS : dict
+PATTERNS_DESCRIPTION_CLF : dict
 """
 
-DEFAULT_CLF_TRANSFORM_FILTERERS = []
+ROOT_TRANSFORMS_CLF = os.path.normpath(
+    os.environ.get(
+        'OPENCOLORIO_CONFIG_ACES__CLF_TRANSFORMS_ROOT',
+        os.path.join(
+            os.path.dirname(__file__), '..', 'transforms', 'builtins')))
 """
-Default list of *CLF* transform filterers.
+*CLF* transforms root directory, default to the version controlled
+sub-module repository. It can be defined by setting the
+`OPENCOLORIO_CONFIG_ACES__CLF_TRANSFORMS_ROOT` environment variable with
+the local 'transforms/clf' directory.
 
-DEFAULT_CLF_TRANSFORM_FILTERERS : list
+ROOT_TRANSFORMS_CLF : unicode
 """
 
 
-def clf_transform_relative_path(path, root_directory=CLF_TRANSFORMS_ROOT):
+def clf_transform_relative_path(path, root_directory=ROOT_TRANSFORMS_CLF):
     """
     Helper definition returning the relative path from given *CLF* transform to
     *CLF* transforms root directory.
@@ -457,11 +457,11 @@ def _parse(self):
 
         clf_transform_id = self._clf_transform_id
 
-        self._urn, components = clf_transform_id.rsplit(CLF_URN_SEPARATOR, 1)
-        components = components.split(CLF_ID_SEPARATOR)
+        self._urn, components = clf_transform_id.rsplit(SEPARATOR_URN_CLF, 1)
+        components = components.split(SEPARATOR_ID_CLF)
         self._type, components = components[0], components[1:]
 
-        assert self._urn == CLF_URN, (
+        assert self._urn == URN_CLF, (
             f'{self._clf_transform_id} URN {self._urn} is invalid!')
 
         assert len(components) in (4, 5), (
@@ -475,7 +475,7 @@ def _parse(self):
              self._minor_version_number,
              self._patch_version_number) = components
 
-        assert self._type in CLF_TYPES, (
+        assert self._type in TRANSFORM_TYPES_CLF, (
             f'{self._clf_transform_id} type {self._type} is invalid!')
 
         if self._name is not None:
@@ -647,7 +647,7 @@ def family(self):
         Getter and setter property for the *CLF* transform family, e.g.
         *aces*, a value in
         :attr:`opencolorio_config_aces.clf.reference.\
-CLF_TRANSFORM_FAMILIES` attribute dictionary.
+TRANSFORM_FAMILIES_CLF` attribute dictionary.
 
         Parameters
         ----------
@@ -986,7 +986,7 @@ def stem(path):
     return clf_transform_pairs
 
 
-def discover_clf_transforms(root_directory=CLF_TRANSFORMS_ROOT):
+def discover_clf_transforms(root_directory=ROOT_TRANSFORMS_CLF):
     """
     Discovers the *CLF* transform paths in given root directory: The given
     directory is traversed and the `*.clf` files are collected.
@@ -1090,11 +1090,11 @@ def classify_clf_transforms(unclassified_clf_transforms):
     for directory, clf_transforms in unclassified_clf_transforms.items():
         sub_directory = directory.replace(f'{root_directory}{os.sep}', '')
         family, *genus = [
-            CLF_TRANSFORM_FAMILIES.get(part, part)
+            TRANSFORM_FAMILIES_CLF.get(part, part)
             for part in sub_directory.split(os.sep)
         ]
 
-        genus = DEFAULT_CLF_TRANSFORM_GENUS if not genus else '/'.join(genus)
+        genus = TRANSFORM_GENUS_DEFAULT_CLF if not genus else '/'.join(genus)
 
         for basename, pairs in find_clf_transform_pairs(
                 clf_transforms).items():
@@ -1208,7 +1208,7 @@ def filter_clf_transforms(clf_transforms, filterers=None):
     """
 
     if filterers is None:
-        filterers = DEFAULT_CLF_TRANSFORM_FILTERERS
+        filterers = TRANSFORM_FILTERERS_DEFAULT_CLF
 
     if isinstance(clf_transforms, Mapping):
         clf_transforms = unclassify_clf_transforms(clf_transforms)
@@ -1231,7 +1231,7 @@ def print_clf_taxonomy():
 
     -   The *CLF* transforms are discovered by traversing the directory defined
     by the :attr:`opencolorio_config_aces.clf.\
-reference.CLF_TRANSFORMS_ROOT` attribute using the
+reference.ROOT_TRANSFORMS_CLF` attribute using the
         :func:`opencolorio_config_aces.discover_clf_transforms` definition.
     -   The *CLF* transforms are classified by *family* e.g. *aces*, and
         *genus* e.g. *undefined* using the

opencolorio_config_aces/clf/transforms/__init__.py

@@ -1,6 +1,6 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright Contributors to the OpenColorIO Project.
 
-from .common import matrix_3x3_to_4x4, generate_clf
+from .common import generate_clf
 
-__all__ = ['matrix_3x3_to_4x4', 'generate_clf']
+__all__ = ['generate_clf']

opencolorio_config_aces/clf/transforms/aces.py

@@ -11,9 +11,9 @@
 import logging
 from pathlib import Path
 
-from opencolorio_config_aces.clf import generate_clf, matrix_3x3_to_4x4
+from opencolorio_config_aces.clf import generate_clf
 from opencolorio_config_aces.config.generation import transform_factory
-from opencolorio_config_aces.utilities import required
+from opencolorio_config_aces.utilities import matrix_3x3_to_4x4, required
 
 __author__ = 'OpenColorIO Contributors'
 __copyright__ = 'Copyright Contributors to the OpenColorIO Project.'
@@ -159,7 +159,7 @@ def generate_clf_aces(directory):
     logging.getLogger().setLevel(logging.INFO)
 
     build_directory = os.path.join(
-        opencolorio_config_aces.clf.discover.classify.CLF_TRANSFORMS_ROOT,
+        opencolorio_config_aces.clf.discover.classify.ROOT_TRANSFORMS_CLF,
         'aces')
 
     if os.path.exists(build_directory):

opencolorio_config_aces/clf/transforms/common.py

@@ -25,20 +25,7 @@
 __email__ = '[email protected]'
 __status__ = 'Production'
 
-__all__ = ['matrix_3x3_to_4x4', 'generate_clf', 'generate_clf_common']
-
-
-def matrix_3x3_to_4x4(M):
-    """
-    Converts given 3x3 matrix :math:`M` to a raveled 4x4 matrix.
-    """
-
-    import numpy as np
-
-    M_I = np.identity(4)
-    M_I[:3, :3] = M
-
-    return np.ravel(M_I).tolist()
+__all__ = ['generate_clf', 'generate_clf_common']
 
 
 @required('OpenColorIO')
@@ -176,7 +163,7 @@ def generate_clf_common(directory):
         description='Conversion from sRGB gamut to ACES2065-1 gamut.')
 
     build_directory = os.path.join(
-        opencolorio_config_aces.clf.discover.classify.CLF_TRANSFORMS_ROOT,
+        opencolorio_config_aces.clf.discover.classify.ROOT_TRANSFORMS_CLF,
         'common')
 
     if os.path.exists(build_directory):

opencolorio_config_aces/config/cg/generate/config.py

@@ -34,11 +34,11 @@
 __status__ = 'Production'
 
 __all__ = [
-    'ACES_CONFIG_CG_MAPPING_FILE_PATH', 'clf_transform_to_description',
+    'PATH_TRANSFORMS_MAPPING_FILE_CG', 'clf_transform_to_description',
     'clf_transform_to_colorspace', 'generate_config_cg'
 ]
 
-ACES_CONFIG_CG_MAPPING_FILE_PATH = (
+PATH_TRANSFORMS_MAPPING_FILE_CG = (
     Path(__file__).parents[0] / 'resources' /
     'OpenColorIO-Config-ACES _CG_ Transforms - CG Config - Mapping.csv')
 """
@@ -146,7 +146,7 @@ def generate_config_cg(
         config_name=None,
         validate=True,
         describe=ColorspaceDescriptionStyle.SHORT_UNION,
-        config_mapping_file_path=ACES_CONFIG_CG_MAPPING_FILE_PATH,
+        config_mapping_file_path=PATH_TRANSFORMS_MAPPING_FILE_CG,
         additional_data=False):
     """
     Generates the *ACES* Computer Graphics (CG) *OpenColorIO* config.

opencolorio_config_aces/config/generation/common.py

@@ -37,18 +37,18 @@
 __status__ = 'Production'
 
 __all__ = [
-    'LOG_ALLOCATION_VARS', 'produce_transform', 'transform_factory',
+    'ALLOCATION_VARS_LOG', 'produce_transform', 'transform_factory',
     'group_transform_factory', 'colorspace_factory', 'named_transform_factory',
     'view_transform_factory', 'look_factory', 'ConfigData',
     'deserialize_config_data', 'serialize_config_data', 'validate_config',
     'generate_config'
 ]
 
-LOG_ALLOCATION_VARS = (-8, 5, 2**-8)
+ALLOCATION_VARS_LOG = (-8, 5, 2**-8)
 """
 Allocation variables for logarithmic data representation.
 
-LOG_ALLOCATION_VARS : tuple
+ALLOCATION_VARS_LOG : tuple
 """