Patch #499: Refactor find_host_config to lib.find_module_in_config

avalon/fusion/pipeline.py

@@ -6,6 +6,7 @@
 from avalon import api as avalon
 
 from ..pipeline import AVALON_CONTAINER_ID
+from ..lib import find_module_in_config
 
 
 class CompLogHandler(logging.Handler):
@@ -23,32 +24,30 @@ def ls():
     assets on disk, it lists assets already loaded in Fusion; once loaded
     they are called 'containers'
 
+    Yields:
+        dict: container
+
     """
 
     comp = get_current_comp()
     tools = comp.GetToolList(False, "Loader").values()
+
+    has_metadata_collector = False
+    config_host = find_module_in_config(api.registered_config(), "fusion")
+    if hasattr(config_host, "collect_container_metadata"):
+        has_metadata_collector = True
+
     for tool in tools:
         container = parse_container(tool)
         if container:
-            # Collect custom data if attribute is present
-            config = find_host_config(avalon.registered_config())
-            if hasattr(config, "collect_container_metadata"):
-                metadata = config.collect_container_metadata(container)
+
+            if has_metadata_collector:
+                metadata = config_host.collect_container_metadata(container)
                 container.update(metadata)
 
             yield container
 
 
-def find_host_config(config):
-    config_name = config.__name__
-    try:
-        config = importlib.import_module(config_name + ".fusion")
-    except ImportError:
-        pass
-
-    return config
-
-
 def install(config):
     """Install Fusion-specific functionality of avalon-core.
 
@@ -74,11 +73,19 @@ def install(config):
     handler.setFormatter(formatter)
     logger.addHandler(handler)
     logger.setLevel(logging.DEBUG)
+
+
+def uninstall(config):
+    """Uninstall Fusion-specific functionality of avalon-core.
+
+    This function is called automatically on calling `api.uninstall()`.
+
+    Args:
+        config: configuration module
+
+    """
 
-    # Trigger install on the config's "fusion" package
-    config = find_host_config(config)
-    if hasattr(config, "install"):
-        config.install()
+    pyblish.api.deregister_host("fusion")
 
 
 def imprint_container(tool,

avalon/houdini/pipeline.py

@@ -10,7 +10,7 @@
 
 # Local libraries
 from . import lib
-from ..lib import logger
+from ..lib import logger, find_module_in_config
 from avalon import api, schema
 
 from ..pipeline import AVALON_CONTAINER_ID
@@ -38,11 +38,7 @@ def install(config):
     pyblish.api.register_host("hpython")
 
     self._has_been_setup = True
-
-    config = find_host_config(config)
-    if hasattr(config, "install"):
-        config.install()
-
+
 
 def uninstall(config):
     """Uninstall Houdini-specific functionality of avalon-core.
@@ -54,27 +50,11 @@ def uninstall(config):
 
     """
 
-    config = find_host_config(config)
-    if hasattr(config, "uninstall"):
-        config.uninstall()
-
     pyblish.api.deregister_host("hython")
     pyblish.api.deregister_host("hpython")
     pyblish.api.deregister_host("houdini")
 
 
-def find_host_config(config):
-    config_name = config.__name__
-    try:
-        config = importlib.import_module(config_name + ".houdini")
-    except ImportError as exc:
-        if str(exc) != "No module name {}".format(config_name + ".houdini"):
-            raise
-        config = None
-
-    return config
-
-
 def get_main_window():
     """Acquire Houdini's main window"""
     if self._parent is None:
@@ -236,13 +216,17 @@ def ls():
                        "pyblish.mindbender.container"):
         containers += lib.lsattr("id", identifier)
 
-    for container in sorted(containers):
+    has_metadata_collector = False
+    config_host = find_module_in_config(api.registered_config(), "houdini")
+    if hasattr(config_host, "collect_container_metadata"):
+        has_metadata_collector = True
+
+    for container in sorted(container_names):
         data = parse_container(container)
 
         # Collect custom data if attribute is present
-        config = find_host_config(api.registered_config())
-        if hasattr(config, "collect_container_metadata"):
-            metadata = config.collect_container_metadata(container)
+        if has_metadata_collector:
+            metadata = config_host.collect_container_metadata(container)
             data.update(metadata)
 
         yield data

avalon/lib.py

@@ -281,3 +281,23 @@ def modules_from_path(path):
         modules.append(module)
 
     return modules
