Chore: Refactor Resolve into new style HostBase, IWorkfileHost, ILoadHost

openpype/hosts/resolve/api/__init__.py

@@ -6,13 +6,10 @@ from .utils import (
 )
 
 from .pipeline import (
-    install,
-    uninstall,
+    ResolveHost,
     ls,
     containerise,
     update_container,
-    publish,
-    launch_workfiles_app,
     maintained_selection,
     remove_instance,
     list_instances
@@ -76,14 +73,10 @@ __all__ = [
     "bmdvf",
 
     # pipeline
-    "install",
-    "uninstall",
+    "ResolveHost",
     "ls",
     "containerise",
     "update_container",
-    "reload_pipeline",
-    "publish",
-    "launch_workfiles_app",
     "maintained_selection",
     "remove_instance",
     "list_instances",

openpype/hosts/resolve/api/menu.py

@@ -5,11 +5,6 @@ from qtpy import QtWidgets, QtCore
 
 from openpype.tools.utils import host_tools
 
-from .pipeline import (
-    publish,
-    launch_workfiles_app
-)
-
 
 def load_stylesheet():
     path = os.path.join(os.path.dirname(__file__), "menu_style.qss")
@@ -113,7 +108,7 @@ class OpenPypeMenu(QtWidgets.QWidget):
 
     def on_workfile_clicked(self):
         print("Clicked Workfile")
-        launch_workfiles_app()
+        host_tools.show_workfiles()
 
     def on_create_clicked(self):
         print("Clicked Create")
@@ -121,7 +116,7 @@ class OpenPypeMenu(QtWidgets.QWidget):
 
     def on_publish_clicked(self):
         print("Clicked Publish")
-        publish(None)
+        host_tools.show_publish(parent=None)
 
     def on_load_clicked(self):
         print("Clicked Load")

openpype/hosts/resolve/api/pipeline.py

@@ -12,14 +12,24 @@ from openpype.pipeline import (
     schema,
     register_loader_plugin_path,
     register_creator_plugin_path,
-    deregister_loader_plugin_path,
-    deregister_creator_plugin_path,
     AVALON_CONTAINER_ID,
 )
-from openpype.tools.utils import host_tools
+from openpype.host import (
+    HostBase,
+    IWorkfileHost,
+    ILoadHost
+)
 
 from . import lib
 from .utils import get_resolve_module
+from .workio import (
+    open_file,
+    save_file,
+    file_extensions,
+    has_unsaved_changes,
+    work_root,
+    current_file
+)
 
 log = Logger.get_logger(__name__)
 
@@ -32,53 +42,59 @@ CREATE_PATH = os.path.join(PLUGINS_DIR, "create")
 AVALON_CONTAINERS = ":AVALON_CONTAINERS"
 
 
-def install():
-    """Install resolve-specific functionality of avalon-core.
+class ResolveHost(HostBase, IWorkfileHost, ILoadHost):
+    name = "maya"
 
-    This is where you install menus and register families, data
-    and loaders into resolve.
+    def __init__(self):
+        super(ResolveHost, self).__init__()
 
-    It is called automatically when installing via `api.install(resolve)`.
+    def install(self):
+        """Install resolve-specific functionality of avalon-core.
 
-    See the Maya equivalent for inspiration on how to implement this.
+        This is where you install menus and register families, data
+        and loaders into resolve.
 
-    """
+        It is called automatically when installing via `api.install(resolve)`.
 
-    log.info("openpype.hosts.resolve installed")
+        See the Maya equivalent for inspiration on how to implement this.
 
-    pyblish.register_host("resolve")
-    pyblish.register_plugin_path(PUBLISH_PATH)
-    log.info("Registering DaVinci Resovle plug-ins..")
+        """
 
-    register_loader_plugin_path(LOAD_PATH)
-    register_creator_plugin_path(CREATE_PATH)
+        log.info("openpype.hosts.resolve installed")
 
-    # register callback for switching publishable
-    pyblish.register_callback("instanceToggled", on_pyblish_instance_toggled)
+        pyblish.register_host("resolve")
+        pyblish.register_plugin_path(PUBLISH_PATH)
+        print("Registering DaVinci Resolve plug-ins..")
 
-    get_resolve_module()
+        register_loader_plugin_path(LOAD_PATH)
+        register_creator_plugin_path(CREATE_PATH)
 
+        # register callback for switching publishable
+        pyblish.register_callback("instanceToggled",
+                                  on_pyblish_instance_toggled)
 
-def uninstall():
-    """Uninstall all that was installed
+        get_resolve_module()
 
-    This is where you undo everything that was done in `install()`.
-    That means, removing menus, deregistering families and  data
-    and everything. It should be as though `install()` was never run,
-    because odds are calling this function means the user is interested
-    in re-installing shortly afterwards. If, for example, he has been
-    modifying the menu or registered families.
+    def open_workfile(self, filepath):
+        return open_file(filepath)
 
-    """
-    pyblish.deregister_host("resolve")
-    pyblish.deregister_plugin_path(PUBLISH_PATH)
-    log.info("Deregistering DaVinci Resovle plug-ins..")
+    def save_workfile(self, filepath=None):
+        return save_file(filepath)
 
-    deregister_loader_plugin_path(LOAD_PATH)
-    deregister_creator_plugin_path(CREATE_PATH)
+    def work_root(self, session):
+        return work_root(session)
 
-    # register callback for switching publishable
-    pyblish.deregister_callback("instanceToggled", on_pyblish_instance_toggled)
+    def get_current_workfile(self):
+        return current_file()
+
+    def workfile_has_unsaved_changes(self):
+        return has_unsaved_changes()
+
+    def get_workfile_extensions(self):
+        return file_extensions()
+
+    def get_containers(self):
+        return ls()
 
 
 def containerise(timeline_item,
@@ -206,15 +222,6 @@ def update_container(timeline_item, data=None):
     return bool(lib.set_timeline_item_pype_tag(timeline_item, container))
 
 
-def launch_workfiles_app(*args):
-    host_tools.show_workfiles()
-
-
-def publish(parent):
-    """Shorthand to publish from within host"""
-    return host_tools.show_publish()
-
-
 @contextlib.contextmanager
 def maintained_selection():
     """Maintain selection during context

openpype/hosts/resolve/api/utils.py

@@ -17,7 +17,7 @@ def get_resolve_module():
     # dont run if already loaded
     if api.bmdvr:
         log.info(("resolve module is assigned to "
-                  f"`pype.hosts.resolve.api.bmdvr`: {api.bmdvr}"))
+                  f"`openpype.hosts.resolve.api.bmdvr`: {api.bmdvr}"))
         return api.bmdvr
     try:
         """
@@ -41,6 +41,10 @@ def get_resolve_module():
             )
         elif sys.platform.startswith("linux"):
             expected_path = "/opt/resolve/libs/Fusion/Modules"
+        else:
+            raise NotImplementedError(
+                "Unsupported platform: {}".format(sys.platform)
+            )
 
         # check if the default path has it...
         print(("Unable to find module DaVinciResolveScript from "
@@ -74,6 +78,6 @@ def get_resolve_module():
     api.bmdvr = bmdvr
     api.bmdvf = bmdvf
     log.info(("Assigning resolve module to "
-              f"`pype.hosts.resolve.api.bmdvr`: {api.bmdvr}"))
+              f"`openpype.hosts.resolve.api.bmdvr`: {api.bmdvr}"))
     log.info(("Assigning resolve module to "
-              f"`pype.hosts.resolve.api.bmdvf`: {api.bmdvf}"))
+              f"`openpype.hosts.resolve.api.bmdvf`: {api.bmdvf}"))

