Merge pull request #1445 from ynput/enhancement/1443-allow-host-addons-to-store-dcc-version-in-workfile-metadata

Workfile info: Add application information to workfile entity

client/ayon_core/host/__init__.py

@@ -1,5 +1,5 @@
 from .constants import ContextChangeReason
-from .abstract import AbstractHost
+from .abstract import AbstractHost, ApplicationInformation
 from .host import (
     HostBase,
     ContextChangeData,
@@ -21,6 +21,7 @@ __all__ = (
     "ContextChangeReason",
 
     "AbstractHost",
+    "ApplicationInformation",
 
     "HostBase",
     "ContextChangeData",

client/ayon_core/host/abstract.py

@@ -2,6 +2,7 @@ from __future__ import annotations
 
 import logging
 from abc import ABC, abstractmethod
+from dataclasses import dataclass
 import typing
 from typing import Optional, Any
 
@@ -13,6 +14,19 @@ if typing.TYPE_CHECKING:
     from .typing import HostContextData
 
 
+@dataclass
+class ApplicationInformation:
+    """Application information.
+
+    Attributes:
+        app_name (Optional[str]): Application name. e.g. Maya, NukeX, Nuke
+        app_version (Optional[str]): Application version. e.g. 15.2.1
+
+    """
+    app_name: Optional[str] = None
+    app_version: Optional[str] = None
+
+
 class AbstractHost(ABC):
     """Abstract definition of host implementation."""
     @property
@@ -26,6 +40,16 @@ class AbstractHost(ABC):
         """Host name."""
         pass
 
+    @abstractmethod
+    def get_app_information(self) -> ApplicationInformation:
+        """Information about the application where host is running.
+
+        Returns:
+            ApplicationInformation: Application information.
+
+        """
+        pass
+
     @abstractmethod
     def get_current_context(self) -> HostContextData:
         """Get the current context of the host.

client/ayon_core/host/host.py

@@ -12,7 +12,7 @@ import ayon_api
 from ayon_core.lib import emit_event
 
 from .constants import ContextChangeReason
-from .abstract import AbstractHost
+from .abstract import AbstractHost, ApplicationInformation
 
 if typing.TYPE_CHECKING:
     from ayon_core.pipeline import Anatomy
@@ -96,6 +96,18 @@ class HostBase(AbstractHost):
 
         pass
 
+    def get_app_information(self) -> ApplicationInformation:
+        """Running application information.
+
+        Host integration should override this method and return correct
+            information.
+
+        Returns:
+            ApplicationInformation: Application information.
+
+        """
+        return ApplicationInformation()
+
     def install(self):
         """Install host specific functionality.
 

client/ayon_core/host/interfaces/workfiles.py

@@ -55,7 +55,7 @@ class _WorkfileOptionalData:
     ):
         if kwargs:
             cls_name = self.__class__.__name__
-            keys = ", ".join(['"{}"'.format(k) for k in kwargs.keys()])
+            keys = ", ".join([f'"{k}"' for k in kwargs.keys()])
             warnings.warn(
                 f"Unknown keywords passed to {cls_name}: {keys}",
             )
@@ -1554,6 +1554,27 @@ class IWorkfileHost(AbstractHost):
         if platform.system().lower() == "windows":
             rootless_path = rootless_path.replace("\\", "/")
 
+        # Get application information
+        app_info = self.get_app_information()
+        data = {}
+        if app_info.app_name:
+            data["app_name"] = app_info.app_name
+        if app_info.app_version:
+            data["app_version"] = app_info.app_version
+
+        # Use app group and app variant from applications addon (if available)
+        app_addon_name = os.environ.get("AYON_APP_NAME")
+        if not app_addon_name:
+            app_addon_name = None
+
+        app_addon_tools_s = os.environ.get("AYON_APP_TOOLS")
+        app_addon_tools = []
+        if app_addon_tools_s:
+            app_addon_tools = app_addon_tools_s.split(";")
+
+        data["ayon_app_name"] = app_addon_name
+        data["ayon_app_tools"] = app_addon_tools
+
         workfile_info = save_workfile_info(
             project_name,
             save_workfile_context.task_entity["id"],
@@ -1562,6 +1583,7 @@ class IWorkfileHost(AbstractHost):
             version,
             comment,
             description,
+            data=data,
             workfile_entities=save_workfile_context.workfile_entities,
         )
         return workfile_info

client/ayon_core/pipeline/workfile/utils.py

@@ -207,6 +207,7 @@ def save_workfile_info(
     comment: Optional[str] = None,
     description: Optional[str] = None,
     username: Optional[str] = None,
+    data: Optional[dict[str, Any]] = None,
     workfile_entities: Optional[list[dict[str, Any]]] = None,
 ) -> dict[str, Any]:
     """Save workfile info entity for a workfile path.
@@ -221,6 +222,7 @@ def save_workfile_info(
         description (Optional[str]): Workfile description.
         username (Optional[str]): Username of user who saves the workfile.
             If not provided, current user is used.
+        data (Optional[dict[str, Any]]): Additional workfile entity data.
         workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched
             workfile entities related to task.
 
@@ -246,6 +248,18 @@ def save_workfile_info(
     if username is None:
         username = get_ayon_username()
 
+    attrib = {}
+    extension = os.path.splitext(rootless_path)[1]
+    for key, value in (
+        ("extension", extension),
+        ("description", description),
+    ):
+        if value is not None:
+            attrib[key] = value
+
+    if data is None:
+        data = {}
+
     if not workfile_entity:
         return _create_workfile_info_entity(
             project_name,
@@ -255,34 +269,38 @@ def save_workfile_info(
             username,
             version,
             comment,
-            description,
+            attrib,
+            data,
         )
 
-    data = {
-        key: value
-        for key, value in (
-            ("host_name", host_name),
-            ("version", version),
-            ("comment", comment),
-        )
-        if value is not None
-    }
-
-    old_data = workfile_entity["data"]
+    for key, value in (
+        ("host_name", host_name),
+        ("version", version),
+        ("comment", comment),
+    ):
+        if value is not None:
+            data[key] = value
 
     changed_data = {}
+    old_data = workfile_entity["data"]
     for key, value in data.items():
         if key not in old_data or old_data[key] != value:
             changed_data[key] = value
+            workfile_entity["data"][key] = value
+
+    changed_attrib = {}
+    old_attrib = workfile_entity["attrib"]
+    for key, value in attrib.items():
+        if key not in old_attrib or old_attrib[key] != value:
+            changed_attrib[key] = value
+            workfile_entity["attrib"][key] = value
 
     update_data = {}
     if changed_data:
         update_data["data"] = changed_data
 
-    old_description = workfile_entity["attrib"].get("description")
-    if description is not None and old_description != description:
-        update_data["attrib"] = {"description": description}
-        workfile_entity["attrib"]["description"] = description
+    if changed_attrib:
+        update_data["attrib"] = changed_attrib
 
     # Automatically fix 'createdBy' and 'updatedBy' fields
     # NOTE both fields were not automatically filled by server
@@ -749,7 +767,8 @@ def _create_workfile_info_entity(
     username: str,
     version: Optional[int],
     comment: Optional[str],
-    description: Optional[str],
+    attrib: dict[str, Any],
+    data: dict[str, Any],
 ) -> dict[str, Any]:
     """Create workfile entity data.
 
@@ -761,27 +780,18 @@ def _create_workfile_info_entity(
         username (str): Username.
         version (Optional[int]): Workfile version.
         comment (Optional[str]): Workfile comment.
-        description (Optional[str]): Workfile description.
+        attrib (dict[str, Any]): Workfile entity attributes.
+        data (dict[str, Any]): Workfile entity data.
 
     Returns:
         dict[str, Any]: Created workfile entity data.
 
     """
-    extension = os.path.splitext(rootless_path)[1]
-
-    attrib = {}
-    for key, value in (
-        ("extension", extension),
-        ("description", description),
-    ):
-        if value is not None:
-            attrib[key] = value
-
-    data = {
+    data.update({
         "host_name": host_name,
         "version": version,
         "comment": comment,
-    }
+    })
 
     workfile_info = {
         "id": uuid.uuid4().hex,