From 3bfb11d09b02c113d63c6294a286d5531cc674eb Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:12:18 +0200 Subject: [PATCH 001/170] moved interfaces to subfolder --- client/ayon_core/host/interfaces/__init__.py | 16 ++++++++++++++++ .../host/{ => interfaces}/interfaces.py | 0 2 files changed, 16 insertions(+) create mode 100644 client/ayon_core/host/interfaces/__init__.py rename client/ayon_core/host/{ => interfaces}/interfaces.py (100%) diff --git a/client/ayon_core/host/interfaces/__init__.py b/client/ayon_core/host/interfaces/__init__.py new file mode 100644 index 0000000000..fb6bdc661a --- /dev/null +++ b/client/ayon_core/host/interfaces/__init__.py @@ -0,0 +1,16 @@ +from .interfaces import ( + MissingMethodsError, + IPublishHost, + INewPublisher, + ILoadHost, + IWorkfileHost, +) + + +__all__ = ( + "MissingMethodsError", + "IWorkfileHost", + "IPublishHost", + "INewPublisher", + "ILoadHost", +) diff --git a/client/ayon_core/host/interfaces.py b/client/ayon_core/host/interfaces/interfaces.py similarity index 100% rename from client/ayon_core/host/interfaces.py rename to client/ayon_core/host/interfaces/interfaces.py From 28eaf12d9d17dc832d6f0affadd8f671c6c2588a Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:13:09 +0200 Subject: [PATCH 002/170] move exception into separate file --- client/ayon_core/host/interfaces/__init__.py | 2 +- .../ayon_core/host/interfaces/exceptions.py | 15 ++++++++++++ .../ayon_core/host/interfaces/interfaces.py | 24 +------------------ 3 files changed, 17 insertions(+), 24 deletions(-) create mode 100644 client/ayon_core/host/interfaces/exceptions.py diff --git a/client/ayon_core/host/interfaces/__init__.py b/client/ayon_core/host/interfaces/__init__.py index fb6bdc661a..efe1ea6c5c 100644 --- a/client/ayon_core/host/interfaces/__init__.py +++ b/client/ayon_core/host/interfaces/__init__.py @@ -1,5 +1,5 @@ +from .exceptions import MissingMethodsError from .interfaces import ( - MissingMethodsError, IPublishHost, INewPublisher, ILoadHost, diff --git a/client/ayon_core/host/interfaces/exceptions.py b/client/ayon_core/host/interfaces/exceptions.py new file mode 100644 index 0000000000..c6b4cef4b4 --- /dev/null +++ b/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}" + ) diff --git a/client/ayon_core/host/interfaces/interfaces.py b/client/ayon_core/host/interfaces/interfaces.py index c077dfeae9..5fc40134f8 100644 --- a/client/ayon_core/host/interfaces/interfaces.py +++ b/client/ayon_core/host/interfaces/interfaces.py @@ -1,28 +1,6 @@ from abc import ABC, 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: From 9d0d8309d0f818d9a6747c374f3265f55cb7a776 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:14:16 +0200 Subject: [PATCH 003/170] move workfiles interface to separate file --- client/ayon_core/host/interfaces/__init__.py | 2 +- .../ayon_core/host/interfaces/interfaces.py | 177 +---------------- client/ayon_core/host/interfaces/workfiles.py | 178 ++++++++++++++++++ 3 files changed, 180 insertions(+), 177 deletions(-) create mode 100644 client/ayon_core/host/interfaces/workfiles.py diff --git a/client/ayon_core/host/interfaces/__init__.py b/client/ayon_core/host/interfaces/__init__.py index efe1ea6c5c..560cd3c0b4 100644 --- a/client/ayon_core/host/interfaces/__init__.py +++ b/client/ayon_core/host/interfaces/__init__.py @@ -1,9 +1,9 @@ from .exceptions import MissingMethodsError +from .workfiles import IWorkfileHost from .interfaces import ( IPublishHost, INewPublisher, ILoadHost, - IWorkfileHost, ) diff --git a/client/ayon_core/host/interfaces/interfaces.py b/client/ayon_core/host/interfaces/interfaces.py index 5fc40134f8..a41dffe92a 100644 --- a/client/ayon_core/host/interfaces/interfaces.py +++ b/client/ayon_core/host/interfaces/interfaces.py @@ -1,4 +1,4 @@ -from abc import ABC, abstractmethod +from abc import abstractmethod from .exceptions import MissingMethodsError @@ -83,181 +83,6 @@ class ILoadHost: 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. diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py new file mode 100644 index 0000000000..433c66277e --- /dev/null +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -0,0 +1,178 @@ +from abc import ABC, abstractmethod + +from .exceptions import MissingMethodsError + + +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() \ No newline at end of file From 9e1e36c412ce1a6e753bf7bba621b08d59492f23 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:15:22 +0200 Subject: [PATCH 004/170] remove ABC form 'IWorkfileHost' --- client/ayon_core/host/interfaces/workfiles.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 433c66277e..6245b2e144 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -3,7 +3,7 @@ from abc import ABC, abstractmethod from .exceptions import MissingMethodsError -class IWorkfileHost(ABC): +class IWorkfileHost: """Implementation requirements to be able use workfile utils and tool.""" @staticmethod From 7e5d8612a7817bbd8a3cedcdb100a05f37a21291 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:18:13 +0200 Subject: [PATCH 005/170] remove validation of methods --- client/ayon_core/host/interfaces/workfiles.py | 50 +------------------ client/ayon_core/tools/workfiles/control.py | 7 +-- 2 files changed, 2 insertions(+), 55 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 6245b2e144..496ee06e4b 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1,58 +1,10 @@ -from abc import ABC, abstractmethod +from abc import abstractmethod -from .exceptions import MissingMethodsError class IWorkfileHost: """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): diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index 3a7459da0c..9cd3c0f76a 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -140,12 +140,7 @@ class BaseWorkfileController( if host is None: host = registered_host() - host_is_valid = False - if host is not None: - missing_methods = ( - IWorkfileHost.get_missing_workfile_methods(host) - ) - host_is_valid = len(missing_methods) == 0 + host_is_valid = isinstance(host, IWorkfileHost) self._host = host self._host_is_valid = host_is_valid From 9140d1124d38fdaa825f4d47ea47bf672d81e3f5 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:22:12 +0200 Subject: [PATCH 006/170] added helper data structure for colleting workfiles --- client/ayon_core/host/interfaces/workfiles.py | 67 +++++++++++++++++++ 1 file changed, 67 insertions(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 496ee06e4b..077ececeb6 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1,6 +1,73 @@ +import os from abc import abstractmethod +from dataclasses import dataclass, asdict +from typing import Optional +@dataclass +class WorkfileInfo: + filepath: str + rootless_path: str + file_size: Optional[float] + file_created: Optional[float] + file_modified: Optional[float] + workfile_entity_id: Optional[str] + description: str + created_by: Optional[str] + updated_by: Optional[str] + available: bool + + @classmethod + def new(cls, filepath, rootless_path, available, workfile_entity): + file_size = file_modified = file_created = None + if filepath and os.path.exists(filepath): + filestat = os.stat(filepath) + file_size = filestat.st_size + file_created = filestat.st_ctime + file_modified = filestat.st_mtime + + if workfile_entity is None: + workfile_entity = {} + + attrib = {} + if workfile_entity: + attrib = workfile_entity["attrib"] + + return cls( + filepath=filepath, + rootless_path=rootless_path, + file_size=file_size, + file_created=file_created, + file_modified=file_modified, + workfile_entity_id=workfile_entity.get("id"), + description=attrib.get("description") or "", + created_by=workfile_entity.get("createdBy"), + updated_by=workfile_entity.get("updatedBy"), + available=available, + ) + + def to_data(self): + """Converts file item to data. + + Returns: + dict[str, Any]: Workfile item data. + + """ + return asdict(self) + + @classmethod + def from_data(self, data): + """Converts data to workfile item. + + Args: + data (dict[str, Any]): Workfile item data. + + Returns: + WorkfileInfo: File item. + + """ + return WorkfileInfo(**data) + class IWorkfileHost: """Implementation requirements to be able use workfile utils and tool.""" From 156eb14bf645ff341463ba2bff3ed9e06174fcb9 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:23:22 +0200 Subject: [PATCH 007/170] remove unnecessary 'work_root' --- client/ayon_core/host/interfaces/workfiles.py | 22 ------------------- 1 file changed, 22 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 077ececeb6..263651a422 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -129,28 +129,6 @@ class IWorkfileHost: 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'. From fe28391ce8cfab29f37ee5f2fecb59258d490a8d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:24:11 +0200 Subject: [PATCH 008/170] add new line char at the end --- client/ayon_core/host/interfaces/workfiles.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 263651a422..7b69404f60 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -172,4 +172,4 @@ class IWorkfileHost: Remove when all usages are replaced. """ - return self.workfile_has_unsaved_changes() \ No newline at end of file + return self.workfile_has_unsaved_changes() From 515cd79a1ad81ebcc656c19dc06302e51b6897e4 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 25 Apr 2025 17:28:38 +0200 Subject: [PATCH 009/170] first implementation of list workfiles --- client/ayon_core/host/interfaces/workfiles.py | 132 +++++++++++++++++- 1 file changed, 131 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 7b69404f60..a2a9ee511a 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1,7 +1,11 @@ +from __future__ import annotations import os +import platform from abc import abstractmethod from dataclasses import dataclass, asdict -from typing import Optional +from typing import Optional, Any + +import ayon_api @dataclass @@ -129,6 +133,132 @@ class IWorkfileHost: return None + def list_workfiles( + self, + project_name: str, + folder_id: str, + task_id: str, + project_entity: Optional[dict[str, Any]] = None, + folder_entity: Optional[dict[str, Any]] = None, + task_entity: Optional[dict[str, Any]] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + template_key: Optional[str] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + ) -> list[WorkfileInfo]: + """List workfiles in the given folder. + + NOTES: + - Better method name? + - This method is pre-implemented as the logic can be shared across + 95% of host integrations. Ad-hoc implementation to give host + integration workfile api functionality. + - Should this method also handle workfiles based on workfile entities? + + Args: + project_name (str): Name of project. + folder_id (str): ID of folder. + task_id (str): ID of task. + project_entity (Optional[dict[str, Any]]): Project entity. + folder_entity (Optional[dict[str, Any]]): Folder entity. + task_entity (Optional[dict[str, Any]]): Task entity. + workfile_entities (Optional[list[dict[str, Any]]]): Workfile + entities. + template_key (Optional[str]): Template key. + project_settings (Optional[dict[str, Any]]): Project settings. + anatomy (Anatomy): Project anatomy. + + Returns: + list[WorkfileInfo]: List of workfiles. + + """ + from ayon_core.pipeline import Anatomy + from ayon_core.pipeline.template_data import get_template_data + from ayon_core.pipeline.workfile import get_workdir_with_workdir_data + + extensions = self.get_workfile_extensions() + if not extensions: + return [] + + if project_entity is None: + project_entity = ayon_api.get_project(project_name) + + if folder_entity is None: + folder_entity = ayon_api.get_folder_by_id(project_name, folder_id) + + if task_entity is None: + task_entity = ayon_api.get_task_by_id(project_name, task_id) + + if workfile_entities is None: + workfile_entities = list(ayon_api.get_workfiles_info( + project_name, task_ids=[task_id] + )) + + if anatomy is None: + anatomy = Anatomy(project_name, project_entity=project_entity) + + workfile_entities_by_path = { + workfile_entity["path"]: workfile_entity + for workfile_entity in workfile_entities + } + + workdir_data = get_template_data( + project_entity, + folder_entity, + task_entity, + host_name=self.name, + ) + workdir = get_workdir_with_workdir_data( + workdir_data, + project_name, + anatomy=anatomy, + template_key=template_key, + project_settings=project_settings, + ) + + if platform.system().lower() == "windows": + rootless_workdir = workdir.replace("\\", "/") + else: + rootless_workdir = workdir + + used_roots = workdir.used_values.get("root") + if used_roots: + used_root_name = next(iter(used_roots)) + root_value = used_roots[used_root_name] + workdir_end = rootless_workdir[len(root_value):].lstrip("/") + rootless_workdir = f"{{root[{used_root_name}]}}/{workdir_end}" + + filenames = [] + if os.path.exists(workdir): + filenames = list(os.listdir(workdir)) + + items = [] + for filename in filenames: + filepath = os.path.join(workdir, filename) + # TODO add 'default' support for folders + ext = os.path.splitext(filepath)[1].lower() + if ext not in extensions: + continue + + rootless_path = f"{rootless_workdir}/{filename}" + workfile_entity = workfile_entities_by_path.pop( + rootless_path, None + ) + items.append(WorkfileInfo.new( + filepath, rootless_path, True, workfile_entity + )) + + for workfile_entity in workfile_entities_by_path.values(): + # Workfile entity is not in the filesystem + # but it is in the database + rootless_path = workfile_entity["path"] + filepath = anatomy.fill_root(rootless_path) + items.append(WorkfileInfo.new( + filepath, rootless_path, False, workfile_entity + )) + + return items + # --- Deprecated method names --- def file_extensions(self): """Deprecated variant of 'get_workfile_extensions'. From 152211a047a5543fa9ae66b2bbb8e0e393b99c79 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 09:16:50 +0200 Subject: [PATCH 010/170] 'get_workfile_extensions' is not abstract anymore --- client/ayon_core/host/interfaces/workfiles.py | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index a2a9ee511a..34d7dddef6 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -77,16 +77,6 @@ class IWorkfileHost: """Implementation requirements to be able use workfile utils and tool.""" - @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. @@ -133,6 +123,18 @@ class IWorkfileHost: return None + def get_workfile_extensions(self) -> list[str]: + """Extensions that can be used as save. + + Questions: + This could potentially use 'HostDefinition'. + + Returns: + list[str]: List of extensions that can be used for saving. + + """ + return [] + def list_workfiles( self, project_name: str, From d78e25c7ecac46768c06efb407f7de513242c31e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 10:09:32 +0200 Subject: [PATCH 011/170] added helper function to collect comments from existing workfiles --- .../pipeline/workfile/path_resolving.py | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 9b2fe25199..bd4a7f0035 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -1,3 +1,4 @@ +from __future__ import annotations import os import re import copy @@ -12,6 +13,7 @@ from ayon_core.lib import ( Logger, StringTemplate, ) +from ayon_core.lib.path_templates import TemplateResult from ayon_core.pipeline import version_start, Anatomy from ayon_core.pipeline.template_data import get_template_data @@ -562,3 +564,99 @@ def create_workdir_extra_folders( fullpath = os.path.join(workdir, subfolder) if not os.path.exists(fullpath): os.makedirs(fullpath) + + +class CommentMatcher: + """Use anatomy and work file data to parse comments from filenames. + + Args: + extensions (set[str]): Set of extensions. + file_template (StringTemplate): Workfile file template. + data (dict[str, Any]): Data to fill the template with. + + """ + def __init__( + self, + extensions: set[str], + file_template: StringTemplate, + data: dict[str, Any] + ): + self._fname_regex = None + + if "{comment}" not in file_template: + # Don't look for comment if template doesn't allow it + return + + # Create a regex group for extensions + any_extension = "(?:{})".format( + "|".join(re.escape(ext.lstrip(".")) for ext in extensions) + ) + + # Use placeholders that will never be in the filename + temp_data = copy.deepcopy(data) + temp_data["comment"] = "<>" + temp_data["version"] = "<>" + temp_data["ext"] = "<>" + + fname_pattern = re.escape( + file_template.format_strict(temp_data) + ) + + # Replace comment and version with something we can match with regex + replacements = ( + ("<>", r"(?P.+)"), + ("<>", r"[0-9]+"), + ("<>", any_extension), + ) + for src, dest in replacements: + fname_pattern = fname_pattern.replace(re.escape(src), dest) + + # Match from beginning to end of string to be safe + self._fname_regex = re.compile(f"^{fname_pattern}$") + + def parse_comment(self, filename: str) -> Optional[str]: + """Parse the {comment} part from a filename""" + if self._fname_regex: + match = self._fname_regex.match(filename) + if match: + return match.group("comment") + return None + + +def get_comments_from_work_filenames( + filenames: list[str], + extensions: set[str], + file_template: StringTemplate, + template_data: dict[str, Any], + current_filename: Optional[str] = None, +) -> tuple[list[str], str]: + """Collect comments from workfile filenames. + + Based on 'current_filename' is also returned "current comment". + + Args: + filenames (list[str]): List of filenames to parse. + extensions (set[str]): Set of file extensions. + file_template (StringTemplate): Workfile file template. + template_data (dict[str, Any]): Data to fill the template with. + current_filename (str): Filename to check for current comment. + + Returns: + tuple[list[str], str]: List of comments and the current comment. + + """ + current_comment = "" + if not filenames: + return [], current_comment + + matcher = CommentMatcher(extensions, file_template, template_data) + + comment_hints = set() + for filename in filenames: + comment = matcher.parse_comment(filename) + if comment: + comment_hints.add(comment) + if filename == current_filename: + current_comment = comment + + return list(comment_hints), current_comment From 615529fa85a3348dd2c407d771656d31814f6603 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:31:56 +0200 Subject: [PATCH 012/170] added 'WorkfileInfo' to host public api --- client/ayon_core/host/__init__.py | 2 ++ client/ayon_core/host/interfaces/__init__.py | 3 ++- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/host/__init__.py b/client/ayon_core/host/__init__.py index da1237c739..80ff0f2e38 100644 --- a/client/ayon_core/host/__init__.py +++ b/client/ayon_core/host/__init__.py @@ -4,6 +4,7 @@ from .host import ( from .interfaces import ( IWorkfileHost, + WorkfileInfo, ILoadHost, IPublishHost, INewPublisher, @@ -16,6 +17,7 @@ __all__ = ( "HostBase", "IWorkfileHost", + "WorkfileInfo", "ILoadHost", "IPublishHost", "INewPublisher", diff --git a/client/ayon_core/host/interfaces/__init__.py b/client/ayon_core/host/interfaces/__init__.py index 560cd3c0b4..4ee6375012 100644 --- a/client/ayon_core/host/interfaces/__init__.py +++ b/client/ayon_core/host/interfaces/__init__.py @@ -1,5 +1,5 @@ from .exceptions import MissingMethodsError -from .workfiles import IWorkfileHost +from .workfiles import IWorkfileHost, WorkfileInfo from .interfaces import ( IPublishHost, INewPublisher, @@ -10,6 +10,7 @@ from .interfaces import ( __all__ = ( "MissingMethodsError", "IWorkfileHost", + "WorkfileInfo", "IPublishHost", "INewPublisher", "ILoadHost", From a61a94d1a9b5b9e62a376e7c77522c68c311d83b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:32:19 +0200 Subject: [PATCH 013/170] added more helper functions to workfile path mapping --- .../ayon_core/pipeline/workfile/__init__.py | 8 + .../pipeline/workfile/path_resolving.py | 279 ++++++++++++------ 2 files changed, 197 insertions(+), 90 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/__init__.py b/client/ayon_core/pipeline/workfile/__init__.py index aa7e150bca..5b8a10c288 100644 --- a/client/ayon_core/pipeline/workfile/__init__.py +++ b/client/ayon_core/pipeline/workfile/__init__.py @@ -4,6 +4,8 @@ from .path_resolving import ( get_workdir_with_workdir_data, get_workdir, + get_last_workfile_with_version_from_paths, + get_last_workfile_from_paths, get_last_workfile_with_version, get_last_workfile, @@ -11,6 +13,8 @@ from .path_resolving import ( get_custom_workfile_template_by_string_context, create_workdir_extra_folders, + + get_comments_from_workfile_paths, ) from .utils import ( @@ -37,6 +41,8 @@ __all__ = ( "get_workdir_with_workdir_data", "get_workdir", + "get_last_workfile_with_version_from_paths", + "get_last_workfile_from_paths", "get_last_workfile_with_version", "get_last_workfile", @@ -45,6 +51,8 @@ __all__ = ( "create_workdir_extra_folders", + "get_comments_from_workfile_paths", + "should_use_last_workfile_on_launch", "should_open_workfiles_tool_on_launch", "MissingWorkdirError", diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index bd4a7f0035..ac915060eb 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -113,7 +113,7 @@ def get_workdir_with_workdir_data( anatomy=None, template_key=None, project_settings=None -): +) -> TemplateResult: """Fill workdir path from entered data and project's anatomy. It is possible to pass only project's name instead of project's anatomy but @@ -133,8 +133,8 @@ def get_workdir_with_workdir_data( Returns: TemplateResult: Workdir path. - """ + """ if not anatomy: anatomy = Anatomy(project_name) @@ -176,8 +176,8 @@ def get_workdir( is stored under `AYON_HOST_NAME` key. anatomy (Anatomy): Optional argument. Anatomy object is created using project name from `project_entity`. It is preferred to pass this - argument as initialization of a new Anatomy object may be time - consuming. + argument as initialization of a new Anatomy object may be + time-consuming. template_key (str): Key of work templates in anatomy templates. Default value is defined in `get_workdir_with_workdir_data`. project_settings(Dict[str, Any]): Prepared project settings for @@ -209,6 +209,159 @@ def get_workdir( ) +def get_last_workfile_with_version_from_paths( + filepaths, file_template, template_data, extensions +): + """Return last workfile version. + + Using workfile template and it's filling data find most possible last + version of workfile which was created for the context. + + Functionality is fully based on knowing which keys are optional or what + values are expected as value. + + The last modified file is used if more files can be considered as + last workfile. + + Args: + filepaths (list[str]): Workfile paths. + file_template (str): Template of file name. + template_data (Dict[str, Any]): Data for filling template. + extensions (Iterable[str]): All allowed file extensions of workfile. + + Returns: + tuple[Union[str, None], Union[int, None]]: Last workfile with version + if there is any workfile otherwise None for both. + + """ + if not filepaths: + return None, None + + dotted_extensions = set() + for ext in extensions: + if not ext.startswith("."): + ext = f".{ext}" + dotted_extensions.add(re.escape(ext)) + + # Build template without optionals, version to digits only regex + # and comment to any definable value. + # Escape extensions dot for regex + ext_expression = "(?:" + "|".join(dotted_extensions) + ")" + + for pattern, replacement in ( + # Replace `.{ext}` with `{ext}` so we are sure dot is not at the end + (r"\.?{ext}", ext_expression), + # Replace optional keys with optional content regex + (r"<.*?>", r".*?"), + # Replace `{version}` with group regex + (r"{version.*?}", r"([0-9]+)"), + (r"{comment.*?}", r".+?"), + ): + file_template = re.sub(pattern, replacement, file_template) + + file_template = StringTemplate.format_strict_template( + file_template, template_data + ) + + # Match with ignore case on Windows due to the Windows + # OS not being case-sensitive. This avoids later running + # into the error that the file did exist if it existed + # with a different upper/lower-case. + kwargs = {} + if platform.system().lower() == "windows": + kwargs["flags"] = re.IGNORECASE + + # Get highest version among existing matching files + version = None + output_filepaths = [] + for filepath in sorted(filepaths): + filename = os.path.basename(filepath) + match = re.match(file_template, filename, **kwargs) + if not match: + continue + + if not match.groups(): + output_filepaths.append(filename) + continue + + file_version = int(match.group(1)) + if version is None or file_version > version: + output_filepaths.clear() + version = file_version + + if file_version == version: + output_filepaths.append(filepath) + + output_filepath = None + last_time = None + for _output_filepath in output_filepaths: + mod_time = None + if os.path.exists(_output_filepath): + mod_time = os.path.getmtime(_output_filepath) + if ( + last_time is None + or (mod_time is not None and last_time < mod_time) + ): + output_filepath = _output_filepath + last_time = mod_time + + return output_filepath, version + + +def get_last_workfile_from_paths( + filepaths: list[str], + file_template: str, + template_data: dict[str, Any], + extensions: set[str], +): + """Return last workfile filename. + + Returns file with version 1 if there is not workfile yet. + + Args: + filepaths (list[str]): Paths to workfiles. + file_template (str): Template of file name. + template_data (dict[str, Any]): Data for filling template. + extensions (set[str]): All allowed file extensions of workfile. + + Returns: + Optional[str]: Last or first workfile as filename of full path + to filename. + + """ + filepath, _version = get_last_workfile_with_version_from_paths( + filepaths, file_template, template_data, extensions + ) + return filepath + + +def _filter_dir_files_by_ext( + dirpath: str, + extensions: set[str], +): + """Filter files by extensions. + + Args: + dirpath (str): List of file paths. + extensions (set[str]): Set of file extensions. + + Returns: + tuple[list[str], set[str]]: Filtered list of file paths. + + """ + dotted_extensions = set() + for ext in extensions: + if not ext.startswith("."): + ext = f".{ext}" + dotted_extensions.add(ext) + filtered_paths = [ + os.path.join(dirpath, filename) + for filename in os.listdir(dirpath) + if os.path.splitext(filename)[-1] in dotted_extensions + ] + return filtered_paths, dotted_extensions + + def get_last_workfile_with_version( workdir, file_template, fill_data, extensions ): @@ -237,85 +390,24 @@ def get_last_workfile_with_version( if not os.path.exists(workdir): return None, None - dotted_extensions = set() - for ext in extensions: - if not ext.startswith("."): - ext = ".{}".format(ext) - dotted_extensions.add(ext) - - # Fast match on extension - filenames = [ - filename - for filename in os.listdir(workdir) - if os.path.splitext(filename)[-1] in dotted_extensions - ] - - # Build template without optionals, version to digits only regex - # and comment to any definable value. - # Escape extensions dot for regex - regex_exts = [ - "\\" + ext - for ext in dotted_extensions - ] - ext_expression = "(?:" + "|".join(regex_exts) + ")" - - # Replace `.{ext}` with `{ext}` so we are sure there is not dot at the end - file_template = re.sub(r"\.?{ext}", ext_expression, file_template) - # Replace optional keys with optional content regex - file_template = re.sub(r"<.*?>", r".*?", file_template) - # Replace `{version}` with group regex - file_template = re.sub(r"{version.*?}", r"([0-9]+)", file_template) - file_template = re.sub(r"{comment.*?}", r".+?", file_template) - file_template = StringTemplate.format_strict_template( - file_template, fill_data + filepaths, dotted_extensions = _filter_dir_files_by_ext( + workdir, extensions ) - # Match with ignore case on Windows due to the Windows - # OS not being case-sensitive. This avoids later running - # into the error that the file did exist if it existed - # with a different upper/lower-case. - kwargs = {} - if platform.system().lower() == "windows": - kwargs["flags"] = re.IGNORECASE - - # Get highest version among existing matching files - version = None - output_filenames = [] - for filename in sorted(filenames): - match = re.match(file_template, filename, **kwargs) - if not match: - continue - - if not match.groups(): - output_filenames.append(filename) - continue - - file_version = int(match.group(1)) - if version is None or file_version > version: - output_filenames[:] = [] - version = file_version - - if file_version == version: - output_filenames.append(filename) - - output_filename = None - if output_filenames: - if len(output_filenames) == 1: - output_filename = output_filenames[0] - else: - last_time = None - for _output_filename in output_filenames: - full_path = os.path.join(workdir, _output_filename) - mod_time = os.path.getmtime(full_path) - if last_time is None or last_time < mod_time: - output_filename = _output_filename - last_time = mod_time - - return output_filename, version + return get_last_workfile_with_version_from_paths( + filepaths, + file_template, + fill_data, + dotted_extensions, + ) def get_last_workfile( - workdir, file_template, fill_data, extensions, full_path=False + workdir: str, + file_template: str, + fill_data: dict[str, Any], + extensions: set[str], + full_path: bool = False ): """Return last workfile filename. @@ -326,17 +418,23 @@ def get_last_workfile( file_template (str): Template of file name. fill_data (Dict[str, Any]): Data for filling template. extensions (Iterable[str]): All allowed file extensions of workfile. - full_path (Optional[bool]): Full path to file is returned if + full_path (bool): Full path to file is returned if set to True. Returns: str: Last or first workfile as filename of full path to filename. """ - filename, _version = get_last_workfile_with_version( - workdir, file_template, fill_data, extensions + filepaths, dotted_extensions = _filter_dir_files_by_ext( + workdir, extensions ) - if filename is None: + filepath = get_last_workfile_from_paths( + filepaths, + file_template, + fill_data, + dotted_extensions + ) + if filepath is None: data = copy.deepcopy(fill_data) data["version"] = version_start.get_versioning_start( data["project"]["name"], @@ -350,11 +448,11 @@ def get_last_workfile( data["ext"] = extensions[0] data["ext"] = data["ext"].lstrip(".") filename = StringTemplate.format_strict_template(file_template, data) + filepath = os.path.join(workdir, filename) if full_path: - return os.path.normpath(os.path.join(workdir, filename)) - - return filename + return os.path.normpath(filepath) + return os.path.basename(filepath) def get_custom_workfile_template( @@ -623,8 +721,8 @@ class CommentMatcher: return None -def get_comments_from_work_filenames( - filenames: list[str], +def get_comments_from_workfile_paths( + filepaths: list[str], extensions: set[str], file_template: StringTemplate, template_data: dict[str, Any], @@ -635,7 +733,7 @@ def get_comments_from_work_filenames( Based on 'current_filename' is also returned "current comment". Args: - filenames (list[str]): List of filenames to parse. + filepaths (list[str]): List of filepaths to parse. extensions (set[str]): Set of file extensions. file_template (StringTemplate): Workfile file template. template_data (dict[str, Any]): Data to fill the template with. @@ -646,13 +744,14 @@ def get_comments_from_work_filenames( """ current_comment = "" - if not filenames: + if not filepaths: return [], current_comment matcher = CommentMatcher(extensions, file_template, template_data) comment_hints = set() - for filename in filenames: + for filepath in filepaths: + filename = os.path.basename(filepath) comment = matcher.parse_comment(filename) if comment: comment_hints.add(comment) From b5f8997248601ea96c021f61f478e08522b93440 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:32:30 +0200 Subject: [PATCH 014/170] selection cares about more information --- client/ayon_core/tools/workfiles/models/selection.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/workfiles/models/selection.py b/client/ayon_core/tools/workfiles/models/selection.py index 2f0896842d..9a6440b2a1 100644 --- a/client/ayon_core/tools/workfiles/models/selection.py +++ b/client/ayon_core/tools/workfiles/models/selection.py @@ -62,7 +62,9 @@ class SelectionModel(object): def get_selected_workfile_path(self): return self._workfile_path - def set_selected_workfile_path(self, path): + def set_selected_workfile_path( + self, rootless_path, path, workfile_entity_id + ): if path == self._workfile_path: return @@ -72,9 +74,11 @@ class SelectionModel(object): { "project_name": self._controller.get_current_project_name(), "path": path, + "rootless_path": rootless_path, "folder_id": self._folder_id, "task_name": self._task_name, "task_id": self._task_id, + "workfile_entity_id": workfile_entity_id, }, self.event_source ) From 1037776e93f71599a9200e7fd60c952875770056 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:34:23 +0200 Subject: [PATCH 015/170] pass project settings to template key getter --- client/ayon_core/tools/workfiles/models/workfiles.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index cc034571f3..da4e455cb4 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -213,6 +213,7 @@ class WorkareaModel: self.project_name, task_type, self._controller.get_host_name(), + project_settings=self._controller.project_settings, ) def _get_last_workfile_version( From 4220f9200081db683136941907c0901e235e1717 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:34:52 +0200 Subject: [PATCH 016/170] pass host name to template data getter --- client/ayon_core/tools/workfiles/models/workfiles.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index da4e455cb4..7d56f02a2f 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -114,9 +114,9 @@ class WorkareaModel: def _get_base_data(self): if self._base_data is None: base_data = get_template_data( - ayon_api.get_project(self.project_name) + ayon_api.get_project(self._project_name), + host_name=self._controller.get_host_name(), ) - base_data["app"] = self._controller.get_host_name() self._base_data = base_data return copy.deepcopy(self._base_data) From 67f478d8b54be64f719dea395269d925c0c52ca6 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:38:08 +0200 Subject: [PATCH 017/170] modified controller base --- client/ayon_core/tools/workfiles/abstract.py | 269 +++++++++---------- 1 file changed, 120 insertions(+), 149 deletions(-) diff --git a/client/ayon_core/tools/workfiles/abstract.py b/client/ayon_core/tools/workfiles/abstract.py index 152ca33d99..78e31f9abd 100644 --- a/client/ayon_core/tools/workfiles/abstract.py +++ b/client/ayon_core/tools/workfiles/abstract.py @@ -3,75 +3,7 @@ from abc import ABC, abstractmethod from ayon_core.style import get_default_entity_icon_color - -class WorkfileInfo: - """Information about workarea file with possible additional from database. - - Args: - folder_id (str): Folder id. - task_id (str): Task id. - filepath (str): Filepath. - filesize (int): File size. - creation_time (float): Creation time (timestamp). - modification_time (float): Modification time (timestamp). - created_by (Union[str, none]): User who created the file. - updated_by (Union[str, none]): User who last updated the file. - note (str): Note. - """ - - def __init__( - self, - folder_id, - task_id, - filepath, - filesize, - creation_time, - modification_time, - created_by, - updated_by, - note, - ): - self.folder_id = folder_id - self.task_id = task_id - self.filepath = filepath - self.filesize = filesize - self.creation_time = creation_time - self.modification_time = modification_time - self.created_by = created_by - self.updated_by = updated_by - self.note = note - - def to_data(self): - """Converts WorkfileInfo item to data. - - Returns: - dict[str, Any]: Folder item data. - """ - - return { - "folder_id": self.folder_id, - "task_id": self.task_id, - "filepath": self.filepath, - "filesize": self.filesize, - "creation_time": self.creation_time, - "modification_time": self.modification_time, - "created_by": self.created_by, - "updated_by": self.updated_by, - "note": self.note, - } - - @classmethod - def from_data(cls, data): - """Re-creates WorkfileInfo item from data. - - Args: - data (dict[str, Any]): Workfile info item data. - - Returns: - WorkfileInfo: Workfile info item. - """ - - return cls(**data) +from ayon_core.host import WorkfileInfo class FolderItem: @@ -87,8 +19,8 @@ class FolderItem: label (str): Folder label. icon_name (str): Name of icon from font awesome. icon_color (str): Hex color string that will be used for icon. - """ + """ def __init__( self, entity_id, parent_id, name, label, icon_name, icon_color ): @@ -104,8 +36,8 @@ class FolderItem: Returns: dict[str, Any]: Folder item data. - """ + """ return { "entity_id": self.entity_id, "parent_id": self.parent_id, @@ -124,8 +56,8 @@ class FolderItem: Returns: FolderItem: Folder item. - """ + """ return cls(**data) @@ -144,8 +76,8 @@ class TaskItem: parent_id (str): Parent folder id. icon_name (str): Name of icon from font awesome. icon_color (str): Hex color string that will be used for icon. - """ + """ def __init__( self, task_id, name, task_type, parent_id, icon_name, icon_color ): @@ -163,8 +95,8 @@ class TaskItem: Returns: str: Task id. - """ + """ return self.task_id @property @@ -173,8 +105,8 @@ class TaskItem: Returns: str: Label of task item. - """ + """ if self._label is None: self._label = "{} ({})".format(self.name, self.task_type) return self._label @@ -184,8 +116,8 @@ class TaskItem: Returns: dict[str, Any]: Task item data. - """ + """ return { "task_id": self.task_id, "name": self.name, @@ -204,8 +136,8 @@ class TaskItem: Returns: TaskItem: Task item. - """ + """ return cls(**data) @@ -224,8 +156,8 @@ class FileItem: workfile. filepath (Optional[str]): Prepared filepath. exists (Optional[bool]): If file exists on disk. - """ + """ def __init__( self, dirpath, @@ -252,8 +184,8 @@ class FileItem: Returns: str: Full path to a file. - """ + """ if self._filepath is None: self._filepath = os.path.join(self.dirpath, self.filename) return self._filepath @@ -264,8 +196,8 @@ class FileItem: Returns: bool: If file exists on disk. - """ + """ if self._exists is None: self._exists = os.path.exists(self.filepath) return self._exists @@ -275,8 +207,8 @@ class FileItem: Returns: dict[str, Any]: File item data. - """ + """ return { "filename": self.filename, "dirpath": self.dirpath, @@ -296,8 +228,8 @@ class FileItem: Returns: FileItem: File item. - """ + """ required_keys = { "filename", "dirpath", @@ -323,8 +255,8 @@ class WorkareaFilepathResult: exists (bool): True if file exists. filepath (str): Filepath. If not provided it will be constructed from root and filename. - """ + """ def __init__(self, root, filename, exists, filepath=None): if not filepath and root and filename: filepath = os.path.join(root, filename) @@ -341,8 +273,8 @@ class AbstractWorkfilesCommon(ABC): Returns: bool: True if host is valid. - """ + """ pass @abstractmethod @@ -353,8 +285,8 @@ class AbstractWorkfilesCommon(ABC): Returns: Iterable[str]: List of extensions. - """ + """ pass @abstractmethod @@ -363,8 +295,8 @@ class AbstractWorkfilesCommon(ABC): Returns: bool: True if save is enabled. - """ + """ pass @abstractmethod @@ -373,8 +305,8 @@ class AbstractWorkfilesCommon(ABC): Args: enabled (bool): Enable save workfile when True. - """ + """ pass @@ -386,6 +318,7 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: str: Name of host. + """ pass @@ -395,8 +328,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: str: Name of project. - """ + """ pass @abstractmethod @@ -406,8 +339,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: Union[str, None]: Folder id or None if host does not have any context. - """ + """ pass @abstractmethod @@ -417,8 +350,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: Union[str, None]: Task name or None if host does not have any context. - """ + """ pass @abstractmethod @@ -428,8 +361,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: Union[str, None]: Path to workfile or None if host does not have opened specific file. - """ + """ pass @property @@ -439,8 +372,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: Anatomy: Project anatomy. - """ + """ pass @property @@ -450,8 +383,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: dict[str, Any]: Project settings. - """ + """ pass @abstractmethod @@ -463,8 +396,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: dict[str, Any]: Project entity data. - """ + """ pass @abstractmethod @@ -477,8 +410,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: dict[str, Any]: Folder entity data. - """ + """ pass @abstractmethod @@ -491,10 +424,24 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): Returns: dict[str, Any]: Task entity data. - """ + """ pass + @abstractmethod + def get_workfile_entities(self, task_id: str): + """Workfile entities for given task. + + Args: + task_id (str): Task id. + + Returns: + list[dict[str, Any]]: List of workfile entities. + + """ + pass + + @abstractmethod def emit_event(self, topic, data=None, source=None): """Emit event. @@ -502,8 +449,8 @@ class AbstractWorkfilesBackend(AbstractWorkfilesCommon): topic (str): Event topic used for callbacks filtering. data (Optional[dict[str, Any]]): Event data. source (Optional[str]): Event source. - """ + """ pass @@ -530,8 +477,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): topic (str): Name of topic. callback (Callable): Callback that will be called when event is triggered. - """ + """ pass @abstractmethod @@ -592,8 +539,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: List[str]: File extensions that can be used as workfile for current host. - """ + """ pass # Selection information @@ -603,8 +550,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: Union[str, None]: Folder id or None if no folder is selected. - """ + """ pass @abstractmethod @@ -616,8 +563,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Args: folder_id (Union[str, None]): Folder id or None if no folder is selected. - """ + """ pass @abstractmethod @@ -626,8 +573,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: Union[str, None]: Task id or None if no folder is selected. - """ + """ pass @abstractmethod @@ -649,8 +596,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): is selected. task_name (Union[str, None]): Task name or None if no task is selected. - """ + """ pass @abstractmethod @@ -659,18 +606,22 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: Union[str, None]: Selected workfile path. - """ + """ pass @abstractmethod - def set_selected_workfile_path(self, path): + def set_selected_workfile_path( + self, rootless_path, path, workfile_entity_id + ): """Change selected workfile path. Args: + rootless_path (Union[str, None]): Selected workfile rootless path. path (Union[str, None]): Selected workfile path. - """ + workfile_entity_id (Union[str, None]): Workfile entity id. + """ pass @abstractmethod @@ -680,8 +631,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: Union[str, None]: Representation id or None if no representation is selected. - """ + """ pass @abstractmethod @@ -691,8 +642,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Args: representation_id (Union[str, None]): Selected workfile representation id. - """ + """ pass def get_selected_context(self): @@ -700,8 +651,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: dict[str, Union[str, None]]: Selected context. - """ + """ return { "folder_id": self.get_selected_folder_id(), "task_id": self.get_selected_task_id(), @@ -737,8 +688,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): files UI element. representation_id (Optional[str]): Representation id. Used for published filed UI element. - """ + """ pass @abstractmethod @@ -750,8 +701,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: dict[str, Any]: Expected selection data. - """ + """ pass @abstractmethod @@ -760,8 +711,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Args: folder_id (str): Folder id which was selected. - """ + """ pass @abstractmethod @@ -771,8 +722,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Args: folder_id (str): Folder id under which task is. task_name (str): Task name which was selected. - """ + """ pass @abstractmethod @@ -785,8 +736,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): folder_id (str): Folder id under which representation is. task_name (str): Task name under which representation is. representation_id (str): Representation id which was selected. - """ + """ pass @abstractmethod @@ -797,8 +748,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): folder_id (str): Folder id under which workfile is. task_name (str): Task name under which workfile is. workfile_name (str): Workfile filename which was selected. - """ + """ pass @abstractmethod @@ -823,8 +774,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: list[FolderItem]: Minimum possible information needed for visualisation of folder hierarchy. - """ + """ pass @abstractmethod @@ -843,8 +794,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: list[TaskItem]: Minimum possible information needed for visualisation of tasks. - """ + """ pass @abstractmethod @@ -853,8 +804,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: bool: Has unsaved changes. - """ + """ pass @abstractmethod @@ -867,8 +818,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: str: Workarea directory. - """ + """ pass @abstractmethod @@ -881,9 +832,9 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): sender (Optional[str]): Who requested workarea file items. Returns: - list[FileItem]: List of workarea file items. - """ + list[WorkfileInfo]: List of workarea file items. + """ pass @abstractmethod @@ -899,8 +850,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: dict[str, Any]: Data for Save As operation. - """ + """ pass @abstractmethod @@ -925,8 +876,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: WorkareaFilepathResult: Result of the operation. - """ + """ pass @abstractmethod @@ -939,43 +890,51 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Returns: list[FileItem]: List of published file items. - """ + """ pass @abstractmethod - def get_workfile_info(self, folder_id, task_name, filepath): + def get_workfile_info(self, folder_id, task_id, rootless_path): """Workfile info from database. Args: folder_id (str): Folder id. - task_name (str): Task id. - filepath (str): Workfile path. + task_id (str): Task id. + rootless_path (str): Workfile path. Returns: Union[WorkfileInfo, None]: Workfile info or None if was passed invalid context. - """ + """ pass @abstractmethod - def save_workfile_info(self, folder_id, task_name, filepath, note): + def save_workfile_info( + self, + task_id, + rootless_path, + version=None, + comment=None, + description=None, + ): """Save workfile info to database. At this moment the only information which can be saved about - workfile is 'note'. + workfile is 'description'. - When 'note' is 'None' it is only validated if workfile info exists, - and if not then creates one with empty note. + If value of 'version', 'comment' or 'description' is 'None' it is not + added/updated to entity. Args: - folder_id (str): Folder id. - task_name (str): Task id. - filepath (str): Workfile path. - note (Union[str, None]): Note. - """ + task_id (str): Task id. + rootless_path (str): Rootless workfile path. + version (Optional[int]): Version of workfile. + comment (Optional[str]): User's comment (subversion). + description (Optional[str]): Workfile description. + """ pass # General commands @@ -985,8 +944,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): Triggers 'controller.reset.started' event at the beginning and 'controller.reset.finished' at the end. - """ + """ pass # Controller actions @@ -998,8 +957,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): folder_id (str): Folder id. task_id (str): Task id. filepath (str): Workfile path. - """ + """ pass @abstractmethod @@ -1013,22 +972,27 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): self, folder_id, task_id, - workdir, + rootless_workdir, filename, template_key, - artist_note, + version, + comment, + description, ): """Save current state of workfile to workarea. Args: folder_id (str): Folder id. task_id (str): Task id. - workdir (str): Workarea directory. + rootless_workdir (str): Workarea directory. filename (str): Workarea filename. template_key (str): Template key used to get the workdir and filename. - """ + version (Optional[int]): Version of workfile. + comment (Optional[str]): User's comment (subversion). + description (Optional[str]): Workfile description. + """ pass @abstractmethod @@ -1041,7 +1005,9 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): workdir, filename, template_key, - artist_note, + version, + comment, + description, ): """Action to copy published workfile representation to workarea. @@ -1056,13 +1022,17 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): workdir (str): Workarea directory. filename (str): Workarea filename. template_key (str): Template key. - artist_note (str): Artist note. - """ + version (int): Workfile version. + comment (str): User's comment (subversion). + description (str): Description note. + """ pass @abstractmethod - def duplicate_workfile(self, src_filepath, workdir, filename, artist_note): + def duplicate_workfile( + self, src_filepath, workdir, filename, description, version, comment + ): """Duplicate workfile. Workfiles is not opened when done. @@ -1071,7 +1041,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): src_filepath (str): Source workfile path. workdir (str): Destination workdir. filename (str): Destination filename. - artist_note (str): Artist note. + version (int): Workfile version. + comment (str): User's comment (subversion). + description (str): Workfile description. """ - pass From ea12998f5b3ebac3163d2875d61f48fcb2cef18e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:40:29 +0200 Subject: [PATCH 018/170] use only IWorkfileHost methods --- client/ayon_core/tools/workfiles/control.py | 21 ++++----------------- 1 file changed, 4 insertions(+), 17 deletions(-) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index 9cd3c0f76a..0bbec856ca 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -10,7 +10,6 @@ from ayon_core.settings import get_project_settings from ayon_core.pipeline import Anatomy, registered_host from ayon_core.pipeline.context_tools import ( change_current_context, - get_current_host_name, get_global_context, ) from ayon_core.pipeline.workfile import create_workdir_extra_folders @@ -288,23 +287,14 @@ class BaseWorkfileController( # Host information def get_workfile_extensions(self): - host = self._host - if isinstance(host, IWorkfileHost): - return host.get_workfile_extensions() - return host.file_extensions() + return self._host.get_workfile_extensions() def has_unsaved_changes(self): - host = self._host - if isinstance(host, IWorkfileHost): - return host.workfile_has_unsaved_changes() - return host.has_unsaved_changes() + return self._host.workfile_has_unsaved_changes() # Current context def get_host_name(self): - host = self._host - if isinstance(host, IWorkfileHost): - return host.name - return get_current_host_name() + return self._host.name def _get_host_current_context(self): if hasattr(self._host, "get_current_context"): @@ -321,10 +311,7 @@ class BaseWorkfileController( return self._current_task_name def get_current_workfile(self): - host = self._host - if isinstance(host, IWorkfileHost): - return host.get_current_workfile() - return host.current_file() + return self._host.get_current_workfile() # Selection information def get_selected_folder_id(self): From f5c8f01da520d64e3d56728c8c9fcc148b848bcb Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:41:06 +0200 Subject: [PATCH 019/170] pass host to workfiles model --- client/ayon_core/tools/workfiles/control.py | 2 +- client/ayon_core/tools/workfiles/models/workfiles.py | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index 0bbec856ca..76a113097d 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -176,7 +176,7 @@ class BaseWorkfileController( return UsersModel(self) def _create_workfiles_model(self): - return WorkfilesModel(self) + return WorkfilesModel(self._host, self) def _create_expected_selection_obj(self): return WorkfilesToolExpectedSelection(self) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 7d56f02a2f..0be559fef4 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -91,7 +91,8 @@ class WorkareaModel: by host integration. """ - def __init__(self, controller): + def __init__(self, host, controller): + self._host = host self._controller = controller extensions = None if controller.is_host_valid(): @@ -741,11 +742,11 @@ class PublishWorkfilesModel: class WorkfilesModel: """Workfiles model.""" - def __init__(self, controller): + def __init__(self, host, controller): self._controller = controller self._entities_model = WorkfileEntitiesModel(controller) - self._workarea_model = WorkareaModel(controller) + self._workarea_model = WorkareaModel(host, controller) self._published_model = PublishWorkfilesModel(controller) def get_workfile_info(self, folder_id, task_id, filepath): From 326a182aa23fe4d8bd17197e02e64957d6e2a6fa Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:41:47 +0200 Subject: [PATCH 020/170] updated 'set_selected_workfile_path' --- client/ayon_core/tools/workfiles/control.py | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index 76a113097d..4c30a93d78 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -332,8 +332,12 @@ class BaseWorkfileController( def get_selected_workfile_path(self): return self._selection_model.get_selected_workfile_path() - def set_selected_workfile_path(self, path): - self._selection_model.set_selected_workfile_path(path) + def set_selected_workfile_path( + self, rootless_path, path, workfile_entity_id + ): + self._selection_model.set_selected_workfile_path( + rootless_path, path, workfile_entity_id + ) def get_selected_representation_id(self): return self._selection_model.get_selected_representation_id() From ad7b2c4790f29fae272bd0ebf2f9708e58a16744 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:42:36 +0200 Subject: [PATCH 021/170] more methods requiring 'IWorkfileHost' --- client/ayon_core/tools/workfiles/control.py | 36 ++++++++------------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index 4c30a93d78..bde300ad2c 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -531,7 +531,7 @@ class BaseWorkfileController( def save_current_workfile(self): current_file = self.get_current_workfile() - self._host_save_workfile(current_file) + self._host.save_workfile(current_file) def save_as_workfile( self, @@ -614,21 +614,6 @@ class BaseWorkfileController( {"failed": failed}, ) - # Helper host methods that resolve 'IWorkfileHost' interface - def _host_open_workfile(self, filepath): - host = self._host - if isinstance(host, IWorkfileHost): - host.open_workfile(filepath) - else: - host.open_file(filepath) - - def _host_save_workfile(self, filepath): - host = self._host - if isinstance(host, IWorkfileHost): - host.save_workfile(filepath) - else: - host.save_file(filepath) - def _emit_event(self, topic, data=None): self.emit_event(topic, data, "controller") @@ -685,7 +670,7 @@ class BaseWorkfileController( ): self._change_current_context(project_name, folder_id, task_id) - self._host_open_workfile(filepath) + self._host.open_workfile(filepath) emit_event("workfile.open.after", event_data, source="workfiles.tool") @@ -734,16 +719,23 @@ class BaseWorkfileController( dst_filepath = os.path.join(workdir, filename) if src_filepath: shutil.copyfile(src_filepath, dst_filepath) - self._host_open_workfile(dst_filepath) + self._host.open_workfile(dst_filepath) else: - self._host_save_workfile(dst_filepath) + self._host.save_workfile(dst_filepath) # Make sure workfile info exists - if not artist_note: - artist_note = None + if not description: + description = None + if not comment: + comment = None self.save_workfile_info( - folder_id, task_name, dst_filepath, note=artist_note + task_id, + f"{rootless_workdir}/{filename}", + version, + comment, + description, ) + self._workfiles_model.reset_workarea_file_items(task_id) # Create extra folders create_workdir_extra_folders( From ec579ca93a93c2adb8c5a0339fcac69dbd6dcd65 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:43:54 +0200 Subject: [PATCH 022/170] updated controller arguments to match needs --- client/ayon_core/tools/workfiles/control.py | 56 +++++++++++++++------ 1 file changed, 40 insertions(+), 16 deletions(-) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index bde300ad2c..649db71981 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -1,5 +1,6 @@ import os import shutil +from typing import Optional import ayon_api @@ -410,7 +411,7 @@ class BaseWorkfileController( def get_workarea_file_items(self, folder_id, task_name, sender=None): task_id = self._get_task_id(folder_id, task_name) return self._workfiles_model.get_workarea_file_items( - folder_id, task_id, task_name + folder_id, task_id ) def get_workarea_save_as_data(self, folder_id, task_id): @@ -446,16 +447,25 @@ class BaseWorkfileController( return self._workfiles_model.get_published_file_items( folder_id, task_name) - def get_workfile_info(self, folder_id, task_name, filepath): - task_id = self._get_task_id(folder_id, task_name) + def get_workfile_info(self, folder_id, task_id, rootless_path): return self._workfiles_model.get_workfile_info( - folder_id, task_id, filepath + folder_id, task_id, rootless_path ) - def save_workfile_info(self, folder_id, task_name, filepath, note): - task_id = self._get_task_id(folder_id, task_name) + def save_workfile_info( + self, + task_id, + rootless_path, + version=None, + comment=None, + description=None, + ): self._workfiles_model.save_workfile_info( - folder_id, task_id, filepath, note + task_id, + rootless_path, + version, + comment, + description, ) def reset(self): @@ -537,10 +547,12 @@ class BaseWorkfileController( self, folder_id, task_id, - workdir, + rootless_workdir, filename, template_key, - artist_note, + version, + comment, + description, ): self._emit_event("save_as.started") @@ -549,10 +561,12 @@ class BaseWorkfileController( self._save_as_workfile( folder_id, task_id, - workdir, + rootless_workdir, filename, template_key, - artist_note=artist_note, + version, + comment, + description, ) except Exception: failed = True @@ -572,7 +586,9 @@ class BaseWorkfileController( workdir, filename, template_key, - artist_note, + version, + comment, + description, ): self._emit_event("copy_representation.started") @@ -584,7 +600,9 @@ class BaseWorkfileController( workdir, filename, template_key, - artist_note, + version, + comment, + description, src_filepath=representation_filepath ) except Exception: @@ -598,7 +616,9 @@ class BaseWorkfileController( {"failed": failed}, ) - def duplicate_workfile(self, src_filepath, workdir, filename, artist_note): + def duplicate_workfile( + self, src_filepath, workdir, filename, version, comment, description + ): self._emit_event("workfile_duplicate.started") failed = False @@ -678,10 +698,12 @@ class BaseWorkfileController( self, folder_id: str, task_id: str, - workdir: str, + rootless_workdir: str, filename: str, template_key: str, - artist_note: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], src_filepath=None, ): # Trigger before save event @@ -690,6 +712,8 @@ class BaseWorkfileController( task = self.get_task_entity(project_name, task_id) task_name = task["name"] + workdir = self.project_anatomy.fill_root(rootless_workdir) + # QUESTION should the data be different for 'before' and 'after'? event_data = self._get_event_context_data( project_name, folder_id, task_id, folder, task From 16b29a6b0a102925e4af8c25975b69be2601269f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:49:55 +0200 Subject: [PATCH 023/170] added reset to workfile model --- client/ayon_core/tools/workfiles/control.py | 1 + client/ayon_core/tools/workfiles/models/workfiles.py | 8 ++++++++ 2 files changed, 9 insertions(+) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index 649db71981..cce6bfca10 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -505,6 +505,7 @@ class BaseWorkfileController( self._projects_model.reset() self._hierarchy_model.reset() + self._workfiles_model.reset() if not expected_folder_id: expected_folder_id = folder_id diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 0be559fef4..5392402063 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -455,6 +455,10 @@ class WorkfileEntitiesModel: self._items = {} self._current_username = _NOT_SET + def reset(self): + self._cache = {} + self._items = {} + def _get_workfile_info_identifier( self, folder_id, task_id, rootless_path ): @@ -749,6 +753,10 @@ class WorkfilesModel: self._workarea_model = WorkareaModel(host, controller) self._published_model = PublishWorkfilesModel(controller) + def reset(self): + self._entities_model.reset() + self._workarea_model.reset() + def get_workfile_info(self, folder_id, task_id, filepath): return self._entities_model.get_workfile_info( folder_id, task_id, filepath From 085f4cbbd7e5572f388992f5b3345c511330ab7d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:51:28 +0200 Subject: [PATCH 024/170] added more cache items --- .../ayon_core/tools/workfiles/models/workfiles.py | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 5392402063..7b928cf57e 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -7,7 +7,11 @@ import arrow import ayon_api from ayon_api.operations import OperationsSession -from ayon_core.lib import get_ayon_username +from ayon_core.lib import ( + get_ayon_username, + NestedCacheItem, + CacheItem, +) from ayon_core.pipeline.template_data import ( get_template_data, get_task_template_data, @@ -102,6 +106,10 @@ class WorkareaModel: self._fill_data_by_folder_id = {} self._task_data_by_folder_id = {} self._workdir_by_context = {} + self._file_items_mapping = {} + self._file_items_cache = NestedCacheItem( + levels=1, default_factory=list + ) @property def project_name(self): @@ -111,6 +119,9 @@ class WorkareaModel: self._base_data = None self._fill_data_by_folder_id = {} self._task_data_by_folder_id = {} + self._workdir_by_context = {} + self._file_items_mapping = {} + self._file_items_cache.reset() def _get_base_data(self): if self._base_data is None: From 1211a714362da13687740946958ab0203776bc6c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:52:45 +0200 Subject: [PATCH 025/170] move private methods below public ones --- .../tools/workfiles/models/workfiles.py | 294 +++++++++--------- 1 file changed, 147 insertions(+), 147 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 7b928cf57e..9cb174b840 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -123,51 +123,6 @@ class WorkareaModel: self._file_items_mapping = {} self._file_items_cache.reset() - def _get_base_data(self): - if self._base_data is None: - base_data = get_template_data( - ayon_api.get_project(self._project_name), - host_name=self._controller.get_host_name(), - ) - self._base_data = base_data - return copy.deepcopy(self._base_data) - - def _get_folder_data(self, folder_id): - fill_data = self._fill_data_by_folder_id.get(folder_id) - if fill_data is None: - folder = self._controller.get_folder_entity( - self.project_name, folder_id - ) - fill_data = get_folder_template_data(folder, self.project_name) - self._fill_data_by_folder_id[folder_id] = fill_data - return copy.deepcopy(fill_data) - - def _get_task_data(self, project_entity, folder_id, task_id): - task_data = self._task_data_by_folder_id.setdefault(folder_id, {}) - if task_id not in task_data: - task = self._controller.get_task_entity( - self.project_name, task_id - ) - if task: - task_data[task_id] = get_task_template_data( - project_entity, task) - return copy.deepcopy(task_data[task_id]) - - def _prepare_fill_data(self, folder_id, task_id): - if not folder_id or not task_id: - return {} - - base_data = self._get_base_data() - project_name = base_data["project"]["name"] - folder_data = self._get_folder_data(folder_id) - project_entity = self._controller.get_project_entity(project_name) - task_data = self._get_task_data(project_entity, folder_id, task_id) - - base_data.update(folder_data) - base_data.update(task_data) - - return base_data - def get_workarea_dir_by_context(self, folder_id, task_id): if not folder_id or not task_id: return None @@ -218,108 +173,6 @@ class WorkareaModel: )) return items - def _get_template_key(self, fill_data): - task_type = fill_data.get("task", {}).get("type") - # TODO cache - return get_workfile_template_key( - self.project_name, - task_type, - self._controller.get_host_name(), - project_settings=self._controller.project_settings, - ) - - def _get_last_workfile_version( - self, workdir, file_template, fill_data, extensions - ): - """ - - Todos: - Validate if logic of this function is correct. It does return - last version + 1 which might be wrong. - - Args: - workdir (str): Workdir path. - file_template (str): File template. - fill_data (dict[str, Any]): Fill data. - extensions (set[str]): Extensions. - - Returns: - int: Next workfile version. - - """ - version = get_last_workfile_with_version( - workdir, file_template, fill_data, extensions - )[1] - - if version is None: - task_info = fill_data.get("task", {}) - version = get_versioning_start( - self.project_name, - self._controller.get_host_name(), - task_name=task_info.get("name"), - task_type=task_info.get("type"), - product_type="workfile", - project_settings=self._controller.project_settings, - ) - else: - version += 1 - return version - - def _get_comments_from_root( - self, - file_template, - extensions, - fill_data, - root, - current_filename, - ): - """Get comments from root directory. - - Args: - file_template (AnatomyStringTemplate): File template. - extensions (set[str]): Extensions. - fill_data (dict[str, Any]): Fill data. - root (str): Root directory. - current_filename (str): Current filename. - - Returns: - Tuple[list[str], Union[str, None]]: Comment hints and current - comment. - - """ - current_comment = None - filenames = [] - if root and os.path.exists(root): - for filename in os.listdir(root): - path = os.path.join(root, filename) - if not os.path.isfile(path): - continue - - ext = os.path.splitext(filename)[-1].lower() - if ext in extensions: - filenames.append(filename) - - if not filenames: - return [], current_comment - - matcher = CommentMatcher(extensions, file_template, fill_data) - - comment_hints = set() - for filename in filenames: - comment = matcher.parse_comment(filename) - if comment: - comment_hints.add(comment) - if filename == current_filename: - current_comment = comment - - return list(comment_hints), current_comment - - def _get_workdir(self, anatomy, template_key, fill_data): - directory_template = anatomy.get_template_item( - "work", template_key, "directory" - ) - return directory_template.format_strict(fill_data).normalized() - def get_workarea_save_as_data(self, folder_id, task_id): folder_entity = None task_entity = None @@ -452,6 +305,153 @@ class WorkareaModel: exists ) + def _get_base_data(self): + if self._base_data is None: + base_data = get_template_data( + ayon_api.get_project(self._project_name), + host_name=self._controller.get_host_name(), + ) + self._base_data = base_data + return copy.deepcopy(self._base_data) + + def _get_folder_data(self, folder_id): + fill_data = self._fill_data_by_folder_id.get(folder_id) + if fill_data is None: + folder = self._controller.get_folder_entity( + self.project_name, folder_id + ) + fill_data = get_folder_template_data(folder, self.project_name) + self._fill_data_by_folder_id[folder_id] = fill_data + return copy.deepcopy(fill_data) + + def _get_task_data(self, project_entity, folder_id, task_id): + task_data = self._task_data_by_folder_id.setdefault(folder_id, {}) + if task_id not in task_data: + task = self._controller.get_task_entity( + self.project_name, task_id + ) + if task: + task_data[task_id] = get_task_template_data( + project_entity, task) + return copy.deepcopy(task_data[task_id]) + + def _prepare_fill_data(self, folder_id, task_id): + if not folder_id or not task_id: + return {} + + base_data = self._get_base_data() + project_name = base_data["project"]["name"] + folder_data = self._get_folder_data(folder_id) + project_entity = self._controller.get_project_entity(project_name) + task_data = self._get_task_data(project_entity, folder_id, task_id) + + base_data.update(folder_data) + base_data.update(task_data) + + return base_data + + def _get_template_key(self, fill_data): + task_type = fill_data.get("task", {}).get("type") + # TODO cache + return get_workfile_template_key( + self.project_name, + task_type, + self._controller.get_host_name(), + project_settings=self._controller.project_settings, + ) + + def _get_last_workfile_version( + self, workdir, file_template, fill_data, extensions + ): + """ + + Todos: + Validate if logic of this function is correct. It does return + last version + 1 which might be wrong. + + Args: + workdir (str): Workdir path. + file_template (str): File template. + fill_data (dict[str, Any]): Fill data. + extensions (set[str]): Extensions. + + Returns: + int: Next workfile version. + + """ + version = get_last_workfile_with_version( + workdir, file_template, fill_data, extensions + )[1] + + if version is None: + task_info = fill_data.get("task", {}) + version = get_versioning_start( + self.project_name, + self._controller.get_host_name(), + task_name=task_info.get("name"), + task_type=task_info.get("type"), + product_type="workfile", + project_settings=self._controller.project_settings, + ) + else: + version += 1 + return version + + def _get_comments_from_root( + self, + file_template, + extensions, + fill_data, + root, + current_filename, + ): + """Get comments from root directory. + + Args: + file_template (AnatomyStringTemplate): File template. + extensions (set[str]): Extensions. + fill_data (dict[str, Any]): Fill data. + root (str): Root directory. + current_filename (str): Current filename. + + Returns: + Tuple[list[str], Union[str, None]]: Comment hints and current + comment. + + """ + current_comment = None + filenames = [] + if root and os.path.exists(root): + for filename in os.listdir(root): + path = os.path.join(root, filename) + if not os.path.isfile(path): + continue + + ext = os.path.splitext(filename)[-1].lower() + if ext in extensions: + filenames.append(filename) + + if not filenames: + return [], current_comment + + matcher = CommentMatcher(extensions, file_template, fill_data) + + comment_hints = set() + for filename in filenames: + comment = matcher.parse_comment(filename) + if comment: + comment_hints.add(comment) + if filename == current_filename: + current_comment = comment + + return list(comment_hints), current_comment + + def _get_workdir(self, anatomy, template_key, fill_data): + directory_template = anatomy.get_template_item( + "work", template_key, "directory" + ) + return directory_template.format_strict(fill_data).normalized() + class WorkfileEntitiesModel: """Workfile entities model. From a2dad64fb57d76988630d87a14415d94e238f97f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:53:28 +0200 Subject: [PATCH 026/170] move public methods above private --- .../tools/workfiles/models/workfiles.py | 110 +++++++++--------- 1 file changed, 55 insertions(+), 55 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 9cb174b840..14eee7b895 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -470,61 +470,6 @@ class WorkfileEntitiesModel: self._cache = {} self._items = {} - def _get_workfile_info_identifier( - self, folder_id, task_id, rootless_path - ): - return "_".join([folder_id, task_id, rootless_path]) - - def _get_rootless_path(self, filepath): - anatomy = self._controller.project_anatomy - - workdir, filename = os.path.split(filepath) - _, rootless_dir = anatomy.find_root_template_from_path(workdir) - return "/".join([ - os.path.normpath(rootless_dir).replace("\\", "/"), - filename - ]) - - def _prepare_workfile_info_item( - self, folder_id, task_id, workfile_info, filepath - ): - note = "" - created_by = None - updated_by = None - if workfile_info: - note = workfile_info["attrib"].get("description") or "" - created_by = workfile_info.get("createdBy") - updated_by = workfile_info.get("updatedBy") - - filestat = os.stat(filepath) - return WorkfileInfo( - folder_id, - task_id, - filepath, - filesize=filestat.st_size, - creation_time=filestat.st_ctime, - modification_time=filestat.st_mtime, - created_by=created_by, - updated_by=updated_by, - note=note - ) - - def _get_workfile_info(self, folder_id, task_id, identifier): - workfile_info = self._cache.get(identifier) - if workfile_info is not None: - return workfile_info - - for workfile_info in ayon_api.get_workfiles_info( - self._controller.get_current_project_name(), - task_ids=[task_id], - fields=["id", "path", "attrib", "createdBy", "updatedBy"], - ): - workfile_identifier = self._get_workfile_info_identifier( - folder_id, task_id, workfile_info["path"] - ) - self._cache[workfile_identifier] = workfile_info - return self._cache.get(identifier) - def get_workfile_info( self, folder_id, task_id, filepath, rootless_path=None ): @@ -599,6 +544,61 @@ class WorkfileEntitiesModel: ) session.commit() + def _get_workfile_info_identifier( + self, folder_id, task_id, rootless_path + ): + return "_".join([folder_id, task_id, rootless_path]) + + def _get_rootless_path(self, filepath): + anatomy = self._controller.project_anatomy + + workdir, filename = os.path.split(filepath) + _, rootless_dir = anatomy.find_root_template_from_path(workdir) + return "/".join([ + os.path.normpath(rootless_dir).replace("\\", "/"), + filename + ]) + + def _prepare_workfile_info_item( + self, folder_id, task_id, workfile_info, filepath + ): + note = "" + created_by = None + updated_by = None + if workfile_info: + note = workfile_info["attrib"].get("description") or "" + created_by = workfile_info.get("createdBy") + updated_by = workfile_info.get("updatedBy") + + filestat = os.stat(filepath) + return WorkfileInfo( + folder_id, + task_id, + filepath, + filesize=filestat.st_size, + creation_time=filestat.st_ctime, + modification_time=filestat.st_mtime, + created_by=created_by, + updated_by=updated_by, + note=note + ) + + def _get_workfile_info(self, folder_id, task_id, identifier): + workfile_info = self._cache.get(identifier) + if workfile_info is not None: + return workfile_info + + for workfile_info in ayon_api.get_workfiles_info( + self._controller.get_current_project_name(), + task_ids=[task_id], + fields=["id", "path", "attrib", "createdBy", "updatedBy"], + ): + workfile_identifier = self._get_workfile_info_identifier( + folder_id, task_id, workfile_info["path"] + ) + self._cache[workfile_identifier] = workfile_info + return self._cache.get(identifier) + def _create_workfile_info_entity(self, task_id, rootless_path, note): extension = os.path.splitext(rootless_path)[1] From 0f64ab1ab64022644a80a1d57abb9c103214e488 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:54:43 +0200 Subject: [PATCH 027/170] remove unused method --- .../tools/workfiles/models/workfiles.py | 49 ------------------- 1 file changed, 49 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 14eee7b895..0f44a960a1 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -397,55 +397,6 @@ class WorkareaModel: version += 1 return version - def _get_comments_from_root( - self, - file_template, - extensions, - fill_data, - root, - current_filename, - ): - """Get comments from root directory. - - Args: - file_template (AnatomyStringTemplate): File template. - extensions (set[str]): Extensions. - fill_data (dict[str, Any]): Fill data. - root (str): Root directory. - current_filename (str): Current filename. - - Returns: - Tuple[list[str], Union[str, None]]: Comment hints and current - comment. - - """ - current_comment = None - filenames = [] - if root and os.path.exists(root): - for filename in os.listdir(root): - path = os.path.join(root, filename) - if not os.path.isfile(path): - continue - - ext = os.path.splitext(filename)[-1].lower() - if ext in extensions: - filenames.append(filename) - - if not filenames: - return [], current_comment - - matcher = CommentMatcher(extensions, file_template, fill_data) - - comment_hints = set() - for filename in filenames: - comment = matcher.parse_comment(filename) - if comment: - comment_hints.add(comment) - if filename == current_filename: - current_comment = comment - - return list(comment_hints), current_comment - def _get_workdir(self, anatomy, template_key, fill_data): directory_template = anatomy.get_template_item( "work", template_key, "directory" From 5fe625a8bd140e1d8804a2b757f3d9f6a45ebb86 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 16:55:32 +0200 Subject: [PATCH 028/170] remove more unnecessary methods --- .../tools/workfiles/models/workfiles.py | 55 ------------------- 1 file changed, 55 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 0f44a960a1..4e2bce3e31 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -495,61 +495,6 @@ class WorkfileEntitiesModel: ) session.commit() - def _get_workfile_info_identifier( - self, folder_id, task_id, rootless_path - ): - return "_".join([folder_id, task_id, rootless_path]) - - def _get_rootless_path(self, filepath): - anatomy = self._controller.project_anatomy - - workdir, filename = os.path.split(filepath) - _, rootless_dir = anatomy.find_root_template_from_path(workdir) - return "/".join([ - os.path.normpath(rootless_dir).replace("\\", "/"), - filename - ]) - - def _prepare_workfile_info_item( - self, folder_id, task_id, workfile_info, filepath - ): - note = "" - created_by = None - updated_by = None - if workfile_info: - note = workfile_info["attrib"].get("description") or "" - created_by = workfile_info.get("createdBy") - updated_by = workfile_info.get("updatedBy") - - filestat = os.stat(filepath) - return WorkfileInfo( - folder_id, - task_id, - filepath, - filesize=filestat.st_size, - creation_time=filestat.st_ctime, - modification_time=filestat.st_mtime, - created_by=created_by, - updated_by=updated_by, - note=note - ) - - def _get_workfile_info(self, folder_id, task_id, identifier): - workfile_info = self._cache.get(identifier) - if workfile_info is not None: - return workfile_info - - for workfile_info in ayon_api.get_workfiles_info( - self._controller.get_current_project_name(), - task_ids=[task_id], - fields=["id", "path", "attrib", "createdBy", "updatedBy"], - ): - workfile_identifier = self._get_workfile_info_identifier( - folder_id, task_id, workfile_info["path"] - ) - self._cache[workfile_identifier] = workfile_info - return self._cache.get(identifier) - def _create_workfile_info_entity(self, task_id, rootless_path, note): extension = os.path.splitext(rootless_path)[1] From f4961bc1f9c3a1b571406c6752ac7740e79b5bcf Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:02:15 +0200 Subject: [PATCH 029/170] updated workarea model --- .../tools/workfiles/models/workfiles.py | 316 ++++++++++-------- 1 file changed, 182 insertions(+), 134 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 4e2bce3e31..6fc76ac458 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -1,7 +1,10 @@ +from __future__ import annotations import os -import re import copy import uuid +import platform +import typing +from typing import Optional, Any import arrow import ayon_api @@ -12,6 +15,7 @@ from ayon_core.lib import ( NestedCacheItem, CacheItem, ) +from ayon_core.host import WorkfileInfo from ayon_core.pipeline.template_data import ( get_template_data, get_task_template_data, @@ -20,73 +24,22 @@ from ayon_core.pipeline.template_data import ( from ayon_core.pipeline.workfile import ( get_workdir_with_workdir_data, get_workfile_template_key, - get_last_workfile_with_version, + get_last_workfile_with_version_from_paths, + get_comments_from_workfile_paths, ) from ayon_core.pipeline.version_start import get_versioning_start from ayon_core.tools.workfiles.abstract import ( WorkareaFilepathResult, FileItem, - WorkfileInfo, ) +if typing.TYPE_CHECKING: + from typing import Union + from ayon_core.pipeline import Anatomy + _NOT_SET = object() -class CommentMatcher(object): - """Use anatomy and work file data to parse comments from filenames. - - Args: - extensions (set[str]): Set of extensions. - file_template (AnatomyStringTemplate): File template. - data (dict[str, Any]): Data to fill the template with. - - """ - def __init__(self, extensions, file_template, data): - self.fname_regex = None - - if "{comment}" not in file_template: - # Don't look for comment if template doesn't allow it - return - - # Create a regex group for extensions - any_extension = "(?:{})".format( - "|".join(re.escape(ext.lstrip(".")) for ext in extensions) - ) - - # Use placeholders that will never be in the filename - temp_data = copy.deepcopy(data) - temp_data["comment"] = "<>" - temp_data["version"] = "<>" - temp_data["ext"] = "<>" - - fname_pattern = file_template.format_strict(temp_data) - fname_pattern = re.escape(fname_pattern) - - # Replace comment and version with something we can match with regex - replacements = { - "<>": "(.+)", - "<>": "[0-9]+", - "<>": any_extension, - } - for src, dest in replacements.items(): - fname_pattern = fname_pattern.replace(re.escape(src), dest) - - # Match from beginning to end of string to be safe - fname_pattern = "^{}$".format(fname_pattern) - - self.fname_regex = re.compile(fname_pattern) - - def parse_comment(self, filepath): - """Parse the {comment} part from a filename""" - if not self.fname_regex: - return - - fname = os.path.basename(filepath) - match = self.fname_regex.match(fname) - if match: - return match.group(1) - - class WorkareaModel: """Workfiles model looking for workfiles in workare folder. @@ -111,10 +64,6 @@ class WorkareaModel: levels=1, default_factory=list ) - @property - def project_name(self): - return self._controller.get_current_project_name() - def reset(self): self._base_data = None self._fill_data_by_folder_id = {} @@ -123,7 +72,14 @@ class WorkareaModel: self._file_items_mapping = {} self._file_items_cache.reset() - def get_workarea_dir_by_context(self, folder_id, task_id): + def reset_file_items(self, task_id: str): + cache: CacheItem = self._file_items_cache[task_id] + cache.set_invalid() + self._file_items_mapping.pop(task_id, None) + + def get_workarea_dir_by_context( + self, folder_id: str, task_id: str + ) -> Optional[str]: if not folder_id or not task_id: return None folder_mapping = self._workdir_by_context.setdefault(folder_id, {}) @@ -135,54 +91,56 @@ class WorkareaModel: workdir = get_workdir_with_workdir_data( workdir_data, - self.project_name, + self._project_name, anatomy=self._controller.project_anatomy, ) folder_mapping[task_id] = workdir return workdir - def get_file_items(self, folder_id, task_id, task_name): - items = [] - if not folder_id or not task_id: - return items + def get_file_items( + self, + folder_id: Optional[str], + task_id: Optional[str], + ) -> list[WorkfileInfo]: + return self._cache_file_items(folder_id, task_id) - workdir = self.get_workarea_dir_by_context(folder_id, task_id) - if not os.path.exists(workdir): - return items + def get_workfile_info( + self, + folder_id: Optional[str], + task_id: Optional[str], + rootless_path: Optional[str] + ): + if not folder_id or not task_id or not rootless_path: + return None - for filename in os.listdir(workdir): - # We want to support both files and folders. e.g. Silhoutte uses - # folders as its project files. So we do not check whether it is - # a file or not. - filepath = os.path.join(workdir, filename) + mapping = self._file_items_mapping.get(task_id) + if mapping is None: + self._cache_file_items(folder_id, task_id) + mapping = self._file_items_mapping[task_id] + return mapping.get(rootless_path) - ext = os.path.splitext(filename)[1].lower() - if ext not in self._extensions: - continue + def update_file_description( + self, task_id: str, rootless_path: str, description: str + ): + mapping = self._file_items_mapping.get(task_id) + if not mapping: + return + item = mapping.get(rootless_path) + if item is not None: + item.description = description - workfile_info = self._controller.get_workfile_info( - folder_id, task_name, filepath - ) - modified = os.path.getmtime(filepath) - items.append(FileItem( - workdir, - filename, - modified, - workfile_info.created_by, - workfile_info.updated_by, - )) - return items - - def get_workarea_save_as_data(self, folder_id, task_id): + def get_workarea_save_as_data( + self, folder_id: Optional[str], task_id: Optional[str] + ) -> dict[str, Any]: folder_entity = None task_entity = None if folder_id: folder_entity = self._controller.get_folder_entity( - self.project_name, folder_id + self._project_name, folder_id ) if folder_entity and task_id: task_entity = self._controller.get_task_entity( - self.project_name, task_id + self._project_name, task_id ) if not folder_entity or not task_entity: @@ -192,6 +150,7 @@ class WorkareaModel: "template_has_comment": None, "ext": None, "workdir": None, + "rootless_workdir": None, "comment": None, "comment_hints": None, "last_version": None, @@ -215,6 +174,17 @@ class WorkareaModel: workdir = self._get_workdir(anatomy, template_key, fill_data) + rootless_workdir = workdir + if platform.system().lower() == "windows": + rootless_workdir = rootless_workdir.replace("\\", "/") + + used_roots = workdir.used_values.get("root") + if used_roots: + used_root_name = next(iter(used_roots)) + root_value = used_roots[used_root_name] + workdir_end = rootless_workdir[len(root_value):].lstrip("/") + rootless_workdir = f"{{root[{used_root_name}]}}/{workdir_end}" + file_template = anatomy.get_template_item( "work", template_key, "file" ) @@ -223,15 +193,20 @@ class WorkareaModel: template_has_version = "{version" in file_template_str template_has_comment = "{comment" in file_template_str - comment_hints, comment = self._get_comments_from_root( + file_items = self.get_file_items(folder_id, task_id) + filepaths = [ + item.filepath + for item in file_items + ] + comment_hints, comment = get_comments_from_workfile_paths( + filepaths, file_template, extensions, fill_data, - workdir, current_filename, ) last_version = self._get_last_workfile_version( - workdir, file_template_str, fill_data, extensions + filepaths, file_template_str, fill_data, extensions ) return { @@ -240,6 +215,7 @@ class WorkareaModel: "template_has_comment": template_has_comment, "ext": current_ext, "workdir": workdir, + "rootless_workdir": rootless_workdir, "comment": comment, "comment_hints": comment_hints, "last_version": last_version, @@ -248,13 +224,13 @@ class WorkareaModel: def fill_workarea_filepath( self, - folder_id, - task_id, - extension, - use_last_version, - version, - comment, - ): + folder_id: str, + task_id: str, + extension: str, + use_last_version: bool, + version: int, + comment: str, + ) -> WorkareaFilepathResult: """Fill workarea filepath based on context. Args: @@ -281,8 +257,16 @@ class WorkareaModel: ) if use_last_version: + file_items = self.get_file_items(folder_id, task_id) + filepaths = [ + item.filepath + for item in file_items + ] version = self._get_last_workfile_version( - workdir, file_template.template, fill_data, self._extensions + filepaths, + file_template.template, + fill_data, + self._extensions ) fill_data["version"] = version fill_data["ext"] = extension.lstrip(".") @@ -305,7 +289,11 @@ class WorkareaModel: exists ) - def _get_base_data(self): + @property + def _project_name(self) -> str: + return self._controller.get_current_project_name() + + def _get_base_data(self) -> dict[str, Any]: if self._base_data is None: base_data = get_template_data( ayon_api.get_project(self._project_name), @@ -314,28 +302,35 @@ class WorkareaModel: self._base_data = base_data return copy.deepcopy(self._base_data) - def _get_folder_data(self, folder_id): + def _get_folder_data(self, folder_id: str) -> dict[str, Any]: fill_data = self._fill_data_by_folder_id.get(folder_id) if fill_data is None: folder = self._controller.get_folder_entity( - self.project_name, folder_id + self._project_name, folder_id ) - fill_data = get_folder_template_data(folder, self.project_name) + fill_data = get_folder_template_data(folder, self._project_name) self._fill_data_by_folder_id[folder_id] = fill_data return copy.deepcopy(fill_data) - def _get_task_data(self, project_entity, folder_id, task_id): + def _get_task_data( + self, + project_entity: dict[str, Any], + folder_id: str, + task_id: str + ) -> dict[str, Any]: task_data = self._task_data_by_folder_id.setdefault(folder_id, {}) if task_id not in task_data: task = self._controller.get_task_entity( - self.project_name, task_id + self._project_name, task_id ) if task: task_data[task_id] = get_task_template_data( project_entity, task) return copy.deepcopy(task_data[task_id]) - def _prepare_fill_data(self, folder_id, task_id): + def _prepare_fill_data( + self, folder_id: str, task_id: str + ) -> dict[str, Any]: if not folder_id or not task_id: return {} @@ -350,19 +345,71 @@ class WorkareaModel: return base_data - def _get_template_key(self, fill_data): + def _cache_file_items( + self, folder_id: Optional[str], task_id: Optional[str] + ) -> list[WorkfileInfo]: + if not folder_id or not task_id: + return [] + + cache: CacheItem = self._file_items_cache[task_id] + if cache.is_valid: + return cache.get_data() + + project_entity = self._controller.get_project_entity( + self._project_name + ) + folder_entity = self._controller.get_folder_entity( + self._project_name, folder_id + ) + task_entity = self._controller.get_task_entity( + self._project_name, task_id + ) + anatomy = self._controller.project_anatomy + project_settings = self._controller.project_settings + workfile_entities = self._controller.get_workfile_entities(task_id) + + fill_data = self._prepare_fill_data(folder_id, task_id) + template_key = self._get_template_key(fill_data) + + items = self._host.list_workfiles( + self._project_name, + folder_id, + task_id, + project_entity=project_entity, + folder_entity=folder_entity, + task_entity=task_entity, + anatomy=anatomy, + template_key=template_key, + project_settings=project_settings, + workfile_entities=workfile_entities, + ) + cache.update_data(items) + + # Cache items by entity ids and rootless path + self._file_items_mapping[task_id] = { + item.rootless_path: item + for item in items + } + + return items + + def _get_template_key(self, fill_data: dict[str, Any]) -> str: task_type = fill_data.get("task", {}).get("type") # TODO cache return get_workfile_template_key( - self.project_name, + self._project_name, task_type, self._controller.get_host_name(), project_settings=self._controller.project_settings, ) def _get_last_workfile_version( - self, workdir, file_template, fill_data, extensions - ): + self, + filepaths: list[str], + file_template: str, + fill_data: dict[str, Any], + extensions: set[str] + ) -> int: """ Todos: @@ -370,7 +417,7 @@ class WorkareaModel: last version + 1 which might be wrong. Args: - workdir (str): Workdir path. + filepaths (list[str]): Workfile paths. file_template (str): File template. fill_data (dict[str, Any]): Fill data. extensions (set[str]): Extensions. @@ -379,25 +426,26 @@ class WorkareaModel: int: Next workfile version. """ - version = get_last_workfile_with_version( - workdir, file_template, fill_data, extensions + version = get_last_workfile_with_version_from_paths( + filepaths, file_template, fill_data, extensions )[1] + if version is not None: + return version + 1 - if version is None: - task_info = fill_data.get("task", {}) - version = get_versioning_start( - self.project_name, - self._controller.get_host_name(), - task_name=task_info.get("name"), - task_type=task_info.get("type"), - product_type="workfile", - project_settings=self._controller.project_settings, - ) - else: - version += 1 - return version - def _get_workdir(self, anatomy, template_key, fill_data): + task_info = fill_data.get("task", {}) + return get_versioning_start( + self._project_name, + self._controller.get_host_name(), + task_name=task_info.get("name"), + task_type=task_info.get("type"), + product_type="workfile", + project_settings=self._controller.project_settings, + ) + + def _get_workdir( + self, anatomy: "Anatomy", template_key: str, fill_data: dict[str, Any] + ): directory_template = anatomy.get_template_item( "work", template_key, "directory" ) From 98acfd8dfcbbe7d5d4fe4eee0ec74d0539d3be92 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:03:21 +0200 Subject: [PATCH 030/170] updated entities model --- .../tools/workfiles/models/workfiles.py | 194 ++++++++++++------ 1 file changed, 126 insertions(+), 68 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 6fc76ac458..e4d555261e 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -456,107 +456,145 @@ class WorkfileEntitiesModel: """Workfile entities model. Args: - control (AbstractWorkfileController): Controller object. - """ + controller (AbstractWorkfileController): Controller object. + """ def __init__(self, controller): self._controller = controller - self._cache = {} - self._items = {} + self._workfile_entities_by_task_id = {} self._current_username = _NOT_SET def reset(self): - self._cache = {} - self._items = {} + self._workfile_entities_by_task_id = {} - def get_workfile_info( - self, folder_id, task_id, filepath, rootless_path=None + def get_workfile_entities(self, task_id: str): + if not task_id: + return [] + workfile_entities = self._workfile_entities_by_task_id.get(task_id) + if workfile_entities is None: + workfile_entities = list(ayon_api.get_workfiles_info( + self._controller.get_current_project_name(), + task_ids=[task_id], + )) + self._workfile_entities_by_task_id[task_id] = workfile_entities + return workfile_entities + + def save_workfile_info( + self, + task_id: str, + rootless_path: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], ): - if not folder_id or not task_id or not filepath: - return None - - if rootless_path is None: - rootless_path = self._get_rootless_path(filepath) - - identifier = self._get_workfile_info_identifier( - folder_id, task_id, rootless_path) - item = self._items.get(identifier) - if item is None: - workfile_info = self._get_workfile_info( - folder_id, task_id, identifier - ) - item = self._prepare_workfile_info_item( - folder_id, task_id, workfile_info, filepath - ) - self._items[identifier] = item - return item - - def save_workfile_info(self, folder_id, task_id, filepath, note): - rootless_path = self._get_rootless_path(filepath) - identifier = self._get_workfile_info_identifier( - folder_id, task_id, rootless_path + # TODO create pipeline function for this + workfile_entities = self.get_workfile_entities(task_id) + workfile_entity = next( + ( + _ent + for _ent in workfile_entities + if _ent["path"] == rootless_path + ), + None ) - workfile_info = self._get_workfile_info( - folder_id, task_id, identifier - ) - if not workfile_info: - self._cache[identifier] = self._create_workfile_info_entity( - task_id, rootless_path, note or "") - self._items.pop(identifier, None) + if not workfile_entity: + workfile_entity = self._create_workfile_info_entity( + task_id, + rootless_path, + version, + comment, + description, + ) + workfile_entities.append(workfile_entity) return - old_note = workfile_info.get("attrib", {}).get("note") + data = {} + for key, value in ( + ("host_name", self._controller.get_host_name()), + ("version", version), + ("comment", comment), + ): + if value is not None: + data[key] = value + + old_data = workfile_entity["data"] + + changed_data = {} + for key, value in data.items(): + if key not in old_data or old_data[key] != value: + changed_data[key] = value - new_workfile_info = copy.deepcopy(workfile_info) update_data = {} - if note is not None and old_note != note: - update_data["attrib"] = {"description": note} - attrib = new_workfile_info.setdefault("attrib", {}) - attrib["description"] = note + 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 username = self._get_current_username() # Automatically fix 'createdBy' and 'updatedBy' fields # NOTE both fields were not automatically filled by server # until 1.1.3 release. - if workfile_info.get("createdBy") is None: + if workfile_entity.get("createdBy") is None: update_data["createdBy"] = username - new_workfile_info["createdBy"] = username + workfile_entity["createdBy"] = username - if workfile_info.get("updatedBy") != username: + if workfile_entity.get("updatedBy") != username: update_data["updatedBy"] = username - new_workfile_info["updatedBy"] = username + workfile_entity["updatedBy"] = username if not update_data: return - self._cache[identifier] = new_workfile_info - self._items.pop(identifier, None) - project_name = self._controller.get_current_project_name() session = OperationsSession() session.update_entity( project_name, "workfile", - workfile_info["id"], + workfile_entity["id"], update_data, ) session.commit() - def _create_workfile_info_entity(self, task_id, rootless_path, note): + def _create_workfile_info_entity( + self, + task_id: str, + rootless_path: str, + version: Optional[int], + comment: Optional[str], + description: str, + ) -> dict[str, Any]: extension = os.path.splitext(rootless_path)[1] project_name = self._controller.get_current_project_name() + attrib = {} + for key, value in ( + ("extension", extension), + ("description", description), + ): + if value is not None: + attrib[key] = value + + data = {} + for key, value in ( + ("host_name", self._controller.get_host_name()), + ("version", version), + ("comment", comment), + ): + if value is not None: + data[key] = value + username = self._get_current_username() workfile_info = { "id": uuid.uuid4().hex, "path": rootless_path, "taskId": task_id, - "attrib": { - "extension": extension, - "description": note - }, + "attrib": attrib, + "data": data, # TODO remove 'createdBy' and 'updatedBy' fields when server is # or above 1.1.3 . "createdBy": username, @@ -568,7 +606,7 @@ class WorkfileEntitiesModel: session.commit() return workfile_info - def _get_current_username(self): + def _get_current_username(self) -> str: if self._current_username is _NOT_SET: self._current_username = get_ayon_username() return self._current_username @@ -709,18 +747,38 @@ class WorkfilesModel: self._published_model = PublishWorkfilesModel(controller) def reset(self): - self._entities_model.reset() self._workarea_model.reset() + self._entities_model.reset() - def get_workfile_info(self, folder_id, task_id, filepath): - return self._entities_model.get_workfile_info( - folder_id, task_id, filepath + def reset_workarea_file_items(self, task_id): + self._workarea_model.reset_file_items(task_id) + + def get_workfile_info(self, folder_id, task_id, rootless_path): + return self._workarea_model.get_workfile_info( + folder_id, task_id, rootless_path ) - def save_workfile_info(self, folder_id, task_id, filepath, note): + def save_workfile_info( + self, + task_id, + rootless_path, + version, + comment, + description, + ): self._entities_model.save_workfile_info( - folder_id, task_id, filepath, note + task_id, + rootless_path, + version, + comment, + description, ) + self._workarea_model.update_file_description( + task_id, rootless_path, description + ) + + def get_workfile_entities(self, task_id): + return self._entities_model.get_workfile_entities(task_id) def get_workarea_dir_by_context(self, folder_id, task_id): """Workarea dir for passed context. @@ -738,20 +796,20 @@ class WorkfilesModel: return self._workarea_model.get_workarea_dir_by_context( folder_id, task_id) - def get_workarea_file_items(self, folder_id, task_id, task_name): + def get_workarea_file_items(self, folder_id, task_id): """Workfile items for passed context from workarea. Args: folder_id (Union[str, None]): Folder id. task_id (Union[str, None]): Task id. - task_name (Union[str, None]): Task name. Returns: - list[FileItem]: List of file items matching workarea of passed + list[WorkfileInfo]: List of file items matching workarea of passed context. + """ return self._workarea_model.get_file_items( - folder_id, task_id, task_name + folder_id, task_id ) def get_workarea_save_as_data(self, folder_id, task_id): From 60c2c4e01848450ffe73948a80355993e592f7bd Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:04:18 +0200 Subject: [PATCH 031/170] move public method above private --- .../tools/workfiles/models/workfiles.py | 118 +++++++++--------- 1 file changed, 61 insertions(+), 57 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index e4d555261e..283b707865 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -626,63 +626,7 @@ class PublishWorkfilesModel: self._cached_extensions = None self._cached_repre_extensions = None - @property - def _extensions(self): - if self._cached_extensions is None: - exts = self._controller.get_workfile_extensions() or [] - self._cached_extensions = exts - return self._cached_extensions - - @property - def _repre_extensions(self): - if self._cached_repre_extensions is None: - self._cached_repre_extensions = { - ext.lstrip(".") for ext in self._extensions - } - return self._cached_repre_extensions - - def _file_item_from_representation( - self, repre_entity, project_anatomy, author, task_name=None - ): - if task_name is not None: - task_info = repre_entity["context"].get("task") - if not task_info or task_info["name"] != task_name: - return None - - # Filter by extension - extensions = self._repre_extensions - workfile_path = None - for repre_file in repre_entity["files"]: - ext = ( - os.path.splitext(repre_file["name"])[1] - .lower() - .lstrip(".") - ) - if ext in extensions: - workfile_path = repre_file["path"] - break - - if not workfile_path: - return None - - try: - workfile_path = workfile_path.format( - root=project_anatomy.roots) - except Exception as exc: - print("Failed to format workfile path: {}".format(exc)) - - dirpath, filename = os.path.split(workfile_path) - created_at = arrow.get(repre_entity["createdAt"]).to("local") - return FileItem( - dirpath, - filename, - created_at.float_timestamp, - author, - None, - repre_entity["id"] - ) - - def get_file_items(self, folder_id, task_name): + def get_file_items(self, folder_id: str, task_name: str) -> list[FileItem]: # TODO refactor to use less server API calls project_name = self._controller.get_current_project_name() # Get subset docs of folder @@ -735,6 +679,66 @@ class PublishWorkfilesModel: return file_items + @property + def _extensions(self): + if self._cached_extensions is None: + exts = self._controller.get_workfile_extensions() or [] + self._cached_extensions = exts + return self._cached_extensions + + @property + def _repre_extensions(self): + if self._cached_repre_extensions is None: + self._cached_repre_extensions = { + ext.lstrip(".") for ext in self._extensions + } + return self._cached_repre_extensions + + def _file_item_from_representation( + self, + repre_entity: dict[str, Any], + project_anatomy: "Anatomy", + author: str, + task_name: Optional[str] = None + ): + if task_name is not None: + task_info = repre_entity["context"].get("task") + if not task_info or task_info["name"] != task_name: + return None + + # Filter by extension + extensions = self._repre_extensions + workfile_path = None + for repre_file in repre_entity["files"]: + ext = ( + os.path.splitext(repre_file["name"])[1] + .lower() + .lstrip(".") + ) + if ext in extensions: + workfile_path = repre_file["path"] + break + + if not workfile_path: + return None + + try: + workfile_path = workfile_path.format( + root=project_anatomy.roots) + except Exception as exc: + print("Failed to format workfile path: {}".format(exc)) + + dirpath, filename = os.path.split(workfile_path) + created_at = arrow.get(repre_entity["createdAt"]).to("local") + return FileItem( + dirpath, + filename, + created_at.float_timestamp, + author, + None, + repre_entity["id"] + ) + class WorkfilesModel: """Workfiles model.""" From e4f6342b3f6436627fd5092d12ed5e6778b1dd67 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:04:50 +0200 Subject: [PATCH 032/170] implement 'get_workfile_entities' on controller --- client/ayon_core/tools/workfiles/control.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index cce6bfca10..cddfb90256 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -468,6 +468,9 @@ class BaseWorkfileController( description, ) + def get_workfile_entities(self, task_id): + return self._workfiles_model.get_workfile_entities(task_id) + def reset(self): if not self._host_is_valid: self._emit_event("controller.reset.started") From b8b012df26b1ab52e07ead08632aa8b225454209 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:05:12 +0200 Subject: [PATCH 033/170] updated UI to work with new methods and structures --- .../tools/workfiles/widgets/files_widget.py | 16 ++- .../widgets/files_widget_workarea.py | 69 ++++++--- .../tools/workfiles/widgets/save_as_dialog.py | 21 +-- .../tools/workfiles/widgets/side_panel.py | 135 ++++++++++-------- 4 files changed, 144 insertions(+), 97 deletions(-) diff --git a/client/ayon_core/tools/workfiles/widgets/files_widget.py b/client/ayon_core/tools/workfiles/widgets/files_widget.py index f0b74f4289..b57192b27a 100644 --- a/client/ayon_core/tools/workfiles/widgets/files_widget.py +++ b/client/ayon_core/tools/workfiles/widgets/files_widget.py @@ -212,9 +212,11 @@ class FilesWidget(QtWidgets.QWidget): return self._controller.duplicate_workfile( filepath, - result["workdir"], + result["rootless_workdir"], result["filename"], - artist_note=result["artist_note"] + version=result["version"], + comment=result["comment"], + description=result["description"] ) def _on_workarea_browse_clicked(self): @@ -259,10 +261,12 @@ class FilesWidget(QtWidgets.QWidget): self._controller.save_as_workfile( result["folder_id"], result["task_id"], - result["workdir"], + result["rootless_workdir"], result["filename"], result["template_key"], - artist_note=result["artist_note"] + version=result["version"], + comment=result["comment"], + description=result["description"] ) def _on_workarea_path_changed(self, event): @@ -315,7 +319,9 @@ class FilesWidget(QtWidgets.QWidget): result["workdir"], result["filename"], result["template_key"], - artist_note=result["artist_note"] + version=result["version"], + comment=result["comment"], + description=result["description"], ) def _on_save_as_request(self): diff --git a/client/ayon_core/tools/workfiles/widgets/files_widget_workarea.py b/client/ayon_core/tools/workfiles/widgets/files_widget_workarea.py index 7f76b6a8ab..47d4902812 100644 --- a/client/ayon_core/tools/workfiles/widgets/files_widget_workarea.py +++ b/client/ayon_core/tools/workfiles/widgets/files_widget_workarea.py @@ -1,3 +1,5 @@ +import os + import qtawesome from qtpy import QtWidgets, QtCore, QtGui @@ -10,8 +12,10 @@ from ayon_core.tools.utils.delegates import PrettyTimeDelegate FILENAME_ROLE = QtCore.Qt.UserRole + 1 FILEPATH_ROLE = QtCore.Qt.UserRole + 2 -AUTHOR_ROLE = QtCore.Qt.UserRole + 3 -DATE_MODIFIED_ROLE = QtCore.Qt.UserRole + 4 +ROOTLESS_PATH_ROLE = QtCore.Qt.UserRole + 3 +AUTHOR_ROLE = QtCore.Qt.UserRole + 4 +DATE_MODIFIED_ROLE = QtCore.Qt.UserRole + 5 +WORKFILE_ENTITY_ID_ROLE = QtCore.Qt.UserRole + 6 class WorkAreaFilesModel(QtGui.QStandardItemModel): @@ -198,7 +202,7 @@ class WorkAreaFilesModel(QtGui.QStandardItemModel): items_to_remove = set(self._items_by_filename.keys()) new_items = [] for file_item in file_items: - filename = file_item.filename + filename = os.path.basename(file_item.filepath) if filename in self._items_by_filename: items_to_remove.discard(filename) item = self._items_by_filename[filename] @@ -206,23 +210,28 @@ class WorkAreaFilesModel(QtGui.QStandardItemModel): item = QtGui.QStandardItem() new_items.append(item) item.setColumnCount(self.columnCount()) - item.setFlags( - QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable - ) item.setData(self._file_icon, QtCore.Qt.DecorationRole) - item.setData(file_item.filename, QtCore.Qt.DisplayRole) - item.setData(file_item.filename, FILENAME_ROLE) + item.setData(filename, QtCore.Qt.DisplayRole) + item.setData(filename, FILENAME_ROLE) + flags = QtCore.Qt.ItemIsSelectable + if file_item.available: + flags |= QtCore.Qt.ItemIsEnabled + item.setFlags(flags) updated_by = file_item.updated_by user_item = user_items_by_name.get(updated_by) if user_item is not None and user_item.full_name: updated_by = user_item.full_name + item.setData( + file_item.workfile_entity_id, WORKFILE_ENTITY_ID_ROLE + ) item.setData(file_item.filepath, FILEPATH_ROLE) + item.setData(file_item.rootless_path, ROOTLESS_PATH_ROLE) + item.setData(file_item.file_modified, DATE_MODIFIED_ROLE) item.setData(updated_by, AUTHOR_ROLE) - item.setData(file_item.modified, DATE_MODIFIED_ROLE) - self._items_by_filename[file_item.filename] = item + self._items_by_filename[filename] = item if new_items: root_item.appendRows(new_items) @@ -354,14 +363,18 @@ class WorkAreaFilesWidget(QtWidgets.QWidget): def _get_selected_info(self): selection_model = self._view.selectionModel() - filepath = None - filename = None + workfile_entity_id = filename = rootless_path = filepath = None for index in selection_model.selectedIndexes(): filepath = index.data(FILEPATH_ROLE) + rootless_path = index.data(ROOTLESS_PATH_ROLE) filename = index.data(FILENAME_ROLE) + workfile_entity_id = index.data(WORKFILE_ENTITY_ID_ROLE) + return { "filepath": filepath, + "rootless_path": rootless_path, "filename": filename, + "workfile_entity_id": workfile_entity_id, } def get_selected_path(self): @@ -374,8 +387,12 @@ class WorkAreaFilesWidget(QtWidgets.QWidget): return self._get_selected_info()["filepath"] def _on_selection_change(self): - filepath = self.get_selected_path() - self._controller.set_selected_workfile_path(filepath) + info = self._get_selected_info() + self._controller.set_selected_workfile_path( + info["rootless_path"], + info["filepath"], + info["workfile_entity_id"], + ) def _on_mouse_double_click(self, event): if event.button() == QtCore.Qt.LeftButton: @@ -430,19 +447,25 @@ class WorkAreaFilesWidget(QtWidgets.QWidget): ) def _on_model_refresh(self): - if ( - not self._change_selection_on_refresh - or self._proxy_model.rowCount() < 1 - ): + if not self._change_selection_on_refresh: return # Find the row with latest date modified + indexes = [ + self._proxy_model.index(idx, 0) + for idx in range(self._proxy_model.rowCount()) + ] + filtered_indexes = [ + index + for index in indexes + if self._proxy_model.flags(index) & QtCore.Qt.ItemIsEnabled + ] + if not filtered_indexes: + return + latest_index = max( - ( - self._proxy_model.index(idx, 0) - for idx in range(self._proxy_model.rowCount()) - ), - key=lambda model_index: model_index.data(DATE_MODIFIED_ROLE) + filtered_indexes, + key=lambda model_index: model_index.data(DATE_MODIFIED_ROLE) or 0 ) # Select row of latest modified diff --git a/client/ayon_core/tools/workfiles/widgets/save_as_dialog.py b/client/ayon_core/tools/workfiles/widgets/save_as_dialog.py index bddff816fe..24d64319ca 100644 --- a/client/ayon_core/tools/workfiles/widgets/save_as_dialog.py +++ b/client/ayon_core/tools/workfiles/widgets/save_as_dialog.py @@ -108,6 +108,7 @@ class SaveAsDialog(QtWidgets.QDialog): self._ext_value = None self._filename = None self._workdir = None + self._rootless_workdir = None self._result = None @@ -144,8 +145,8 @@ class SaveAsDialog(QtWidgets.QDialog): version_layout.addWidget(last_version_check) # Artist note widget - artist_note_input = PlaceholderPlainTextEdit(inputs_widget) - artist_note_input.setPlaceholderText( + description_input = PlaceholderPlainTextEdit(inputs_widget) + description_input.setPlaceholderText( "Provide a note about this workfile.") # Preview widget @@ -166,7 +167,7 @@ class SaveAsDialog(QtWidgets.QDialog): subversion_label = QtWidgets.QLabel("Subversion:", inputs_widget) extension_label = QtWidgets.QLabel("Extension:", inputs_widget) preview_label = QtWidgets.QLabel("Preview:", inputs_widget) - artist_note_label = QtWidgets.QLabel("Artist Note:", inputs_widget) + description_label = QtWidgets.QLabel("Artist Note:", inputs_widget) # Build inputs inputs_layout = QtWidgets.QGridLayout(inputs_widget) @@ -178,8 +179,8 @@ class SaveAsDialog(QtWidgets.QDialog): inputs_layout.addWidget(extension_combobox, 2, 1) inputs_layout.addWidget(preview_label, 3, 0) inputs_layout.addWidget(preview_widget, 3, 1) - inputs_layout.addWidget(artist_note_label, 4, 0, 1, 2) - inputs_layout.addWidget(artist_note_input, 5, 0, 1, 2) + inputs_layout.addWidget(description_label, 4, 0, 1, 2) + inputs_layout.addWidget(description_input, 5, 0, 1, 2) # Build layout main_layout = QtWidgets.QVBoxLayout(self) @@ -214,13 +215,13 @@ class SaveAsDialog(QtWidgets.QDialog): self._extension_combobox = extension_combobox self._subversion_input = subversion_input self._preview_widget = preview_widget - self._artist_note_input = artist_note_input + self._description_input = description_input self._version_label = version_label self._subversion_label = subversion_label self._extension_label = extension_label self._preview_label = preview_label - self._artist_note_label = artist_note_label + self._description_label = description_label # Post init setup @@ -255,6 +256,7 @@ class SaveAsDialog(QtWidgets.QDialog): self._folder_id = folder_id self._task_id = task_id self._workdir = data["workdir"] + self._rootless_workdir = data["rootless_workdir"] self._comment_value = data["comment"] self._ext_value = data["ext"] self._template_key = data["template_key"] @@ -329,10 +331,13 @@ class SaveAsDialog(QtWidgets.QDialog): self._result = { "filename": self._filename, "workdir": self._workdir, + "rootless_workdir": self._rootless_workdir, "folder_id": self._folder_id, "task_id": self._task_id, "template_key": self._template_key, - "artist_note": self._artist_note_input.toPlainText(), + "version": self._version_value, + "comment": self._comment_value, + "description": self._description_input.toPlainText(), } self.close() diff --git a/client/ayon_core/tools/workfiles/widgets/side_panel.py b/client/ayon_core/tools/workfiles/widgets/side_panel.py index 7ba60b5544..2e146fddbe 100644 --- a/client/ayon_core/tools/workfiles/widgets/side_panel.py +++ b/client/ayon_core/tools/workfiles/widgets/side_panel.py @@ -4,6 +4,8 @@ from qtpy import QtWidgets, QtCore def file_size_to_string(file_size): + if not file_size: + return "N/A" size = 0 size_ending_mapping = { "KB": 1024 ** 1, @@ -43,44 +45,45 @@ class SidePanelWidget(QtWidgets.QWidget): details_input = QtWidgets.QPlainTextEdit(self) details_input.setReadOnly(True) - artist_note_widget = QtWidgets.QWidget(self) - note_label = QtWidgets.QLabel("Artist note", artist_note_widget) - note_input = QtWidgets.QPlainTextEdit(artist_note_widget) - btn_note_save = QtWidgets.QPushButton("Save note", artist_note_widget) + description_widget = QtWidgets.QWidget(self) + description_label = QtWidgets.QLabel("Artist note", description_widget) + description_input = QtWidgets.QPlainTextEdit(description_widget) + btn_description_save = QtWidgets.QPushButton("Save note", description_widget) - artist_note_layout = QtWidgets.QVBoxLayout(artist_note_widget) - artist_note_layout.setContentsMargins(0, 0, 0, 0) - artist_note_layout.addWidget(note_label, 0) - artist_note_layout.addWidget(note_input, 1) - artist_note_layout.addWidget( - btn_note_save, 0, alignment=QtCore.Qt.AlignRight + description_layout = QtWidgets.QVBoxLayout(description_widget) + description_layout.setContentsMargins(0, 0, 0, 0) + description_layout.addWidget(description_label, 0) + description_layout.addWidget(description_input, 1) + description_layout.addWidget( + btn_description_save, 0, alignment=QtCore.Qt.AlignRight ) main_layout = QtWidgets.QVBoxLayout(self) main_layout.setContentsMargins(0, 0, 0, 0) main_layout.addWidget(details_label, 0) main_layout.addWidget(details_input, 1) - main_layout.addWidget(artist_note_widget, 1) + main_layout.addWidget(description_widget, 1) - note_input.textChanged.connect(self._on_note_change) - btn_note_save.clicked.connect(self._on_save_click) + description_input.textChanged.connect(self._on_description_change) + btn_description_save.clicked.connect(self._on_save_click) controller.register_event_callback( "selection.workarea.changed", self._on_selection_change ) self._details_input = details_input - self._artist_note_widget = artist_note_widget - self._note_input = note_input - self._btn_note_save = btn_note_save + self._description_widget = description_widget + self._description_input = description_input + self._btn_description_save = btn_description_save self._folder_id = None - self._task_name = None + self._task_id = None self._filepath = None - self._orig_note = "" + self._rootless_path = None + self._orig_description = "" self._controller = controller - self._set_context(None, None, None) + self._set_context(None, None, None, None) def set_published_mode(self, published_mode): """Change published mode. @@ -89,64 +92,69 @@ class SidePanelWidget(QtWidgets.QWidget): published_mode (bool): Published mode enabled. """ - self._artist_note_widget.setVisible(not published_mode) + self._description_widget.setVisible(not published_mode) def _on_selection_change(self, event): folder_id = event["folder_id"] - task_name = event["task_name"] + task_id = event["task_id"] filepath = event["path"] + rootless_path = event["rootless_path"] - self._set_context(folder_id, task_name, filepath) + self._set_context(folder_id, task_id, rootless_path, filepath) - def _on_note_change(self): - text = self._note_input.toPlainText() - self._btn_note_save.setEnabled(self._orig_note != text) + def _on_description_change(self): + text = self._description_input.toPlainText() + self._btn_description_save.setEnabled(self._orig_description != text) def _on_save_click(self): - note = self._note_input.toPlainText() + description = self._description_input.toPlainText() self._controller.save_workfile_info( - self._folder_id, - self._task_name, - self._filepath, - note + self._task_id, + self._rootless_path, + description=description, ) - self._orig_note = note - self._btn_note_save.setEnabled(False) + self._orig_description = description + self._btn_description_save.setEnabled(False) - def _set_context(self, folder_id, task_name, filepath): + def _set_context(self, folder_id, task_id, rootless_path, filepath): workfile_info = None # Check if folder, task and file are selected - if bool(folder_id) and bool(task_name) and bool(filepath): + if folder_id and task_id and rootless_path: workfile_info = self._controller.get_workfile_info( - folder_id, task_name, filepath + folder_id, task_id, rootless_path ) enabled = workfile_info is not None self._details_input.setEnabled(enabled) - self._note_input.setEnabled(enabled) - self._btn_note_save.setEnabled(enabled) + self._description_input.setEnabled(enabled) + self._btn_description_save.setEnabled(enabled) self._folder_id = folder_id - self._task_name = task_name + self._task_id = task_id self._filepath = filepath + self._rootless_path = rootless_path # Disable inputs and remove texts if any required arguments are # missing if not enabled: - self._orig_note = "" + self._orig_description = "" self._details_input.setPlainText("") - self._note_input.setPlainText("") + self._description_input.setPlainText("") return - note = workfile_info.note - size_value = file_size_to_string(workfile_info.filesize) + description = workfile_info.description + size_value = file_size_to_string(workfile_info.file_size) # Append html string datetime_format = "%b %d %Y %H:%M:%S" - creation_time = datetime.datetime.fromtimestamp( - workfile_info.creation_time) - modification_time = datetime.datetime.fromtimestamp( - workfile_info.modification_time) + file_created = workfile_info.file_created + modification_time = workfile_info.file_modified + if file_created: + file_created = datetime.datetime.fromtimestamp(file_created) + + if modification_time: + modification_time = datetime.datetime.fromtimestamp( + modification_time) user_items_by_name = self._controller.get_user_items_by_name() @@ -156,33 +164,38 @@ class SidePanelWidget(QtWidgets.QWidget): return user_item.full_name return username - created_lines = [ - creation_time.strftime(datetime_format) - ] + created_lines = [] if workfile_info.created_by: - created_lines.insert( - 0, convert_username(workfile_info.created_by) + created_lines.append( + convert_username(workfile_info.created_by) ) + if file_created: + created_lines.append(file_created.strftime(datetime_format)) - modified_lines = [ - modification_time.strftime(datetime_format) - ] + if created_lines: + created_lines.insert(0, "Created:") + + modified_lines = [] if workfile_info.updated_by: - modified_lines.insert( - 0, convert_username(workfile_info.updated_by) + modified_lines.append( + convert_username(workfile_info.updated_by) ) + if modification_time: + modified_lines.append( + modification_time.strftime(datetime_format) + ) + if modified_lines: + modified_lines.insert(0, "Modified:") lines = ( "Size:", size_value, - "Created:", "
".join(created_lines), - "Modified:", "
".join(modified_lines), ) - self._orig_note = note - self._note_input.setPlainText(note) + self._orig_description = description + self._description_input.setPlainText(description) # Set as empty string self._details_input.setPlainText("") - self._details_input.appendHtml("
".join(lines)) + self._details_input.appendHtml("
".join(lines)) From e70535831973126adcffbe56f423a899e5a25b88 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:05:23 +0200 Subject: [PATCH 034/170] fix abstract property --- client/ayon_core/host/host.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index 5a29de6cd7..3333cf3778 100644 --- a/client/ayon_core/host/host.py +++ b/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 @@ class HostBase(ABC): self._log = logging.getLogger(self.__class__.__name__) return self._log - @abstractproperty + @property + @abstractmethod def name(self): """Host name.""" From 95b1820c8318c075e27d1dd94a405ebf6bdff5ad Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:05:47 +0200 Subject: [PATCH 035/170] added some typehints into IWorkfileHost --- client/ayon_core/host/interfaces/workfiles.py | 29 ++++++++++--------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 34d7dddef6..97985b754a 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -3,10 +3,14 @@ import os import platform from abc import abstractmethod from dataclasses import dataclass, asdict +import typing from typing import Optional, Any import ayon_api +if typing.TYPE_CHECKING: + from ayon_core.pipeline import Anatomy + @dataclass class WorkfileInfo: @@ -76,51 +80,50 @@ class WorkfileInfo: class IWorkfileHost: """Implementation requirements to be able use workfile utils and tool.""" - @abstractmethod - def save_workfile(self, dst_path=None): + def save_workfile(self, dst_path: Optional[str] = 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): + def open_workfile(self, filepath: str): """Open passed filepath in the host. Args: filepath (str): Path to workfile. - """ + """ pass @abstractmethod - def get_current_workfile(self): + def get_current_workfile(self) -> Optional[str]: """Retrieve path to current opened file. Returns: - str: Path to file which is currently opened. - None: If nothing is opened. - """ + Optional[str]: Path to file which is currently opened. None if + nothing is opened. + """ return None - def workfile_has_unsaved_changes(self): + def workfile_has_unsaved_changes(self) -> Optional[bool]: """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 + Optional[bool]: True if scene is saved and False if has unsaved + modifications. None if can't tell if workfiles has modifications. - None: Can't tell if workfiles has modifications. - """ + """ return None def get_workfile_extensions(self) -> list[str]: From bef56a526fb19035b6b6809d4af33d7237ebe762 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:05:58 +0200 Subject: [PATCH 036/170] added todos into controller --- client/ayon_core/tools/workfiles/control.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index cddfb90256..b0d4cb16b2 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -528,6 +528,7 @@ class BaseWorkfileController( # Controller actions def open_workfile(self, folder_id, task_id, filepath): + # TODO move to workfiles model self._emit_event("open_workfile.started") failed = False @@ -544,6 +545,7 @@ class BaseWorkfileController( ) def save_current_workfile(self): + # TODO move to workfiles model current_file = self.get_current_workfile() self._host.save_workfile(current_file) @@ -594,6 +596,7 @@ class BaseWorkfileController( comment, description, ): + # TODO move to workfiles model self._emit_event("copy_representation.started") failed = False @@ -623,6 +626,8 @@ class BaseWorkfileController( def duplicate_workfile( self, src_filepath, workdir, filename, version, comment, description ): + # TODO move to workfiles model + # TODO save workfile information self._emit_event("workfile_duplicate.started") failed = False @@ -678,6 +683,7 @@ class BaseWorkfileController( } def _open_workfile(self, folder_id, task_id, filepath): + # TODO move to workfiles model project_name = self.get_current_project_name() event_data = self._get_event_context_data( project_name, folder_id, task_id @@ -710,6 +716,7 @@ class BaseWorkfileController( description: Optional[str], src_filepath=None, ): + # TODO move to workfiles model # Trigger before save event project_name = self.get_current_project_name() folder = self.get_folder_entity(project_name, folder_id) From 552bc03aa613216a61ed4e6c2ef7de0e21d72ee2 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 28 Apr 2025 17:50:14 +0200 Subject: [PATCH 037/170] added comment --- client/ayon_core/tools/workfiles/widgets/files_widget.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/client/ayon_core/tools/workfiles/widgets/files_widget.py b/client/ayon_core/tools/workfiles/widgets/files_widget.py index b57192b27a..d45e057192 100644 --- a/client/ayon_core/tools/workfiles/widgets/files_widget.py +++ b/client/ayon_core/tools/workfiles/widgets/files_widget.py @@ -200,6 +200,9 @@ class FilesWidget(QtWidgets.QWidget): self._open_workfile(folder_id, task_id, path) def _on_current_open_requests(self): + # TODO validate if item under mouse is enabled + # - thi uses selected item, but that does not have to be the one + # under mouse self._on_workarea_open_clicked() def _on_duplicate_request(self): From 80397a3cc69bcf8b67c17a49fba287b88d4128fc Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 29 Apr 2025 17:31:53 +0200 Subject: [PATCH 038/170] implemented base of published workfile collection --- client/ayon_core/host/interfaces/workfiles.py | 219 ++++++++++++++++++ 1 file changed, 219 insertions(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 97985b754a..456ba0b9d4 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -7,6 +7,7 @@ import typing from typing import Optional, Any import ayon_api +import arrow if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy @@ -77,6 +78,70 @@ class WorkfileInfo: return WorkfileInfo(**data) +@dataclass +class PublishedWorkfileInfo: + folder_id: str + task_id: Optional[str] + representation_id: str + filepath: str + created_at: float + author: str + available: bool + file_size: Optional[float] + file_created: Optional[float] + file_modified: Optional[float] + + @classmethod + def new( + cls, + folder_id: str, + task_id: Optional[str], + repre_entity: dict[str, Any], + filepath: str, + author: str, + available: bool, + file_size: Optional[float], + file_modified: Optional[float], + file_created: Optional[float], + ): + created_at = arrow.get(repre_entity["createdAt"]).to("local") + + return cls( + folder_id=folder_id, + task_id=task_id, + representation_id=repre_entity["id"], + filepath=filepath, + created_at=created_at.float_timestamp, + author=author, + available=available, + file_size=file_size, + file_created=file_created, + file_modified=file_modified, + ) + + def to_data(self): + """Converts file item to data. + + Returns: + dict[str, Any]: Workfile item data. + + """ + return asdict(self) + + @classmethod + def from_data(self, data): + """Converts data to workfile item. + + Args: + data (dict[str, Any]): Workfile item data. + + Returns: + WorkfileInfo: File item. + + """ + return WorkfileInfo(**data) + + class IWorkfileHost: """Implementation requirements to be able use workfile utils and tool.""" @@ -264,6 +329,110 @@ class IWorkfileHost: return items + def list_published_workfiles( + self, + project_name: str, + folder_id: str, + anatomy: Optional["Anatomy"] = None, + version_entities: Optional[list[dict[str, Any]]] = None, + repre_entities: Optional[list[dict[str, Any]]] = None, + ) -> list[PublishedWorkfileInfo]: + """List published workfiles for given folder. + + Default implementation looks for products with 'workfile' + product type. + + Pre-fetched entities have mandatory fields to be fetched. + - Version: 'id', 'author', 'taskId' + - Representation: 'id', 'versionId', 'files' + + Args: + project_name (str): Project name. + folder_id (str): Folder id. + anatomy (Anatomy): Project anatomy. + version_entities (Optional[list[dict[str, Any]]]): Pre-fetched + version entities. + repre_entities (Optional[list[dict[str, Any]]]): Pre-fetched + representation entities. + + Returns: + list[PublishedWorkfileInfo]: Published workfile information for + given context. + + """ + from ayon_core.pipeline import Anatomy + + # Get all representations of the folder + ( + version_entities, + repre_entities + ) = self._fetch_workfile_entities( + project_name, + folder_id, + version_entities, + repre_entities, + ) + if not repre_entities: + return [] + + if anatomy is None: + anatomy = Anatomy(project_name) + + versions_by_id = { + version_entity["id"]: version_entity + for version_entity in version_entities + } + extensions = self.get_workfile_extensions() + items = [] + for repre_entity in repre_entities: + version_id = repre_entity["versionId"] + version_entity = versions_by_id[version_id] + task_id = version_entity["taskId"] + + # Filter by extension + workfile_path = None + for repre_file in repre_entity["files"]: + ext = ( + os.path.splitext(repre_file["name"])[1] + .lower() + .lstrip(".") + ) + if ext in extensions: + workfile_path = repre_file["path"] + break + + if not workfile_path: + continue + + try: + workfile_path = workfile_path.format(root=anatomy.roots) + except Exception as exc: + print(f"Failed to format workfile path: {exc}") + + is_available = False + file_size = file_modified = file_created = None + if workfile_path and os.path.exists(workfile_path): + filestat = os.stat(workfile_path) + is_available = True + file_size = filestat.st_size + file_created = filestat.st_ctime + file_modified = filestat.st_mtime + + workfile_item = PublishedWorkfileInfo.new( + folder_id, + task_id, + repre_entity, + workfile_path, + version_entity["author"], + is_available, + file_size, + file_created, + file_modified, + ) + items.append(workfile_item) + + return items + # --- Deprecated method names --- def file_extensions(self): """Deprecated variant of 'get_workfile_extensions'. @@ -308,3 +477,53 @@ class IWorkfileHost: """ return self.workfile_has_unsaved_changes() + + def _fetch_workfile_entities( + self, + project_name: str, + folder_id: str, + version_entities: Optional[list[dict[str, Any]]], + repre_entities: Optional[list[dict[str, Any]]], + ) -> tuple[ + list[dict[str, Any]], + list[dict[str, Any]] + ]: + if repre_entities is not None and version_entities is None: + # Get versions of representations + version_ids = {r["versionId"] for r in repre_entities} + version_entities = list(ayon_api.get_versions( + project_name, + version_ids=version_ids, + fields={"id", "author", "taskId"}, + )) + + if version_entities is None: + # Get product entities of folder + product_entities = ayon_api.get_products( + project_name, + folder_ids={folder_id}, + product_types={"workfile"}, + fields={"id", "name"} + ) + + version_entities = [] + product_ids = {product["id"] for product in product_entities} + if product_ids: + # Get version docs of products with their families + version_entities = list(ayon_api.get_versions( + project_name, + product_ids=product_ids, + fields={"id", "author", "taskId"}, + )) + + # Fetch representations of filtered versions and add filter for + # extension + if repre_entities is None: + repre_entities = [] + if version_entities: + repre_entities = list(ayon_api.get_representations( + project_name, + version_ids={v["id"] for v in version_entities} + )) + + return version_entities, repre_entities From dde5c6a46ffa2223a42c17a19a6b4a4f01a6e8ed Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 30 Apr 2025 17:34:09 +0200 Subject: [PATCH 039/170] use collect published files from host --- client/ayon_core/host/__init__.py | 2 ++ client/ayon_core/host/interfaces/__init__.py | 5 ++- client/ayon_core/host/interfaces/workfiles.py | 5 ++- .../tools/workfiles/models/workfiles.py | 34 +++++++++++++------ .../widgets/files_widget_published.py | 13 ++++--- 5 files changed, 41 insertions(+), 18 deletions(-) diff --git a/client/ayon_core/host/__init__.py b/client/ayon_core/host/__init__.py index 80ff0f2e38..b252b03d76 100644 --- a/client/ayon_core/host/__init__.py +++ b/client/ayon_core/host/__init__.py @@ -5,6 +5,7 @@ from .host import ( from .interfaces import ( IWorkfileHost, WorkfileInfo, + PublishedWorkfileInfo, ILoadHost, IPublishHost, INewPublisher, @@ -18,6 +19,7 @@ __all__ = ( "IWorkfileHost", "WorkfileInfo", + "PublishedWorkfileInfo", "ILoadHost", "IPublishHost", "INewPublisher", diff --git a/client/ayon_core/host/interfaces/__init__.py b/client/ayon_core/host/interfaces/__init__.py index 4ee6375012..379d8555fb 100644 --- a/client/ayon_core/host/interfaces/__init__.py +++ b/client/ayon_core/host/interfaces/__init__.py @@ -1,5 +1,5 @@ from .exceptions import MissingMethodsError -from .workfiles import IWorkfileHost, WorkfileInfo +from .workfiles import IWorkfileHost, WorkfileInfo, PublishedWorkfileInfo from .interfaces import ( IPublishHost, INewPublisher, @@ -9,8 +9,11 @@ from .interfaces import ( __all__ = ( "MissingMethodsError", + "IWorkfileHost", "WorkfileInfo", + "PublishedWorkfileInfo", + "IPublishHost", "INewPublisher", "ILoadHost", diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 456ba0b9d4..21085abaa8 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -382,7 +382,10 @@ class IWorkfileHost: version_entity["id"]: version_entity for version_entity in version_entities } - extensions = self.get_workfile_extensions() + extensions = { + ext.lstrip(".") + for ext in self.get_workfile_extensions() + } items = [] for repre_entity in repre_entities: version_id = repre_entity["versionId"] diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 283b707865..74b8f1aeb3 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -15,7 +15,7 @@ from ayon_core.lib import ( NestedCacheItem, CacheItem, ) -from ayon_core.host import WorkfileInfo +from ayon_core.host import WorkfileInfo, PublishedWorkfileInfo from ayon_core.pipeline.template_data import ( get_template_data, get_task_template_data, @@ -28,10 +28,7 @@ from ayon_core.pipeline.workfile import ( get_comments_from_workfile_paths, ) from ayon_core.pipeline.version_start import get_versioning_start -from ayon_core.tools.workfiles.abstract import ( - WorkareaFilepathResult, - FileItem, -) +from ayon_core.tools.workfiles.abstract import WorkareaFilepathResult if typing.TYPE_CHECKING: from typing import Union @@ -432,7 +429,6 @@ class WorkareaModel: if version is not None: return version + 1 - task_info = fill_data.get("task", {}) return get_versioning_start( self._project_name, @@ -744,11 +740,11 @@ class WorkfilesModel: """Workfiles model.""" def __init__(self, host, controller): + self._host = host self._controller = controller self._entities_model = WorkfileEntitiesModel(controller) self._workarea_model = WorkareaModel(host, controller) - self._published_model = PublishWorkfilesModel(controller) def reset(self): self._workarea_model.reset() @@ -825,7 +821,9 @@ class WorkfilesModel: *args, **kwargs ) - def get_published_file_items(self, folder_id, task_name): + def get_published_file_items( + self, folder_id, task_id + ) -> PublishedWorkfileInfo: """Published workfiles for passed context. Args: @@ -833,7 +831,21 @@ class WorkfilesModel: task_name (str): Task name. Returns: - list[FileItem]: List of files for published workfiles. - """ + list[PublishedWorkfileInfo]: List of files for published workfiles. + + """ + project_name = self._project_name + anatomy = self._controller.project_anatomy + items = self._host.list_published_workfiles( + project_name, + folder_id, + anatomy, + ) + if task_id: + items = [ + item + for item in items + if item.task_id == task_id + ] + return items - return self._published_model.get_file_items(folder_id, task_name) diff --git a/client/ayon_core/tools/workfiles/widgets/files_widget_published.py b/client/ayon_core/tools/workfiles/widgets/files_widget_published.py index 07122046be..250204a7d7 100644 --- a/client/ayon_core/tools/workfiles/widgets/files_widget_published.py +++ b/client/ayon_core/tools/workfiles/widgets/files_widget_published.py @@ -1,3 +1,5 @@ +import os + import qtawesome from qtpy import QtWidgets, QtCore, QtGui @@ -205,24 +207,25 @@ class PublishedFilesModel(QtGui.QStandardItemModel): new_items.append(item) item.setColumnCount(self.columnCount()) item.setData(self._file_icon, QtCore.Qt.DecorationRole) - item.setData(file_item.filename, QtCore.Qt.DisplayRole) item.setData(repre_id, REPRE_ID_ROLE) - if file_item.exists: + if file_item.available: flags = QtCore.Qt.ItemIsEnabled | QtCore.Qt.ItemIsSelectable else: flags = QtCore.Qt.NoItemFlags - author = file_item.created_by + author = file_item.author user_item = user_items_by_name.get(author) if user_item is not None and user_item.full_name: author = user_item.full_name - item.setFlags(flags) + filename = os.path.basename(file_item.filepath) + item.setFlags(flags) + item.setData(filename, QtCore.Qt.DisplayRole) item.setData(file_item.filepath, FILEPATH_ROLE) item.setData(author, AUTHOR_ROLE) - item.setData(file_item.modified, DATE_MODIFIED_ROLE) + item.setData(file_item.file_modified, DATE_MODIFIED_ROLE) self._items_by_id[repre_id] = item From b76ae8ffd37ff78472ede1fe2292729e788100ab Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 30 Apr 2025 17:35:43 +0200 Subject: [PATCH 040/170] update controller --- client/ayon_core/tools/workfiles/abstract.py | 113 +------------------ client/ayon_core/tools/workfiles/control.py | 10 +- 2 files changed, 5 insertions(+), 118 deletions(-) diff --git a/client/ayon_core/tools/workfiles/abstract.py b/client/ayon_core/tools/workfiles/abstract.py index 78e31f9abd..6d7d0b4c0e 100644 --- a/client/ayon_core/tools/workfiles/abstract.py +++ b/client/ayon_core/tools/workfiles/abstract.py @@ -3,8 +3,6 @@ from abc import ABC, abstractmethod from ayon_core.style import get_default_entity_icon_color -from ayon_core.host import WorkfileInfo - class FolderItem: """Item representing folder entity on a server. @@ -141,111 +139,6 @@ class TaskItem: return cls(**data) -class FileItem: - """File item that represents a file. - - Can be used for both Workarea and Published workfile. Workarea file - will always exist on disk which is not the case for Published workfile. - - Args: - dirpath (str): Directory path of file. - filename (str): Filename. - modified (float): Modified timestamp. - created_by (Optional[str]): Username. - representation_id (Optional[str]): Representation id of published - workfile. - filepath (Optional[str]): Prepared filepath. - exists (Optional[bool]): If file exists on disk. - - """ - def __init__( - self, - dirpath, - filename, - modified, - created_by=None, - updated_by=None, - representation_id=None, - filepath=None, - exists=None - ): - self.filename = filename - self.dirpath = dirpath - self.modified = modified - self.created_by = created_by - self.updated_by = updated_by - self.representation_id = representation_id - self._filepath = filepath - self._exists = exists - - @property - def filepath(self): - """Filepath of file. - - Returns: - str: Full path to a file. - - """ - if self._filepath is None: - self._filepath = os.path.join(self.dirpath, self.filename) - return self._filepath - - @property - def exists(self): - """File is available. - - Returns: - bool: If file exists on disk. - - """ - if self._exists is None: - self._exists = os.path.exists(self.filepath) - return self._exists - - def to_data(self): - """Converts file item to data. - - Returns: - dict[str, Any]: File item data. - - """ - return { - "filename": self.filename, - "dirpath": self.dirpath, - "modified": self.modified, - "created_by": self.created_by, - "representation_id": self.representation_id, - "filepath": self.filepath, - "exists": self.exists, - } - - @classmethod - def from_data(cls, data): - """Re-creates file item from data. - - Args: - data (dict[str, Any]): File item data. - - Returns: - FileItem: File item. - - """ - required_keys = { - "filename", - "dirpath", - "modified", - "representation_id" - } - missing_keys = required_keys - set(data.keys()) - if missing_keys: - raise KeyError("Missing keys: {}".format(missing_keys)) - - return cls(**{ - key: data[key] - for key in required_keys - }) - - class WorkareaFilepathResult: """Result of workarea file formatting. @@ -881,7 +774,7 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): pass @abstractmethod - def get_published_file_items(self, folder_id, task_id): + def get_published_file_items(self, folder_id: str, task_id: str): """Get published file items. Args: @@ -889,7 +782,7 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): task_id (Union[str, None]): Task id. Returns: - list[FileItem]: List of published file items. + list[PublishedWorkfileInfo]: List of published file items. """ pass @@ -904,7 +797,7 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): rootless_path (str): Workfile path. Returns: - Union[WorkfileInfo, None]: Workfile info or None if was passed + Optional[WorkfileInfo]: Workfile info or None if was passed invalid context. """ diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index b0d4cb16b2..37a3f4115b 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -437,15 +437,9 @@ class BaseWorkfileController( ) def get_published_file_items(self, folder_id, task_id): - task_name = None - if task_id: - task = self.get_task_entity( - self.get_current_project_name(), task_id - ) - task_name = task.get("name") - return self._workfiles_model.get_published_file_items( - folder_id, task_name) + folder_id, task_id + ) def get_workfile_info(self, folder_id, task_id, rootless_path): return self._workfiles_model.get_workfile_info( From 1b7474bb99660c56101deb49c3d2289f82313972 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 30 Apr 2025 17:51:56 +0200 Subject: [PATCH 041/170] Merge workfile entities model into workfiles model --- .../tools/workfiles/models/workfiles.py | 358 +++++++++--------- 1 file changed, 173 insertions(+), 185 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 74b8f1aeb3..892ca66d94 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -6,7 +6,6 @@ import platform import typing from typing import Optional, Any -import arrow import ayon_api from ayon_api.operations import OperationsSession @@ -448,166 +447,6 @@ class WorkareaModel: return directory_template.format_strict(fill_data).normalized() -class WorkfileEntitiesModel: - """Workfile entities model. - - Args: - controller (AbstractWorkfileController): Controller object. - - """ - def __init__(self, controller): - self._controller = controller - self._workfile_entities_by_task_id = {} - self._current_username = _NOT_SET - - def reset(self): - self._workfile_entities_by_task_id = {} - - def get_workfile_entities(self, task_id: str): - if not task_id: - return [] - workfile_entities = self._workfile_entities_by_task_id.get(task_id) - if workfile_entities is None: - workfile_entities = list(ayon_api.get_workfiles_info( - self._controller.get_current_project_name(), - task_ids=[task_id], - )) - self._workfile_entities_by_task_id[task_id] = workfile_entities - return workfile_entities - - def save_workfile_info( - self, - task_id: str, - rootless_path: str, - version: Optional[int], - comment: Optional[str], - description: Optional[str], - ): - # TODO create pipeline function for this - workfile_entities = self.get_workfile_entities(task_id) - workfile_entity = next( - ( - _ent - for _ent in workfile_entities - if _ent["path"] == rootless_path - ), - None - ) - if not workfile_entity: - workfile_entity = self._create_workfile_info_entity( - task_id, - rootless_path, - version, - comment, - description, - ) - workfile_entities.append(workfile_entity) - return - - data = {} - for key, value in ( - ("host_name", self._controller.get_host_name()), - ("version", version), - ("comment", comment), - ): - if value is not None: - data[key] = value - - old_data = workfile_entity["data"] - - changed_data = {} - for key, value in data.items(): - if key not in old_data or old_data[key] != value: - changed_data[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 - - username = self._get_current_username() - # Automatically fix 'createdBy' and 'updatedBy' fields - # NOTE both fields were not automatically filled by server - # until 1.1.3 release. - if workfile_entity.get("createdBy") is None: - update_data["createdBy"] = username - workfile_entity["createdBy"] = username - - if workfile_entity.get("updatedBy") != username: - update_data["updatedBy"] = username - workfile_entity["updatedBy"] = username - - if not update_data: - return - - project_name = self._controller.get_current_project_name() - - session = OperationsSession() - session.update_entity( - project_name, - "workfile", - workfile_entity["id"], - update_data, - ) - session.commit() - - def _create_workfile_info_entity( - self, - task_id: str, - rootless_path: str, - version: Optional[int], - comment: Optional[str], - description: str, - ) -> dict[str, Any]: - extension = os.path.splitext(rootless_path)[1] - - project_name = self._controller.get_current_project_name() - - attrib = {} - for key, value in ( - ("extension", extension), - ("description", description), - ): - if value is not None: - attrib[key] = value - - data = {} - for key, value in ( - ("host_name", self._controller.get_host_name()), - ("version", version), - ("comment", comment), - ): - if value is not None: - data[key] = value - - username = self._get_current_username() - workfile_info = { - "id": uuid.uuid4().hex, - "path": rootless_path, - "taskId": task_id, - "attrib": attrib, - "data": data, - # TODO remove 'createdBy' and 'updatedBy' fields when server is - # or above 1.1.3 . - "createdBy": username, - "updatedBy": username, - } - - session = OperationsSession() - session.create_entity(project_name, "workfile", workfile_info) - session.commit() - return workfile_info - - def _get_current_username(self) -> str: - if self._current_username is _NOT_SET: - self._current_username = get_ayon_username() - return self._current_username - - class PublishWorkfilesModel: """Model for handling of published workfiles. @@ -743,12 +582,48 @@ class WorkfilesModel: self._host = host self._controller = controller - self._entities_model = WorkfileEntitiesModel(controller) self._workarea_model = WorkareaModel(host, controller) + # self._published_model = PublishWorkfilesModel(controller) + + self._workfile_entities_by_task_id = {} + self._current_username = _NOT_SET def reset(self): self._workarea_model.reset() - self._entities_model.reset() + + self._workfile_entities_by_task_id = {} + + def get_workfile_entities(self, task_id: str): + if not task_id: + return [] + workfile_entities = self._workfile_entities_by_task_id.get(task_id) + if workfile_entities is None: + workfile_entities = list(ayon_api.get_workfiles_info( + self._controller.get_current_project_name(), + task_ids=[task_id], + )) + self._workfile_entities_by_task_id[task_id] = workfile_entities + return workfile_entities + + def save_workfile_info( + self, + task_id: str, + rootless_path: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], + ): + self._save_workfile_info( + task_id, + rootless_path, + version, + comment, + description, + ) + + self._workarea_model.update_file_description( + task_id, rootless_path, description + ) def reset_workarea_file_items(self, task_id): self._workarea_model.reset_file_items(task_id) @@ -758,28 +633,6 @@ class WorkfilesModel: folder_id, task_id, rootless_path ) - def save_workfile_info( - self, - task_id, - rootless_path, - version, - comment, - description, - ): - self._entities_model.save_workfile_info( - task_id, - rootless_path, - version, - comment, - description, - ) - self._workarea_model.update_file_description( - task_id, rootless_path, description - ) - - def get_workfile_entities(self, task_id): - return self._entities_model.get_workfile_entities(task_id) - def get_workarea_dir_by_context(self, folder_id, task_id): """Workarea dir for passed context. @@ -848,4 +701,139 @@ class WorkfilesModel: if item.task_id == task_id ] return items + # return self._published_model.get_file_items(folder_id, task_name) + @property + def _project_name(self) -> str: + return self._controller.get_current_project_name() + + def _get_current_username(self) -> str: + if self._current_username is _NOT_SET: + self._current_username = get_ayon_username() + return self._current_username + + # --- Workfile entities --- + def _save_workfile_info( + self, + task_id: str, + rootless_path: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], + ): + # TODO create pipeline function for this + workfile_entities = self.get_workfile_entities(task_id) + workfile_entity = next( + ( + _ent + for _ent in workfile_entities + if _ent["path"] == rootless_path + ), + None + ) + if not workfile_entity: + workfile_entity = self._create_workfile_info_entity( + task_id, + rootless_path, + version, + comment, + description, + ) + workfile_entities.append(workfile_entity) + return + + data = {} + for key, value in ( + ("host_name", self._controller.get_host_name()), + ("version", version), + ("comment", comment), + ): + if value is not None: + data[key] = value + + old_data = workfile_entity["data"] + + changed_data = {} + for key, value in data.items(): + if key not in old_data or old_data[key] != value: + changed_data[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 + + username = self._get_current_username() + # Automatically fix 'createdBy' and 'updatedBy' fields + # NOTE both fields were not automatically filled by server + # until 1.1.3 release. + if workfile_entity.get("createdBy") is None: + update_data["createdBy"] = username + workfile_entity["createdBy"] = username + + if workfile_entity.get("updatedBy") != username: + update_data["updatedBy"] = username + workfile_entity["updatedBy"] = username + + if not update_data: + return + + session = OperationsSession() + session.update_entity( + self._project_name, + "workfile", + workfile_entity["id"], + update_data, + ) + session.commit() + + def _create_workfile_info_entity( + self, + task_id: str, + rootless_path: str, + version: Optional[int], + comment: Optional[str], + description: str, + ) -> dict[str, Any]: + 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 = {} + for key, value in ( + ("host_name", self._controller.get_host_name()), + ("version", version), + ("comment", comment), + ): + if value is not None: + data[key] = value + + username = self._get_current_username() + workfile_info = { + "id": uuid.uuid4().hex, + "path": rootless_path, + "taskId": task_id, + "attrib": attrib, + "data": data, + # TODO remove 'createdBy' and 'updatedBy' fields when server is + # or above 1.1.3 . + "createdBy": username, + "updatedBy": username, + } + + session = OperationsSession() + session.create_entity( + self._project_name, "workfile", workfile_info + ) + session.commit() + return workfile_info From 2f6ed068e722ac2d434b0fd8d910870bcd006099 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 30 Apr 2025 17:52:28 +0200 Subject: [PATCH 042/170] Remove publish workfiles model --- .../tools/workfiles/models/workfiles.py | 130 ------------------ 1 file changed, 130 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 892ca66d94..181d963ec7 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -447,134 +447,6 @@ class WorkareaModel: return directory_template.format_strict(fill_data).normalized() -class PublishWorkfilesModel: - """Model for handling of published workfiles. - - Todos: - Cache workfiles products and representations for some time. - Note Representations won't change. Only what can change are - versions. - """ - - def __init__(self, controller): - self._controller = controller - self._cached_extensions = None - self._cached_repre_extensions = None - - def get_file_items(self, folder_id: str, task_name: str) -> list[FileItem]: - # TODO refactor to use less server API calls - project_name = self._controller.get_current_project_name() - # Get subset docs of folder - product_entities = ayon_api.get_products( - project_name, - folder_ids={folder_id}, - product_types={"workfile"}, - fields={"id", "name"} - ) - - output = [] - product_ids = {product["id"] for product in product_entities} - if not product_ids: - return output - - # Get version docs of products with their families - version_entities = ayon_api.get_versions( - project_name, - product_ids=product_ids, - fields={"id", "author"} - ) - versions_by_id = { - version["id"]: version - for version in version_entities - } - if not versions_by_id: - return output - - # Query representations of filtered versions and add filter for - # extension - repre_entities = ayon_api.get_representations( - project_name, - version_ids=set(versions_by_id) - ) - project_anatomy = self._controller.project_anatomy - - # Filter queried representations by task name if task is set - file_items = [] - for repre_entity in repre_entities: - version_id = repre_entity["versionId"] - version_entity = versions_by_id[version_id] - file_item = self._file_item_from_representation( - repre_entity, - project_anatomy, - version_entity["author"], - task_name, - ) - if file_item is not None: - file_items.append(file_item) - - return file_items - - @property - def _extensions(self): - if self._cached_extensions is None: - exts = self._controller.get_workfile_extensions() or [] - self._cached_extensions = exts - return self._cached_extensions - - @property - def _repre_extensions(self): - if self._cached_repre_extensions is None: - self._cached_repre_extensions = { - ext.lstrip(".") for ext in self._extensions - } - return self._cached_repre_extensions - - def _file_item_from_representation( - self, - repre_entity: dict[str, Any], - project_anatomy: "Anatomy", - author: str, - task_name: Optional[str] = None - ): - if task_name is not None: - task_info = repre_entity["context"].get("task") - if not task_info or task_info["name"] != task_name: - return None - - # Filter by extension - extensions = self._repre_extensions - workfile_path = None - for repre_file in repre_entity["files"]: - ext = ( - os.path.splitext(repre_file["name"])[1] - .lower() - .lstrip(".") - ) - if ext in extensions: - workfile_path = repre_file["path"] - break - - if not workfile_path: - return None - - try: - workfile_path = workfile_path.format( - root=project_anatomy.roots) - except Exception as exc: - print("Failed to format workfile path: {}".format(exc)) - - dirpath, filename = os.path.split(workfile_path) - created_at = arrow.get(repre_entity["createdAt"]).to("local") - return FileItem( - dirpath, - filename, - created_at.float_timestamp, - author, - None, - repre_entity["id"] - ) - - class WorkfilesModel: """Workfiles model.""" @@ -583,7 +455,6 @@ class WorkfilesModel: self._controller = controller self._workarea_model = WorkareaModel(host, controller) - # self._published_model = PublishWorkfilesModel(controller) self._workfile_entities_by_task_id = {} self._current_username = _NOT_SET @@ -701,7 +572,6 @@ class WorkfilesModel: if item.task_id == task_id ] return items - # return self._published_model.get_file_items(folder_id, task_name) @property def _project_name(self) -> str: From eb3328157172e90e0d6603796b20329ac6819e72 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:12:56 +0200 Subject: [PATCH 043/170] merge workfile models into one --- .../tools/workfiles/models/workfiles.py | 365 ++++++++---------- 1 file changed, 171 insertions(+), 194 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 181d963ec7..d04975bafb 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -14,7 +14,12 @@ from ayon_core.lib import ( NestedCacheItem, CacheItem, ) -from ayon_core.host import WorkfileInfo, PublishedWorkfileInfo +from ayon_core.host import ( + HostBase, + IWorkfileHost, + WorkfileInfo, + PublishedWorkfileInfo, +) from ayon_core.pipeline.template_data import ( get_template_data, get_task_template_data, @@ -27,30 +32,40 @@ from ayon_core.pipeline.workfile import ( get_comments_from_workfile_paths, ) from ayon_core.pipeline.version_start import get_versioning_start -from ayon_core.tools.workfiles.abstract import WorkareaFilepathResult +from ayon_core.tools.workfiles.abstract import ( + WorkareaFilepathResult, + AbstractWorkfilesBackend, +) if typing.TYPE_CHECKING: - from typing import Union from ayon_core.pipeline import Anatomy _NOT_SET = object() -class WorkareaModel: - """Workfiles model looking for workfiles in workare folder. +class HostType(HostBase, IWorkfileHost): + pass - Workarea folder is usually task and host specific, defined by - anatomy templates. Is looking for files with extensions defined - by host integration. - """ - def __init__(self, host, controller): - self._host = host - self._controller = controller +class WorkfilesModel: + """Workfiles model.""" + + def __init__( + self, + host: HostType, + controller: AbstractWorkfilesBackend + ): + self._host: HostType = host + self._controller: AbstractWorkfilesBackend = controller + extensions = None if controller.is_host_valid(): extensions = controller.get_workfile_extensions() - self._extensions = extensions + self._extensions: Optional[set[str]] = extensions + + self._current_username = _NOT_SET + + # Workarea self._base_data = None self._fill_data_by_folder_id = {} self._task_data_by_folder_id = {} @@ -60,6 +75,9 @@ class WorkareaModel: levels=1, default_factory=list ) + # Entities + self._workfile_entities_by_task_id = {} + def reset(self): self._base_data = None self._fill_data_by_folder_id = {} @@ -68,14 +86,73 @@ class WorkareaModel: self._file_items_mapping = {} self._file_items_cache.reset() - def reset_file_items(self, task_id: str): - cache: CacheItem = self._file_items_cache[task_id] - cache.set_invalid() - self._file_items_mapping.pop(task_id, None) + self._workfile_entities_by_task_id = {} + + def get_workfile_entities(self, task_id: str): + if not task_id: + return [] + workfile_entities = self._workfile_entities_by_task_id.get(task_id) + if workfile_entities is None: + workfile_entities = list(ayon_api.get_workfiles_info( + self._controller.get_current_project_name(), + task_ids=[task_id], + )) + self._workfile_entities_by_task_id[task_id] = workfile_entities + return workfile_entities + + def get_workfile_info( + self, + folder_id: Optional[str], + task_id: Optional[str], + rootless_path: Optional[str] + ): + if not folder_id or not task_id or not rootless_path: + return None + + mapping = self._file_items_mapping.get(task_id) + if mapping is None: + self._cache_file_items(folder_id, task_id) + mapping = self._file_items_mapping[task_id] + return mapping.get(rootless_path) + + def save_workfile_info( + self, + task_id: str, + rootless_path: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], + ): + self._save_workfile_info( + task_id, + rootless_path, + version, + comment, + description, + ) + + self._update_file_description( + task_id, rootless_path, description + ) + + def reset_workarea_file_items(self, task_id): + self._reset_file_items(task_id) def get_workarea_dir_by_context( - self, folder_id: str, task_id: str + self, folder_id: str, task_id: str ) -> Optional[str]: + """Workarea dir for passed context. + + The directory path is based on project anatomy templates. + + Args: + folder_id (str): Folder id. + task_id (str): Task id. + + Returns: + Optional[str]: Workarea dir path or None for invalid context. + + """ if not folder_id or not task_id: return None folder_mapping = self._workdir_by_context.setdefault(folder_id, {}) @@ -93,38 +170,20 @@ class WorkareaModel: folder_mapping[task_id] = workdir return workdir - def get_file_items( - self, - folder_id: Optional[str], - task_id: Optional[str], - ) -> list[WorkfileInfo]: + def get_workarea_file_items(self, folder_id, task_id): + """Workfile items for passed context from workarea. + + Args: + folder_id (Optional[str]): Folder id. + task_id (Optional[str]): Task id. + + Returns: + list[WorkfileInfo]: List of file items matching workarea of passed + context. + + """ return self._cache_file_items(folder_id, task_id) - def get_workfile_info( - self, - folder_id: Optional[str], - task_id: Optional[str], - rootless_path: Optional[str] - ): - if not folder_id or not task_id or not rootless_path: - return None - - mapping = self._file_items_mapping.get(task_id) - if mapping is None: - self._cache_file_items(folder_id, task_id) - mapping = self._file_items_mapping[task_id] - return mapping.get(rootless_path) - - def update_file_description( - self, task_id: str, rootless_path: str, description: str - ): - mapping = self._file_items_mapping.get(task_id) - if not mapping: - return - item = mapping.get(rootless_path) - if item is not None: - item.description = description - def get_workarea_save_as_data( self, folder_id: Optional[str], task_id: Optional[str] ) -> dict[str, Any]: @@ -139,7 +198,7 @@ class WorkareaModel: self._project_name, task_id ) - if not folder_entity or not task_entity: + if not folder_entity or not task_entity or self._extensions is None: return { "template_key": None, "template_has_version": None, @@ -189,15 +248,15 @@ class WorkareaModel: template_has_version = "{version" in file_template_str template_has_comment = "{comment" in file_template_str - file_items = self.get_file_items(folder_id, task_id) + file_items = self.get_workarea_file_items(folder_id, task_id) filepaths = [ item.filepath for item in file_items ] comment_hints, comment = get_comments_from_workfile_paths( filepaths, - file_template, extensions, + file_template, fill_data, current_filename, ) @@ -253,7 +312,7 @@ class WorkareaModel: ) if use_last_version: - file_items = self.get_file_items(folder_id, task_id) + file_items = self.get_workarea_file_items(folder_id, task_id) filepaths = [ item.filepath for item in file_items @@ -285,15 +344,58 @@ class WorkareaModel: exists ) + def get_published_file_items( + self, folder_id: str, task_id: str + ) -> PublishedWorkfileInfo: + """Published workfiles for passed context. + + Args: + folder_id (str): Folder id. + task_id (str): Task id. + + Returns: + list[PublishedWorkfileInfo]: List of files for published workfiles. + + """ + project_name = self._project_name + anatomy = self._controller.project_anatomy + items = self._host.list_published_workfiles( + project_name, + folder_id, + anatomy, + ) + if task_id: + items = [ + item + for item in items + if item.task_id == task_id + ] + return items + @property def _project_name(self) -> str: return self._controller.get_current_project_name() + @property + def _host_name(self) -> str: + return self._host.name + + def _get_current_username(self) -> str: + if self._current_username is _NOT_SET: + self._current_username = get_ayon_username() + return self._current_username + + # --- Workarea --- + def _reset_file_items(self, task_id: str): + cache: CacheItem = self._file_items_cache[task_id] + cache.set_invalid() + self._file_items_mapping.pop(task_id, None) + def _get_base_data(self) -> dict[str, Any]: if self._base_data is None: base_data = get_template_data( ayon_api.get_project(self._project_name), - host_name=self._controller.get_host_name(), + host_name=self._host_name, ) self._base_data = base_data return copy.deepcopy(self._base_data) @@ -316,12 +418,13 @@ class WorkareaModel: ) -> dict[str, Any]: task_data = self._task_data_by_folder_id.setdefault(folder_id, {}) if task_id not in task_data: - task = self._controller.get_task_entity( + task_entity = self._controller.get_task_entity( self._project_name, task_id ) - if task: + if task_entity: task_data[task_id] = get_task_template_data( - project_entity, task) + project_entity, task_entity + ) return copy.deepcopy(task_data[task_id]) def _prepare_fill_data( @@ -395,7 +498,7 @@ class WorkareaModel: return get_workfile_template_key( self._project_name, task_type, - self._controller.get_host_name(), + self._host_name, project_settings=self._controller.project_settings, ) @@ -431,7 +534,7 @@ class WorkareaModel: task_info = fill_data.get("task", {}) return get_versioning_start( self._project_name, - self._controller.get_host_name(), + self._host_name, task_name=task_info.get("name"), task_type=task_info.get("type"), product_type="workfile", @@ -446,141 +549,15 @@ class WorkareaModel: ) return directory_template.format_strict(fill_data).normalized() - -class WorkfilesModel: - """Workfiles model.""" - - def __init__(self, host, controller): - self._host = host - self._controller = controller - - self._workarea_model = WorkareaModel(host, controller) - - self._workfile_entities_by_task_id = {} - self._current_username = _NOT_SET - - def reset(self): - self._workarea_model.reset() - - self._workfile_entities_by_task_id = {} - - def get_workfile_entities(self, task_id: str): - if not task_id: - return [] - workfile_entities = self._workfile_entities_by_task_id.get(task_id) - if workfile_entities is None: - workfile_entities = list(ayon_api.get_workfiles_info( - self._controller.get_current_project_name(), - task_ids=[task_id], - )) - self._workfile_entities_by_task_id[task_id] = workfile_entities - return workfile_entities - - def save_workfile_info( - self, - task_id: str, - rootless_path: str, - version: Optional[int], - comment: Optional[str], - description: Optional[str], + def _update_file_description( + self, task_id: str, rootless_path: str, description: str ): - self._save_workfile_info( - task_id, - rootless_path, - version, - comment, - description, - ) - - self._workarea_model.update_file_description( - task_id, rootless_path, description - ) - - def reset_workarea_file_items(self, task_id): - self._workarea_model.reset_file_items(task_id) - - def get_workfile_info(self, folder_id, task_id, rootless_path): - return self._workarea_model.get_workfile_info( - folder_id, task_id, rootless_path - ) - - def get_workarea_dir_by_context(self, folder_id, task_id): - """Workarea dir for passed context. - - The directory path is based on project anatomy templates. - - Args: - folder_id (str): Folder id. - task_id (str): Task id. - - Returns: - Union[str, None]: Workarea dir path or None for invalid context. - """ - - return self._workarea_model.get_workarea_dir_by_context( - folder_id, task_id) - - def get_workarea_file_items(self, folder_id, task_id): - """Workfile items for passed context from workarea. - - Args: - folder_id (Union[str, None]): Folder id. - task_id (Union[str, None]): Task id. - - Returns: - list[WorkfileInfo]: List of file items matching workarea of passed - context. - - """ - return self._workarea_model.get_file_items( - folder_id, task_id - ) - - def get_workarea_save_as_data(self, folder_id, task_id): - return self._workarea_model.get_workarea_save_as_data( - folder_id, task_id) - - def fill_workarea_filepath(self, *args, **kwargs): - return self._workarea_model.fill_workarea_filepath( - *args, **kwargs - ) - - def get_published_file_items( - self, folder_id, task_id - ) -> PublishedWorkfileInfo: - """Published workfiles for passed context. - - Args: - folder_id (str): Folder id. - task_name (str): Task name. - - Returns: - list[PublishedWorkfileInfo]: List of files for published workfiles. - - """ - project_name = self._project_name - anatomy = self._controller.project_anatomy - items = self._host.list_published_workfiles( - project_name, - folder_id, - anatomy, - ) - if task_id: - items = [ - item - for item in items - if item.task_id == task_id - ] - return items - - @property - def _project_name(self) -> str: - return self._controller.get_current_project_name() - - def _get_current_username(self) -> str: - if self._current_username is _NOT_SET: - self._current_username = get_ayon_username() - return self._current_username + mapping = self._file_items_mapping.get(task_id) + if not mapping: + return + item = mapping.get(rootless_path) + if item is not None: + item.description = description # --- Workfile entities --- def _save_workfile_info( @@ -614,7 +591,7 @@ class WorkfilesModel: data = {} for key, value in ( - ("host_name", self._controller.get_host_name()), + ("host_name", self._host_name), ("version", version), ("comment", comment), ): @@ -681,7 +658,7 @@ class WorkfilesModel: data = {} for key, value in ( - ("host_name", self._controller.get_host_name()), + ("host_name", self._host_name), ("version", version), ("comment", comment), ): From 6a7f41f80a172a928b9e3a5fe745256590d744d4 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 30 Apr 2025 19:06:10 +0200 Subject: [PATCH 044/170] move workfiles related logic to workfiles model --- client/ayon_core/tools/workfiles/control.py | 261 +++------------ .../tools/workfiles/models/workfiles.py | 305 +++++++++++++++++- 2 files changed, 325 insertions(+), 241 deletions(-) diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index 37a3f4115b..f5df9f83ce 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -5,15 +5,11 @@ from typing import Optional import ayon_api from ayon_core.host import IWorkfileHost -from ayon_core.lib import Logger, emit_event +from ayon_core.lib import Logger from ayon_core.lib.events import QueuedEventSystem from ayon_core.settings import get_project_settings from ayon_core.pipeline import Anatomy, registered_host -from ayon_core.pipeline.context_tools import ( - change_current_context, - get_global_context, -) -from ayon_core.pipeline.workfile import create_workdir_extra_folders +from ayon_core.pipeline.context_tools import get_global_context from ayon_core.tools.common_models import ( HierarchyModel, @@ -297,11 +293,6 @@ class BaseWorkfileController( def get_host_name(self): return self._host.name - def _get_host_current_context(self): - if hasattr(self._host, "get_current_context"): - return self._host.get_current_context() - return get_global_context() - def get_current_project_name(self): return self._current_project_name @@ -312,7 +303,7 @@ class BaseWorkfileController( return self._current_task_name def get_current_workfile(self): - return self._host.get_current_workfile() + return self._workfiles_model.get_current_workfile() # Selection information def get_selected_folder_id(self): @@ -522,26 +513,10 @@ class BaseWorkfileController( # Controller actions def open_workfile(self, folder_id, task_id, filepath): - # TODO move to workfiles model - self._emit_event("open_workfile.started") - - failed = False - try: - self._open_workfile(folder_id, task_id, filepath) - - except Exception: - failed = True - self.log.warning("Open of workfile failed", exc_info=True) - - self._emit_event( - "open_workfile.finished", - {"failed": failed}, - ) + self._workfiles_model.open_workfile(folder_id, task_id, filepath) def save_current_workfile(self): - # TODO move to workfiles model - current_file = self.get_current_workfile() - self._host.save_workfile(current_file) + self._workfiles_model.save_current_workfile() def save_as_workfile( self, @@ -554,27 +529,15 @@ class BaseWorkfileController( comment, description, ): - self._emit_event("save_as.started") - - failed = False - try: - self._save_as_workfile( - folder_id, - task_id, - rootless_workdir, - filename, - template_key, - version, - comment, - description, - ) - except Exception: - failed = True - self.log.warning("Save as failed", exc_info=True) - - self._emit_event( - "save_as.finished", - {"failed": failed}, + self._workfiles_model.save_as_workfile( + folder_id, + task_id, + rootless_workdir, + filename, + template_key, + version, + comment, + description, ) def copy_workfile_representation( @@ -590,51 +553,29 @@ class BaseWorkfileController( comment, description, ): - # TODO move to workfiles model - self._emit_event("copy_representation.started") - - failed = False - try: - self._save_as_workfile( - folder_id, - task_id, - workdir, - filename, - template_key, - version, - comment, - description, - src_filepath=representation_filepath - ) - except Exception: - failed = True - self.log.warning( - "Copy of workfile representation failed", exc_info=True - ) - - self._emit_event( - "copy_representation.finished", - {"failed": failed}, + self._workfiles_model.copy_workfile_representation( + representation_id, + representation_filepath, + folder_id, + task_id, + workdir, + filename, + template_key, + version, + comment, + description, ) def duplicate_workfile( self, src_filepath, workdir, filename, version, comment, description ): - # TODO move to workfiles model - # TODO save workfile information - self._emit_event("workfile_duplicate.started") - - failed = False - try: - dst_filepath = os.path.join(workdir, filename) - shutil.copy(src_filepath, dst_filepath) - except Exception: - failed = True - self.log.warning("Duplication of workfile failed", exc_info=True) - - self._emit_event( - "workfile_duplicate.finished", - {"failed": failed}, + self._workfiles_model.duplicate_workfile( + src_filepath, + workdir, + filename, + version, + comment, + description, ) def _emit_event(self, topic, data=None): @@ -651,6 +592,11 @@ class BaseWorkfileController( return None return task_item.id + def _get_host_current_context(self): + if hasattr(self._host, "get_current_context"): + return self._host.get_current_context() + return get_global_context() + # Expected selection # - expected selection is used to restore selection after refresh # or when current context should be used @@ -659,136 +605,3 @@ class BaseWorkfileController( "expected_selection_changed", self._expected_selection.get_expected_selection_data(), ) - - def _get_event_context_data( - self, project_name, folder_id, task_id, folder=None, task=None - ): - if folder is None: - folder = self.get_folder_entity(project_name, folder_id) - if task is None: - task = self.get_task_entity(project_name, task_id) - return { - "project_name": project_name, - "folder_id": folder_id, - "folder_path": folder["path"], - "task_id": task_id, - "task_name": task["name"], - "host_name": self.get_host_name(), - } - - def _open_workfile(self, folder_id, task_id, filepath): - # TODO move to workfiles model - project_name = self.get_current_project_name() - event_data = self._get_event_context_data( - project_name, folder_id, task_id - ) - event_data["filepath"] = filepath - - emit_event("workfile.open.before", event_data, source="workfiles.tool") - - # Change context - task_name = event_data["task_name"] - if ( - folder_id != self.get_current_folder_id() - or task_name != self.get_current_task_name() - ): - self._change_current_context(project_name, folder_id, task_id) - - self._host.open_workfile(filepath) - - emit_event("workfile.open.after", event_data, source="workfiles.tool") - - def _save_as_workfile( - self, - folder_id: str, - task_id: str, - rootless_workdir: str, - filename: str, - template_key: str, - version: Optional[int], - comment: Optional[str], - description: Optional[str], - src_filepath=None, - ): - # TODO move to workfiles model - # Trigger before save event - project_name = self.get_current_project_name() - folder = self.get_folder_entity(project_name, folder_id) - task = self.get_task_entity(project_name, task_id) - task_name = task["name"] - - workdir = self.project_anatomy.fill_root(rootless_workdir) - - # QUESTION should the data be different for 'before' and 'after'? - event_data = self._get_event_context_data( - project_name, folder_id, task_id, folder, task - ) - event_data.update({ - "filename": filename, - "workdir_path": workdir, - }) - - emit_event("workfile.save.before", event_data, source="workfiles.tool") - - # Create workfiles root folder - if not os.path.exists(workdir): - self.log.debug("Initializing work directory: %s", workdir) - os.makedirs(workdir) - - # Change context - if ( - folder_id != self.get_current_folder_id() - or task_name != self.get_current_task_name() - ): - self._change_current_context( - project_name, folder_id, task_id, template_key - ) - - # Save workfile - dst_filepath = os.path.join(workdir, filename) - if src_filepath: - shutil.copyfile(src_filepath, dst_filepath) - self._host.open_workfile(dst_filepath) - else: - self._host.save_workfile(dst_filepath) - - # Make sure workfile info exists - if not description: - description = None - if not comment: - comment = None - self.save_workfile_info( - task_id, - f"{rootless_workdir}/{filename}", - version, - comment, - description, - ) - self._workfiles_model.reset_workarea_file_items(task_id) - - # Create extra folders - create_workdir_extra_folders( - workdir, - self.get_host_name(), - task["taskType"], - task_name, - project_name - ) - - # Trigger after save events - emit_event("workfile.save.after", event_data, source="workfiles.tool") - - def _change_current_context( - self, project_name, folder_id, task_id, template_key=None - ): - # Change current context - folder_entity = self.get_folder_entity(project_name, folder_id) - task_entity = self.get_task_entity(project_name, task_id) - change_current_context( - folder_entity, - task_entity, - template_key=template_key - ) - self._current_folder_id = folder_entity["id"] - self._current_folder_path = folder_entity["path"] - self._current_task_name = task_entity["name"] diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index d04975bafb..6508f693dd 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -4,6 +4,7 @@ import copy import uuid import platform import typing +import shutil from typing import Optional, Any import ayon_api @@ -13,6 +14,8 @@ from ayon_core.lib import ( get_ayon_username, NestedCacheItem, CacheItem, + emit_event, + Logger, ) from ayon_core.host import ( HostBase, @@ -30,8 +33,10 @@ from ayon_core.pipeline.workfile import ( get_workfile_template_key, get_last_workfile_with_version_from_paths, get_comments_from_workfile_paths, + create_workdir_extra_folders, ) from ayon_core.pipeline.version_start import get_versioning_start +from ayon_core.pipeline.context_tools import change_current_context from ayon_core.tools.workfiles.abstract import ( WorkareaFilepathResult, AbstractWorkfilesBackend, @@ -58,6 +63,7 @@ class WorkfilesModel: self._host: HostType = host self._controller: AbstractWorkfilesBackend = controller + self._log = Logger.get_logger("WorkfilesModel") extensions = None if controller.is_host_valid(): extensions = controller.get_workfile_extensions() @@ -70,8 +76,8 @@ class WorkfilesModel: self._fill_data_by_folder_id = {} self._task_data_by_folder_id = {} self._workdir_by_context = {} - self._file_items_mapping = {} - self._file_items_cache = NestedCacheItem( + self._workarea_file_items_mapping = {} + self._workarea_file_items_cache = NestedCacheItem( levels=1, default_factory=list ) @@ -83,18 +89,135 @@ class WorkfilesModel: self._fill_data_by_folder_id = {} self._task_data_by_folder_id = {} self._workdir_by_context = {} - self._file_items_mapping = {} - self._file_items_cache.reset() + self._workarea_file_items_mapping = {} + self._workarea_file_items_cache.reset() self._workfile_entities_by_task_id = {} + # Host functionality + def get_current_workfile(self): + return self._host.get_current_workfile() + + def open_workfile(self, folder_id, task_id, filepath): + self._emit_event("open_workfile.started") + + failed = False + try: + self._open_workfile(folder_id, task_id, filepath) + + except Exception: + failed = True + self._log.warning("Open of workfile failed", exc_info=True) + + self._emit_event( + "open_workfile.finished", + {"failed": failed}, + ) + + def save_current_workfile(self): + current_file = self.get_current_workfile() + self._host.save_workfile(current_file) + + def save_as_workfile( + self, + folder_id, + task_id, + rootless_workdir, + filename, + template_key, + version, + comment, + description, + ): + self._emit_event("save_as.started") + + failed = False + try: + self._save_as_workfile( + folder_id, + task_id, + rootless_workdir, + filename, + template_key, + version, + comment, + description, + ) + except Exception: + failed = True + self._log.warning("Save as failed", exc_info=True) + + self._emit_event( + "save_as.finished", + {"failed": failed}, + ) + + def copy_workfile_representation( + self, + representation_id, + representation_filepath, + folder_id, + task_id, + workdir, + filename, + template_key, + version, + comment, + description, + ): + # TODO move to workfiles pipeline + self._emit_event("copy_representation.started") + + failed = False + try: + self._save_as_workfile( + folder_id, + task_id, + workdir, + filename, + template_key, + version, + comment, + description, + src_filepath=representation_filepath + ) + except Exception: + failed = True + self._log.warning( + "Copy of workfile representation failed", exc_info=True + ) + + self._emit_event( + "copy_representation.finished", + {"failed": failed}, + ) + + def duplicate_workfile( + self, src_filepath, workdir, filename, version, comment, description + ): + # TODO save workfile information + self._emit_event("workfile_duplicate.started") + + failed = False + try: + dst_filepath = os.path.join(workdir, filename) + shutil.copy(src_filepath, dst_filepath) + except Exception: + failed = True + self._log.warning("Duplication of workfile failed", exc_info=True) + + self._emit_event( + "workfile_duplicate.finished", + {"failed": failed}, + ) + def get_workfile_entities(self, task_id: str): if not task_id: return [] workfile_entities = self._workfile_entities_by_task_id.get(task_id) if workfile_entities is None: workfile_entities = list(ayon_api.get_workfiles_info( - self._controller.get_current_project_name(), + self._project_name, task_ids=[task_id], )) self._workfile_entities_by_task_id[task_id] = workfile_entities @@ -109,10 +232,10 @@ class WorkfilesModel: if not folder_id or not task_id or not rootless_path: return None - mapping = self._file_items_mapping.get(task_id) + mapping = self._workarea_file_items_mapping.get(task_id) if mapping is None: self._cache_file_items(folder_id, task_id) - mapping = self._file_items_mapping[task_id] + mapping = self._workarea_file_items_mapping[task_id] return mapping.get(rootless_path) def save_workfile_info( @@ -135,11 +258,11 @@ class WorkfilesModel: task_id, rootless_path, description ) - def reset_workarea_file_items(self, task_id): - self._reset_file_items(task_id) + def reset_workarea_file_items(self, task_id: str): + self._reset_workarea_file_items(task_id) def get_workarea_dir_by_context( - self, folder_id: str, task_id: str + self, folder_id: str, task_id: str ) -> Optional[str]: """Workarea dir for passed context. @@ -346,7 +469,7 @@ class WorkfilesModel: def get_published_file_items( self, folder_id: str, task_id: str - ) -> PublishedWorkfileInfo: + ) -> list[PublishedWorkfileInfo]: """Published workfiles for passed context. Args: @@ -380,16 +503,164 @@ class WorkfilesModel: def _host_name(self) -> str: return self._host.name + def _emit_event(self, topic, data=None): + self._controller.emit_event(topic, data, "workfiles") + def _get_current_username(self) -> str: if self._current_username is _NOT_SET: self._current_username = get_ayon_username() return self._current_username + # --- Host --- + def _get_event_context_data( + self, + project_name: str, + folder_id: str, + task_id: str, + folder_entity: Optional[dict[str, Any]] = None, + task_entity: Optional[dict[str, Any]] = None, + ): + if folder_entity is None: + folder_entity = self._controller.get_folder_entity( + project_name, folder_id + ) + if task_entity is None: + task_entity = self._controller.get_task_entity( + project_name, task_id + ) + return { + "project_name": project_name, + "folder_id": folder_id, + "folder_path": folder_entity["path"], + "task_id": task_id, + "task_name": task_entity["name"], + "host_name": self._host_name, + } + + def _open_workfile(self, folder_id: str, task_id: str, filepath: str): + # TODO move to workfiles pipeline + project_name = self._project_name + event_data = self._get_event_context_data( + project_name, folder_id, task_id + ) + event_data["filepath"] = filepath + + emit_event("workfile.open.before", event_data, source="workfiles.tool") + + # Change context + task_name = event_data["task_name"] + if ( + folder_id != self._controller.get_current_folder_id() + or task_name != self._controller.get_current_task_name() + ): + self._change_current_context(project_name, folder_id, task_id) + + self._host.open_workfile(filepath) + + emit_event("workfile.open.after", event_data, source="workfiles.tool") + + def _save_as_workfile( + self, + folder_id: str, + task_id: str, + rootless_workdir: str, + filename: str, + template_key: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], + src_filepath=None, + ): + # TODO move to workfiles pipeline + # Trigger before save event + project_name = self._project_name + folder = self._controller.get_folder_entity(project_name, folder_id) + task = self._controller.get_task_entity(project_name, task_id) + task_name = task["name"] + + workdir = self._controller.project_anatomy.fill_root(rootless_workdir) + + # QUESTION should the data be different for 'before' and 'after'? + event_data = self._get_event_context_data( + project_name, folder_id, task_id, folder, task + ) + event_data.update({ + "filename": filename, + "workdir_path": workdir, + }) + + emit_event("workfile.save.before", event_data, source="workfiles.tool") + + # Create workfiles root folder + if not os.path.exists(workdir): + self._log.debug("Initializing work directory: %s", workdir) + os.makedirs(workdir) + + # Change context + if ( + folder_id != self._controller.get_current_folder_id() + or task_name != self._controller.get_current_task_name() + ): + self._change_current_context( + project_name, folder_id, task_id, template_key + ) + + # Save workfile + dst_filepath = os.path.join(workdir, filename) + if src_filepath: + shutil.copyfile(src_filepath, dst_filepath) + self._host.open_workfile(dst_filepath) + else: + self._host.save_workfile(dst_filepath) + + # Make sure workfile info exists + if not description: + description = None + if not comment: + comment = None + self.save_workfile_info( + task_id, + f"{rootless_workdir}/{filename}", + version, + comment, + description, + ) + self.reset_workarea_file_items(task_id) + + # Create extra folders + create_workdir_extra_folders( + workdir, + self._host_name, + task["taskType"], + task_name, + project_name + ) + + # Trigger after save events + emit_event("workfile.save.after", event_data, source="workfiles.tool") + + def _change_current_context( + self, project_name, folder_id, task_id, template_key=None + ): + # Change current context + folder_entity = self._controller.get_folder_entity( + project_name, folder_id + ) + task_entity = self._controller.get_task_entity(project_name, task_id) + change_current_context( + folder_entity, + task_entity, + template_key=template_key + ) + self._current_folder_id = folder_entity["id"] + self._current_folder_path = folder_entity["path"] + self._current_task_name = task_entity["name"] + # --- Workarea --- - def _reset_file_items(self, task_id: str): - cache: CacheItem = self._file_items_cache[task_id] + def _reset_workarea_file_items(self, task_id: str): + cache: CacheItem = self._workarea_file_items_cache[task_id] cache.set_invalid() - self._file_items_mapping.pop(task_id, None) + self._workarea_file_items_mapping.pop(task_id, None) def _get_base_data(self) -> dict[str, Any]: if self._base_data is None: @@ -450,7 +721,7 @@ class WorkfilesModel: if not folder_id or not task_id: return [] - cache: CacheItem = self._file_items_cache[task_id] + cache: CacheItem = self._workarea_file_items_cache[task_id] if cache.is_valid: return cache.get_data() @@ -485,7 +756,7 @@ class WorkfilesModel: cache.update_data(items) # Cache items by entity ids and rootless path - self._file_items_mapping[task_id] = { + self._workarea_file_items_mapping[task_id] = { item.rootless_path: item for item in items } @@ -552,7 +823,7 @@ class WorkfilesModel: def _update_file_description( self, task_id: str, rootless_path: str, description: str ): - mapping = self._file_items_mapping.get(task_id) + mapping = self._workarea_file_items_mapping.get(task_id) if not mapping: return item = mapping.get(rootless_path) From 21c1a8bda2b219894c51a9a52b36195de227ab3d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 16 May 2025 10:23:07 +0200 Subject: [PATCH 045/170] added base implementation to workfiles interface --- client/ayon_core/host/interfaces/workfiles.py | 161 +++++++++++++++++- 1 file changed, 156 insertions(+), 5 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 21085abaa8..970e31bc88 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1,6 +1,7 @@ from __future__ import annotations import os import platform +import shutil from abc import abstractmethod from dataclasses import dataclass, asdict import typing @@ -65,7 +66,7 @@ class WorkfileInfo: return asdict(self) @classmethod - def from_data(self, data): + def from_data(cls, data): """Converts data to workfile item. Args: @@ -80,6 +81,7 @@ class WorkfileInfo: @dataclass class PublishedWorkfileInfo: + project_name: str folder_id: str task_id: Optional[str] representation_id: str @@ -94,6 +96,7 @@ class PublishedWorkfileInfo: @classmethod def new( cls, + project_name: str, folder_id: str, task_id: Optional[str], repre_entity: dict[str, Any], @@ -107,6 +110,7 @@ class PublishedWorkfileInfo: created_at = arrow.get(repre_entity["createdAt"]).to("local") return cls( + project_name=project_name, folder_id=folder_id, task_id=task_id, representation_id=repre_entity["id"], @@ -129,7 +133,7 @@ class PublishedWorkfileInfo: return asdict(self) @classmethod - def from_data(self, data): + def from_data(cls, data): """Converts data to workfile item. Args: @@ -192,10 +196,12 @@ class IWorkfileHost: return None def get_workfile_extensions(self) -> list[str]: - """Extensions that can be used as save. + """Extensions that can be used as save workfile. - Questions: - This could potentially use 'HostDefinition'. + Notes: + Method may not be used if 'list_workfiles' and + 'list_published_workfiles' are re-implemented with different + logic. Returns: list[str]: List of extensions that can be used for saving. @@ -203,6 +209,51 @@ class IWorkfileHost: """ return [] + def save_workfile_with_context( + self, + filepath: str, + folder_id: str, + task_id: str, + folder_entity: Optional[dict[str, Any]] = None, + task_entity: Optional[dict[str, Any]] = None, + ): + """Save current workfile with context. + + Notes: + Should this method care about context change? + + Args: + filepath (str): Where the current scene should be saved. + folder_id (str): Folder id. + task_id (str): Task id. + + """ + self.save_workfile(filepath) + + def open_workfile_with_context( + self, + filepath: str, + folder_id: str, + task_id: str, + folder_entity: Optional[dict[str, Any]] = None, + task_entity: Optional[dict[str, Any]] = None, + ): + """Open passed filepath in the host with context. + + This function should be used to open workfile in different context. + + Notes: + Should this method care about context change? + + Args: + filepath (str): Path to workfile. + folder_id (str): Folder id. + task_id (str): Task id. + + """ + self.open_workfile(filepath) + + def list_workfiles( self, project_name: str, @@ -422,6 +473,7 @@ class IWorkfileHost: file_modified = filestat.st_mtime workfile_item = PublishedWorkfileInfo.new( + project_name, folder_id, task_id, repre_entity, @@ -436,6 +488,105 @@ class IWorkfileHost: return items + def copy_workfile( + self, + src_path: str, + dst_path: str, + folder_id: str, + task_id: str, + open_workfile: bool = False, + folder_entity: Optional[dict[str, Any]] = None, + task_entity: Optional[dict[str, Any]] = None, + ): + """Save workfile path with target folder and task context. + + It is expected that workfile is saved to current project, but can be + copied from other project. + + Args: + src_path (str): Path to the source scene. + dst_path (str): Where the scene should be saved. + folder_id (str): Folder id. + task_id (str): Task id. + open_workfile (bool): Open workfile when copied. + + """ + # TODO We might need option to open file once copied as some DCC might + # actually need to open the workfile to copy it. + dst_dir = os.path.dirname(dst_path) + if not os.path.exists(dst_dir): + os.makedirs(dst_dir, exist_ok=True) + shutil.copy(src_path, dst_path) + if open_workfile: + self.open_workfile_with_context( + dst_path, + folder_id, + task_id, + folder_entity=folder_entity, + task_entity=task_entity, + ) + + def copy_workfile_representation( + self, + src_project_name: str, + src_representation_id: str, + dst_path: str, + folder_id: str, + task_id: str, + open_workfile: bool = False, + anatomy: Optional[Anatomy] = None, + src_representation_entity: Optional[dict[str, Any]] = None, + src_representation_path: Optional[str] = None, + folder_entity: Optional[dict[str, Any]] = None, + task_entity: Optional[dict[str, Any]] = None, + ): + """Copy workfile representation. + + Use representation as source for the workfile. + + Args: + src_project_name (str): Project name. + src_representation_id (str): Representation id. + dst_path (str): Where the scene should be saved. + folder_id (str): Folder id. + task_id (str): Task id. + open_workfile (bool): Open workfile when copied. + anatomy (Optional[Anatomy]): Project anatomy. + src_representation_entity (Optional[dict[str, Any]]): Representation + entity. + src_representation_path (Optional[str]): Representation path. + + """ + # TODO We might need option to open file once copied as some DCC might + # actually need to open the workfile to copy it. + from ayon_core.pipeline import Anatomy + from ayon_core.pipeline.load import ( + get_representation_path_with_anatomy + ) + + if src_representation_path is None: + if src_representation_entity is None: + src_representation_entity = ayon_api.get_representation_by_id( + src_project_name, src_representation_id + ) + + if anatomy is None: + anatomy = Anatomy(src_project_name) + src_representation_path = get_representation_path_with_anatomy( + src_representation_entity, + anatomy, + ) + + self.copy_workfile( + src_representation_path, + dst_path, + folder_id, + task_id, + open_workfile=open_workfile, + folder_entity=folder_entity, + task_entity=task_entity, + ) + # --- Deprecated method names --- def file_extensions(self): """Deprecated variant of 'get_workfile_extensions'. From 29d824decfca2a5ee295dbc47c76203de7b8bebd Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 16 May 2025 10:25:18 +0200 Subject: [PATCH 046/170] modified change current context function --- client/ayon_core/pipeline/context_tools.py | 47 +++++++++++++++++----- 1 file changed, 37 insertions(+), 10 deletions(-) diff --git a/client/ayon_core/pipeline/context_tools.py b/client/ayon_core/pipeline/context_tools.py index 66556bbb35..0c6e86ef4b 100644 --- a/client/ayon_core/pipeline/context_tools.py +++ b/client/ayon_core/pipeline/context_tools.py @@ -10,7 +10,7 @@ import pyblish.api from pyblish.lib import MessageHandler from ayon_core import AYON_CORE_ROOT -from ayon_core.host import HostBase +from ayon_core.host import HostBase, IWorkfileHost from ayon_core.lib import ( is_in_tests, initialize_ayon_connection, @@ -505,37 +505,64 @@ def get_current_context_custom_workfile_template(project_settings=None): ) -def change_current_context(folder_entity, task_entity, template_key=None): +def change_current_context( + folder_entity, + task_entity, + template_key=None, + workdir=None, + anatomy=None, + project_entity=None, + project_settings=None, +): """Update active Session to a new task work area. This updates the live Session to a different task under folder. + Notes: + This function does a lot of things related to workfiles which + extends arguments options a lot. + We might want to implement 'set_current_context' on host integration + instead. But `AYON_WORKDIR`, which is related to 'IWorkfileHost', + would not be available in that case which might be break some + logic. + Args: folder_entity (Dict[str, Any]): Folder entity to set. task_entity (Dict[str, Any]): Task entity to set. - template_key (Union[str, None]): Prepared template key to be used for + template_key (Optional[str]): Prepared template key to be used for workfile template in Anatomy. + workdir (Optional[str]): Workdir to set. + anatomy (Optional[Anatomy]): Anatomy object used for workdir + calculation. + project_entity (Optional[dict[str, Any]]): Project entity used for + workdir calculation. + project_settings (Optional[dict[str, Any]]): Project settings used for + workdir calculation. Returns: Dict[str, str]: The changed key, values in the current Session. - """ - project_name = get_current_project_name() - workdir = None + """ + host = registered_host() + project_name = host.get_current_project_name() folder_path = None task_name = None if folder_entity: folder_path = folder_entity["path"] if task_entity: task_name = task_entity["name"] - project_entity = ayon_api.get_project(project_name) - host_name = get_current_host_name() + + if isinstance(host, IWorkfileHost) and workdir is None and folder_entity: + if project_entity is None: + project_entity = ayon_api.get_project(project_name) workdir = get_workdir( project_entity, folder_entity, task_entity, - host_name, - template_key=template_key + host.name, + anatomy=anatomy, + template_key=template_key, + project_settings=project_settings, ) envs = { From f4638b92cd9bea6ef3c9a243adda202b9741196d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 16 May 2025 10:25:31 +0200 Subject: [PATCH 047/170] implemented utils functions for workfiles --- .../ayon_core/pipeline/workfile/__init__.py | 10 + client/ayon_core/pipeline/workfile/utils.py | 646 +++++++++++++++++- 2 files changed, 655 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/__init__.py b/client/ayon_core/pipeline/workfile/__init__.py index 5b8a10c288..cc081d676b 100644 --- a/client/ayon_core/pipeline/workfile/__init__.py +++ b/client/ayon_core/pipeline/workfile/__init__.py @@ -21,6 +21,11 @@ from .utils import ( should_use_last_workfile_on_launch, should_open_workfiles_tool_on_launch, MissingWorkdirError, + + open_workfile, + save_current_workfile_to, + copy_and_open_workfile, + copy_and_open_workfile_representation, ) from .build_workfile import BuildWorkfile @@ -57,6 +62,11 @@ __all__ = ( "should_open_workfiles_tool_on_launch", "MissingWorkdirError", + "open_workfile", + "save_current_workfile_to", + "copy_and_open_workfile", + "copy_and_open_workfile_representation", + "BuildWorkfile", "discover_workfile_build_plugins", diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 25be061dec..44c811d5e2 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -1,6 +1,24 @@ -from ayon_core.lib import filter_profiles +from __future__ import annotations +import os +import platform +import uuid +import typing +from typing import Optional, Any + +import ayon_api +from ayon_api.operations import OperationsSession + +from ayon_core.lib import filter_profiles, emit_event, get_ayon_username from ayon_core.settings import get_project_settings +from .path_resolving import ( + create_workdir_extra_folders, + get_workfile_template_key, +) + +if typing.TYPE_CHECKING: + from ayon_core.pipeline import Anatomy + class MissingWorkdirError(Exception): """Raised when accessing a work directory not found on disk.""" @@ -124,3 +142,629 @@ def should_open_workfiles_tool_on_launch( if output is None: return default_output return output + + +def _get_event_context_data( + project_name: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + host_name: str, +): + return { + "project_name": project_name, + "folder_id": folder_entity["id"], + "folder_path": folder_entity["path"], + "task_id": task_entity["id"], + "task_name": task_entity["name"], + "host_name": host_name, + } + + +def save_workfile_info( + project_name: str, + task_id: str, + rootless_path: str, + host_name: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], + username: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, +): + # TODO create pipeline function for this + if workfile_entities is None: + workfile_entities = list(ayon_api.get_workfiles_info( + project_name, + task_ids=[task_id], + )) + + workfile_entity = next( + ( + _ent + for _ent in workfile_entities + if _ent["path"] == rootless_path + ), + None + ) + + if username is None: + username = get_ayon_username() + + if not workfile_entity: + return _create_workfile_info_entity( + project_name, + task_id, + host_name, + rootless_path, + username, + version, + comment, + description, + ) + + data = {} + for key, value in ( + ("host_name", host_name), + ("version", version), + ("comment", comment), + ): + if value is not None: + data[key] = value + + old_data = workfile_entity["data"] + + changed_data = {} + for key, value in data.items(): + if key not in old_data or old_data[key] != value: + changed_data[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 + + # Automatically fix 'createdBy' and 'updatedBy' fields + # NOTE both fields were not automatically filled by server + # until 1.1.3 release. + if workfile_entity.get("createdBy") is None: + update_data["createdBy"] = username + workfile_entity["createdBy"] = username + + if workfile_entity.get("updatedBy") != username: + update_data["updatedBy"] = username + workfile_entity["updatedBy"] = username + + if not update_data: + return + + session = OperationsSession() + session.update_entity( + project_name, + "workfile", + workfile_entity["id"], + update_data, + ) + session.commit() + return workfile_entity + + +def open_workfile( + filepath: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], +): + from ayon_core.pipeline.context_tools import ( + registered_host, change_current_context + ) + + # Trigger before save event + host = registered_host() + context = host.get_current_context() + project_name = context["project_name"] + current_folder_path = context["folder_path"] + current_task_name = context["task_name"] + host_name = host.name + + # TODO move to workfiles pipeline + event_data = _get_event_context_data( + project_name, folder_entity, task_entity, host_name + ) + event_data["filepath"] = filepath + + emit_event("workfile.open.before", event_data, source="workfiles.tool") + + # Change context + if ( + folder_entity["path"] != current_folder_path + or task_entity["name"] != current_task_name + ): + change_current_context( + project_name, + folder_entity, + task_entity, + workdir=os.path.dirname(filepath) + ) + + host.open_workfile(filepath) + + emit_event("workfile.open.after", event_data, source="workfiles.tool") + + +def save_current_workfile_to( + workfile_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + version: Optional[int], + comment: Optional[str] = None, + description: Optional[str] = None, + source: Optional[str] = None, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + username: Optional[str] = None, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, +) -> dict[str, Any]: + """Save current workfile to new location or context. + + Args: + workfile_path (str): Destination workfile path. + folder_entity (dict[str, Any]): Target folder entity. + task_entity (dict[str, Any]): Target task entity. + version (Optional[int]): Workfile version. + comment (optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + source (Optional[str]): Source of the save action. + rootless_path (Optional[str]): Rootless path of the workfile. Is + calculated if not passed in. + workfile_entities (Optional[list[dict[str, Any]]]): List of workfile + username (Optional[str]): Username of the user saving the workfile. + Current user is used if not passed. + project_entity (Optional[dict[str, Any]]): Project entity used for + rootless path calculation. + project_settings (Optional[dict[str, Any]]): Project settings used for + rootless path calculation. + anatomy (Optional[Anatomy]): Project anatomy used for rootless + path calculation. + + Returns: + dict[str, Any]: Workfile info entity. + + """ + print("save_current_workfile_to") + return _save_workfile( + None, + None, + None, + None, + workfile_path, + folder_entity, + task_entity, + version, + comment, + description, + source, + rootless_path, + workfile_entities, + username, + project_entity, + project_settings, + anatomy, + ) + + +def copy_and_open_workfile( + src_workfile_path: str, + workfile_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + version: Optional[int], + comment: Optional[str] = None, + description: Optional[str] = None, + source: Optional[str] = None, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + username: Optional[str] = None, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, +) -> dict[str, Any]: + """Copy workfile to new location and open it. + + Args: + src_workfile_path (str): Source workfile path. + workfile_path (str): Destination workfile path. + folder_entity (dict[str, Any]): Target folder entity. + task_entity (dict[str, Any]): Target task entity. + version (Optional[int]): Workfile version. + comment (optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + source (Optional[str]): Source of the save action. + rootless_path (Optional[str]): Rootless path of the workfile. Is + calculated if not passed in. + workfile_entities (Optional[list[dict[str, Any]]]): List of workfile + username (Optional[str]): Username of the user saving the workfile. + Current user is used if not passed. + project_entity (Optional[dict[str, Any]]): Project entity used for + rootless path calculation. + project_settings (Optional[dict[str, Any]]): Project settings used for + rootless path calculation. + anatomy (Optional[Anatomy]): Project anatomy used for rootless + path calculation. + + Returns: + dict[str, Any]: Workfile info entity. + + """ + print("copy_and_open_workfile") + return _save_workfile( + src_workfile_path, + None, + None, + None, + workfile_path, + folder_entity, + task_entity, + version, + comment, + description, + source, + rootless_path, + workfile_entities, + username, + project_entity, + project_settings, + anatomy, + ) + + +def copy_and_open_workfile_representation( + project_name: str, + representation_id: str, + workfile_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + version: Optional[int], + comment: Optional[str] = None, + description: Optional[str] = None, + source: Optional[str] = None, + rootless_path: Optional[str] = None, + representation_entity: Optional[dict[str, Any]] = None, + representation_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + username: Optional[str] = None, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, +) -> dict[str, Any]: + """Copy workfile to new location and open it. + + Args: + project_name (str): Project name where representation is stored. + representation_id (str): Source representation id. + workfile_path (str): Destination workfile path. + folder_entity (dict[str, Any]): Target folder entity. + task_entity (dict[str, Any]): Target task entity. + version (Optional[int]): Workfile version. + comment (optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + source (Optional[str]): Source of the save action. + rootless_path (Optional[str]): Rootless path of the workfile. Is + calculated if not passed in. + workfile_entities (Optional[list[dict[str, Any]]]): List of workfile + username (Optional[str]): Username of the user saving the workfile. + Current user is used if not passed. + project_entity (Optional[dict[str, Any]]): Project entity used for + rootless path calculation. + project_settings (Optional[dict[str, Any]]): Project settings used for + rootless path calculation. + anatomy (Optional[Anatomy]): Project anatomy used for rootless + path calculation. + + Returns: + dict[str, Any]: Workfile info entity. + + """ + print("copy_and_open_workfile_representation") + if representation_entity is None: + representation_entity = ayon_api.get_representation_by_id( + project_name, + representation_id, + ) + + return _save_workfile( + None, + project_name, + representation_entity, + representation_path, + workfile_path, + folder_entity, + task_entity, + version, + comment, + description, + source, + rootless_path, + workfile_entities, + username, + project_entity, + project_settings, + anatomy, + ) + + +def _save_workfile( + src_workfile_path: Optional[str], + representation_project_name: Optional[str], + representation_entity: Optional[dict[str, Any]], + representation_path: Optional[str], + workfile_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + version: Optional[int], + comment: Optional[str], + description: Optional[str], + source: Optional[str], + rootless_path: Optional[str], + workfile_entities: Optional[list[dict[str, Any]]], + username: Optional[str], + project_entity: Optional[dict[str, Any]], + project_settings: Optional[dict[str, Any]], + anatomy: Optional["Anatomy"], +) -> dict[str, Any]: + """Function used to save workfile to new location and context. + + Because the functionality for 'save_current_workfile_to' and + 'copy_and_open_workfile' is currently the same, except for used + function on host it is easier to create this wrapper function. + + Args: + src_workfile_path (Optional[str]): Source workfile path. + representation_entity (Optional[dict[str, Any]]): Representation used + as source for workfile. + workfile_path (str): Destination workfile path. + folder_entity (dict[str, Any]): Target folder entity. + task_entity (dict[str, Any]): Target task entity. + version (Optional[int]): Workfile version. + comment (optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + source (Optional[str]): Source of the save action. + rootless_path (Optional[str]): Rootless path of the workfile. Is + calculated if not passed in. + workfile_entities (Optional[list[dict[str, Any]]]): List of workfile + username (Optional[str]): Username of the user saving the workfile. + Current user is used if not passed. + project_entity (Optional[dict[str, Any]]): Project entity used for + rootless path calculation. + project_settings (Optional[dict[str, Any]]): Project settings used for + rootless path calculation. + anatomy (Optional[Anatomy]): Project anatomy used for rootless + path calculation. + + Returns: + dict[str, Any]: Workfile info entity. + + """ + from ayon_core.pipeline.context_tools import ( + registered_host, change_current_context + ) + + # Trigger before save event + host = registered_host() + context = host.get_current_context() + project_name = context["project_name"] + current_folder_path = context["folder_path"] + current_task_name = context["task_name"] + + folder_id = folder_entity["id"] + task_name = task_entity["name"] + task_type = task_entity["taskType"] + task_id = task_entity["id"] + host_name = host.name + + workdir, filename = os.path.split(workfile_path) + + # QUESTION should the data be different for 'before' and 'after'? + event_data = _get_event_context_data( + project_name, folder_entity, task_entity, host_name + ) + event_data.update({ + "filename": filename, + "workdir_path": workdir, + }) + + emit_event("workfile.save.before", event_data, source=source) + + # Change context + if ( + folder_entity["path"] != current_folder_path + or task_entity["name"] != current_task_name + ): + change_current_context( + folder_entity, + task_entity, + workdir=workdir, + anatomy=anatomy, + project_entity=project_entity, + project_settings=project_settings, + ) + + if src_workfile_path: + host.copy_workfile( + src_workfile_path, + workfile_path, + folder_id, + task_id, + open_workfile=True, + dst_folder_entity=folder_entity, + dst_task_entity=task_entity, + ) + elif representation_entity: + host.copy_workfile_representation( + representation_project_name, + representation_entity["id"], + workfile_path, + folder_id, + task_id, + open_workfile=True, + folder_entity=folder_entity, + task_entity=task_entity, + src_representation_entity=representation_entity, + src_representation_path=representation_path, + anatomy=anatomy, + ) + else: + host.save_workfile_with_context( + workfile_path, + folder_id, + task_id, + open_workfile=True, + folder_entity=folder_entity, + task_entity=task_entity, + ) + + if not description: + description = None + + if not comment: + comment = None + + if rootless_path is None: + rootless_path = _find_rootless_path( + workfile_path, + project_name, + task_type, + host_name, + project_entity, + project_settings, + anatomy, + ) + + # It is not possible to create workfile infor without rootless path + workfile_info = None + if rootless_path: + if platform.system().lower() == "windows": + rootless_path = rootless_path.replace("\\", "/") + + workfile_info = save_workfile_info( + project_name, + task_id, + rootless_path, + host_name, + version, + comment, + description, + username=username, + workfile_entities=workfile_entities, + ) + + # Create extra folders + create_workdir_extra_folders( + workdir, + host.name, + task_entity["taskType"], + task_name, + project_name + ) + + # Trigger after save events + emit_event("workfile.save.after", event_data, source=source) + return workfile_info + + +def _find_rootless_path( + workfile_path: str, + project_name: str, + task_type: str, + host_name: str, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, +) -> str: + """Find rootless workfile path.""" + if anatomy is None: + from ayon_core.pipeline import Anatomy + + anatomy = Anatomy(project_name, project_entity=project_entity) + template_key = get_workfile_template_key( + project_name, + task_type, + host_name, + project_settings=project_settings + ) + dir_template = anatomy.get_template_item( + "work", template_key, "directory" + ) + result = dir_template.format({"root": anatomy.roots}) + used_root = result.used_values.get("root") + rootless_path = str(workfile_path) + if platform.system().lower() == "windows": + rootless_path = rootless_path.replace("\\", "/") + + root_key = root_value = None + if used_root is not None: + root_key, root_value = next(iter(used_root.items())) + if platform.system().lower() == "windows": + root_value = root_value.replace("\\", "/") + + if root_value and rootless_path.startswith(root_value): + rootless_path = rootless_path[len(root_value):].lstrip("/") + rootless_path = f"{{root[{root_key}]}}/{rootless_path}" + else: + success, result = anatomy.find_root_template_from_path(rootless_path) + if success: + rootless_path = result + return rootless_path + + +def _create_workfile_info_entity( + project_name: str, + task_id: str, + host_name: str, + rootless_path: str, + username: str, + version: Optional[int], + comment: Optional[str], + description: Optional[str], +) -> dict[str, Any]: + 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 = {} + for key, value in ( + ("host_name", host_name), + ("version", version), + ("comment", comment), + ): + if value is not None: + data[key] = value + + workfile_info = { + "id": uuid.uuid4().hex, + "path": rootless_path, + "taskId": task_id, + "attrib": attrib, + "data": data, + # TODO remove 'createdBy' and 'updatedBy' fields when server is + # or above 1.1.3 . + "createdBy": username, + "updatedBy": username, + } + + session = OperationsSession() + session.create_entity( + project_name, "workfile", workfile_info + ) + session.commit() + return workfile_info \ No newline at end of file From 639087937f025edc3cf47205df22abdc47bbfd53 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 16 May 2025 10:26:01 +0200 Subject: [PATCH 048/170] modified workfiles tool accordingly --- client/ayon_core/tools/workfiles/abstract.py | 20 +- client/ayon_core/tools/workfiles/control.py | 21 +- .../tools/workfiles/models/workfiles.py | 343 ++++++++++-------- .../tools/workfiles/widgets/files_widget.py | 9 +- 4 files changed, 235 insertions(+), 158 deletions(-) diff --git a/client/ayon_core/tools/workfiles/abstract.py b/client/ayon_core/tools/workfiles/abstract.py index 6d7d0b4c0e..863d6bb9bc 100644 --- a/client/ayon_core/tools/workfiles/abstract.py +++ b/client/ayon_core/tools/workfiles/abstract.py @@ -866,8 +866,8 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): folder_id, task_id, rootless_workdir, + workdir, filename, - template_key, version, comment, description, @@ -897,7 +897,7 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): task_id, workdir, filename, - template_key, + rootless_workdir, version, comment, description, @@ -914,7 +914,7 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): task_id (str): Task id. workdir (str): Workarea directory. filename (str): Workarea filename. - template_key (str): Template key. + rootless_workdir (str): Rootless workdir. version (int): Workfile version. comment (str): User's comment (subversion). description (str): Description note. @@ -924,14 +924,26 @@ class AbstractWorkfilesFrontend(AbstractWorkfilesCommon): @abstractmethod def duplicate_workfile( - self, src_filepath, workdir, filename, description, version, comment + self, + folder_id, + task_id, + src_filepath, + rootless_workdir, + workdir, + filename, + description, + version, + comment ): """Duplicate workfile. Workfiles is not opened when done. Args: + folder_id (str): Folder id. + task_id (str): Task id. src_filepath (str): Source workfile path. + rootless_workdir (str): Rootless workdir. workdir (str): Destination workdir. filename (str): Destination filename. version (int): Workfile version. diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index f5df9f83ce..faab199c9f 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -523,8 +523,8 @@ class BaseWorkfileController( folder_id, task_id, rootless_workdir, + workdir, filename, - template_key, version, comment, description, @@ -534,7 +534,6 @@ class BaseWorkfileController( task_id, rootless_workdir, filename, - template_key, version, comment, description, @@ -548,7 +547,7 @@ class BaseWorkfileController( task_id, workdir, filename, - template_key, + rootless_workdir, version, comment, description, @@ -560,17 +559,29 @@ class BaseWorkfileController( task_id, workdir, filename, - template_key, + rootless_workdir, version, comment, description, ) def duplicate_workfile( - self, src_filepath, workdir, filename, version, comment, description + self, + folder_id, + task_id, + src_filepath, + rootless_workdir, + workdir, + filename, + version, + comment, + description ): self._workfiles_model.duplicate_workfile( + folder_id, + task_id, src_filepath, + rootless_workdir, workdir, filename, version, diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 6508f693dd..d9a217653e 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -14,7 +14,6 @@ from ayon_core.lib import ( get_ayon_username, NestedCacheItem, CacheItem, - emit_event, Logger, ) from ayon_core.host import ( @@ -33,10 +32,12 @@ from ayon_core.pipeline.workfile import ( get_workfile_template_key, get_last_workfile_with_version_from_paths, get_comments_from_workfile_paths, - create_workdir_extra_folders, + open_workfile, + save_current_workfile_to, + copy_and_open_workfile, + copy_and_open_workfile_representation, ) from ayon_core.pipeline.version_start import get_versioning_start -from ayon_core.pipeline.context_tools import change_current_context from ayon_core.tools.workfiles.abstract import ( WorkareaFilepathResult, AbstractWorkfilesBackend, @@ -81,6 +82,12 @@ class WorkfilesModel: levels=1, default_factory=list ) + # Published workfiles + self._repre_by_id = {} + self._published_workfile_items_cache = NestedCacheItem( + levels=1, default_factory=list + ) + # Entities self._workfile_entities_by_task_id = {} @@ -92,6 +99,9 @@ class WorkfilesModel: self._workarea_file_items_mapping = {} self._workarea_file_items_cache.reset() + self._repre_by_id = {} + self._published_workfile_items_cache.reset() + self._workfile_entities_by_task_id = {} # Host functionality @@ -123,26 +133,50 @@ class WorkfilesModel: folder_id, task_id, rootless_workdir, + workdir, filename, - template_key, version, comment, description, ): self._emit_event("save_as.started") + filepath = os.path.join(workdir, filename) + rootless_path = f"{rootless_workdir}/{filename}" + project_name = self._controller.get_current_project_name() + folder_entity = self._controller.get_folder_entity( + project_name, folder_id + ) + task_entity = self._controller.get_task_entity( + project_name, task_id + ) + workfile_entities = self.get_workfile_entities(task_id) failed = False try: - self._save_as_workfile( - folder_id, - task_id, - rootless_workdir, - filename, - template_key, + workfile_info = save_current_workfile_to( + filepath, + folder_entity, + task_entity, version, comment, description, + source="workfiles.tool", + rootless_path=rootless_path, + workfile_entities=workfile_entities, + username=self._get_current_username(), + project_entity=self._controller.get_project_entity( + project_name + ), + project_settings=self._controller.project_settings, + anatomy=self._controller.project_anatomy, ) + self._update_workfile_info( + task_id, rootless_path, description, workfile_info + ) + self._update_current_context( + folder_id, folder_entity["path"], task_entity["name"] + ) + except Exception: failed = True self._log.warning("Save as failed", exc_info=True) @@ -160,27 +194,53 @@ class WorkfilesModel: task_id, workdir, filename, - template_key, + rootless_workdir, version, comment, description, ): - # TODO move to workfiles pipeline self._emit_event("copy_representation.started") + project_name = self._project_name + folder_entity = self._controller.get_folder_entity( + self._project_name, folder_id + ) + task_entity = self._controller.get_task_entity( + self._project_name, task_id + ) + repre_entity = self._repre_by_id.get(representation_id) + dst_filepath = os.path.join(workdir, filename) + rootless_path = f"{rootless_workdir}/{filename}" + failed = False try: - self._save_as_workfile( - folder_id, - task_id, - workdir, - filename, - template_key, - version, - comment, - description, - src_filepath=representation_filepath + workfile_info = copy_and_open_workfile_representation( + project_name, + representation_id, + dst_filepath, + folder_entity, + task_entity, + version=version, + comment=comment, + description=description, + rootless_path=rootless_path, + representation_entity=repre_entity, + representation_path=representation_filepath, + workfile_entities=self.get_workfile_entities(task_id), + username=self._get_current_username(), + project_entity=self._controller.get_project_entity( + project_name + ), + project_settings=self._controller.project_settings, + anatomy=self._controller.project_anatomy, ) + self._update_workfile_info( + task_id, rootless_path, description, workfile_info + ) + self._update_current_context( + folder_id, folder_entity["path"], task_entity["name"] + ) + except Exception: failed = True self._log.warning( @@ -193,15 +253,47 @@ class WorkfilesModel: ) def duplicate_workfile( - self, src_filepath, workdir, filename, version, comment, description + self, + folder_id, + task_id, + src_filepath, + rootless_workdir, + workdir, + filename, + version, + comment, + description ): - # TODO save workfile information self._emit_event("workfile_duplicate.started") + project_name = self._controller.get_current_project_name() + project_entity = self._controller.get_project_entity(project_name) + folder_entity = self._controller.get_folder_entity( + project_name, folder_id + ) + task_entity = self._controller.get_task_entity(project_name, task_id) + workfile_entities = self.get_workfile_entities(task_id) + rootless_path = f"{rootless_workdir}/{filename}" + workfile_path = os.path.join(workdir, filename) failed = False try: - dst_filepath = os.path.join(workdir, filename) - shutil.copy(src_filepath, dst_filepath) + copy_and_open_workfile( + src_filepath, + workfile_path, + folder_entity, + task_entity, + version, + comment, + description, + source="workfiles.tool", + rootless_path=rootless_path, + workfile_entities=workfile_entities, + username=self._get_current_username(), + project_entity=project_entity, + project_settings=self._controller.project_settings, + anatomy=self._controller.project_anatomy, + ) + except Exception: failed = True self._log.warning("Duplication of workfile failed", exc_info=True) @@ -258,9 +350,6 @@ class WorkfilesModel: task_id, rootless_path, description ) - def reset_workarea_file_items(self, task_id: str): - self._reset_workarea_file_items(task_id) - def get_workarea_dir_by_context( self, folder_id: str, task_id: str ) -> Optional[str]: @@ -480,13 +569,51 @@ class WorkfilesModel: list[PublishedWorkfileInfo]: List of files for published workfiles. """ - project_name = self._project_name - anatomy = self._controller.project_anatomy - items = self._host.list_published_workfiles( - project_name, - folder_id, - anatomy, - ) + if not folder_id: + return [] + + cache = self._published_workfile_items_cache[folder_id] + if not cache.is_valid: + project_name = self._project_name + anatomy = self._controller.project_anatomy + + product_entities = ayon_api.get_products( + project_name, + folder_ids={folder_id}, + product_types={"workfile"}, + fields={"id", "name"} + ) + + version_entities = [] + product_ids = {product["id"] for product in product_entities} + if product_ids: + # Get version docs of products with their families + version_entities = list(ayon_api.get_versions( + project_name, + product_ids=product_ids, + fields={"id", "author", "taskId"}, + )) + + repre_entities = [] + if version_entities: + repre_entities = list(ayon_api.get_representations( + project_name, + version_ids={v["id"] for v in version_entities} + )) + + self._repre_by_id.update({ + repre_entity["id"]: repre_entity + for repre_entity in repre_entities + }) + + cache.update_data(self._host.list_published_workfiles( + project_name, + folder_id, + anatomy, + )) + + items = cache.get_data() + if task_id: items = [ item @@ -540,121 +667,21 @@ class WorkfilesModel: def _open_workfile(self, folder_id: str, task_id: str, filepath: str): # TODO move to workfiles pipeline project_name = self._project_name - event_data = self._get_event_context_data( - project_name, folder_id, task_id - ) - event_data["filepath"] = filepath - - emit_event("workfile.open.before", event_data, source="workfiles.tool") - - # Change context - task_name = event_data["task_name"] - if ( - folder_id != self._controller.get_current_folder_id() - or task_name != self._controller.get_current_task_name() - ): - self._change_current_context(project_name, folder_id, task_id) - - self._host.open_workfile(filepath) - - emit_event("workfile.open.after", event_data, source="workfiles.tool") - - def _save_as_workfile( - self, - folder_id: str, - task_id: str, - rootless_workdir: str, - filename: str, - template_key: str, - version: Optional[int], - comment: Optional[str], - description: Optional[str], - src_filepath=None, - ): - # TODO move to workfiles pipeline - # Trigger before save event - project_name = self._project_name - folder = self._controller.get_folder_entity(project_name, folder_id) - task = self._controller.get_task_entity(project_name, task_id) - task_name = task["name"] - - workdir = self._controller.project_anatomy.fill_root(rootless_workdir) - - # QUESTION should the data be different for 'before' and 'after'? - event_data = self._get_event_context_data( - project_name, folder_id, task_id, folder, task - ) - event_data.update({ - "filename": filename, - "workdir_path": workdir, - }) - - emit_event("workfile.save.before", event_data, source="workfiles.tool") - - # Create workfiles root folder - if not os.path.exists(workdir): - self._log.debug("Initializing work directory: %s", workdir) - os.makedirs(workdir) - - # Change context - if ( - folder_id != self._controller.get_current_folder_id() - or task_name != self._controller.get_current_task_name() - ): - self._change_current_context( - project_name, folder_id, task_id, template_key - ) - - # Save workfile - dst_filepath = os.path.join(workdir, filename) - if src_filepath: - shutil.copyfile(src_filepath, dst_filepath) - self._host.open_workfile(dst_filepath) - else: - self._host.save_workfile(dst_filepath) - - # Make sure workfile info exists - if not description: - description = None - if not comment: - comment = None - self.save_workfile_info( - task_id, - f"{rootless_workdir}/{filename}", - version, - comment, - description, - ) - self.reset_workarea_file_items(task_id) - - # Create extra folders - create_workdir_extra_folders( - workdir, - self._host_name, - task["taskType"], - task_name, - project_name - ) - - # Trigger after save events - emit_event("workfile.save.after", event_data, source="workfiles.tool") - - def _change_current_context( - self, project_name, folder_id, task_id, template_key=None - ): - # Change current context folder_entity = self._controller.get_folder_entity( project_name, folder_id ) - task_entity = self._controller.get_task_entity(project_name, task_id) - change_current_context( - folder_entity, - task_entity, - template_key=template_key + task_entity = self._controller.get_task_entity( + project_name, task_id ) - self._current_folder_id = folder_entity["id"] - self._current_folder_path = folder_entity["path"] - self._current_task_name = task_entity["name"] + open_workfile(filepath, folder_entity, task_entity) + self._update_current_context( + folder_id, folder_entity["path"], task_entity["name"] + ) + + def _update_current_context(self, folder_id, folder_path, task_name): + self._current_folder_id = folder_id + self._current_folder_path = folder_path + self._current_task_name = task_name # --- Workarea --- def _reset_workarea_file_items(self, task_id: str): @@ -820,6 +847,28 @@ class WorkfilesModel: ) return directory_template.format_strict(fill_data).normalized() + def _update_workfile_info( + self, + task_id: str, + rootless_path: str, + description: str, + workfile_entity: dict[str, Any], + ): + self._update_file_description(task_id, rootless_path, description) + workfile_entities = self.get_workfile_entities(task_id) + target_idx = None + for idx, workfile_entity in enumerate(workfile_entities): + if workfile_entity["path"] == rootless_path: + target_idx = idx + break + + if target_idx is None: + workfile_entities.append(workfile_entity) + else: + workfile_entities[target_idx] = workfile_entity + + self._reset_workarea_file_items(task_id) + def _update_file_description( self, task_id: str, rootless_path: str, description: str ): diff --git a/client/ayon_core/tools/workfiles/widgets/files_widget.py b/client/ayon_core/tools/workfiles/widgets/files_widget.py index d45e057192..012a12ab17 100644 --- a/client/ayon_core/tools/workfiles/widgets/files_widget.py +++ b/client/ayon_core/tools/workfiles/widgets/files_widget.py @@ -213,9 +213,14 @@ class FilesWidget(QtWidgets.QWidget): result = self._exec_save_as_dialog() if result is None: return + folder_id = self._selected_folder_id + task_id = self._selected_task_id self._controller.duplicate_workfile( + folder_id, + task_id, filepath, result["rootless_workdir"], + result["workdir"], result["filename"], version=result["version"], comment=result["comment"], @@ -265,8 +270,8 @@ class FilesWidget(QtWidgets.QWidget): result["folder_id"], result["task_id"], result["rootless_workdir"], + result["workdir"], result["filename"], - result["template_key"], version=result["version"], comment=result["comment"], description=result["description"] @@ -321,7 +326,7 @@ class FilesWidget(QtWidgets.QWidget): result["task_id"], result["workdir"], result["filename"], - result["template_key"], + result["rootless_workdir"], version=result["version"], comment=result["comment"], description=result["description"], From 723463d44ee578945aa35e6ba4ac17bb440dd590 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 16 May 2025 10:43:02 +0200 Subject: [PATCH 049/170] use correct function --- client/ayon_core/pipeline/workfile/utils.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 44c811d5e2..94f4528205 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -289,7 +289,13 @@ def open_workfile( workdir=os.path.dirname(filepath) ) - host.open_workfile(filepath) + host.open_workfile_with_context( + filepath, + folder_entity["id"], + task_entity["id"], + folder_entity, + task_entity, + ) emit_event("workfile.open.after", event_data, source="workfiles.tool") From a37c074771b5dea0937496023629ad87a7da8be5 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 19 May 2025 10:35:59 +0200 Subject: [PATCH 050/170] expect entities instead of ids --- client/ayon_core/host/interfaces/workfiles.py | 80 ++++++------------- client/ayon_core/pipeline/workfile/utils.py | 23 ++---- .../tools/workfiles/models/workfiles.py | 6 +- 3 files changed, 35 insertions(+), 74 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 970e31bc88..de4c096237 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -212,10 +212,8 @@ class IWorkfileHost: def save_workfile_with_context( self, filepath: str, - folder_id: str, - task_id: str, - folder_entity: Optional[dict[str, Any]] = None, - task_entity: Optional[dict[str, Any]] = None, + folder_entity: dict[str, Any] = None, + task_entity: dict[str, Any] = None, ): """Save current workfile with context. @@ -224,8 +222,8 @@ class IWorkfileHost: Args: filepath (str): Where the current scene should be saved. - folder_id (str): Folder id. - task_id (str): Task id. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. """ self.save_workfile(filepath) @@ -233,10 +231,8 @@ class IWorkfileHost: def open_workfile_with_context( self, filepath: str, - folder_id: str, - task_id: str, - folder_entity: Optional[dict[str, Any]] = None, - task_entity: Optional[dict[str, Any]] = None, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], ): """Open passed filepath in the host with context. @@ -257,11 +253,9 @@ class IWorkfileHost: def list_workfiles( self, project_name: str, - folder_id: str, - task_id: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], project_entity: Optional[dict[str, Any]] = None, - folder_entity: Optional[dict[str, Any]] = None, - task_entity: Optional[dict[str, Any]] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, template_key: Optional[str] = None, project_settings: Optional[dict[str, Any]] = None, @@ -278,11 +272,9 @@ class IWorkfileHost: Args: project_name (str): Name of project. - folder_id (str): ID of folder. - task_id (str): ID of task. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. project_entity (Optional[dict[str, Any]]): Project entity. - folder_entity (Optional[dict[str, Any]]): Folder entity. - task_entity (Optional[dict[str, Any]]): Task entity. workfile_entities (Optional[list[dict[str, Any]]]): Workfile entities. template_key (Optional[str]): Template key. @@ -304,13 +296,8 @@ class IWorkfileHost: if project_entity is None: project_entity = ayon_api.get_project(project_name) - if folder_entity is None: - folder_entity = ayon_api.get_folder_by_id(project_name, folder_id) - - if task_entity is None: - task_entity = ayon_api.get_task_by_id(project_name, task_id) - if workfile_entities is None: + task_id = task_entity["id"] workfile_entities = list(ayon_api.get_workfiles_info( project_name, task_ids=[task_id] )) @@ -492,11 +479,9 @@ class IWorkfileHost: self, src_path: str, dst_path: str, - folder_id: str, - task_id: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], open_workfile: bool = False, - folder_entity: Optional[dict[str, Any]] = None, - task_entity: Optional[dict[str, Any]] = None, ): """Save workfile path with target folder and task context. @@ -506,8 +491,8 @@ class IWorkfileHost: Args: src_path (str): Path to the source scene. dst_path (str): Where the scene should be saved. - folder_id (str): Folder id. - task_id (str): Task id. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. open_workfile (bool): Open workfile when copied. """ @@ -520,25 +505,20 @@ class IWorkfileHost: if open_workfile: self.open_workfile_with_context( dst_path, - folder_id, - task_id, - folder_entity=folder_entity, - task_entity=task_entity, + folder_entity, + task_entity, ) def copy_workfile_representation( self, src_project_name: str, - src_representation_id: str, + src_representation_entity: dict[str, Any], dst_path: str, - folder_id: str, - task_id: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], open_workfile: bool = False, anatomy: Optional[Anatomy] = None, - src_representation_entity: Optional[dict[str, Any]] = None, src_representation_path: Optional[str] = None, - folder_entity: Optional[dict[str, Any]] = None, - task_entity: Optional[dict[str, Any]] = None, ): """Copy workfile representation. @@ -546,14 +526,13 @@ class IWorkfileHost: Args: src_project_name (str): Project name. - src_representation_id (str): Representation id. + src_representation_entity (dict[str, Any]): Representation + entity. dst_path (str): Where the scene should be saved. - folder_id (str): Folder id. - task_id (str): Task id. + folder_entity (dict[str, Any): Folder entity. + task_entity (dict[str, Any]): Task entity. open_workfile (bool): Open workfile when copied. anatomy (Optional[Anatomy]): Project anatomy. - src_representation_entity (Optional[dict[str, Any]]): Representation - entity. src_representation_path (Optional[str]): Representation path. """ @@ -565,11 +544,6 @@ class IWorkfileHost: ) if src_representation_path is None: - if src_representation_entity is None: - src_representation_entity = ayon_api.get_representation_by_id( - src_project_name, src_representation_id - ) - if anatomy is None: anatomy = Anatomy(src_project_name) src_representation_path = get_representation_path_with_anatomy( @@ -580,11 +554,9 @@ class IWorkfileHost: self.copy_workfile( src_representation_path, dst_path, - folder_id, - task_id, + folder_entity, + task_entity, open_workfile=open_workfile, - folder_entity=folder_entity, - task_entity=task_entity, ) # --- Deprecated method names --- diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 94f4528205..c5b6b16e2a 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -291,8 +291,6 @@ def open_workfile( host.open_workfile_with_context( filepath, - folder_entity["id"], - task_entity["id"], folder_entity, task_entity, ) @@ -603,34 +601,27 @@ def _save_workfile( host.copy_workfile( src_workfile_path, workfile_path, - folder_id, - task_id, + folder_entity, + task_entity, open_workfile=True, - dst_folder_entity=folder_entity, - dst_task_entity=task_entity, ) elif representation_entity: host.copy_workfile_representation( representation_project_name, - representation_entity["id"], + representation_entity, workfile_path, - folder_id, - task_id, + folder_entity, + task_entity, open_workfile=True, - folder_entity=folder_entity, - task_entity=task_entity, - src_representation_entity=representation_entity, src_representation_path=representation_path, anatomy=anatomy, ) else: host.save_workfile_with_context( workfile_path, - folder_id, - task_id, + folder_entity, + task_entity, open_workfile=True, - folder_entity=folder_entity, - task_entity=task_entity, ) if not description: diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index d9a217653e..d13bfa248f 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -770,11 +770,9 @@ class WorkfilesModel: items = self._host.list_workfiles( self._project_name, - folder_id, - task_id, + folder_entity, + task_entity, project_entity=project_entity, - folder_entity=folder_entity, - task_entity=task_entity, anatomy=anatomy, template_key=template_key, project_settings=project_settings, From 70f3c05d0793f9f04f8a5890cecbe8ea31a0b4e1 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 19 May 2025 10:45:49 +0200 Subject: [PATCH 051/170] linting fixes --- client/ayon_core/host/interfaces/workfiles.py | 5 ++--- client/ayon_core/pipeline/workfile/utils.py | 3 +-- client/ayon_core/tools/workfiles/control.py | 2 -- client/ayon_core/tools/workfiles/models/workfiles.py | 1 - client/ayon_core/tools/workfiles/widgets/side_panel.py | 4 +++- 5 files changed, 6 insertions(+), 9 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index de4c096237..f416d19aa0 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -243,13 +243,12 @@ class IWorkfileHost: Args: filepath (str): Path to workfile. - folder_id (str): Folder id. - task_id (str): Task id. + folder_entity (dict[str, Any]): Folder id. + task_entity (dict[str, Any]): Task id. """ self.open_workfile(filepath) - def list_workfiles( self, project_name: str, diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index c5b6b16e2a..a7a1436522 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -564,7 +564,6 @@ def _save_workfile( current_folder_path = context["folder_path"] current_task_name = context["task_name"] - folder_id = folder_entity["id"] task_name = task_entity["name"] task_type = task_entity["taskType"] task_id = task_entity["id"] @@ -764,4 +763,4 @@ def _create_workfile_info_entity( project_name, "workfile", workfile_info ) session.commit() - return workfile_info \ No newline at end of file + return workfile_info diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index faab199c9f..ab6b12e4f4 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -1,6 +1,4 @@ import os -import shutil -from typing import Optional import ayon_api diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index d13bfa248f..4f5fb9890d 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -4,7 +4,6 @@ import copy import uuid import platform import typing -import shutil from typing import Optional, Any import ayon_api diff --git a/client/ayon_core/tools/workfiles/widgets/side_panel.py b/client/ayon_core/tools/workfiles/widgets/side_panel.py index 2e146fddbe..b1b91d9721 100644 --- a/client/ayon_core/tools/workfiles/widgets/side_panel.py +++ b/client/ayon_core/tools/workfiles/widgets/side_panel.py @@ -48,7 +48,9 @@ class SidePanelWidget(QtWidgets.QWidget): description_widget = QtWidgets.QWidget(self) description_label = QtWidgets.QLabel("Artist note", description_widget) description_input = QtWidgets.QPlainTextEdit(description_widget) - btn_description_save = QtWidgets.QPushButton("Save note", description_widget) + btn_description_save = QtWidgets.QPushButton( + "Save note", description_widget + ) description_layout = QtWidgets.QVBoxLayout(description_widget) description_layout.setContentsMargins(0, 0, 0, 0) From a159e02f873a9176fbe1ac351035a152615dd3a0 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 21 May 2025 16:51:22 +0200 Subject: [PATCH 052/170] fix arguments --- client/ayon_core/pipeline/workfile/utils.py | 1 - client/ayon_core/tools/workfiles/control.py | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index a7a1436522..f36e349841 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -620,7 +620,6 @@ def _save_workfile( workfile_path, folder_entity, task_entity, - open_workfile=True, ) if not description: diff --git a/client/ayon_core/tools/workfiles/control.py b/client/ayon_core/tools/workfiles/control.py index ab6b12e4f4..4391e6b5fd 100644 --- a/client/ayon_core/tools/workfiles/control.py +++ b/client/ayon_core/tools/workfiles/control.py @@ -531,6 +531,7 @@ class BaseWorkfileController( folder_id, task_id, rootless_workdir, + workdir, filename, version, comment, From edb371fb38b6c0d7e57f3450608db833080cb4f7 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 22 May 2025 12:35:38 +0200 Subject: [PATCH 053/170] Remove outdated todo --- client/ayon_core/pipeline/workfile/utils.py | 1 - 1 file changed, 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index f36e349841..d37287b330 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -171,7 +171,6 @@ def save_workfile_info( username: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, ): - # TODO create pipeline function for this if workfile_entities is None: workfile_entities = list(ayon_api.get_workfiles_info( project_name, From e97f7f1d20e07727411308b9b7cb73e4a328e10f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 26 May 2025 15:11:34 +0200 Subject: [PATCH 054/170] added docstring to dataclasses --- client/ayon_core/host/interfaces/workfiles.py | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index f416d19aa0..7d924dff3a 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -16,6 +16,29 @@ if typing.TYPE_CHECKING: @dataclass class WorkfileInfo: + """Information about workfile. + + Host can open, copy and use the workfile using this information object. + + Attributes: + filepath (str): Path to the workfile. + rootless_path (str): Path to the workfile without root. And without + backslashes on Windows. + file_size (Optional[float]): Size of the workfile in bytes. + file_created (Optional[float]): Timestamp when the workfile was + created on the filesystem. + file_modified (Optional[float]): Timestamp when the workfile was + modified on the filesystem. + workfile_entity_id (Optional[str]): Workfile entity id. If None then + the workfile is not in the database. + description (str): Description of the workfile. + created_by (Optional[str]): User id of the user who created the + workfile entity. + updated_by (Optional[str]): User id of the user who updated the + workfile entity. + available (bool): True if workfile is available on the machine. + + """ filepath: str rootless_path: str file_size: Optional[float] @@ -81,6 +104,27 @@ class WorkfileInfo: @dataclass class PublishedWorkfileInfo: + """Information about published workfile. + + Host can copy and use the workfile using this information object. + + Attributes: + project_name (str): Name of the project where workfile lives. + folder_id (str): Folder id under which is workfile stored. + task_id (Optional[str]): Task id under which is workfile stored. + representation_id (str): Representation id of the workfile. + filepath (str): Path to the workfile. + created_at (float): Timestamp when the workfile representation + was created. + author (str): Author of the workfile representation. + available (bool): True if workfile is available on the machine. + file_size (Optional[float]): Size of the workfile in bytes. + file_created (Optional[float]): Timestamp when the workfile was + created on the filesystem. + file_modified (Optional[float]): Timestamp when the workfile was + modified on the filesystem. + + """ project_name: str folder_id: str task_id: Optional[str] From c83bae2605f60bc6aa555d542b5783171cb0c01a Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 12:03:13 +0200 Subject: [PATCH 055/170] move context change responsibility to host --- client/ayon_core/host/host.py | 224 ++++++++++++++++++++- client/ayon_core/pipeline/context_tools.py | 106 +++++----- 2 files changed, 262 insertions(+), 68 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index 3333cf3778..d451b768c1 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -1,10 +1,20 @@ +from __future__ import annotations + import os import logging import contextlib from abc import ABC, abstractmethod +import typing +from typing import Optional, Any -# NOTE can't import 'typing' because of issues in Maya 2020 -# - shiboken crashes on 'typing' module import +import ayon_api + +from ayon_core.lib import emit_event + +from .interfaces import IWorkfileHost + +if typing.TYPE_CHECKING: + from ayon_core.pipeline import Anatomy class HostBase(ABC): @@ -94,12 +104,12 @@ class HostBase(ABC): @property @abstractmethod - def name(self): + def name(self) -> str: """Host name.""" pass - def get_current_project_name(self): + def get_current_project_name(self) -> str: """ Returns: Union[str, None]: Current project name. @@ -107,7 +117,7 @@ class HostBase(ABC): return os.environ.get("AYON_PROJECT_NAME") - def get_current_folder_path(self): + def get_current_folder_path(self) -> Optional[str]: """ Returns: Union[str, None]: Current asset name. @@ -115,7 +125,7 @@ class HostBase(ABC): return os.environ.get("AYON_FOLDER_PATH") - def get_current_task_name(self): + def get_current_task_name(self) -> Optional[str]: """ Returns: Union[str, None]: Current task name. @@ -123,7 +133,7 @@ class HostBase(ABC): return os.environ.get("AYON_TASK_NAME") - def get_current_context(self): + def get_current_context(self) -> dict[str, Optional[str]]: """Get current context information. This method should be used to get current context of host. Usage of @@ -142,6 +152,88 @@ class HostBase(ABC): "task_name": self.get_current_task_name() } + def set_current_context( + self, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + *, + reason: Optional[str] = None, + workdir: Optional[str] = None, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + ): + """Set current context information. + + This method should be used to set current context of host. Usage of + this method can be crucial for host implementations in DCCs where + can be opened multiple workfiles at one moment and change of context + can't be caught properly. + + Notes: + This method should not care about change of workdir and expect any + of the arguments. + + Args: + folder_entity (Optional[dict[str, Any]]): Folder entity. + task_entity (Optional[dict[str, Any]]): Task entity. + reason (Optional[str]): Reason for context change. + workdir (Optional[str]): Work directory path. + project_entity (Optional[dict[str, Any]]): Project entity data. + project_settings (Optional[dict[str, Any]]): Project settings data. + anatomy (Optional[Anatomy]): Anatomy instance for the project. + + """ + from ayon_core.pipeline import Anatomy + + folder_path = folder_entity["path"] + task_name = task_entity["name"] + + context = self.get_current_context() + # Don't do anything if context did not change + if ( + context["folder_path"] == folder_path + and context["task_name"] == task_name + ): + return context + + project_name = self.get_current_project_name() + if project_entity is None: + project_entity = ayon_api.get_project(project_name) + + if anatomy is None: + anatomy = Anatomy(project_name, project_entity=project_entity) + + self._before_context_change( + project_entity, + folder_entity, + task_entity, + anatomy, + reason, + ) + self._set_current_context( + project_entity, + folder_entity, + task_entity, + reason, + workdir, + anatomy, + project_settings, + ) + self._after_context_change( + project_entity, + folder_entity, + task_entity, + anatomy, + reason, + ) + + return self._emit_context_change_event( + project_name, + folder_path, + task_name, + ) + def get_context_title(self): """Context title shown for UI purposes. @@ -188,3 +280,121 @@ class HostBase(ABC): yield finally: pass + + def _emit_context_change_event( + self, + project_name: str, + folder_path: Optional[str], + task_name: Optional[str], + ): + """Emit context change event. + + Args: + project_name (str): Name of the project. + folder_path (Optional[str]): Path of the folder. + task_name (Optional[str]): Name of the task. + + """ + data = { + "project_name": project_name, + "folder_path": folder_path, + "task_name": task_name, + } + emit_event("taskChanged", data) + return data + + def _set_current_context( + self, + project_entity: dict[str, Any], + folder_entity: Optional[dict[str, Any]], + task_entity: Optional[dict[str, Any]], + reason: Optional[str], + workdir: Optional[str], + anatomy: Optional["Anatomy"], + project_settings: Optional[dict[str, Any]], + ): + from ayon_core.pipeline.workfile import get_workdir + + project_name = self.get_current_project_name() + folder_path = None + task_name = None + if folder_entity: + folder_path = folder_entity["path"] + if task_entity: + task_name = task_entity["name"] + + if ( + workdir is None + and isinstance(self, IWorkfileHost) + and folder_entity + ): + if project_entity is None: + project_entity = ayon_api.get_project(project_name) + + workdir = get_workdir( + project_entity, + folder_entity, + task_entity, + self.name, + anatomy=anatomy, + project_settings=project_settings, + ) + + envs = { + "AYON_PROJECT_NAME": project_name, + "AYON_FOLDER_PATH": folder_path, + "AYON_TASK_NAME": task_name, + "AYON_WORKDIR": workdir, + } + + # Update the Session and environments. Pop from environments all keys with + # value set to None. + for key, value in envs.items(): + if value is None: + os.environ.pop(key, None) + else: + os.environ[key] = value + + def _before_context_change( + self, + project_entity: dict[str, Any], + folder_entity: Optional[dict[str, Any]], + task_entity: Optional[dict[str, Any]], + anatomy: "Anatomy", + reason: Optional[str], + ): + """Before context is changed. + + This method is called before the context is changed in the host. + + Can be overriden to implement host specific logic. + + Args: + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + reason (Optional[str]): Reason for context change. + + """ + pass + + def _after_context_change( + self, + project_entity: dict[str, Any], + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + anatomy: "Anatomy", + reason: Optional[str], + ): + """After context is changed. + + This method is called after the context is changed in the host. + + Can be overriden to implement host specific logic. + + Args: + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + reason (Optional[str]): Reason for context change. + + """ + pass diff --git a/client/ayon_core/pipeline/context_tools.py b/client/ayon_core/pipeline/context_tools.py index 0c6e86ef4b..c51f0ad0d9 100644 --- a/client/ayon_core/pipeline/context_tools.py +++ b/client/ayon_core/pipeline/context_tools.py @@ -1,20 +1,21 @@ """Core pipeline functionality""" - +from __future__ import annotations import os import logging import platform import uuid +import warnings +from typing import Optional, Any import ayon_api import pyblish.api from pyblish.lib import MessageHandler from ayon_core import AYON_CORE_ROOT -from ayon_core.host import HostBase, IWorkfileHost +from ayon_core.host import HostBase from ayon_core.lib import ( is_in_tests, initialize_ayon_connection, - emit_event, version_up ) from ayon_core.addon import load_addons, AddonsManager @@ -24,7 +25,6 @@ from .publish.lib import filter_pyblish_plugins from .anatomy import Anatomy from .template_data import get_template_data_with_names from .workfile import ( - get_workdir, get_custom_workfile_template_by_string_context, get_workfile_template_key_from_context, get_last_workfile, @@ -505,14 +505,19 @@ def get_current_context_custom_workfile_template(project_settings=None): ) +_PLACEHOLDER = object() + + def change_current_context( - folder_entity, - task_entity, - template_key=None, - workdir=None, - anatomy=None, - project_entity=None, - project_settings=None, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + *, + template_key: Optional[str] = _PLACEHOLDER, + workdir: Optional[str] = _PLACEHOLDER, + reason: Optional[str] = None, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional[Anatomy] = None, ): """Update active Session to a new task work area. @@ -529,9 +534,10 @@ def change_current_context( Args: folder_entity (Dict[str, Any]): Folder entity to set. task_entity (Dict[str, Any]): Task entity to set. - template_key (Optional[str]): Prepared template key to be used for - workfile template in Anatomy. - workdir (Optional[str]): Workdir to set. + template_key (Optional[str]): DEPRECATED: Prepared template key to + be used for workfile template in Anatomy. + workdir (Optional[str]): DEPRECATED: Workdir to set. + reason (Optional[str]): Reason for changing context. anatomy (Optional[Anatomy]): Anatomy object used for workdir calculation. project_entity (Optional[dict[str, Any]]): Project entity used for @@ -540,58 +546,36 @@ def change_current_context( workdir calculation. Returns: - Dict[str, str]: The changed key, values in the current Session. + Dict[str, str]: New context data. """ - host = registered_host() - project_name = host.get_current_project_name() - folder_path = None - task_name = None - if folder_entity: - folder_path = folder_entity["path"] - if task_entity: - task_name = task_entity["name"] + depr_args = [] + if template_key is not _PLACEHOLDER: + depr_args.append("'template_key'") - if isinstance(host, IWorkfileHost) and workdir is None and folder_entity: - if project_entity is None: - project_entity = ayon_api.get_project(project_name) - workdir = get_workdir( - project_entity, - folder_entity, - task_entity, - host.name, - anatomy=anatomy, - template_key=template_key, - project_settings=project_settings, + if workdir is not _PLACEHOLDER: + depr_args.append("'workdir'") + + if depr_args: + ending = "s" if len(depr_args) > 1 else "" + depr_args = ", ".join(depr_args) + warnings.warn( + ( + f"Used deprecated argument{ending} {depr_args}." + " To change " + ), + DeprecationWarning, ) - envs = { - "AYON_PROJECT_NAME": project_name, - "AYON_FOLDER_PATH": folder_path, - "AYON_TASK_NAME": task_name, - "AYON_WORKDIR": workdir, - } - - # Update the Session and environments. Pop from environments all keys with - # value set to None. - for key, value in envs.items(): - if value is None: - os.environ.pop(key, None) - else: - os.environ[key] = value - - data = envs.copy() - - # Convert env keys to human readable keys - data["project_name"] = project_name - data["folder_path"] = folder_path - data["task_name"] = task_name - data["workdir_path"] = workdir - - # Emit session change - emit_event("taskChanged", data) - - return data + host = registered_host() + return host.set_current_context( + folder_entity, + task_entity, + reason=reason, + anatomy=anatomy, + project_entity=project_entity, + project_settings=project_settings, + ) def get_process_id(): From a879d11ac6c76199e3fbc76bf4aad017735c9971 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 12:03:34 +0200 Subject: [PATCH 056/170] get_ayon_username is using cached values --- client/ayon_core/lib/local_settings.py | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/lib/local_settings.py b/client/ayon_core/lib/local_settings.py index d994145d4b..91b881cf57 100644 --- a/client/ayon_core/lib/local_settings.py +++ b/client/ayon_core/lib/local_settings.py @@ -15,6 +15,10 @@ import ayon_api _PLACEHOLDER = object() +class _Cache: + username = None + + def _get_ayon_appdirs(*args): return os.path.join( platformdirs.user_data_dir("AYON", "Ynput"), @@ -591,10 +595,26 @@ def get_local_site_id(): def get_ayon_username(): """AYON username used for templates and publishing. - Uses curet ayon api username. + Uses current ayon api username. Returns: str: Username. """ - return ayon_api.get_user()["name"] + # Look for username in the connection stack + # - this is used when service is working as other user + # (e.g. in background sync) + # TODO @iLLiCiTiT - do not use private attribute of 'ServerAPI', rather + # use public method to get username from connection stack. + con = ayon_api.get_server_api_connection() + user_stack = getattr(con, "_as_user_stack", None) + if user_stack is not None: + username = user_stack.username + if username is not None: + return username + + # Cache the username to avoid multiple API calls + # - it is not expected that user would change + if _Cache.username is None: + _Cache.username = ayon_api.get_user()["name"] + return _Cache.username From 8bda7dd93b3a63eb02e3b3db9844533ae61ae04d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 12:05:15 +0200 Subject: [PATCH 057/170] move all the responsibility about workfiles to IWorkfileHost --- client/ayon_core/host/interfaces/workfiles.py | 499 +++++++++++++++++- 1 file changed, 482 insertions(+), 17 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 7d924dff3a..0c8ceb872b 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -10,10 +10,16 @@ from typing import Optional, Any import ayon_api import arrow +from ayon_core.lib import emit_event + if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy +WORKFILE_OPEN_REASON = "workfile.opened" +WORKFILE_SAVE_REASON = "workfile.saved" + + @dataclass class WorkfileInfo: """Information about workfile. @@ -256,8 +262,17 @@ class IWorkfileHost: def save_workfile_with_context( self, filepath: str, - folder_entity: dict[str, Any] = None, - task_entity: dict[str, Any] = None, + folder_entity: Optional[dict[str, Any]], + task_entity: Optional[dict[str, Any]], + *, + version: Optional[int], + comment: Optional[str] = None, + description: Optional[str] = None, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + project_settings: Optional[dict[str, Any]] = None, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, ): """Save current workfile with context. @@ -268,15 +283,72 @@ class IWorkfileHost: filepath (str): Where the current scene should be saved. folder_entity (dict[str, Any]): Folder entity. task_entity (dict[str, Any]): Task entity. + version (Optional[int]): Version of the workfile. + comment (Optional[str]): Comment for the workfile. + description (Optional[str]): Description for the workfile. + rootless_path (Optional[str]): Rootless path of the workfile. + workfile_entities (Optional[list[dict[str, Any]]]): Workfile + project_settings (Optional[dict[str, Any]]): Project settings. + project_entity (Optional[dict[str, Any]]): Project entity. + anatomy (Optional[Anatomy]): Project anatomy. """ + self._before_workfile_save( + filepath, + folder_entity, + task_entity, + ) + event_data = self._get_workfile_event_data( + self.get_current_project_name(), + folder_entity, + task_entity, + filepath, + ) + self._emit_workfile_save_event(event_data, after_open=False) + + workdir = os.path.dirname(filepath) + + self.set_current_context( + folder_entity, + task_entity, + reason=WORKFILE_SAVE_REASON, + workdir=workdir, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, + ) + self.save_workfile(filepath) + self._save_workfile_entity( + filepath, + folder_entity, + task_entity, + version, + comment, + description, + rootless_path, + workfile_entities, + project_settings, + project_entity, + anatomy, + ) + self._after_workfile_save( + filepath, + folder_entity, + task_entity, + ) + self._emit_workfile_save_event(event_data) + def open_workfile_with_context( self, filepath: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], + *, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, ): """Open passed filepath in the host with context. @@ -289,10 +361,42 @@ class IWorkfileHost: filepath (str): Path to workfile. folder_entity (dict[str, Any]): Folder id. task_entity (dict[str, Any]): Task id. + project_entity (Optional[dict[str, Any]]): Project entity. + project_settings (Optional[dict[str, Any]]): Project settings. + anatomy (Optional[Anatomy]): Project anatomy. """ + context = self.get_current_context() + project_name = context["project_name"] + current_folder_path = context["folder_path"] + current_task_name = context["task_name"] + + workdir = os.path.dirname(filepath) + # Set 'AYON_WORKDIR' environment variable + os.environ["AYON_WORKDIR"] = workdir + + event_data = self._get_workfile_event_data( + project_name, folder_entity, task_entity, filepath + ) + + self._before_workfile_open(folder_entity, task_entity, filepath) + self._emit_workfile_open_event(event_data, after_open=False) + + self.set_current_context( + folder_entity, + task_entity, + reason=WORKFILE_OPEN_REASON, + workdir=workdir, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, + ) + self.open_workfile(filepath) + self._after_workfile_open(folder_entity, task_entity, filepath) + self._emit_workfile_open_event(event_data) + def list_workfiles( self, project_name: str, @@ -414,6 +518,7 @@ class IWorkfileHost: self, project_name: str, folder_id: str, + *, anatomy: Optional["Anatomy"] = None, version_entities: Optional[list[dict[str, Any]]] = None, repre_entities: Optional[list[dict[str, Any]]] = None, @@ -524,7 +629,16 @@ class IWorkfileHost: dst_path: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], - open_workfile: bool = False, + *, + version: Optional[int], + comment: Optional[str] = None, + description: Optional[str] = None, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + project_settings: Optional[dict[str, Any]] = None, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + open_workfile: bool = True, ): """Save workfile path with target folder and task context. @@ -536,21 +650,68 @@ class IWorkfileHost: dst_path (str): Where the scene should be saved. folder_entity (dict[str, Any]): Folder entity. task_entity (dict[str, Any]): Task entity. + version (Optional[int]): Version of the workfile. + comment (Optional[str]): Comment for the workfile. + description (Optional[str]): Description for the workfile. + rootless_path (Optional[str]): Rootless path of the workfile. + workfile_entities (Optional[list[dict[str, Any]]]): Workfile + entities to be saved with the workfile. + project_settings (Optional[dict[str, Any]]): Project settings. + project_entity (Optional[dict[str, Any]]): Project entity. + anatomy (Optional[Anatomy]): Project anatomy. open_workfile (bool): Open workfile when copied. """ - # TODO We might need option to open file once copied as some DCC might - # actually need to open the workfile to copy it. + self._before_workfile_copy( + src_path, + dst_path, + folder_entity, + task_entity, + open_workfile, + ) + event_data = self._get_workfile_event_data( + self.get_current_project_name(), + folder_entity, + task_entity, + dst_path, + ) + self._emit_workfile_save_event(event_data, after_open=False) + dst_dir = os.path.dirname(dst_path) if not os.path.exists(dst_dir): os.makedirs(dst_dir, exist_ok=True) shutil.copy(src_path, dst_path) - if open_workfile: - self.open_workfile_with_context( - dst_path, - folder_entity, - task_entity, - ) + + self._save_workfile_entity( + dst_path, + folder_entity, + task_entity, + version, + comment, + description, + rootless_path, + workfile_entities, + project_settings, + project_entity, + anatomy, + ) + self._after_workfile_copy( + src_path, + dst_path, + folder_entity, + task_entity, + open_workfile, + ) + self._emit_workfile_save_event(event_data) + + if not open_workfile: + return + + self.open_workfile_with_context( + dst_path, + folder_entity, + task_entity, + ) def copy_workfile_representation( self, @@ -559,8 +720,17 @@ class IWorkfileHost: dst_path: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], - open_workfile: bool = False, - anatomy: Optional[Anatomy] = None, + *, + version: Optional[int], + comment: Optional[str] = None, + description: Optional[str] = None, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + project_settings: Optional[dict[str, Any]] = None, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + open_workfile: bool = True, + src_anatomy: Optional["Anatomy"] = None, src_representation_path: Optional[str] = None, ): """Copy workfile representation. @@ -574,8 +744,17 @@ class IWorkfileHost: dst_path (str): Where the scene should be saved. folder_entity (dict[str, Any): Folder entity. task_entity (dict[str, Any]): Task entity. - open_workfile (bool): Open workfile when copied. + version (Optional[int]): Version of the workfile. + comment (Optional[str]): Comment for the workfile. + description (Optional[str]): Description for the workfile. + rootless_path (Optional[str]): Rootless path of the workfile. + workfile_entities (Optional[list[dict[str, Any]]]): Workfile + entities to be saved with the workfile. + project_settings (Optional[dict[str, Any]]): Project settings. + project_entity (Optional[dict[str, Any]]): Project entity. anatomy (Optional[Anatomy]): Project anatomy. + open_workfile (bool): Open workfile when copied. + src_anatomy (Optional[Anatomy]): Anatomy of the source src_representation_path (Optional[str]): Representation path. """ @@ -586,12 +765,27 @@ class IWorkfileHost: get_representation_path_with_anatomy ) - if src_representation_path is None: + project_name = self.get_current_project_name() + # Re-use Anatomy or project entity if source context is same + if project_name == src_project_name: + if src_anatomy is None and anatomy is not None: + src_anatomy = anatomy + elif anatomy is None and src_anatomy is not None: + anatomy = src_anatomy + elif not project_entity: + project_entity = ayon_api.get_project(project_name) + if anatomy is None: - anatomy = Anatomy(src_project_name) + anatomy = src_anatomy = Anatomy( + project_name, project_entity=project_entity + ) + + if src_representation_path is None: + if src_anatomy is None: + src_anatomy = Anatomy(src_project_name) src_representation_path = get_representation_path_with_anatomy( src_representation_entity, - anatomy, + src_anatomy, ) self.copy_workfile( @@ -599,6 +793,14 @@ class IWorkfileHost: dst_path, folder_entity, task_entity, + version=version, + comment=comment, + description=description, + rootless_path=rootless_path, + workfile_entities=workfile_entities, + project_settings=project_settings, + project_entity=project_entity, + anatomy=anatomy, open_workfile=open_workfile, ) @@ -696,3 +898,266 @@ class IWorkfileHost: )) return version_entities, repre_entities + + def _save_workfile_entity( + self, + workfile_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + version: Optional[int], + comment: Optional[str], + description: Optional[str], + rootless_path: Optional[str], + workfile_entities: Optional[list[dict[str, Any]]] = None, + project_settings: Optional[dict[str, Any]] = None, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + ): + from ayon_core.pipeline.workfile.utils import ( + save_workfile_info, + find_workfile_rootless_path, + ) + + project_name = self.get_current_project_name() + if not description: + description = None + + if not comment: + comment = None + + if rootless_path is None: + rootless_path = find_workfile_rootless_path( + workfile_path, + project_name, + folder_entity, + task_entity, + self.name, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, + ) + + # It is not possible to create workfile infor without rootless path + workfile_info = None + if not rootless_path: + return workfile_info + + if platform.system().lower() == "windows": + rootless_path = rootless_path.replace("\\", "/") + + workfile_info = save_workfile_info( + project_name, + task_entity["id"], + rootless_path, + self.name, + version, + comment, + description, + workfile_entities=workfile_entities, + ) + return workfile_info + + def _create_extra_folders(self, folder_entity, task_entity, workdir): + from ayon_core.pipeline.workfile.path_resolving import ( + create_workdir_extra_folders + ) + + project_name = self.get_current_project_name() + + # Create extra folders + create_workdir_extra_folders( + workdir, + self.name, + task_entity["taskType"], + task_entity["name"], + project_name + ) + + def _get_workfile_event_data( + self, + project_name: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + filepath: str, + ): + workdir, filename = os.path.split(filepath) + return { + "project_name": project_name, + "folder_id": folder_entity["id"], + "folder_path": folder_entity["path"], + "task_id": task_entity["id"], + "task_name": task_entity["name"], + "host_name": self.name, + "filepath": filepath, + "filename": filename, + "workdir_path": workdir, + } + + def _before_workfile_open( + self, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + filepath: str, + ): + """Before workfile is opened. + + This method is called before the workfile is opened in the host. + + Can be overriden to implement host specific logic. + + Args: + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + filepath (str): Path to the workfile. + + """ + pass + + def _after_workfile_open( + self, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + filepath: str, + ): + """After workfile is opened. + + This method is called after the workfile is opened in the host. + + Can be overriden to implement host specific logic. + + Args: + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + filepath (str): Path to the workfile. + + """ + pass + + + def _before_workfile_save( + self, + filepath: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + ): + """Before workfile is saved. + + This method is called before the workfile is saved in the host. + + Can be overriden to implement host specific logic. + + Args: + filepath (str): Path to the workfile. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + + """ + pass + + def _after_workfile_save( + self, + filepath: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + ): + """After workfile is saved. + + This method is called after the workfile is saved in the host. + + Can be overriden to implement host specific logic. + + Args: + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + filepath (str): Path to the workfile. + + """ + workdir = os.path.dirname(filepath) + self._create_extra_folders(folder_entity, task_entity, workdir) + + def _before_workfile_copy( + self, + src_path: str, + dst_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + open_workfile: bool = True, + ): + """Before workfile is copied. + + This method is called before the workfile is copied by host + integration. + + Can be overriden to implement host specific logic. + + Args: + src_path (str): Path to the source workfile. + dst_path (str): Path to the destination workfile. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + open_workfile (bool): Should be the path opened once copy is + finished. + + """ + pass + + def _after_workfile_copy( + self, + src_path: str, + dst_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + open_workfile: bool = True, + ): + """After workfile is copied. + + This method is called after the workfile is copied by host + integration. + + Can be overriden to implement host specific logic. + + Args: + src_path (str): Path to the source workfile. + dst_path (str): Path to the destination workfile. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + open_workfile (bool): Should be the path opened once copy is + finished. + + """ + workdir = os.path.dirname(dst_path) + self._create_extra_folders(folder_entity, task_entity, workdir) + + def _emit_workfile_open_event( + self, + event_data: dict[str, Optional[str]], + after_open: bool = True, + ): + topics = [] + topic_end = "before" + if after_open: + topics.append("workfile.opened") + topic_end = "after" + + # Keep backwards compatible event topic + topics.append(f"workfile.open.{topic_end}") + + for topic in topics: + emit_event(topic, event_data) + + def _emit_workfile_save_event( + self, + event_data: dict[str, Optional[str]], + after_open: bool = True, + ): + topics = [] + topic_end = "before" + if after_open: + topics.append("workfile.saved") + topic_end = "after" + + # Keep backwards compatible event topic + topics.append(f"workfile.save.{topic_end}") + + for topic in topics: + emit_event(topic, event_data) From c52f300b878b8f23d418872b2ff02048ddba0960 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 12:05:39 +0200 Subject: [PATCH 058/170] use host methods to work with workfiles and add helper functions --- .../ayon_core/pipeline/workfile/__init__.py | 4 + client/ayon_core/pipeline/workfile/utils.py | 426 ++++++------------ 2 files changed, 131 insertions(+), 299 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/__init__.py b/client/ayon_core/pipeline/workfile/__init__.py index cc081d676b..52acb035b1 100644 --- a/client/ayon_core/pipeline/workfile/__init__.py +++ b/client/ayon_core/pipeline/workfile/__init__.py @@ -26,6 +26,8 @@ from .utils import ( save_current_workfile_to, copy_and_open_workfile, copy_and_open_workfile_representation, + save_workfile_info, + find_workfile_rootless_path, ) from .build_workfile import BuildWorkfile @@ -50,6 +52,7 @@ __all__ = ( "get_last_workfile_from_paths", "get_last_workfile_with_version", "get_last_workfile", + "find_workfile_rootless_path", "get_custom_workfile_template", "get_custom_workfile_template_by_string_context", @@ -66,6 +69,7 @@ __all__ = ( "save_current_workfile_to", "copy_and_open_workfile", "copy_and_open_workfile_representation", + "save_workfile_info", "BuildWorkfile", diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index d37287b330..7ed2ee4739 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -11,10 +11,7 @@ from ayon_api.operations import OperationsSession from ayon_core.lib import filter_profiles, emit_event, get_ayon_username from ayon_core.settings import get_project_settings -from .path_resolving import ( - create_workdir_extra_folders, - get_workfile_template_key, -) +from .path_resolving import get_workfile_template_key if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy @@ -25,13 +22,60 @@ class MissingWorkdirError(Exception): pass +def get_workfiles_info( + workfile_path: str, + project_name: str, + task_id: str, + *, + anatomy: Optional["Anatomy"] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, +) -> Optional[dict[str, Any]]: + """Find workfile info entity for a workfile path. + + Args: + workfile_path (str): Workfile path. + project_name (str): The name of the project. + task_id (str): Task id under which is workfile created. + anatomy (Optional[Anatomy]): Project anatomy used to get roots. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities related to task. + + Returns: + Optional[dict[str, Any]]: Workfile info entity if found, otherwise + `None`. + + """ + if anatomy is None: + anatomy = Anatomy(project_name) + + if workfile_entities is None: + workfile_entities = list(ayon_api.get_workfiles_info( + project_name, + task_ids=[task_id], + )) + + if platform.system().lower() == "windows": + workfile_path = workfile_path.replace("\\", "/") + workfile_path = workfile_path.lower() + + for workfile_entity in workfile_entities: + path = workfile_entity["path"] + filled_path = anatomy.fill_root(path) + if platform.system().lower() == "windows": + filled_path = filled_path.replace("\\", "/") + filled_path = filled_path.lower() + if filled_path == workfile_path: + return workfile_entity + return None + + def should_use_last_workfile_on_launch( - project_name, - host_name, - task_name, - task_type, - default_output=False, - project_settings=None, + project_name: str, + host_name: str, + task_name: str, + task_type: str, + default_output: bool = False, + project_settings: Optional[dict[str, Any]] = None, ): """Define if host should start last version workfile if possible. @@ -144,30 +188,14 @@ def should_open_workfiles_tool_on_launch( return output -def _get_event_context_data( - project_name: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - host_name: str, -): - return { - "project_name": project_name, - "folder_id": folder_entity["id"], - "folder_path": folder_entity["path"], - "task_id": task_entity["id"], - "task_name": task_entity["name"], - "host_name": host_name, - } - - def save_workfile_info( project_name: str, task_id: str, rootless_path: str, host_name: str, - version: Optional[int], - comment: Optional[str], - description: Optional[str], + version: Optional[int] = None, + comment: Optional[str] = None, + description: Optional[str] = None, username: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, ): @@ -255,63 +283,38 @@ def open_workfile( filepath: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, ): - from ayon_core.pipeline.context_tools import ( - registered_host, change_current_context - ) + from ayon_core.pipeline.context_tools import registered_host # Trigger before save event host = registered_host() - context = host.get_current_context() - project_name = context["project_name"] - current_folder_path = context["folder_path"] - current_task_name = context["task_name"] - host_name = host.name - - # TODO move to workfiles pipeline - event_data = _get_event_context_data( - project_name, folder_entity, task_entity, host_name - ) - event_data["filepath"] = filepath - - emit_event("workfile.open.before", event_data, source="workfiles.tool") - - # Change context - if ( - folder_entity["path"] != current_folder_path - or task_entity["name"] != current_task_name - ): - change_current_context( - project_name, - folder_entity, - task_entity, - workdir=os.path.dirname(filepath) - ) - host.open_workfile_with_context( filepath, folder_entity, task_entity, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, ) - emit_event("workfile.open.after", event_data, source="workfiles.tool") - def save_current_workfile_to( workfile_path: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], - version: Optional[int], + *, + version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - source: Optional[str] = None, rootless_path: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, - username: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, -) -> dict[str, Any]: +): """Save current workfile to new location or context. Args: @@ -321,12 +324,10 @@ def save_current_workfile_to( version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - source (Optional[str]): Source of the save action. rootless_path (Optional[str]): Rootless path of the workfile. Is calculated if not passed in. workfile_entities (Optional[list[dict[str, Any]]]): List of workfile - username (Optional[str]): Username of the user saving the workfile. - Current user is used if not passed. + entities related to task. project_entity (Optional[dict[str, Any]]): Project entity used for rootless path calculation. project_settings (Optional[dict[str, Any]]): Project settings used for @@ -338,25 +339,22 @@ def save_current_workfile_to( dict[str, Any]: Workfile info entity. """ - print("save_current_workfile_to") - return _save_workfile( - None, - None, - None, - None, + from ayon_core.pipeline.context_tools import registered_host + + # Trigger before save event + host = registered_host() + host.save_workfile_with_context( workfile_path, folder_entity, task_entity, version, comment, description, - source, - rootless_path, - workfile_entities, - username, - project_entity, - project_settings, - anatomy, + rootless_path=rootless_path, + workfile_entities=workfile_entities, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, ) @@ -365,17 +363,16 @@ def copy_and_open_workfile( workfile_path: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], - version: Optional[int], + *, + version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - source: Optional[str] = None, rootless_path: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, - username: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, -) -> dict[str, Any]: +): """Copy workfile to new location and open it. Args: @@ -386,12 +383,9 @@ def copy_and_open_workfile( version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - source (Optional[str]): Source of the save action. rootless_path (Optional[str]): Rootless path of the workfile. Is calculated if not passed in. workfile_entities (Optional[list[dict[str, Any]]]): List of workfile - username (Optional[str]): Username of the user saving the workfile. - Current user is used if not passed. project_entity (Optional[dict[str, Any]]): Project entity used for rootless path calculation. project_settings (Optional[dict[str, Any]]): Project settings used for @@ -403,51 +397,49 @@ def copy_and_open_workfile( dict[str, Any]: Workfile info entity. """ - print("copy_and_open_workfile") - return _save_workfile( + from ayon_core.pipeline.context_tools import registered_host + + host = registered_host() + host.copy_workfile( src_workfile_path, - None, - None, - None, workfile_path, folder_entity, task_entity, - version, - comment, - description, - source, - rootless_path, - workfile_entities, - username, - project_entity, - project_settings, - anatomy, + version=version, + comment=comment, + description=description, + rootless_path=rootless_path, + workfile_entities=workfile_entities, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, + open_workfile=True, ) def copy_and_open_workfile_representation( - project_name: str, + src_project_name: str, representation_id: str, workfile_path: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], - version: Optional[int], + *, + version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - source: Optional[str] = None, rootless_path: Optional[str] = None, representation_entity: Optional[dict[str, Any]] = None, representation_path: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, - username: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, -) -> dict[str, Any]: + src_anatomy: Optional["Anatomy"] = None, +): """Copy workfile to new location and open it. Args: - project_name (str): Project name where representation is stored. + src_project_name (str): Project name where representation is stored. representation_id (str): Source representation id. workfile_path (str): Destination workfile path. folder_entity (dict[str, Any]): Target folder entity. @@ -455,12 +447,13 @@ def copy_and_open_workfile_representation( version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - source (Optional[str]): Source of the save action. rootless_path (Optional[str]): Rootless path of the workfile. Is calculated if not passed in. + representation_entity (Optional[dict[str, Any]]): Representation + entity. If not provided, it will be fetched from the server. + representation_path (Optional[str]): Path to the representation. + Calculated if not provided. workfile_entities (Optional[list[dict[str, Any]]]): List of workfile - username (Optional[str]): Username of the user saving the workfile. - Current user is used if not passed. project_entity (Optional[dict[str, Any]]): Project entity used for rootless path calculation. project_settings (Optional[dict[str, Any]]): Project settings used for @@ -472,209 +465,42 @@ def copy_and_open_workfile_representation( dict[str, Any]: Workfile info entity. """ - print("copy_and_open_workfile_representation") + from ayon_core.pipeline.context_tools import registered_host + if representation_entity is None: representation_entity = ayon_api.get_representation_by_id( - project_name, + src_project_name, representation_id, ) - return _save_workfile( - None, - project_name, + host = registered_host() + host.copy_workfile_representation( + src_project_name, representation_entity, - representation_path, workfile_path, folder_entity, task_entity, - version, - comment, - description, - source, - rootless_path, - workfile_entities, - username, - project_entity, - project_settings, - anatomy, + version=version, + comment=comment, + description=description, + rootless_path=rootless_path, + workfile_entities=workfile_entities, + project_settings=project_settings, + project_entity=project_entity, + anatomy=anatomy, + src_anatomy=src_anatomy, + src_representation_path=representation_path, + open_workfile=open_workfile, ) -def _save_workfile( - src_workfile_path: Optional[str], - representation_project_name: Optional[str], - representation_entity: Optional[dict[str, Any]], - representation_path: Optional[str], - workfile_path: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - version: Optional[int], - comment: Optional[str], - description: Optional[str], - source: Optional[str], - rootless_path: Optional[str], - workfile_entities: Optional[list[dict[str, Any]]], - username: Optional[str], - project_entity: Optional[dict[str, Any]], - project_settings: Optional[dict[str, Any]], - anatomy: Optional["Anatomy"], -) -> dict[str, Any]: - """Function used to save workfile to new location and context. - - Because the functionality for 'save_current_workfile_to' and - 'copy_and_open_workfile' is currently the same, except for used - function on host it is easier to create this wrapper function. - - Args: - src_workfile_path (Optional[str]): Source workfile path. - representation_entity (Optional[dict[str, Any]]): Representation used - as source for workfile. - workfile_path (str): Destination workfile path. - folder_entity (dict[str, Any]): Target folder entity. - task_entity (dict[str, Any]): Target task entity. - version (Optional[int]): Workfile version. - comment (optional[str]): Workfile comment. - description (Optional[str]): Workfile description. - source (Optional[str]): Source of the save action. - rootless_path (Optional[str]): Rootless path of the workfile. Is - calculated if not passed in. - workfile_entities (Optional[list[dict[str, Any]]]): List of workfile - username (Optional[str]): Username of the user saving the workfile. - Current user is used if not passed. - project_entity (Optional[dict[str, Any]]): Project entity used for - rootless path calculation. - project_settings (Optional[dict[str, Any]]): Project settings used for - rootless path calculation. - anatomy (Optional[Anatomy]): Project anatomy used for rootless - path calculation. - - Returns: - dict[str, Any]: Workfile info entity. - - """ - from ayon_core.pipeline.context_tools import ( - registered_host, change_current_context - ) - - # Trigger before save event - host = registered_host() - context = host.get_current_context() - project_name = context["project_name"] - current_folder_path = context["folder_path"] - current_task_name = context["task_name"] - - task_name = task_entity["name"] - task_type = task_entity["taskType"] - task_id = task_entity["id"] - host_name = host.name - - workdir, filename = os.path.split(workfile_path) - - # QUESTION should the data be different for 'before' and 'after'? - event_data = _get_event_context_data( - project_name, folder_entity, task_entity, host_name - ) - event_data.update({ - "filename": filename, - "workdir_path": workdir, - }) - - emit_event("workfile.save.before", event_data, source=source) - - # Change context - if ( - folder_entity["path"] != current_folder_path - or task_entity["name"] != current_task_name - ): - change_current_context( - folder_entity, - task_entity, - workdir=workdir, - anatomy=anatomy, - project_entity=project_entity, - project_settings=project_settings, - ) - - if src_workfile_path: - host.copy_workfile( - src_workfile_path, - workfile_path, - folder_entity, - task_entity, - open_workfile=True, - ) - elif representation_entity: - host.copy_workfile_representation( - representation_project_name, - representation_entity, - workfile_path, - folder_entity, - task_entity, - open_workfile=True, - src_representation_path=representation_path, - anatomy=anatomy, - ) - else: - host.save_workfile_with_context( - workfile_path, - folder_entity, - task_entity, - ) - - if not description: - description = None - - if not comment: - comment = None - - if rootless_path is None: - rootless_path = _find_rootless_path( - workfile_path, - project_name, - task_type, - host_name, - project_entity, - project_settings, - anatomy, - ) - - # It is not possible to create workfile infor without rootless path - workfile_info = None - if rootless_path: - if platform.system().lower() == "windows": - rootless_path = rootless_path.replace("\\", "/") - - workfile_info = save_workfile_info( - project_name, - task_id, - rootless_path, - host_name, - version, - comment, - description, - username=username, - workfile_entities=workfile_entities, - ) - - # Create extra folders - create_workdir_extra_folders( - workdir, - host.name, - task_entity["taskType"], - task_name, - project_name - ) - - # Trigger after save events - emit_event("workfile.save.after", event_data, source=source) - return workfile_info - - -def _find_rootless_path( +def find_workfile_rootless_path( workfile_path: str, project_name: str, - task_type: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], host_name: str, + *, project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, @@ -684,6 +510,8 @@ def _find_rootless_path( from ayon_core.pipeline import Anatomy anatomy = Anatomy(project_name, project_entity=project_entity) + + task_type = task_entity["taskType"] template_key = get_workfile_template_key( project_name, task_type, From e08c5f243b7b1e171ff66b717639c5a1d07f6480 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 12:06:04 +0200 Subject: [PATCH 059/170] modified workfiles model to use api functions --- .../tools/workfiles/models/workfiles.py | 226 +++++------------- 1 file changed, 55 insertions(+), 171 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 4f5fb9890d..f2977be973 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -35,6 +35,7 @@ from ayon_core.pipeline.workfile import ( save_current_workfile_to, copy_and_open_workfile, copy_and_open_workfile_representation, + save_workfile_info, ) from ayon_core.pipeline.version_start import get_versioning_start from ayon_core.tools.workfiles.abstract import ( @@ -149,20 +150,18 @@ class WorkfilesModel: task_entity = self._controller.get_task_entity( project_name, task_id ) - workfile_entities = self.get_workfile_entities(task_id) + failed = False try: - workfile_info = save_current_workfile_to( + save_current_workfile_to( filepath, folder_entity, task_entity, - version, - comment, - description, - source="workfiles.tool", + version=version, + comment=comment, + description=description, rootless_path=rootless_path, - workfile_entities=workfile_entities, - username=self._get_current_username(), + workfile_entities=self.get_workfile_entities(task_id), project_entity=self._controller.get_project_entity( project_name ), @@ -170,7 +169,7 @@ class WorkfilesModel: anatomy=self._controller.project_anatomy, ) self._update_workfile_info( - task_id, rootless_path, description, workfile_info + task_id, rootless_path, description ) self._update_current_context( folder_id, folder_entity["path"], task_entity["name"] @@ -212,8 +211,9 @@ class WorkfilesModel: rootless_path = f"{rootless_workdir}/{filename}" failed = False + workfile_entities = self.get_workfile_entities(task_id) try: - workfile_info = copy_and_open_workfile_representation( + copy_and_open_workfile_representation( project_name, representation_id, dst_filepath, @@ -225,8 +225,7 @@ class WorkfilesModel: rootless_path=rootless_path, representation_entity=repre_entity, representation_path=representation_filepath, - workfile_entities=self.get_workfile_entities(task_id), - username=self._get_current_username(), + workfile_entities=workfile_entities, project_entity=self._controller.get_project_entity( project_name ), @@ -234,7 +233,7 @@ class WorkfilesModel: anatomy=self._controller.project_anatomy, ) self._update_workfile_info( - task_id, rootless_path, description, workfile_info + task_id, rootless_path, description ) self._update_current_context( folder_id, folder_entity["path"], task_entity["name"] @@ -281,13 +280,11 @@ class WorkfilesModel: workfile_path, folder_entity, task_entity, - version, - comment, - description, - source="workfiles.tool", + version=version, + comment=comment, + description=description, rootless_path=rootless_path, workfile_entities=workfile_entities, - username=self._get_current_username(), project_entity=project_entity, project_settings=self._controller.project_settings, anatomy=self._controller.project_anatomy, @@ -608,7 +605,9 @@ class WorkfilesModel: cache.update_data(self._host.list_published_workfiles( project_name, folder_id, - anatomy, + anatomy=anatomy, + version_entities=version_entities, + repre_entities=repre_entities, )) items = cache.get_data() @@ -638,31 +637,6 @@ class WorkfilesModel: return self._current_username # --- Host --- - def _get_event_context_data( - self, - project_name: str, - folder_id: str, - task_id: str, - folder_entity: Optional[dict[str, Any]] = None, - task_entity: Optional[dict[str, Any]] = None, - ): - if folder_entity is None: - folder_entity = self._controller.get_folder_entity( - project_name, folder_id - ) - if task_entity is None: - task_entity = self._controller.get_task_entity( - project_name, task_id - ) - return { - "project_name": project_name, - "folder_id": folder_id, - "folder_path": folder_entity["path"], - "task_id": task_id, - "task_name": task_entity["name"], - "host_name": self._host_name, - } - def _open_workfile(self, folder_id: str, task_id: str, filepath: str): # TODO move to workfiles pipeline project_name = self._project_name @@ -849,23 +823,26 @@ class WorkfilesModel: task_id: str, rootless_path: str, description: str, - workfile_entity: dict[str, Any], ): self._update_file_description(task_id, rootless_path, description) - workfile_entities = self.get_workfile_entities(task_id) - target_idx = None - for idx, workfile_entity in enumerate(workfile_entities): - if workfile_entity["path"] == rootless_path: - target_idx = idx - break - - if target_idx is None: - workfile_entities.append(workfile_entity) - else: - workfile_entities[target_idx] = workfile_entity - self._reset_workarea_file_items(task_id) + # Update workfile entity cache if are cached + if task_id in self._workfile_entities_by_task_id: + workfile_entities = self.get_workfile_entities(task_id) + + target_workfile_entity = None + for workfile_entity in workfile_entities: + if rootless_path == workfile_entity["path"]: + target_workfile_entity = workfile_entity + break + + if target_workfile_entity is None: + self._workfile_entities_by_task_id.pop(task_id, None) + self.get_workfile_entities(task_id) + else: + target_workfile_entity["attrib"]["description"] = description + def _update_file_description( self, task_id: str, rootless_path: str, description: str ): @@ -885,119 +862,26 @@ class WorkfilesModel: comment: Optional[str], description: Optional[str], ): - # TODO create pipeline function for this + workfile_entity = save_workfile_info( + self._controller.get_current_project_name(), + task_id, + rootless_path, + self._controller.get_host_name(), + version=version, + comment=comment, + description=description, + workfile_entities=self.get_workfile_entities(task_id), + ) + # Update cache workfile_entities = self.get_workfile_entities(task_id) - workfile_entity = next( - ( - _ent - for _ent in workfile_entities - if _ent["path"] == rootless_path - ), - None - ) - if not workfile_entity: - workfile_entity = self._create_workfile_info_entity( - task_id, - rootless_path, - version, - comment, - description, - ) + match_idx = None + for idx, entity in enumerate(workfile_entities): + if entity["id"] == workfile_entity["id"]: + # Update existing entity + match_idx = idx + break + + if match_idx is None: workfile_entities.append(workfile_entity) - return - - data = {} - for key, value in ( - ("host_name", self._host_name), - ("version", version), - ("comment", comment), - ): - if value is not None: - data[key] = value - - old_data = workfile_entity["data"] - - changed_data = {} - for key, value in data.items(): - if key not in old_data or old_data[key] != value: - changed_data[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 - - username = self._get_current_username() - # Automatically fix 'createdBy' and 'updatedBy' fields - # NOTE both fields were not automatically filled by server - # until 1.1.3 release. - if workfile_entity.get("createdBy") is None: - update_data["createdBy"] = username - workfile_entity["createdBy"] = username - - if workfile_entity.get("updatedBy") != username: - update_data["updatedBy"] = username - workfile_entity["updatedBy"] = username - - if not update_data: - return - - session = OperationsSession() - session.update_entity( - self._project_name, - "workfile", - workfile_entity["id"], - update_data, - ) - session.commit() - - def _create_workfile_info_entity( - self, - task_id: str, - rootless_path: str, - version: Optional[int], - comment: Optional[str], - description: str, - ) -> dict[str, Any]: - 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 = {} - for key, value in ( - ("host_name", self._host_name), - ("version", version), - ("comment", comment), - ): - if value is not None: - data[key] = value - - username = self._get_current_username() - workfile_info = { - "id": uuid.uuid4().hex, - "path": rootless_path, - "taskId": task_id, - "attrib": attrib, - "data": data, - # TODO remove 'createdBy' and 'updatedBy' fields when server is - # or above 1.1.3 . - "createdBy": username, - "updatedBy": username, - } - - session = OperationsSession() - session.create_entity( - self._project_name, "workfile", workfile_info - ) - session.commit() - return workfile_info + else: + workfile_entities[match_idx] = workfile_entity From 406f43a13f2ac075c45605beebb4c1f3708fd335 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 12:10:26 +0200 Subject: [PATCH 060/170] formatting cleanup --- client/ayon_core/host/host.py | 4 ++-- client/ayon_core/host/interfaces/workfiles.py | 3 --- client/ayon_core/pipeline/workfile/utils.py | 6 +++--- client/ayon_core/tools/workfiles/models/workfiles.py | 2 -- 4 files changed, 5 insertions(+), 10 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index d451b768c1..5e5e8ac79f 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -347,8 +347,8 @@ class HostBase(ABC): "AYON_WORKDIR": workdir, } - # Update the Session and environments. Pop from environments all keys with - # value set to None. + # Update the Session and environments. Pop from environments all + # keys with value set to None. for key, value in envs.items(): if value is None: os.environ.pop(key, None) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 0c8ceb872b..47a0cb0277 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -368,8 +368,6 @@ class IWorkfileHost: """ context = self.get_current_context() project_name = context["project_name"] - current_folder_path = context["folder_path"] - current_task_name = context["task_name"] workdir = os.path.dirname(filepath) # Set 'AYON_WORKDIR' environment variable @@ -1033,7 +1031,6 @@ class IWorkfileHost: """ pass - def _before_workfile_save( self, filepath: str, diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 7ed2ee4739..c45163e7a1 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -8,7 +8,7 @@ from typing import Optional, Any import ayon_api from ayon_api.operations import OperationsSession -from ayon_core.lib import filter_profiles, emit_event, get_ayon_username +from ayon_core.lib import filter_profiles, get_ayon_username from ayon_core.settings import get_project_settings from .path_resolving import get_workfile_template_key @@ -54,7 +54,7 @@ def get_workfiles_info( task_ids=[task_id], )) - if platform.system().lower() == "windows": + if platform.system().lower() == "windows": workfile_path = workfile_path.replace("\\", "/") workfile_path = workfile_path.lower() @@ -398,7 +398,7 @@ def copy_and_open_workfile( """ from ayon_core.pipeline.context_tools import registered_host - + host = registered_host() host.copy_workfile( src_workfile_path, diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index f2977be973..23521dc3f6 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -1,13 +1,11 @@ from __future__ import annotations import os import copy -import uuid import platform import typing from typing import Optional, Any import ayon_api -from ayon_api.operations import OperationsSession from ayon_core.lib import ( get_ayon_username, From 7cb22fbe1fed55b3f2edb178ba0fbd1ab1b54265 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 13:27:35 +0200 Subject: [PATCH 061/170] add arrow to dependencies --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index f919a9589b..1ca75cd6b0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,6 +19,7 @@ python = ">=3.9.1,<3.10" pytest = "^8.0" pytest-print = "^1.0" ayon-python-api = "^1.0" +arrow = "0.17.0" # linting dependencies ruff = "0.11.7" pre-commit = "^3.6.2" From df55a32b95995ccbf9c5292b4a4991f1939d010f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 13:32:26 +0200 Subject: [PATCH 062/170] fix 'PublishedWorkfileInfo' --- client/ayon_core/host/interfaces/workfiles.py | 21 ++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 47a0cb0277..8cf904e5d3 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1,10 +1,11 @@ from __future__ import annotations + import os import platform import shutil +import typing from abc import abstractmethod from dataclasses import dataclass, asdict -import typing from typing import Optional, Any import ayon_api @@ -57,7 +58,13 @@ class WorkfileInfo: available: bool @classmethod - def new(cls, filepath, rootless_path, available, workfile_entity): + def new( + cls, + filepath: str, + rootless_path: str, + available: bool, + workfile_entity: dict[str, Any], + ): file_size = file_modified = file_created = None if filepath and os.path.exists(filepath): filestat = os.stat(filepath) @@ -85,7 +92,7 @@ class WorkfileInfo: available=available, ) - def to_data(self): + def to_data(self) -> dict[str, Any]: """Converts file item to data. Returns: @@ -95,7 +102,7 @@ class WorkfileInfo: return asdict(self) @classmethod - def from_data(cls, data): + def from_data(cls, data: dict[str, Any]) -> "WorkfileInfo": """Converts data to workfile item. Args: @@ -173,7 +180,7 @@ class PublishedWorkfileInfo: file_modified=file_modified, ) - def to_data(self): + def to_data(self) -> dict[str, Any]: """Converts file item to data. Returns: @@ -183,7 +190,7 @@ class PublishedWorkfileInfo: return asdict(self) @classmethod - def from_data(cls, data): + def from_data(cls, data: dict[str, Any]) -> "PublishedWorkfileInfo": """Converts data to workfile item. Args: @@ -193,7 +200,7 @@ class PublishedWorkfileInfo: WorkfileInfo: File item. """ - return WorkfileInfo(**data) + return PublishedWorkfileInfo(**data) class IWorkfileHost: From f4545a6f9798651e6a6fafe6d65d9cd7e5556797 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 13:48:51 +0200 Subject: [PATCH 063/170] some formatting changes --- .../ayon_core/host/interfaces/exceptions.py | 2 +- client/ayon_core/host/interfaces/workfiles.py | 61 +++++++++++-------- .../pipeline/workfile/path_resolving.py | 2 +- 3 files changed, 38 insertions(+), 27 deletions(-) diff --git a/client/ayon_core/host/interfaces/exceptions.py b/client/ayon_core/host/interfaces/exceptions.py index c6b4cef4b4..eec4564142 100644 --- a/client/ayon_core/host/interfaces/exceptions.py +++ b/client/ayon_core/host/interfaces/exceptions.py @@ -1,5 +1,5 @@ class MissingMethodsError(ValueError): - """Exception when host miss some required methods for specific workflow. + """Exception when host miss some required methods for a specific workflow. Args: host (HostBase): Host implementation where are missing methods. diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 8cf904e5d3..a081999823 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -197,22 +197,26 @@ class PublishedWorkfileInfo: data (dict[str, Any]): Workfile item data. Returns: - WorkfileInfo: File item. + PublishedWorkfileInfo: File item. """ return PublishedWorkfileInfo(**data) class IWorkfileHost: - """Implementation requirements to be able use workfile utils and tool.""" + """Implementation requirements to be able to use workfiles utils and tool. + Some of the methods are pre-implemented as they generally do the same in + all host integrations. + + """ @abstractmethod def save_workfile(self, dst_path: Optional[str] = None): - """Save currently opened scene. + """Save the currently opened scene. Args: dst_path (str): Where the current scene should be saved. Or use - current path if 'None' is passed. + the current path if 'None' is passed. """ pass @@ -229,10 +233,10 @@ class IWorkfileHost: @abstractmethod def get_current_workfile(self) -> Optional[str]: - """Retrieve path to current opened file. + """Retrieve a path to current opened file. Returns: - Optional[str]: Path to file which is currently opened. None if + Optional[str]: Path to the file which is currently opened. None if nothing is opened. """ @@ -241,8 +245,8 @@ class IWorkfileHost: def workfile_has_unsaved_changes(self) -> Optional[bool]: """Currently opened scene is saved. - Not all hosts can know if current scene is saved because the API of - DCC does not support it. + Not all hosts can know if the current scene is saved because the API + of DCC does not support it. Returns: Optional[bool]: True if scene is saved and False if has unsaved @@ -253,7 +257,7 @@ class IWorkfileHost: return None def get_workfile_extensions(self) -> list[str]: - """Extensions that can be used as save workfile. + """Extensions that can be used to save the workfile to. Notes: Method may not be used if 'list_workfiles' and @@ -269,8 +273,8 @@ class IWorkfileHost: def save_workfile_with_context( self, filepath: str, - folder_entity: Optional[dict[str, Any]], - task_entity: Optional[dict[str, Any]], + folder_entity: dict[str, Any], + task_entity: dict[str, Any], *, version: Optional[int], comment: Optional[str] = None, @@ -281,7 +285,7 @@ class IWorkfileHost: project_entity: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, ): - """Save current workfile with context. + """Save the current workfile with context. Notes: Should this method care about context change? @@ -415,7 +419,7 @@ class IWorkfileHost: ) -> list[WorkfileInfo]: """List workfiles in the given folder. - NOTES: + Notes: - Better method name? - This method is pre-implemented as the logic can be shared across 95% of host integrations. Ad-hoc implementation to give host @@ -423,7 +427,7 @@ class IWorkfileHost: - Should this method also handle workfiles based on workfile entities? Args: - project_name (str): Name of project. + project_name (str): Project name. folder_entity (dict[str, Any]): Folder entity. task_entity (dict[str, Any]): Task entity. project_entity (Optional[dict[str, Any]]): Project entity. @@ -505,7 +509,10 @@ class IWorkfileHost: rootless_path, None ) items.append(WorkfileInfo.new( - filepath, rootless_path, True, workfile_entity + filepath, + rootless_path, + available=True, + workfile_entity=workfile_entity, )) for workfile_entity in workfile_entities_by_path.values(): @@ -514,7 +521,10 @@ class IWorkfileHost: rootless_path = workfile_entity["path"] filepath = anatomy.fill_root(rootless_path) items.append(WorkfileInfo.new( - filepath, rootless_path, False, workfile_entity + filepath, + rootless_path, + available=False, + workfile_entity=workfile_entity, )) return items @@ -528,9 +538,9 @@ class IWorkfileHost: version_entities: Optional[list[dict[str, Any]]] = None, repre_entities: Optional[list[dict[str, Any]]] = None, ) -> list[PublishedWorkfileInfo]: - """List published workfiles for given folder. + """List published workfiles for the given folder. - Default implementation looks for products with 'workfile' + The default implementation looks for products with the 'workfile' product type. Pre-fetched entities have mandatory fields to be fetched. @@ -548,7 +558,7 @@ class IWorkfileHost: Returns: list[PublishedWorkfileInfo]: Published workfile information for - given context. + the given context. """ from ayon_core.pipeline import Anatomy @@ -601,7 +611,9 @@ class IWorkfileHost: try: workfile_path = workfile_path.format(root=anatomy.roots) except Exception as exc: - print(f"Failed to format workfile path: {exc}") + self.log.warning( + f"Failed to format workfile path.", exc_info=True + ) is_available = False file_size = file_modified = file_created = None @@ -647,8 +659,8 @@ class IWorkfileHost: ): """Save workfile path with target folder and task context. - It is expected that workfile is saved to current project, but can be - copied from other project. + It is expected that workfile is saved to the current project, but + can be copied from the other project. Args: src_path (str): Path to the source scene. @@ -763,8 +775,6 @@ class IWorkfileHost: src_representation_path (Optional[str]): Representation path. """ - # TODO We might need option to open file once copied as some DCC might - # actually need to open the workfile to copy it. from ayon_core.pipeline import Anatomy from ayon_core.pipeline.load import ( get_representation_path_with_anatomy @@ -815,6 +825,7 @@ class IWorkfileHost: Todo: Remove when all usages are replaced. + """ return self.get_workfile_extensions() @@ -823,8 +834,8 @@ class IWorkfileHost: Todo: Remove when all usages are replaced. - """ + """ self.save_workfile(dst_path) def open_file(self, filepath): diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index ac915060eb..2bb94d5c06 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -737,7 +737,7 @@ def get_comments_from_workfile_paths( extensions (set[str]): Set of file extensions. file_template (StringTemplate): Workfile file template. template_data (dict[str, Any]): Data to fill the template with. - current_filename (str): Filename to check for current comment. + current_filename (str): Filename to check for the current comment. Returns: tuple[list[str], str]: List of comments and the current comment. From e6bb395d67e6bff6f2e912d893a5d630791a25b5 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 13:56:37 +0200 Subject: [PATCH 064/170] set AYON_WORKDIR when workfile is opened --- client/ayon_core/host/interfaces/workfiles.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index a081999823..ab61e608f8 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -319,6 +319,9 @@ class IWorkfileHost: workdir = os.path.dirname(filepath) + # Set 'AYON_WORKDIR' environment variable + os.environ["AYON_WORKDIR"] = workdir + self.set_current_context( folder_entity, task_entity, From 524ed034238f86e3625ea7047a8af78db5c297ba Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 13:58:22 +0200 Subject: [PATCH 065/170] removed unnecessary workdir handling from set current context --- client/ayon_core/host/host.py | 50 +++++++------------ client/ayon_core/host/interfaces/workfiles.py | 4 -- client/ayon_core/pipeline/context_tools.py | 9 ++-- 3 files changed, 23 insertions(+), 40 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index 5e5e8ac79f..45123d74a8 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -158,9 +158,7 @@ class HostBase(ABC): task_entity: dict[str, Any], *, reason: Optional[str] = None, - workdir: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, ): """Set current context information. @@ -178,9 +176,7 @@ class HostBase(ABC): folder_entity (Optional[dict[str, Any]]): Folder entity. task_entity (Optional[dict[str, Any]]): Task entity. reason (Optional[str]): Reason for context change. - workdir (Optional[str]): Work directory path. project_entity (Optional[dict[str, Any]]): Project entity data. - project_settings (Optional[dict[str, Any]]): Project settings data. anatomy (Optional[Anatomy]): Anatomy instance for the project. """ @@ -208,24 +204,22 @@ class HostBase(ABC): project_entity, folder_entity, task_entity, - anatomy, reason, + anatomy, ) self._set_current_context( project_entity, folder_entity, task_entity, reason, - workdir, anatomy, - project_settings, ) self._after_context_change( project_entity, folder_entity, task_entity, - anatomy, reason, + anatomy, ) return self._emit_context_change_event( @@ -309,10 +303,22 @@ class HostBase(ABC): folder_entity: Optional[dict[str, Any]], task_entity: Optional[dict[str, Any]], reason: Optional[str], - workdir: Optional[str], - anatomy: Optional["Anatomy"], - project_settings: Optional[dict[str, Any]], + anatomy: "Anatomy", ): + """Method that changes the context in host. + + Can be overriden for hosts that do need different handling of context + than using environment variables. + + Args: + project_entity (dict[str, Any]): Project entity. + folder_entity (dict[str, Any]): Folder entity of new context. + task_entity (dict[str, Any]): Task entity of new context. + reason (Optional[str]): Reason why change happened. Currently + known reasons are that workfile is being opened or saved. + anatomy (Anatomy): Project anatomy. + + """ from ayon_core.pipeline.workfile import get_workdir project_name = self.get_current_project_name() @@ -323,28 +329,10 @@ class HostBase(ABC): if task_entity: task_name = task_entity["name"] - if ( - workdir is None - and isinstance(self, IWorkfileHost) - and folder_entity - ): - if project_entity is None: - project_entity = ayon_api.get_project(project_name) - - workdir = get_workdir( - project_entity, - folder_entity, - task_entity, - self.name, - anatomy=anatomy, - project_settings=project_settings, - ) - envs = { "AYON_PROJECT_NAME": project_name, "AYON_FOLDER_PATH": folder_path, "AYON_TASK_NAME": task_name, - "AYON_WORKDIR": workdir, } # Update the Session and environments. Pop from environments all @@ -360,8 +348,8 @@ class HostBase(ABC): project_entity: dict[str, Any], folder_entity: Optional[dict[str, Any]], task_entity: Optional[dict[str, Any]], - anatomy: "Anatomy", reason: Optional[str], + anatomy: "Anatomy", ): """Before context is changed. @@ -382,8 +370,8 @@ class HostBase(ABC): project_entity: dict[str, Any], folder_entity: dict[str, Any], task_entity: dict[str, Any], - anatomy: "Anatomy", reason: Optional[str], + anatomy: "Anatomy", ): """After context is changed. diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index ab61e608f8..97f71690f5 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -326,9 +326,7 @@ class IWorkfileHost: folder_entity, task_entity, reason=WORKFILE_SAVE_REASON, - workdir=workdir, project_entity=project_entity, - project_settings=project_settings, anatomy=anatomy, ) @@ -398,9 +396,7 @@ class IWorkfileHost: folder_entity, task_entity, reason=WORKFILE_OPEN_REASON, - workdir=workdir, project_entity=project_entity, - project_settings=project_settings, anatomy=anatomy, ) diff --git a/client/ayon_core/pipeline/context_tools.py b/client/ayon_core/pipeline/context_tools.py index c51f0ad0d9..5043902b67 100644 --- a/client/ayon_core/pipeline/context_tools.py +++ b/client/ayon_core/pipeline/context_tools.py @@ -524,11 +524,11 @@ def change_current_context( This updates the live Session to a different task under folder. Notes: - This function does a lot of things related to workfiles which + * This function does a lot of things related to workfiles which extends arguments options a lot. - We might want to implement 'set_current_context' on host integration + * We might want to implement 'set_current_context' on host integration instead. But `AYON_WORKDIR`, which is related to 'IWorkfileHost', - would not be available in that case which might be break some + would not be available in that case which might break some logic. Args: @@ -572,9 +572,8 @@ def change_current_context( folder_entity, task_entity, reason=reason, - anatomy=anatomy, project_entity=project_entity, - project_settings=project_settings, + anatomy=anatomy, ) From 63b69a915436370a0e831846a5265a7154605b61 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:02:13 +0200 Subject: [PATCH 066/170] added 'TemplateResult' typint --- .../pipeline/workfile/path_resolving.py | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 2bb94d5c06..91867cd162 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -3,6 +3,7 @@ import os import re import copy import platform +import typing from typing import Optional, Dict, Any import ayon_api @@ -13,10 +14,12 @@ from ayon_core.lib import ( Logger, StringTemplate, ) -from ayon_core.lib.path_templates import TemplateResult from ayon_core.pipeline import version_start, Anatomy from ayon_core.pipeline.template_data import get_template_data +if typing.TYPE_CHECKING: + from ayon_core.lib.path_templates import TemplateResult + def get_workfile_template_key_from_context( project_name: str, @@ -113,7 +116,7 @@ def get_workdir_with_workdir_data( anatomy=None, template_key=None, project_settings=None -) -> TemplateResult: +) -> "TemplateResult": """Fill workdir path from entered data and project's anatomy. It is possible to pass only project's name instead of project's anatomy but @@ -157,14 +160,14 @@ def get_workdir_with_workdir_data( def get_workdir( - project_entity, - folder_entity, - task_entity, - host_name, + project_entity: dict[str, Any], + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + host_name: str, anatomy=None, template_key=None, project_settings=None -): +) -> "TemplateResult": """Fill workdir path from entered data and project's anatomy. Args: @@ -186,8 +189,8 @@ def get_workdir( Returns: TemplateResult: Workdir path. - """ + """ if not anatomy: anatomy = Anatomy( project_entity["name"], project_entity=project_entity From 0f7921741daa458083bddeed667a9d4d480dc280 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:07:29 +0200 Subject: [PATCH 067/170] remove unused imports --- client/ayon_core/host/host.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index 45123d74a8..e997443aa2 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -11,8 +11,6 @@ import ayon_api from ayon_core.lib import emit_event -from .interfaces import IWorkfileHost - if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy @@ -319,8 +317,6 @@ class HostBase(ABC): anatomy (Anatomy): Project anatomy. """ - from ayon_core.pipeline.workfile import get_workdir - project_name = self.get_current_project_name() folder_path = None task_name = None From 87832f109d6739c4788a03b67065db0acb386dfc Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:27:47 +0200 Subject: [PATCH 068/170] modified change context function --- client/ayon_core/pipeline/context_tools.py | 25 ++++++---------------- 1 file changed, 6 insertions(+), 19 deletions(-) diff --git a/client/ayon_core/pipeline/context_tools.py b/client/ayon_core/pipeline/context_tools.py index 5043902b67..b27d2f3920 100644 --- a/client/ayon_core/pipeline/context_tools.py +++ b/client/ayon_core/pipeline/context_tools.py @@ -513,15 +513,13 @@ def change_current_context( task_entity: dict[str, Any], *, template_key: Optional[str] = _PLACEHOLDER, - workdir: Optional[str] = _PLACEHOLDER, reason: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, anatomy: Optional[Anatomy] = None, -): +) -> dict[str, str]: """Update active Session to a new task work area. - This updates the live Session to a different task under folder. + This updates the live Session to a different task under a folder. Notes: * This function does a lot of things related to workfiles which @@ -536,33 +534,22 @@ def change_current_context( task_entity (Dict[str, Any]): Task entity to set. template_key (Optional[str]): DEPRECATED: Prepared template key to be used for workfile template in Anatomy. - workdir (Optional[str]): DEPRECATED: Workdir to set. reason (Optional[str]): Reason for changing context. anatomy (Optional[Anatomy]): Anatomy object used for workdir calculation. project_entity (Optional[dict[str, Any]]): Project entity used for workdir calculation. - project_settings (Optional[dict[str, Any]]): Project settings used for - workdir calculation. Returns: - Dict[str, str]: New context data. + dict[str, str]: New context data. """ - depr_args = [] if template_key is not _PLACEHOLDER: - depr_args.append("'template_key'") - - if workdir is not _PLACEHOLDER: - depr_args.append("'workdir'") - - if depr_args: - ending = "s" if len(depr_args) > 1 else "" - depr_args = ", ".join(depr_args) warnings.warn( ( - f"Used deprecated argument{ending} {depr_args}." - " To change " + f"Used deprecated argument 'template_key' in" + f" 'change_current_context'." + " It is not necessary to pass it in anymore." ), DeprecationWarning, ) From 77dbf2946bca4809a2b15b386c61e78a2cff91c7 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:30:08 +0200 Subject: [PATCH 069/170] added typehints and modify docstrings --- .../pipeline/workfile/path_resolving.py | 65 ++++++++++--------- 1 file changed, 35 insertions(+), 30 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 91867cd162..21f0571888 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -213,8 +213,11 @@ def get_workdir( def get_last_workfile_with_version_from_paths( - filepaths, file_template, template_data, extensions -): + filepaths: list[str], + file_template: str, + template_data: dict[str, Any], + extensions: set[str], +) -> tuple[Optional[str], Optional[int]]: """Return last workfile version. Using workfile template and it's filling data find most possible last @@ -230,10 +233,10 @@ def get_last_workfile_with_version_from_paths( filepaths (list[str]): Workfile paths. file_template (str): Template of file name. template_data (Dict[str, Any]): Data for filling template. - extensions (Iterable[str]): All allowed file extensions of workfile. + extensions (set[str]): All allowed file extensions of workfile. Returns: - tuple[Union[str, None], Union[int, None]]: Last workfile with version + tuple[Optional[str], Optional[int]]: Last workfile with version if there is any workfile otherwise None for both. """ @@ -295,6 +298,8 @@ def get_last_workfile_with_version_from_paths( if file_version == version: output_filepaths.append(filepath) + # Use file modification time to use most recent file if there are + # multiple workfiles with the same version output_filepath = None last_time = None for _output_filepath in output_filepaths: @@ -316,10 +321,10 @@ def get_last_workfile_from_paths( file_template: str, template_data: dict[str, Any], extensions: set[str], -): - """Return last workfile filename. +) -> Optional[str]: + """Return the last workfile filename. - Returns file with version 1 if there is not workfile yet. + Returns the file with version 1 if there is not workfile yet. Args: filepaths (list[str]): Paths to workfiles. @@ -328,8 +333,7 @@ def get_last_workfile_from_paths( extensions (set[str]): All allowed file extensions of workfile. Returns: - Optional[str]: Last or first workfile as filename of full path - to filename. + Optional[str]: Last workfile path. """ filepath, _version = get_last_workfile_with_version_from_paths( @@ -341,7 +345,7 @@ def get_last_workfile_from_paths( def _filter_dir_files_by_ext( dirpath: str, extensions: set[str], -): +) -> tuple[list[str], set[str]]: """Filter files by extensions. Args: @@ -366,12 +370,15 @@ def _filter_dir_files_by_ext( def get_last_workfile_with_version( - workdir, file_template, fill_data, extensions -): + workdir: str, + file_template: str, + template_data: dict[str, Any], + extensions: set[str], +) -> tuple[Optional[str], Optional[int]]: """Return last workfile version. - Usign workfile template and it's filling data find most possible last - version of workfile which was created for the context. + Using the workfile template and its filling data to find the most possible + last version of workfile which was created for the context. Functionality is fully based on knowing which keys are optional or what values are expected as value. @@ -382,14 +389,14 @@ def get_last_workfile_with_version( Args: workdir (str): Path to dir where workfiles are stored. file_template (str): Template of file name. - fill_data (Dict[str, Any]): Data for filling template. - extensions (Iterable[str]): All allowed file extensions of workfile. + template_data (dict[str, Any]): Data for filling template. + extensions (set[str]): All allowed file extensions of workfile. Returns: - Tuple[Union[str, None], Union[int, None]]: Last workfile with version + tuple[Optional[str], Optional[int]]: Last workfile with version if there is any workfile otherwise None for both. - """ + """ if not os.path.exists(workdir): return None, None @@ -400,7 +407,7 @@ def get_last_workfile_with_version( return get_last_workfile_with_version_from_paths( filepaths, file_template, - fill_data, + template_data, dotted_extensions, ) @@ -408,10 +415,10 @@ def get_last_workfile_with_version( def get_last_workfile( workdir: str, file_template: str, - fill_data: dict[str, Any], + template_data: dict[str, Any], extensions: set[str], - full_path: bool = False -): + full_path: bool = False, +) -> str: """Return last workfile filename. Returns file with version 1 if there is not workfile yet. @@ -419,10 +426,9 @@ def get_last_workfile( Args: workdir (str): Path to dir where workfiles are stored. file_template (str): Template of file name. - fill_data (Dict[str, Any]): Data for filling template. + template_data (Dict[str, Any]): Data for filling template. extensions (Iterable[str]): All allowed file extensions of workfile. - full_path (bool): Full path to file is returned if - set to True. + full_path (bool): Return full path to the file or only filename. Returns: str: Last or first workfile as filename of full path to filename. @@ -434,11 +440,11 @@ def get_last_workfile( filepath = get_last_workfile_from_paths( filepaths, file_template, - fill_data, + template_data, dotted_extensions ) if filepath is None: - data = copy.deepcopy(fill_data) + data = copy.deepcopy(template_data) data["version"] = version_start.get_versioning_start( data["project"]["name"], data["app"], @@ -492,11 +498,10 @@ def get_custom_workfile_template( project_settings(Dict[str, Any]): Preloaded project settings. Returns: - str: Path to template or None if none of profiles match current + Optional[str]: Path to template or None if none of profiles match current context. Existence of formatted path is not validated. - None: If no profile is matching context. - """ + """ log = Logger.get_logger("CustomWorkfileResolve") project_name = project_entity["name"] From 63911161dd33cf612b23272a7b02cb83d192e28f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:30:24 +0200 Subject: [PATCH 070/170] add deprecation warning for 'full_path' argument --- client/ayon_core/pipeline/workfile/path_resolving.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 21f0571888..970b351586 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -434,6 +434,18 @@ def get_last_workfile( str: Last or first workfile as filename of full path to filename. """ + # TODO (iLLiCiTiT): Remove the argument 'full_path' and return only full + # path. As far as I can tell it is always called with 'full_path' set + # to 'True'. + # - it has to be 2 step operation, first warn about having it 'False', and + # then warn about having it filled. + if full_path is False: + warnings.warn( + "Argument 'full_path' will be removed and will return" + " only full path in future.", + DeprecationWarning, + ) + filepaths, dotted_extensions = _filter_dir_files_by_ext( workdir, extensions ) From c8a7e355b4cce797e3f5396dd720a284bcdb9206 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:30:52 +0200 Subject: [PATCH 071/170] iterate over extensions fix --- client/ayon_core/pipeline/workfile/path_resolving.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 970b351586..4dcd4d47f0 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -465,8 +465,8 @@ def get_last_workfile( product_type="workfile" ) data.pop("comment", None) - if not data.get("ext"): - data["ext"] = extensions[0] + if data.get("ext") is None: + data["ext"] = next(iter(extensions), "") data["ext"] = data["ext"].lstrip(".") filename = StringTemplate.format_strict_template(file_template, data) filepath = os.path.join(workdir, filename) From f130f543b8aed6f872ca92455a51d8c52a44e82a Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:33:15 +0200 Subject: [PATCH 072/170] add missing import --- client/ayon_core/pipeline/workfile/path_resolving.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 4dcd4d47f0..b95d731809 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -3,6 +3,7 @@ import os import re import copy import platform +import warnings import typing from typing import Optional, Dict, Any From 79922d99b28c1093c729a3d76601861cf069929c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:33:23 +0200 Subject: [PATCH 073/170] update docstrings --- client/ayon_core/pipeline/workfile/path_resolving.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index b95d731809..a177caf7a4 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -221,7 +221,7 @@ def get_last_workfile_with_version_from_paths( ) -> tuple[Optional[str], Optional[int]]: """Return last workfile version. - Using workfile template and it's filling data find most possible last + Using the workfile template and its template data find most possible last version of workfile which was created for the context. Functionality is fully based on knowing which keys are optional or what @@ -511,8 +511,8 @@ def get_custom_workfile_template( project_settings(Dict[str, Any]): Preloaded project settings. Returns: - Optional[str]: Path to template or None if none of profiles match current - context. Existence of formatted path is not validated. + Optional[str]: Path to template or None if none of profiles match + current context. Existence of formatted path is not validated. """ log = Logger.get_logger("CustomWorkfileResolve") @@ -734,7 +734,7 @@ class CommentMatcher: self._fname_regex = re.compile(f"^{fname_pattern}$") def parse_comment(self, filename: str) -> Optional[str]: - """Parse the {comment} part from a filename""" + """Parse the {comment} part from a filename.""" if self._fname_regex: match = self._fname_regex.match(filename) if match: From dd637bb25d4a29eb8919a219fc92e716dcf79481 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 3 Jun 2025 14:33:31 +0200 Subject: [PATCH 074/170] use comprehention --- client/ayon_core/pipeline/workfile/utils.py | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index c45163e7a1..c61614205a 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -563,14 +563,15 @@ def _create_workfile_info_entity( if value is not None: attrib[key] = value - data = {} - for key, value in ( - ("host_name", host_name), - ("version", version), - ("comment", comment), - ): - if value is not None: - data[key] = value + data = { + key: value + for key, value in ( + ("host_name", host_name), + ("version", version), + ("comment", comment), + ) + if value is not None + } workfile_info = { "id": uuid.uuid4().hex, From 808712e1148bde74f3ff0005ad8e80245c15e998 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 4 Jun 2025 16:13:01 +0200 Subject: [PATCH 075/170] Apply suggestions from code review Co-authored-by: Roy Nieterau --- client/ayon_core/host/interfaces/workfiles.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 97f71690f5..e435d5dc7f 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -296,6 +296,7 @@ class IWorkfileHost: task_entity (dict[str, Any]): Task entity. version (Optional[int]): Version of the workfile. comment (Optional[str]): Comment for the workfile. + Usually used in the filename template. description (Optional[str]): Description for the workfile. rootless_path (Optional[str]): Rootless path of the workfile. workfile_entities (Optional[list[dict[str, Any]]]): Workfile From 5baf13c96cfcfb99c610a19d6ed8276e72eda2d8 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 4 Jun 2025 16:16:05 +0200 Subject: [PATCH 076/170] fix formatting --- client/ayon_core/host/interfaces/workfiles.py | 4 ++-- client/ayon_core/pipeline/context_tools.py | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index e435d5dc7f..f2c5dc89cf 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -610,9 +610,9 @@ class IWorkfileHost: try: workfile_path = workfile_path.format(root=anatomy.roots) - except Exception as exc: + except Exception: self.log.warning( - f"Failed to format workfile path.", exc_info=True + "Failed to format workfile path.", exc_info=True ) is_available = False diff --git a/client/ayon_core/pipeline/context_tools.py b/client/ayon_core/pipeline/context_tools.py index b27d2f3920..cccdafe6f1 100644 --- a/client/ayon_core/pipeline/context_tools.py +++ b/client/ayon_core/pipeline/context_tools.py @@ -547,8 +547,8 @@ def change_current_context( if template_key is not _PLACEHOLDER: warnings.warn( ( - f"Used deprecated argument 'template_key' in" - f" 'change_current_context'." + "Used deprecated argument 'template_key' in" + " 'change_current_context'." " It is not necessary to pass it in anymore." ), DeprecationWarning, From 509543e3690677f8dacd3dce63d5a7f5c87f151a Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 4 Jun 2025 16:21:03 +0200 Subject: [PATCH 077/170] better description of workfile_entities --- client/ayon_core/host/interfaces/workfiles.py | 15 ++++---- client/ayon_core/pipeline/workfile/utils.py | 34 +++++++++++++++---- 2 files changed, 35 insertions(+), 14 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index f2c5dc89cf..cbf8a8e8e4 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -299,7 +299,8 @@ class IWorkfileHost: Usually used in the filename template. description (Optional[str]): Description for the workfile. rootless_path (Optional[str]): Rootless path of the workfile. - workfile_entities (Optional[list[dict[str, Any]]]): Workfile + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities for the task. project_settings (Optional[dict[str, Any]]): Project settings. project_entity (Optional[dict[str, Any]]): Project entity. anatomy (Optional[Anatomy]): Project anatomy. @@ -431,8 +432,8 @@ class IWorkfileHost: folder_entity (dict[str, Any]): Folder entity. task_entity (dict[str, Any]): Task entity. project_entity (Optional[dict[str, Any]]): Project entity. - workfile_entities (Optional[list[dict[str, Any]]]): Workfile - entities. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities for the task. template_key (Optional[str]): Template key. project_settings (Optional[dict[str, Any]]): Project settings. anatomy (Anatomy): Project anatomy. @@ -671,8 +672,8 @@ class IWorkfileHost: comment (Optional[str]): Comment for the workfile. description (Optional[str]): Description for the workfile. rootless_path (Optional[str]): Rootless path of the workfile. - workfile_entities (Optional[list[dict[str, Any]]]): Workfile - entities to be saved with the workfile. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities for the task. project_settings (Optional[dict[str, Any]]): Project settings. project_entity (Optional[dict[str, Any]]): Project entity. anatomy (Optional[Anatomy]): Project anatomy. @@ -765,8 +766,8 @@ class IWorkfileHost: comment (Optional[str]): Comment for the workfile. description (Optional[str]): Description for the workfile. rootless_path (Optional[str]): Rootless path of the workfile. - workfile_entities (Optional[list[dict[str, Any]]]): Workfile - entities to be saved with the workfile. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities for the task. project_settings (Optional[dict[str, Any]]): Project settings. project_entity (Optional[dict[str, Any]]): Project entity. anatomy (Optional[Anatomy]): Project anatomy. diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index c61614205a..1a862d7d92 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -38,7 +38,7 @@ def get_workfiles_info( task_id (str): Task id under which is workfile created. anatomy (Optional[Anatomy]): Project anatomy used to get roots. workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities related to task. + workfile entities related to the task. Returns: Optional[dict[str, Any]]: Workfile info entity if found, otherwise @@ -198,7 +198,25 @@ def save_workfile_info( description: Optional[str] = None, username: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, -): +) -> dict[str, Any]: + """Save workfile info entity for a workfile path. + Args: + project_name (str): The name of the project. + task_id (str): Task id under which is workfile created. + rootless_path (str): Rootless path of the workfile. + host_name (str): Name of host which is saving the workfile. + version (Optional[int]): Workfile version. + comment (Optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + username (Optional[str]): Username of user who saves the workfile. + If not provided, current user is used. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities related to task. + + Returns: + dict[str, Any]: Workfile info entity. + + """ if workfile_entities is None: workfile_entities = list(ayon_api.get_workfiles_info( project_name, @@ -266,7 +284,7 @@ def save_workfile_info( workfile_entity["updatedBy"] = username if not update_data: - return + return workfile_entity session = OperationsSession() session.update_entity( @@ -326,8 +344,8 @@ def save_current_workfile_to( description (Optional[str]): Workfile description. rootless_path (Optional[str]): Rootless path of the workfile. Is calculated if not passed in. - workfile_entities (Optional[list[dict[str, Any]]]): List of workfile - entities related to task. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities related to the task. project_entity (Optional[dict[str, Any]]): Project entity used for rootless path calculation. project_settings (Optional[dict[str, Any]]): Project settings used for @@ -385,7 +403,8 @@ def copy_and_open_workfile( description (Optional[str]): Workfile description. rootless_path (Optional[str]): Rootless path of the workfile. Is calculated if not passed in. - workfile_entities (Optional[list[dict[str, Any]]]): List of workfile + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities related to the task. project_entity (Optional[dict[str, Any]]): Project entity used for rootless path calculation. project_settings (Optional[dict[str, Any]]): Project settings used for @@ -453,7 +472,8 @@ def copy_and_open_workfile_representation( entity. If not provided, it will be fetched from the server. representation_path (Optional[str]): Path to the representation. Calculated if not provided. - workfile_entities (Optional[list[dict[str, Any]]]): List of workfile + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities related to the task. project_entity (Optional[dict[str, Any]]): Project entity used for rootless path calculation. project_settings (Optional[dict[str, Any]]): Project settings used for From e53962dd6e929a7a87f4262c9b41495cf673f0c1 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 10:07:07 +0200 Subject: [PATCH 078/170] let 'version' argument optional --- client/ayon_core/host/interfaces/workfiles.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index cbf8a8e8e4..5d5cb8d740 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -276,7 +276,7 @@ class IWorkfileHost: folder_entity: dict[str, Any], task_entity: dict[str, Any], *, - version: Optional[int], + version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, rootless_path: Optional[str] = None, @@ -648,7 +648,7 @@ class IWorkfileHost: folder_entity: dict[str, Any], task_entity: dict[str, Any], *, - version: Optional[int], + version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, rootless_path: Optional[str] = None, @@ -739,7 +739,7 @@ class IWorkfileHost: folder_entity: dict[str, Any], task_entity: dict[str, Any], *, - version: Optional[int], + version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, rootless_path: Optional[str] = None, From d97829a180ea6fc9390cf36593d28e80949be4d5 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 10:07:18 +0200 Subject: [PATCH 079/170] filter published workfiles by extension --- client/ayon_core/host/interfaces/workfiles.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 5d5cb8d740..5c958ac846 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -520,6 +520,9 @@ class IWorkfileHost: # Workfile entity is not in the filesystem # but it is in the database rootless_path = workfile_entity["path"] + ext = os.path.splitext(rootless_path)[1].lower() + if ext not in extensions: + continue filepath = anatomy.fill_root(rootless_path) items.append(WorkfileInfo.new( filepath, From 26a35a8cb5caf266f5236501802e3400c5636c29 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 10:07:36 +0200 Subject: [PATCH 080/170] pre-fetch project entity --- client/ayon_core/host/interfaces/workfiles.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 5c958ac846..95ef3f3318 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -311,8 +311,9 @@ class IWorkfileHost: folder_entity, task_entity, ) + project_name = self.get_current_project_name() event_data = self._get_workfile_event_data( - self.get_current_project_name(), + project_name, folder_entity, task_entity, filepath, @@ -324,6 +325,9 @@ class IWorkfileHost: # Set 'AYON_WORKDIR' environment variable os.environ["AYON_WORKDIR"] = workdir + if project_entity is None: + project_entity = ayon_api.get_project(project_name) + self.set_current_context( folder_entity, task_entity, From d3699c348fb1600b82c2589474976af5b7e3a614 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 10:08:02 +0200 Subject: [PATCH 081/170] modified docstrings --- client/ayon_core/host/interfaces/workfiles.py | 45 +++++++++++++++---- 1 file changed, 36 insertions(+), 9 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 95ef3f3318..f84322de90 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -287,6 +287,13 @@ class IWorkfileHost: ): """Save the current workfile with context. + Arguments 'rootless_path', 'workfile_entities', 'project_entity' + and 'anatomy' can be filled to enhance efficiency if you already + have access to the values. + + Argument 'project_settings' is used to calculate 'rootless_path' + if it is not provided. + Notes: Should this method care about context change? @@ -294,11 +301,13 @@ class IWorkfileHost: filepath (str): Where the current scene should be saved. folder_entity (dict[str, Any]): Folder entity. task_entity (dict[str, Any]): Task entity. - version (Optional[int]): Version of the workfile. + version (Optional[int]): Version of the workfile. Information + for workfile entity. Recommended to fill. comment (Optional[str]): Comment for the workfile. Usually used in the filename template. - description (Optional[str]): Description for the workfile. - rootless_path (Optional[str]): Rootless path of the workfile. + description (Optional[str]): Artist note for the workfile entity. + rootless_path (Optional[str]): Prepared rootless path of + the workfile. workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched workfile entities for the task. project_settings (Optional[dict[str, Any]]): Project settings. @@ -422,14 +431,16 @@ class IWorkfileHost: project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, ) -> list[WorkfileInfo]: - """List workfiles in the given folder. + """List workfiles in the given task. + + The method should also return workfiles that are not available on + disk, but are in the AYON database. Notes: - Better method name? - This method is pre-implemented as the logic can be shared across 95% of host integrations. Ad-hoc implementation to give host integration workfile api functionality. - - Should this method also handle workfiles based on workfile entities? Args: project_name (str): Project name. @@ -670,14 +681,22 @@ class IWorkfileHost: It is expected that workfile is saved to the current project, but can be copied from the other project. + Arguments 'rootless_path', 'workfile_entities', 'project_entity' + and 'anatomy' can be filled to enhance efficiency if you already + have access to the values. + + Argument 'project_settings' is used to calculate 'rootless_path' + if it is not provided. + Args: src_path (str): Path to the source scene. dst_path (str): Where the scene should be saved. folder_entity (dict[str, Any]): Folder entity. task_entity (dict[str, Any]): Task entity. - version (Optional[int]): Version of the workfile. + version (Optional[int]): Version of the workfile. Information + for workfile entity. Recommended to fill. comment (Optional[str]): Comment for the workfile. - description (Optional[str]): Description for the workfile. + description (Optional[str]): Artist note for the workfile entity. rootless_path (Optional[str]): Rootless path of the workfile. workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched workfile entities for the task. @@ -762,6 +781,13 @@ class IWorkfileHost: Use representation as source for the workfile. + Arguments 'rootless_path', 'workfile_entities', 'project_entity' + and 'anatomy' can be filled to enhance efficiency if you already + have access to the values. + + Argument 'project_settings' is used to calculate 'rootless_path' + if it is not provided. + Args: src_project_name (str): Project name. src_representation_entity (dict[str, Any]): Representation @@ -769,9 +795,10 @@ class IWorkfileHost: dst_path (str): Where the scene should be saved. folder_entity (dict[str, Any): Folder entity. task_entity (dict[str, Any]): Task entity. - version (Optional[int]): Version of the workfile. + version (Optional[int]): Version of the workfile. Information + for workfile entity. Recommended to fill. comment (Optional[str]): Comment for the workfile. - description (Optional[str]): Description for the workfile. + description (Optional[str]): Artist note for the workfile entity. rootless_path (Optional[str]): Rootless path of the workfile. workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched workfile entities for the task. From 76ceefb6f38fbd67a9403605b13e75e2e6d0173b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 10:08:29 +0200 Subject: [PATCH 082/170] require kwargs for 'list_workfiles' --- client/ayon_core/host/interfaces/workfiles.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index f84322de90..5a3b9f117f 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -425,6 +425,7 @@ class IWorkfileHost: project_name: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], + *, project_entity: Optional[dict[str, Any]] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, template_key: Optional[str] = None, From 3e6aafae556fae48ded5d32e38e5844f0ee2e556 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 10:08:59 +0200 Subject: [PATCH 083/170] apply suggestion Co-authored-by: Roy Nieterau --- client/ayon_core/host/interfaces/workfiles.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 5a3b9f117f..86b751ba66 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -237,7 +237,7 @@ class IWorkfileHost: Returns: Optional[str]: Path to the file which is currently opened. None if - nothing is opened. + nothing is opened or the current workfile is unsaved. """ return None From 351ab7d56bc2b9add8f193489a0ce4e3ef30098e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 11:24:32 +0200 Subject: [PATCH 084/170] use 'open_workfile' to open workfile --- client/ayon_core/pipeline/workfile/workfile_template_builder.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/workfile_template_builder.py b/client/ayon_core/pipeline/workfile/workfile_template_builder.py index 27da278c5e..45edf01172 100644 --- a/client/ayon_core/pipeline/workfile/workfile_template_builder.py +++ b/client/ayon_core/pipeline/workfile/workfile_template_builder.py @@ -604,7 +604,7 @@ class AbstractTemplateBuilder(ABC): """Open template file with registered host.""" template_preset = self.get_template_preset() template_path = template_preset["path"] - self.host.open_file(template_path) + self.host.open_workfile(template_path) @abstractmethod def import_template(self, template_path): From 762f98620baca0220b463eb8b9d2769063b5dbf5 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 16:33:17 +0200 Subject: [PATCH 085/170] use dataclasses to pass information form method to method --- client/ayon_core/host/host.py | 50 ++--- client/ayon_core/host/interfaces/workfiles.py | 172 +++++++++--------- 2 files changed, 103 insertions(+), 119 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index e997443aa2..f9f74e8069 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -4,6 +4,7 @@ import os import logging import contextlib from abc import ABC, abstractmethod +from dataclasses import dataclass import typing from typing import Optional, Any @@ -15,6 +16,16 @@ if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy +@dataclass +class ContextChangeData: + project_entity: dict[str, Any] + folder_entity: dict[str, Any] + task_entity: dict[str, Any] + reason: Optional[str] + anatomy: "Anatomy" + + + class HostBase(ABC): """Base of host implementation class. @@ -198,13 +209,14 @@ class HostBase(ABC): if anatomy is None: anatomy = Anatomy(project_name, project_entity=project_entity) - self._before_context_change( + context_change_data = ContextChangeData( project_entity, folder_entity, task_entity, reason, anatomy, ) + self._before_context_change(context_change_data) self._set_current_context( project_entity, folder_entity, @@ -212,13 +224,7 @@ class HostBase(ABC): reason, anatomy, ) - self._after_context_change( - project_entity, - folder_entity, - task_entity, - reason, - anatomy, - ) + self._after_context_change(context_change_data) return self._emit_context_change_event( project_name, @@ -339,14 +345,7 @@ class HostBase(ABC): else: os.environ[key] = value - def _before_context_change( - self, - project_entity: dict[str, Any], - folder_entity: Optional[dict[str, Any]], - task_entity: Optional[dict[str, Any]], - reason: Optional[str], - anatomy: "Anatomy", - ): + def _before_context_change(self, context_change_data: ContextChangeData): """Before context is changed. This method is called before the context is changed in the host. @@ -354,21 +353,13 @@ class HostBase(ABC): Can be overriden to implement host specific logic. Args: - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. - reason (Optional[str]): Reason for context change. + context_change_data (ContextChangeData): Object with information + about context change. """ pass - def _after_context_change( - self, - project_entity: dict[str, Any], - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - reason: Optional[str], - anatomy: "Anatomy", - ): + def _after_context_change(self, context_change_data: ContextChangeData): """After context is changed. This method is called after the context is changed in the host. @@ -376,9 +367,8 @@ class HostBase(ABC): Can be overriden to implement host specific logic. Args: - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. - reason (Optional[str]): Reason for context change. + context_change_data (ContextChangeData): Object with information + about context change. """ pass diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 86b751ba66..53776f1ce8 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -21,6 +21,29 @@ WORKFILE_OPEN_REASON = "workfile.opened" WORKFILE_SAVE_REASON = "workfile.saved" +@dataclass +class WorkfileOpenData: + filepath: str + folder_entity: dict[str, Any] + task_entity: dict[str, Any] + + +@dataclass +class WorkfileSaveData(WorkfileOpenData): + filepath: str + folder_entity: dict[str, Any] + task_entity: dict[str, Any] + + +@dataclass +class WorkfileCopyData: + source_path: str + destination_path: str + folder_entity: dict[str, Any] + task_entity: dict[str, Any] + open_workfile: bool + + @dataclass class WorkfileInfo: """Information about workfile. @@ -315,11 +338,12 @@ class IWorkfileHost: anatomy (Optional[Anatomy]): Project anatomy. """ - self._before_workfile_save( - filepath, - folder_entity, - task_entity, + save_workfile_data = WorkfileSaveData( + folder_entity=folder_entity, + task_entity=task_entity, + filepath=filepath, ) + self._before_workfile_save(save_workfile_data) project_name = self.get_current_project_name() event_data = self._get_workfile_event_data( project_name, @@ -360,11 +384,7 @@ class IWorkfileHost: project_entity, anatomy, ) - self._after_workfile_save( - filepath, - folder_entity, - task_entity, - ) + self._after_workfile_save(save_workfile_data) self._emit_workfile_save_event(event_data) def open_workfile_with_context( @@ -403,8 +423,12 @@ class IWorkfileHost: event_data = self._get_workfile_event_data( project_name, folder_entity, task_entity, filepath ) - - self._before_workfile_open(folder_entity, task_entity, filepath) + open_workfile_data = WorkfileOpenData( + folder_entity=folder_entity, + task_entity=task_entity, + filepath=filepath, + ) + self._before_workfile_open(open_workfile_data) self._emit_workfile_open_event(event_data, after_open=False) self.set_current_context( @@ -417,7 +441,7 @@ class IWorkfileHost: self.open_workfile(filepath) - self._after_workfile_open(folder_entity, task_entity, filepath) + self._after_workfile_open(open_workfile_data) self._emit_workfile_open_event(event_data) def list_workfiles( @@ -707,13 +731,15 @@ class IWorkfileHost: open_workfile (bool): Open workfile when copied. """ - self._before_workfile_copy( - src_path, - dst_path, - folder_entity, - task_entity, - open_workfile, + copy_workfile_data = WorkfileCopyData( + source_path=src_path, + destination_path=dst_path, + folder_entity=folder_entity, + task_entity=task_entity, + open_workfile=open_workfile, + ) + self._before_workfile_copy(copy_workfile_data) event_data = self._get_workfile_event_data( self.get_current_project_name(), folder_entity, @@ -740,13 +766,7 @@ class IWorkfileHost: project_entity, anatomy, ) - self._after_workfile_copy( - src_path, - dst_path, - folder_entity, - task_entity, - open_workfile, - ) + self._after_workfile_copy(copy_workfile_data) self._emit_workfile_save_event(event_data) if not open_workfile: @@ -1046,11 +1066,8 @@ class IWorkfileHost: } def _before_workfile_open( - self, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - filepath: str, - ): + self, open_workfile_data: WorkfileOpenData + ) -> None: """Before workfile is opened. This method is called before the workfile is opened in the host. @@ -1058,19 +1075,15 @@ class IWorkfileHost: Can be overriden to implement host specific logic. Args: - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. - filepath (str): Path to the workfile. + open_workfile_data (WorkfileOpenData): Context and path of + workfile to open. """ pass def _after_workfile_open( - self, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - filepath: str, - ): + self, open_workfile_data: WorkfileOpenData + ) -> None: """After workfile is opened. This method is called after the workfile is opened in the host. @@ -1078,19 +1091,15 @@ class IWorkfileHost: Can be overriden to implement host specific logic. Args: - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. - filepath (str): Path to the workfile. + open_workfile_data (WorkfileOpenData): Context and path of + opened workfile. """ pass def _before_workfile_save( - self, - filepath: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - ): + self, save_workfile_data: WorkfileSaveData + ) -> None: """Before workfile is saved. This method is called before the workfile is saved in the host. @@ -1098,19 +1107,15 @@ class IWorkfileHost: Can be overriden to implement host specific logic. Args: - filepath (str): Path to the workfile. - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. + save_workfile_data (WorkfileSaveData): Workfile path with target + folder and task context. """ pass def _after_workfile_save( - self, - filepath: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - ): + self, save_workfile_data: WorkfileSaveData + ) -> None: """After workfile is saved. This method is called after the workfile is saved in the host. @@ -1118,22 +1123,20 @@ class IWorkfileHost: Can be overriden to implement host specific logic. Args: - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. - filepath (str): Path to the workfile. + save_workfile_data (WorkfileSaveData): Workfile path with target + folder and task context. """ - workdir = os.path.dirname(filepath) - self._create_extra_folders(folder_entity, task_entity, workdir) + workdir = os.path.dirname(save_workfile_data.filepath) + self._create_extra_folders( + save_workfile_data.folder_entity, + save_workfile_data.task_entity, + workdir + ) def _before_workfile_copy( - self, - src_path: str, - dst_path: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - open_workfile: bool = True, - ): + self, copy_workfile_data: WorkfileCopyData + ) -> None: """Before workfile is copied. This method is called before the workfile is copied by host @@ -1142,24 +1145,15 @@ class IWorkfileHost: Can be overriden to implement host specific logic. Args: - src_path (str): Path to the source workfile. - dst_path (str): Path to the destination workfile. - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. - open_workfile (bool): Should be the path opened once copy is - finished. + copy_workfile_data (WorkfileCopyData): Source and destination + path with context before workfile is copied. """ pass def _after_workfile_copy( - self, - src_path: str, - dst_path: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - open_workfile: bool = True, - ): + self, copy_workfile_data: WorkfileCopyData + ) -> None: """After workfile is copied. This method is called after the workfile is copied by host @@ -1168,22 +1162,22 @@ class IWorkfileHost: Can be overriden to implement host specific logic. Args: - src_path (str): Path to the source workfile. - dst_path (str): Path to the destination workfile. - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. - open_workfile (bool): Should be the path opened once copy is - finished. + copy_workfile_data (WorkfileCopyData): Source and destination + path with context after workfile is copied. """ - workdir = os.path.dirname(dst_path) - self._create_extra_folders(folder_entity, task_entity, workdir) + workdir = os.path.dirname(copy_workfile_data.destination_path) + self._create_extra_folders( + copy_workfile_data.folder_entity, + copy_workfile_data.task_entity, + workdir, + ) def _emit_workfile_open_event( self, event_data: dict[str, Optional[str]], after_open: bool = True, - ): + ) -> None: topics = [] topic_end = "before" if after_open: @@ -1200,7 +1194,7 @@ class IWorkfileHost: self, event_data: dict[str, Optional[str]], after_open: bool = True, - ): + ) -> None: topics = [] topic_end = "before" if after_open: From 688e5f2104b3563a09724d4b264bb4c4f144973c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 16:55:07 +0200 Subject: [PATCH 086/170] remove unnecessary line --- client/ayon_core/host/interfaces/workfiles.py | 1 - 1 file changed, 1 deletion(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 53776f1ce8..d5aec5b651 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -737,7 +737,6 @@ class IWorkfileHost: folder_entity=folder_entity, task_entity=task_entity, open_workfile=open_workfile, - ) self._before_workfile_copy(copy_workfile_data) event_data = self._get_workfile_event_data( From da1a39ed6ad15437b946617630f45efedf312e86 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 17:03:25 +0200 Subject: [PATCH 087/170] validate extension earlier Co-authored-by: Roy Nieterau --- client/ayon_core/host/interfaces/workfiles.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index d5aec5b651..f6f6b91f2d 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -539,12 +539,13 @@ class IWorkfileHost: items = [] for filename in filenames: - filepath = os.path.join(workdir, filename) # TODO add 'default' support for folders - ext = os.path.splitext(filepath)[1].lower() + ext = os.path.splitext(filename)[1].lower() if ext not in extensions: continue + filepath = os.path.join(workdir, filename) + rootless_path = f"{rootless_workdir}/{filename}" workfile_entity = workfile_entities_by_path.pop( rootless_path, None From 411c433d50ed8bf4b0ea84d9872e7b07d17d342c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 17:06:58 +0200 Subject: [PATCH 088/170] added typehints --- client/ayon_core/host/host.py | 7 +++++-- client/ayon_core/host/interfaces/workfiles.py | 21 ++++++++++++------- 2 files changed, 18 insertions(+), 10 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index f9f74e8069..1c2885b7e6 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -25,7 +25,6 @@ class ContextChangeData: anatomy: "Anatomy" - class HostBase(ABC): """Base of host implementation class. @@ -169,7 +168,7 @@ class HostBase(ABC): reason: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, - ): + ) -> dict[str, Optional[str]]: """Set current context information. This method should be used to set current context of host. Usage of @@ -188,6 +187,10 @@ class HostBase(ABC): project_entity (Optional[dict[str, Any]]): Project entity data. anatomy (Optional[Anatomy]): Anatomy instance for the project. + Returns: + dict[str, Optional[str]]: Context information with project name, + folder path and task name. + """ from ayon_core.pipeline import Anatomy diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index f6f6b91f2d..76e91dcd93 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -186,7 +186,7 @@ class PublishedWorkfileInfo: file_size: Optional[float], file_modified: Optional[float], file_created: Optional[float], - ): + ) -> "PublishedWorkfileInfo": created_at = arrow.get(repre_entity["createdAt"]).to("local") return cls( @@ -307,7 +307,7 @@ class IWorkfileHost: project_settings: Optional[dict[str, Any]] = None, project_entity: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, - ): + ) -> None: """Save the current workfile with context. Arguments 'rootless_path', 'workfile_entities', 'project_entity' @@ -396,7 +396,7 @@ class IWorkfileHost: project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, - ): + ) -> None: """Open passed filepath in the host with context. This function should be used to open workfile in different context. @@ -701,7 +701,7 @@ class IWorkfileHost: project_entity: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, open_workfile: bool = True, - ): + ) -> None: """Save workfile path with target folder and task context. It is expected that workfile is saved to the current project, but @@ -797,7 +797,7 @@ class IWorkfileHost: open_workfile: bool = True, src_anatomy: Optional["Anatomy"] = None, src_representation_path: Optional[str] = None, - ): + ) -> None: """Copy workfile representation. Use representation as source for the workfile. @@ -984,7 +984,7 @@ class IWorkfileHost: project_settings: Optional[dict[str, Any]] = None, project_entity: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, - ): + ) -> Optional[dict[str, Any]]: from ayon_core.pipeline.workfile.utils import ( save_workfile_info, find_workfile_rootless_path, @@ -1029,7 +1029,12 @@ class IWorkfileHost: ) return workfile_info - def _create_extra_folders(self, folder_entity, task_entity, workdir): + def _create_extra_folders( + self, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + workdir: str, + ) -> None: from ayon_core.pipeline.workfile.path_resolving import ( create_workdir_extra_folders ) @@ -1051,7 +1056,7 @@ class IWorkfileHost: folder_entity: dict[str, Any], task_entity: dict[str, Any], filepath: str, - ): + ) -> dict[str, Optional[str]]: workdir, filename = os.path.split(filepath) return { "project_name": project_name, From 0c25defb9d5f3a82597fdfcbc0af6befc20207b6 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 17:17:10 +0200 Subject: [PATCH 089/170] added more docstrings --- client/ayon_core/host/interfaces/workfiles.py | 92 +++++++++++++++++-- 1 file changed, 86 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 76e91dcd93..d5f17b9acb 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -351,7 +351,7 @@ class IWorkfileHost: task_entity, filepath, ) - self._emit_workfile_save_event(event_data, after_open=False) + self._emit_workfile_save_event(event_data, after_save=False) workdir = os.path.dirname(filepath) @@ -612,7 +612,7 @@ class IWorkfileHost: ( version_entities, repre_entities - ) = self._fetch_workfile_entities( + ) = self._fetch_published_workfile_entities( project_name, folder_id, version_entities, @@ -746,7 +746,7 @@ class IWorkfileHost: task_entity, dst_path, ) - self._emit_workfile_save_event(event_data, after_open=False) + self._emit_workfile_save_event(event_data, after_save=False) dst_dir = os.path.dirname(dst_path) if not os.path.exists(dst_dir): @@ -921,7 +921,7 @@ class IWorkfileHost: return self.workfile_has_unsaved_changes() - def _fetch_workfile_entities( + def _fetch_published_workfile_entities( self, project_name: str, folder_id: str, @@ -931,6 +931,21 @@ class IWorkfileHost: list[dict[str, Any]], list[dict[str, Any]] ]: + """Fetch integrated workfile entities for the given folder. + + Args: + project_name (str): Project name. + folder_id (str): Folder id. + version_entities (Optional[list[dict[str, Any]]]): Pre-fetched + version entities. + repre_entities (Optional[list[dict[str, Any]]]): Pre-fetched + representation entities. + + Returns: + tuple[list[dict[str, Any]], list[dict[str, Any]]]: + Tuple of version entities and representation entities. + + """ if repre_entities is not None and version_entities is None: # Get versions of representations version_ids = {r["versionId"] for r in repre_entities} @@ -985,6 +1000,27 @@ class IWorkfileHost: project_entity: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, ) -> Optional[dict[str, Any]]: + """Create of update workfile entity to AYON based on provided data. + + Args: + workfile_path (str): Path to the workfile. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + version (Optional[int]): Version of the workfile. + comment (Optional[str]): Comment for the workfile. + description (Optional[str]): Artist note for the workfile entity. + rootless_path (Optional[str]): Prepared rootless path of + the workfile. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities. + project_settings (Optional[dict[str, Any]]): Project settings. + project_entity (Optional[dict[str, Any]]): Project entity. + anatomy (Optional[Anatomy]): Project anatomy. + + Returns: + Optional[dict[str, Any]]: Workfile entity. + + """ from ayon_core.pipeline.workfile.utils import ( save_workfile_info, find_workfile_rootless_path, @@ -1035,6 +1071,16 @@ class IWorkfileHost: task_entity: dict[str, Any], workdir: str, ) -> None: + """Create extra folders in the workdir. + + This method should be called when workfile is saved or copied. + + Args: + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + workdir (str): Workdir where workfile/s will be stored. + + """ from ayon_core.pipeline.workfile.path_resolving import ( create_workdir_extra_folders ) @@ -1057,6 +1103,18 @@ class IWorkfileHost: task_entity: dict[str, Any], filepath: str, ) -> dict[str, Optional[str]]: + """Prepare workfile event data. + + Args: + project_name (str): Name of the project where workfile lives. + folder_entity (dict[str, Any]): Folder entity. + task_entity (dict[str, Any]): Task entity. + filepath (str): Path to the workfile. + + Returns: + dict[str, Optional[str]]: Data for workfile event. + + """ workdir, filename = os.path.split(filepath) return { "project_name": project_name, @@ -1183,6 +1241,17 @@ class IWorkfileHost: event_data: dict[str, Optional[str]], after_open: bool = True, ) -> None: + """Emit workfile save event. + + Emit event before and after workfile is opened. + + Other addons can listen to this event and do additional steps. + + Args: + event_data (dict[str, Optional[str]]): Prepare event data. + after_open (bool): Emit event after workfile is opened. + + """ topics = [] topic_end = "before" if after_open: @@ -1198,11 +1267,22 @@ class IWorkfileHost: def _emit_workfile_save_event( self, event_data: dict[str, Optional[str]], - after_open: bool = True, + after_save: bool = True, ) -> None: + """Emit workfile save event. + + Emit event before and after workfile is saved or copied. + + Other addons can listen to this event and do additional steps. + + Args: + event_data (dict[str, Optional[str]]): Prepare event data. + after_save (bool): Emit event after workfile is saved. + + """ topics = [] topic_end = "before" - if after_open: + if after_save: topics.append("workfile.saved") topic_end = "after" From 397bfd23ebc865d74016b1e63bb27f1cebaf6fde Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 18:04:00 +0200 Subject: [PATCH 090/170] added deprecation warnings --- client/ayon_core/host/interfaces/workfiles.py | 35 ++++++++++++++++--- 1 file changed, 31 insertions(+), 4 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index d5f17b9acb..b300adc308 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -4,6 +4,8 @@ import os import platform import shutil import typing +import warnings +import functools from abc import abstractmethod from dataclasses import dataclass, asdict from typing import Optional, Any @@ -21,6 +23,26 @@ WORKFILE_OPEN_REASON = "workfile.opened" WORKFILE_SAVE_REASON = "workfile.saved" +def deprecated(reason): + def decorator(func): + message = f"Call to deprecated function {func.__name__} ({reason})." + + @functools.wraps(func) + def new_func(*args, **kwargs): + warnings.simplefilter("always", DeprecationWarning) + warnings.warn( + message, + category=DeprecationWarning, + stacklevel=2 + ) + warnings.simplefilter("default", DeprecationWarning) + return func(*args, **kwargs) + + return new_func + + return decorator + + @dataclass class WorkfileOpenData: filepath: str @@ -876,6 +898,7 @@ class IWorkfileHost: ) # --- Deprecated method names --- + @deprecated("Use 'get_workfile_extensions' instead") def file_extensions(self): """Deprecated variant of 'get_workfile_extensions'. @@ -885,40 +908,44 @@ class IWorkfileHost: """ return self.get_workfile_extensions() + @deprecated("Use 'save_workfile' instead") def save_file(self, dst_path=None): """Deprecated variant of 'save_workfile'. Todo: - Remove when all usages are replaced. + Remove when all usages are replaced """ self.save_workfile(dst_path) + @deprecated("Use 'open_workfile' instead") def open_file(self, filepath): """Deprecated variant of 'open_workfile'. Todo: Remove when all usages are replaced. - """ + """ return self.open_workfile(filepath) + @deprecated("Use 'get_current_workfile' instead") def current_file(self): """Deprecated variant of 'get_current_workfile'. Todo: Remove when all usages are replaced. - """ + """ return self.get_current_workfile() + @deprecated("Use 'workfile_has_unsaved_changes' instead") 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() def _fetch_published_workfile_entities( From 7eb067a99d917e761093180387805529d754d842 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 18:05:33 +0200 Subject: [PATCH 091/170] remove safe type hint --- client/ayon_core/host/host.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index 1c2885b7e6..ad6a805575 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -22,7 +22,7 @@ class ContextChangeData: folder_entity: dict[str, Any] task_entity: dict[str, Any] reason: Optional[str] - anatomy: "Anatomy" + anatomy: Anatomy class HostBase(ABC): @@ -167,7 +167,7 @@ class HostBase(ABC): *, reason: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, ) -> dict[str, Optional[str]]: """Set current context information. @@ -310,7 +310,7 @@ class HostBase(ABC): folder_entity: Optional[dict[str, Any]], task_entity: Optional[dict[str, Any]], reason: Optional[str], - anatomy: "Anatomy", + anatomy: Anatomy, ): """Method that changes the context in host. From a23678beb1c526b5185dca74dcb30137638d6901 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 18:07:36 +0200 Subject: [PATCH 092/170] use 'ContextChangeData' for '_set_current_context' --- client/ayon_core/host/host.py | 25 +++++++------------------ 1 file changed, 7 insertions(+), 18 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index ad6a805575..c7c2b30323 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -220,13 +220,7 @@ class HostBase(ABC): anatomy, ) self._before_context_change(context_change_data) - self._set_current_context( - project_entity, - folder_entity, - task_entity, - reason, - anatomy, - ) + self._set_current_context(context_change_data) self._after_context_change(context_change_data) return self._emit_context_change_event( @@ -305,13 +299,8 @@ class HostBase(ABC): return data def _set_current_context( - self, - project_entity: dict[str, Any], - folder_entity: Optional[dict[str, Any]], - task_entity: Optional[dict[str, Any]], - reason: Optional[str], - anatomy: Anatomy, - ): + self, context_change_data: ContextChangeData + ) -> None: """Method that changes the context in host. Can be overriden for hosts that do need different handling of context @@ -329,10 +318,10 @@ class HostBase(ABC): project_name = self.get_current_project_name() folder_path = None task_name = None - if folder_entity: - folder_path = folder_entity["path"] - if task_entity: - task_name = task_entity["name"] + if context_change_data.folder_entity: + folder_path = context_change_data.folder_entity["path"] + if context_change_data.task_entity: + task_name = context_change_data.task_entity["name"] envs = { "AYON_PROJECT_NAME": project_name, From 873db37794114f84a32250fe78431c446fe46038 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Fri, 6 Jun 2025 18:08:55 +0200 Subject: [PATCH 093/170] don't use safe typehint --- client/ayon_core/host/interfaces/workfiles.py | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index b300adc308..ce0c680f16 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -147,7 +147,7 @@ class WorkfileInfo: return asdict(self) @classmethod - def from_data(cls, data: dict[str, Any]) -> "WorkfileInfo": + def from_data(cls, data: dict[str, Any]) -> WorkfileInfo: """Converts data to workfile item. Args: @@ -328,7 +328,7 @@ class IWorkfileHost: workfile_entities: Optional[list[dict[str, Any]]] = None, project_settings: Optional[dict[str, Any]] = None, project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, ) -> None: """Save the current workfile with context. @@ -417,7 +417,7 @@ class IWorkfileHost: *, project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, ) -> None: """Open passed filepath in the host with context. @@ -476,7 +476,7 @@ class IWorkfileHost: workfile_entities: Optional[list[dict[str, Any]]] = None, template_key: Optional[str] = None, project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, ) -> list[WorkfileInfo]: """List workfiles in the given task. @@ -601,7 +601,7 @@ class IWorkfileHost: project_name: str, folder_id: str, *, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, version_entities: Optional[list[dict[str, Any]]] = None, repre_entities: Optional[list[dict[str, Any]]] = None, ) -> list[PublishedWorkfileInfo]: @@ -721,7 +721,7 @@ class IWorkfileHost: workfile_entities: Optional[list[dict[str, Any]]] = None, project_settings: Optional[dict[str, Any]] = None, project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, open_workfile: bool = True, ) -> None: """Save workfile path with target folder and task context. @@ -815,9 +815,9 @@ class IWorkfileHost: workfile_entities: Optional[list[dict[str, Any]]] = None, project_settings: Optional[dict[str, Any]] = None, project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, open_workfile: bool = True, - src_anatomy: Optional["Anatomy"] = None, + src_anatomy: Optional[Anatomy] = None, src_representation_path: Optional[str] = None, ) -> None: """Copy workfile representation. @@ -1025,7 +1025,7 @@ class IWorkfileHost: workfile_entities: Optional[list[dict[str, Any]]] = None, project_settings: Optional[dict[str, Any]] = None, project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + anatomy: Optional[Anatomy] = None, ) -> Optional[dict[str, Any]]: """Create of update workfile entity to AYON based on provided data. From 0bf1e9a9349e352af4bf22982159a6d4fd2b4d51 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 12 Jun 2025 11:42:21 +0200 Subject: [PATCH 094/170] add indentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Ondřej Samohel <33513211+antirotor@users.noreply.github.com> --- client/ayon_core/host/interfaces/workfiles.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index ce0c680f16..73f5c2ba37 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -610,9 +610,9 @@ class IWorkfileHost: The default implementation looks for products with the 'workfile' product type. - Pre-fetched entities have mandatory fields to be fetched. - - Version: 'id', 'author', 'taskId' - - Representation: 'id', 'versionId', 'files' + Pre-fetched entities have mandatory fields to be fetched: + - Version: 'id', 'author', 'taskId' + - Representation: 'id', 'versionId', 'files' Args: project_name (str): Project name. From e3114d85b8372d8b03e31920a1fa1aea2d77f8f9 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 12 Jun 2025 11:46:05 +0200 Subject: [PATCH 095/170] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Ondřej Samohel <33513211+antirotor@users.noreply.github.com> --- client/ayon_core/host/interfaces/workfiles.py | 6 +++--- client/ayon_core/pipeline/workfile/utils.py | 17 +++++++++-------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 73f5c2ba37..096f39a9f3 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -74,7 +74,7 @@ class WorkfileInfo: Attributes: filepath (str): Path to the workfile. - rootless_path (str): Path to the workfile without root. And without + rootless_path (str): Path to the workfile without the root. And without backslashes on Windows. file_size (Optional[float]): Size of the workfile in bytes. file_created (Optional[float]): Timestamp when the workfile was @@ -256,7 +256,7 @@ class IWorkfileHost: """ @abstractmethod - def save_workfile(self, dst_path: Optional[str] = None): + def save_workfile(self, dst_path: Optional[str] = None) -> None: """Save the currently opened scene. Args: @@ -267,7 +267,7 @@ class IWorkfileHost: pass @abstractmethod - def open_workfile(self, filepath: str): + def open_workfile(self, filepath: str) -> None: """Open passed filepath in the host. Args: diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 1a862d7d92..570d1a1259 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -247,14 +247,15 @@ def save_workfile_info( description, ) - data = {} - for key, value in ( - ("host_name", host_name), - ("version", version), - ("comment", comment), - ): - if value is not None: - data[key] = value + 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"] From 2e798f9ee2610dcfcbd8d7e5999f3ff969f4f2ce Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 16 Jun 2025 10:25:22 +0200 Subject: [PATCH 096/170] Apply suggestions from code review MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Ondřej Samohel <33513211+antirotor@users.noreply.github.com> --- client/ayon_core/host/host.py | 4 ++-- client/ayon_core/host/interfaces/workfiles.py | 14 +++++++------- client/ayon_core/pipeline/workfile/utils.py | 1 + 3 files changed, 10 insertions(+), 9 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index c7c2b30323..191f6d4f4b 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -342,7 +342,7 @@ class HostBase(ABC): This method is called before the context is changed in the host. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: context_change_data (ContextChangeData): Object with information @@ -356,7 +356,7 @@ class HostBase(ABC): This method is called after the context is changed in the host. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: context_change_data (ContextChangeData): Object with information diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 096f39a9f3..36a35f297a 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -822,7 +822,7 @@ class IWorkfileHost: ) -> None: """Copy workfile representation. - Use representation as source for the workfile. + Use representation as a source for the workfile. Arguments 'rootless_path', 'workfile_entities', 'project_entity' and 'anatomy' can be filled to enhance efficiency if you already @@ -1162,7 +1162,7 @@ class IWorkfileHost: This method is called before the workfile is opened in the host. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: open_workfile_data (WorkfileOpenData): Context and path of @@ -1178,7 +1178,7 @@ class IWorkfileHost: This method is called after the workfile is opened in the host. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: open_workfile_data (WorkfileOpenData): Context and path of @@ -1194,7 +1194,7 @@ class IWorkfileHost: This method is called before the workfile is saved in the host. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: save_workfile_data (WorkfileSaveData): Workfile path with target @@ -1210,7 +1210,7 @@ class IWorkfileHost: This method is called after the workfile is saved in the host. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: save_workfile_data (WorkfileSaveData): Workfile path with target @@ -1232,7 +1232,7 @@ class IWorkfileHost: This method is called before the workfile is copied by host integration. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: copy_workfile_data (WorkfileCopyData): Source and destination @@ -1249,7 +1249,7 @@ class IWorkfileHost: This method is called after the workfile is copied by host integration. - Can be overriden to implement host specific logic. + Can be overridden to implement host specific logic. Args: copy_workfile_data (WorkfileCopyData): Source and destination diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 570d1a1259..d3c30d932a 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -200,6 +200,7 @@ def save_workfile_info( workfile_entities: Optional[list[dict[str, Any]]] = None, ) -> dict[str, Any]: """Save workfile info entity for a workfile path. + Args: project_name (str): The name of the project. task_id (str): Task id under which is workfile created. From 34d9289f3c88861242fe79cbbec1239d55787ebb Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 16 Jun 2025 14:42:04 +0200 Subject: [PATCH 097/170] remove invalid returns typehints --- client/ayon_core/pipeline/workfile/utils.py | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index d3c30d932a..87aa06fb87 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -334,7 +334,7 @@ def save_current_workfile_to( project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, -): +) -> None: """Save current workfile to new location or context. Args: @@ -355,9 +355,6 @@ def save_current_workfile_to( anatomy (Optional[Anatomy]): Project anatomy used for rootless path calculation. - Returns: - dict[str, Any]: Workfile info entity. - """ from ayon_core.pipeline.context_tools import registered_host @@ -392,7 +389,7 @@ def copy_and_open_workfile( project_entity: Optional[dict[str, Any]] = None, project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, -): +) -> None: """Copy workfile to new location and open it. Args: @@ -414,9 +411,6 @@ def copy_and_open_workfile( anatomy (Optional[Anatomy]): Project anatomy used for rootless path calculation. - Returns: - dict[str, Any]: Workfile info entity. - """ from ayon_core.pipeline.context_tools import registered_host @@ -456,7 +450,7 @@ def copy_and_open_workfile_representation( project_settings: Optional[dict[str, Any]] = None, anatomy: Optional["Anatomy"] = None, src_anatomy: Optional["Anatomy"] = None, -): +) -> None: """Copy workfile to new location and open it. Args: @@ -483,9 +477,6 @@ def copy_and_open_workfile_representation( anatomy (Optional[Anatomy]): Project anatomy used for rootless path calculation. - Returns: - dict[str, Any]: Workfile info entity. - """ from ayon_core.pipeline.context_tools import registered_host From 09858f61e1ceedbf90b400434f211b37d2233517 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 16 Jun 2025 14:48:37 +0200 Subject: [PATCH 098/170] added typeddict for context data --- client/ayon_core/host/host.py | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index 191f6d4f4b..c957f4ee22 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -15,6 +15,13 @@ from ayon_core.lib import emit_event if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy + from typing import TypedDict + + class HostContextData(TypedDict): + project_name: str + folder_path: Optional[str] + task_name: Optional[str] + @dataclass class ContextChangeData: @@ -141,7 +148,7 @@ class HostBase(ABC): return os.environ.get("AYON_TASK_NAME") - def get_current_context(self) -> dict[str, Optional[str]]: + def get_current_context(self) -> "HostContextData": """Get current context information. This method should be used to get current context of host. Usage of @@ -168,7 +175,7 @@ class HostBase(ABC): reason: Optional[str] = None, project_entity: Optional[dict[str, Any]] = None, anatomy: Optional[Anatomy] = None, - ) -> dict[str, Optional[str]]: + ) -> "HostContextData": """Set current context information. This method should be used to set current context of host. Usage of @@ -281,7 +288,7 @@ class HostBase(ABC): project_name: str, folder_path: Optional[str], task_name: Optional[str], - ): + ) -> "HostContextData": """Emit context change event. Args: @@ -289,6 +296,9 @@ class HostBase(ABC): folder_path (Optional[str]): Path of the folder. task_name (Optional[str]): Name of the task. + Returns: + HostContextData: Data send to context change event. + """ data = { "project_name": project_name, From 76665860174d97715ef352b6111229f62d24e101 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 17 Jun 2025 13:45:30 +0200 Subject: [PATCH 099/170] use kwargs --- client/ayon_core/host/interfaces/workfiles.py | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 36a35f297a..6b11c2fce6 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -107,6 +107,7 @@ class WorkfileInfo: cls, filepath: str, rootless_path: str, + *, available: bool, workfile_entity: dict[str, Any], ): @@ -202,6 +203,7 @@ class PublishedWorkfileInfo: folder_id: str, task_id: Optional[str], repre_entity: dict[str, Any], + *, filepath: str, author: str, available: bool, @@ -696,12 +698,12 @@ class IWorkfileHost: folder_id, task_id, repre_entity, - workfile_path, - version_entity["author"], - is_available, - file_size, - file_created, - file_modified, + filepath=workfile_path, + author=version_entity["author"], + available=is_available, + file_size=file_size, + file_created=file_created, + file_modified=file_modified, ) items.append(workfile_item) From 0ae72c8e46a2a0aeedb171cdac1abed96f35bcea Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 17 Jun 2025 13:52:28 +0200 Subject: [PATCH 100/170] small enhancmement of docstring --- client/ayon_core/pipeline/workfile/path_resolving.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index a177caf7a4..4f100a219e 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -432,7 +432,8 @@ def get_last_workfile( full_path (bool): Return full path to the file or only filename. Returns: - str: Last or first workfile as filename of full path to filename. + str: Last or first workfile file name or path based on + 'full_path' value. """ # TODO (iLLiCiTiT): Remove the argument 'full_path' and return only full From 48bc7a0769fb6fb19b5696652387653b55279056 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 17 Jun 2025 13:53:28 +0200 Subject: [PATCH 101/170] small clarity enhancement --- client/ayon_core/pipeline/workfile/path_resolving.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 4f100a219e..4e4c70a27c 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -420,9 +420,9 @@ def get_last_workfile( extensions: set[str], full_path: bool = False, ) -> str: - """Return last workfile filename. + """Return last the workfile filename. - Returns file with version 1 if there is not workfile yet. + Returns first file name/path if there are not workfiles yet. Args: workdir (str): Path to dir where workfiles are stored. From 8b35eb38492d21bb00d969164c828f7b8f8c8a0c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 18 Jun 2025 16:29:59 +0200 Subject: [PATCH 102/170] fix kwargs --- client/ayon_core/pipeline/workfile/utils.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 87aa06fb87..3a04424ee4 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -364,9 +364,9 @@ def save_current_workfile_to( workfile_path, folder_entity, task_entity, - version, - comment, - description, + version=version, + comment=comment, + description=description, rootless_path=rootless_path, workfile_entities=workfile_entities, project_entity=project_entity, From 3e5e873ad07afba9ebe9955e552be1936d04ef75 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 18 Jun 2025 16:49:16 +0200 Subject: [PATCH 103/170] added helper function to save current file with current context --- client/ayon_core/pipeline/workfile/utils.py | 65 ++++++++++++++++++++- 1 file changed, 64 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 3a04424ee4..f64f68850b 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -358,7 +358,6 @@ def save_current_workfile_to( """ from ayon_core.pipeline.context_tools import registered_host - # Trigger before save event host = registered_host() host.save_workfile_with_context( workfile_path, @@ -375,6 +374,70 @@ def save_current_workfile_to( ) +def save_workfile_with_current_context( + workfile_path: str, + *, + version: Optional[int] = None, + comment: Optional[str] = None, + description: Optional[str] = None, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + project_entity: Optional[dict[str, Any]] = None, + project_settings: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, +) -> None: + """Save current workfile to new location using current context. + + Helper function to save workfile using current context. Calls + 'save_current_workfile_to' at the end. + + Args: + workfile_path (str): Destination workfile path. + version (Optional[int]): Workfile version. + comment (optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + rootless_path (Optional[str]): Rootless path of the workfile. Is + calculated if not passed in. + workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched + workfile entities related to the task. + project_entity (Optional[dict[str, Any]]): Project entity used for + rootless path calculation. + project_settings (Optional[dict[str, Any]]): Project settings used for + rootless path calculation. + anatomy (Optional[Anatomy]): Project anatomy used for rootless + path calculation. + + """ + from ayon_core.pipeline.context_tools import registered_host + + host = registered_host() + context = host.get_current_context() + project_name = context["project_name"] + folder_path = context["folder_path"] + task_name = context["task_name"] + folder_entity = task_entity = None + if folder_path: + folder_entity = ayon_api.get_folder_by_path(project_name, folder_path) + if folder_entity and task_name: + task_entity = ayon_api.get_task_by_name( + project_name, folder_entity["id"], task_name + ) + + save_current_workfile_to( + workfile_path, + folder_entity, + task_entity, + version=version, + comment=comment, + description=description, + rootless_path=rootless_path, + workfile_entities=workfile_entities, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, + ) + + def copy_and_open_workfile( src_workfile_path: str, workfile_path: str, From ab363bf77eab85fee7593a719c3853c94d63c3d9 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 23 Jun 2025 17:10:23 +0200 Subject: [PATCH 104/170] remove typehint --- client/ayon_core/host/host.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index c957f4ee22..d562fcbe65 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -124,7 +124,7 @@ class HostBase(ABC): pass - def get_current_project_name(self) -> str: + def get_current_project_name(self): """ Returns: Union[str, None]: Current project name. From 1e7c9db988434bb2b27e7a73b1a4af102497b576 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 26 Jun 2025 09:25:20 +0200 Subject: [PATCH 105/170] define context change reason enum --- client/ayon_core/host/__init__.py | 3 +++ client/ayon_core/host/constants.py | 15 +++++++++++++++ client/ayon_core/host/host.py | 8 +++++--- client/ayon_core/host/interfaces/workfiles.py | 9 +++------ 4 files changed, 26 insertions(+), 9 deletions(-) create mode 100644 client/ayon_core/host/constants.py diff --git a/client/ayon_core/host/__init__.py b/client/ayon_core/host/__init__.py index b252b03d76..ef5c324028 100644 --- a/client/ayon_core/host/__init__.py +++ b/client/ayon_core/host/__init__.py @@ -1,3 +1,4 @@ +from .constants import ContextChangeReason from .host import ( HostBase, ) @@ -15,6 +16,8 @@ from .dirmap import HostDirmap __all__ = ( + "ContextChangeReason", + "HostBase", "IWorkfileHost", diff --git a/client/ayon_core/host/constants.py b/client/ayon_core/host/constants.py new file mode 100644 index 0000000000..2564c5d54d --- /dev/null +++ b/client/ayon_core/host/constants.py @@ -0,0 +1,15 @@ +from enum import Enum + + +class StrEnum(str, Enum): + """A string-based Enum class that allows for string comparison.""" + + def __str__(self) -> str: + return self.value + + +class ContextChangeReason(StrEnum): + """Reasons for context change in the host.""" + undefined = "undefined" + workfile_open = "workfile.opened" + workfile_save = "workfile.saved" diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index d562fcbe65..554b694240 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -12,6 +12,8 @@ import ayon_api from ayon_core.lib import emit_event +from .constants import ContextChangeReason + if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy @@ -28,7 +30,7 @@ class ContextChangeData: project_entity: dict[str, Any] folder_entity: dict[str, Any] task_entity: dict[str, Any] - reason: Optional[str] + reason: ContextChangeReason anatomy: Anatomy @@ -172,7 +174,7 @@ class HostBase(ABC): folder_entity: dict[str, Any], task_entity: dict[str, Any], *, - reason: Optional[str] = None, + reason: ContextChangeReason = ContextChangeReason.undefined, project_entity: Optional[dict[str, Any]] = None, anatomy: Optional[Anatomy] = None, ) -> "HostContextData": @@ -190,7 +192,7 @@ class HostBase(ABC): Args: folder_entity (Optional[dict[str, Any]]): Folder entity. task_entity (Optional[dict[str, Any]]): Task entity. - reason (Optional[str]): Reason for context change. + reason (ContextChangeReason): Reason for context change. project_entity (Optional[dict[str, Any]]): Project entity data. anatomy (Optional[Anatomy]): Anatomy instance for the project. diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 6b11c2fce6..559660a6e9 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -14,15 +14,12 @@ import ayon_api import arrow from ayon_core.lib import emit_event +from ayon_core.host.constants import ContextChangeReason if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy -WORKFILE_OPEN_REASON = "workfile.opened" -WORKFILE_SAVE_REASON = "workfile.saved" - - def deprecated(reason): def decorator(func): message = f"Call to deprecated function {func.__name__} ({reason})." @@ -388,9 +385,9 @@ class IWorkfileHost: self.set_current_context( folder_entity, task_entity, - reason=WORKFILE_SAVE_REASON, project_entity=project_entity, anatomy=anatomy, + reason=ContextChangeReason.workfile_save, ) self.save_workfile(filepath) @@ -458,9 +455,9 @@ class IWorkfileHost: self.set_current_context( folder_entity, task_entity, - reason=WORKFILE_OPEN_REASON, project_entity=project_entity, anatomy=anatomy, + reason=ContextChangeReason.workfile_open, ) self.open_workfile(filepath) From 1d40243df5325cf639bbdc12b5a0f3d0adfd33ba Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 26 Jun 2025 09:25:26 +0200 Subject: [PATCH 106/170] fix typehint --- client/ayon_core/host/host.py | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/host/host.py b/client/ayon_core/host/host.py index 554b694240..7fc4b19bdd 100644 --- a/client/ayon_core/host/host.py +++ b/client/ayon_core/host/host.py @@ -319,12 +319,8 @@ class HostBase(ABC): than using environment variables. Args: - project_entity (dict[str, Any]): Project entity. - folder_entity (dict[str, Any]): Folder entity of new context. - task_entity (dict[str, Any]): Task entity of new context. - reason (Optional[str]): Reason why change happened. Currently - known reasons are that workfile is being opened or saved. - anatomy (Anatomy): Project anatomy. + context_change_data (ContextChangeData): Context change related + data. """ project_name = self.get_current_project_name() From 646f3bedd4a786caf6e2fda7d812dce270966fb1 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 26 Jun 2025 10:18:38 +0200 Subject: [PATCH 107/170] wrap optional arguments into wrappers --- client/ayon_core/host/interfaces/__init__.py | 48 +- client/ayon_core/host/interfaces/workfiles.py | 1060 ++++++++++++----- client/ayon_core/pipeline/workfile/utils.py | 130 +- .../tools/workfiles/models/workfiles.py | 106 +- 4 files changed, 877 insertions(+), 467 deletions(-) diff --git a/client/ayon_core/host/interfaces/__init__.py b/client/ayon_core/host/interfaces/__init__.py index 379d8555fb..8f11ad4e2f 100644 --- a/client/ayon_core/host/interfaces/__init__.py +++ b/client/ayon_core/host/interfaces/__init__.py @@ -1,5 +1,30 @@ from .exceptions import MissingMethodsError -from .workfiles import IWorkfileHost, WorkfileInfo, PublishedWorkfileInfo +from .workfiles import ( + IWorkfileHost, + WorkfileInfo, + PublishedWorkfileInfo, + + OpenWorkfileOptionalData, + ListWorkfilesOptionalData, + ListPublishedWorkfilesOptionalData, + SaveWorkfileOptionalData, + CopyWorkfileOptionalData, + CopyPublishedWorkfileOptionalData, + + get_open_workfile_context, + get_list_workfiles_context, + get_list_published_workfiles_context, + get_save_workfile_context, + get_copy_workfile_context, + get_copy_repre_workfile_context, + + OpenWorkfileContext, + ListWorkfilesContext, + ListPublishedWorkfilesContext, + SaveWorkfileContext, + CopyWorkfileContext, + CopyPublishedWorkfileContext, +) from .interfaces import ( IPublishHost, INewPublisher, @@ -14,6 +39,27 @@ __all__ = ( "WorkfileInfo", "PublishedWorkfileInfo", + "OpenWorkfileOptionalData", + "ListWorkfilesOptionalData", + "ListPublishedWorkfilesOptionalData", + "SaveWorkfileOptionalData", + "CopyWorkfileOptionalData", + "CopyPublishedWorkfileOptionalData", + + "get_open_workfile_context", + "get_list_workfiles_context", + "get_list_published_workfiles_context", + "get_save_workfile_context", + "get_copy_workfile_context", + "get_copy_repre_workfile_context", + + "OpenWorkfileContext", + "ListWorkfilesContext", + "ListPublishedWorkfilesContext", + "SaveWorkfileContext", + "CopyWorkfileContext", + "CopyPublishedWorkfileContext", + "IPublishHost", "INewPublisher", "ILoadHost", diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 559660a6e9..8bc0b1cf85 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -14,6 +14,7 @@ import ayon_api import arrow from ayon_core.lib import emit_event +from ayon_core.settings import get_project_settings from ayon_core.host.constants import ContextChangeReason if typing.TYPE_CHECKING: @@ -40,29 +41,560 @@ def deprecated(reason): return decorator +# Wrappers for optional arguments that might change in future +class _WorkfileOptionalData: + """Base class for optional data used in workfile operations.""" + def __init__( + self, + *, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + project_settings: Optional[dict[str, Any]] = None, + **kwargs + ): + if kwargs: + cls_name = self.__class__.__name__ + keys = ", ".join(['"{}"'.format(k) for k in kwargs.keys()]) + warnings.warn( + f"Unknown keywords passed to {cls_name}: {keys}", + ) + + self.project_entity = project_entity + self.anatomy = anatomy + self.project_settings = project_settings + + def get_project_data( + self, project_name: str + ) -> tuple[dict[str, Any], "Anatomy", dict[str, Any]]: + from ayon_core.pipeline import Anatomy + + project_entity = self.project_entity + anatomy = self.anatomy + project_settings = self.project_settings + + if project_entity is None: + project_entity = ayon_api.get_project(project_name) + + if anatomy is None: + anatomy = Anatomy( + project_name, + project_entity=project_entity + ) + + if project_settings is None: + project_settings = get_project_settings(project_name) + return ( + project_entity, + anatomy, + project_settings, + ) + + +class OpenWorkfileOptionalData(_WorkfileOptionalData): + """Optional data for opening workfile.""" + data_version = 1 + + +class ListWorkfilesOptionalData(_WorkfileOptionalData): + """Optional data to list workfiles.""" + data_version = 1 + + def __init__( + self, + *, + template_key: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + **kwargs + ): + super().__init__(**kwargs) + self.template_key = template_key + self.workfile_entities = workfile_entities + + def get_template_key( + self, + project_name: str, + task_type: str, + host_name: str, + project_settings: dict[str, Any], + ) -> str: + from ayon_core.pipeline.workfile import get_workfile_template_key + + if self.template_key is not None: + return self.template_key + + return get_workfile_template_key( + project_name=project_name, + task_type=task_type, + host_name=host_name, + project_settings=project_settings, + ) + + def get_workfile_entities( + self, project_name: str, task_id: str + ) -> list[dict[str, Any]]: + """Fill workfile entities if not provided.""" + if self.workfile_entities is not None: + return self.workfile_entities + return list(ayon_api.get_workfiles_info( + project_name, task_ids=[task_id] + )) + + +class ListPublishedWorkfilesOptionalData(_WorkfileOptionalData): + """Optional data to list published workfiles.""" + data_version = 1 + + def __init__( + self, + *, + product_entities: Optional[list[dict[str, Any]]] = None, + version_entities: Optional[list[dict[str, Any]]] = None, + repre_entities: Optional[list[dict[str, Any]]] = None, + **kwargs + ): + super().__init__(**kwargs) + + self.product_entities = product_entities + self.version_entities = version_entities + self.repre_entities = repre_entities + + def get_entities( + self, + project_name: str, + folder_id: str, + ) -> tuple[ + list[dict[str, Any]], + list[dict[str, Any]], + list[dict[str, Any]] + ]: + product_entities = self.product_entities + if product_entities is None: + product_entities = list(ayon_api.get_products( + project_name, + folder_ids={folder_id}, + product_types={"workfile"}, + fields={"id", "name"}, + )) + + version_entities = self.version_entities + if version_entities is None: + product_ids = {p["id"] for p in product_entities} + version_entities = list(ayon_api.get_versions( + project_name, + product_ids=product_ids, + task_ids=task_filters, + fields={"id", "author", "taskId"}, + )) + + repre_entities = self.repre_entities + if repre_entities is None: + version_ids = {v["id"] for v in version_entities} + repre_entities = list(ayon_api.get_representations( + project_name, + version_ids=version_ids, + )) + return product_entities, version_entities, repre_entities + + +class SaveWorkfileOptionalData(_WorkfileOptionalData): + """Optional data to save workfile.""" + data_version = 1 + + def __init__( + self, + *, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, + **kwargs + ): + super().__init__(**kwargs) + + self.rootless_path = rootless_path + self.workfile_entities = workfile_entities + + def get_workfile_entities(self, project_name: str, task_id: str): + """Fill workfile entities if not provided.""" + if self.workfile_entities is not None: + return self.workfile_entities + return list(ayon_api.get_workfiles_info( + project_name, task_ids=[task_id] + )) + + def get_rootless_path( + self, + workfile_path: str, + project_name: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + host_name: str, + project_entity: dict[str, Any], + project_settings: dict[str, Any], + anatomy: "Anatomy", + ): + from ayon_core.pipeline.workfile.utils import ( + find_workfile_rootless_path + ) + + if self.rootless_path is not None: + return self.rootless_path + + return find_workfile_rootless_path( + workfile_path, + project_name, + folder_entity, + task_entity, + host_name, + project_entity=project_entity, + project_settings=project_settings, + anatomy=anatomy, + ) + + +class CopyWorkfileOptionalData(SaveWorkfileOptionalData): + """Optional data to copy workfile.""" + data_version = 1 + + +class CopyPublishedWorkfileOptionalData(SaveWorkfileOptionalData): + """Optional data to copy published workfile.""" + data_version = 1 + + def __init__( + self, + src_anatomy: Optional["Anatomy"] = None, + src_representation_path: Optional[str] = None, + **kwargs + ): + super().__init__(**kwargs) + self.src_anatomy = src_anatomy + self.src_representation_path = src_representation_path + + def get_source_data( + self, + current_anatomy: Optional["Anatomy"], + project_name: str, + representation_entity: dict[str, Any], + ) -> tuple["Anatomy", str]: + from ayon_core.pipeline import Anatomy + from ayon_core.pipeline.load import ( + get_representation_path_with_anatomy + ) + + src_anatomy = self.src_anatomy + + if ( + src_anatomy is None + and current_anatomy is not None + and current_anatomy.project_name == project_name + ): + src_anatomy = current_anatomy + else: + src_anatomy = Anatomy(project_name) + + repre_path = self.src_representation_path + if repre_path is None: + repre_path = get_representation_path_with_anatomy( + representation_entity, + src_anatomy, + ) + return src_anatomy, repre_path + + +# Dataclasses used during workfile operations @dataclass -class WorkfileOpenData: +class OpenWorkfileContext: + data_version: int + project_name: str filepath: str + project_entity: dict[str, Any] folder_entity: dict[str, Any] task_entity: dict[str, Any] + anatomy: "Anatomy" + project_settings: dict[str, Any] @dataclass -class WorkfileSaveData(WorkfileOpenData): - filepath: str +class ListWorkfilesContext: + data_version: int + project_name: str + project_entity: dict[str, Any] folder_entity: dict[str, Any] task_entity: dict[str, Any] + anatomy: "Anatomy" + project_settings: dict[str, Any] + template_key: str + workfile_entities: list[dict[str, Any]] @dataclass -class WorkfileCopyData: - source_path: str - destination_path: str +class ListPublishedWorkfilesContext: + data_version: int + project_name: str + project_entity: dict[str, Any] + folder_id: str + anatomy: "Anatomy" + project_settings: dict[str, Any] + product_entities: list[dict[str, Any]] + version_entities: list[dict[str, Any]] + repre_entities: list[dict[str, Any]] + + +@dataclass +class SaveWorkfileContext: + data_version: int + project_name: str + project_entity: dict[str, Any] folder_entity: dict[str, Any] task_entity: dict[str, Any] + anatomy: "Anatomy" + project_settings: dict[str, Any] + dst_path: str + rootless_path: str + workfile_entities: list[dict[str, Any]] + + +@dataclass +class CopyWorkfileContext(SaveWorkfileContext): + src_path: str + version: Optional[int] + comment: Optional[str] + description: Optional[str] open_workfile: bool +@dataclass +class CopyPublishedWorkfileContext(CopyWorkfileContext): + src_project_name: str + src_representation_entity: dict[str, Any] + src_anatomy: "Anatomy" + + +def get_open_workfile_context( + project_name: str, + filepath: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + prepared_data: Optional[OpenWorkfileOptionalData], +) -> OpenWorkfileContext: + if prepared_data is None: + prepared_data = OpenWorkfileOptionalData() + ( + project_entity, anatomy, project_settings + ) = prepared_data.get_project_data(project_name) + return OpenWorkfileContext( + data_version=prepared_data.data_version, + filepath=filepath, + folder_entity=folder_entity, + task_entity=task_entity, + project_name=project_name, + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + ) + + +def get_list_workfiles_context( + project_name: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + host_name: str, + prepared_data: Optional[ListWorkfilesOptionalData], +) -> ListWorkfilesContext: + if prepared_data is None: + prepared_data = ListWorkfilesOptionalData() + ( + project_entity, anatomy, project_settings + ) = prepared_data.get_project_data(project_name) + + template_key = prepared_data.get_template_key( + project_name, + task_entity["taskType"], + host_name, + project_settings, + ) + workfile_entities = prepared_data.get_workfile_entities( + project_name, task_entity["id"] + ) + return ListWorkfilesContext( + data_version=prepared_data.data_version, + project_entity=project_entity, + folder_entity=folder_entity, + task_entity=task_entity, + project_name=project_name, + anatomy=anatomy, + project_settings=project_settings, + template_key=template_key, + workfile_entities=workfile_entities, + ) + + +def get_list_published_workfiles_context( + project_name: str, + folder_id: str, + prepared_data: Optional[ListPublishedWorkfilesOptionalData], +) -> ListPublishedWorkfilesContext: + if prepared_data is None: + prepared_data = ListPublishedWorkfilesOptionalData() + ( + project_entity, anatomy, project_settings + ) = prepared_data.get_project_data(project_name) + ( + product_entities, + version_entities, + repre_entities, + ) = prepared_data.get_entities(project_name, folder_id) + + + return ListPublishedWorkfilesContext( + data_version=prepared_data.data_version, + project_name=project_name, + project_entity=project_entity, + folder_id=folder_id, + anatomy=anatomy, + project_settings=project_settings, + product_entities=product_entities, + version_entities=version_entities, + repre_entities=repre_entities, + ) + + +def get_save_workfile_context( + project_name: str, + filepath: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + host_name: str, + prepared_data: Optional[SaveWorkfileOptionalData], +) -> SaveWorkfileContext: + if prepared_data is None: + prepared_data = SaveWorkfileOptionalData() + + ( + project_entity, anatomy, project_settings + ) = prepared_data.get_project_data(project_name) + + rootless_path = prepared_data.get_rootless_path( + filepath, + project_name, + folder_entity, + task_entity, + host_name, + project_entity, + project_settings, + anatomy, + ) + workfile_entities = prepared_data.get_workfile_entities( + project_name, task_entity["id"] + ) + return SaveWorkfileContext( + data_version=prepared_data.data_version, + project_name=project_name, + project_entity=project_entity, + folder_entity=folder_entity, + task_entity=task_entity, + anatomy=anatomy, + project_settings=project_settings, + dst_path=filepath, + rootless_path=rootless_path, + workfile_entities=workfile_entities, + ) + + +def get_copy_workfile_context( + project_name: str, + src_path: str, + dst_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + *, + version: Optional[int], + comment: Optional[str], + description: Optional[str], + open_workfile: bool, + host_name: str, + prepared_data: Optional[CopyWorkfileOptionalData], +) -> CopyWorkfileContext: + if prepared_data is None: + prepared_data = CopyWorkfileOptionalData() + context: SaveWorkfileContext = get_save_workfile_context( + project_name, + dst_path, + folder_entity, + task_entity, + host_name, + prepared_data, + ) + return CopyWorkfileContext( + data_version=prepared_data.data_version, + src_path=src_path, + project_name=context.project_name, + project_entity=context.project_entity, + folder_entity=context.folder_entity, + task_entity=context.task_entity, + version=version, + comment=comment, + description=description, + open_workfile=open_workfile, + anatomy=context.anatomy, + project_settings=context.project_settings, + dst_path=context.dst_path, + rootless_path=context.rootless_path, + workfile_entities=context.workfile_entities, + ) + + +def get_copy_repre_workfile_context( + project_name: str, + src_project_name: str, + src_representation_entity: dict[str, Any], + dst_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + version: Optional[int], + comment: Optional[str], + description: Optional[str], + open_workfile: bool, + host_name: str, + prepared_data: Optional[CopyPublishedWorkfileOptionalData], +) -> CopyPublishedWorkfileContext: + if prepared_data is None: + prepared_data = CopyPublishedWorkfileOptionalData() + + context: SaveWorkfileContext = get_save_workfile_context( + project_name, + dst_path, + folder_entity, + task_entity, + host_name, + prepared_data, + ) + src_anatomy, repre_path = prepared_data.get_source_data( + context.anatomy, + src_project_name, + src_representation_entity, + ) + return CopyPublishedWorkfileContext( + data_version=prepared_data.data_version, + src_project_name=src_project_name, + src_representation_entity=src_representation_entity, + src_path=repre_path, + dst_path=context.dst_path, + project_name=context.project_name, + project_entity=context.project_entity, + folder_entity=context.folder_entity, + task_entity=context.task_entity, + version=version, + comment=comment, + description=description, + open_workfile=open_workfile, + anatomy=context.anatomy, + project_settings=context.project_settings, + rootless_path=context.rootless_path, + workfile_entities=context.workfile_entities, + src_anatomy=src_anatomy, + ) + + @dataclass class WorkfileInfo: """Information about workfile. @@ -323,11 +855,7 @@ class IWorkfileHost: version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - rootless_path: Optional[str] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_settings: Optional[dict[str, Any]] = None, - project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional[Anatomy] = None, + prepared_data: Optional[SaveWorkfileOptionalData] = None, ) -> None: """Save the current workfile with context. @@ -350,22 +878,21 @@ class IWorkfileHost: comment (Optional[str]): Comment for the workfile. Usually used in the filename template. description (Optional[str]): Artist note for the workfile entity. - rootless_path (Optional[str]): Prepared rootless path of - the workfile. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities for the task. - project_settings (Optional[dict[str, Any]]): Project settings. - project_entity (Optional[dict[str, Any]]): Project entity. - anatomy (Optional[Anatomy]): Project anatomy. + prepared_data (Optional[SaveWorkfileOptionalData]): Prepared data + for speed enhancements. """ - save_workfile_data = WorkfileSaveData( - folder_entity=folder_entity, - task_entity=task_entity, - filepath=filepath, - ) - self._before_workfile_save(save_workfile_data) project_name = self.get_current_project_name() + save_workfile_context = get_save_workfile_context( + project_name, + filepath, + folder_entity, + task_entity, + host_name=self.name, + prepared_data=prepared_data, + ) + + self._before_workfile_save(save_workfile_context) event_data = self._get_workfile_event_data( project_name, folder_entity, @@ -379,33 +906,23 @@ class IWorkfileHost: # Set 'AYON_WORKDIR' environment variable os.environ["AYON_WORKDIR"] = workdir - if project_entity is None: - project_entity = ayon_api.get_project(project_name) - self.set_current_context( folder_entity, task_entity, - project_entity=project_entity, - anatomy=anatomy, reason=ContextChangeReason.workfile_save, + project_entity=save_workfile_context.project_entity, + anatomy=save_workfile_context.anatomy, ) self.save_workfile(filepath) self._save_workfile_entity( - filepath, - folder_entity, - task_entity, + save_workfile_context, version, comment, description, - rootless_path, - workfile_entities, - project_settings, - project_entity, - anatomy, ) - self._after_workfile_save(save_workfile_data) + self._after_workfile_save(save_workfile_context) self._emit_workfile_save_event(event_data) def open_workfile_with_context( @@ -414,9 +931,7 @@ class IWorkfileHost: folder_entity: dict[str, Any], task_entity: dict[str, Any], *, - project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional[Anatomy] = None, + prepared_data: Optional[OpenWorkfileOptionalData] = None, ) -> None: """Open passed filepath in the host with context. @@ -429,14 +944,21 @@ class IWorkfileHost: filepath (str): Path to workfile. folder_entity (dict[str, Any]): Folder id. task_entity (dict[str, Any]): Task id. - project_entity (Optional[dict[str, Any]]): Project entity. - project_settings (Optional[dict[str, Any]]): Project settings. - anatomy (Optional[Anatomy]): Project anatomy. + prepared_data (Optional[WorkfileOptionalData]): Prepared data + for speed enhancements. """ context = self.get_current_context() project_name = context["project_name"] + open_workfile_context = get_open_workfile_context( + project_name, + filepath, + folder_entity, + task_entity, + prepared_data=prepared_data, + ) + workdir = os.path.dirname(filepath) # Set 'AYON_WORKDIR' environment variable os.environ["AYON_WORKDIR"] = workdir @@ -444,25 +966,20 @@ class IWorkfileHost: event_data = self._get_workfile_event_data( project_name, folder_entity, task_entity, filepath ) - open_workfile_data = WorkfileOpenData( - folder_entity=folder_entity, - task_entity=task_entity, - filepath=filepath, - ) - self._before_workfile_open(open_workfile_data) + self._before_workfile_open(open_workfile_context) self._emit_workfile_open_event(event_data, after_open=False) self.set_current_context( folder_entity, task_entity, - project_entity=project_entity, - anatomy=anatomy, reason=ContextChangeReason.workfile_open, + project_entity=open_workfile_context.project_entity, + anatomy=open_workfile_context.anatomy, ) self.open_workfile(filepath) - self._after_workfile_open(open_workfile_data) + self._after_workfile_open(open_workfile_context) self._emit_workfile_open_event(event_data) def list_workfiles( @@ -471,11 +988,7 @@ class IWorkfileHost: folder_entity: dict[str, Any], task_entity: dict[str, Any], *, - project_entity: Optional[dict[str, Any]] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - template_key: Optional[str] = None, - project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional[Anatomy] = None, + prepared_data: Optional[ListWorkfilesOptionalData] = None, ) -> list[WorkfileInfo]: """List workfiles in the given task. @@ -492,18 +1005,13 @@ class IWorkfileHost: project_name (str): Project name. folder_entity (dict[str, Any]): Folder entity. task_entity (dict[str, Any]): Task entity. - project_entity (Optional[dict[str, Any]]): Project entity. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities for the task. - template_key (Optional[str]): Template key. - project_settings (Optional[dict[str, Any]]): Project settings. - anatomy (Anatomy): Project anatomy. + prepared_data (Optional[ListWorkfilesOptionalData]): Prepared + data for speed enhancements. Returns: list[WorkfileInfo]: List of workfiles. """ - from ayon_core.pipeline import Anatomy from ayon_core.pipeline.template_data import get_template_data from ayon_core.pipeline.workfile import get_workdir_with_workdir_data @@ -511,25 +1019,21 @@ class IWorkfileHost: if not extensions: return [] - if project_entity is None: - project_entity = ayon_api.get_project(project_name) - - if workfile_entities is None: - task_id = task_entity["id"] - workfile_entities = list(ayon_api.get_workfiles_info( - project_name, task_ids=[task_id] - )) - - if anatomy is None: - anatomy = Anatomy(project_name, project_entity=project_entity) + list_workfiles_context = get_list_workfiles_context( + project_name, + folder_entity, + task_entity, + host_name=self.name, + prepared_data=prepared_data, + ) workfile_entities_by_path = { workfile_entity["path"]: workfile_entity - for workfile_entity in workfile_entities + for workfile_entity in list_workfiles_context.workfile_entities } workdir_data = get_template_data( - project_entity, + list_workfiles_context.project_entity, folder_entity, task_entity, host_name=self.name, @@ -537,9 +1041,9 @@ class IWorkfileHost: workdir = get_workdir_with_workdir_data( workdir_data, project_name, - anatomy=anatomy, - template_key=template_key, - project_settings=project_settings, + anatomy=list_workfiles_context.anatomy, + template_key=list_workfiles_context.template_key, + project_settings=list_workfiles_context.project_settings, ) if platform.system().lower() == "windows": @@ -585,7 +1089,7 @@ class IWorkfileHost: ext = os.path.splitext(rootless_path)[1].lower() if ext not in extensions: continue - filepath = anatomy.fill_root(rootless_path) + filepath = prepared_data.anatomy.fill_root(rootless_path) items.append(WorkfileInfo.new( filepath, rootless_path, @@ -600,9 +1104,7 @@ class IWorkfileHost: project_name: str, folder_id: str, *, - anatomy: Optional[Anatomy] = None, - version_entities: Optional[list[dict[str, Any]]] = None, - repre_entities: Optional[list[dict[str, Any]]] = None, + prepared_data: Optional[ListPublishedWorkfilesOptionalData] = None, ) -> list[PublishedWorkfileInfo]: """List published workfiles for the given folder. @@ -616,45 +1118,32 @@ class IWorkfileHost: Args: project_name (str): Project name. folder_id (str): Folder id. - anatomy (Anatomy): Project anatomy. - version_entities (Optional[list[dict[str, Any]]]): Pre-fetched - version entities. - repre_entities (Optional[list[dict[str, Any]]]): Pre-fetched - representation entities. + prepared_data (Optional[ListPublishedWorkfilesOptionalData]): + Prepared data for speed enhancements. Returns: list[PublishedWorkfileInfo]: Published workfile information for the given context. """ - from ayon_core.pipeline import Anatomy - - # Get all representations of the folder - ( - version_entities, - repre_entities - ) = self._fetch_published_workfile_entities( + list_workfiles_context = get_list_published_workfiles_context( project_name, folder_id, - version_entities, - repre_entities, + prepared_data=prepared_data, ) - if not repre_entities: + if not list_workfiles_context.repre_entities: return [] - if anatomy is None: - anatomy = Anatomy(project_name) - versions_by_id = { version_entity["id"]: version_entity - for version_entity in version_entities + for version_entity in prepared_data.version_entities } extensions = { ext.lstrip(".") for ext in self.get_workfile_extensions() } items = [] - for repre_entity in repre_entities: + for repre_entity in prepared_data.repre_entities: version_id = repre_entity["versionId"] version_entity = versions_by_id[version_id] task_id = version_entity["taskId"] @@ -675,7 +1164,9 @@ class IWorkfileHost: continue try: - workfile_path = workfile_path.format(root=anatomy.roots) + workfile_path = workfile_path.format( + root=prepared_data.anatomy.roots + ) except Exception: self.log.warning( "Failed to format workfile path.", exc_info=True @@ -716,12 +1207,8 @@ class IWorkfileHost: version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - rootless_path: Optional[str] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_settings: Optional[dict[str, Any]] = None, - project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional[Anatomy] = None, open_workfile: bool = True, + prepared_data: Optional[CopyWorkfileOptionalData] = None, ) -> None: """Save workfile path with target folder and task context. @@ -744,59 +1231,31 @@ class IWorkfileHost: for workfile entity. Recommended to fill. comment (Optional[str]): Comment for the workfile. description (Optional[str]): Artist note for the workfile entity. - rootless_path (Optional[str]): Rootless path of the workfile. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities for the task. - project_settings (Optional[dict[str, Any]]): Project settings. - project_entity (Optional[dict[str, Any]]): Project entity. - anatomy (Optional[Anatomy]): Project anatomy. open_workfile (bool): Open workfile when copied. + prepared_data (Optional[CopyWorkfileOptionalData]): Prepared data + for speed enhancements. """ - copy_workfile_data = WorkfileCopyData( - source_path=src_path, - destination_path=dst_path, - folder_entity=folder_entity, - task_entity=task_entity, + project_name = self.get_current_project_name() + copy_workfile_context: CopyWorkfileContext = get_copy_workfile_context( + project_name, + src_path, + dst_path, + folder_entity, + task_entity, + version=version, + comment=comment, + description=description, open_workfile=open_workfile, + host_name=self.name, + prepared_data=prepared_data, ) - self._before_workfile_copy(copy_workfile_data) - event_data = self._get_workfile_event_data( - self.get_current_project_name(), - folder_entity, - task_entity, - dst_path, - ) - self._emit_workfile_save_event(event_data, after_save=False) - - dst_dir = os.path.dirname(dst_path) - if not os.path.exists(dst_dir): - os.makedirs(dst_dir, exist_ok=True) - shutil.copy(src_path, dst_path) - - self._save_workfile_entity( - dst_path, - folder_entity, - task_entity, - version, - comment, - description, - rootless_path, - workfile_entities, - project_settings, - project_entity, - anatomy, - ) - self._after_workfile_copy(copy_workfile_data) - self._emit_workfile_save_event(event_data) - - if not open_workfile: - return - - self.open_workfile_with_context( - dst_path, - folder_entity, - task_entity, + self._copy_workfile( + copy_workfile_context, + version=version, + comment=comment, + description=description, + open_workfile=open_workfile, ) def copy_workfile_representation( @@ -810,14 +1269,8 @@ class IWorkfileHost: version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - rootless_path: Optional[str] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_settings: Optional[dict[str, Any]] = None, - project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional[Anatomy] = None, open_workfile: bool = True, - src_anatomy: Optional[Anatomy] = None, - src_representation_path: Optional[str] = None, + prepared_data: Optional[CopyPublishedWorkfileOptionalData] = None, ) -> None: """Copy workfile representation. @@ -841,58 +1294,33 @@ class IWorkfileHost: for workfile entity. Recommended to fill. comment (Optional[str]): Comment for the workfile. description (Optional[str]): Artist note for the workfile entity. - rootless_path (Optional[str]): Rootless path of the workfile. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities for the task. - project_settings (Optional[dict[str, Any]]): Project settings. - project_entity (Optional[dict[str, Any]]): Project entity. - anatomy (Optional[Anatomy]): Project anatomy. open_workfile (bool): Open workfile when copied. - src_anatomy (Optional[Anatomy]): Anatomy of the source - src_representation_path (Optional[str]): Representation path. + prepared_data (Optional[CopyPublishedWorkfileOptionalData]): + Prepared data for speed enhancements. """ - from ayon_core.pipeline import Anatomy - from ayon_core.pipeline.load import ( - get_representation_path_with_anatomy - ) - project_name = self.get_current_project_name() - # Re-use Anatomy or project entity if source context is same - if project_name == src_project_name: - if src_anatomy is None and anatomy is not None: - src_anatomy = anatomy - elif anatomy is None and src_anatomy is not None: - anatomy = src_anatomy - elif not project_entity: - project_entity = ayon_api.get_project(project_name) - - if anatomy is None: - anatomy = src_anatomy = Anatomy( - project_name, project_entity=project_entity - ) - - if src_representation_path is None: - if src_anatomy is None: - src_anatomy = Anatomy(src_project_name) - src_representation_path = get_representation_path_with_anatomy( + copy_repre_workfile_context: CopyPublishedWorkfileContext = ( + get_copy_repre_workfile_context( + project_name, + src_project_name, src_representation_entity, - src_anatomy, + dst_path, + folder_entity, + task_entity, + version=version, + comment=comment, + description=description, + open_workfile=open_workfile, + host_name=self.name, + prepared_data=prepared_data, ) - - self.copy_workfile( - src_representation_path, - dst_path, - folder_entity, - task_entity, + ) + self._copy_workfile( + copy_repre_workfile_context, version=version, comment=comment, description=description, - rootless_path=rootless_path, - workfile_entities=workfile_entities, - project_settings=project_settings, - project_entity=project_entity, - anatomy=anatomy, open_workfile=open_workfile, ) @@ -947,109 +1375,94 @@ class IWorkfileHost: """ return self.workfile_has_unsaved_changes() - def _fetch_published_workfile_entities( + def _copy_workfile( self, - project_name: str, - folder_id: str, - version_entities: Optional[list[dict[str, Any]]], - repre_entities: Optional[list[dict[str, Any]]], - ) -> tuple[ - list[dict[str, Any]], - list[dict[str, Any]] - ]: - """Fetch integrated workfile entities for the given folder. - - Args: - project_name (str): Project name. - folder_id (str): Folder id. - version_entities (Optional[list[dict[str, Any]]]): Pre-fetched - version entities. - repre_entities (Optional[list[dict[str, Any]]]): Pre-fetched - representation entities. - - Returns: - tuple[list[dict[str, Any]], list[dict[str, Any]]]: - Tuple of version entities and representation entities. - - """ - if repre_entities is not None and version_entities is None: - # Get versions of representations - version_ids = {r["versionId"] for r in repre_entities} - version_entities = list(ayon_api.get_versions( - project_name, - version_ids=version_ids, - fields={"id", "author", "taskId"}, - )) - - if version_entities is None: - # Get product entities of folder - product_entities = ayon_api.get_products( - project_name, - folder_ids={folder_id}, - product_types={"workfile"}, - fields={"id", "name"} - ) - - version_entities = [] - product_ids = {product["id"] for product in product_entities} - if product_ids: - # Get version docs of products with their families - version_entities = list(ayon_api.get_versions( - project_name, - product_ids=product_ids, - fields={"id", "author", "taskId"}, - )) - - # Fetch representations of filtered versions and add filter for - # extension - if repre_entities is None: - repre_entities = [] - if version_entities: - repre_entities = list(ayon_api.get_representations( - project_name, - version_ids={v["id"] for v in version_entities} - )) - - return version_entities, repre_entities - - def _save_workfile_entity( - self, - workfile_path: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], + copy_workfile_context: CopyWorkfileContext, + *, + version: Optional[int], + comment: Optional[str], + description: Optional[str], + open_workfile: bool, + ) -> None: + """Save workfile path with target folder and task context. + + It is expected that workfile is saved to the current project, but + can be copied from the other project. + + Arguments 'rootless_path', 'workfile_entities', 'project_entity' + and 'anatomy' can be filled to enhance efficiency if you already + have access to the values. + + Argument 'project_settings' is used to calculate 'rootless_path' + if it is not provided. + + Args: + copy_workfile_context (CopyWorkfileContext): Prepared data + for speed enhancements. + version (Optional[int]): Version of the workfile. Information + for workfile entity. Recommended to fill. + comment (Optional[str]): Comment for the workfile. + description (Optional[str]): Artist note for the workfile entity. + open_workfile (bool): Open workfile when copied. + + """ + self._before_workfile_copy(copy_workfile_context) + event_data = self._get_workfile_event_data( + copy_workfile_context.project_name, + copy_workfile_context.folder_entity, + copy_workfile_context.task_entity, + copy_workfile_context.dst_path, + ) + self._emit_workfile_save_event(event_data, after_save=False) + + dst_dir = os.path.dirname(copy_workfile_context.dst_path) + if not os.path.exists(dst_dir): + os.makedirs(dst_dir, exist_ok=True) + shutil.copy( + copy_workfile_context.src_path, + copy_workfile_context.dst_path + ) + + self._save_workfile_entity( + copy_workfile_context, + version, + comment, + description, + ) + self._after_workfile_copy(copy_workfile_context) + self._emit_workfile_save_event(event_data) + + if not open_workfile: + return + + self.open_workfile_with_context( + copy_workfile_context.dst_path, + copy_workfile_context.folder_entity, + copy_workfile_context.task_entity, + ) + + def _save_workfile_entity( + self, + save_workfile_context: SaveWorkfileContext, version: Optional[int], comment: Optional[str], description: Optional[str], - rootless_path: Optional[str], - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_settings: Optional[dict[str, Any]] = None, - project_entity: Optional[dict[str, Any]] = None, - anatomy: Optional[Anatomy] = None, ) -> Optional[dict[str, Any]]: """Create of update workfile entity to AYON based on provided data. Args: - workfile_path (str): Path to the workfile. - folder_entity (dict[str, Any]): Folder entity. - task_entity (dict[str, Any]): Task entity. + save_workfile_context (SaveWorkfileContext): Save workfile + context with all prepared data. version (Optional[int]): Version of the workfile. comment (Optional[str]): Comment for the workfile. description (Optional[str]): Artist note for the workfile entity. - rootless_path (Optional[str]): Prepared rootless path of - the workfile. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities. - project_settings (Optional[dict[str, Any]]): Project settings. - project_entity (Optional[dict[str, Any]]): Project entity. - anatomy (Optional[Anatomy]): Project anatomy. Returns: Optional[dict[str, Any]]: Workfile entity. """ from ayon_core.pipeline.workfile.utils import ( - save_workfile_info, - find_workfile_rootless_path, + save_workfile_info ) project_name = self.get_current_project_name() @@ -1059,18 +1472,7 @@ class IWorkfileHost: if not comment: comment = None - if rootless_path is None: - rootless_path = find_workfile_rootless_path( - workfile_path, - project_name, - folder_entity, - task_entity, - self.name, - project_entity=project_entity, - project_settings=project_settings, - anatomy=anatomy, - ) - + rootless_path = save_workfile_context.rootless_path # It is not possible to create workfile infor without rootless path workfile_info = None if not rootless_path: @@ -1081,13 +1483,13 @@ class IWorkfileHost: workfile_info = save_workfile_info( project_name, - task_entity["id"], + save_workfile_context.task_entity["id"], rootless_path, self.name, version, comment, description, - workfile_entities=workfile_entities, + workfile_entities=save_workfile_context.workfile_entities, ) return workfile_info @@ -1155,7 +1557,7 @@ class IWorkfileHost: } def _before_workfile_open( - self, open_workfile_data: WorkfileOpenData + self, open_workfile_context: OpenWorkfileContext ) -> None: """Before workfile is opened. @@ -1164,14 +1566,14 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - open_workfile_data (WorkfileOpenData): Context and path of + open_workfile_context (OpenWorkfileContext): Context and path of workfile to open. """ pass def _after_workfile_open( - self, open_workfile_data: WorkfileOpenData + self, open_workfile_context: OpenWorkfileContext ) -> None: """After workfile is opened. @@ -1180,14 +1582,14 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - open_workfile_data (WorkfileOpenData): Context and path of + open_workfile_context (OpenWorkfileContext): Context and path of opened workfile. """ pass def _before_workfile_save( - self, save_workfile_data: WorkfileSaveData + self, save_workfile_context: SaveWorkfileContext ) -> None: """Before workfile is saved. @@ -1196,14 +1598,14 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - save_workfile_data (WorkfileSaveData): Workfile path with target + save_workfile_context (SaveWorkfileContext): Workfile path with target folder and task context. """ pass def _after_workfile_save( - self, save_workfile_data: WorkfileSaveData + self, save_workfile_context: SaveWorkfileContext ) -> None: """After workfile is saved. @@ -1212,19 +1614,19 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - save_workfile_data (WorkfileSaveData): Workfile path with target + save_workfile_context (SaveWorkfileContext): Workfile path with target folder and task context. """ - workdir = os.path.dirname(save_workfile_data.filepath) + workdir = os.path.dirname(save_workfile_context.dst_path) self._create_extra_folders( - save_workfile_data.folder_entity, - save_workfile_data.task_entity, + save_workfile_context.folder_entity, + save_workfile_context.task_entity, workdir ) def _before_workfile_copy( - self, copy_workfile_data: WorkfileCopyData + self, copy_workfile_context: CopyWorkfileContext ) -> None: """Before workfile is copied. @@ -1234,14 +1636,14 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - copy_workfile_data (WorkfileCopyData): Source and destination + copy_workfile_context (CopyWorkfileContext): Source and destination path with context before workfile is copied. """ pass def _after_workfile_copy( - self, copy_workfile_data: WorkfileCopyData + self, copy_workfile_context: CopyWorkfileContext ) -> None: """After workfile is copied. @@ -1251,14 +1653,14 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - copy_workfile_data (WorkfileCopyData): Source and destination + copy_workfile_context (CopyWorkfileContext): Source and destination path with context after workfile is copied. """ - workdir = os.path.dirname(copy_workfile_data.destination_path) + workdir = os.path.dirname(copy_workfile_context.dst_path) self._create_extra_folders( - copy_workfile_data.folder_entity, - copy_workfile_data.task_entity, + copy_workfile_context.folder_entity, + copy_workfile_context.task_entity, workdir, ) @@ -1271,6 +1673,8 @@ class IWorkfileHost: Emit event before and after workfile is opened. + This method is not meant to be overridden. + Other addons can listen to this event and do additional steps. Args: @@ -1299,6 +1703,8 @@ class IWorkfileHost: Emit event before and after workfile is saved or copied. + This method is not meant to be overridden. + Other addons can listen to this event and do additional steps. Args: diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index f64f68850b..f19c9933a0 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -10,6 +10,12 @@ from ayon_api.operations import OperationsSession from ayon_core.lib import filter_profiles, get_ayon_username from ayon_core.settings import get_project_settings +from ayon_core.host.interfaces import ( + SaveWorkfileOptionalData, + OpenWorkfileOptionalData, + CopyWorkfileOptionalData, + CopyPublishedWorkfileOptionalData, +) from .path_resolving import get_workfile_template_key @@ -303,9 +309,8 @@ def open_workfile( filepath: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], - project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + *, + prepared_data: Optional[OpenWorkfileOptionalData] = None, ): from ayon_core.pipeline.context_tools import registered_host @@ -315,9 +320,7 @@ def open_workfile( filepath, folder_entity, task_entity, - project_entity=project_entity, - project_settings=project_settings, - anatomy=anatomy, + prepared_data=prepared_data, ) @@ -329,11 +332,7 @@ def save_current_workfile_to( version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - rootless_path: Optional[str] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + prepared_data: Optional[SaveWorkfileOptionalData] = None, ) -> None: """Save current workfile to new location or context. @@ -344,16 +343,8 @@ def save_current_workfile_to( version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - rootless_path (Optional[str]): Rootless path of the workfile. Is - calculated if not passed in. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities related to the task. - project_entity (Optional[dict[str, Any]]): Project entity used for - rootless path calculation. - project_settings (Optional[dict[str, Any]]): Project settings used for - rootless path calculation. - anatomy (Optional[Anatomy]): Project anatomy used for rootless - path calculation. + prepared_data (Optional[SaveWorkfileOptionalData]): Prepared data + for speed enhancements. """ from ayon_core.pipeline.context_tools import registered_host @@ -366,11 +357,7 @@ def save_current_workfile_to( version=version, comment=comment, description=description, - rootless_path=rootless_path, - workfile_entities=workfile_entities, - project_entity=project_entity, - project_settings=project_settings, - anatomy=anatomy, + prepared_data=prepared_data, ) @@ -380,11 +367,7 @@ def save_workfile_with_current_context( version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - rootless_path: Optional[str] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + prepared_data: Optional[SaveWorkfileOptionalData] = None, ) -> None: """Save current workfile to new location using current context. @@ -396,16 +379,8 @@ def save_workfile_with_current_context( version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - rootless_path (Optional[str]): Rootless path of the workfile. Is - calculated if not passed in. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities related to the task. - project_entity (Optional[dict[str, Any]]): Project entity used for - rootless path calculation. - project_settings (Optional[dict[str, Any]]): Project settings used for - rootless path calculation. - anatomy (Optional[Anatomy]): Project anatomy used for rootless - path calculation. + prepared_data (Optional[SaveWorkfileOptionalData]): Prepared data + for speed enhancements. """ from ayon_core.pipeline.context_tools import registered_host @@ -430,11 +405,7 @@ def save_workfile_with_current_context( version=version, comment=comment, description=description, - rootless_path=rootless_path, - workfile_entities=workfile_entities, - project_entity=project_entity, - project_settings=project_settings, - anatomy=anatomy, + prepared_data=prepared_data, ) @@ -447,11 +418,7 @@ def copy_and_open_workfile( version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - rootless_path: Optional[str] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, + prepared_data: Optional[CopyWorkfileOptionalData] = None, ) -> None: """Copy workfile to new location and open it. @@ -463,16 +430,8 @@ def copy_and_open_workfile( version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - rootless_path (Optional[str]): Rootless path of the workfile. Is - calculated if not passed in. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities related to the task. - project_entity (Optional[dict[str, Any]]): Project entity used for - rootless path calculation. - project_settings (Optional[dict[str, Any]]): Project settings used for - rootless path calculation. - anatomy (Optional[Anatomy]): Project anatomy used for rootless - path calculation. + prepared_data (Optional[CopyWorkfileOptionalData]): Prepared data + for speed enhancements. """ from ayon_core.pipeline.context_tools import registered_host @@ -486,18 +445,14 @@ def copy_and_open_workfile( version=version, comment=comment, description=description, - rootless_path=rootless_path, - workfile_entities=workfile_entities, - project_entity=project_entity, - project_settings=project_settings, - anatomy=anatomy, open_workfile=True, + prepared_data=prepared_data, ) def copy_and_open_workfile_representation( src_project_name: str, - representation_id: str, + representation_entity: dict[str, Any], workfile_path: str, folder_entity: dict[str, Any], task_entity: dict[str, Any], @@ -505,50 +460,25 @@ def copy_and_open_workfile_representation( version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, - rootless_path: Optional[str] = None, - representation_entity: Optional[dict[str, Any]] = None, - representation_path: Optional[str] = None, - workfile_entities: Optional[list[dict[str, Any]]] = None, - project_entity: Optional[dict[str, Any]] = None, - project_settings: Optional[dict[str, Any]] = None, - anatomy: Optional["Anatomy"] = None, - src_anatomy: Optional["Anatomy"] = None, + prepared_data: Optional[CopyPublishedWorkfileOptionalData] = None, ) -> None: """Copy workfile to new location and open it. Args: src_project_name (str): Project name where representation is stored. - representation_id (str): Source representation id. + representation_entity (dict[str, Any]): Representation entity. workfile_path (str): Destination workfile path. folder_entity (dict[str, Any]): Target folder entity. task_entity (dict[str, Any]): Target task entity. version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - rootless_path (Optional[str]): Rootless path of the workfile. Is - calculated if not passed in. - representation_entity (Optional[dict[str, Any]]): Representation - entity. If not provided, it will be fetched from the server. - representation_path (Optional[str]): Path to the representation. - Calculated if not provided. - workfile_entities (Optional[list[dict[str, Any]]]): Pre-fetched - workfile entities related to the task. - project_entity (Optional[dict[str, Any]]): Project entity used for - rootless path calculation. - project_settings (Optional[dict[str, Any]]): Project settings used for - rootless path calculation. - anatomy (Optional[Anatomy]): Project anatomy used for rootless - path calculation. + prepared_data (Optional[CopyPublishedWorkfileOptionalData]): Prepared data + for speed enhancements. """ from ayon_core.pipeline.context_tools import registered_host - if representation_entity is None: - representation_entity = ayon_api.get_representation_by_id( - src_project_name, - representation_id, - ) - host = registered_host() host.copy_workfile_representation( src_project_name, @@ -559,14 +489,8 @@ def copy_and_open_workfile_representation( version=version, comment=comment, description=description, - rootless_path=rootless_path, - workfile_entities=workfile_entities, - project_settings=project_settings, - project_entity=project_entity, - anatomy=anatomy, - src_anatomy=src_anatomy, - src_representation_path=representation_path, open_workfile=open_workfile, + prepared_data=prepared_data, ) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 23521dc3f6..5e4e5db808 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -19,6 +19,14 @@ from ayon_core.host import ( WorkfileInfo, PublishedWorkfileInfo, ) +from ayon_core.host.interfaces import ( + OpenWorkfileOptionalData, + ListWorkfilesOptionalData, + ListPublishedWorkfilesOptionalData, + SaveWorkfileOptionalData, + CopyWorkfileOptionalData, + CopyPublishedWorkfileOptionalData, +) from ayon_core.pipeline.template_data import ( get_template_data, get_task_template_data, @@ -142,6 +150,7 @@ class WorkfilesModel: filepath = os.path.join(workdir, filename) rootless_path = f"{rootless_workdir}/{filename}" project_name = self._controller.get_current_project_name() + project_entity = self._controller.get_project_entity(project_name) folder_entity = self._controller.get_folder_entity( project_name, folder_id ) @@ -149,6 +158,13 @@ class WorkfilesModel: project_name, task_id ) + prepared_data = SaveWorkfileOptionalData( + project_entity=project_entity, + anatomy=self._controller.project_anatomy, + project_settings=self._controller.project_settings, + rootless_path=rootless_path, + workfile_entities=self.get_workfile_entities(task_id), + ) failed = False try: save_current_workfile_to( @@ -158,13 +174,7 @@ class WorkfilesModel: version=version, comment=comment, description=description, - rootless_path=rootless_path, - workfile_entities=self.get_workfile_entities(task_id), - project_entity=self._controller.get_project_entity( - project_name - ), - project_settings=self._controller.project_settings, - anatomy=self._controller.project_anatomy, + prepared_data=prepared_data, ) self._update_workfile_info( task_id, rootless_path, description @@ -198,37 +208,38 @@ class WorkfilesModel: self._emit_event("copy_representation.started") project_name = self._project_name + project_entity = self._controller.get_project_entity(project_name) folder_entity = self._controller.get_folder_entity( - self._project_name, folder_id + project_name, folder_id ) task_entity = self._controller.get_task_entity( - self._project_name, task_id + project_name, task_id ) repre_entity = self._repre_by_id.get(representation_id) dst_filepath = os.path.join(workdir, filename) rootless_path = f"{rootless_workdir}/{filename}" + prepared_data = CopyPublishedWorkfileOptionalData( + project_entity=project_entity, + anatomy=self._controller.project_anatomy, + project_settings=self._controller.project_settings, + rootless_path=rootless_path, + representation_path=representation_filepath, + workfile_entities=self.get_workfile_entities(task_id), + src_anatomy=self._controller.project_anatomy, + ) failed = False - workfile_entities = self.get_workfile_entities(task_id) try: copy_and_open_workfile_representation( project_name, - representation_id, + repre_entity, dst_filepath, folder_entity, task_entity, version=version, comment=comment, description=description, - rootless_path=rootless_path, - representation_entity=repre_entity, - representation_path=representation_filepath, - workfile_entities=workfile_entities, - project_entity=self._controller.get_project_entity( - project_name - ), - project_settings=self._controller.project_settings, - anatomy=self._controller.project_anatomy, + prepared_data=prepared_data, ) self._update_workfile_info( task_id, rootless_path, description @@ -271,6 +282,14 @@ class WorkfilesModel: workfile_entities = self.get_workfile_entities(task_id) rootless_path = f"{rootless_workdir}/{filename}" workfile_path = os.path.join(workdir, filename) + + prepared_data = CopyWorkfileOptionalData( + project_entity=project_entity, + project_settings=self._controller.project_settings, + anatomy=self._controller.project_anatomy, + rootless_path=rootless_path, + workfile_entities=workfile_entities, + ) failed = False try: copy_and_open_workfile( @@ -281,11 +300,7 @@ class WorkfilesModel: version=version, comment=comment, description=description, - rootless_path=rootless_path, - workfile_entities=workfile_entities, - project_entity=project_entity, - project_settings=self._controller.project_settings, - anatomy=self._controller.project_anatomy, + prepared_data=prepared_data, ) except Exception: @@ -571,12 +586,12 @@ class WorkfilesModel: project_name = self._project_name anatomy = self._controller.project_anatomy - product_entities = ayon_api.get_products( + product_entities = list(ayon_api.get_products( project_name, folder_ids={folder_id}, product_types={"workfile"}, fields={"id", "name"} - ) + )) version_entities = [] product_ids = {product["id"] for product in product_entities} @@ -599,13 +614,20 @@ class WorkfilesModel: repre_entity["id"]: repre_entity for repre_entity in repre_entities }) + project_entity = self._controller.get_project_entity(project_name) + prepared_data = ListPublishedWorkfilesOptionalData( + project_entity=project_entity, + anatomy=anatomy, + project_settings=self._controller.project_settings, + product_entities=product_entities, + version_entities=version_entities, + repre_entities=repre_entities, + ) cache.update_data(self._host.list_published_workfiles( project_name, folder_id, - anatomy=anatomy, - version_entities=version_entities, - repre_entities=repre_entities, + prepared_data=prepared_data, )) items = cache.get_data() @@ -638,13 +660,21 @@ class WorkfilesModel: def _open_workfile(self, folder_id: str, task_id: str, filepath: str): # TODO move to workfiles pipeline project_name = self._project_name + project_entity = self._controller.get_project_entity(project_name) folder_entity = self._controller.get_folder_entity( project_name, folder_id ) task_entity = self._controller.get_task_entity( project_name, task_id ) - open_workfile(filepath, folder_entity, task_entity) + prepared_data = OpenWorkfileOptionalData( + project_entity=project_entity, + anatomy=self._controller.project_anatomy, + project_settings=self._controller.project_settings, + ) + open_workfile( + filepath, folder_entity, task_entity, prepared_data=prepared_data + ) self._update_current_context( folder_id, folder_entity["path"], task_entity["name"] ) @@ -739,15 +769,19 @@ class WorkfilesModel: fill_data = self._prepare_fill_data(folder_id, task_id) template_key = self._get_template_key(fill_data) + prepared_data = ListWorkfilesOptionalData( + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + template_key=template_key, + workfile_entities=workfile_entities, + ) + items = self._host.list_workfiles( self._project_name, folder_entity, task_entity, - project_entity=project_entity, - anatomy=anatomy, - template_key=template_key, - project_settings=project_settings, - workfile_entities=workfile_entities, + prepared_data=prepared_data, ) cache.update_data(items) From 91377aa40011a22593b6cb41694c96747f7fcf33 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 26 Jun 2025 10:20:56 +0200 Subject: [PATCH 108/170] formatting fixes --- client/ayon_core/host/interfaces/workfiles.py | 10 ++++------ client/ayon_core/pipeline/workfile/utils.py | 4 ++-- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 8bc0b1cf85..4eb8b08719 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -182,7 +182,6 @@ class ListPublishedWorkfilesOptionalData(_WorkfileOptionalData): version_entities = list(ayon_api.get_versions( project_name, product_ids=product_ids, - task_ids=task_filters, fields={"id", "author", "taskId"}, )) @@ -444,7 +443,6 @@ def get_list_published_workfiles_context( repre_entities, ) = prepared_data.get_entities(project_name, folder_id) - return ListPublishedWorkfilesContext( data_version=prepared_data.data_version, project_name=project_name, @@ -1598,8 +1596,8 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - save_workfile_context (SaveWorkfileContext): Workfile path with target - folder and task context. + save_workfile_context (SaveWorkfileContext): Workfile path with + target folder and task context. """ pass @@ -1614,8 +1612,8 @@ class IWorkfileHost: Can be overridden to implement host specific logic. Args: - save_workfile_context (SaveWorkfileContext): Workfile path with target - folder and task context. + save_workfile_context (SaveWorkfileContext): Workfile path with + target folder and task context. """ workdir = os.path.dirname(save_workfile_context.dst_path) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index f19c9933a0..0ac294c82a 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -473,8 +473,8 @@ def copy_and_open_workfile_representation( version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. - prepared_data (Optional[CopyPublishedWorkfileOptionalData]): Prepared data - for speed enhancements. + prepared_data (Optional[CopyPublishedWorkfileOptionalData]): Prepared + data for speed enhancements. """ from ayon_core.pipeline.context_tools import registered_host From dc476dea9234e2e430ccd5795bd29e1d05b65c6f Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 26 Jun 2025 10:57:27 +0200 Subject: [PATCH 109/170] fix missing argument --- client/ayon_core/pipeline/workfile/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 0ac294c82a..177eb69694 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -489,7 +489,7 @@ def copy_and_open_workfile_representation( version=version, comment=comment, description=description, - open_workfile=open_workfile, + open_workfile=True, prepared_data=prepared_data, ) From 449549b72bb76142fd669f3da9dd197e87d4bad8 Mon Sep 17 00:00:00 2001 From: "Sveinbjorn J. Tryggvason" Date: Tue, 1 Jul 2025 11:11:18 +0000 Subject: [PATCH 110/170] allow merging of file sequence entries --- .../tools/attribute_defs/files_widget.py | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/client/ayon_core/tools/attribute_defs/files_widget.py b/client/ayon_core/tools/attribute_defs/files_widget.py index 8a40b3ff38..edac8059f0 100644 --- a/client/ayon_core/tools/attribute_defs/files_widget.py +++ b/client/ayon_core/tools/attribute_defs/files_widget.py @@ -892,6 +892,28 @@ class FilesWidget(QtWidgets.QFrame): self._add_filepaths(new_items) self._remove_item_by_ids(item_ids) + def _on_merge_request(self): + if self._multivalue: + return + + item_ids = self._files_view.get_selected_item_ids() + if not item_ids: + return + + all_paths = [] + for item_id in item_ids: + file_item = self._files_model.get_file_item_by_id(item_id) + if not file_item: + return + + new_items = file_item.split_sequence() + for nitem in new_items: + all_paths.append(os.path.join(nitem.directory, nitem.filenames[0])) + unique_all_pahts = list(set(all_paths)) + self._remove_item_by_ids(item_ids) + new_items = FileDefItem.from_value(unique_all_pahts, True) + self._add_filepaths(new_items) + def _on_remove_requested(self): if self._multivalue: return @@ -911,6 +933,9 @@ class FilesWidget(QtWidgets.QFrame): split_action.triggered.connect(self._on_split_request) menu.addAction(split_action) + merge_action = QtWidgets.QAction("Merge sequence", menu) + merge_action.triggered.connect(self._on_merge_request) + menu.addAction(merge_action) remove_action = QtWidgets.QAction("Remove", menu) remove_action.triggered.connect(self._on_remove_requested) menu.addAction(remove_action) From b142bc4d457dd7665d19ba5f09247bb6619fc2a9 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 2 Jul 2025 09:49:44 +0200 Subject: [PATCH 111/170] expect folder path and task name in 'save_current_workfile_to' --- client/ayon_core/pipeline/workfile/utils.py | 18 +++++++++++++----- .../tools/workfiles/models/workfiles.py | 2 +- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 177eb69694..a1371a4956 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -326,8 +326,8 @@ def open_workfile( def save_current_workfile_to( workfile_path: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], + folder_path: str, + task_name: str, *, version: Optional[int] = None, comment: Optional[str] = None, @@ -338,8 +338,8 @@ def save_current_workfile_to( Args: workfile_path (str): Destination workfile path. - folder_entity (dict[str, Any]): Target folder entity. - task_entity (dict[str, Any]): Target task entity. + folder_path (str): Target folder path. + task_name (str): Target task name. version (Optional[int]): Workfile version. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. @@ -350,6 +350,14 @@ def save_current_workfile_to( from ayon_core.pipeline.context_tools import registered_host host = registered_host() + context = host.get_current_context() + project_name = context["project_name"] + folder_entity = ayon_api.get_folder_by_path( + project_name, folder_path + ) + task_entity = ayon_api.get_task_by_name( + project_name, folder_entity["id"], task_name + ) host.save_workfile_with_context( workfile_path, folder_entity, @@ -398,7 +406,7 @@ def save_workfile_with_current_context( project_name, folder_entity["id"], task_name ) - save_current_workfile_to( + host.save_workfile_with_context( workfile_path, folder_entity, task_entity, diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 5e4e5db808..0a581d6498 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -167,7 +167,7 @@ class WorkfilesModel: ) failed = False try: - save_current_workfile_to( + self._host.save_workfile_with_context( filepath, folder_entity, task_entity, From bc9a1b6526fc939239719738adfab6c2ea172ddd Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 2 Jul 2025 09:53:46 +0200 Subject: [PATCH 112/170] remove unused import --- client/ayon_core/tools/workfiles/models/workfiles.py | 1 - 1 file changed, 1 deletion(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 0a581d6498..a1cca07178 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -38,7 +38,6 @@ from ayon_core.pipeline.workfile import ( get_last_workfile_with_version_from_paths, get_comments_from_workfile_paths, open_workfile, - save_current_workfile_to, copy_and_open_workfile, copy_and_open_workfile_representation, save_workfile_info, From 1b2d3606191fc7f294c113c35b90c3ebdf852f3f Mon Sep 17 00:00:00 2001 From: sjt-rvx <72554834+sjt-rvx@users.noreply.github.com> Date: Wed, 2 Jul 2025 10:22:35 +0000 Subject: [PATCH 113/170] Update client/ayon_core/tools/attribute_defs/files_widget.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- .../tools/attribute_defs/files_widget.py | 22 ++++++++++--------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/client/ayon_core/tools/attribute_defs/files_widget.py b/client/ayon_core/tools/attribute_defs/files_widget.py index edac8059f0..f1b0f06dbc 100644 --- a/client/ayon_core/tools/attribute_defs/files_widget.py +++ b/client/ayon_core/tools/attribute_defs/files_widget.py @@ -900,18 +900,20 @@ class FilesWidget(QtWidgets.QFrame): if not item_ids: return - all_paths = [] + all_paths = set() + merged_item_ids = set() for item_id in item_ids: file_item = self._files_model.get_file_item_by_id(item_id) - if not file_item: - return - - new_items = file_item.split_sequence() - for nitem in new_items: - all_paths.append(os.path.join(nitem.directory, nitem.filenames[0])) - unique_all_pahts = list(set(all_paths)) - self._remove_item_by_ids(item_ids) - new_items = FileDefItem.from_value(unique_all_pahts, True) + if file_item is None: + continue + merged_item_ids.add(item_id) + all_paths |= { + os.path.join(file_item.directory, filename) + for filename in file_item.filenames + } + + self._remove_item_by_ids(merged_item_ids) + new_items = FileDefItem.from_value(list(all_paths), True) self._add_filepaths(new_items) def _on_remove_requested(self): From b3d87eac82a84305ee788f357fd73cac20abcc53 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 2 Jul 2025 16:59:13 +0200 Subject: [PATCH 114/170] added 'is_mandatory' to instance --- .../ayon_core/pipeline/create/structures.py | 34 +++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/client/ayon_core/pipeline/create/structures.py b/client/ayon_core/pipeline/create/structures.py index d7ba6b9c24..1bc20501cc 100644 --- a/client/ayon_core/pipeline/create/structures.py +++ b/client/ayon_core/pipeline/create/structures.py @@ -507,6 +507,7 @@ class CreatedInstance: if transient_data is None: transient_data = {} self._transient_data = transient_data + self._is_mandatory = False # Create a copy of passed data to avoid changing them on the fly data = copy.deepcopy(data or {}) @@ -605,6 +606,12 @@ class CreatedInstance: if key in self._data and self._data[key] == value: return + if self.is_mandatory and key == "active" and value is not True: + raise ImmutableKeyError( + key, + "Instance is mandatory and can't be disabled." + ) + self._data[key] = value self._create_context.instance_values_changed( self.id, {key: value} @@ -718,6 +725,33 @@ class CreatedInstance: return self._transient_data + @property + def is_mandatory(self) -> bool: + """Check if instance is mandatory. + + Returns: + bool: True if instance is mandatory, False otherwise. + + """ + return self._is_mandatory + + def set_mandatory(self, value: bool) -> None: + """Set instance as mandatory or not. + + Mandatory instance can't be disabled in UI. + + Args: + value (bool): True if instance should be mandatory, False + otherwise. + + """ + if value is self._is_mandatory: + return + self._is_mandatory = value + if value is True: + self["active"] = True + self._create_context.instance_state_changed(self.id) + def changes(self): """Calculate and return changes.""" From 541c7c328a5fa2bfee59bcc7c97205925b3c9e35 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 2 Jul 2025 16:59:24 +0200 Subject: [PATCH 115/170] capture state changes of instance --- client/ayon_core/pipeline/create/context.py | 75 +++++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/client/ayon_core/pipeline/create/context.py b/client/ayon_core/pipeline/create/context.py index 05531afd05..14b13613b6 100644 --- a/client/ayon_core/pipeline/create/context.py +++ b/client/ayon_core/pipeline/create/context.py @@ -79,6 +79,7 @@ _NOT_SET = object() INSTANCE_ADDED_TOPIC = "instances.added" INSTANCE_REMOVED_TOPIC = "instances.removed" VALUE_CHANGED_TOPIC = "values.changed" +INSTANCE_STATE_CHANGED_TOPIC = "instance.stated.changed" PRE_CREATE_ATTR_DEFS_CHANGED_TOPIC = "pre.create.attr.defs.changed" CREATE_ATTR_DEFS_CHANGED_TOPIC = "create.attr.defs.changed" PUBLISH_ATTR_DEFS_CHANGED_TOPIC = "publish.attr.defs.changed" @@ -257,6 +258,10 @@ class CreateContext: "create_attrs_change": BulkInfo(), # Publish attribute definitions changed "publish_attrs_change": BulkInfo(), + # Instance state changed + # - right now used only for 'mandatory' state but can be extended + # in future + "state_change": BulkInfo(), } self._bulk_order = [] @@ -1049,6 +1054,35 @@ class CreateContext: PUBLISH_ATTR_DEFS_CHANGED_TOPIC, callback ) + def add_instance_state_change_callback( + self, callback: Callable + ) -> "EventCallback": + """Register callback to listen instance state changes. + + Create plugin changed attribute definitions of instance. + + Data structure of event:: + + ```python + { + "instances": [CreatedInstance, ...], + "create_context": CreateContext + } + ``` + + Args: + callback (Callable): Callback function that will be called when + create attributes changed. + + Returns: + EventCallback: Created callback object which can be used to + stop listening. + + """ + return self._event_hub.add_callback( + INSTANCE_STATE_CHANGED_TOPIC, callback + ) + def context_data_to_store(self) -> dict[str, Any]: """Data that should be stored by host function. @@ -1323,6 +1357,13 @@ class CreateContext: ) as bulk_info: yield bulk_info + @contextmanager + def bulk_instance_state_change(self, sender: Optional[str] = None): + with self._bulk_context( + "state_change", sender + ) as bulk_info: + yield bulk_info + @contextmanager def bulk_publish_attr_defs_change(self, sender: Optional[str] = None): with self._bulk_context("publish_attrs_change", sender) as bulk_info: @@ -1390,6 +1431,19 @@ class CreateContext: with self.bulk_value_changes() as bulk_item: bulk_item.append((instance_id, new_values)) + def instance_state_changed(self, instance_id: str) -> None: + """Instance state changed. + + Triggered by `CreatedInstance`. + + Args: + instance_id (Optional[str]): Instance id. + + """ + if self._is_instance_events_ready(instance_id): + with self.bulk_instance_state_change() as bulk_item: + bulk_item.append(instance_id) + # --- context change callbacks --- def publish_attribute_value_changed( self, plugin_name: str, value: dict[str, Any] @@ -2249,6 +2303,8 @@ class CreateContext: self._bulk_create_attrs_change_finished(data, sender) elif key == "publish_attrs_change": self._bulk_publish_attrs_change_finished(data, sender) + elif key == "state_change": + self._bulk_instance_state_change_finished(data, sender) def _bulk_add_instances_finished( self, @@ -2443,3 +2499,22 @@ class CreateContext: {"instance_changes": instance_changes}, sender, ) + + def _bulk_instance_state_change_finished( + self, + instance_ids: list[str], + sender: Optional[str], + ) -> None: + if not instance_ids: + return + + instances = [ + self.get_instance_by_id(instance_id) + for instance_id in set(instance_ids) + ] + + self._emit_event( + INSTANCE_STATE_CHANGED_TOPIC, + {"instances": instances}, + sender, + ) From 9f69202538071dfe2770e9d07c142deb66986f7e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 2 Jul 2025 16:59:40 +0200 Subject: [PATCH 116/170] handle mandatory property in publisher --- client/ayon_core/tools/publisher/control.py | 1 + .../tools/publisher/models/create.py | 20 +++++++++++++++++++ .../publisher/widgets/card_view_widgets.py | 4 ++++ .../publisher/widgets/list_view_widgets.py | 5 +++++ .../publisher/widgets/overview_widget.py | 12 ++++++++++- 5 files changed, 41 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/publisher/control.py b/client/ayon_core/tools/publisher/control.py index ef2e122692..b551b21bd4 100644 --- a/client/ayon_core/tools/publisher/control.py +++ b/client/ayon_core/tools/publisher/control.py @@ -53,6 +53,7 @@ class PublisherController( changed. "create.context.create.attrs.changed" - Create attributes changed. "create.context.publish.attrs.changed" - Publish attributes changed. + "create.context.instance.state.changed" - Instance state changed. "create.context.removed.instance" - Instance removed from context. "create.model.instances.context.changed" - Instances changed context. like folder, task or variant. diff --git a/client/ayon_core/tools/publisher/models/create.py b/client/ayon_core/tools/publisher/models/create.py index 900168eaef..7f44b374e6 100644 --- a/client/ayon_core/tools/publisher/models/create.py +++ b/client/ayon_core/tools/publisher/models/create.py @@ -217,6 +217,7 @@ class InstanceItem: folder_path: Optional[str], task_name: Optional[str], is_active: bool, + is_mandatory: bool, has_promised_context: bool, ): self._instance_id: str = instance_id @@ -229,6 +230,7 @@ class InstanceItem: self._folder_path: Optional[str] = folder_path self._task_name: Optional[str] = task_name self._is_active: bool = is_active + self._is_mandatory: bool = is_mandatory self._has_promised_context: bool = has_promised_context @property @@ -251,6 +253,10 @@ class InstanceItem: def product_type(self): return self._product_type + @property + def is_mandatory(self): + return self._is_mandatory + @property def has_promised_context(self): return self._has_promised_context @@ -304,6 +310,7 @@ class InstanceItem: instance["folderPath"], instance["task"], instance["active"], + instance.is_mandatory, instance.has_promised_context, ) @@ -476,6 +483,9 @@ class CreateModel: self._create_context.add_publish_attr_defs_change_callback( self._cc_publish_attr_changed ) + self._create_context.add_instance_state_change_callback( + self._cc_instance_state_changed + ) self._create_context.reset_finalization() @@ -1171,6 +1181,16 @@ class CreateModel: event_data, ) + def _cc_instance_state_changed(self, event): + instance_ids = { + instance.id + for instance in event.data["instances"] + } + self._emit_event( + "create.context.instance.state.changed", + {"instance_ids": instance_ids}, + ) + def _get_allowed_creators_pattern(self) -> Union[Pattern, None]: """Provide regex pattern for configured creator labels in this context diff --git a/client/ayon_core/tools/publisher/widgets/card_view_widgets.py b/client/ayon_core/tools/publisher/widgets/card_view_widgets.py index 2f633b3149..8a4eddf058 100644 --- a/client/ayon_core/tools/publisher/widgets/card_view_widgets.py +++ b/client/ayon_core/tools/publisher/widgets/card_view_widgets.py @@ -482,6 +482,9 @@ class InstanceCardWidget(CardWidget): if checkbox_value != new_value: self._active_checkbox.setChecked(new_value) + def _set_is_mandatory(self, is_mandatory: bool) -> None: + self._active_checkbox.setVisible(not is_mandatory) + def update_instance(self, instance, context_info): """Update instance object and update UI.""" self.instance = instance @@ -525,6 +528,7 @@ class InstanceCardWidget(CardWidget): """Update instance data""" self._update_product_name() self._set_active(self.instance.is_active) + self._set_is_mandatory(self.instance.is_mandatory) self._validate_context(context_info) def _set_expanded(self, expanded=None): diff --git a/client/ayon_core/tools/publisher/widgets/list_view_widgets.py b/client/ayon_core/tools/publisher/widgets/list_view_widgets.py index bc3353ba5e..8d9f509b0e 100644 --- a/client/ayon_core/tools/publisher/widgets/list_view_widgets.py +++ b/client/ayon_core/tools/publisher/widgets/list_view_widgets.py @@ -132,6 +132,7 @@ class InstanceListItemWidget(QtWidgets.QWidget): active_checkbox = NiceCheckbox(parent=self) active_checkbox.setChecked(instance.is_active) + active_checkbox.setVisible(not instance.is_mandatory) layout = QtWidgets.QHBoxLayout(self) content_margins = layout.contentsMargins() @@ -192,6 +193,7 @@ class InstanceListItemWidget(QtWidgets.QWidget): self._instance_label_widget.setText(html_escape(label)) # Check active state self.set_active(instance.is_active) + self._set_is_mandatory(instance.is_mandatory) # Check valid states self._set_valid_property(context_info.is_valid) @@ -203,6 +205,9 @@ class InstanceListItemWidget(QtWidgets.QWidget): def set_active_toggle_enabled(self, enabled): self._active_checkbox.setEnabled(enabled) + def _set_is_mandatory(self, is_mandatory: bool) -> None: + self._active_checkbox.setVisible(not is_mandatory) + class ListContextWidget(QtWidgets.QFrame): """Context (or global attributes) widget.""" diff --git a/client/ayon_core/tools/publisher/widgets/overview_widget.py b/client/ayon_core/tools/publisher/widgets/overview_widget.py index c6c3b774f0..44bb09d4fc 100644 --- a/client/ayon_core/tools/publisher/widgets/overview_widget.py +++ b/client/ayon_core/tools/publisher/widgets/overview_widget.py @@ -155,6 +155,10 @@ class OverviewWidget(QtWidgets.QFrame): "create.model.instances.context.changed", self._on_instance_context_change ) + controller.register_event_callback( + "create.model.instance.state.changed", + self._on_instance_state_changed + ) self._product_content_widget = product_content_widget self._product_content_layout = product_content_layout @@ -352,6 +356,12 @@ class OverviewWidget(QtWidgets.QFrame): ) def _on_instance_context_change(self, event): + self._refresh_instance_states(event["instance_ids"]) + + def _on_instance_state_changed(self, event): + self._refresh_instance_states(event["instance_ids"]) + + def _refresh_instance_states(self, instance_ids): current_idx = self._product_views_layout.currentIndex() for idx in range(self._product_views_layout.count()): if idx == current_idx: @@ -361,7 +371,7 @@ class OverviewWidget(QtWidgets.QFrame): widget.set_refreshed(False) current_widget = self._product_views_layout.widget(current_idx) - current_widget.refresh_instance_states(event["instance_ids"]) + current_widget.refresh_instance_states(instance_ids) def _on_convert_requested(self): self.convert_requested.emit() From 39d011b89f63f0268367ab86fbbf19d92ab6f17b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 3 Jul 2025 10:20:03 +0200 Subject: [PATCH 117/170] don't change active state of mandatory instances --- .../publisher/widgets/list_view_widgets.py | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/publisher/widgets/list_view_widgets.py b/client/ayon_core/tools/publisher/widgets/list_view_widgets.py index 8d9f509b0e..969bec11e5 100644 --- a/client/ayon_core/tools/publisher/widgets/list_view_widgets.py +++ b/client/ayon_core/tools/publisher/widgets/list_view_widgets.py @@ -152,6 +152,8 @@ class InstanceListItemWidget(QtWidgets.QWidget): self._has_valid_context = None + self._checkbox_enabled = not instance.is_mandatory + self._set_valid_property(context_info.is_valid) def mouseDoubleClickEvent(self, event): @@ -185,6 +187,10 @@ class InstanceListItemWidget(QtWidgets.QWidget): self._active_checkbox.setChecked(new_value) self._active_checkbox.blockSignals(False) + def is_checkbox_enabled(self) -> bool: + """Checkbox can be changed by user.""" + return self._checkbox_enabled + def update_instance(self, instance, context_info): """Update instance object.""" # Check product name @@ -206,6 +212,7 @@ class InstanceListItemWidget(QtWidgets.QWidget): self._active_checkbox.setEnabled(enabled) def _set_is_mandatory(self, is_mandatory: bool) -> None: + self._checkbox_enabled = not is_mandatory self._active_checkbox.setVisible(not is_mandatory) @@ -954,11 +961,17 @@ class InstanceListView(AbstractInstanceView): return active_by_id = {} + all_changed = True for row in range(group_item.rowCount()): item = group_item.child(row) instance_id = item.data(INSTANCE_ID_ROLE) - if instance_id is not None: + widget = self._widgets_by_id.get(instance_id) + if widget is None: + continue + if widget.is_checkbox_enabled(): active_by_id[instance_id] = active + else: + all_changed = False self._controller.set_instances_active_state(active_by_id) @@ -968,6 +981,10 @@ class InstanceListView(AbstractInstanceView): if not self._instance_view.isExpanded(proxy_index): self._instance_view.expand(proxy_index) + if not all_changed: + # If not all instances were changed, update group checkstate + self._update_group_checkstate(group_name) + def has_items(self): if self._convertor_group_widget is not None: return True From b1e0a925059eb5c077a35c60e663bb61bd58a27d Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 3 Jul 2025 13:05:31 +0200 Subject: [PATCH 118/170] define logging config for AYON processes --- client/ayon_core/cli.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/client/ayon_core/cli.py b/client/ayon_core/cli.py index 2340696ad9..5978e8ba19 100644 --- a/client/ayon_core/cli.py +++ b/client/ayon_core/cli.py @@ -2,6 +2,7 @@ """Package for handling AYON command line arguments.""" import os import sys +import logging import code import traceback from pathlib import Path @@ -23,6 +24,9 @@ from ayon_core.lib.env_tools import ( merge_env_variables, ) +logging.basicConfig() +log = logging.getLogger() + @click.group(invoke_without_command=True) @click.pass_context From f2b67e3d79497b6f2c9b26fc33edd353a784235d Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Fri, 4 Jul 2025 23:28:41 +0200 Subject: [PATCH 119/170] Add "blender" to hosts list for Validate File Saved --- client/ayon_core/plugins/publish/validate_file_saved.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/plugins/publish/validate_file_saved.py b/client/ayon_core/plugins/publish/validate_file_saved.py index 7656687b4f..f8fdd27342 100644 --- a/client/ayon_core/plugins/publish/validate_file_saved.py +++ b/client/ayon_core/plugins/publish/validate_file_saved.py @@ -37,7 +37,7 @@ class ValidateCurrentSaveFile(pyblish.api.ContextPlugin): label = "Validate File Saved" order = pyblish.api.ValidatorOrder - 0.1 hosts = ["fusion", "houdini", "max", "maya", "nuke", "substancepainter", - "cinema4d", "silhouette", "gaffer"] + "cinema4d", "silhouette", "gaffer", "blender"] actions = [SaveByVersionUpAction, ShowWorkfilesAction] def process(self, context): From 7006ed8940e62eacfae2d247f4d08b0988bb7201 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 10:17:55 +0200 Subject: [PATCH 120/170] fix not existing dirs --- client/ayon_core/pipeline/workfile/path_resolving.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 4e4c70a27c..b318137a5d 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -362,6 +362,10 @@ def _filter_dir_files_by_ext( if not ext.startswith("."): ext = f".{ext}" dotted_extensions.add(ext) + + if not os.path.exists(dirpath): + return [], dotted_extensions + filtered_paths = [ os.path.join(dirpath, filename) for filename in os.listdir(dirpath) From 206eb45cf49fc5dec1ae56200c1c18294f800914 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 10:24:12 +0200 Subject: [PATCH 121/170] added 'save_workfile_with_current_context' to workfile init --- client/ayon_core/pipeline/workfile/__init__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/__init__.py b/client/ayon_core/pipeline/workfile/__init__.py index 52acb035b1..51327b8c09 100644 --- a/client/ayon_core/pipeline/workfile/__init__.py +++ b/client/ayon_core/pipeline/workfile/__init__.py @@ -24,6 +24,7 @@ from .utils import ( open_workfile, save_current_workfile_to, + save_workfile_with_current_context, copy_and_open_workfile, copy_and_open_workfile_representation, save_workfile_info, @@ -67,6 +68,7 @@ __all__ = ( "open_workfile", "save_current_workfile_to", + "save_workfile_with_current_context", "copy_and_open_workfile", "copy_and_open_workfile_representation", "save_workfile_info", From 5ff56aeda59cb89c1e4e8e4029a01888a7398ced Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 10:24:25 +0200 Subject: [PATCH 122/170] use host methods in workfiles tool --- client/ayon_core/tools/workfiles/models/workfiles.py | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index a1cca07178..35ffc3102c 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -37,9 +37,6 @@ from ayon_core.pipeline.workfile import ( get_workfile_template_key, get_last_workfile_with_version_from_paths, get_comments_from_workfile_paths, - open_workfile, - copy_and_open_workfile, - copy_and_open_workfile_representation, save_workfile_info, ) from ayon_core.pipeline.version_start import get_versioning_start @@ -229,7 +226,7 @@ class WorkfilesModel: ) failed = False try: - copy_and_open_workfile_representation( + self._host.copy_workfile_representation( project_name, repre_entity, dst_filepath, @@ -291,7 +288,7 @@ class WorkfilesModel: ) failed = False try: - copy_and_open_workfile( + self._host.copy_workfile( src_filepath, workfile_path, folder_entity, @@ -671,7 +668,7 @@ class WorkfilesModel: anatomy=self._controller.project_anatomy, project_settings=self._controller.project_settings, ) - open_workfile( + self._host.open_workfile_with_context( filepath, folder_entity, task_entity, prepared_data=prepared_data ) self._update_current_context( From 43d9324e1028971dfb5b7b6a098422535cca89eb Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 10:26:27 +0200 Subject: [PATCH 123/170] remove unnecessary functions --- .../ayon_core/pipeline/workfile/__init__.py | 6 - client/ayon_core/pipeline/workfile/utils.py | 104 ------------------ 2 files changed, 110 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/__init__.py b/client/ayon_core/pipeline/workfile/__init__.py index 51327b8c09..c6a0e0d80b 100644 --- a/client/ayon_core/pipeline/workfile/__init__.py +++ b/client/ayon_core/pipeline/workfile/__init__.py @@ -22,11 +22,8 @@ from .utils import ( should_open_workfiles_tool_on_launch, MissingWorkdirError, - open_workfile, save_current_workfile_to, save_workfile_with_current_context, - copy_and_open_workfile, - copy_and_open_workfile_representation, save_workfile_info, find_workfile_rootless_path, ) @@ -66,11 +63,8 @@ __all__ = ( "should_open_workfiles_tool_on_launch", "MissingWorkdirError", - "open_workfile", "save_current_workfile_to", "save_workfile_with_current_context", - "copy_and_open_workfile", - "copy_and_open_workfile_representation", "save_workfile_info", "BuildWorkfile", diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index a1371a4956..fd5cc4538e 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -305,25 +305,6 @@ def save_workfile_info( return workfile_entity -def open_workfile( - filepath: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - *, - prepared_data: Optional[OpenWorkfileOptionalData] = None, -): - from ayon_core.pipeline.context_tools import registered_host - - # Trigger before save event - host = registered_host() - host.open_workfile_with_context( - filepath, - folder_entity, - task_entity, - prepared_data=prepared_data, - ) - - def save_current_workfile_to( workfile_path: str, folder_path: str, @@ -417,91 +398,6 @@ def save_workfile_with_current_context( ) -def copy_and_open_workfile( - src_workfile_path: str, - workfile_path: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - *, - version: Optional[int] = None, - comment: Optional[str] = None, - description: Optional[str] = None, - prepared_data: Optional[CopyWorkfileOptionalData] = None, -) -> None: - """Copy workfile to new location and open it. - - Args: - src_workfile_path (str): Source workfile path. - workfile_path (str): Destination workfile path. - folder_entity (dict[str, Any]): Target folder entity. - task_entity (dict[str, Any]): Target task entity. - version (Optional[int]): Workfile version. - comment (optional[str]): Workfile comment. - description (Optional[str]): Workfile description. - prepared_data (Optional[CopyWorkfileOptionalData]): Prepared data - for speed enhancements. - - """ - from ayon_core.pipeline.context_tools import registered_host - - host = registered_host() - host.copy_workfile( - src_workfile_path, - workfile_path, - folder_entity, - task_entity, - version=version, - comment=comment, - description=description, - open_workfile=True, - prepared_data=prepared_data, - ) - - -def copy_and_open_workfile_representation( - src_project_name: str, - representation_entity: dict[str, Any], - workfile_path: str, - folder_entity: dict[str, Any], - task_entity: dict[str, Any], - *, - version: Optional[int] = None, - comment: Optional[str] = None, - description: Optional[str] = None, - prepared_data: Optional[CopyPublishedWorkfileOptionalData] = None, -) -> None: - """Copy workfile to new location and open it. - - Args: - src_project_name (str): Project name where representation is stored. - representation_entity (dict[str, Any]): Representation entity. - workfile_path (str): Destination workfile path. - folder_entity (dict[str, Any]): Target folder entity. - task_entity (dict[str, Any]): Target task entity. - version (Optional[int]): Workfile version. - comment (optional[str]): Workfile comment. - description (Optional[str]): Workfile description. - prepared_data (Optional[CopyPublishedWorkfileOptionalData]): Prepared - data for speed enhancements. - - """ - from ayon_core.pipeline.context_tools import registered_host - - host = registered_host() - host.copy_workfile_representation( - src_project_name, - representation_entity, - workfile_path, - folder_entity, - task_entity, - version=version, - comment=comment, - description=description, - open_workfile=True, - prepared_data=prepared_data, - ) - - def find_workfile_rootless_path( workfile_path: str, project_name: str, From 9c1aa9bfeffcd6af9569b6e3304113f84ed59dc9 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 11:02:41 +0200 Subject: [PATCH 124/170] remove unused import --- client/ayon_core/pipeline/workfile/utils.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index fd5cc4538e..9e4194ccf6 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -12,9 +12,6 @@ from ayon_core.lib import filter_profiles, get_ayon_username from ayon_core.settings import get_project_settings from ayon_core.host.interfaces import ( SaveWorkfileOptionalData, - OpenWorkfileOptionalData, - CopyWorkfileOptionalData, - CopyPublishedWorkfileOptionalData, ) from .path_resolving import get_workfile_template_key From 54ecd2b834ec773b75e600beb13445df5fa7799e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 12:40:34 +0200 Subject: [PATCH 125/170] move basicconfig to main --- client/ayon_core/cli.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/cli.py b/client/ayon_core/cli.py index 5978e8ba19..ca3dcc86ee 100644 --- a/client/ayon_core/cli.py +++ b/client/ayon_core/cli.py @@ -24,9 +24,6 @@ from ayon_core.lib.env_tools import ( merge_env_variables, ) -logging.basicConfig() -log = logging.getLogger() - @click.group(invoke_without_command=True) @click.pass_context @@ -310,6 +307,8 @@ def _add_addons(addons_manager): def main(*args, **kwargs): + logging.basicConfig() + initialize_ayon_connection() python_path = os.getenv("PYTHONPATH", "") split_paths = python_path.split(os.pathsep) From c54b7c25178e0c8910f16d7a94a7f78d17c33059 Mon Sep 17 00:00:00 2001 From: sjt-rvx <72554834+sjt-rvx@users.noreply.github.com> Date: Mon, 7 Jul 2025 10:58:18 +0000 Subject: [PATCH 126/170] Update client/ayon_core/tools/attribute_defs/files_widget.py Co-authored-by: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> --- client/ayon_core/tools/attribute_defs/files_widget.py | 1 - 1 file changed, 1 deletion(-) diff --git a/client/ayon_core/tools/attribute_defs/files_widget.py b/client/ayon_core/tools/attribute_defs/files_widget.py index f1b0f06dbc..4c55ae5620 100644 --- a/client/ayon_core/tools/attribute_defs/files_widget.py +++ b/client/ayon_core/tools/attribute_defs/files_widget.py @@ -911,7 +911,6 @@ class FilesWidget(QtWidgets.QFrame): os.path.join(file_item.directory, filename) for filename in file_item.filenames } - self._remove_item_by_ids(merged_item_ids) new_items = FileDefItem.from_value(list(all_paths), True) self._add_filepaths(new_items) From cd6136ba00667adfe1c810e9e3986604066e229b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 14:32:02 +0200 Subject: [PATCH 127/170] show all arguments in IDE --- client/ayon_core/host/interfaces/workfiles.py | 44 +++++++++++++++++-- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 4eb8b08719..3c86d9caa3 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -102,11 +102,19 @@ class ListWorkfilesOptionalData(_WorkfileOptionalData): def __init__( self, *, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + project_settings: Optional[dict[str, Any]] = None, template_key: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, **kwargs ): - super().__init__(**kwargs) + super().__init__( + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + **kwargs + ) self.template_key = template_key self.workfile_entities = workfile_entities @@ -147,12 +155,20 @@ class ListPublishedWorkfilesOptionalData(_WorkfileOptionalData): def __init__( self, *, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + project_settings: Optional[dict[str, Any]] = None, product_entities: Optional[list[dict[str, Any]]] = None, version_entities: Optional[list[dict[str, Any]]] = None, repre_entities: Optional[list[dict[str, Any]]] = None, **kwargs ): - super().__init__(**kwargs) + super().__init__( + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + **kwargs + ) self.product_entities = product_entities self.version_entities = version_entities @@ -202,11 +218,19 @@ class SaveWorkfileOptionalData(_WorkfileOptionalData): def __init__( self, *, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + project_settings: Optional[dict[str, Any]] = None, rootless_path: Optional[str] = None, workfile_entities: Optional[list[dict[str, Any]]] = None, **kwargs ): - super().__init__(**kwargs) + super().__init__( + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + **kwargs + ) self.rootless_path = rootless_path self.workfile_entities = workfile_entities @@ -260,11 +284,23 @@ class CopyPublishedWorkfileOptionalData(SaveWorkfileOptionalData): def __init__( self, + project_entity: Optional[dict[str, Any]] = None, + anatomy: Optional["Anatomy"] = None, + project_settings: Optional[dict[str, Any]] = None, + rootless_path: Optional[str] = None, + workfile_entities: Optional[list[dict[str, Any]]] = None, src_anatomy: Optional["Anatomy"] = None, src_representation_path: Optional[str] = None, **kwargs ): - super().__init__(**kwargs) + super().__init__( + rootless_path=rootless_path, + workfile_entities=workfile_entities, + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + **kwargs + ) self.src_anatomy = src_anatomy self.src_representation_path = src_representation_path From c8b2ad1ce23ed3de9958317a3b309bbcc57d5e15 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 14:42:28 +0200 Subject: [PATCH 128/170] use 'AnatomyTemplateResult' for workdir output typehint --- client/ayon_core/pipeline/anatomy/__init__.py | 4 ++++ .../ayon_core/pipeline/workfile/path_resolving.py | 14 +++++++------- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/pipeline/anatomy/__init__.py b/client/ayon_core/pipeline/anatomy/__init__.py index 7000f51495..36bc2a138d 100644 --- a/client/ayon_core/pipeline/anatomy/__init__.py +++ b/client/ayon_core/pipeline/anatomy/__init__.py @@ -6,6 +6,7 @@ from .exceptions import ( AnatomyTemplateUnsolved, ) from .anatomy import Anatomy +from .templates import AnatomyTemplateResult, AnatomyStringTemplate __all__ = ( @@ -16,4 +17,7 @@ __all__ = ( "AnatomyTemplateUnsolved", "Anatomy", + + "AnatomyTemplateResult", + "AnatomyStringTemplate", ) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index b318137a5d..0e364ebc01 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -19,7 +19,7 @@ from ayon_core.pipeline import version_start, Anatomy from ayon_core.pipeline.template_data import get_template_data if typing.TYPE_CHECKING: - from ayon_core.lib.path_templates import TemplateResult + from ayon_core.pipeline.anatomy import AnatomyTemplateResult def get_workfile_template_key_from_context( @@ -117,7 +117,7 @@ def get_workdir_with_workdir_data( anatomy=None, template_key=None, project_settings=None -) -> "TemplateResult": +) -> "AnatomyTemplateResult": """Fill workdir path from entered data and project's anatomy. It is possible to pass only project's name instead of project's anatomy but @@ -136,7 +136,7 @@ def get_workdir_with_workdir_data( if 'template_key' is not passed. Returns: - TemplateResult: Workdir path. + AnatomyTemplateResult: Workdir path. """ if not anatomy: @@ -153,7 +153,7 @@ def get_workdir_with_workdir_data( template_obj = anatomy.get_template_item( "work", template_key, "directory" ) - # Output is TemplateResult object which contain useful data + # Output is AnatomyTemplateResult object which contain useful data output = template_obj.format_strict(workdir_data) if output: return output.normalized() @@ -168,7 +168,7 @@ def get_workdir( anatomy=None, template_key=None, project_settings=None -) -> "TemplateResult": +) -> "AnatomyTemplateResult": """Fill workdir path from entered data and project's anatomy. Args: @@ -189,7 +189,7 @@ def get_workdir( if 'template_key' is not passed. Returns: - TemplateResult: Workdir path. + AnatomyTemplateResult: Workdir path. """ if not anatomy: @@ -203,7 +203,7 @@ def get_workdir( task_entity, host_name, ) - # Output is TemplateResult object which contain useful data + # Output is AnatomyTemplateResult object which contain useful data return get_workdir_with_workdir_data( workdir_data, anatomy.project_name, From b70385ab3ab3a871e7c528b5c3ee55a2faf977ef Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 14:42:40 +0200 Subject: [PATCH 129/170] implemented save next version helper --- client/ayon_core/pipeline/workfile/utils.py | 134 +++++++++++++++++++- 1 file changed, 133 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 9e4194ccf6..0e24b33555 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -12,9 +12,16 @@ from ayon_core.lib import filter_profiles, get_ayon_username from ayon_core.settings import get_project_settings from ayon_core.host.interfaces import ( SaveWorkfileOptionalData, + ListWorkfilesOptionalData, ) +from ayon_core.pipeline.version_start import get_versioning_start +from ayon_core.pipeline.template_data import get_template_data -from .path_resolving import get_workfile_template_key +from .path_resolving import ( + get_workdir, + get_workfile_template_key, + get_last_workfile_with_version_from_paths, +) if typing.TYPE_CHECKING: from ayon_core.pipeline import Anatomy @@ -395,6 +402,131 @@ def save_workfile_with_current_context( ) +def save_next_version( + version: Optional[int] = None, + comment: Optional[str] = None, + description: Optional[str] = None, +) -> None: + """Save workfile using current context, version and comment. + + Helper function to save workfile using current context. Last workfile + version + 1 is used if is not passed in. + + Args: + version (Optional[int]): Workfile version that will be used. Last + version + 1 is used if is not passed in. + comment (optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + + """ + from ayon_core.pipeline import Anatomy + from ayon_core.pipeline.context_tools import registered_host + + host = registered_host() + + context = host.get_current_context() + project_name = context["project_name"] + folder_path = context["folder_path"] + task_name = context["task_name"] + project_entity = ayon_api.get_project(project_name) + project_settings = get_project_settings(project_name) + anatomy = Anatomy(project_name, project_entity=project_entity) + folder_entity = ayon_api.get_folder_by_path(project_name, folder_path) + task_entity = ayon_api.get_task_by_name( + project_name, folder_entity["id"], task_name + ) + + template_key = get_workfile_template_key( + project_name, + task_entity["taskType"], + host.name, + project_settings=project_settings + ) + file_template = anatomy.get_template_item("work", template_key, "file") + template_data = get_template_data( + project_entity, + folder_entity, + task_entity, + host.name, + project_settings, + ) + workdir = get_workdir( + project_entity, + folder_entity, + task_entity, + host.name, + anatomy=anatomy, + template_key=template_key, + project_settings=project_settings, + ) + rootless_dir = workdir.rootless + if version is None: + workfile_extensions = host.get_workfile_extensions() + if not workfile_extensions: + raise ValueError("Host does not have defined file extensions") + workfiles = host.list_workfiles( + project_name, folder_entity, task_entity, + prepared_data=ListWorkfilesOptionalData( + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + template_key=template_key, + ) + ) + filepaths = [ + workfile.filepath + for workfile in workfiles + ] + + dotted_extensions = set() + for ext in workfile_extensions: + if not ext.startswith("."): + ext = f".{ext}" + dotted_extensions.add(ext) + + last_path, last_version = get_last_workfile_with_version_from_paths( + filepaths, + file_template, + template_data, + dotted_extensions, + ) + if last_path is None: + version = get_versioning_start( + project_name, + host.name, + task_name=task_entity["name"], + task_type=task_entity["taskType"], + product_type="workfile" + ) + else: + version = last_version + 1 + + template_data["version"] = version + template_data["comment"] = comment + + filename = file_template.format_strict(template_data) + workfile_path = os.path.join(workdir, filename) + rootless_path = f"{rootless_dir}/{filename}" + if platform.system().lower() == "windows": + rootless_path = rootless_path.replace("\\", "/") + + prepared_data = SaveWorkfileOptionalData( + project_entity=project_entity, + anatomy=anatomy, + project_settings=project_settings, + rootless_path=rootless_path, + ) + host.save_workfile_with_context( + workfile_path, + folder_entity, + task_entity, + version=version, + comment=comment, + description=description, + prepared_data=prepared_data, + ) + + def find_workfile_rootless_path( workfile_path: str, project_name: str, From 4517d55c456f28565ab7f8340b4c754d2bb839ee Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 18:16:23 +0200 Subject: [PATCH 130/170] implemented helper function to parse data from filename using template --- .../pipeline/workfile/path_resolving.py | 80 +++++++++++++++++++ 1 file changed, 80 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 0e364ebc01..ed7ac03e81 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -6,6 +6,7 @@ import platform import warnings import typing from typing import Optional, Dict, Any +from dataclasses import dataclass import ayon_api @@ -213,6 +214,85 @@ def get_workdir( ) +@dataclass +class WorkfileParsedData: + version: Optional[int] = None + comment: Optional[str] = None + ext: Optional[str] = None + + +class WorkfileDataParser: + """Parse dynamic data from existing filenames based on template. + + Args: + file_template (str): Workfile file template. + data (dict[str, Any]): Data to fill the template with. + + """ + def __init__( + self, + file_template: str, + data: dict[str, Any], + ): + data = copy.deepcopy(data) + file_template = str(file_template) + # Use placeholders that will never be in the filename + ext_replacement = "CIextID" + version_replacement = "CIversionID" + comment_replacement = "CIcommentID" + data["version"] = version_replacement + data["comment"] = comment_replacement + for pattern, replacement in ( + # Replace `.{ext}` with `{ext}` so we are sure dot is not at the end + (r"\.?{ext}", ext_replacement), + ): + file_template = re.sub(pattern, replacement, file_template) + + file_template = StringTemplate(file_template) + comment_template = re.escape(str(file_template.format_strict(data))) + data.pop("comment") + file_template = re.escape(str(file_template.format_strict(data))) + for src, replacement in ( + (ext_replacement, r"(?P\..*)"), + (version_replacement, r"(?P[0-9]+)"), + (comment_replacement, r"(?P.+?)"), + ): + comment_template = comment_template.replace(src, replacement) + file_template = file_template.replace(src, replacement) + + kwargs = {} + if platform.system().lower() == "windows": + kwargs["flags"] = re.IGNORECASE + + # Match from beginning to end of string to be safe + self._comment_template = re.compile(f"^{comment_template}$", **kwargs) + self._file_template = re.compile(f"^{file_template}$", **kwargs) + + def parse_data(self, filename: str) -> WorkfileParsedData: + """Parse the dynamic data from a filename.""" + match = self._comment_template.match(filename) + if not match: + match = self._file_template.match(filename) + + if not match: + return WorkfileParsedData() + + kwargs = match.groupdict() + version = kwargs.get("version") + if version is not None: + kwargs["version"] = int(version) + return WorkfileParsedData(**kwargs) + + +def parse_data_from_workfile( + filename: str, + file_template: str, + template_data: dict[str, Any], +) -> WorkfileParsedData: + parser = WorkfileDataParser(file_template, template_data) + return parser.parse_data(filename) + + def get_last_workfile_with_version_from_paths( filepaths: list[str], file_template: str, From e09f87262d06696ea1e4c4b74268240fecd6d682 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 18:16:43 +0200 Subject: [PATCH 131/170] store version and comment from filename to WorkfileInfo --- client/ayon_core/host/interfaces/workfiles.py | 59 +++++++++++++++---- 1 file changed, 46 insertions(+), 13 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 3c86d9caa3..53ec02ac57 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -639,6 +639,8 @@ class WorkfileInfo: filepath (str): Path to the workfile. rootless_path (str): Path to the workfile without the root. And without backslashes on Windows. + version (Optional[int]): Version of the workfile. + comment (Optional[str]): Comment of the workfile. file_size (Optional[float]): Size of the workfile in bytes. file_created (Optional[float]): Timestamp when the workfile was created on the filesystem. @@ -656,6 +658,8 @@ class WorkfileInfo: """ filepath: str rootless_path: str + version: Optional[int] + comment: Optional[str] file_size: Optional[float] file_created: Optional[float] file_modified: Optional[float] @@ -671,6 +675,8 @@ class WorkfileInfo: filepath: str, rootless_path: str, *, + version: Optional[int], + comment: Optional[str], available: bool, workfile_entity: dict[str, Any], ): @@ -691,6 +697,8 @@ class WorkfileInfo: return cls( filepath=filepath, rootless_path=rootless_path, + version=version, + comment=comment, file_size=file_size, file_created=file_created, file_modified=file_modified, @@ -1047,7 +1055,10 @@ class IWorkfileHost: """ from ayon_core.pipeline.template_data import get_template_data - from ayon_core.pipeline.workfile import get_workdir_with_workdir_data + from ayon_core.pipeline.workfile.path_resolving import ( + get_workdir_with_workdir_data, + WorkfileDataParser, + ) extensions = self.get_workfile_extensions() if not extensions: @@ -1080,22 +1091,18 @@ class IWorkfileHost: project_settings=list_workfiles_context.project_settings, ) + file_template = list_workfiles_context.anatomy.get_template_item( + "work", list_workfiles_context.template_key, "file" + ) + rootless_workdir = workdir.rootless if platform.system().lower() == "windows": - rootless_workdir = workdir.replace("\\", "/") - else: - rootless_workdir = workdir - - used_roots = workdir.used_values.get("root") - if used_roots: - used_root_name = next(iter(used_roots)) - root_value = used_roots[used_root_name] - workdir_end = rootless_workdir[len(root_value):].lstrip("/") - rootless_workdir = f"{{root[{used_root_name}]}}/{workdir_end}" + rootless_workdir = rootless_workdir.replace("\\", "/") filenames = [] if os.path.exists(workdir): filenames = list(os.listdir(workdir)) + data_parser = WorkfileDataParser(file_template, workdir_data) items = [] for filename in filenames: # TODO add 'default' support for folders @@ -1109,12 +1116,26 @@ class IWorkfileHost: workfile_entity = workfile_entities_by_path.pop( rootless_path, None ) - items.append(WorkfileInfo.new( + version = comment = None + if workfile_entity: + _data = workfile_entity["data"] + version = _data.get("version") + comment = _data.get("comment") + + if version is None: + parsed_data = data_parser.parse_data(filename) + version = parsed_data.version + comment = parsed_data.comment + + item = WorkfileInfo.new( filepath, rootless_path, + version=version, + comment=comment, available=True, workfile_entity=workfile_entity, - )) + ) + items.append(item) for workfile_entity in workfile_entities_by_path.values(): # Workfile entity is not in the filesystem @@ -1123,10 +1144,22 @@ class IWorkfileHost: ext = os.path.splitext(rootless_path)[1].lower() if ext not in extensions: continue + + _data = workfile_entity["data"] + version = _data.get("version") + comment = _data.get("comment") + if version is None: + filename = os.path.basename(rootless_path) + parsed_data = data_parser.parse_data(filename) + version = parsed_data.version + comment = parsed_data.comment + filepath = prepared_data.anatomy.fill_root(rootless_path) items.append(WorkfileInfo.new( filepath, rootless_path, + version=version, + comment=comment, available=False, workfile_entity=workfile_entity, )) From eeb839a65c0fa159bdf71b0fdf6771b38c8e8682 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 18:17:17 +0200 Subject: [PATCH 132/170] use version on workfile info to find last version --- client/ayon_core/pipeline/workfile/utils.py | 27 ++++++--------------- 1 file changed, 8 insertions(+), 19 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 0e24b33555..82326754b8 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -20,7 +20,6 @@ from ayon_core.pipeline.template_data import get_template_data from .path_resolving import ( get_workdir, get_workfile_template_key, - get_last_workfile_with_version_from_paths, ) if typing.TYPE_CHECKING: @@ -473,24 +472,16 @@ def save_next_version( template_key=template_key, ) ) - filepaths = [ - workfile.filepath + versions = { + workfile.version for workfile in workfiles - ] + if workfile.version is not None + } + version = None + if versions: + version = max(versions) + 1 - dotted_extensions = set() - for ext in workfile_extensions: - if not ext.startswith("."): - ext = f".{ext}" - dotted_extensions.add(ext) - - last_path, last_version = get_last_workfile_with_version_from_paths( - filepaths, - file_template, - template_data, - dotted_extensions, - ) - if last_path is None: + if version is None: version = get_versioning_start( project_name, host.name, @@ -498,8 +489,6 @@ def save_next_version( task_type=task_entity["taskType"], product_type="workfile" ) - else: - version = last_version + 1 template_data["version"] = version template_data["comment"] = comment From bc433532f02d192902663d556faf97bca955b413 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 18:17:28 +0200 Subject: [PATCH 133/170] always store all data even if are set to None --- client/ayon_core/pipeline/workfile/utils.py | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 82326754b8..0c3a50446d 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -586,13 +586,9 @@ def _create_workfile_info_entity( attrib[key] = value data = { - key: value - for key, value in ( - ("host_name", host_name), - ("version", version), - ("comment", comment), - ) - if value is not None + "host_name": host_name, + "version": version, + "comment": comment, } workfile_info = { From b9cad42dc28b7e1367a0dea119dc37f4849851e2 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 7 Jul 2025 18:17:47 +0200 Subject: [PATCH 134/170] use data from WorkfileInfo in workfiles tool --- .../tools/workfiles/models/workfiles.py | 66 ++++++++----------- 1 file changed, 29 insertions(+), 37 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index 35ffc3102c..b08a138cc2 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -466,19 +466,20 @@ class WorkfilesModel: template_has_comment = "{comment" in file_template_str file_items = self.get_workarea_file_items(folder_id, task_id) - filepaths = [ - item.filepath - for item in file_items - ] - comment_hints, comment = get_comments_from_workfile_paths( - filepaths, - extensions, - file_template, - fill_data, - current_filename, - ) + comment_hints = set() + comment = None + for item in file_items: + filepath = item.filepath + filename = os.path.basename(filepath) + if filename == current_filename: + comment = item.comment + + if item.comment: + comment_hints.add(item.comment) + comment_hints = list(comment_hints) + last_version = self._get_last_workfile_version( - filepaths, file_template_str, fill_data, extensions + file_items, task_entity ) return { @@ -530,15 +531,11 @@ class WorkfilesModel: if use_last_version: file_items = self.get_workarea_file_items(folder_id, task_id) - filepaths = [ - item.filepath - for item in file_items - ] + task_entity = self._controller.get_task_entity( + self._project_name, task_id + ) version = self._get_last_workfile_version( - filepaths, - file_template.template, - fill_data, - self._extensions + file_items, task_entity ) fill_data["version"] = version fill_data["ext"] = extension.lstrip(".") @@ -800,11 +797,7 @@ class WorkfilesModel: ) def _get_last_workfile_version( - self, - filepaths: list[str], - file_template: str, - fill_data: dict[str, Any], - extensions: set[str] + self, file_items: list[WorkfileInfo], task_entity: dict[str, Any] ) -> int: """ @@ -813,27 +806,26 @@ class WorkfilesModel: last version + 1 which might be wrong. Args: - filepaths (list[str]): Workfile paths. - file_template (str): File template. - fill_data (dict[str, Any]): Fill data. - extensions (set[str]): Extensions. + file_items (list[WorkfileInfo]): Workfile items. + task_entity (dict[str, Any]): Task entity. Returns: int: Next workfile version. """ - version = get_last_workfile_with_version_from_paths( - filepaths, file_template, fill_data, extensions - )[1] - if version is not None: - return version + 1 + versions = { + item.version + for item in file_items + if item.version is not None + } + if versions: + return max(versions) + 1 - task_info = fill_data.get("task", {}) return get_versioning_start( self._project_name, self._host_name, - task_name=task_info.get("name"), - task_type=task_info.get("type"), + task_name=task_entity["name"], + task_type=task_entity["taskType"], product_type="workfile", project_settings=self._controller.project_settings, ) From df9d58c384058241d54adde81780d7358907d1fa Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 8 Jul 2025 15:23:56 +0200 Subject: [PATCH 135/170] fix typo --- client/ayon_core/pipeline/create/context.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/create/context.py b/client/ayon_core/pipeline/create/context.py index 14b13613b6..e9f259e53b 100644 --- a/client/ayon_core/pipeline/create/context.py +++ b/client/ayon_core/pipeline/create/context.py @@ -79,7 +79,7 @@ _NOT_SET = object() INSTANCE_ADDED_TOPIC = "instances.added" INSTANCE_REMOVED_TOPIC = "instances.removed" VALUE_CHANGED_TOPIC = "values.changed" -INSTANCE_STATE_CHANGED_TOPIC = "instance.stated.changed" +INSTANCE_STATE_CHANGED_TOPIC = "instance.state.changed" PRE_CREATE_ATTR_DEFS_CHANGED_TOPIC = "pre.create.attr.defs.changed" CREATE_ATTR_DEFS_CHANGED_TOPIC = "create.attr.defs.changed" PUBLISH_ATTR_DEFS_CHANGED_TOPIC = "publish.attr.defs.changed" From 031ccebb45a548d0e54a936d9ab8f3770c5dd226 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 8 Jul 2025 17:39:47 +0200 Subject: [PATCH 136/170] use requirement instead of state --- client/ayon_core/pipeline/create/context.py | 34 +++++++++---------- .../ayon_core/pipeline/create/structures.py | 2 +- client/ayon_core/tools/publisher/control.py | 3 +- .../tools/publisher/models/create.py | 8 ++--- .../publisher/widgets/overview_widget.py | 2 +- 5 files changed, 25 insertions(+), 24 deletions(-) diff --git a/client/ayon_core/pipeline/create/context.py b/client/ayon_core/pipeline/create/context.py index e9f259e53b..fd66881344 100644 --- a/client/ayon_core/pipeline/create/context.py +++ b/client/ayon_core/pipeline/create/context.py @@ -79,7 +79,7 @@ _NOT_SET = object() INSTANCE_ADDED_TOPIC = "instances.added" INSTANCE_REMOVED_TOPIC = "instances.removed" VALUE_CHANGED_TOPIC = "values.changed" -INSTANCE_STATE_CHANGED_TOPIC = "instance.state.changed" +INSTANCE_REQUIREMENT_CHANGED_TOPIC = "instance.requirement.changed" PRE_CREATE_ATTR_DEFS_CHANGED_TOPIC = "pre.create.attr.defs.changed" CREATE_ATTR_DEFS_CHANGED_TOPIC = "create.attr.defs.changed" PUBLISH_ATTR_DEFS_CHANGED_TOPIC = "publish.attr.defs.changed" @@ -258,10 +258,10 @@ class CreateContext: "create_attrs_change": BulkInfo(), # Publish attribute definitions changed "publish_attrs_change": BulkInfo(), - # Instance state changed - # - right now used only for 'mandatory' state but can be extended + # Instance requirement changed + # - right now used only for 'mandatory' but can be extended # in future - "state_change": BulkInfo(), + "requirement_change": BulkInfo(), } self._bulk_order = [] @@ -1054,10 +1054,10 @@ class CreateContext: PUBLISH_ATTR_DEFS_CHANGED_TOPIC, callback ) - def add_instance_state_change_callback( + def add_instance_requirement_change_callback( self, callback: Callable ) -> "EventCallback": - """Register callback to listen instance state changes. + """Register callback to listen instance requirement changes. Create plugin changed attribute definitions of instance. @@ -1072,7 +1072,7 @@ class CreateContext: Args: callback (Callable): Callback function that will be called when - create attributes changed. + instance requirement changed. Returns: EventCallback: Created callback object which can be used to @@ -1080,7 +1080,7 @@ class CreateContext: """ return self._event_hub.add_callback( - INSTANCE_STATE_CHANGED_TOPIC, callback + INSTANCE_REQUIREMENT_CHANGED_TOPIC, callback ) def context_data_to_store(self) -> dict[str, Any]: @@ -1358,9 +1358,9 @@ class CreateContext: yield bulk_info @contextmanager - def bulk_instance_state_change(self, sender: Optional[str] = None): + def bulk_instance_requirement_change(self, sender: Optional[str] = None): with self._bulk_context( - "state_change", sender + "requirement_change", sender ) as bulk_info: yield bulk_info @@ -1431,8 +1431,8 @@ class CreateContext: with self.bulk_value_changes() as bulk_item: bulk_item.append((instance_id, new_values)) - def instance_state_changed(self, instance_id: str) -> None: - """Instance state changed. + def instance_requirement_changed(self, instance_id: str) -> None: + """Instance requirement changed. Triggered by `CreatedInstance`. @@ -1441,7 +1441,7 @@ class CreateContext: """ if self._is_instance_events_ready(instance_id): - with self.bulk_instance_state_change() as bulk_item: + with self.bulk_instance_requirement_change() as bulk_item: bulk_item.append(instance_id) # --- context change callbacks --- @@ -2303,8 +2303,8 @@ class CreateContext: self._bulk_create_attrs_change_finished(data, sender) elif key == "publish_attrs_change": self._bulk_publish_attrs_change_finished(data, sender) - elif key == "state_change": - self._bulk_instance_state_change_finished(data, sender) + elif key == "requirement_change": + self._bulk_instance_requirement_change_finished(data, sender) def _bulk_add_instances_finished( self, @@ -2500,7 +2500,7 @@ class CreateContext: sender, ) - def _bulk_instance_state_change_finished( + def _bulk_instance_requirement_change_finished( self, instance_ids: list[str], sender: Optional[str], @@ -2514,7 +2514,7 @@ class CreateContext: ] self._emit_event( - INSTANCE_STATE_CHANGED_TOPIC, + INSTANCE_REQUIREMENT_CHANGED_TOPIC, {"instances": instances}, sender, ) diff --git a/client/ayon_core/pipeline/create/structures.py b/client/ayon_core/pipeline/create/structures.py index 1bc20501cc..a4c68d2502 100644 --- a/client/ayon_core/pipeline/create/structures.py +++ b/client/ayon_core/pipeline/create/structures.py @@ -750,7 +750,7 @@ class CreatedInstance: self._is_mandatory = value if value is True: self["active"] = True - self._create_context.instance_state_changed(self.id) + self._create_context.instance_requirement_changed(self.id) def changes(self): """Calculate and return changes.""" diff --git a/client/ayon_core/tools/publisher/control.py b/client/ayon_core/tools/publisher/control.py index b551b21bd4..038816c6fc 100644 --- a/client/ayon_core/tools/publisher/control.py +++ b/client/ayon_core/tools/publisher/control.py @@ -53,7 +53,8 @@ class PublisherController( changed. "create.context.create.attrs.changed" - Create attributes changed. "create.context.publish.attrs.changed" - Publish attributes changed. - "create.context.instance.state.changed" - Instance state changed. + "create.context.instance.requirement.changed" - Instance requirement + changed. "create.context.removed.instance" - Instance removed from context. "create.model.instances.context.changed" - Instances changed context. like folder, task or variant. diff --git a/client/ayon_core/tools/publisher/models/create.py b/client/ayon_core/tools/publisher/models/create.py index 7f44b374e6..75ed2c73fe 100644 --- a/client/ayon_core/tools/publisher/models/create.py +++ b/client/ayon_core/tools/publisher/models/create.py @@ -483,8 +483,8 @@ class CreateModel: self._create_context.add_publish_attr_defs_change_callback( self._cc_publish_attr_changed ) - self._create_context.add_instance_state_change_callback( - self._cc_instance_state_changed + self._create_context.add_instance_requirement_change_callback( + self._cc_instance_requirement_changed ) self._create_context.reset_finalization() @@ -1181,13 +1181,13 @@ class CreateModel: event_data, ) - def _cc_instance_state_changed(self, event): + def _cc_instance_requirement_changed(self, event): instance_ids = { instance.id for instance in event.data["instances"] } self._emit_event( - "create.context.instance.state.changed", + "create.model.instance.requirement.changed", {"instance_ids": instance_ids}, ) diff --git a/client/ayon_core/tools/publisher/widgets/overview_widget.py b/client/ayon_core/tools/publisher/widgets/overview_widget.py index 44bb09d4fc..a7e099c0d0 100644 --- a/client/ayon_core/tools/publisher/widgets/overview_widget.py +++ b/client/ayon_core/tools/publisher/widgets/overview_widget.py @@ -156,7 +156,7 @@ class OverviewWidget(QtWidgets.QFrame): self._on_instance_context_change ) controller.register_event_callback( - "create.model.instance.state.changed", + "create.model.instance.requirement.changed", self._on_instance_state_changed ) From 4a9132132b7b06202b552b06aaab4653c32633a7 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Tue, 8 Jul 2025 17:42:01 +0200 Subject: [PATCH 137/170] one more method name change --- client/ayon_core/tools/publisher/widgets/overview_widget.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/publisher/widgets/overview_widget.py b/client/ayon_core/tools/publisher/widgets/overview_widget.py index a7e099c0d0..46395328e0 100644 --- a/client/ayon_core/tools/publisher/widgets/overview_widget.py +++ b/client/ayon_core/tools/publisher/widgets/overview_widget.py @@ -157,7 +157,7 @@ class OverviewWidget(QtWidgets.QFrame): ) controller.register_event_callback( "create.model.instance.requirement.changed", - self._on_instance_state_changed + self._on_instance_requirement_changed ) self._product_content_widget = product_content_widget @@ -358,7 +358,7 @@ class OverviewWidget(QtWidgets.QFrame): def _on_instance_context_change(self, event): self._refresh_instance_states(event["instance_ids"]) - def _on_instance_state_changed(self, event): + def _on_instance_requirement_changed(self, event): self._refresh_instance_states(event["instance_ids"]) def _refresh_instance_states(self, instance_ids): From 6fd5ee7ed0e5ff274cd814f41c8ff31ccdf4a926 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:06:18 +0200 Subject: [PATCH 138/170] use context instead of prepared data --- client/ayon_core/host/interfaces/workfiles.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 53ec02ac57..b6c33337e9 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1154,7 +1154,7 @@ class IWorkfileHost: version = parsed_data.version comment = parsed_data.comment - filepath = prepared_data.anatomy.fill_root(rootless_path) + filepath = list_workfiles_context.anatomy.fill_root(rootless_path) items.append(WorkfileInfo.new( filepath, rootless_path, @@ -1203,14 +1203,14 @@ class IWorkfileHost: versions_by_id = { version_entity["id"]: version_entity - for version_entity in prepared_data.version_entities + for version_entity in list_workfiles_context.version_entities } extensions = { ext.lstrip(".") for ext in self.get_workfile_extensions() } items = [] - for repre_entity in prepared_data.repre_entities: + for repre_entity in list_workfiles_context.repre_entities: version_id = repre_entity["versionId"] version_entity = versions_by_id[version_id] task_id = version_entity["taskId"] @@ -1232,7 +1232,7 @@ class IWorkfileHost: try: workfile_path = workfile_path.format( - root=prepared_data.anatomy.roots + root=list_workfiles_context.anatomy.roots ) except Exception: self.log.warning( From 77a31cb5e95003fd6e97e7d01e5aa036bc3b07e2 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:14:58 +0200 Subject: [PATCH 139/170] added helper functions to parse dynamic data from workfile --- .../pipeline/workfile/path_resolving.py | 41 ++++++++++++++++++- 1 file changed, 40 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index ed7ac03e81..b750e3bf47 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -284,15 +284,54 @@ class WorkfileDataParser: return WorkfileParsedData(**kwargs) -def parse_data_from_workfile( +def parse_dynamic_data_from_workfile( filename: str, file_template: str, template_data: dict[str, Any], ) -> WorkfileParsedData: + """Parse dynamic data from a workfile filename. + + Dynamic data are 'version', 'comment' and 'ext'. + + Args: + filename (str): Workfile filename. + file_template (str): Workfile file template. + template_data (dict[str, Any]): Data to fill the template with. + + Returns: + WorkfileParsedData: Dynamic data parsed from the filename. + + """ parser = WorkfileDataParser(file_template, template_data) return parser.parse_data(filename) +def parse_dynamic_data_from_workfiles( + filenames: list[str], + file_template: str, + template_data: dict[str, Any], +) -> dict[str, WorkfileParsedData]: + """Parse dynamic data from a workfiles filenames. + + Dynamic data are 'version', 'comment' and 'ext'. + + Args: + filenames (list[str]): Workfiles filenames. + file_template (str): Workfile file template. + template_data (dict[str, Any]): Data to fill the template with. + + Returns: + dict[str, WorkfileParsedData]: Dynamic data parsed from the filenames + by filename. + + """ + parser = WorkfileDataParser(file_template, template_data) + return { + filename: parser.parse_data(filename) + for filename in filenames + } + + def get_last_workfile_with_version_from_paths( filepaths: list[str], file_template: str, From 567c8ed650bf523c724a6ddc6d9e34cc830f238c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:15:12 +0200 Subject: [PATCH 140/170] added warnings to comment matcher function and class --- .../ayon_core/pipeline/workfile/path_resolving.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index b750e3bf47..3f7d23f07f 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -824,6 +824,12 @@ class CommentMatcher: file_template: StringTemplate, data: dict[str, Any] ): + warnings.warn( + "Class 'CommentMatcher' is deprecated. Please" + " use 'parse_dynamic_data_from_workfiles' instead.", + DeprecationWarning, + stacklevel=2, + ) self._fname_regex = None if "{comment}" not in file_template: @@ -873,7 +879,7 @@ def get_comments_from_workfile_paths( template_data: dict[str, Any], current_filename: Optional[str] = None, ) -> tuple[list[str], str]: - """Collect comments from workfile filenames. + """DEPRECATED Collect comments from workfile filenames. Based on 'current_filename' is also returned "current comment". @@ -888,6 +894,12 @@ def get_comments_from_workfile_paths( tuple[list[str], str]: List of comments and the current comment. """ + warnings.warn( + "Function 'get_comments_from_workfile_paths' is deprecated. Please" + " use 'parse_dynamic_data_from_workfiles' instead.", + DeprecationWarning, + stacklevel=2, + ) current_comment = "" if not filepaths: return [], current_comment From bb4b975bf59692bf752bbedcd88c850e13988e6b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:17:56 +0200 Subject: [PATCH 141/170] added explaining comment --- client/ayon_core/pipeline/workfile/path_resolving.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index 3f7d23f07f..a13fe6b5cc 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -249,7 +249,14 @@ class WorkfileDataParser: file_template = re.sub(pattern, replacement, file_template) file_template = StringTemplate(file_template) + # Prepare template that does contain 'comment' comment_template = re.escape(str(file_template.format_strict(data))) + # Prepare template that does not contain 'comment' + # - comment is usually marked as optional and in that case the regex + # to find the comment is different based on the filename + # - if filename contains comment then 'comment_template' will match + # - if filename does not contain comment then 'file_template' will + # match data.pop("comment") file_template = re.escape(str(file_template.format_strict(data))) for src, replacement in ( From 86ce8d799bb12326c226a88032ec9d7f48ab39e4 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:22:02 +0200 Subject: [PATCH 142/170] remove unused imports --- client/ayon_core/tools/workfiles/models/workfiles.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/client/ayon_core/tools/workfiles/models/workfiles.py b/client/ayon_core/tools/workfiles/models/workfiles.py index b08a138cc2..d33a532222 100644 --- a/client/ayon_core/tools/workfiles/models/workfiles.py +++ b/client/ayon_core/tools/workfiles/models/workfiles.py @@ -35,8 +35,6 @@ from ayon_core.pipeline.template_data import ( from ayon_core.pipeline.workfile import ( get_workdir_with_workdir_data, get_workfile_template_key, - get_last_workfile_with_version_from_paths, - get_comments_from_workfile_paths, save_workfile_info, ) from ayon_core.pipeline.version_start import get_versioning_start From e9e6c68523dd2da20c031381006375427630f24c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:22:11 +0200 Subject: [PATCH 143/170] fix line length --- client/ayon_core/pipeline/workfile/path_resolving.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/path_resolving.py b/client/ayon_core/pipeline/workfile/path_resolving.py index a13fe6b5cc..b806f1ebf0 100644 --- a/client/ayon_core/pipeline/workfile/path_resolving.py +++ b/client/ayon_core/pipeline/workfile/path_resolving.py @@ -243,7 +243,8 @@ class WorkfileDataParser: data["version"] = version_replacement data["comment"] = comment_replacement for pattern, replacement in ( - # Replace `.{ext}` with `{ext}` so we are sure dot is not at the end + # Replace `.{ext}` with `{ext}` so we are sure dot is not + # at the end (r"\.?{ext}", ext_replacement), ): file_template = re.sub(pattern, replacement, file_template) From ef4c5d676187fa6bb31a0e0857be2359b73d1723 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:31:29 +0200 Subject: [PATCH 144/170] added anotations import --- client/ayon_core/tools/loader/control.py | 2 ++ client/ayon_core/tools/loader/ui/_multicombobox.py | 1 + client/ayon_core/tools/loader/ui/products_delegates.py | 3 +-- client/ayon_core/tools/loader/ui/products_widget.py | 1 + client/ayon_core/tools/loader/ui/search_bar.py | 2 ++ client/ayon_core/tools/loader/ui/window.py | 2 ++ 6 files changed, 9 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/tools/loader/control.py b/client/ayon_core/tools/loader/control.py index 95f48b3519..7ba42a0981 100644 --- a/client/ayon_core/tools/loader/control.py +++ b/client/ayon_core/tools/loader/control.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import logging import uuid diff --git a/client/ayon_core/tools/loader/ui/_multicombobox.py b/client/ayon_core/tools/loader/ui/_multicombobox.py index 393272fdf9..b4e1707242 100644 --- a/client/ayon_core/tools/loader/ui/_multicombobox.py +++ b/client/ayon_core/tools/loader/ui/_multicombobox.py @@ -1,4 +1,5 @@ from __future__ import annotations + import typing from typing import List, Tuple, Optional, Iterable, Any diff --git a/client/ayon_core/tools/loader/ui/products_delegates.py b/client/ayon_core/tools/loader/ui/products_delegates.py index e78b32ceb1..b500b86b97 100644 --- a/client/ayon_core/tools/loader/ui/products_delegates.py +++ b/client/ayon_core/tools/loader/ui/products_delegates.py @@ -2,7 +2,6 @@ from __future__ import annotations import numbers import uuid -from typing import Dict from qtpy import QtWidgets, QtCore, QtGui @@ -249,7 +248,7 @@ class VersionDelegate(QtWidgets.QStyledItemDelegate): def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) - self._editor_by_id: Dict[str, VersionComboBox] = {} + self._editor_by_id: dict[str, VersionComboBox] = {} self._task_ids_filter = None self._statuses_filter = None self._version_tags_filter = None diff --git a/client/ayon_core/tools/loader/ui/products_widget.py b/client/ayon_core/tools/loader/ui/products_widget.py index f1c82ee83d..e5bb75a208 100644 --- a/client/ayon_core/tools/loader/ui/products_widget.py +++ b/client/ayon_core/tools/loader/ui/products_widget.py @@ -1,4 +1,5 @@ from __future__ import annotations + import collections from typing import Optional diff --git a/client/ayon_core/tools/loader/ui/search_bar.py b/client/ayon_core/tools/loader/ui/search_bar.py index ab673df1ac..a855a3c452 100644 --- a/client/ayon_core/tools/loader/ui/search_bar.py +++ b/client/ayon_core/tools/loader/ui/search_bar.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import copy import uuid from dataclasses import dataclass diff --git a/client/ayon_core/tools/loader/ui/window.py b/client/ayon_core/tools/loader/ui/window.py index d056b62b13..df5beb708f 100644 --- a/client/ayon_core/tools/loader/ui/window.py +++ b/client/ayon_core/tools/loader/ui/window.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from qtpy import QtWidgets, QtCore, QtGui from ayon_core.resources import get_ayon_icon_filepath From 0927358cd862bec7c3ae253c5af6db01bc59250c Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 15:51:36 +0200 Subject: [PATCH 145/170] add more annotations imports --- client/ayon_core/tools/loader/models/actions.py | 2 ++ client/ayon_core/tools/loader/models/products.py | 1 + client/ayon_core/tools/loader/models/selection.py | 3 +++ client/ayon_core/tools/loader/models/sitesync.py | 2 ++ 4 files changed, 8 insertions(+) diff --git a/client/ayon_core/tools/loader/models/actions.py b/client/ayon_core/tools/loader/models/actions.py index 40331d73a4..b792f92dfd 100644 --- a/client/ayon_core/tools/loader/models/actions.py +++ b/client/ayon_core/tools/loader/models/actions.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import sys import traceback import inspect diff --git a/client/ayon_core/tools/loader/models/products.py b/client/ayon_core/tools/loader/models/products.py index edf8efc3b3..87e2406c81 100644 --- a/client/ayon_core/tools/loader/models/products.py +++ b/client/ayon_core/tools/loader/models/products.py @@ -1,5 +1,6 @@ """Products model for loader tools.""" from __future__ import annotations + import collections import contextlib from typing import TYPE_CHECKING, Iterable, Optional diff --git a/client/ayon_core/tools/loader/models/selection.py b/client/ayon_core/tools/loader/models/selection.py index 04add26f86..f2148352cd 100644 --- a/client/ayon_core/tools/loader/models/selection.py +++ b/client/ayon_core/tools/loader/models/selection.py @@ -1,3 +1,6 @@ +from __future__ import annotations + + class SelectionModel(object): """Model handling selection changes. diff --git a/client/ayon_core/tools/loader/models/sitesync.py b/client/ayon_core/tools/loader/models/sitesync.py index c7f0038df4..3a54a1b5f8 100644 --- a/client/ayon_core/tools/loader/models/sitesync.py +++ b/client/ayon_core/tools/loader/models/sitesync.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import collections from ayon_api import ( From 02ed6cb9e080a1f3f0e751dd046fe14470edb1f7 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 16:34:33 +0200 Subject: [PATCH 146/170] remove double slashes --- client/ayon_core/host/interfaces/workfiles.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index b6c33337e9..193d59322b 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1113,6 +1113,11 @@ class IWorkfileHost: filepath = os.path.join(workdir, filename) rootless_path = f"{rootless_workdir}/{filename}" + # Double slashes can happen when root leads to root of disk or + # when task exists on root folder + # - '/{hierarchy}/{folder[name]}' -> '//some_folder' + while "//" in rootless_path: + rootless_path = rootless_path.replace("//", "/") workfile_entity = workfile_entities_by_path.pop( rootless_path, None ) From 6b452e49291db234a0bc8d37105baf4c5571139e Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 9 Jul 2025 17:50:35 +0200 Subject: [PATCH 147/170] fix the slashes issue at the root --- client/ayon_core/host/interfaces/workfiles.py | 5 ----- client/ayon_core/lib/path_templates.py | 7 ++++++- client/ayon_core/pipeline/anatomy/templates.py | 10 ++++++++++ 3 files changed, 16 insertions(+), 6 deletions(-) diff --git a/client/ayon_core/host/interfaces/workfiles.py b/client/ayon_core/host/interfaces/workfiles.py index 193d59322b..b6c33337e9 100644 --- a/client/ayon_core/host/interfaces/workfiles.py +++ b/client/ayon_core/host/interfaces/workfiles.py @@ -1113,11 +1113,6 @@ class IWorkfileHost: filepath = os.path.join(workdir, filename) rootless_path = f"{rootless_workdir}/{filename}" - # Double slashes can happen when root leads to root of disk or - # when task exists on root folder - # - '/{hierarchy}/{folder[name]}' -> '//some_folder' - while "//" in rootless_path: - rootless_path = rootless_path.replace("//", "/") workfile_entity = workfile_entities_by_path.pop( rootless_path, None ) diff --git a/client/ayon_core/lib/path_templates.py b/client/ayon_core/lib/path_templates.py index 9e3e455a6c..c6e9e14eac 100644 --- a/client/ayon_core/lib/path_templates.py +++ b/client/ayon_core/lib/path_templates.py @@ -3,6 +3,7 @@ import re import copy import numbers import warnings +import platform from string import Formatter import typing from typing import List, Dict, Any, Set @@ -12,6 +13,7 @@ if typing.TYPE_CHECKING: SUB_DICT_PATTERN = re.compile(r"([^\[\]]+)") OPTIONAL_PATTERN = re.compile(r"(<.*?[^{0]*>)[^0-9]*?") +_IS_WINDOWS = platform.system().lower() == "windows" class TemplateUnsolved(Exception): @@ -277,8 +279,11 @@ class TemplateResult(str): """Convert to normalized path.""" cls = self.__class__ + path = str(self) + if _IS_WINDOWS: + path = path.replace("\\", "/") return cls( - os.path.normpath(self.replace("\\", "/")), + os.path.normpath(path), self.template, self.solved, self.used_values, diff --git a/client/ayon_core/pipeline/anatomy/templates.py b/client/ayon_core/pipeline/anatomy/templates.py index d89b70719e..e3ec005089 100644 --- a/client/ayon_core/pipeline/anatomy/templates.py +++ b/client/ayon_core/pipeline/anatomy/templates.py @@ -1,6 +1,7 @@ import os import re import copy +import platform import collections import numbers @@ -15,6 +16,7 @@ from .exceptions import ( AnatomyTemplateUnsolved, ) +_IS_WINDOWS = platform.system().lower() == "windows" _PLACEHOLDER = object() @@ -526,6 +528,14 @@ class AnatomyTemplates: root_key = "{" + root_key + "}" output = output.replace(str(used_value), root_key) + # Make sure rootless path is with forward slashes + if _IS_WINDOWS: + output.replace("\\", "/") + + # Make sure there are no double slashes + while "//" in output: + output = output.replace("//", "/") + return output def format(self, data, strict=True): From 11c7119aa550cbd6ed9758d5f1793ec1af0cdd9a Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 9 Jul 2025 18:53:06 +0200 Subject: [PATCH 148/170] Add photoshop review to be handled by global extract_review --- client/ayon_core/plugins/publish/extract_review.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/plugins/publish/extract_review.py b/client/ayon_core/plugins/publish/extract_review.py index a5f541225c..7aa40a17a4 100644 --- a/client/ayon_core/plugins/publish/extract_review.py +++ b/client/ayon_core/plugins/publish/extract_review.py @@ -162,6 +162,7 @@ class ExtractReview(pyblish.api.InstancePlugin): "flame", "unreal", "circuit", + "photoshop" ] # Supported extensions From de0e069a419c78af7916a1d45283ee19df95ea49 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 9 Jul 2025 18:53:28 +0200 Subject: [PATCH 149/170] Add photoshop thumbnails to be handled by global extract_thumbnail --- client/ayon_core/plugins/publish/extract_thumbnail.py | 1 + 1 file changed, 1 insertion(+) diff --git a/client/ayon_core/plugins/publish/extract_thumbnail.py b/client/ayon_core/plugins/publish/extract_thumbnail.py index 69bb9007f9..66acb15312 100644 --- a/client/ayon_core/plugins/publish/extract_thumbnail.py +++ b/client/ayon_core/plugins/publish/extract_thumbnail.py @@ -38,6 +38,7 @@ class ExtractThumbnail(pyblish.api.InstancePlugin): "substancedesigner", "nuke", "aftereffects", + "photoshop", "unreal", "houdini", "circuit", From 50ae9ee4189bd9482d9ed1c9d10a34bd21d3af81 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 9 Jul 2025 18:54:25 +0200 Subject: [PATCH 150/170] Added photoshop specific defaults to ExtractReview More closely follow what PS was doing internally. --- server/settings/publish_plugins.py | 97 ++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) diff --git a/server/settings/publish_plugins.py b/server/settings/publish_plugins.py index d690d79607..b14f43e48a 100644 --- a/server/settings/publish_plugins.py +++ b/server/settings/publish_plugins.py @@ -1442,6 +1442,103 @@ DEFAULT_PUBLISH_VALUES = { "fill_missing_frames": "closest_existing" } ] + }, + { + "product_types": [], + "hosts": ["photoshop"], + "outputs": [ + { + "name": "jpg", + "ext": "jpg", + "tags": [ + "ftrackreview", + "kitsureview", + "webreview" + ], + "burnins": [], + "ffmpeg_args": { + "video_filters": [], + "audio_filters": [], + "input": [], + "output": [] + }, + "filter": { + "families": [ + "render", + "review", + "ftrack" + ], + "product_names": [], + "custom_tags": [], + "single_frame_filter": "single_frame" + }, + "overscan_crop": "", + # "overscan_color": [0, 0, 0], + "overscan_color": [0, 0, 0, 0.0], + "width": 1920, + "height": 1080, + "scale_pixel_aspect": True, + "bg_color": [0, 0, 0, 0.0], + "letter_box": { + "enabled": False, + "ratio": 0.0, + "fill_color": [0, 0, 0, 1.0], + "line_thickness": 0, + "line_color": [255, 0, 0, 1.0] + }, + "fill_missing_frames": "closest_existing" + }, + { + "name": "mov", + "ext": "mov", + "tags": [ + "ftrackreview", + "kitsureview", + "webreview" + ], + "burnins": [], + "ffmpeg_args": { + "video_filters": [], + "audio_filters": [], + "input": [ + "-apply_trc gamma22" + ], + "output": [ + "-pix_fmt yuv420p", + "-crf 18", + "-c:a aac", + "-b:a 192k", + "-g 1", + "-movflags faststart" + ] + }, + "filter": { + "families": [ + "render", + "review", + "ftrack" + ], + "product_names": [], + "custom_tags": [], + "single_frame_filter": "multi_frame" + }, + "overscan_crop": "", + # "overscan_color": [0, 0, 0], + "overscan_color": [0, 0, 0, 0.0], + "width": 0, + "height": 0, + "scale_pixel_aspect": True, + "bg_color": [0, 0, 0, 0.0], + "letter_box": { + "enabled": False, + "ratio": 0.0, + "fill_color": [0, 0, 0, 1.0], + "line_thickness": 0, + "line_color": [255, 0, 0, 1.0] + }, + "fill_missing_frames": "closest_existing" + } + ] } ] }, From 8f995df928f5550eeed0b023c73c5ba89da733e3 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 10 Jul 2025 08:29:44 +0200 Subject: [PATCH 151/170] fix docstring --- client/ayon_core/pipeline/create/context.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/client/ayon_core/pipeline/create/context.py b/client/ayon_core/pipeline/create/context.py index fd66881344..cd06b06ea3 100644 --- a/client/ayon_core/pipeline/create/context.py +++ b/client/ayon_core/pipeline/create/context.py @@ -1057,9 +1057,9 @@ class CreateContext: def add_instance_requirement_change_callback( self, callback: Callable ) -> "EventCallback": - """Register callback to listen instance requirement changes. + """Register callback to listen to instance requirement changes. - Create plugin changed attribute definitions of instance. + Instance changed requirement of active state. Data structure of event:: From d1fe9d4af6928c5ae259d843142e04842c0633d0 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Thu, 10 Jul 2025 08:29:55 +0200 Subject: [PATCH 152/170] removed doubled doble colon --- client/ayon_core/pipeline/create/context.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/client/ayon_core/pipeline/create/context.py b/client/ayon_core/pipeline/create/context.py index cd06b06ea3..929cc59d2a 100644 --- a/client/ayon_core/pipeline/create/context.py +++ b/client/ayon_core/pipeline/create/context.py @@ -872,7 +872,7 @@ class CreateContext: Event is triggered when instances are already available in context and have set create/publish attribute definitions. - Data structure of event:: + Data structure of event: ```python { @@ -899,7 +899,7 @@ class CreateContext: Event is triggered when instances are already removed from context. - Data structure of event:: + Data structure of event: ```python { @@ -927,7 +927,7 @@ class CreateContext: Event is triggered when any value changes on any instance or context data. - Data structure of event:: + Data structure of event: ```python { @@ -965,7 +965,7 @@ class CreateContext: Create plugin can trigger refresh of pre-create attributes. Usage of this event is mainly for publisher UI. - Data structure of event:: + Data structure of event: ```python { @@ -994,7 +994,7 @@ class CreateContext: Create plugin changed attribute definitions of instance. - Data structure of event:: + Data structure of event: ```python { @@ -1023,7 +1023,7 @@ class CreateContext: Publish plugin changed attribute definitions of instance of context. - Data structure of event:: + Data structure of event: ```python { @@ -1061,7 +1061,7 @@ class CreateContext: Instance changed requirement of active state. - Data structure of event:: + Data structure of event: ```python { From bb4131e0e5148d509b59d097f6b3d579dce0e582 Mon Sep 17 00:00:00 2001 From: Ynbot Date: Thu, 10 Jul 2025 06:41:18 +0000 Subject: [PATCH 153/170] [Automated] Add generated package files from main --- client/ayon_core/version.py | 2 +- package.py | 2 +- pyproject.toml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/version.py b/client/ayon_core/version.py index df92396802..963fc9ecdc 100644 --- a/client/ayon_core/version.py +++ b/client/ayon_core/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring AYON addon 'core' version.""" -__version__ = "1.4.0+dev" +__version__ = "1.4.1" diff --git a/package.py b/package.py index efed91b6cf..acc27aa7b8 100644 --- a/package.py +++ b/package.py @@ -1,6 +1,6 @@ name = "core" title = "Core" -version = "1.4.0+dev" +version = "1.4.1" client_dir = "ayon_core" diff --git a/pyproject.toml b/pyproject.toml index 91579f04fb..9b89ab23ac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ [tool.poetry] name = "ayon-core" -version = "1.4.0+dev" +version = "1.4.1" description = "" authors = ["Ynput Team "] readme = "README.md" From f6d39301ecab441c75457c8935283dd455c1c5ae Mon Sep 17 00:00:00 2001 From: Ynbot Date: Thu, 10 Jul 2025 06:41:50 +0000 Subject: [PATCH 154/170] [Automated] Update version in package.py for develop --- client/ayon_core/version.py | 2 +- package.py | 2 +- pyproject.toml | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/client/ayon_core/version.py b/client/ayon_core/version.py index 963fc9ecdc..509c4a8d14 100644 --- a/client/ayon_core/version.py +++ b/client/ayon_core/version.py @@ -1,3 +1,3 @@ # -*- coding: utf-8 -*- """Package declaring AYON addon 'core' version.""" -__version__ = "1.4.1" +__version__ = "1.4.1+dev" diff --git a/package.py b/package.py index acc27aa7b8..039bf0379c 100644 --- a/package.py +++ b/package.py @@ -1,6 +1,6 @@ name = "core" title = "Core" -version = "1.4.1" +version = "1.4.1+dev" client_dir = "ayon_core" diff --git a/pyproject.toml b/pyproject.toml index 9b89ab23ac..9609729420 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ [tool.poetry] name = "ayon-core" -version = "1.4.1" +version = "1.4.1+dev" description = "" authors = ["Ynput Team "] readme = "README.md" From f6077eea2d089e7aafa696acfccd4958263ab23d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 10 Jul 2025 06:42:43 +0000 Subject: [PATCH 155/170] chore(): update bug report / version --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index eff53116a2..9fb6ee645d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -35,6 +35,7 @@ body: label: Version description: What version are you running? Look to AYON Tray options: + - 1.4.1 - 1.4.0 - 1.3.2 - 1.3.1 From dce81ba92d66adb9aafe67ad4c3df38f17708727 Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Mon, 14 Jul 2025 12:03:38 +0200 Subject: [PATCH 156/170] If an instance is not set to `integrate` then skip the validation check against it. This should fix the issue described [here](https://community.ynput.io/t/houdini-local-render-and-publish-existing-frames-error/2647/7?u=bigroy) where a matching "render instance" is generated for the local rendering spawning off from an initial instance - where the initial instance becomes set to not integrate (integrate=False) but remain available for further validations (publish=True). --- client/ayon_core/plugins/publish/validate_unique_subsets.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/plugins/publish/validate_unique_subsets.py b/client/ayon_core/plugins/publish/validate_unique_subsets.py index 4067dd75a5..e91cd16374 100644 --- a/client/ayon_core/plugins/publish/validate_unique_subsets.py +++ b/client/ayon_core/plugins/publish/validate_unique_subsets.py @@ -34,7 +34,11 @@ class ValidateProductUniqueness(pyblish.api.ContextPlugin): for instance in context: # Ignore disabled instances - if not instance.data.get('publish', True): + if not instance.data.get("publish", True): + continue + + # Ignore disabled instances + if not instance.data.get("integrate", True): continue # Ignore instance without folder data From 1e98481a10a58c433ef8d4dd0ac68a8099f28cca Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Mon, 14 Jul 2025 12:06:07 +0200 Subject: [PATCH 157/170] Tweak comment --- client/ayon_core/plugins/publish/validate_unique_subsets.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/plugins/publish/validate_unique_subsets.py b/client/ayon_core/plugins/publish/validate_unique_subsets.py index e91cd16374..26c9ada116 100644 --- a/client/ayon_core/plugins/publish/validate_unique_subsets.py +++ b/client/ayon_core/plugins/publish/validate_unique_subsets.py @@ -37,7 +37,7 @@ class ValidateProductUniqueness(pyblish.api.ContextPlugin): if not instance.data.get("publish", True): continue - # Ignore disabled instances + # Ignore instances not marked to integrate if not instance.data.get("integrate", True): continue From 37980d2299909b3b108f41f5998e231b43e25dab Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Mon, 14 Jul 2025 14:54:58 +0200 Subject: [PATCH 158/170] Fix all characters of report being printed to new lines --- client/ayon_core/pipeline/publish/lib.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/publish/lib.py b/client/ayon_core/pipeline/publish/lib.py index 49143c4426..fb84417730 100644 --- a/client/ayon_core/pipeline/publish/lib.py +++ b/client/ayon_core/pipeline/publish/lib.py @@ -1048,7 +1048,7 @@ def main_cli_publish( discover_result = publish_plugins_discover() publish_plugins = discover_result.plugins - print("\n".join(discover_result.get_report(only_errors=False))) + print(discover_result.get_report(only_errors=False)) # Error exit as soon as any error occurs. error_format = ("Failed {plugin.__name__}: " From 0a75ab09c509fecfb180fd38513920a3be564c6a Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Mon, 14 Jul 2025 21:59:28 +0200 Subject: [PATCH 159/170] Report the actual class name --- client/ayon_core/pipeline/plugin_discover.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/plugin_discover.py b/client/ayon_core/pipeline/plugin_discover.py index f531600276..03da7fce79 100644 --- a/client/ayon_core/pipeline/plugin_discover.py +++ b/client/ayon_core/pipeline/plugin_discover.py @@ -51,7 +51,7 @@ class DiscoverResult: "*** Discovered {} plugins".format(len(self.plugins)) ) for cls in self.plugins: - lines.append("- {}".format(cls.__class__.__name__)) + lines.append("- {}".format(cls.__name__)) # Plugin that were defined to be ignored if self.ignored_plugins or full_report: From baba4e4d7d6dcb85c8df9cd970914a08fd34996f Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 16 Jul 2025 12:43:54 +0200 Subject: [PATCH 160/170] Revert "Added photoshop specific defaults to ExtractReview" This reverts commit 50ae9ee4189bd9482d9ed1c9d10a34bd21d3af81. --- server/settings/publish_plugins.py | 97 ------------------------------ 1 file changed, 97 deletions(-) diff --git a/server/settings/publish_plugins.py b/server/settings/publish_plugins.py index b14f43e48a..d690d79607 100644 --- a/server/settings/publish_plugins.py +++ b/server/settings/publish_plugins.py @@ -1442,103 +1442,6 @@ DEFAULT_PUBLISH_VALUES = { "fill_missing_frames": "closest_existing" } ] - }, - { - "product_types": [], - "hosts": ["photoshop"], - "outputs": [ - { - "name": "jpg", - "ext": "jpg", - "tags": [ - "ftrackreview", - "kitsureview", - "webreview" - ], - "burnins": [], - "ffmpeg_args": { - "video_filters": [], - "audio_filters": [], - "input": [], - "output": [] - }, - "filter": { - "families": [ - "render", - "review", - "ftrack" - ], - "product_names": [], - "custom_tags": [], - "single_frame_filter": "single_frame" - }, - "overscan_crop": "", - # "overscan_color": [0, 0, 0], - "overscan_color": [0, 0, 0, 0.0], - "width": 1920, - "height": 1080, - "scale_pixel_aspect": True, - "bg_color": [0, 0, 0, 0.0], - "letter_box": { - "enabled": False, - "ratio": 0.0, - "fill_color": [0, 0, 0, 1.0], - "line_thickness": 0, - "line_color": [255, 0, 0, 1.0] - }, - "fill_missing_frames": "closest_existing" - }, - { - "name": "mov", - "ext": "mov", - "tags": [ - "ftrackreview", - "kitsureview", - "webreview" - ], - "burnins": [], - "ffmpeg_args": { - "video_filters": [], - "audio_filters": [], - "input": [ - "-apply_trc gamma22" - ], - "output": [ - "-pix_fmt yuv420p", - "-crf 18", - "-c:a aac", - "-b:a 192k", - "-g 1", - "-movflags faststart" - ] - }, - "filter": { - "families": [ - "render", - "review", - "ftrack" - ], - "product_names": [], - "custom_tags": [], - "single_frame_filter": "multi_frame" - }, - "overscan_crop": "", - # "overscan_color": [0, 0, 0], - "overscan_color": [0, 0, 0, 0.0], - "width": 0, - "height": 0, - "scale_pixel_aspect": True, - "bg_color": [0, 0, 0, 0.0], - "letter_box": { - "enabled": False, - "ratio": 0.0, - "fill_color": [0, 0, 0, 1.0], - "line_thickness": 0, - "line_color": [255, 0, 0, 1.0] - }, - "fill_missing_frames": "closest_existing" - } - ] } ] }, From b87dbabd142764e27890283201819b77d00747f0 Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 16 Jul 2025 16:01:11 +0200 Subject: [PATCH 161/170] Added task_types to ExtractReview profile in Settings --- server/settings/publish_plugins.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/server/settings/publish_plugins.py b/server/settings/publish_plugins.py index d690d79607..ee422a0acf 100644 --- a/server/settings/publish_plugins.py +++ b/server/settings/publish_plugins.py @@ -747,6 +747,11 @@ class ExtractReviewProfileModel(BaseSettingsModel): hosts: list[str] = SettingsField( default_factory=list, title="Host names" ) + task_types: list[str] = SettingsField( + default_factory=list, + title="Task Types", + enum_resolver=task_types_enum, + ) outputs: list[ExtractReviewOutputDefModel] = SettingsField( default_factory=list, title="Output Definitions" ) @@ -1348,6 +1353,7 @@ DEFAULT_PUBLISH_VALUES = { { "product_types": [], "hosts": [], + "task_types": [], "outputs": [ { "name": "png", From ff92960be6a8b16919321d4b598be980db1ba2ac Mon Sep 17 00:00:00 2001 From: Petr Kalis Date: Wed, 16 Jul 2025 16:01:31 +0200 Subject: [PATCH 162/170] Added task_types to ExtractReview profile --- client/ayon_core/plugins/publish/extract_review.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/client/ayon_core/plugins/publish/extract_review.py b/client/ayon_core/plugins/publish/extract_review.py index 7aa40a17a4..1e4997cfb4 100644 --- a/client/ayon_core/plugins/publish/extract_review.py +++ b/client/ayon_core/plugins/publish/extract_review.py @@ -203,15 +203,21 @@ class ExtractReview(pyblish.api.InstancePlugin): def _get_outputs_for_instance(self, instance): host_name = instance.context.data["hostName"] product_type = instance.data["productType"] + task_type = None + task_entity = instance.data.get("taskEntity") + if task_entity: + task_type = task_entity["taskType"] self.log.debug("Host: \"{}\"".format(host_name)) self.log.debug("Product type: \"{}\"".format(product_type)) + self.log.debug("Task type: \"{}\"".format(task_type)) profile = filter_profiles( self.profiles, { "hosts": host_name, "product_types": product_type, + "task_types": task_type }, logger=self.log) if not profile: From 260aad8c1fb19db519f8f64814b6e20030b36b1b Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 21 Jul 2025 15:30:58 +0200 Subject: [PATCH 163/170] implemented 'copy_workfile_to_context' --- client/ayon_core/pipeline/workfile/utils.py | 119 ++++++++++++++++++++ 1 file changed, 119 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 0c3a50446d..29d636fd7d 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -13,6 +13,7 @@ from ayon_core.settings import get_project_settings from ayon_core.host.interfaces import ( SaveWorkfileOptionalData, ListWorkfilesOptionalData, + CopyWorkfileOptionalData, ) from ayon_core.pipeline.version_start import get_versioning_start from ayon_core.pipeline.template_data import get_template_data @@ -516,6 +517,124 @@ def save_next_version( ) +def copy_workfile_to_context( + src_workfile_path: str, + folder_entity: dict[str, Any], + task_entity: dict[str, Any], + *, + version: Optional[int] = None, + comment: Optional[str] = None, + description: Optional[str] = None, + open_workfile: bool = True, + prepared_data: Optional[CopyWorkfileOptionalData] = None, +) -> None: + """Copy workfile to a context. + + Copy workfile to a specified folder and task. Destination path is + calculated based on passed information. + + Args: + src_workfile_path (str): Source workfile path. + folder_entity (dict[str, Any]): Target folder entity. + task_entity (dict[str, Any]): Target task entity. + version (Optional[int]): Workfile version. Use next version if not + passed. + comment (optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + prepared_data (Optional[CopyWorkfileOptionalData]): Prepared data + for speed enhancements. Rootless path is calculated in this + function. + + """ + from ayon_core.pipeline import Anatomy + from ayon_core.pipeline.context_tools import registered_host + + host = registered_host() + project_name = host.get_current_project_name() + + anatomy = prepared_data.anatomy + if anatomy is None: + if prepared_data.project_entity is None: + prepared_data.project_entity = ayon_api.get_project( + project_name + ) + anatomy = Anatomy( + project_name, project_entity=prepared_data.project_entity + ) + prepared_data.anatomy = anatomy + + project_settings = prepared_data.project_settings + if project_settings is None: + project_settings = get_project_settings(project_name) + prepared_data.project_settings = project_settings + + if version is None: + list_prepared_data = None + if prepared_data is not None: + list_prepared_data = ListWorkfilesOptionalData( + project_entity=prepared_data.project_entity, + anatomy=prepared_data.anatomy, + project_settings=prepared_data.project_settings, + workfile_entities=prepared_data.workfile_entities, + ) + + workfiles = host.list_workfiles( + project_name, + folder_entity, + task_entity, + prepared_data=list_prepared_data + ) + if workfiles: + version = max( + workfile.version + for workfile in workfiles + ) + 1 + else: + version = get_versioning_start( + project_name, + host.name, + task_name=task_entity["name"], + task_type=task_entity["taskType"], + product_type="workfile" + ) + + task_type = task_entity["taskType"] + template_key = get_workfile_template_key( + project_name, + task_type, + host.name, + project_settings=prepared_data.project_settings + ) + + template_data = get_template_data( + prepared_data.project_entity, + folder_entity, + task_entity, + host.name, + prepared_data.project_settings, + ) + template_data["version"] = version + if comment: + template_data["comment"] = comment + + workfile_template = anatomy.get_template_item( + "work", template_key, "path" + ) + workfile_path = workfile_template.format_strict(template_data) + prepared_data.rootless_path = workfile_path.rootless + host.copy_workfile( + src_workfile_path, + workfile_path, + folder_entity, + task_entity, + version=version, + comment=comment, + description=description, + open_workfile=open_workfile, + prepared_data=prepared_data, + ) + + def find_workfile_rootless_path( workfile_path: str, project_name: str, From 4462e218cd317765cfea7c635b0fd60de0c048bf Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 21 Jul 2025 16:10:58 +0200 Subject: [PATCH 164/170] make sure the save is enabled --- client/ayon_core/tools/workfiles/widgets/files_widget.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/client/ayon_core/tools/workfiles/widgets/files_widget.py b/client/ayon_core/tools/workfiles/widgets/files_widget.py index 012a12ab17..a1993c078b 100644 --- a/client/ayon_core/tools/workfiles/widgets/files_widget.py +++ b/client/ayon_core/tools/workfiles/widgets/files_widget.py @@ -333,7 +333,9 @@ class FilesWidget(QtWidgets.QWidget): ) def _on_save_as_request(self): - self._on_published_save_clicked() + # Make sure the save is enabled + if self._is_save_enabled and self._valid_selected_context: + self._on_published_save_clicked() def _set_select_contex_mode(self, enabled): if self._select_context_mode is enabled: From a1a4066bc60faf1ba017b9130dc4402d105891ab Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 21 Jul 2025 16:11:06 +0200 Subject: [PATCH 165/170] fix typo --- client/ayon_core/tools/workfiles/widgets/files_widget.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/tools/workfiles/widgets/files_widget.py b/client/ayon_core/tools/workfiles/widgets/files_widget.py index a1993c078b..0c8ad392e2 100644 --- a/client/ayon_core/tools/workfiles/widgets/files_widget.py +++ b/client/ayon_core/tools/workfiles/widgets/files_widget.py @@ -201,7 +201,7 @@ class FilesWidget(QtWidgets.QWidget): def _on_current_open_requests(self): # TODO validate if item under mouse is enabled - # - thi uses selected item, but that does not have to be the one + # - this uses selected item, but that does not have to be the one # under mouse self._on_workarea_open_clicked() From 55dedaef8012f0d4787f3548a76c18bdf15a3a09 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 21 Jul 2025 16:25:59 +0200 Subject: [PATCH 166/170] allow to pass prepared data --- client/ayon_core/pipeline/workfile/utils.py | 33 +++++++++++++++------ 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 29d636fd7d..28614bbb37 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -406,6 +406,8 @@ def save_next_version( version: Optional[int] = None, comment: Optional[str] = None, description: Optional[str] = None, + *, + prepared_data: Optional[SaveWorkfileOptionalData] = None, ) -> None: """Save workfile using current context, version and comment. @@ -417,6 +419,8 @@ def save_next_version( version + 1 is used if is not passed in. comment (optional[str]): Workfile comment. description (Optional[str]): Workfile description. + prepared_data (Optional[SaveWorkfileOptionalData]): Prepared data + for speed enhancements. """ from ayon_core.pipeline import Anatomy @@ -428,9 +432,25 @@ def save_next_version( project_name = context["project_name"] folder_path = context["folder_path"] task_name = context["task_name"] - project_entity = ayon_api.get_project(project_name) - project_settings = get_project_settings(project_name) - anatomy = Anatomy(project_name, project_entity=project_entity) + if prepared_data is None: + prepared_data = SaveWorkfileOptionalData() + + project_entity = prepared_data.project_entity + anatomy = prepared_data.anatomy + project_settings = prepared_data.project_settings + + if project_entity is None: + project_entity = ayon_api.get_project(project_name) + prepared_data.project_entity = project_entity + + if project_settings is None: + project_settings = get_project_settings(project_name) + prepared_data.project_settings = project_settings + + if anatomy is None: + anatomy = Anatomy(project_name, project_entity=project_entity) + prepared_data.anatomy = anatomy + folder_entity = ayon_api.get_folder_by_path(project_name, folder_path) task_entity = ayon_api.get_task_by_name( project_name, folder_entity["id"], task_name @@ -499,13 +519,8 @@ def save_next_version( rootless_path = f"{rootless_dir}/{filename}" if platform.system().lower() == "windows": rootless_path = rootless_path.replace("\\", "/") + prepared_data.rootless_path = rootless_path - prepared_data = SaveWorkfileOptionalData( - project_entity=project_entity, - anatomy=anatomy, - project_settings=project_settings, - rootless_path=rootless_path, - ) host.save_workfile_with_context( workfile_path, folder_entity, From 84e88f0cf3c328883c2267df3e0a0e8448ec6093 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 21 Jul 2025 16:51:43 +0200 Subject: [PATCH 167/170] add docstring --- client/ayon_core/pipeline/workfile/utils.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 28614bbb37..aee304d1d3 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -709,6 +709,22 @@ def _create_workfile_info_entity( comment: Optional[str], description: Optional[str], ) -> dict[str, Any]: + """Create workfile entity data. + + Args: + project_name (str): Project name. + task_id (str): Task id. + host_name (str): Host name. + rootless_path (str): Rootless workfile path. + username (str): Username. + version (Optional[int]): Workfile version. + comment (Optional[str]): Workfile comment. + description (Optional[str]): Workfile description. + + Returns: + dict[str, Any]: Created workfile entity data. + + """ extension = os.path.splitext(rootless_path)[1] attrib = {} From 71dc4ca70670173eec8bb2bbd738a3a1a2371a17 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Mon, 21 Jul 2025 16:51:53 +0200 Subject: [PATCH 168/170] added return type hint --- client/ayon_core/pipeline/workfile/utils.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index aee304d1d3..77c1953e4d 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -86,7 +86,7 @@ def should_use_last_workfile_on_launch( task_type: str, default_output: bool = False, project_settings: Optional[dict[str, Any]] = None, -): +) -> bool: """Define if host should start last version workfile if possible. Default output is `False`. Can be overridden with environment variable From 4d142ab6289f7fafc3e6ca8d43110998eb00dab6 Mon Sep 17 00:00:00 2001 From: Jakub Trllo <43494761+iLLiCiTiT@users.noreply.github.com> Date: Wed, 23 Jul 2025 09:48:49 +0200 Subject: [PATCH 169/170] fill extension in template data --- client/ayon_core/pipeline/workfile/utils.py | 51 ++++++++++++++++----- 1 file changed, 39 insertions(+), 12 deletions(-) diff --git a/client/ayon_core/pipeline/workfile/utils.py b/client/ayon_core/pipeline/workfile/utils.py index 77c1953e4d..d5c717bd6d 100644 --- a/client/ayon_core/pipeline/workfile/utils.py +++ b/client/ayon_core/pipeline/workfile/utils.py @@ -411,8 +411,8 @@ def save_next_version( ) -> None: """Save workfile using current context, version and comment. - Helper function to save workfile using current context. Last workfile - version + 1 is used if is not passed in. + Helper function to save a workfile using the current context. Last + workfile version + 1 is used if is not passed in. Args: version (Optional[int]): Workfile version that will be used. Last @@ -480,10 +480,8 @@ def save_next_version( project_settings=project_settings, ) rootless_dir = workdir.rootless + last_workfile = None if version is None: - workfile_extensions = host.get_workfile_extensions() - if not workfile_extensions: - raise ValueError("Host does not have defined file extensions") workfiles = host.list_workfiles( project_name, folder_entity, task_entity, prepared_data=ListWorkfilesOptionalData( @@ -493,14 +491,18 @@ def save_next_version( template_key=template_key, ) ) - versions = { - workfile.version - for workfile in workfiles - if workfile.version is not None - } + for workfile in workfiles: + if workfile.version is None: + continue + if ( + last_workfile is None + or last_workfile.version < workfile.version + ): + last_workfile = workfile + version = None - if versions: - version = max(versions) + 1 + if last_workfile is not None: + version = last_workfile.version + 1 if version is None: version = get_versioning_start( @@ -514,6 +516,26 @@ def save_next_version( template_data["version"] = version template_data["comment"] = comment + # Resolve extension + # - Don't fill any if the host does not have defined any -> e.g. if host + # uses directory instead of a file. + # 1. Use the current file extension. + # 2. Use the last known workfile extension. + # 3. Use the first extensions from 'get_workfile_extensions'. + ext = None + workfile_extensions = host.get_workfile_extensions() + if workfile_extensions: + current_path = host.get_current_workfile() + if current_path: + ext = os.path.splitext(current_path)[1].lstrip(".") + elif last_workfile is not None: + ext = os.path.splitext(last_workfile.filepath)[1].lstrip(".") + else: + ext = next(iter(workfile_extensions), None) + + if ext: + template_data["ext"] = ext + filename = file_template.format_strict(template_data) workfile_path = os.path.join(workdir, filename) rootless_path = f"{rootless_dir}/{filename}" @@ -632,6 +654,11 @@ def copy_workfile_to_context( if comment: template_data["comment"] = comment + workfile_extensions = host.get_workfile_extensions() + if workfile_extensions: + ext = os.path.splitext(src_workfile_path)[1].lstrip(".") + template_data["ext"] = ext + workfile_template = anatomy.get_template_item( "work", template_key, "path" ) From 6def9655f07f8c1dcb80d38a1cb52ff617f03e2e Mon Sep 17 00:00:00 2001 From: Roy Nieterau Date: Wed, 23 Jul 2025 11:39:08 +0200 Subject: [PATCH 170/170] Do not use deprecated `Logger.warn`, use `Logger.warning` instead --- client/ayon_core/plugins/publish/integrate_inputlinks.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/ayon_core/plugins/publish/integrate_inputlinks.py b/client/ayon_core/plugins/publish/integrate_inputlinks.py index a3b6a228d6..be399a95fc 100644 --- a/client/ayon_core/plugins/publish/integrate_inputlinks.py +++ b/client/ayon_core/plugins/publish/integrate_inputlinks.py @@ -105,7 +105,7 @@ class IntegrateInputLinksAYON(pyblish.api.ContextPlugin): created links by its type """ if workfile_instance is None: - self.log.warn("No workfile in this publish session.") + self.log.warning("No workfile in this publish session.") return workfile_version_id = workfile_instance.data["versionEntity"]["id"]