openpype/hosts/resolve/startup.py

@@ -27,7 +27,8 @@ def ensure_installed_host():
     if host:
         return host
 
-    install_host(openpype.hosts.resolve.api)
+    host = openpype.hosts.resolve.api.ResolveHost()
+    install_host(host)
     return registered_host()
 
 
@@ -37,10 +38,10 @@ def launch_menu():
     openpype.hosts.resolve.api.launch_pype_menu()
 
 
-def open_file(path):
+def open_workfile(path):
     # Avoid the need to "install" the host
     host = ensure_installed_host()
-    host.open_file(path)
+    host.open_workfile(path)
 
 
 def main():
@@ -49,7 +50,7 @@ def main():
 
     if workfile_path and os.path.exists(workfile_path):
         log.info(f"Opening last workfile: {workfile_path}")
-        open_file(workfile_path)
+        open_workfile(workfile_path)
     else:
         log.info("No last workfile set to open. Skipping..")
 

openpype/hosts/resolve/utility_scripts/OpenPype__Menu.py

@@ -8,12 +8,13 @@ log = Logger.get_logger(__name__)
 
 
 def main(env):
-    import openpype.hosts.resolve.api as bmdvr
+    from openpype.hosts.resolve.api import ResolveHost, launch_pype_menu
 
     # activate resolve from openpype
-    install_host(bmdvr)
+    host = ResolveHost()
+    install_host(host)
 
-    bmdvr.launch_pype_menu()
+    launch_pype_menu()
 
 
 if __name__ == "__main__":