Merge branch 'develop' into pno/PLT-2447-update_connect_ontology

Author: paulnoirel

.github/workflows/python-package-develop.yml

@@ -61,19 +61,15 @@ jobs:
           - python-version: "3.9"
             api-key: STAGING_LABELBOX_API_KEY_3
             da-test-key: DA_GCP_LABELBOX_API_KEY
-            sdk-version: ${{ fromJson(needs.get_sdk_versions.outputs.sdk_versions)[3] }}
           - python-version: "3.10"
             api-key: STAGING_LABELBOX_API_KEY_4
             da-test-key: DA_GCP_LABELBOX_API_KEY
-            sdk-version: ${{ fromJson(needs.get_sdk_versions.outputs.sdk_versions)[2] }}
           - python-version: "3.11"
             api-key: STAGING_LABELBOX_API_KEY
             da-test-key: DA_GCP_LABELBOX_API_KEY
-            sdk-version: ${{ fromJson(needs.get_sdk_versions.outputs.sdk_versions)[1] }}
           - python-version: "3.12"
             api-key: STAGING_LABELBOX_API_KEY_5
-            da-test-key: DA_GCP_LABELBOX_API_KEY
-            sdk-version: ${{ fromJson(needs.get_sdk_versions.outputs.sdk_versions)[0] }}            
+            da-test-key: DA_GCP_LABELBOX_API_KEY       
           - python-version: "3.13"
             api-key: STAGING_LABELBOX_API_KEY_2
             da-test-key: DA_GCP_LABELBOX_API_KEY

docs/conf.py

@@ -16,7 +16,7 @@
 project = 'Python SDK reference'
 copyright = '2025, Labelbox'
 author = 'Labelbox'
-release = '6.8.0'
+release = '6.10.0'
 
 # -- General configuration ---------------------------------------------------
 

libs/labelbox/CHANGELOG.md

@@ -1,15 +1,27 @@
 # Changelog
