ayon-python-api 1.2.7__tar.gz → 1.2.9__tar.gz

{ayon_python_api-1.2.7/ayon_python_api.egg-info → ayon_python_api-1.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ayon_python_api
-Version: 1.2.7
+Version: 1.2.9
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/__init__.py

@@ -70,6 +70,8 @@ from ._api import (
     delete,
     download_file_to_stream,
     download_file,
+    download_project_file,
+    download_project_file_to_stream,
     upload_file_from_stream,
     upload_file,
     upload_reviewable,
@@ -349,6 +351,8 @@ __all__ = (
     "delete",
     "download_file_to_stream",
     "download_file",
+    "download_project_file",
+    "download_project_file_to_stream",
     "upload_file_from_stream",
     "upload_file",
     "upload_reviewable",

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api.py

@@ -84,6 +84,7 @@ if typing.TYPE_CHECKING:
         ActionModeType,
         StreamType,
         EntityListAttributeDefinitionDict,
+        AdvancedFilterDict,
     )
     from ._api_helpers.links import CreateLinkData
 
@@ -992,6 +993,80 @@ def download_file(
     )
 
 
+def download_project_file(
+    project_name: str,
+    file_id: str,
+    filepath: str,
+    *,
+    chunk_size: Optional[int] = None,
+    progress: Optional[TransferProgress] = None,
+) -> TransferProgress:
+    """Download project file to filepath.
+
+    Project files are usually binary files, such as images, videos,
+        or other media files that can be accessed via api endpoint
+        '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+    Args:
+        project_name (str): Project name.
+        file_id (str): File id.
+        filepath (str): Path where file will be downloaded.
+        chunk_size (Optional[int]): Size of chunks that are received
+            in single loop.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track download progress.
+
+    Returns:
+        TransferProgress: Progress object.
+
+    """
+    con = get_server_api_connection()
+    return con.download_project_file(
+        project_name=project_name,
+        file_id=file_id,
+        filepath=filepath,
+        chunk_size=chunk_size,
+        progress=progress,
+    )
+
+
+def download_project_file_to_stream(
+    project_name: str,
+    file_id: str,
+    stream: StreamType,
+    *,
+    chunk_size: Optional[int] = None,
+    progress: Optional[TransferProgress] = None,
+) -> TransferProgress:
+    """Download project file to a stream.
+
+    Project files are usually binary files, such as images, videos,
+        or other media files that can be accessed via api endpoint
+        '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+    Args:
+        project_name (str): Project name.
+        file_id (str): File id.
+        stream (StreamType): Stream where output will be stored.
+        chunk_size (Optional[int]): Size of chunks that are received
+            in single loop.
+        progress (Optional[TransferProgress]): Object that gives ability
+            to track download progress.
+
+    Returns:
+        TransferProgress: Progress object.
+
+    """
+    con = get_server_api_connection()
+    return con.download_project_file_to_stream(
+        project_name=project_name,
+        file_id=file_id,
+        stream=stream,
+        chunk_size=chunk_size,
+        progress=progress,
+    )
+
+
 def upload_file_from_stream(
     endpoint: str,
     stream: StreamType,
@@ -4144,6 +4219,7 @@ def get_folders(
     tags: Optional[Iterable[str]] = None,
     active: Optional[bool] = True,
     has_links: Optional[bool] = None,
+    filters: Optional[AdvancedFilterDict] = None,
     fields: Optional[Iterable[str]] = None,
     own_attributes: bool = False,
 ) -> Generator[FolderDict, None, None]:
@@ -4185,6 +4261,7 @@ def get_folders(
             Both are returned if is set to None.
         has_links (Optional[Literal[IN, OUT, ANY]]): Filter
             representations with IN/OUT/ANY links.
+        filters (Optional[AdvancedFilterDict]): Advanced filtering options.
         fields (Optional[Iterable[str]]): Fields to be queried for
             folder. All possible folder fields are returned
             if 'None' is passed.
@@ -4212,6 +4289,7 @@ def get_folders(
         tags=tags,
         active=active,
         has_links=has_links,
+        filters=filters,
         fields=fields,
         own_attributes=own_attributes,
     )
@@ -4497,6 +4575,7 @@ def get_tasks(
     statuses: Optional[Iterable[str]] = None,
     tags: Optional[Iterable[str]] = None,
     active: Optional[bool] = True,
+    filters: Optional[AdvancedFilterDict] = None,
     fields: Optional[Iterable[str]] = None,
     own_attributes: bool = False,
 ) -> Generator[TaskDict, None, None]:
@@ -4521,6 +4600,7 @@ def get_tasks(
             filtering.
         active (Optional[bool]): Filter active/inactive tasks.
             Both are returned if is set to None.
+        filters (Optional[AdvancedFilterDict]): Advanced filtering options.
         fields (Optional[Iterable[str]]): Fields to be queried for
             folder. All possible folder fields are returned
             if 'None' is passed.
@@ -4543,6 +4623,7 @@ def get_tasks(
         statuses=statuses,
         tags=tags,
         active=active,
+        filters=filters,
         fields=fields,
         own_attributes=own_attributes,
     )
@@ -4621,6 +4702,7 @@ def get_tasks_by_folder_paths(
     statuses: Optional[Iterable[str]] = None,
     tags: Optional[Iterable[str]] = None,
     active: Optional[bool] = True,
+    filters: Optional[AdvancedFilterDict] = None,
     fields: Optional[Iterable[str]] = None,
     own_attributes: bool = False,
 ) -> dict[str, list[TaskDict]]:
@@ -4643,6 +4725,7 @@ def get_tasks_by_folder_paths(
             filtering.
         active (Optional[bool]): Filter active/inactive tasks.
             Both are returned if is set to None.
+        filters (Optional[AdvancedFilterDict]): Advanced filtering options.
         fields (Optional[Iterable[str]]): Fields to be queried for
             folder. All possible folder fields are returned
             if 'None' is passed.
@@ -4665,6 +4748,7 @@ def get_tasks_by_folder_paths(
         statuses=statuses,
         tags=tags,
         active=active,
+        filters=filters,
         fields=fields,
         own_attributes=own_attributes,
     )
@@ -4914,6 +4998,7 @@ def get_products(
     statuses: Optional[Iterable[str]] = None,
     tags: Optional[Iterable[str]] = None,
     active: Optional[bool] = True,
+    filters: Optional[AdvancedFilterDict] = None,
     fields: Optional[Iterable[str]] = None,
     own_attributes=_PLACEHOLDER,
 ) -> Generator[ProductDict, None, None]:
@@ -4932,6 +5017,8 @@ def get_products(
             Use 'None' if folder is direct child of project.
         product_types (Optional[Iterable[str]]): Product types used for
             filtering.
+        product_base_types (Optional[Iterable[str]]): Product base types
+            used for filtering.
         product_name_regex (Optional[str]): Filter products by name regex.
         product_path_regex (Optional[str]): Filter products by path regex.
             Path starts with folder path and ends with product name.
@@ -4943,6 +5030,7 @@ def get_products(
             for filtering.
         active (Optional[bool]): Filter active/inactive products.
             Both are returned if is set to None.
+        filters (Optional[AdvancedFilterDict]): Advanced filtering options.
         fields (Optional[Iterable[str]]): Fields to be queried for
             folder. All possible folder fields are returned
             if 'None' is passed.
@@ -4967,6 +5055,7 @@ def get_products(
         statuses=statuses,
         tags=tags,
         active=active,
+        filters=filters,
         fields=fields,
         own_attributes=own_attributes,
     )
@@ -5249,6 +5338,7 @@ def get_versions(
     statuses: Optional[Iterable[str]] = None,
     tags: Optional[Iterable[str]] = None,
     active: Optional[bool] = True,
+    filters: Optional[AdvancedFilterDict] = None,
     fields: Optional[Iterable[str]] = None,
     own_attributes=_PLACEHOLDER,
 ) -> Generator[VersionDict, None, None]:
@@ -5275,6 +5365,7 @@ def get_versions(
             for filtering.
         active (Optional[bool]): Receive active/inactive entities.
             Both are returned when 'None' is passed.
+        filters (Optional[AdvancedFilterDict]): Advanced filtering options.
         fields (Optional[Iterable[str]]): Fields to be queried
             for version. All possible folder fields are returned
             if 'None' is passed.
@@ -5298,6 +5389,7 @@ def get_versions(
         statuses=statuses,
         tags=tags,
         active=active,
+        filters=filters,
         fields=fields,
         own_attributes=own_attributes,
     )
@@ -5743,6 +5835,7 @@ def get_representations(
     tags: Optional[Iterable[str]] = None,
     active: Optional[bool] = True,
     has_links: Optional[str] = None,
+    filters: Optional[AdvancedFilterDict] = None,
     fields: Optional[Iterable[str]] = None,
     own_attributes=_PLACEHOLDER,
 ) -> Generator[RepresentationDict, None, None]:
@@ -5773,6 +5866,7 @@ def get_representations(
             Both are returned when 'None' is passed.
         has_links (Optional[Literal[IN, OUT, ANY]]): Filter
             representations with IN/OUT/ANY links.
+        filters (Optional[AdvancedFilterDict]): Advanced filtering options.
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
@@ -5795,6 +5889,7 @@ def get_representations(
         tags=tags,
         active=active,
         has_links=has_links,
+        filters=filters,
         fields=fields,
         own_attributes=own_attributes,
     )
@@ -7206,7 +7301,15 @@ def get_entity_lists(
     active: Optional[bool] = None,
     fields: Optional[Iterable[str]] = None,
 ) -> Generator[dict[str, Any], None, None]:
-    """Fetch entity lists from server.
+    """Fetch entity lists from AYON server.
+
+    Warnings:
+        You can't get list items for lists with different 'entityType' in
+            one call.
+
+    Notes:
+        To get list items, you have to pass 'items' field or
+            'items.{sub-fields you want}' to 'fields' argument.
 
     Args:
         project_name (str): Project name where entity lists are.

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api_helpers/base.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import logging
 import typing
-from typing import Optional, Any, Iterable
+from typing import Optional, Any, Iterable, Union
 
 import requests
 
@@ -142,6 +142,11 @@ class BaseServerAPI:
     ):
         raise NotImplementedError()
 
+    def _prepare_advanced_filters(
+        self, filters: Union[str, dict[str, Any], None]
+    ) -> Optional[str]:
+        raise NotImplementedError()
+
     def _convert_entity_data(self, entity: AnyEntityDict):
         raise NotImplementedError()
 

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api_helpers/folders.py

@@ -21,6 +21,7 @@ if typing.TYPE_CHECKING:
         FolderDict,
         FlatFolderDict,
         ProjectHierarchyDict,
+        AdvancedFilterDict,
     )
 
 
@@ -216,6 +217,7 @@ class FoldersAPI(BaseServerAPI):
         tags: Optional[Iterable[str]] = None,
         active: Optional[bool] = True,
         has_links: Optional[bool] = None,
+        filters: Optional[AdvancedFilterDict] = None,
         fields: Optional[Iterable[str]] = None,
         own_attributes: bool = False
     ) -> Generator[FolderDict, None, None]:
@@ -257,6 +259,7 @@ class FoldersAPI(BaseServerAPI):
                 Both are returned if is set to None.
             has_links (Optional[Literal[IN, OUT, ANY]]): Filter
                 representations with IN/OUT/ANY links.
+            filters (Optional[AdvancedFilterDict]): Advanced filtering options.
             fields (Optional[Iterable[str]]): Fields to be queried for
                 folder. All possible folder fields are returned
                 if 'None' is passed.
@@ -270,11 +273,11 @@ class FoldersAPI(BaseServerAPI):
         if not project_name:
             return
 
-        filters = {
+        graphql_filters = {
             "projectName": project_name
         }
         if not prepare_list_filters(
-            filters,
+            graphql_filters,
             ("folderIds", folder_ids),
             ("folderPaths", folder_paths),
             ("folderNames", folder_names),
@@ -291,9 +294,10 @@ class FoldersAPI(BaseServerAPI):
             ("folderHasTasks", has_tasks),
             ("folderHasLinks", has_links),
             ("folderHasChildren", has_children),
+            ("filter", self._prepare_advanced_filters(filters)),
         ):
             if filter_value is not None:
-                filters[filter_key] = filter_value
+                graphql_filters[filter_key] = filter_value
 
         if parent_ids is not None:
             parent_ids = set(parent_ids)
@@ -313,7 +317,7 @@ class FoldersAPI(BaseServerAPI):
                 parent_ids.remove(project_name)
                 parent_ids.add("root")
 
-            filters["parentFolderIds"] = list(parent_ids)
+            graphql_filters["parentFolderIds"] = list(parent_ids)
 
         if not fields:
             fields = self.get_default_fields_for_type("folder")
@@ -328,7 +332,7 @@ class FoldersAPI(BaseServerAPI):
             fields.add("ownAttrib")
 
         query = folders_graphql_query(fields)
-        for attr, filter_value in filters.items():
+        for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)
 
         for parsed_data in query.continuous_query(self):

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api_helpers/lists.py

@@ -26,7 +26,15 @@ class ListsAPI(BaseServerAPI):
         active: Optional[bool] = None,
         fields: Optional[Iterable[str]] = None,
     ) -> Generator[dict[str, Any], None, None]:
-        """Fetch entity lists from server.
+        """Fetch entity lists from AYON server.
+
+        Warnings:
+            You can't get list items for lists with different 'entityType' in
+                one call.
+
+        Notes:
+            To get list items, you have to pass 'items' field or
+                'items.{sub-fields you want}' to 'fields' argument.
 
         Args:
             project_name (str): Project name where entity lists are.
@@ -42,7 +50,30 @@ class ListsAPI(BaseServerAPI):
         """
         if fields is None:
             fields = self.get_default_fields_for_type("entityList")
-        fields = set(fields)
+
+        # List does not have 'attrib' field but has 'allAttrib' field
+        #   which is json string and contains only values that are set
+        o_fields = tuple(fields)
+        fields = set()
+        requires_attrib = False
+        for field in o_fields:
+            if field == "attrib" or field.startswith("attrib."):
+                requires_attrib = True
+                field = "allAttrib"
+            fields.add(field)
+
+        if "items" in fields:
+            fields.discard("items")
+            fields |= {
+                "items.id",
+                "items.entityId",
+                "items.entityType",
+                "items.position",
+            }
+
+        available_attribs = []
+        if requires_attrib:
+            available_attribs = self.get_attributes_for_type("list")
 
         if active is not None:
             fields.add("active")
@@ -66,6 +97,15 @@ class ListsAPI(BaseServerAPI):
                 if isinstance(attributes, str):
                     entity_list["attributes"] = json.loads(attributes)
 
+                if requires_attrib:
+                    all_attrib = json.loads(
+                        entity_list.get("allAttrib") or "{}"
+                    )
+                    entity_list["attrib"] = {
+                        attrib_name: all_attrib.get(attrib_name)
+                        for attrib_name in available_attribs
+                    }
+
                 self._convert_entity_data(entity_list)
 
                 yield entity_list
@@ -170,9 +210,8 @@ class ListsAPI(BaseServerAPI):
                 kwargs[key] = value
 
         response = self.post(
-            f"projects/{project_name}/lists/{list_id}/items",
+            f"projects/{project_name}/lists",
             **kwargs
-
         )
         response.raise_for_status()
         return list_id
@@ -343,7 +382,7 @@ class ListsAPI(BaseServerAPI):
             mode (EntityListItemMode): Mode of items update.
 
         """
-        response = self.post(
+        response = self.patch(
             f"projects/{project_name}/lists/{list_id}/items",
             items=items,
             mode=mode,

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api_helpers/products.py

@@ -18,7 +18,11 @@ from ayon_api.graphql_queries import (
 from .base import BaseServerAPI, _PLACEHOLDER
 
 if typing.TYPE_CHECKING:
-    from ayon_api.typing import ProductDict, ProductTypeDict
+    from ayon_api.typing import (
+        ProductDict,
+        ProductTypeDict,
+        AdvancedFilterDict,
+    )
 
 
 class ProductsAPI(BaseServerAPI):
@@ -43,6 +47,7 @@ class ProductsAPI(BaseServerAPI):
         statuses: Optional[Iterable[str]] = None,
         tags: Optional[Iterable[str]] = None,
         active: Optional[bool] = True,
+        filters: Optional[AdvancedFilterDict] = None,
         fields: Optional[Iterable[str]] = None,
         own_attributes=_PLACEHOLDER
     ) -> Generator[ProductDict, None, None]:
@@ -74,6 +79,7 @@ class ProductsAPI(BaseServerAPI):
                 for filtering.
             active (Optional[bool]): Filter active/inactive products.
                 Both are returned if is set to None.
+            filters (Optional[AdvancedFilterDict]): Advanced filtering options.
             fields (Optional[Iterable[str]]): Fields to be queried for
                 folder. All possible folder fields are returned
                 if 'None' is passed.
@@ -145,18 +151,18 @@ class ProductsAPI(BaseServerAPI):
             fields.add("folderId")
 
         # Prepare filters for query
-        filters = {
+        graphql_filters = {
             "projectName": project_name
         }
 
         if filter_folder_ids:
-            filters["folderIds"] = list(filter_folder_ids)
+            graphql_filters["folderIds"] = list(filter_folder_ids)
 
         if filter_product_names:
-            filters["productNames"] = list(filter_product_names)
+            graphql_filters["productNames"] = list(filter_product_names)
 
         if not prepare_list_filters(
-            filters,
+            graphql_filters,
             ("productIds", product_ids),
             ("productTypes", product_types),
             ("productBaseTypes", product_base_types),
@@ -168,12 +174,13 @@ class ProductsAPI(BaseServerAPI):
         for filter_key, filter_value in (
             ("productNameRegex", product_name_regex),
             ("productPathRegex", product_path_regex),
+            ("filter", self._prepare_advanced_filters(filters)),
         ):
             if filter_value:
-                filters[filter_key] = filter_value
+                graphql_filters[filter_key] = filter_value
 
         query = products_graphql_query(fields)
-        for attr, filter_value in filters.items():
+        for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)
 
         parsed_data = query.query(self)

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api_helpers/representations.py

@@ -20,7 +20,7 @@ from ayon_api.graphql_queries import (
 from .base import BaseServerAPI, _PLACEHOLDER
 
 if typing.TYPE_CHECKING:
-    from ayon_api.typing import RepresentationDict
+    from ayon_api.typing import RepresentationDict, AdvancedFilterDict
 
 
 class RepresentationsAPI(BaseServerAPI):
@@ -42,6 +42,7 @@ class RepresentationsAPI(BaseServerAPI):
         tags: Optional[Iterable[str]] = None,
         active: Optional[bool] = True,
         has_links: Optional[str] = None,
+        filters: Optional[AdvancedFilterDict] = None,
         fields: Optional[Iterable[str]] = None,
         own_attributes=_PLACEHOLDER,
     ) -> Generator[RepresentationDict, None, None]:
@@ -72,6 +73,7 @@ class RepresentationsAPI(BaseServerAPI):
                 Both are returned when 'None' is passed.
             has_links (Optional[Literal[IN, OUT, ANY]]): Filter
                 representations with IN/OUT/ANY links.
+            filters (Optional[AdvancedFilterDict]): Advanced filtering options.
             fields (Optional[Iterable[str]]): Fields to be queried for
                 representation. All possible fields are returned if 'None' is
                 passed.
@@ -106,7 +108,7 @@ class RepresentationsAPI(BaseServerAPI):
             fields.discard("files")
             fields |= REPRESENTATION_FILES_FIELDS
 
-        filters = {
+        graphql_filters = {
             "projectName": project_name
         }
 
@@ -114,7 +116,7 @@ class RepresentationsAPI(BaseServerAPI):
             representation_ids = set(representation_ids)
             if not representation_ids:
                 return
-            filters["representationIds"] = list(representation_ids)
+            graphql_filters["representationIds"] = list(representation_ids)
 
         version_ids_filter = None
         representation_names_filter = None
@@ -140,29 +142,35 @@ class RepresentationsAPI(BaseServerAPI):
                     return
 
         if version_ids_filter:
-            filters["versionIds"] = list(version_ids_filter)
+            graphql_filters["versionIds"] = list(version_ids_filter)
 
         if representation_names_filter:
-            filters["representationNames"] = list(representation_names_filter)
+            graphql_filters["representationNames"] = list(
+                representation_names_filter
+            )
 
         if statuses is not None:
             statuses = set(statuses)
             if not statuses:
                 return
-            filters["representationStatuses"] = list(statuses)
+            graphql_filters["representationStatuses"] = list(statuses)
 
         if tags is not None:
             tags = set(tags)
             if not tags:
                 return
-            filters["representationTags"] = list(tags)
+            graphql_filters["representationTags"] = list(tags)
 
         if has_links is not None:
-            filters["representationHasLinks"] = has_links.upper()
+            graphql_filters["representationHasLinks"] = has_links.upper()
+
+        filters = self._prepare_advanced_filters(filters)
+        if filters:
+            graphql_filters["filter"] = filters
 
         query = representations_graphql_query(fields)
 
-        for attr, filter_value in filters.items():
+        for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)
 
         for parsed_data in query.continuous_query(self):

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api_helpers/tasks.py

@@ -17,7 +17,7 @@ from ayon_api.graphql_queries import (
 from .base import BaseServerAPI
 
 if typing.TYPE_CHECKING:
-    from ayon_api.typing import TaskDict
+    from ayon_api.typing import TaskDict, AdvancedFilterDict
 
 
 class TasksAPI(BaseServerAPI):
@@ -38,6 +38,7 @@ class TasksAPI(BaseServerAPI):
         statuses: Optional[Iterable[str]] = None,
         tags: Optional[Iterable[str]] = None,
         active: Optional[bool] = True,
+        filters: Optional[AdvancedFilterDict] = None,
         fields: Optional[Iterable[str]] = None,
         own_attributes: bool = False
     ) -> Generator[TaskDict, None, None]:
@@ -62,6 +63,7 @@ class TasksAPI(BaseServerAPI):
                 filtering.
             active (Optional[bool]): Filter active/inactive tasks.
                 Both are returned if is set to None.
+            filters (Optional[AdvancedFilterDict]): Advanced filtering options.
             fields (Optional[Iterable[str]]): Fields to be queried for
                 folder. All possible folder fields are returned
                 if 'None' is passed.
@@ -75,11 +77,11 @@ class TasksAPI(BaseServerAPI):
         if not project_name:
             return
 
-        filters = {
+        graphql_filters = {
             "projectName": project_name
         }
         if not prepare_list_filters(
-            filters,
+            graphql_filters,
             ("taskIds", task_ids),
             ("taskNames", task_names),
             ("taskTypes", task_types),
@@ -91,6 +93,10 @@ class TasksAPI(BaseServerAPI):
         ):
             return
 
+        filters = self._prepare_advanced_filters(filters)
+        if filters:
+            graphql_filters["filter"] = filters
+
         if not fields:
             fields = self.get_default_fields_for_type("task")
         else:
@@ -101,7 +107,7 @@ class TasksAPI(BaseServerAPI):
             fields.add("active")
 
         query = tasks_graphql_query(fields)
-        for attr, filter_value in filters.items():
+        for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)
 
         for parsed_data in query.continuous_query(self):
@@ -193,6 +199,7 @@ class TasksAPI(BaseServerAPI):
         statuses: Optional[Iterable[str]] = None,
         tags: Optional[Iterable[str]] = None,
         active: Optional[bool] = True,
+        filters: Optional[AdvancedFilterDict] = None,
         fields: Optional[Iterable[str]] = None,
         own_attributes: bool = False
     ) -> dict[str, list[TaskDict]]:
@@ -215,6 +222,7 @@ class TasksAPI(BaseServerAPI):
                 filtering.
             active (Optional[bool]): Filter active/inactive tasks.
                 Both are returned if is set to None.
+            filters (Optional[AdvancedFilterDict]): Advanced filtering options.
             fields (Optional[Iterable[str]]): Fields to be queried for
                 folder. All possible folder fields are returned
                 if 'None' is passed.
@@ -230,12 +238,13 @@ class TasksAPI(BaseServerAPI):
         if not project_name or not folder_paths:
             return {}
 
-        filters = {
+        graphql_filters = {
             "projectName": project_name,
             "folderPaths": list(folder_paths),
         }
+
         if not prepare_list_filters(
-            filters,
+            graphql_filters,
             ("taskNames", task_names),
             ("taskTypes", task_types),
             ("taskAssigneesAny", assignees),
@@ -245,6 +254,10 @@ class TasksAPI(BaseServerAPI):
         ):
             return {}
 
+        filters = self._prepare_advanced_filters(filters)
+        if filters:
+            graphql_filters["filter"] = filters
+
         if not fields:
             fields = self.get_default_fields_for_type("task")
         else:
@@ -255,7 +268,7 @@ class TasksAPI(BaseServerAPI):
             fields.add("active")
 
         query = tasks_by_folder_paths_graphql_query(fields)
-        for attr, filter_value in filters.items():
+        for attr, filter_value in graphql_filters.items():
             query.set_variable_value(attr, filter_value)
 
         output = {

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/_api_helpers/versions.py

@@ -15,7 +15,7 @@ from ayon_api.graphql_queries import versions_graphql_query
 from .base import BaseServerAPI, _PLACEHOLDER
 
 if typing.TYPE_CHECKING:
-    from ayon_api.typing import VersionDict
+    from ayon_api.typing import VersionDict, AdvancedFilterDict
 
 
 class VersionsAPI(BaseServerAPI):
@@ -37,6 +37,7 @@ class VersionsAPI(BaseServerAPI):
         statuses: Optional[Iterable[str]] = None,
         tags: Optional[Iterable[str]] = None,
         active: Optional[bool] = True,
+        filters: Optional[AdvancedFilterDict] = None,
         fields: Optional[Iterable[str]] = None,
         own_attributes=_PLACEHOLDER
     ) -> Generator[VersionDict, None, None]:
@@ -63,6 +64,7 @@ class VersionsAPI(BaseServerAPI):
                 for filtering.
             active (Optional[bool]): Receive active/inactive entities.
                 Both are returned when 'None' is passed.
+            filters (Optional[AdvancedFilterDict]): Advanced filtering options.
             fields (Optional[Iterable[str]]): Fields to be queried
                 for version. All possible folder fields are returned
                 if 'None' is passed.
@@ -98,11 +100,12 @@ class VersionsAPI(BaseServerAPI):
         if not hero and not standard:
             return
 
-        filters = {
+        graphql_filters = {
             "projectName": project_name
         }
+
         if not prepare_list_filters(
-            filters,
+            graphql_filters,
             ("taskIds", task_ids),
             ("versionIds", version_ids),
             ("productIds", product_ids),
@@ -113,6 +116,11 @@ class VersionsAPI(BaseServerAPI):
         ):
             return
 
+
+        filters = self._prepare_advanced_filters(filters)
+        if filters:
+            graphql_filters["filter"] = filters
+
         queries = []
         # Add filters based on 'hero' and 'standard'
         # NOTE: There is not a filter to "ignore" hero versions or to get
@@ -123,14 +131,14 @@ class VersionsAPI(BaseServerAPI):
             # This query all versions standard + hero
             # - hero must be filtered out if is not enabled during loop
             query = versions_graphql_query(fields)
-            for attr, filter_value in filters.items():
+            for attr, filter_value in graphql_filters.items():
                 query.set_variable_value(attr, filter_value)
             queries.append(query)
         else:
             if hero:
                 # Add hero query if hero is enabled
                 hero_query = versions_graphql_query(fields)
-                for attr, filter_value in filters.items():
+                for attr, filter_value in graphql_filters.items():
                     hero_query.set_variable_value(attr, filter_value)
 
                 hero_query.set_variable_value("heroOnly", True)
@@ -138,7 +146,7 @@ class VersionsAPI(BaseServerAPI):
 
             if standard:
                 standard_query = versions_graphql_query(fields)
-                for attr, filter_value in filters.items():
+                for attr, filter_value in graphql_filters.items():
                     standard_query.set_variable_value(attr, filter_value)
 
                 if latest:

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/constants.py

@@ -247,6 +247,7 @@ DEFAULT_ACTIVITY_FIELDS = {
 DEFAULT_ENTITY_LIST_FIELDS = {
     "id",
     "count",
+    "allAttrib",
     "attributes",
     "active",
     "createdBy",
@@ -259,8 +260,4 @@ DEFAULT_ENTITY_LIST_FIELDS = {
     "tags",
     "updatedAt",
     "updatedBy",
-    "items.id",
-    "items.entityId",
-    "items.entityType",
-    "items.position",
 }

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/entity_hub.py

@@ -1582,6 +1582,8 @@ class BaseEntity(ABC):
         self._tags = copy.deepcopy(tags)
         self._thumbnail_id = thumbnail_id
 
+        if name == label:
+            label = None
         self._orig_name = name
         self._orig_label = label
         self._orig_status = status

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/graphql_queries.py

@@ -139,6 +139,7 @@ def folders_graphql_query(fields):
         "folderAssigneesAll", "[String!]"
     )
     tags_var = query.add_variable("folderTags", "[String!]")
+    filter_var = query.add_variable("filter", "String!")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -157,6 +158,7 @@ def folders_graphql_query(fields):
     folders_field.set_filter("hasTasks", has_tasks_var)
     folders_field.set_filter("hasLinks", has_links_var)
     folders_field.set_filter("hasChildren", has_children_var)
+    folders_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
     add_links_fields(folders_field, nested_fields)
@@ -188,6 +190,7 @@ def tasks_graphql_query(fields):
     assignees_all_var = query.add_variable("taskAssigneesAll", "[String!]")
     statuses_var = query.add_variable("taskStatuses", "[String!]")
     tags_var = query.add_variable("taskTags", "[String!]")
+    filter_var = query.add_variable("filter", "String!")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -203,6 +206,7 @@ def tasks_graphql_query(fields):
     tasks_field.set_filter("assignees", assignees_all_var)
     tasks_field.set_filter("statuses", statuses_var)
     tasks_field.set_filter("tags", tags_var)
+    tasks_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
     add_links_fields(tasks_field, nested_fields)
@@ -233,6 +237,7 @@ def tasks_by_folder_paths_graphql_query(fields):
     assignees_all_var = query.add_variable("taskAssigneesAll", "[String!]")
     statuses_var = query.add_variable("taskStatuses", "[String!]")
     tags_var = query.add_variable("taskTags", "[String!]")
+    filter_var = query.add_variable("filter", "String!")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -250,6 +255,7 @@ def tasks_by_folder_paths_graphql_query(fields):
     tasks_field.set_filter("assignees", assignees_all_var)
     tasks_field.set_filter("statuses", statuses_var)
     tasks_field.set_filter("tags", tags_var)
+    tasks_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(fields)
     add_links_fields(tasks_field, nested_fields)
@@ -284,6 +290,7 @@ def products_graphql_query(fields):
     product_path_regex_var = query.add_variable("productPathRegex", "String!")
     statuses_var = query.add_variable("productStatuses", "[String!]")
     tags_var = query.add_variable("productTags", "[String!]")
+    filter_var = query.add_variable("filter", "String!")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -298,6 +305,7 @@ def products_graphql_query(fields):
     products_field.set_filter("tags", tags_var)
     products_field.set_filter("nameEx", product_name_regex_var)
     products_field.set_filter("pathEx", product_path_regex_var)
+    products_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(set(fields))
     add_links_fields(products_field, nested_fields)
@@ -333,6 +341,7 @@ def versions_graphql_query(fields):
     )
     statuses_var = query.add_variable("versionStatuses", "[String!]")
     tags_var = query.add_variable("versionTags", "[String!]")
+    filter_var = query.add_variable("filter", "String!")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -347,6 +356,7 @@ def versions_graphql_query(fields):
     versions_field.set_filter("heroOrLatestOnly", hero_or_latest_only_var)
     versions_field.set_filter("statuses", statuses_var)
     versions_field.set_filter("tags", tags_var)
+    versions_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(set(fields))
     add_links_fields(versions_field, nested_fields)
@@ -383,6 +393,7 @@ def representations_graphql_query(fields):
     tags_var = query.add_variable(
         "representationTags", "[String!]"
     )
+    filter_var = query.add_variable("filter", "String!")
 
     project_field = query.add_field("project")
     project_field.set_filter("name", project_name_var)
@@ -394,6 +405,7 @@ def representations_graphql_query(fields):
     repres_field.set_filter("hasLinks", has_links_var)
     repres_field.set_filter("statuses", statuses_var)
     repres_field.set_filter("tags", tags_var)
+    repres_field.set_filter("filter", filter_var)
 
     nested_fields = fields_to_dict(set(fields))
     add_links_fields(repres_field, nested_fields)

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/server_api.py

@@ -1377,9 +1377,11 @@ class ServerAPI(
             try:
                 with get_func(url, **kwargs) as response:
                     response.raise_for_status()
-                    progress.set_content_size(
-                        response.headers["Content-length"]
-                    )
+                    if progress.get_content_size() is None:
+                        progress.set_content_size(
+                            response.headers["Content-length"]
+                        )
+
                     for chunk in response.iter_content(chunk_size=chunk_size):
                         stream.write(chunk)
                         progress.add_transferred_chunk(len(chunk))
@@ -1496,6 +1498,76 @@ class ServerAPI(
 
         return progress
 
+    def download_project_file(
+        self,
+        project_name: str,
+        file_id: str,
+        filepath: str,
+        *,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> TransferProgress:
+        """Download project file to filepath.
+
+        Project files are usually binary files, such as images, videos,
+            or other media files that can be accessed via api endpoint
+            '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+        Args:
+            project_name (str): Project name.
+            file_id (str): File id.
+            filepath (str): Path where file will be downloaded.
+            chunk_size (Optional[int]): Size of chunks that are received
+                in single loop.
+            progress (Optional[TransferProgress]): Object that gives ability
+                to track download progress.
+
+        Returns:
+            TransferProgress: Progress object.
+
+        """
+        return self.download_file(
+            f"api/projects/{project_name}/files/{file_id}",
+            filepath,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
+    def download_project_file_to_stream(
+        self,
+        project_name: str,
+        file_id: str,
+        stream: StreamType,
+        *,
+        chunk_size: Optional[int] = None,
+        progress: Optional[TransferProgress] = None,
+    ) -> TransferProgress:
+        """Download project file to a stream.
+
+        Project files are usually binary files, such as images, videos,
+            or other media files that can be accessed via api endpoint
+            '{server url}/api/projects/{project_name}/files/{file_id}'.
+
+        Args:
+            project_name (str): Project name.
+            file_id (str): File id.
+            stream (StreamType): Stream where output will be stored.
+            chunk_size (Optional[int]): Size of chunks that are received
+                in single loop.
+            progress (Optional[TransferProgress]): Object that gives ability
+                to track download progress.
+
+        Returns:
+            TransferProgress: Progress object.
+
+        """
+        return self.download_file_to_stream(
+            f"api/projects/{project_name}/files/{file_id}",
+            stream,
+            chunk_size=chunk_size,
+            progress=progress,
+        )
+
     @staticmethod
     def _upload_chunks_iter(
         file_stream: StreamType,
@@ -1884,6 +1956,8 @@ class ServerAPI(
 
         elif entity_type == "entityList":
             entity_type_defaults = set(DEFAULT_ENTITY_LIST_FIELDS)
+            # Attributes scope is 'list'
+            entity_type = "list"
 
         else:
             raise ValueError(f"Unknown entity type \"{entity_type}\"")
@@ -2191,6 +2265,16 @@ class ServerAPI(
                 )
             }
 
+    def _prepare_advanced_filters(
+        self, filters: Union[str, dict[str, Any], None]
+    ) -> Optional[str]:
+        if not filters:
+            return None
+
+        if isinstance(filters, dict):
+            return json.dumps(filters)
+        return filters
+
     def _convert_entity_data(self, entity: AnyEntityDict):
         if not entity or "data" not in entity:
             return

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/typing.py

@@ -602,3 +602,23 @@ StreamType = Union[io.BytesIO, BinaryIO]
 class EntityListAttributeDefinitionDict(TypedDict):
     name: str
     data: dict[str, Any]
+
+
+AdvancedFilterOperator = Literal["and", "or"]
+AdvancedFilterConditionOperator = Literal[
+    "eq", "lt", "gt", "lte", "gte", "ne",
+    "isnull", "notnull",
+    "in", "notin", "contains", "excludes",
+    "any", "like"
+]
+
+
+class AdvancedFilterConditionDict(TypedDict):
+    key: str
+    value: Any
+    operator: AdvancedFilterConditionOperator
+
+
+class AdvancedFilterDict(TypedDict):
+    conditions: list[Union[AdvancedFilterConditionDict, "AdvancedFilterDict"]]
+    operator: AdvancedFilterOperator

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/ayon_api/version.py

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

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9/ayon_python_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ayon_python_api
-Version: 1.2.7
+Version: 1.2.9
 Summary: AYON Python API
 Home-page: https://github.com/ynput/ayon-python-api
 Author: ynput.io

{ayon_python_api-1.2.7 → ayon_python_api-1.2.9}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ayon_python_api"
-version = "1.2.7"
+version = "1.2.9"
 description = "AYON Python API"
 license = {file = "LICENSE"}
 readme = {file = "README.md", content-type = "text/markdown"}