Global: supporting OPENPYPE_TMPDIR in staging dir maker

openpype/hosts/flame/plugins/publish/extract_subset_resources.py

@@ -548,30 +548,3 @@ def import_clip(self, path):
                 "Path `{}` is containing more that one clip".format(path)
             )
         return clips[0]
-
-    def staging_dir(self, instance):
-        """Provide a temporary directory in which to store extracted files
-
-        Upon calling this method the staging directory is stored inside
-        the instance.data['stagingDir']
-        """
-        staging_dir = instance.data.get('stagingDir', None)
-        openpype_temp_dir = os.getenv("OPENPYPE_TEMP_DIR")
-
-        if not staging_dir:
-            if openpype_temp_dir and os.path.exists(openpype_temp_dir):
-                staging_dir = os.path.normpath(
-                    tempfile.mkdtemp(
-                        prefix="pyblish_tmp_",
-                        dir=openpype_temp_dir
-                    )
-                )
-            else:
-                staging_dir = os.path.normpath(
-                    tempfile.mkdtemp(prefix="pyblish_tmp_")
-                )
-            instance.data['stagingDir'] = staging_dir
-
-        instance.context.data["cleanupFullPaths"].append(staging_dir)
-
-        return staging_dir

openpype/pipeline/publish/lib.py

@@ -10,7 +10,11 @@
 import pyblish.plugin
 import pyblish.api
 
-from openpype.lib import Logger, filter_profiles
+from openpype.lib import (
+    Logger,
+    filter_profiles,
+    StringTemplate
+)
 from openpype.settings import (
     get_project_settings,
     get_system_settings,
@@ -609,8 +613,22 @@ def context_plugin_should_run(plugin, context):
 def get_instance_staging_dir(instance):
     """Unified way how staging dir is stored and created on instances.
 
-    First check if 'stagingDir' is already set in instance data. If there is
-    not create new in tempdir.
+    First check if 'stagingDir' is already set in instance data.
+    In case there already is new tempdir will not be created.
+
+    It also supports `OPENPYPE_TEMP_DIR`, so studio can define own temp
+    shared repository per project or even per more granular context.
+    Template formating is supported also with optional keys. Folder is
+    created in case it doesnt exists.
+
+    Available anatomy formatting keys:
+        - root[work | <root name key>]
+        - project[name | code]
+        - asset
+        - hierarchy
+        - task
+        - username
+        - app
 
     Note:
         Staging dir does not have to be necessarily in tempdir so be carefull
@@ -623,12 +641,58 @@ def get_instance_staging_dir(instance):
     Returns:
         str: Path to staging dir of instance.
     """
+    staging_dir = instance.data.get('stagingDir')
+    if staging_dir:
+        return staging_dir
+
+    openpype_temp_dir = os.getenv("OPENPYPE_TEMP_DIR")
+    custom_temp_dir = None
+    if openpype_temp_dir:
+        if "{" in openpype_temp_dir:
+            custom_temp_dir = _formated_staging_dir(
+                instance, openpype_temp_dir
+            )
+        elif os.path.exists(openpype_temp_dir):
+            custom_temp_dir = openpype_temp_dir
 
-    staging_dir = instance.data.get("stagingDir")
-    if not staging_dir:
+
+    if custom_temp_dir:
+        staging_dir = os.path.normpath(
+            tempfile.mkdtemp(
+                prefix="pyblish_tmp_",
+                dir=custom_temp_dir
+            )
+        )
+    else:
         staging_dir = os.path.normpath(
             tempfile.mkdtemp(prefix="pyblish_tmp_")
         )
-        instance.data["stagingDir"] = staging_dir
+    instance.data['stagingDir'] = staging_dir
+
+    instance.context.data["cleanupFullPaths"].append(staging_dir)
 
     return staging_dir
+
+
+def _formated_staging_dir(instance, openpype_temp_dir):
+    anatomy = instance.context.data["anatomy"]
+    # get anatomy formating data
+    # so template formating is supported
+    anatomy_data = copy.deepcopy(instance.context.data["anatomyData"])
+    anatomy_data["root"] = anatomy.roots
+    """Template path formatting is supporting:
+            - optional key formating
+            - available keys:
+                - root[work | <root name key>]
+                - project[name | code]
+                - asset
+                - hierarchy
+                - task
+                - username
+                - app
+            """
+    result = StringTemplate.format_template(openpype_temp_dir, anatomy_data)
+    result = os.path.normpath(result)
+            # create the dir in case it doesnt exists
+    os.makedirs(os.path.dirname(result))
+    return result