Workfiles: Add basic workfiles api

client/ayon_core/host/__init__.py

@@ -4,6 +4,8 @@
 
 from .interfaces import (
     IWorkfileHost,
+    WorkfileInfo,
+    PublishedWorkfileInfo,
     ILoadHost,
     IPublishHost,
     INewPublisher,
@@ -16,6 +18,8 @@
     "HostBase",
 
     "IWorkfileHost",
+    "WorkfileInfo",
+    "PublishedWorkfileInfo",
     "ILoadHost",
     "IPublishHost",
     "INewPublisher",

client/ayon_core/host/host.py

@@ -1,7 +1,7 @@
 import os
 import logging
 import contextlib
-from abc import ABC, abstractproperty
+from abc import ABC, abstractmethod
 
 # NOTE can't import 'typing' because of issues in Maya 2020
 #   - shiboken crashes on 'typing' module import
@@ -92,7 +92,8 @@ def log(self):
             self._log = logging.getLogger(self.__class__.__name__)
         return self._log
 
-    @abstractproperty
+    @property
+    @abstractmethod
     def name(self):
         """Host name."""
 

client/ayon_core/host/interfaces/__init__.py

@@ -0,0 +1,20 @@
+from .exceptions import MissingMethodsError
+from .workfiles import IWorkfileHost, WorkfileInfo, PublishedWorkfileInfo
+from .interfaces import (
+    IPublishHost,
+    INewPublisher,
+    ILoadHost,
+)
+
+
+__all__ = (
+    "MissingMethodsError",
+
+    "IWorkfileHost",
+    "WorkfileInfo",
+    "PublishedWorkfileInfo",
+
+    "IPublishHost",
+    "INewPublisher",
+    "ILoadHost",
+)

client/ayon_core/host/interfaces/exceptions.py

@@ -0,0 +1,15 @@
+class MissingMethodsError(ValueError):
+    """Exception when host miss some required methods for specific workflow.
+
+    Args:
+        host (HostBase): Host implementation where are missing methods.
+        missing_methods (list[str]): List of missing methods.
+    """
+
+    def __init__(self, host, missing_methods):
+        joined_missing = ", ".join(
+            ['"{}"'.format(item) for item in missing_methods]
+        )
+        super().__init__(
+            f"Host \"{host.name}\" miss methods {joined_missing}"
+        )

client/ayon_core/host/interfaces.py → client/ayon_core/host/interfaces/interfaces.py

@@ -1,28 +1,6 @@
-from abc import ABC, abstractmethod
+from abc import abstractmethod
 
-
-class MissingMethodsError(ValueError):
-    """Exception when host miss some required methods for specific workflow.
-
-    Args:
-        host (HostBase): Host implementation where are missing methods.
-        missing_methods (list[str]): List of missing methods.
-    """
-
-    def __init__(self, host, missing_methods):
-        joined_missing = ", ".join(
-            ['"{}"'.format(item) for item in missing_methods]
-        )
-        host_name = getattr(host, "name", None)
-        if not host_name:
-            try:
-                host_name = host.__file__.replace("\\", "/").split("/")[-3]
-            except Exception:
-                host_name = str(host)
-        message = (
-            "Host \"{}\" miss methods {}".format(host_name, joined_missing)
-        )
-        super(MissingMethodsError, self).__init__(message)
+from .exceptions import MissingMethodsError
 
 
 class ILoadHost:
@@ -105,181 +83,6 @@ def ls(self):
         return self.get_containers()
 
 
-class IWorkfileHost(ABC):
-    """Implementation requirements to be able use workfile utils and tool."""
-
-    @staticmethod
-    def get_missing_workfile_methods(host):
-        """Look for missing methods on "old type" host implementation.
-
-        Method is used for validation of implemented functions related to
-        workfiles. Checks only existence of methods.
-
-        Args:
-            Union[ModuleType, HostBase]: Object of host where to look for
-                required methods.
-
-        Returns:
-            list[str]: Missing method implementations for workfiles workflow.
-        """
-
-        if isinstance(host, IWorkfileHost):
-            return []
-
-        required = [
-            "open_file",
-            "save_file",
-            "current_file",
-            "has_unsaved_changes",
-            "file_extensions",
-            "work_root",
-        ]
-        missing = []
-        for name in required:
-            if not hasattr(host, name):
-                missing.append(name)
-        return missing
-
-    @staticmethod
-    def validate_workfile_methods(host):
-        """Validate methods of "old type" host for workfiles workflow.
-
-        Args:
-            Union[ModuleType, HostBase]: Object of host to validate.
-
-        Raises:
-            MissingMethodsError: If there are missing methods on host
-                implementation.
-        """
-
-        missing = IWorkfileHost.get_missing_workfile_methods(host)
-        if missing:
-            raise MissingMethodsError(host, missing)
-
-    @abstractmethod
-    def get_workfile_extensions(self):
-        """Extensions that can be used as save.
-
-        Questions:
-            This could potentially use 'HostDefinition'.
-        """
-
-        return []
-
-    @abstractmethod
-    def save_workfile(self, dst_path=None):
-        """Save currently opened scene.
-
-        Args:
-            dst_path (str): Where the current scene should be saved. Or use
-                current path if 'None' is passed.
-        """
-
-        pass
-
-    @abstractmethod
-    def open_workfile(self, filepath):
-        """Open passed filepath in the host.
-
-        Args:
-            filepath (str): Path to workfile.
-        """
-
-        pass
-
-    @abstractmethod
-    def get_current_workfile(self):
-        """Retrieve path to current opened file.
-
-        Returns:
-            str: Path to file which is currently opened.
-            None: If nothing is opened.
-        """
-
-        return None
-
-    def workfile_has_unsaved_changes(self):
-        """Currently opened scene is saved.
-
-        Not all hosts can know if current scene is saved because the API of
-        DCC does not support it.
-
-        Returns:
-            bool: True if scene is saved and False if has unsaved
-                modifications.
-            None: Can't tell if workfiles has modifications.
-        """
-
-        return None
-
-    def work_root(self, session):
-        """Modify workdir per host.
-
-        Default implementation keeps workdir untouched.
-
-        Warnings:
-            We must handle this modification with more sophisticated way
-            because this can't be called out of DCC so opening of last workfile
-            (calculated before DCC is launched) is complicated. Also breaking
-            defined work template is not a good idea.
-            Only place where it's really used and can make sense is Maya. There
-            workspace.mel can modify subfolders where to look for maya files.
-
-        Args:
-            session (dict): Session context data.
-
-        Returns:
-            str: Path to new workdir.
-        """
-
-        return session["AYON_WORKDIR"]
-
-    # --- Deprecated method names ---
-    def file_extensions(self):
-        """Deprecated variant of 'get_workfile_extensions'.
-
-        Todo:
-            Remove when all usages are replaced.
-        """
-        return self.get_workfile_extensions()
-
-    def save_file(self, dst_path=None):
-        """Deprecated variant of 'save_workfile'.
-
-        Todo:
-            Remove when all usages are replaced.
-        """
-
-        self.save_workfile(dst_path)
-
-    def open_file(self, filepath):
-        """Deprecated variant of 'open_workfile'.
-
-        Todo:
-            Remove when all usages are replaced.
-        """
-
-        return self.open_workfile(filepath)
-
-    def current_file(self):
-        """Deprecated variant of 'get_current_workfile'.
-
-        Todo:
-            Remove when all usages are replaced.
-        """
-
-        return self.get_current_workfile()
-
-    def has_unsaved_changes(self):
-        """Deprecated variant of 'workfile_has_unsaved_changes'.
-
-        Todo:
-            Remove when all usages are replaced.
-        """
-
-        return self.workfile_has_unsaved_changes()
-
-
 class IPublishHost:
     """Functions related to new creation system in new publisher.