Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2026-01-02 08:54:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Initial implementation of pre/post loader hooks

Browse source
This commit is contained in:
Petr Kalis 2025-04-03 18:06:31 +02:00
parent 04a2f08fea
commit 7ec99b3715
1 changed files with 101 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

110
client/ayon_core/tools/loader/models/actions.py
View file

@ -9,6 +9,7 @@ import ayon_api
from ayon_core.lib import NestedCacheItem
from ayon_core.pipeline.load import (
discover_loader_plugins,
discover_loader_pre_hook_plugin,
ProductLoaderPlugin,
filter_repre_contexts_by_loader,
get_loader_identifier,
@ -17,6 +18,8 @@ from ayon_core.pipeline.load import (
load_with_product_contexts,
LoadError,
IncompatibleLoaderError,
get_loaders_by_name
)
from ayon_core.tools.loader.abstract import ActionItem
@ -50,6 +53,8 @@ class LoaderActionsModel:
levels=1, lifetime=self.loaders_cache_lifetime)
self._repre_loaders = NestedCacheItem(
levels=1, lifetime=self.loaders_cache_lifetime)
self._hook_loaders_by_identifier = NestedCacheItem(
levels=1, lifetime=self.loaders_cache_lifetime)
def reset(self):
"""Reset the model with all cached items."""
@ -58,6 +63,7 @@ class LoaderActionsModel:
self._loaders_by_identifier.reset()
self._product_loaders.reset()
self._repre_loaders.reset()
self._hook_loaders_by_identifier.reset()
def get_versions_action_items(self, project_name, version_ids):
"""Get action items for given version ids.
@ -143,12 +149,14 @@ class LoaderActionsModel:
ACTIONS_MODEL_SENDER,
)
loader = self._get_loader_by_identifier(project_name, identifier)
hooks = self._get_hook_loaders_by_identifier(project_name, identifier)
if representation_ids is not None:
error_info = self._trigger_representation_loader(
loader,
options,
project_name,
representation_ids,
hooks
)
elif version_ids is not None:
error_info = self._trigger_version_loader(
@ -156,6 +164,7 @@ class LoaderActionsModel:
options,
project_name,
version_ids,
hooks
)
else:
raise NotImplementedError(
@ -307,22 +316,40 @@ class LoaderActionsModel:
we want to show loaders for?
Returns:
tuple[list[ProductLoaderPlugin], list[LoaderPlugin]]: Discovered
loader plugins.
tuple(
list[ProductLoaderPlugin],
list[LoaderPlugin],
): Discovered loader plugins.
"""
loaders_by_identifier_c = self._loaders_by_identifier[project_name]
product_loaders_c = self._product_loaders[project_name]
repre_loaders_c = self._repre_loaders[project_name]
hook_loaders_by_identifier_c = self._hook_loaders_by_identifier[project_name]
if loaders_by_identifier_c.is_valid:
return product_loaders_c.get_data(), repre_loaders_c.get_data()
return (
product_loaders_c.get_data(),
repre_loaders_c.get_data(),
hook_loaders_by_identifier_c.get_data()
)
# Get all representation->loader combinations available for the
# index under the cursor, so we can list the user the options.
available_loaders = self._filter_loaders_by_tool_name(
project_name, discover_loader_plugins(project_name)
)
hook_loaders_by_identifier = {}
pre_load_hook_plugins = discover_loader_pre_hook_plugin(project_name)
loaders_by_name = get_loaders_by_name()
for hook_plugin in pre_load_hook_plugins:
for load_plugin_name in hook_plugin.loaders:
load_plugin = loaders_by_name.get(load_plugin_name)
if not load_plugin:
continue
if not load_plugin.enabled:
continue
identifier = get_loader_identifier(load_plugin)
hook_loaders_by_identifier.setdefault(identifier, {}).setdefault("pre", []).append(hook_plugin)
repre_loaders = []
product_loaders = []
loaders_by_identifier = {}
@ -340,6 +367,8 @@ class LoaderActionsModel:
loaders_by_identifier_c.update_data(loaders_by_identifier)
product_loaders_c.update_data(product_loaders)
repre_loaders_c.update_data(repre_loaders)
hook_loaders_by_identifier_c.update_data(hook_loaders_by_identifier)
return product_loaders, repre_loaders
def _get_loader_by_identifier(self, project_name, identifier):
@ -349,6 +378,13 @@ class LoaderActionsModel:
loaders_by_identifier = loaders_by_identifier_c.get_data()
return loaders_by_identifier.get(identifier)
def _get_hook_loaders_by_identifier(self, project_name, identifier):
if not self._hook_loaders_by_identifier[project_name].is_valid:
self._get_loaders(project_name)
hook_loaders_by_identifier_c = self._hook_loaders_by_identifier[project_name]
hook_loaders_by_identifier_c = hook_loaders_by_identifier_c.get_data()
return hook_loaders_by_identifier_c.get(identifier)
def _actions_sorter(self, action_item):
"""Sort the Loaders by their order and then their name.
@ -606,6 +642,7 @@ class LoaderActionsModel:
options,
project_name,
version_ids,
hooks=None
):
"""Trigger version loader.
@ -655,7 +692,7 @@ class LoaderActionsModel:
})
return self._load_products_by_loader(
loader, product_contexts, options
loader, product_contexts, options, hooks=hooks
)
def _trigger_representation_loader(
@ -664,6 +701,7 @@ class LoaderActionsModel:
options,
project_name,
representation_ids,
hooks
):
"""Trigger representation loader.
@ -716,10 +754,16 @@ class LoaderActionsModel:
})
return self._load_representations_by_loader(
loader, repre_contexts, options
loader, repre_contexts, options, hooks
)
def _load_representations_by_loader(self, loader, repre_contexts, options):
def _load_representations_by_loader(
self,
loader,
repre_contexts,
options,
hooks=None
):
"""Loops through list of repre_contexts and loads them with one loader
Args:
@ -737,12 +781,26 @@ class LoaderActionsModel:
if version < 0:
version = "Hero"
try:
for hook_plugin in hooks.get("pre", []):
hook_plugin.process(
loader,
repre_context,
options=options
)
load_with_repre_context(
loader,
repre_context,
options=options
)
for hook_plugin in hooks.get("post", []):
hook_plugin.process(
loader,
repre_context,
options=options
)
except IncompatibleLoaderError as exc:
print(exc)
error_info.append((
@ -770,7 +828,13 @@ class LoaderActionsModel:
))
return error_info
def _load_products_by_loader(self, loader, version_contexts, options):
def _load_products_by_loader(
self,
loader,
version_contexts,
options,
hooks=None
):
"""Triggers load with ProductLoader type of loaders.
Warning:
@ -791,12 +855,26 @@ class LoaderActionsModel:
product_name = context.get("product", {}).get("name") or "N/A"
product_names.append(product_name)
try:
for hook_plugin in hooks.get("pre", []):
hook_plugin.process(
loader,
version_contexts,
options=options
)
load_with_product_contexts(
loader,
version_contexts,
options=options
options=options,
)
for hook_plugin in hooks.get("post", []):
hook_plugin.process(
loader,
version_contexts,
options=options
)
except Exception as exc:
formatted_traceback = None
if not isinstance(exc, LoadError):
@ -817,12 +895,26 @@ class LoaderActionsModel:
version_context.get("product", {}).get("name") or "N/A"
)
try:
for hook_plugin in hooks.get("pre", []):
hook_plugin.process(
loader,
version_contexts,
options=options
)
load_with_product_context(
loader,
version_context,
options=options
)
for hook_plugin in hooks.get("post", []):
hook_plugin.process(
loader,
version_context,
options=options
)
except Exception as exc:
formatted_traceback = None
if not isinstance(exc, LoadError):