SG-43459 Migrate Build scene/template workflows

app.py

@@ -12,6 +12,8 @@
 A loader application that lets you add new items to the scene.
 """
 
+from types import ModuleType
+
 import sgtk
 import os
 
@@ -28,6 +30,7 @@ def init_app(self):
             return
 
         tk_multi_loader = self.import_module("tk_multi_loader")
+        self._flowam = tk_multi_loader.flowam
 
         # the manager class provides the interface for loading. We store a
         # reference to it to enable the create_loader_action_manager method exposed on
@@ -95,3 +98,15 @@ def create_loader_manager(self, bundle=None):
         :returns: A :class:`tk_multi_loader.LoaderManager` instance
         """
         return self._manager_class(bundle or self)
+
+    @property
+    def flowam(self) -> ModuleType:
+        """
+        Access to the FlowAM integration module for this app. This module provides
+        drop-in replacements for the standard Shotgun-based Loader models and actions,
+        backed by Flow Asset Management (FlowAM) instead of the ShotGrid REST API.
+
+        :returns: The FlowAM integration module for this app
+        :rtype: :mod:`tk_multi_loader.flowam`
+        """
+        return self._flowam

azure-pipelines.yml

@@ -46,3 +46,4 @@ jobs:
     - name: tk-framework-qtwidgets
     - name: tk-framework-shotgunutils
     - name: tk-shell
+    tk_core_ref: ticket/sg-43461/migrate-host-base

hooks/tk-3dsmaxplus_actions.py

@@ -24,7 +24,7 @@ class MaxActions(HookBaseClass):
     ##############################################################################################################
     # public interface - to be overridden by deriving classes
 
-    def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
+    def generate_actions(self, sg_publish_data, actions, ui_area):
         """
         Returns a list of action instances for a particular publish.
         This method is called each time a user clicks a publish somewhere in the UI.
@@ -101,7 +101,7 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
 
         return action_instances
 
-    def execute_multiple_actions(self, actions, **kwargs):
+    def execute_multiple_actions(self, actions):
         """
         Executes the specified action on a list of items.
 
@@ -132,7 +132,7 @@ def execute_multiple_actions(self, actions, **kwargs):
             params = single_action["params"]
             self.execute_action(name, params, sg_publish_data)
 
-    def execute_action(self, name, params, sg_publish_data, **kwargs):
+    def execute_action(self, name, params, sg_publish_data):
         """
         Execute a given action. The data sent to this be method will
         represent one of the actions enumerated by the generate_actions method.

hooks/tk-desktop_actions.py

@@ -31,7 +31,6 @@ def generate_actions(
         sg_publish_data: dict,
         actions: list,
         ui_area: str,
-        **kwargs,
     ) -> list:
         """
         Return a list of action instances for a particular publish.
