return missing commits from previous 2.x/develop merge

pype/lib/__init__.py

@@ -56,7 +56,11 @@ from .plugin_tools import (
     filter_pyblish_plugins,
     source_hash,
     get_unique_layer_name,
-    get_background_layers
+    get_background_layers,
+    oiio_supported,
+    decompress,
+    get_decompress_dir,
+    should_decompress
 )
 
 from .user_settings import (
@@ -108,6 +112,10 @@ __all__ = [
     "source_hash",
     "get_unique_layer_name",
     "get_background_layers",
+    "oiio_supported",
+    "decompress",
+    "get_decompress_dir",
+    "should_decompress",
 
     "version_up",
     "get_version_from_path",

pype/lib/plugin_tools.py

@@ -5,6 +5,8 @@ import inspect
 import logging
 import re
 import json
+import pype.api
+import tempfile
 
 from pype.settings import get_project_settings
 
@@ -134,3 +136,115 @@ def get_background_layers(file_url):
                                                layer.get("filename")).
                                   replace("\\", "/"))
     return layers
+
+
+def oiio_supported():
+    """
+        Checks if oiiotool is configured for this platform.
+
+        Expects full path to executable.
+
+        'should_decompress' will throw exception if configured,
+        but not present or not working.
+        Returns:
+            (bool)
+    """
+    oiio_path = os.getenv("PYPE_OIIO_PATH", "")
+    if not oiio_path or not os.path.exists(oiio_path):
+        log.debug("OIIOTool is not configured or not present at {}".
+                  format(oiio_path))
+        return False
+
+    return True
+
+
+def decompress(target_dir, file_url,
+               input_frame_start=None, input_frame_end=None, log=None):
+    """
+        Decompresses DWAA 'file_url' .exr to 'target_dir'.
+
+        Creates uncompressed files in 'target_dir', they need to be cleaned.
+
+        File url could be for single file or for a sequence, in that case
+        %0Xd will be as a placeholder for frame number AND input_frame* will
+        be filled.
+        In that case single oiio command with '--frames' will be triggered for
+        all frames, this should be faster then looping and running sequentially
+
+        Args:
+            target_dir (str): extended from stagingDir
+            file_url (str): full urls to source file (with or without %0Xd)
+            input_frame_start (int) (optional): first frame
+            input_frame_end (int) (optional): last frame
+            log (Logger) (optional): pype logger
+    """
+    is_sequence = input_frame_start is not None and \
+        input_frame_end is not None and \
+        (int(input_frame_end) > int(input_frame_start))
+
+    oiio_cmd = []
+    oiio_cmd.append(os.getenv("PYPE_OIIO_PATH"))
+
+    oiio_cmd.append("--compression none")
+
+    base_file_name = os.path.basename(file_url)
+    oiio_cmd.append(file_url)
+
+    if is_sequence:
+        oiio_cmd.append("--frames {}-{}".format(input_frame_start,
+                                                input_frame_end))
+
+    oiio_cmd.append("-o")
+    oiio_cmd.append(os.path.join(target_dir, base_file_name))
+
+    subprocess_exr = " ".join(oiio_cmd)
+
+    if not log:
+        log = logging.getLogger(__name__)
+
+    log.debug("Decompressing {}".format(subprocess_exr))
+    pype.api.subprocess(
+        subprocess_exr, shell=True, logger=log
+    )
+
+
+def get_decompress_dir():
+    """
+        Creates temporary folder for decompressing.
+        Its local, in case of farm it is 'local' to the farm machine.
+
+        Should be much faster, needs to be cleaned up later.
+    """
+    return os.path.normpath(
+        tempfile.mkdtemp(prefix="pyblish_tmp_")
+    )
+
+
+def should_decompress(file_url):
+    """
+        Tests that 'file_url' is compressed with DWAA.
+
+        Uses 'oiio_supported' to check that OIIO tool is available for this
+        platform.
+
+        Shouldn't throw exception as oiiotool is guarded by check function.
+        Currently implemented this way as there is no support for Mac and Linux
+        In the future, it should be more strict and throws exception on
+        misconfiguration.
+
+        Args:
+            file_url (str): path to rendered file (in sequence it would be
+                first file, if that compressed it is expected that whole seq
+                will be too)
+        Returns:
+            (bool): 'file_url' is DWAA compressed and should be decompressed
+                and we can decompress (oiiotool supported)
+    """
+    if oiio_supported():
+        output = pype.api.subprocess([
+            os.getenv("PYPE_OIIO_PATH"),
+            "--info", "-v", file_url])
+        return "compression: \"dwaa\"" in output or \
+            "compression: \"dwab\"" in output
+
+    return False