rename 'BackgroundOperation' to 'BackgroundOperationTask'

Author: iLLiCiTiT

ayon_api/_api.py

@@ -48,7 +48,7 @@
         ActivityReferenceType,
         EntityListEntityType,
         EntityListItemMode,
-        BackgroundOperation,
+        BackgroundOperationTask,
         LinkDirection,
         EventFilter,
         EventStatus,
@@ -1261,7 +1261,7 @@ def send_background_batch_operations(
     can_fail: bool = False,
     wait: bool = False,
     raise_on_fail: bool = True,
-) -> BackgroundOperation:
+) -> BackgroundOperationTask:
     """Post multiple CRUD operations to server.
 
     When multiple changes should be made on server side this is the best
@@ -1294,7 +1294,7 @@ def send_background_batch_operations(
             or 'raise_on_fail' is enabled and any operation fails.
 
     Returns:
-        BackgroundOperation: Background operation.
+        BackgroundOperationTask: Background operation.
 
     """
     con = get_server_api_connection()
@@ -1310,15 +1310,15 @@ def send_background_batch_operations(
 def get_background_operations_status(
     project_name: str,
     task_id: str,
-) -> BackgroundOperation:
+) -> BackgroundOperationTask:
     """Get status of background operations task.
 
     Args:
         project_name (str): Project name.
         task_id (str): Backgorund operation task id.
 
     Returns:
-        BackgroundOperation: Background operation.
+        BackgroundOperationTask: Background operation.
 
     """
     con = get_server_api_connection()

ayon_api/server_api.py

@@ -91,7 +91,7 @@
         ServerVersion,
         AnyEntityDict,
         StreamType,
-        BackgroundOperation,
+        BackgroundOperationTask,
     )
 
 VERSION_REGEX = re.compile(
@@ -1913,7 +1913,7 @@ def send_background_batch_operations(
         can_fail: bool = False,
         wait: bool = False,
         raise_on_fail: bool = True,
-    ) -> BackgroundOperation:
+    ) -> BackgroundOperationTask:
         """Post multiple CRUD operations to server.
 
         When multiple changes should be made on server side this is the best
@@ -1946,7 +1946,7 @@ def send_background_batch_operations(
                 or 'raise_on_fail' is enabled and any operation fails.
 
         Returns:
-            BackgroundOperation: Background operation.
+            BackgroundOperationTask: Background operation.
 
         """
         operations_body = self._prepare_operations_body(operations)
@@ -1977,15 +1977,15 @@ def send_background_batch_operations(
 
     def get_background_operations_status(
         self, project_name: str, task_id: str
-    ) -> BackgroundOperation:
+    ) -> BackgroundOperationTask:
         """Get status of background operations task.
 
         Args:
             project_name (str): Project name.
             task_id (str): Backgorund operation task id.
 
         Returns:
-            BackgroundOperation: Background operation.
+            BackgroundOperationTask: Background operation.
 
         """
         response = self.get(

ayon_api/typing.py

@@ -89,7 +89,7 @@ class EventFilter(TypedDict):
     operator: Literal["and", "or"]
 
 
-class BackgroundOperation(TypedDict):
+class BackgroundOperationTask(TypedDict):
     id: str
     status: Literal["pending", "in_progress", "completed"]
     result: Optional[dict[str, Any]]