-Version 6.8.0 (2025-02-20)
-### Added Support for Source Ontology Names in Relationships
+# Version 6.10.0 (2025-04-04)
+## Added
+* API keys Management: ([#1961](https://github.com/Labelbox/labelbox-python/pull/1961))
+* Get invitations: ([#1962](https://github.com/Labelbox/labelbox-python/pull/1962))
+* Add tasks to organization and TaskStatus to filter tasks: ([#1958](https://github.com/Labelbox/labelbox-python/pull/1958))
+
+
+# Version 6.9.0 (2025-03-17)
+## Added 
+* Provide support to cancel tasks ([#1957](https://github.com/Labelbox/labelbox-python/pull/1957))
+* Added support for AUDIO attachment type ([#1956](https://github.com/Labelbox/labelbox-python/pull/1956))
+
+# Version 6.8.0 (2025-02-20)
+## Added Support for Source Ontology Names in Relationships
 
 Added the ability to specify relationships using `source_ontology_name` instead of a concrete source annotation. This enhancement is particularly useful for PDF document annotations where you can create relationships referencing ontology classes directly.
 
 Key changes:
 - Added optional `source_ontology_name` field to `Relationship` class
 - Made `source` field optional
 - Added validation to ensure either `source` or `source_ontology_name` is provided, but not both
-### Added search by name for `get_catalog_slice`
-### Added `get_catalog_slices` to get all slices
+## Added search by name for `get_catalog_slice`
+## Added `get_catalog_slices` to get all slices
 
 # Version 6.7.0 (2025-02-06)
 ## Added

libs/labelbox/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "labelbox"
-version = "6.8.0"
+version = "6.10.0"
 description = "Labelbox Python API"
 authors = [{ name = "Labelbox", email = "engineering@labelbox.com" }]
 dependencies = [
@@ -11,7 +11,6 @@ dependencies = [
     "strenum>=0.4.15",
     "tqdm>=4.66.2",
     "geojson>=3.1.0",
-    "mypy==1.10.1",
     "lbox-clients==1.1.2",
 ]
 readme = "README.md"

libs/labelbox/src/labelbox/__init__.py

@@ -1,6 +1,6 @@
 name = "labelbox"
 
-__version__ = "6.8.0"
+__version__ = "6.10.0"
 
 from labelbox.client import Client
 from labelbox.schema.annotation_import import (
@@ -98,3 +98,6 @@
     PromptResponseClassification,
 )
 from lbox.exceptions import *
+from labelbox.schema.taskstatus import TaskStatus
+from labelbox.schema.api_key import ApiKey
+from labelbox.schema.timeunit import TimeUnit

libs/labelbox/src/labelbox/client.py

@@ -79,6 +79,9 @@
 from labelbox.schema.slice import CatalogSlice, ModelSlice
 from labelbox.schema.task import DataUpsertTask, Task
 from labelbox.schema.user import User
+from labelbox.schema.taskstatus import TaskStatus
+from labelbox.schema.api_key import ApiKey
+from labelbox.schema.timeunit import TimeUnit
 
 logger = logging.getLogger(__name__)
 
@@ -90,6 +93,9 @@ class Client:
     top-level data objects (Projects, Datasets).
     """
 
+    # Class variable to cache task types
+    _cancelable_task_types = None
+
     def __init__(
         self,
         api_key=None,
@@ -2389,3 +2395,124 @@ def get_task_by_id(self, task_id: str) -> Union[Task, DataUpsertTask]:
 
         task._user = user
         return task
+
+    def _get_cancelable_task_types(self):
+        """Internal method that returns a list of task types that can be canceled.
+
+        The result is cached after the first call to avoid unnecessary API requests.
+
+        Returns:
+            List[str]: List of cancelable task types in snake_case format
+        """
+        if self._cancelable_task_types is None:
+            query = """query GetCancelableTaskTypesPyApi {
+                cancelableTaskTypes
+            }"""
+
+            result = self.execute(query).get("cancelableTaskTypes", [])
+            # Reformat to kebab case
+            self._cancelable_task_types = [
+                utils.snake_case(task_type).replace("_", "-")
+                for task_type in result
+            ]
+
+        return self._cancelable_task_types
+
+    def cancel_task(self, task_id: str) -> bool:
+        """
+        Cancels a task with the given ID if the task type is cancelable and the task is in progress.
+
+        Args:
+            task_id (str): The ID of the task to cancel.
+
+        Returns:
+            bool: True if the task was successfully cancelled.
+
+        Raises:
+            LabelboxError: If the task could not be cancelled, if the task type is not cancelable,
+                or if the task is not in progress.
+            ResourceNotFoundError: If the task does not exist (raised by get_task_by_id).
+        """
+        # Get the task object to check its type and status
+        task = self.get_task_by_id(task_id)
+
+        # Check if task type is cancelable
+        cancelable_types = self._get_cancelable_task_types()
+        if task.type not in cancelable_types:
+            raise LabelboxError(
+                f"Task type '{task.type}' cannot be cancelled. Cancelable types are: {cancelable_types}"
+            )
+
+        # Check if task is in progress
+        if task.status_as_enum != TaskStatus.In_Progress:
+            raise LabelboxError(
+                f"Task cannot be cancelled because it is not in progress. Current status: {task.status}"
+            )
+
+        mutation_str = """
+        mutation CancelTaskPyApi($id: ID!) {
+            cancelBulkOperationJob(id: $id) {
+                success
+            }
+        }
+        """
+        res = self.execute(mutation_str, {"id": task_id})
+        return res["cancelBulkOperationJob"]["success"]
+
+    def create_api_key(
+        self,
+        name: str,
+        user: Union[User, str],
+        role: Union[Role, str],
+        validity: int = 0,
+        time_unit: TimeUnit = TimeUnit.SECOND,
+        refresh_cache: bool = False,
+    ) -> Dict[str, str]:
+        """Creates a new API key.
+
+        Args:
+            name (str): The name of the API key.
+            user (Union[User, str]): The user object or user ID to associate with the API key.
+            role (Union[Role, str]): The role object or role ID to assign to the API key.
+            validity (int, optional): The validity period of the API key. Defaults to 0 (no expiration).
+            time_unit (TimeUnit, optional): The time unit for the validity period. Defaults to TimeUnit.SECOND.
+            refresh_cache (bool, optional): Whether to refresh cached permissions and roles. Defaults to False.
+
+        Returns:
+            Dict[str, str]: A dictionary containing the created API key information.
+        """
+        warnings.warn(
+            "The creation of API keys is currently in alpha and its behavior may change in future releases.",
+        )
+        if refresh_cache:
+            # Clear cached attributes if they exist
+            if hasattr(self, "_cached_current_user_permissions"):
+                delattr(self, "_cached_current_user_permissions")
+            if hasattr(self, "_cached_available_api_key_roles"):
+                delattr(self, "_cached_available_api_key_roles")
+
+        return ApiKey.create_api_key(
+            self, name, user, role, validity, time_unit
+        )
+
+    def get_api_keys(self, include_expired: bool = False) -> List[ApiKey]:
+        """Retrieves all API keys accessible to the current user.
+
+        Args:
+            include_revoked (bool, optional): Whether to include revoked API keys. Defaults to True.
+
+        Returns:
+            List[ApiKey]: A list of ApiKey objects.
+        """
+        return ApiKey.get_api_keys(self, include_expired)
+
+    def get_api_key(self, api_key_id: str) -> Optional[ApiKey]:
+        """Retrieves a single API key by its ID.
+
+        Args:
+            api_key_id (str): The unique ID of the API key.
+
+        Returns:
+            Optional[ApiKey]: The corresponding ApiKey object if found, otherwise None.
+        """
+        return ApiKey.get_api_key(self, api_key_id)

libs/labelbox/src/labelbox/orm/model.py

@@ -29,9 +29,6 @@ class Field:
     These `Comparison` objects can then be used for filtering:
         >>> project = client.get_projects(comparison)
 
-    Also exposes the ordering property used for sorting:
-        >>> labels = project.labels(order_by=Label.label.asc)
-
     Attributes:
         field_type (Field.Type): The type of the field.
         name (str): name that the attribute has in client-side Python objects

libs/labelbox/src/labelbox/schema/__init__.py

@@ -26,3 +26,6 @@
 import labelbox.schema.catalog
 import labelbox.schema.ontology_kind
 import labelbox.schema.project_overview
+import labelbox.schema.taskstatus
+import labelbox.schema.api_key
+import labelbox.schema.timeunit