ayon-python-api 1.0.4__tar.gz → 1.0.5__tar.gz

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 1.0.4
+Version: 1.0.5
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/ayon_api/__init__.py

@@ -118,6 +118,7 @@ from ._api import (
     get_rest_projects,
     get_rest_entity_by_id,
     get_rest_folder,
+    get_rest_folders,
     get_rest_task,
     get_rest_product,
     get_rest_version,
@@ -329,6 +330,7 @@ __all__ = (
     "get_rest_projects",
     "get_rest_entity_by_id",
     "get_rest_folder",
+    "get_rest_folders",
     "get_rest_task",
     "get_rest_product",
     "get_rest_version",

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/ayon_api/_api.py

@@ -1917,6 +1917,51 @@ def get_rest_folder(*args, **kwargs):
     return con.get_rest_folder(*args, **kwargs)
 
 
+def get_rest_folders(*args, **kwargs):
+    """Get simplified flat list of all project folders.
+
+    Get all project folders in single REST call. This can be faster than
+        using 'get_folders' method which is using GraphQl, but does not
+        allow any filtering, and set of fields is defined
+        by server backend.
+
+    Example::
+
+        [
+            {
+                "id": "112233445566",
+                "parentId": "112233445567",
+                "path": "/root/parent/child",
+                "parents": ["root", "parent"],
+                "name": "child",
+                "label": "Child",
+                "folderType": "Folder",
+                "hasTasks": False,
+                "hasChildren": False,
+                "taskNames": [
+                    "Compositing",
+                ],
+                "status": "In Progress",
+                "attrib": {},
+                "ownAttrib": [],
+                "updatedAt": "2023-06-12T15:37:02.420260",
+            },
+            ...
+        ]
+
+    Args:
+        project_name (str): Project name.
+        include_attrib (Optional[bool]): Include attribute values
+            in output. Slower to query.
+
+    Returns:
+        list[dict[str, Any]]: List of folder entities.
+
+    """
+    con = get_server_api_connection()
+    return con.get_rest_folders(*args, **kwargs)
+
+
 def get_rest_task(*args, **kwargs):
     con = get_server_api_connection()
     return con.get_rest_task(*args, **kwargs)
@@ -2065,6 +2110,12 @@ def get_folders_rest(*args, **kwargs):
             ...
         ]
 
+    Deprecated:
+        Use 'get_rest_folders' instead. Function was renamed to match
+            other rest functions, like 'get_rest_folder',
+            'get_rest_project' etc. .
+        Will be removed in '1.0.7' or '1.1.0'.
+
     Args:
         project_name (str): Project name.
         include_attrib (Optional[bool]): Include attribute values

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/ayon_api/entity_hub.py

@@ -2585,6 +2585,7 @@ class FolderEntity(BaseEntity):
 
     def lock(self):
         super(FolderEntity, self).lock()
+        self._orig_label = self._get_label_value()
         self._orig_folder_type = self._folder_type
         self._orig_status = self._status
         self._orig_tags = copy.deepcopy(self._tags)
@@ -2608,10 +2609,7 @@ class FolderEntity(BaseEntity):
         if self._orig_tags != self._tags:
             changes["tags"] = self._tags
 
-        label = self._label
-        if self._name == label:
-            label = None
-
+        label = self._get_label_value()
         if label != self._orig_label:
             changes["label"] = label
 
@@ -2655,6 +2653,10 @@ class FolderEntity(BaseEntity):
             "folderType": self.folder_type,
             "parentId": parent_id,
         }
+        label = self._get_label_value()
+        if label:
+            output["label"] = label
+
         attrib = self.attribs.to_dict()
         if attrib:
             output["attrib"] = attrib
@@ -2679,6 +2681,18 @@ class FolderEntity(BaseEntity):
             output["data"] = self._data
         return output
 
