ayon-python-api 1.2.22__tar.gz → 1.2.23__tar.gz

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/PKG-INFO

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

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/__init__.py

@@ -275,6 +275,7 @@ from ._api import (
     delete_link_type,
     make_sure_link_type_exists,
     create_link,
+    create_links,
     delete_link,
     get_entities_links,
     get_folders_links,
@@ -594,6 +595,7 @@ __all__ = (
     "delete_link_type",
     "make_sure_link_type_exists",
     "create_link",
+    "create_links",
     "delete_link",
     "get_entities_links",
     "get_folders_links",

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/_api.py

@@ -53,6 +53,8 @@ if typing.TYPE_CHECKING:
         BackgroundOperationTask,
         LinkDirection,
         CreateLinkData,
+        CreateLinkResponseData,
+        CreateLinksResponseItem,
         EventFilter,
         EventStatus,
         EnrollEventData,
@@ -1620,7 +1622,9 @@ def get_rest_entity_by_id(
 def send_batch_operations(
     project_name: str,
     operations: list[dict[str, Any]],
+    *,
     can_fail: bool = False,
+    wait_for_events: bool = False,
     raise_on_fail: bool = True,
 ) -> list[dict[str, Any]]:
     """Post multiple CRUD operations to server.
@@ -1635,6 +1639,7 @@ def send_batch_operations(
         operations (list[dict[str, Any]]): Operations to be processed.
         can_fail (bool): Server will try to process all
             operations even if one of them fails.
+        wait_for_events (bool): Wait for events to be processed on server.
         raise_on_fail (bool): Raise exception if an operation
             fails. You can handle failed operations on your own
             when set to 'False'.
@@ -1653,6 +1658,7 @@ def send_batch_operations(
         project_name=project_name,
         operations=operations,
         can_fail=can_fail,
+        wait_for_events=wait_for_events,
         raise_on_fail=raise_on_fail,
     )
 
@@ -1662,8 +1668,9 @@ def send_background_batch_operations(
     operations: list[dict[str, Any]],
     *,
     can_fail: bool = False,
-    wait: bool = False,
+    wait_for_events: bool = False,
     raise_on_fail: bool = True,
+    wait: bool = False,
 ) -> BackgroundOperationTask:
     """Post multiple CRUD operations to server.
 
@@ -1686,10 +1693,11 @@ def send_background_batch_operations(
         operations (list[dict[str, Any]]): Operations to be processed.
         can_fail (bool): Server will try to process all
             operations even if one of them fails.
-        wait (bool): Wait for operations to end.
+        wait_for_events (bool): Wait for events to be processed on server.
         raise_on_fail (bool): Raise exception if an operation
             fails. You can handle failed operations on your own
             when set to 'False'. Used when 'wait' is enabled.
+        wait (bool): Wait for operations to end.
 
     Raises:
         ValueError: Operations can't be converted to json string.
@@ -1705,8 +1713,9 @@ def send_background_batch_operations(
         project_name=project_name,
         operations=operations,
         can_fail=can_fail,
-        wait=wait,
+        wait_for_events=wait_for_events,
         raise_on_fail=raise_on_fail,
+        wait=wait,
     )
 
 
@@ -2708,7 +2717,9 @@ def set_entity_watchers(
 def send_activities_batch_operations(
     project_name: str,
     operations: list[dict[str, Any]],
+    *,
     can_fail: bool = False,
+    wait_for_events: bool = False,
     raise_on_fail: bool = True,
 ) -> list[dict[str, Any]]:
     """Post multiple CRUD activities operations to server.
@@ -2723,6 +2734,7 @@ def send_activities_batch_operations(
         operations (list[dict[str, Any]]): Operations to be processed.
         can_fail (Optional[bool]): Server will try to process all
             operations even if one of them fails.
+        wait_for_events (bool): Wait for events to be processed on server.
         raise_on_fail (Optional[bool]): Raise exception if an operation
             fails. You can handle failed operations on your own
             when set to 'False'.
@@ -2741,6 +2753,7 @@ def send_activities_batch_operations(
         project_name=project_name,
         operations=operations,
         can_fail=can_fail,
+        wait_for_events=wait_for_events,
         raise_on_fail=raise_on_fail,
     )
 
@@ -7504,7 +7517,7 @@ def create_link(
     output_type: str,
     link_name: Optional[str] = None,
     data: Optional[dict[str, Any]] = None,
-) -> CreateLinkData:
+) -> CreateLinkResponseData:
     """Create link between 2 entities.
 
     Link has a type which must already exists on a project.
@@ -7527,7 +7540,7 @@ def create_link(
             with the link.
 
     Returns:
-        CreateLinkData: Information about link.
+        CreateLinkResponseData: Information about link.
 
     Raises:
         HTTPRequestError: Server error happened.
@@ -7546,6 +7559,41 @@ def create_link(
     )
 
 
+def create_links(
+    project_name: str,
+    links: list[CreateLinkData],
+) -> list[CreateLinksResponseItem]:
+    """Create multiple links in a single request.
+
+    Example of link data::
+        [
+            {
+                "input": "59a212c0d2e211eda0e20242ac120001",
+                "output": "59a212c0d2e211eda0e20242ac120002",
+                "linkType": "reference|folder|folder",
+                "name": "my_link",
+                "data": {"key": "value"}
+            }
+        ]
+
+    Args:
+        project_name (str): Project where links are created.
+        links (list[CreateLinkData]): List of link data.
+
+    Returns:
+        list[CreateLinksResponseItem]: Information about created links.
+
+    Raises:
+        ValueError: Link data is invalid.
+
+    """
+    con = get_server_api_connection()
+    return con.create_links(
+        project_name=project_name,
+        links=links,
+    )
+
+
 def delete_link(
     project_name: str,
     link_id: str,
@@ -8003,8 +8051,8 @@ def create_entity_list(
     *,
     list_type: Optional[str] = None,
     access: Optional[dict[str, Any]] = None,
-    attrib: Optional[list[dict[str, Any]]] = None,
-    data: Optional[list[dict[str, Any]]] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
     tags: Optional[list[str]] = None,
     template: Optional[dict[str, Any]] = None,
     entity_list_folder_id: Optional[str] = None,
@@ -8060,8 +8108,8 @@ def update_entity_list(
     *,
     label: Optional[str] = None,
     access: Optional[dict[str, Any]] = None,
-    attrib: Optional[list[dict[str, Any]]] = None,
-    data: Optional[list[dict[str, Any]]] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
     tags: Optional[list[str]] = None,
     entity_list_folder_id: str | None | type[NOT_SET] = NOT_SET,
     owner: Optional[str] = None,

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/_api_helpers/activities.py

@@ -370,8 +370,10 @@ class ActivitiesAPI(BaseServerAPI):
         self,
         project_name: str,
         operations: list[dict[str, Any]],
+        *,
         can_fail: bool = False,
-        raise_on_fail: bool = True
+        wait_for_events: bool = False,
+        raise_on_fail: bool = True,
     ) -> list[dict[str, Any]]:
         """Post multiple CRUD activities operations to server.
 
@@ -385,6 +387,7 @@ class ActivitiesAPI(BaseServerAPI):
             operations (list[dict[str, Any]]): Operations to be processed.
             can_fail (Optional[bool]): Server will try to process all
                 operations even if one of them fails.
+            wait_for_events (bool): Wait for events to be processed on server.
             raise_on_fail (Optional[bool]): Raise exception if an operation
                 fails. You can handle failed operations on your own
                 when set to 'False'.
@@ -401,6 +404,7 @@ class ActivitiesAPI(BaseServerAPI):
         return self._send_batch_operations(
             f"projects/{project_name}/operations/activities",
             operations,
-            can_fail,
-            raise_on_fail,
+            can_fail=can_fail,
+            wait_for_events=wait_for_events,
+            raise_on_fail=raise_on_fail,
         )

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/_api_helpers/base.py

@@ -167,6 +167,7 @@ class BaseServerAPI:
         uri: str,
         operations: list[dict[str, Any]],
         can_fail: bool,
+        wait_for_events: bool,
         raise_on_fail: bool
     ) -> list[dict[str, Any]]:
         raise NotImplementedError()

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/_api_helpers/links.py

@@ -15,7 +15,12 @@ from ayon_api.graphql_queries import (
 from .base import BaseServerAPI
 
 if typing.TYPE_CHECKING:
-    from ayon_api.typing import LinkDirection, CreateLinkData
+    from ayon_api.typing import (
+        LinkDirection,
+        CreateLinkData,
+        CreateLinkResponseData,
+        CreateLinksResponseItem,
+    )
 
 
 class LinksAPI(BaseServerAPI):
@@ -200,7 +205,7 @@ class LinksAPI(BaseServerAPI):
         output_type: str,
         link_name: Optional[str] = None,
         data: Optional[dict[str, Any]] = None,
-    ) -> CreateLinkData:
+    ) -> CreateLinkResponseData:
         """Create link between 2 entities.
 
         Link has a type which must already exists on a project.
@@ -223,7 +228,7 @@ class LinksAPI(BaseServerAPI):
                 with the link.
 
         Returns:
-            CreateLinkData: Information about link.
+            CreateLinkResponseData: Information about link.
 
         Raises:
             HTTPRequestError: Server error happened.
@@ -249,6 +254,70 @@ class LinksAPI(BaseServerAPI):
         response.raise_for_status()
         return response.data
 
+    def create_links(
+        self,
+        project_name: str,
+        links: list[CreateLinkData],
+    ) -> list[CreateLinksResponseItem]:
+        """Create multiple links in a single request.
+
+        Example of link data::
+            [
+                {
+                    "input": "59a212c0d2e211eda0e20242ac120001",
+                    "output": "59a212c0d2e211eda0e20242ac120002",
+                    "linkType": "reference|folder|folder",
+                    "name": "my_link",
+                    "data": {"key": "value"}
+                }
+            ]
+
+        Args:
+            project_name (str): Project where links are created.
+            links (list[CreateLinkData]): List of link data.
+
+        Returns:
+            list[CreateLinksResponseItem]: Information about created links.
+
+        Raises:
+            ValueError: Link data is invalid.
+
+        """
+        if not links:
+            return []
+
+        for link in links:
+            self._validate_link_data(link)
+
+        if self.get_server_version_tuple() < (1, 15, 8):
+            created_links = []
+            for link in links:
+                link_type, in_type, out_type = link["linkType"].split("|")
+                data = self.create_link(
+                    project_name,
+                    link_type,
+                    link["input"],
+                    in_type,
+                    link["output"],
+                    out_type,
+                    link_name=link.get("name") or None,
+                    data=link.get("data") or None,
+                )
+                created_links.append({
+                    "id": data["id"],
+                    "input": link["input"],
+                    "output": link["output"],
+                    "linkType": link["linkType"]
+                })
+            return created_links
+
+        response = self.post(
+            f"projects/{project_name}/links/bulk",
+            links=links
+        )
+        response.raise_for_status()
+        return response.data["created"]
+
     def delete_link(self, project_name: str, link_id: str) -> None:
         """Remove link by id.
 
@@ -619,6 +688,35 @@ class LinksAPI(BaseServerAPI):
             project_name, [representation_id], link_types, link_direction
         )[representation_id]
 
+    def _validate_link_data(self, link_data: dict[str, Any]) -> None:
+        """Validate link data before sending to server.
+
+        Args:
+            link_data (dict[str, Any]): Link data to validate.
+
+        Raises:
+            ValueError: Link data is invalid.
+
+        """
+        required_keys = {"input", "output", "linkType"}
+        missing_keys = required_keys - link_data.keys()
+        if missing_keys:
+            mk = ", ".join(f"'{key}'" for key in sorted(missing_keys))
+            raise ValueError(f"Missing required keys in link data: {mk}")
+
+        link_type = link_data["linkType"]
+        if not isinstance(link_type, str):
+            raise ValueError(
+                f"Invalid linkType type: {type(link_type)}. Expected 'str'"
+            )
+
+        link_type_parts = link_type.split("|")
+        if len(link_type_parts) != 3:
+            raise ValueError(
+                f"Invalid linkType format: {link_type}. Expected format:"
+                " 'link_type|input_type|output_type'"
+            )
+
     def _prepare_link_filters(
         self,
         filters: dict[str, Any],

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/_api_helpers/lists.py

@@ -157,8 +157,8 @@ class ListsAPI(BaseServerAPI):
         *,
         list_type: Optional[str] = None,
         access: Optional[dict[str, Any]] = None,
-        attrib: Optional[list[dict[str, Any]]] = None,
-        data: Optional[list[dict[str, Any]]] = None,
+        attrib: Optional[dict[str, Any]] = None,
+        data: Optional[dict[str, Any]] = None,
         tags: Optional[list[str]] = None,
         template: Optional[dict[str, Any]] = None,
         entity_list_folder_id: Optional[str] = None,
@@ -225,8 +225,8 @@ class ListsAPI(BaseServerAPI):
         *,
         label: Optional[str] = None,
         access: Optional[dict[str, Any]] = None,
-        attrib: Optional[list[dict[str, Any]]] = None,
-        data: Optional[list[dict[str, Any]]] = None,
+        attrib: Optional[dict[str, Any]] = None,
+        data: Optional[dict[str, Any]] = None,
         tags: Optional[list[str]] = None,
         entity_list_folder_id: str | None | type[NOT_SET] = NOT_SET,
         owner: Optional[str] = None,

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/operations.py

@@ -741,12 +741,21 @@ class OperationsSession(object):
     Args:
         con (Optional[ServerAPI]): Connection to server. Global connection
             is used if not passed.
+        wait_for_events (bool): Wait for events to be processed on server.
+            Default value of the argument. Can be changed when 'commit'
+            is called.
 
     """
-    def __init__(self, con: Optional[ServerAPI] = None) -> None:
+    def __init__(
+        self,
+        con: Optional[ServerAPI] = None,
+        *,
+        wait_for_events: bool = False,
+    ) -> None:
         if con is None:
             con = get_server_api_connection()
         self._con = con
+        self._wait_for_events = wait_for_events
         self._project_cache = {}
         self._operations = []
         self._nested_operations = collections.defaultdict(list)
@@ -817,8 +826,15 @@ class OperationsSession(object):
             for operation in self._operations
         ]
 
-    def commit(self) -> None:
-        """Commit session operations."""
+    def commit(self, *, wait_for_events: bool | None = None) -> None:
+        """Commit session operations.
+
+        Args:
+            wait_for_events (bool | None): Wait for events to be processed
+                on server. Use 'None' to use the default value defined on
+                OperationsSession object.
+
+        """
         operations, self._operations = self._operations, []
         if not operations:
             return
@@ -827,6 +843,9 @@ class OperationsSession(object):
         for operation in operations:
             operations_by_project[operation.project_name].append(operation)
 
+        if wait_for_events is None:
+            wait_for_events = self._wait_for_events
+
         for project_name, operations in operations_by_project.items():
             operations_body = []
             for operation in operations:
@@ -835,7 +854,11 @@ class OperationsSession(object):
                     operations_body.append(body)
 
             self._con.send_background_batch_operations(
-                project_name, operations_body, wait=True, can_fail=False
+                project_name,
+                operations_body,
+                can_fail=False,
+                wait_for_events=wait_for_events,
+                wait=True,
             )
 
     def create_entity(

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/server_api.py

@@ -2475,7 +2475,9 @@ class ServerAPI(
         self,
         project_name: str,
         operations: list[dict[str, Any]],
+        *,
         can_fail: bool = False,
+        wait_for_events: bool = False,
         raise_on_fail: bool = True,
     ) -> list[dict[str, Any]]:
         """Post multiple CRUD operations to server.
@@ -2490,6 +2492,7 @@ class ServerAPI(
             operations (list[dict[str, Any]]): Operations to be processed.
             can_fail (bool): Server will try to process all
                 operations even if one of them fails.
+            wait_for_events (bool): Wait for events to be processed on server.
             raise_on_fail (bool): Raise exception if an operation
                 fails. You can handle failed operations on your own
                 when set to 'False'.
@@ -2506,8 +2509,9 @@ class ServerAPI(
         return self._send_batch_operations(
             f"projects/{project_name}/operations",
             operations,
-            can_fail,
-            raise_on_fail,
+            can_fail=can_fail,
+            wait_for_events=wait_for_events,
+            raise_on_fail=raise_on_fail,
         )
 
     def send_background_batch_operations(
@@ -2516,8 +2520,9 @@ class ServerAPI(
         operations: list[dict[str, Any]],
         *,
         can_fail: bool = False,
-        wait: bool = False,
+        wait_for_events: bool = False,
         raise_on_fail: bool = True,
+        wait: bool = False,
     ) -> BackgroundOperationTask:
         """Post multiple CRUD operations to server.
 
@@ -2540,10 +2545,11 @@ class ServerAPI(
             operations (list[dict[str, Any]]): Operations to be processed.
             can_fail (bool): Server will try to process all
                 operations even if one of them fails.
-            wait (bool): Wait for operations to end.
+            wait_for_events (bool): Wait for events to be processed on server.
             raise_on_fail (bool): Raise exception if an operation
                 fails. You can handle failed operations on your own
                 when set to 'False'. Used when 'wait' is enabled.
+            wait (bool): Wait for operations to end.
 
         Raises:
             ValueError: Operations can't be converted to json string.
@@ -2558,7 +2564,8 @@ class ServerAPI(
         response = self.post(
             f"projects/{project_name}/operations/background",
             operations=operations_body,
-            canFail=can_fail
+            canFail=can_fail,
+            waitForEvents=wait_for_events,
         )
         response.raise_for_status()
         if not wait:
@@ -2631,7 +2638,8 @@ class ServerAPI(
         uri: str,
         operations: list[dict[str, Any]],
         can_fail: bool,
-        raise_on_fail: bool
+        wait_for_events: bool,
+        raise_on_fail: bool,
     ) -> list[dict[str, Any]]:
         if not operations:
             return []
@@ -2643,7 +2651,8 @@ class ServerAPI(
         response = self.post(
             uri,
             operations=operations_body,
-            canFail=can_fail
+            canFail=can_fail,
+            waitForEvents=wait_for_events,
         )
 
         op_results = response.get("operations")

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/typing.py

@@ -127,8 +127,23 @@ AttributeType = Literal[
 LinkDirection = Literal["in", "out"]
 
 
-class CreateLinkData(TypedDict):
+class CreateLinkResponseData(TypedDict):
+    id: str
+
+
+class CreateLinksResponseItem(TypedDict):
     id: str
+    input: str
+    output: str
+    linkType: str
+
+
+class CreateLinkData(TypedDict):
+    input: str
+    output: str
+    linkType: str
+    data: NotRequired[dict[str, Any] | None]
+    name: NotRequired[str | None]
 
 
 class AttributeEnumItemDict(TypedDict):

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_api/version.py

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

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/ayon_python_api.egg-info/PKG-INFO

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

{ayon_python_api-1.2.22 → ayon_python_api-1.2.23}/pyproject.toml

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