PR merging develop to Releases

.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.9.7
         - 1.9.6
         - 1.9.5
         - 1.9.4

.github/workflows/pr_linting.yml

@@ -23,5 +23,4 @@ jobs:
       - uses: actions/checkout@v4
       - uses: astral-sh/ruff-action@v3
         with:
-          changed-files: "true"
           version-file: "pyproject.toml"

client/ayon_core/pipeline/anatomy/__init__.py

@@ -5,8 +5,9 @@
     TemplateMissingKey,
     AnatomyTemplateUnsolved,
 )
-from .anatomy import Anatomy
+from .roots import AnatomyRoot, AnatomyRoots
 from .templates import AnatomyTemplateResult, AnatomyStringTemplate
+from .anatomy import Anatomy
 
 
 __all__ = (
@@ -16,8 +17,11 @@
     "TemplateMissingKey",
     "AnatomyTemplateUnsolved",
 
-    "Anatomy",
+    "AnatomyRoot",
+    "AnatomyRoots",
 
     "AnatomyTemplateResult",
     "AnatomyStringTemplate",
+
+    "Anatomy",
 )

client/ayon_core/pipeline/anatomy/anatomy.py

@@ -1,8 +1,11 @@
+from __future__ import annotations
+
 import os
 import re
 import copy
 import platform
 import collections
+from typing import TYPE_CHECKING, Any
 
 import ayon_api
 
@@ -17,7 +20,12 @@
 
 from .exceptions import RootCombinationError, ProjectNotSet
 from .roots import AnatomyRoots
-from .templates import AnatomyTemplates
+from .templates import AnatomyTemplates, NOT_SET
+
+
+if TYPE_CHECKING:
+    from .templates import TemplateItem
+
 
 log = Logger.get_logger(__name__)
 
@@ -104,7 +112,13 @@ def templates_obj(self):
         """Return `AnatomyTemplates` object of current Anatomy instance."""
         return self._templates_obj
 
-    def get_template_item(self, *args, **kwargs):
+    def get_template_item(
+            self,
+            category_name: str,
+            template_name: str,
+            subkey: str | None = None,
+            default: Any = NOT_SET,
+    ) -> TemplateItem | Any:
         """Get template item from category.
 
         Args:
@@ -117,7 +131,9 @@ def get_template_item(self, *args, **kwargs):
             Any: Template item, subkey value as AnatomyStringTemplate or None.
 
         """
-        return self._templates_obj.get_template_item(*args, **kwargs)
+        return self._templates_obj.get_template_item(
+            category_name, template_name, subkey, default
+        )
 
     def format(self, *args, **kwargs):
         """Wrap `format` method of Anatomy's `templates_obj`."""

client/ayon_core/pipeline/anatomy/roots.py

@@ -1,14 +1,15 @@
 import os
 import platform
 import numbers
+import warnings
 
 from ayon_core.lib import Logger, StringTemplate
 from ayon_core.lib.path_templates import FormatObject
 
 from .exceptions import RootMissingEnv
 
 
-class RootItem(FormatObject):
+class AnatomyRoot(FormatObject):
     """Represents one item or roots.
 
     Holds raw data of root item specification. Raw data contain value
@@ -243,6 +244,21 @@ def find_root_template_from_path(self, path):
         return (result, output)
 
 
+# TODO remove
+class RootItem(AnatomyRoot):
+    """DEPRECATED: Use 'AnatomyRoot' instead.
+
+    Backwards compatibility added 2026/05/21.
+    """
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        warnings.warn(
+            "RootItem is deprecated. Use AnatomyRoot instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+
+
 class AnatomyRoots:
     """Object which should be used for formatting "root" key in templates.
 
@@ -296,7 +312,7 @@ def path_remapper(
             src_platform (Optional[str]): Specify source platform. This is
                 recommended to not use and keep unset until you really want
                 to use specific platform.
-            roots (Optional[Union[dict, RootItem])): It is possible to remap
+            roots (Optional[Union[dict, AnatomyRoot])): It is possible to remap
                 path with different roots then instance where method was
                 called has.
 
@@ -318,7 +334,7 @@ def path_remapper(
             if not dst_platform:
                 return path
 
-        if isinstance(roots, RootItem):
+        if isinstance(roots, AnatomyRoot):
             return roots.path_remapper(path, dst_platform, src_platform)
 
         for _root in roots.values():
@@ -353,7 +369,7 @@ def find_root_template_from_path(self, path, roots=None):
         if roots is None:
             raise ValueError("Roots are not set. Can't find path.")
 
-        if isinstance(roots, RootItem):
+        if isinstance(roots, AnatomyRoot):
             return roots.find_root_template_from_path(path)
 
         for root_name, _root in roots.items():
@@ -411,7 +427,7 @@ def all_root_paths(self, roots=None):
             roots = self.roots
 
         output = []
-        if isinstance(roots, RootItem):
+        if isinstance(roots, AnatomyRoot):
             for value in roots.raw_data.values():
                 output.append(value)
             return output
@@ -426,7 +442,7 @@ def _root_environments(self, keys=None, roots=None):
         if roots is None:
             roots = self.roots
 
-        if isinstance(roots, RootItem):
+        if isinstance(roots, AnatomyRoot):
             key_items = [self.env_prefix]
             for _key in keys:
                 key_items.append(_key.upper())
@@ -462,7 +478,7 @@ def _root_environmets_fill_data(self, template, keys=None, roots=None):
                 )
             }
 