@@ -77,21 +76,15 @@ def generate_actions(
 
         action_instances = []
 
-        enable_flowam = app.get_setting("enable_flowam", False)
-        if enable_flowam:
-            am_base_obj = kwargs.get("am_base_obj")
-            if not am_base_obj:
-                raise Exception(
-                    "FlowAM is enabled but no Asset Management base object was passed to the action hook. "
-                    "FlowAM specific actions will not be generated."
-                )
+        if app.context.flow_project_id:
+            flowam_actions = app.flowam.FlowAMActions()
 
             if "download" in actions and sg_publish_data.get("type") == "PublishedFile":
                 version_number = sg_publish_data.get("version_number")
 
                 if (
                     version_number is not None
-                    and version_number != am_base_obj.DRAFT_VERSION_IDENTIFIER
+                    and version_number != flowam_actions.DRAFT_VERSION_IDENTIFIER
                 ):
                     action_instances.append(
                         {
@@ -130,9 +123,9 @@ def generate_actions(
             if (
                 "reference_copy_link" in actions
                 and sg_publish_data.get(
-                    "version_number", am_base_obj.DRAFT_VERSION_IDENTIFIER
+                    "version_number", flowam_actions.DRAFT_VERSION_IDENTIFIER
                 )
-                > am_base_obj.DRAFT_VERSION_IDENTIFIER
+                > flowam_actions.DRAFT_VERSION_IDENTIFIER
             ):
                 action_instances.append(
                     {
@@ -146,7 +139,7 @@ def generate_actions(
 
         return action_instances
 
-    def execute_multiple_actions(self, actions: list, **kwargs) -> None:
+    def execute_multiple_actions(self, actions: list) -> None:
         """
         Executes the specified action on a list of items.
 
@@ -171,22 +164,19 @@ def execute_multiple_actions(self, actions: list, **kwargs) -> None:
 
         :param list actions: Action dictionaries.
         """
-        app = self.parent
-        app.log_info("Executing action '%s' on the selection")
         # Helps to visually scope selections
         # Execute each action.
         for single_action in actions:
             name = single_action["name"]
             sg_publish_data = single_action["sg_publish_data"]
             params = single_action["params"]
-            self.execute_action(name, params, sg_publish_data, **kwargs)
+            self.execute_action(name, params, sg_publish_data)
 
     def execute_action(
         self,
         name: str,
         params: Any,
         sg_publish_data: dict,
-        **kwargs,
     ) -> None:
         """
         Print out all actions. The data sent to this be method will
@@ -202,7 +192,7 @@ def execute_action(
             "Execute action called for action %s. "
             "Parameters: %s. Publish Data: %s" % (name, params, sg_publish_data)
         )
-        am_base_obj = kwargs.get("am_base_obj")
+        flowam_actions = app.flowam.FlowAMActions()
 
         if name == "create_generic_asset":
             # Right click a task the left panel
@@ -213,10 +203,10 @@ def execute_action(
             self._launch_publisher(name, sg_publish_data)
 
         elif name == "reference_copy_link":
-            am_base_obj._create_reference_copy_link(sg_publish_data)
+            flowam_actions._create_reference_copy_link(sg_publish_data)
 
         elif name == "download":
-            am_base_obj._download_asset_revision(sg_publish_data)
+            flowam_actions._download_asset_revision(sg_publish_data)
 
     def _launch_publisher(self, action_name: str, sg_publish_data: dict) -> None:
         """

hooks/tk-flame_actions.py

@@ -44,7 +44,7 @@ class FlameActionError(Exception):
 class FlameActions(HookBaseClass):
     ##############################################################################################################
     # public interface - to be overridden by deriving classes
-    def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
+    def generate_actions(self, sg_publish_data, actions, ui_area):
         """
         Returns a list of action instances for a particular publish.
         This method is called each time a user clicks a publish somewhere in the UI.
@@ -136,7 +136,7 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
 
         return action_instances
 
-    def execute_multiple_actions(self, actions, **kwargs):
+    def execute_multiple_actions(self, actions):
         """
         Executes the specified action on a list of items.
 
@@ -167,7 +167,7 @@ def execute_multiple_actions(self, actions, **kwargs):
             params = single_action["params"]
             self.execute_action(name, params, sg_publish_data)
 
-    def execute_action(self, name, params, sg_publish_data, **kwargs):
+    def execute_action(self, name, params, sg_publish_data):
         """
         Execute a given action. The data sent to this be method will
         represent one of the actions enumerated by the generate_actions method.

hooks/tk-houdini_actions.py

@@ -16,6 +16,7 @@
 import re
 
 import sgtk
+from tank_vendor.flow_integration_sdk.sandbox import is_new_asset
 
 HookBaseClass = sgtk.get_hook_baseclass()
 
@@ -25,7 +26,7 @@ class HoudiniActions(HookBaseClass):
     ##############################################################################################################
     # public interface - to be overridden by deriving classes
 
-    def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
+    def generate_actions(self, sg_publish_data, actions, ui_area):
         """
         Returns a list of action instances for a particular publish.
         This method is called each time a user clicks a publish somewhere in the UI.
@@ -102,22 +103,18 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
         # -----------------------
         # FlowAM specific actions
         # -----------------------
-        enable_flowam = app.get_setting("enable_flowam", False)
-        if enable_flowam:
-            am_base_obj = kwargs.get("am_base_obj")
-            if not am_base_obj:
-                raise Exception(
-                    "FlowAM is enabled but no Asset Management base object was passed to the action hook. "
-                    "FlowAM specific actions will not be generated."
-                )
+        if self.parent.context.flow_project_id:
+            flowam_actions = app.flowam.FlowAMActions()
 
             if "open" in actions and sg_publish_data.get("type") == "PublishedFile":
                 if (
-                    am_base_obj._is_local_draft(sg_publish_data)
+                    flowam_actions.is_local_draft_by_revision(
+                        sg_publish_data.get("sg_flow_revision_id")
+                    )
                     or sg_publish_data.get(
-                        "version_number", am_base_obj.DRAFT_VERSION_IDENTIFIER
+                        "version_number", flowam_actions.DRAFT_VERSION_IDENTIFIER
                     )
-                    > am_base_obj.DRAFT_VERSION_IDENTIFIER
+                    > flowam_actions.DRAFT_VERSION_IDENTIFIER
                 ):
                     action_instances.append(
                         {
@@ -134,7 +131,7 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
 
                 if (
                     version_number is not None
-                    and version_number != am_base_obj.DRAFT_VERSION_IDENTIFIER
+                    and version_number != flowam_actions.DRAFT_VERSION_IDENTIFIER
                 ):
                     action_instances.append(
                         {
@@ -148,9 +145,9 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
             if "discard_draft" in actions:
                 draft_id = sg_publish_data.get("sg_flow_revision_id")
 
-                if am_base_obj._is_local_draft(
-                    sg_publish_data
-                ) and am_base_obj._is_new_asset(draft_id):
+                if flowam_actions.is_local_draft_by_revision(
+                    sg_publish_data.get("sg_flow_revision_id")
+                ) and is_new_asset(draft_id):
                     action_instances.append(
                         {
                             "name": "discard_draft",
@@ -163,9 +160,9 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
             if (
                 "reference_copy_link" in actions
                 and sg_publish_data.get(
-                    "version_number", am_base_obj.DRAFT_VERSION_IDENTIFIER
+                    "version_number", flowam_actions.DRAFT_VERSION_IDENTIFIER
                 )
-                != am_base_obj.DRAFT_VERSION_IDENTIFIER
+                != flowam_actions.DRAFT_VERSION_IDENTIFIER
             ):
                 action_instances.append(
                     {
@@ -199,7 +196,7 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
 
         return action_instances
 
-    def execute_multiple_actions(self, actions, **kwargs):
+    def execute_multiple_actions(self, actions):
         """
         Executes the specified action on a list of items.
 
@@ -228,9 +225,9 @@ def execute_multiple_actions(self, actions, **kwargs):
             name = single_action["name"]
             sg_publish_data = single_action["sg_publish_data"]
             params = single_action["params"]
-            self.execute_action(name, params, sg_publish_data, **kwargs)
+            self.execute_action(name, params, sg_publish_data)
 
-    def execute_action(self, name, params, sg_publish_data, **kwargs):
+    def execute_action(self, name, params, sg_publish_data):
         """
         Execute a given action. The data sent to this be method will
         represent one of the actions enumerated by the generate_actions method.
@@ -249,27 +246,26 @@ def execute_action(self, name, params, sg_publish_data, **kwargs):
         # -----------------------
         # FlowAM specific actions
         # -----------------------
-        enable_flowam = app.get_setting("enable_flowam", False)
-        if enable_flowam:
-            am_base_obj = kwargs.get("am_base_obj")
+        if self.parent.context.flow_project_id:
+            flowam_actions = app.flowam.FlowAMActions()
 
             if name == "open":
-                am_base_obj._do_open(sg_publish_data)
+                flowam_actions._do_open(sg_publish_data)
 
             if name == "reference_copy_link":
-                am_base_obj._create_reference_copy_link(sg_publish_data)
+                flowam_actions._create_reference_copy_link(sg_publish_data)
 
             if name == "discard_draft":
-                am_base_obj._discard_draft(sg_publish_data)
+                flowam_actions._discard_draft(sg_publish_data)
 
             if name == "build_new_scene":
-                am_base_obj._build_new_scene(sg_publish_data)
+                flowam_actions._build_new_scene(sg_publish_data)
 
             if name == "build_new_template":
-                am_base_obj._build_new_template(sg_publish_data)
+                flowam_actions._build_new_template(sg_publish_data)
 
             if name == "download":
-                am_base_obj._download_asset_revision(sg_publish_data)
+                flowam_actions._download_asset_revision(sg_publish_data)
 
             return
 

hooks/tk-mari_actions.py

@@ -25,7 +25,7 @@ class MariActions(HookBaseClass):
     ##############################################################################################################
     # public interface - to be overridden by deriving classes
 
-    def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
+    def generate_actions(self, sg_publish_data, actions, ui_area):
         """
         Returns a list of action instances for a particular publish.
         This method is called each time a user clicks a publish somewhere in the UI.
@@ -108,7 +108,7 @@ def generate_actions(self, sg_publish_data, actions, ui_area, **kwargs):
 
         return action_instances
 
-    def execute_multiple_actions(self, actions, **kwargs):
+    def execute_multiple_actions(self, actions):
         """
         Executes the specified action on a list of items.
 
@@ -139,7 +139,7 @@ def execute_multiple_actions(self, actions, **kwargs):
             params = single_action["params"]
             self.execute_action(name, params, sg_publish_data)
 
-    def execute_action(self, name, params, sg_publish_data, **kwargs):
+    def execute_action(self, name, params, sg_publish_data):
         """
         Execute a given action. The data sent to this be method will
         represent one of the actions enumerated by the generate_actions method.