ayon-python-api 1.2.1__tar.gz → 1.2.3__tar.gz

{ayon-python-api-1.2.1/ayon_python_api.egg-info → ayon_python_api-1.2.3}/PKG-INFO

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

{ayon-python-api-1.2.1 → ayon_python_api-1.2.3}/ayon_api/__init__.py

@@ -80,6 +80,8 @@ from ._api import (
     get_default_fields_for_type,
     get_rest_entity_by_id,
     send_batch_operations,
+    send_background_batch_operations,
+    get_background_operations_status,
     get_installers,
     create_installer,
     update_installer,
@@ -220,11 +222,17 @@ from ._api import (
     create_representation,
     update_representation,
     delete_representation,
+    get_workfile_entities,
+    get_workfile_entity,
+    get_workfile_entity_by_id,
+    create_workfile_entity,
+    update_workfile_entity,
+    delete_workfile_entity,
     get_workfiles_info,
     get_workfile_info,
     get_workfile_info_by_id,
-    delete_workfile_info,
     update_workfile_info,
+    delete_workfile_info,
     get_full_link_type_name,
     get_link_types,
     get_link_type,
@@ -347,6 +355,8 @@ __all__ = (
     "get_default_fields_for_type",
     "get_rest_entity_by_id",
     "send_batch_operations",
+    "send_background_batch_operations",
+    "get_background_operations_status",
     "get_installers",
     "create_installer",
     "update_installer",
@@ -487,11 +497,17 @@ __all__ = (
     "create_representation",
     "update_representation",
     "delete_representation",
+    "get_workfile_entities",
+    "get_workfile_entity",
+    "get_workfile_entity_by_id",
+    "create_workfile_entity",
+    "update_workfile_entity",
+    "delete_workfile_entity",
     "get_workfiles_info",
     "get_workfile_info",
     "get_workfile_info_by_id",
-    "delete_workfile_info",
     "update_workfile_info",
+    "delete_workfile_info",
     "get_full_link_type_name",
     "get_link_types",
     "get_link_type",

{ayon-python-api-1.2.1 → ayon_python_api-1.2.3}/ayon_api/_api.py

@@ -48,6 +48,7 @@ if typing.TYPE_CHECKING:
         ActivityReferenceType,
         EntityListEntityType,
         EntityListItemMode,
+        BackgroundOperationTask,
         LinkDirection,
         EventFilter,
         EventStatus,
@@ -1253,6 +1254,80 @@ def send_batch_operations(
     )
 
 
+def send_background_batch_operations(
+    project_name: str,
+    operations: list[dict[str, Any]],
+    *,
+    can_fail: bool = False,
+    wait: bool = False,
+    raise_on_fail: bool = True,
+) -> BackgroundOperationTask:
+    """Post multiple CRUD operations to server.
+
+    When multiple changes should be made on server side this is the best
+    way to go. It is possible to pass multiple operations to process on a
+    server side and do the changes in a transaction.
+
+    Compared to 'send_batch_operations' this function creates a task on
+        server which then can be periodically checked for a status and
+        receive it's result.
+
+    When used with 'wait' set to 'True' this method blocks until task is
+        finished. Which makes it work as 'send_batch_operations'
+        but safer for large operations batch as is not bound to
+        response timeout.
+
+    Args:
+        project_name (str): On which project should be operations
+            processed.
+        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 (bool): Wait for operations to end.
+        raise_on_fail (Optional[bool]): Raise exception if an operation
+            fails. You can handle failed operations on your own
+            when set to 'False'. Used when 'wait' is enabled.
+
+    Raises:
+        ValueError: Operations can't be converted to json string.
+        FailedOperations: When output does not contain server operations
+            or 'raise_on_fail' is enabled and any operation fails.
+
+    Returns:
+        BackgroundOperationTask: Background operation.
+
+    """
+    con = get_server_api_connection()
+    return con.send_background_batch_operations(
+        project_name=project_name,
+        operations=operations,
+        can_fail=can_fail,
+        wait=wait,
+        raise_on_fail=raise_on_fail,
+    )
+
+
+def get_background_operations_status(
+    project_name: str,
+    task_id: str,
+) -> BackgroundOperationTask:
+    """Get status of background operations task.
+
+    Args:
+        project_name (str): Project name.
+        task_id (str): Backgorund operation task id.
+
+    Returns:
+        BackgroundOperationTask: Background operation.
+
+    """
+    con = get_server_api_connection()
+    return con.get_background_operations_status(
+        project_name=project_name,
+        task_id=task_id,
+    )
+
+
 def get_installers(
     version: Optional[str] = None,
     platform_name: Optional[str] = None,
@@ -6082,8 +6157,9 @@ def delete_representation(
     )
 
 
-def get_workfiles_info(
+def get_workfile_entities(
     project_name: str,
+    *,
     workfile_ids: Optional[Iterable[str]] = None,
     task_ids: Optional[Iterable[str]] = None,
     paths: Optional[Iterable[str]] = None,
@@ -6092,7 +6168,6 @@ def get_workfiles_info(
     tags: Optional[Iterable[str]] = None,
     has_links: Optional[str] = None,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Generator[WorkfileInfoDict, None, None]:
     """Workfile info entities by passed filters.
 
@@ -6111,8 +6186,6 @@ def get_workfiles_info(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Generator[WorkfileInfoDict, None, None]: Queried workfile info
@@ -6120,7 +6193,7 @@ def get_workfiles_info(
 
     """
     con = get_server_api_connection()
-    return con.get_workfiles_info(
+    return con.get_workfile_entities(
         project_name=project_name,
         workfile_ids=workfile_ids,
         task_ids=task_ids,
@@ -6130,16 +6203,15 @@ def get_workfiles_info(
         tags=tags,
         has_links=has_links,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def get_workfile_info(
+def get_workfile_entity(
     project_name: str,
     task_id: str,
     path: str,
+    *,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Optional[WorkfileInfoDict]:
     """Workfile info entity by task id and workfile path.
 
@@ -6150,28 +6222,25 @@ def get_workfile_info(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Optional[WorkfileInfoDict]: Workfile info entity or None.
 
     """
     con = get_server_api_connection()
-    return con.get_workfile_info(
+    return con.get_workfile_entity(
         project_name=project_name,
         task_id=task_id,
         path=path,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def get_workfile_info_by_id(
+def get_workfile_entity_by_id(
     project_name: str,
     workfile_id: str,
+    *,
     fields: Optional[Iterable[str]] = None,
-    own_attributes=_PLACEHOLDER,
 ) -> Optional[WorkfileInfoDict]:
     """Workfile info entity by id.
 
@@ -6181,23 +6250,119 @@ def get_workfile_info_by_id(
         fields (Optional[Iterable[str]]): Fields to be queried for
             representation. All possible fields are returned if 'None' is
             passed.
-        own_attributes (Optional[bool]): DEPRECATED: Not supported for
-            workfiles.
 
     Returns:
         Optional[WorkfileInfoDict]: Workfile info entity or None.
 
     """
     con = get_server_api_connection()
-    return con.get_workfile_info_by_id(
+    return con.get_workfile_entity_by_id(
         project_name=project_name,
         workfile_id=workfile_id,
         fields=fields,
-        own_attributes=own_attributes,
     )
 
 
-def delete_workfile_info(
+def create_workfile_entity(
+    project_name: str,
+    path: str,
+    task_id: str,
+    *,
+    thumbnail_id: Optional[str] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
+    tags: Optional[list[str]] = None,
+    status: Optional[str] = None,
+    active: Optional[bool] = None,
+    workfile_id: Optional[str] = None,
+) -> str:
+    """Create new workfile.
+
+    Args:
+        project_name (str): Project name.
+        path (str): Representation name.
+        task_id (str): Parent task id.
+        thumbnail_id (Optional[str]): Thumbnail id.
+        attrib (Optional[dict[str, Any]]): Representation attributes.
+        data (Optional[dict[str, Any]]): Representation data.
+        tags (Optional[Iterable[str]]): Representation tags.
+        status (Optional[str]): Representation status.
+        active (Optional[bool]): Representation active state.
+        workfile_id (Optional[str]): Workfile info id. If not
+            passed new id is generated.
+
+    Returns:
+        str: Workfile info id.
+
+    """
+    con = get_server_api_connection()
+    return con.create_workfile_entity(
+        project_name=project_name,
+        path=path,
+        task_id=task_id,
+        thumbnail_id=thumbnail_id,
+        attrib=attrib,
+        data=data,
+        tags=tags,
+        status=status,
+        active=active,
+        workfile_id=workfile_id,
+    )
+
+
+def update_workfile_entity(
+    project_name: str,
+    workfile_id: str,
+    *,
+    path: Optional[str] = None,
+    task_id: Optional[str] = None,
+    attrib: Optional[dict[str, Any]] = None,
+    data: Optional[dict[str, Any]] = None,
+    tags: Optional[Iterable[str]] = None,
+    status: Optional[str] = None,
+    active: Optional[bool] = None,
+    thumbnail_id: Optional[str] = NOT_SET,
+    created_by: Optional[str] = None,
+    updated_by: Optional[str] = None,
+) -> None:
+    """Update workfile entity on server.
+
+    Update of ``attrib`` does change only passed attributes. If you want
+        to unset value, use ``None``.
+
+    Args:
+        project_name (str): Project name.
+        workfile_id (str): Workfile id.
+        path (Optional[str]): New rootless workfile path..
+        task_id (Optional[str]): New parent task id.
+        attrib (Optional[dict[str, Any]]): New attributes.
+        data (Optional[dict[str, Any]]): New data.
+        tags (Optional[Iterable[str]]): New tags.
+        status (Optional[str]): New status.
+        active (Optional[bool]): New active state.
+        thumbnail_id (Optional[str]): New thumbnail id.
+        created_by (Optional[str]): New created by username.
+        updated_by (Optional[str]): New updated by username.
+
+    """
+    con = get_server_api_connection()
+    return con.update_workfile_entity(
+        project_name=project_name,
+        workfile_id=workfile_id,
+        path=path,
+        task_id=task_id,
+        attrib=attrib,
+        data=data,
+        tags=tags,
+        status=status,
+        active=active,
+        thumbnail_id=thumbnail_id,
+        created_by=created_by,
+        updated_by=updated_by,
+    )
+
+
+def delete_workfile_entity(
     project_name: str,
     workfile_id: str,
 ) -> None:
@@ -6209,12 +6374,127 @@ def delete_workfile_info(
 
     """
     con = get_server_api_connection()
-    return con.delete_workfile_info(
+    return con.delete_workfile_entity(
         project_name=project_name,
         workfile_id=workfile_id,
     )
 
 
+def get_workfiles_info(
+    project_name: str,
+    workfile_ids: Optional[Iterable[str]] = None,
+    task_ids: Optional[Iterable[str]] = None,
+    paths: Optional[Iterable[str]] = None,
+    path_regex: Optional[str] = None,
+    statuses: Optional[Iterable[str]] = None,
+    tags: Optional[Iterable[str]] = None,
+    has_links: Optional[str] = None,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Generator[WorkfileInfoDict, None, None]:
+    """DEPRECATED Workfile info entities by passed filters.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        workfile_ids (Optional[Iterable[str]]): Workfile ids.
+        task_ids (Optional[Iterable[str]]): Task ids.
+        paths (Optional[Iterable[str]]): Rootless workfiles paths.
+        path_regex (Optional[str]): Regex filter for workfile path.
+        statuses (Optional[Iterable[str]]): Workfile info statuses used
+            for filtering.
+        tags (Optional[Iterable[str]]): Workfile info tags used
+            for filtering.
+        has_links (Optional[Literal[IN, OUT, ANY]]): Filter
+            representations with IN/OUT/ANY links.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Generator[WorkfileInfoDict, None, None]: Queried workfile info
+            entites.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfiles_info(
+        project_name=project_name,
+        workfile_ids=workfile_ids,
+        task_ids=task_ids,
+        paths=paths,
+        path_regex=path_regex,
+        statuses=statuses,
+        tags=tags,
+        has_links=has_links,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
+def get_workfile_info(
+    project_name: str,
+    task_id: str,
+    path: str,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Optional[WorkfileInfoDict]:
+    """DEPRECATED Workfile info entity by task id and workfile path.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        task_id (str): Task id.
+        path (str): Rootless workfile path.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfile_info(
+        project_name=project_name,
+        task_id=task_id,
+        path=path,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
+def get_workfile_info_by_id(
+    project_name: str,
+    workfile_id: str,
+    fields: Optional[Iterable[str]] = None,
+    own_attributes=_PLACEHOLDER,
+) -> Optional[WorkfileInfoDict]:
+    """DEPRECATED Workfile info entity by id.
+
+    Args:
+        project_name (str): Project under which the entity is located.
+        workfile_id (str): Workfile info id.
+        fields (Optional[Iterable[str]]): Fields to be queried for
+            representation. All possible fields are returned if 'None' is
+            passed.
+        own_attributes (Optional[bool]): DEPRECATED: Not supported for
+            workfiles.
+
+    Returns:
+        Optional[WorkfileInfoDict]: Workfile info entity or None.
+
+    """
+    con = get_server_api_connection()
+    return con.get_workfile_info_by_id(
+        project_name=project_name,
+        workfile_id=workfile_id,
+        fields=fields,
+        own_attributes=own_attributes,
+    )
+
+
 def update_workfile_info(
     project_name: str,
     workfile_id: str,
@@ -6229,7 +6509,7 @@ def update_workfile_info(
     created_by: Optional[str] = None,
     updated_by: Optional[str] = None,
 ) -> None:
-    """Update workfile entity on server.
+    """DEPRECATED Update workfile entity on server.
 
     Update of ``attrib`` does change only passed attributes. If you want
         to unset value, use ``None``.
@@ -6266,6 +6546,24 @@ def update_workfile_info(
     )
 
 
+def delete_workfile_info(
+    project_name: str,
+    workfile_id: str,
+) -> None:
+    """DEPRECATED Delete workfile entity on server.
+
+    Args:
+        project_name (str): Project name.
+        workfile_id (str): Workfile id to delete.
+
+    """
+    con = get_server_api_connection()
+    return con.delete_workfile_info(
+        project_name=project_name,
+        workfile_id=workfile_id,
+    )
+
+
 def get_full_link_type_name(
     link_type_name: str,
     input_type: str,

{ayon-python-api-1.2.1 → ayon_python_api-1.2.3}/ayon_api/_api_helpers/base.py

@@ -109,6 +109,11 @@ class BaseServerAPI:
     ) -> Optional[ProjectDict]:
         raise NotImplementedError()
 
+    def get_user(
+        self, username: Optional[str] = None
+    ) -> Optional[dict[str, Any]]:
+        raise NotImplementedError()
+
     def _prepare_fields(
         self,
         entity_type: str,