-        if isinstance(roots, RootItem):
+        if isinstance(roots, AnatomyRoot):
             key_items = [AnatomyRoots.env_prefix]
             for _key in keys:
                 key_items.append(_key.upper())
@@ -513,32 +529,31 @@ def _discover(self):
         Default roots are loaded if project override's does not contain roots.
 
         Returns:
-            `RootItem` or `dict` with multiple `RootItem`s when multiroot
+            `AnatomyRoot` or `dict` with multiple `AnatomyRoot`s when multiroot
             setting is used.
         """
 
         return self._parse_dict(self._anatomy["roots"], self)
 
     @staticmethod
     def _parse_dict(data, parent):
-        """Parse roots raw data into RootItem or dictionary with RootItems.
+        """Parse roots raw data into dictionary with AnatomyRoots.
 
-        Converting raw roots data to `RootItem` helps to handle platform keys.
-        This method is recursive to be able handle multiroot setup and
-        is static to be able to load default roots without creating new object.
+        Converting raw roots data to `AnatomyRoot` helps to handle platform
+            keys.
 
         Args:
             data (dict): Should contain raw roots data to be parsed.
             parent (AnatomyRoots): Parent object set as parent
-                for ``RootItem``.
+                for ``AnatomyRoot``.
 
         Returns:
-            dict[str, RootItem]: Root items by name.
+            dict[str, AnatomyRoot]: Root items by name.
 
         """
         output = {}
         for root_name, root_values in data.items():
-            output[root_name] = RootItem(
+            output[root_name] = AnatomyRoot(
                 parent, root_values, root_name
             )
         return output

client/ayon_core/pipeline/anatomy/templates.py

@@ -1,9 +1,11 @@
+from __future__ import annotations
 import os
 import re
 import copy
 import platform
 import collections
 import numbers
+from typing import Any
 
 from ayon_core.lib.path_templates import (
     TemplateResult,
@@ -16,8 +18,9 @@
     AnatomyTemplateUnsolved,
 )
 
+
 _IS_WINDOWS = platform.system().lower() == "windows"
-_PLACEHOLDER = object()
+NOT_SET = object()
 
 
 class AnatomyTemplateResult(TemplateResult):
@@ -441,7 +444,7 @@ def roots(self):
         """Anatomy roots object.
 
         Returns:
-            RootItem: Anatomy roots data.
+            dict[str, AnatomyRoot]: Anatomy roots data.
 
         """
         return self._anatomy.roots
@@ -578,14 +581,18 @@ def format_all(self, in_data):
         return self.format(in_data, strict=False)
 
     def get_template_item(
-        self, category_name, template_name, subkey=None, default=_PLACEHOLDER
-    ):
+        self,
+        category_name: str,
+        template_name: str,
+        subkey: str | None = None,
+        default: Any = NOT_SET
+    ) -> Any:
         """Get template item from category.
 
         Args:
             category_name (str): Category name.
             template_name (str): Template name.
-            subkey (Optional[str]): Subkey name.
+            subkey (str | None): Subkey name.
             default (Any): Default value if template is not found.
 
         Returns:
@@ -599,13 +606,13 @@ def get_template_item(
         self._validate_discovery()
         category = self.get(category_name)
         if category is None:
-            if default is not _PLACEHOLDER:
+            if default is not NOT_SET:
                 return default
             raise KeyError("Category '{}' not found.".format(category_name))
 
         template_item = category.get(template_name)
         if template_item is None:
-            if default is not _PLACEHOLDER:
+            if default is not NOT_SET:
                 return default
             raise KeyError(
                 "Template '{}' not found in category '{}'.".format(
@@ -620,7 +627,7 @@ def get_template_item(
         if item is not None:
             return item
 
-        if default is not _PLACEHOLDER:
+        if default is not NOT_SET:
             return default
         raise KeyError(
             "Subkey '{}' not found in '{}/{}'.".format(

client/ayon_core/pipeline/publish/__init__.py

@@ -53,6 +53,15 @@
     has_trait_representations,
     set_trait_representations,
 
+    get_instance_template_name,
+    get_instance_publish_template,
+    get_publish_template_object,
+    get_instance_families,
+    get_version_data_from_instance,
+    get_rootless_path,
+
+    IntegrationTemplateItem,
+
     get_default_reviewable_layers,
 )
 
@@ -119,5 +128,14 @@
     "has_trait_representations",
     "set_trait_representations",
 
+    "get_instance_template_name",
+    "get_instance_publish_template",
+    "get_publish_template_object",
+    "get_instance_families",
+    "get_version_data_from_instance",
+    "get_rootless_path",
+
+    "IntegrationTemplateItem",
+
     "get_default_reviewable_layers",
 )