+    def _get_label_value(self):
+        """Get label value that will be used for operations.
+
+        Returns:
+            Union[str, None]: Label value.
+
+        """
+        label = self._label
+        if not label or self._name == label:
+            return None
+        return label
+
 
 class TaskEntity(BaseEntity):
     """Entity representing a task on AYON server.
@@ -2734,6 +2748,7 @@ class TaskEntity(BaseEntity):
 
     def lock(self):
         super(TaskEntity, self).lock()
+        self._orig_label = self._get_label_value()
         self._orig_task_type = self._task_type
         self._orig_status = self._status
         self._orig_tags = copy.deepcopy(self._tags)
@@ -2819,10 +2834,7 @@ class TaskEntity(BaseEntity):
         if self._orig_tags != self._tags:
             changes["tags"] = self._tags
 
-        label = self._label
-        if self._name == label:
-            label = None
-
+        label = self._get_label_value()
         if label != self._orig_label:
             changes["label"] = label
 
@@ -2855,6 +2867,10 @@ class TaskEntity(BaseEntity):
             "folderId": self.parent_id,
             "attrib": self.attribs.to_dict(),
         }
+        label = self._get_label_value()
+        if label:
+            output["label"] = label
+
         attrib = self.attribs.to_dict()
         if attrib:
             output["attrib"] = attrib
@@ -2874,3 +2890,15 @@ class TaskEntity(BaseEntity):
         ):
             output["data"] = self._data
         return output
+
+    def _get_label_value(self):
+        """Get label value that will be used for operations.
+
+        Returns:
+            Union[str, None]: Label value.
+
+        """
+        label = self._label
+        if not label or self._name == label:
+            return None
+        return label

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/ayon_api/server_api.py

@@ -3383,6 +3383,62 @@ class ServerAPI(object):
     def get_rest_folder(self, project_name, folder_id):
         return self.get_rest_entity_by_id(project_name, "folder", folder_id)
 
+    def get_rest_folders(self, project_name, include_attrib=False):
+        """Get simplified flat list of all project folders.
+
+        Get all project folders in single REST call. This can be faster than
+            using 'get_folders' method which is using GraphQl, but does not
+            allow any filtering, and set of fields is defined
+            by server backend.
+
+        Example::
+
+            [
+                {
+                    "id": "112233445566",
+                    "parentId": "112233445567",
+                    "path": "/root/parent/child",
+                    "parents": ["root", "parent"],
+                    "name": "child",
+                    "label": "Child",
+                    "folderType": "Folder",
+                    "hasTasks": False,
+                    "hasChildren": False,
+                    "taskNames": [
+                        "Compositing",
+                    ],
+                    "status": "In Progress",
+                    "attrib": {},
+                    "ownAttrib": [],
+                    "updatedAt": "2023-06-12T15:37:02.420260",
+                },
+                ...
+            ]
+
+        Args:
+            project_name (str): Project name.
+            include_attrib (Optional[bool]): Include attribute values
+                in output. Slower to query.
+
+        Returns:
+            list[dict[str, Any]]: List of folder entities.
+
+        """
+        major, minor, patch, _, _ = self.server_version_tuple
+        if (major, minor, patch) < (1, 0, 8):
+            raise UnsupportedServerVersion(
+                "Function 'get_folders_rest' is supported"
+                " for AYON server 1.0.8 and above."
+            )
+        query = "?attrib={}".format(
+            "true" if include_attrib else "false"
+        )
+        response = self.get(
+            "projects/{}/folders{}".format(project_name, query)
+        )
+        response.raise_for_status()
+        return response.data["folders"]
+
     def get_rest_task(self, project_name, task_id):
         return self.get_rest_entity_by_id(project_name, "task", task_id)
 
@@ -3647,6 +3703,12 @@ class ServerAPI(object):
                 ...
             ]
 
+        Deprecated:
+            Use 'get_rest_folders' instead. Function was renamed to match
+                other rest functions, like 'get_rest_folder',
+                'get_rest_project' etc. .
+            Will be removed in '1.0.7' or '1.1.0'.
+
         Args:
             project_name (str): Project name.
             include_attrib (Optional[bool]): Include attribute values
@@ -3656,20 +3718,7 @@ class ServerAPI(object):
             list[dict[str, Any]]: List of folder entities.
 
         """
-        major, minor, patch, _, _ = self.server_version_tuple
-        if (major, minor, patch) < (1, 0, 8):
-            raise UnsupportedServerVersion(
-                "Function 'get_folders_rest' is supported"
-                " for AYON server 1.0.8 and above."
-            )
-        query = "?attrib={}".format(
-            "true" if include_attrib else "false"
-        )
-        response = self.get(
-            "projects/{}/folders{}".format(project_name, query)
-        )
-        response.raise_for_status()
-        return response.data["folders"]
+        return self.get_rest_folders(project_name, include_attrib)
 
     def get_folders(
         self,

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/ayon_api/version.py

@@ -1,2 +1,2 @@
 """Package declaring Python API for AYON server."""
-__version__ = "1.0.4"
+__version__ = "1.0.5"

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/ayon_python_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ayon-python-api
-Version: 1.0.4
+Version: 1.0.5
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon-python-api-1.0.4 → ayon-python-api-1.0.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon-python-api"
-version = "1.0.4"
+version = "1.0.5"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}
@@ -31,7 +31,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "ayon-python-api"
-version = "1.0.4"
+version = "1.0.5"
 description = "AYON Python API"
 authors = [
     "ynput.io <info@ynput.io>"