Merge pull request #4063 from pypeclub/feature/publisher_common_cache_function

Publisher: Prepared common function for instance data cache

openpype/hosts/traypublisher/api/plugin.py

@@ -1,54 +1,32 @@
-import collections
-
 from openpype.lib.attribute_definitions import FileDef
+from openpype.lib.transcoding import IMAGE_EXTENSIONS, VIDEO_EXTENSIONS
 from openpype.pipeline.create import (
     Creator,
     HiddenCreator,
     CreatedInstance,
+    cache_and_get_instances,
     PRE_CREATE_THUMBNAIL_KEY,
 )
-
 from .pipeline import (
     list_instances,
     update_instances,
     remove_instances,
     HostContext,
 )
-from openpype.lib.transcoding import IMAGE_EXTENSIONS, VIDEO_EXTENSIONS
-
 
 REVIEW_EXTENSIONS = set(IMAGE_EXTENSIONS) | set(VIDEO_EXTENSIONS)
-
-
-def _cache_and_get_instances(creator):
-    """Cache instances in shared data.
-
-    Args:
-        creator (Creator): Plugin which would like to get instances from host.
-
-    Returns:
-        List[Dict[str, Any]]: Cached instances list from host implementation.
-    """
-
-    shared_key = "openpype.traypublisher.instances"
-    if shared_key not in creator.collection_shared_data:
-        instances_by_creator_id = collections.defaultdict(list)
-        for instance_data in list_instances():
-            creator_id = instance_data.get("creator_identifier")
-            instances_by_creator_id[creator_id].append(instance_data)
-        creator.collection_shared_data[shared_key] = instances_by_creator_id
-    return creator.collection_shared_data[shared_key]
+SHARED_DATA_KEY = "openpype.traypublisher.instances"
 
 
 class HiddenTrayPublishCreator(HiddenCreator):
     host_name = "traypublisher"
 
     def collect_instances(self):
-        instance_data_by_identifier = _cache_and_get_instances(self)
-        for instance_data in instance_data_by_identifier[self.identifier]:
-            instance = CreatedInstance.from_existing(
-                instance_data, self
-            )
+        instances_by_identifier = cache_and_get_instances(
+            self, SHARED_DATA_KEY, list_instances
+        )
+        for instance_data in instances_by_identifier[self.identifier]:
+            instance = CreatedInstance.from_existing(instance_data, self)
             self._add_instance_to_context(instance)
 
     def update_instances(self, update_list):
@@ -80,11 +58,11 @@ class TrayPublishCreator(Creator):
     host_name = "traypublisher"
 
     def collect_instances(self):
-        instance_data_by_identifier = _cache_and_get_instances(self)
-        for instance_data in instance_data_by_identifier[self.identifier]:
-            instance = CreatedInstance.from_existing(
-                instance_data, self
-            )
+        instances_by_identifier = cache_and_get_instances(
+            self, SHARED_DATA_KEY, list_instances
+        )
+        for instance_data in instances_by_identifier[self.identifier]:
+            instance = CreatedInstance.from_existing(instance_data, self)
             self._add_instance_to_context(instance)
 
     def update_instances(self, update_list):

openpype/pipeline/create/__init__.py

@@ -25,6 +25,8 @@ from .creator_plugins import (
     deregister_creator_plugin,
     register_creator_plugin_path,
     deregister_creator_plugin_path,
+
+    cache_and_get_instances,
 )
 
 from .context import (

openpype/pipeline/create/creator_plugins.py

@@ -1,5 +1,6 @@
 import os
 import copy
+import collections
 
 from abc import (
     ABCMeta,
@@ -674,3 +675,34 @@ def deregister_creator_plugin_path(path):
     deregister_plugin_path(BaseCreator, path)
     deregister_plugin_path(LegacyCreator, path)
     deregister_plugin_path(SubsetConvertorPlugin, path)
+
+
+def cache_and_get_instances(creator, shared_key, list_instances_func):
+    """Common approach to cache instances in shared data.
+
+    This is helper function which does not handle cases when a 'shared_key' is
+    used for different list instances functions. The same approach of caching
+    instances into 'collection_shared_data' is not required but is so common
+    we've decided to unify it to some degree.
+
+    Function 'list_instances_func' is called only if 'shared_key' is not
+    available in 'collection_shared_data' on creator.
+
+    Args:
+        creator (Creator): Plugin which would like to get instance data.
+        shared_key (str): Key under which output of function will be stored.
+        list_instances_func (Function): Function that will return instance data
+            if data were not yet stored under 'shared_key'.
+
+    Returns:
+        Dict[str, Dict[str, Any]]: Cached instances by creator identifier from
+            result of passed function.
+    """
+
+    if shared_key not in creator.collection_shared_data:
+        value = collections.defaultdict(list)
+        for instance in list_instances_func():
+            identifier = instance.get("creator_identifier")
+            value[identifier].append(instance)
+        creator.collection_shared_data[shared_key] = value
+    return creator.collection_shared_data[shared_key]