+
+
+def find_module_in_config(config, module):
+    """Find and return submodule of the config.
+
+    Args:
+        config (types.ModuleType): The config to search in.
+        module (str): The config's submodule to search.
+
+    Returns:
+        types.ModuleType or None: The module, if found.
+
+    """
+    config_name = config.__name__
+    module_name = "%s.%s" % (config_name, module)
+    try:
+        return importlib.import_module(module_name)
+    except ImportError as exc:
+        if str(exc) != "No module name {}".format(module_name):
+            log_.warning("Config has no '%s' module." % module_name)

avalon/maya/pipeline.py

@@ -10,7 +10,7 @@
 from pyblish import api as pyblish
 
 from . import lib, compat
-from ..lib import logger
+from ..lib import logger, find_module_in_config
 from .. import api, schema
 from ..tools import workfiles
 from ..vendor.Qt import QtCore, QtWidgets
@@ -58,10 +58,6 @@ def install(config):
     pyblish.register_host("mayapy")
     pyblish.register_host("maya")
 
-    config = find_host_config(config)
-    if hasattr(config, "install"):
-        config.install()
-
 
 def _set_project():
     """Sets the maya project to the current Session's work directory.
@@ -84,17 +80,6 @@ def _set_project():
     cmds.workspace(workdir, openWorkspace=True)
 
 
-def find_host_config(config):
-    try:
-        config = importlib.import_module(config.__name__ + ".maya")
-    except ImportError as exc:
-        if str(exc) != "No module name {}".format(config.__name__ + ".maya"):
-            raise
-        config = None
-
-    return config
-
-
 def get_main_window():
     """Acquire Maya's main window"""
     if self._parent is None:
@@ -111,9 +96,6 @@ def uninstall(config):
     This function is called automatically on calling `api.uninstall()`.
 
     """
-    config = find_host_config(config)
-    if hasattr(config, "uninstall"):
-        config.uninstall()
 
     _uninstall_menu()
 
@@ -517,16 +499,16 @@ def ls():
     container_names = _ls()
 
     has_metadata_collector = False
-    config = find_host_config(api.registered_config())
-    if hasattr(config, "collect_container_metadata"):
+    config_host = find_module_in_config(api.registered_config(), "maya")
+    if hasattr(config_host, "collect_container_metadata"):
         has_metadata_collector = True
 
     for container in sorted(container_names):
         data = parse_container(container)
 
         # Collect custom data if attribute is present
         if has_metadata_collector:
-            metadata = config.collect_container_metadata(container)
+            metadata = config_host.collect_container_metadata(container)
             data.update(metadata)
 
         yield data

avalon/nuke/pipeline.py

@@ -227,26 +227,10 @@ def install(config):
     _register_events()
 
     pyblish.register_host("nuke")
-    # Trigger install on the config's "nuke" package
-    config = find_host_config(config)
-
-    if hasattr(config, "install"):
-        config.install()
 
     log.info("config.nuke installed")
 
 
-def find_host_config(config):
-    try:
-        config = importlib.import_module(config.__name__ + ".nuke")
-    except ImportError as exc:
-        if str(exc) != "No module name {}".format(config.__name__ + ".nuke"):
-            raise
-        config = None
-
-    return config
-
-
 def get_main_window():
     """Acquire Nuke's main window"""
     if self._parent is None:
@@ -270,9 +254,6 @@ def uninstall(config):
     modifying the menu or registered families.
 
     """
-    config = find_host_config(config)
-    if hasattr(config, "uninstall"):
-        config.uninstall()
 
     _uninstall_menu()
 

avalon/pipeline.py

@@ -77,6 +77,12 @@ def install(host):
     # Optional host install function
     if hasattr(host, "install"):
         host.install(config)
+
+    # Optional config.host.install()
+    host_name = host.__name__.rsplit(".", 1)[-1]
+    config_host = lib.find_module_in_config(config, host_name)
+    if hasattr(config_host, "install"):
+        config_host.install()
 
     register_host(host)
     register_config(config)
@@ -104,9 +110,16 @@ def find_config():
 def uninstall():
     """Undo all of what `install()` did"""
     config = registered_config()
-
+    host = registered_host()
+
+    # Optional config.host.uninstall()
+    host_name = host.__name__.rsplit(".", 1)[-1]
+    config_host = lib.find_module_in_config(config, host_name)
+    if hasattr(config_host, "uninstall"):
+        config_host.uninstall()
+
     try:
-        registered_host().uninstall(config)
+        host.uninstall(config)
     except AttributeError:
         pass