Made "jsonpickle" an optional dependency. (#29)

Closes #28.

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

Co-authored-by: Michael Dolan <[email protected]>

Author: KelSolaar

.github/workflows/continuous-integration.yml

@@ -35,7 +35,7 @@ jobs:
       shell: bash
     - name: Install Package Dependencies
       run: |
-        poetry install --extras "graph"
+        poetry install --extras "optional"
       shell: bash
     - name: Lint with flake8
       run: |

docs/opencolorio_config_aces.utilities.rst

@@ -25,6 +25,7 @@ Common
     vivified_to_dict
     message_box
     is_colour_installed
+    is_jsonpickle_installed
     is_networkx_installed
     is_opencolorio_installed
     REQUIREMENTS_TO_CALLABLE

opencolorio_config_aces/config/generation/common.py

@@ -19,7 +19,6 @@
 -   :func:`opencolorio_config_aces.generate_config`
 """
 
-import jsonpickle
 import logging
 import re
 from collections import OrderedDict
@@ -498,6 +497,7 @@ class ConfigData:
     default_view_transform: str = field(default_factory=str)
 
 
+@required('jsonpickle')
 def deserialize_config_data(path):
     """
     Deserializes the *JSON* *OpenColorIO* config data container at given path.
@@ -513,11 +513,14 @@ def deserialize_config_data(path):
         Deserialized *JSON* *OpenColorIO* config data container.
     """
 
+    import jsonpickle
+
     with open(path) as config_json:
         return ConfigData(**jsonpickle.decode(config_json.read()))
 
 
 # TODO: Implement schema verification support for serialized data.
+@required('jsonpickle')
 def serialize_config_data(data, path):
     """
     Serializes the *OpenColorIO* config data container as a *JSON* file.
@@ -530,6 +533,8 @@ def serialize_config_data(data, path):
         *JSON* file path.
     """
 
+    import jsonpickle
+
     with open(path, 'w') as config_json:
         config_json.write(jsonpickle.encode(asdict(data), indent=2))
 

opencolorio_config_aces/utilities/__init__.py

@@ -1,16 +1,16 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright Contributors to the OpenColorIO Project.
 
-from .common import (DocstringDict, first_item, common_ancestor,
-                     paths_common_ancestor, vivification, vivified_to_dict,
-                     message_box, is_colour_installed, is_networkx_installed,
-                     is_opencolorio_installed, REQUIREMENTS_TO_CALLABLE,
-                     required, is_string, is_iterable, git_describe)
+from .common import (
+    DocstringDict, first_item, common_ancestor, paths_common_ancestor,
+    vivification, vivified_to_dict, message_box, is_colour_installed,
+    is_jsonpickle_installed, is_networkx_installed, is_opencolorio_installed,
+    REQUIREMENTS_TO_CALLABLE, required, is_string, is_iterable, git_describe)
 
 __all__ = [
     'DocstringDict', 'first_item', 'common_ancestor', 'paths_common_ancestor',
     'vivification', 'vivified_to_dict', 'message_box', 'is_colour_installed',
-    'is_networkx_installed', 'is_opencolorio_installed',
-    'REQUIREMENTS_TO_CALLABLE', 'required', 'is_string', 'is_iterable',
-    'git_describe'
+    'is_jsonpickle_installed', 'is_networkx_installed',
+    'is_opencolorio_installed', 'REQUIREMENTS_TO_CALLABLE', 'required',
+    'is_string', 'is_iterable', 'git_describe'
 ]

opencolorio_config_aces/utilities/common.py

@@ -24,9 +24,9 @@
 __all__ = [
     'DocstringDict', 'first_item', 'common_ancestor', 'paths_common_ancestor',
     'vivification', 'vivified_to_dict', 'message_box', 'is_colour_installed',
-    'is_networkx_installed', 'is_opencolorio_installed',
-    'REQUIREMENTS_TO_CALLABLE', 'required', 'is_string', 'is_iterable',
-    'git_describe'
+    'is_jsonpickle_installed', 'is_networkx_installed',
+    'is_opencolorio_installed', 'REQUIREMENTS_TO_CALLABLE', 'required',
+    'is_string', 'is_iterable', 'git_describe'
 ]
 
 
@@ -285,6 +285,38 @@ def is_colour_installed(raise_exception=False):
         return False
 
 
+def is_jsonpickle_installed(raise_exception=False):
+    """
+    Returns if *jsonpickle* is installed and available.
+
+    Parameters
+    ----------
+    raise_exception : bool
+        Raise exception if *jsonpickle* is unavailable.
+
+    Returns
+    -------
+    bool
+        Is *jsonpickle* installed.
+
+    Raises
+    ------
+    ImportError
+        If *jsonpickle* is not installed.
+    """
+
+    try:  # pragma: no cover
+        import jsonpickle  # noqa
+
+        return True
+    except ImportError as error:  # pragma: no cover
+        if raise_exception:
+            raise ImportError(
+                ('"jsonpickle" related API features, e.g. serialization, '
+                 'are not available: "{0}".').format(error))
+        return False
+
+
 def is_networkx_installed(raise_exception=False):
     """
     Returns if *NetworkX* is installed and available.
@@ -351,6 +383,8 @@ def is_opencolorio_installed(raise_exception=False):
 REQUIREMENTS_TO_CALLABLE = DocstringDict({
     'Colour':
     is_colour_installed,
+    'jsonpickle':
+    is_jsonpickle_installed,
     'NetworkX':
     is_networkx_installed,
     'OpenColorIO':
@@ -360,7 +394,7 @@ def is_opencolorio_installed(raise_exception=False):
 Mapping of requirements to their respective callables.
 
 _REQUIREMENTS_TO_CALLABLE : CaseInsensitiveMapping
-    **{'Colour', 'NetworkX', 'OpenImageIO'}**
+    **{'Colour', 'jsonpickle', 'NetworkX', 'OpenImageIO'}**
 """
 
 

pyproject.toml

@@ -19,13 +19,13 @@ keywords = [
 
 [tool.poetry.dependencies]
 python = "^3.7"
-jsonpickle = "^2.0.0"
 
 colour-science = { version = "^0.3.16", optional = true }
 coverage = { version = "*", optional = true }  # Development dependency.
 coveralls = { version = "*", optional = true }  # Development dependency.
 flake8 = { version = "*", optional = true }  # Development dependency.
 invoke = { version = "*", optional = true }  # Development dependency.
+jsonpickle = { version = "^2.0.0", optional = true }
 networkx = { version = "*", optional = true }
 nose = { version = "*", optional = true }  # Development dependency.
 pre-commit = { version = "*", optional = true }  # Development dependency.
@@ -66,8 +66,7 @@ development = [
     "twine",
     "yapf"
 ]
-colour = [ "colour-science" ]
-graph = [ "networkx" ]
+optional = [ "colour-science", "jsonpickle", "networkx" ]
 graphviz = [ "pygraphviz" ]
 
 [build-system]