From 359d6856442f8d9f3d992ec3af335d8b9aa300f2 Mon Sep 17 00:00:00 2001
From: Roy Nieterau <roy@colorbleed.nl>
Date: Thu, 15 Jun 2023 14:35:47 +0200
Subject: [PATCH] Draft to allow "inventory" actions to be supplied by a Module
 or Addon.

---
 openpype/modules/README.md         |  3 ++-
 openpype/modules/base.py           | 22 +++++++++++++++++++---
 openpype/modules/interfaces.py     | 23 +++++++++++++++++++----
 openpype/pipeline/context_tools.py |  5 +++++
 4 files changed, 45 insertions(+), 8 deletions(-)

diff --git a/openpype/modules/README.md b/openpype/modules/README.md
index 86afdb9d91..ce3f99b338 100644
--- a/openpype/modules/README.md
+++ b/openpype/modules/README.md
@@ -138,7 +138,8 @@ class ClockifyModule(
  "publish": [],
  "create": [],
  "load": [],
- "actions": []
+ "actions": [],
+ "inventory": []
  }
  ```
 
diff --git a/openpype/modules/base.py b/openpype/modules/base.py
index 732525b6eb..fb9b4e1096 100644
--- a/openpype/modules/base.py
+++ b/openpype/modules/base.py
@@ -740,15 +740,16 @@ class ModulesManager:
         Unknown keys are logged out.
 
         Returns:
-            dict: Output is dictionary with keys "publish", "create", "load"
-                and "actions" each containing list of paths.
+            dict: Output is dictionary with keys "publish", "create", "load",
+                "actions" and "inventory" each containing list of paths.
         """
         # Output structure
         output = {
             "publish": [],
             "create": [],
             "load": [],
-            "actions": []
+            "actions": [],
+            "inventory": []
         }
         unknown_keys_by_module = {}
         for module in self.get_enabled_modules():
@@ -853,6 +854,21 @@ class ModulesManager:
             host_name
         )
 
+    def collect_inventory_action_paths(self, host_name):
+        """Helper to collect load plugin paths from modules.
+
+        Args:
+            host_name (str): For which host are load plugins meant.
+
+        Returns:
+            list: List of pyblish plugin paths.
+        """
+
+        return self._collect_plugin_paths(
+            "get_inventory_action_paths",
+            host_name
+        )
+
     def get_host_module(self, host_name):
         """Find host module by host name.
 
diff --git a/openpype/modules/interfaces.py b/openpype/modules/interfaces.py
index 8c9a6ee1dd..40a42e9290 100644
--- a/openpype/modules/interfaces.py
+++ b/openpype/modules/interfaces.py
@@ -33,8 +33,8 @@ class OpenPypeInterface:
 class IPluginPaths(OpenPypeInterface):
     """Module has plugin paths to return.
 
-    Expected result is dictionary with keys "publish", "create", "load" or
-    "actions" and values as list or string.
+    Expected result is dictionary with keys "publish", "create", "load",
+    "actions" or "inventory" and values as list or string.
     {
         "publish": ["path/to/publish_plugins"]
     }
@@ -109,6 +109,21 @@ class IPluginPaths(OpenPypeInterface):
 
         return self._get_plugin_paths_by_type("publish")
 
+    def get_inventory_action_paths(self, host_name):
+        """Receive inventory action paths.
+
+        Give addons ability to add inventory action plugin paths.
+
+        Notes:
+           Default implementation uses 'get_plugin_paths' and always return
+               all publish plugin paths.
+
+        Args:
+           host_name (str): For which host are the plugins meant.
+        """
+
+        return self._get_plugin_paths_by_type("inventory")
+
 
 class ILaunchHookPaths(OpenPypeInterface):
     """Module has launch hook paths to return.
@@ -397,8 +412,8 @@ class ITrayService(ITrayModule):
 class ISettingsChangeListener(OpenPypeInterface):
     """Module has plugin paths to return.
 
-    Expected result is dictionary with keys "publish", "create", "load" or
-    "actions" and values as list or string.
+    Expected result is dictionary with keys "publish", "create", "load",
+    "actions" or "inventory" and values as list or string.
     {
         "publish": ["path/to/publish_plugins"]
     }
diff --git a/openpype/pipeline/context_tools.py b/openpype/pipeline/context_tools.py
index ada78b989d..97a5c1ba69 100644
--- a/openpype/pipeline/context_tools.py
+++ b/openpype/pipeline/context_tools.py
@@ -181,6 +181,11 @@ def install_openpype_plugins(project_name=None, host_name=None):
     for path in load_plugin_paths:
         register_loader_plugin_path(path)
 
+    inventory_action_paths = modules_manager.collect_inventory_action_paths(
+        host_name)
+    for path in inventory_action_paths:
+        register_inventory_action_path(path)
+
     if project_name is None:
         project_name = os.environ.get("AVALON_PROJECT")