Merge pull request #1413 from pypeclub/bugfix/plugin_overrides_per_host

Fix Avalon plugins attribute overrides

openpype/__init__.py

@@ -9,6 +9,7 @@ from .settings import get_project_settings
 from .lib import (
     Anatomy,
     filter_pyblish_plugins,
+    set_plugin_attributes_from_settings,
     change_timer_to_current_context
 )
 
@@ -58,38 +59,8 @@ def patched_discover(superclass):
     # run original discover and get plugins
     plugins = _original_discover(superclass)
 
-    # determine host application to use for finding presets
-    if avalon.registered_host() is None:
-        return plugins
-    host = avalon.registered_host().__name__.split(".")[-1]
+    set_plugin_attributes_from_settings(plugins, superclass)
 
-    # map plugin superclass to preset json. Currenly suppoted is load and
-    # create (avalon.api.Loader and avalon.api.Creator)
-    plugin_type = "undefined"
-    if superclass.__name__.split(".")[-1] == "Loader":
-        plugin_type = "load"
-    elif superclass.__name__.split(".")[-1] == "Creator":
-        plugin_type = "create"
-
-    print(">>> Finding presets for {}:{} ...".format(host, plugin_type))
-    try:
-        settings = (
-            get_project_settings(os.environ['AVALON_PROJECT'])
-            [host][plugin_type]
-        )
-    except KeyError:
-        print("*** no presets found.")
-    else:
-        for plugin in plugins:
-            if plugin.__name__ in settings:
-                print(">>> We have preset for {}".format(plugin.__name__))
-                for option, value in settings[plugin.__name__].items():
-                    if option == "enabled" and value is False:
-                        setattr(plugin, "active", False)
-                        print("  - is disabled by preset")
-                    else:
-                        setattr(plugin, option, value)
-                        print("  - setting `{}`: `{}`".format(option, value))
     return plugins
 
 

openpype/lib/__init__.py

@@ -113,6 +113,7 @@ from .plugin_tools import (
     TaskNotSetError,
     get_subset_name,
     filter_pyblish_plugins,
+    set_plugin_attributes_from_settings,
     source_hash,
     get_unique_layer_name,
     get_background_layers,
@@ -207,6 +208,7 @@ __all__ = [
     "TaskNotSetError",
     "get_subset_name",
     "filter_pyblish_plugins",
+    "set_plugin_attributes_from_settings",
     "source_hash",
     "get_unique_layer_name",
     "get_background_layers",

openpype/lib/plugin_tools.py

@@ -150,6 +150,95 @@ def filter_pyblish_plugins(plugins):
                 setattr(plugin, option, value)
 
 
+def set_plugin_attributes_from_settings(
+    plugins, superclass, host_name=None, project_name=None
+):
+    """Change attribute values on Avalon plugins by project settings.
+
+    This function should be used only in host context. Modify
+    behavior of plugins.
+
+    Args:
+        plugins (list): Plugins discovered by origin avalon discover method.
+        superclass (object): Superclass of plugin type (e.g. Cretor, Loader).
+        host_name (str): Name of host for which plugins are loaded and from.
+            Value from environment `AVALON_APP` is used if not entered.
+        project_name (str): Name of project for which settings will be loaded.
+            Value from environment `AVALON_PROJECT` is used if not entered.
+    """
+
+    # determine host application to use for finding presets
+    if host_name is None:
+        host_name = os.environ.get("AVALON_APP")
+
+    if project_name is None:
+        project_name = os.environ.get("AVALON_PROJECT")
+
+    # map plugin superclass to preset json. Currenly suppoted is load and
+    # create (avalon.api.Loader and avalon.api.Creator)
+    plugin_type = None
+    if superclass.__name__.split(".")[-1] == "Loader":
+        plugin_type = "load"
+    elif superclass.__name__.split(".")[-1] == "Creator":
+        plugin_type = "create"
+
+    if not host_name or not project_name or plugin_type is None:
+        msg = "Skipped attributes override from settings."
+        if not host_name:
+            msg += " Host name is not defined."
+
+        if not project_name:
+            msg += " Project name is not defined."
+
+        if plugin_type is None:
+            msg += " Plugin type is unsupported for class {}.".format(
+                superclass.__name__
+            )
+
+        print(msg)
+        return
+
+    print(">>> Finding presets for {}:{} ...".format(host_name, plugin_type))
+
+    project_settings = get_project_settings(project_name)
+    plugin_type_settings = (
+        project_settings
+        .get(host_name, {})
+        .get(plugin_type, {})
+    )
+    global_type_settings = (
+        project_settings
+        .get("global", {})
+        .get(plugin_type, {})
+    )
+    if not global_type_settings and not plugin_type_settings:
+        return
+
+    for plugin in plugins:
+        plugin_name = plugin.__name__
+
+        plugin_settings = None
+        # Look for plugin settings in host specific settings
+        if plugin_name in plugin_type_settings:
+            plugin_settings = plugin_type_settings[plugin_name]
+
+        # Look for plugin settings in global settings
+        elif plugin_name in global_type_settings:
+            plugin_settings = global_type_settings[plugin_name]
+
+        if not plugin_settings:
+            continue
+
+        print(">>> We have preset for {}".format(plugin_name))
+        for option, value in plugin_settings.items():
+            if option == "enabled" and value is False:
+                setattr(plugin, "active", False)
+                print("  - is disabled by preset")
+            else:
+                setattr(plugin, option, value)
+                print("  - setting `{}`: `{}`".format(option, value))
+
+
 def source_hash(filepath, *args):
     """Generate simple identifier for a source file.
     This is used to identify whether a source file has previously been