Merge pull request #1982 from kili-technology/feature/lab-4021-aau-i-can-activatedeactivate-the-consensus-on-an-asset

feat(lab-4021): add method to activate and deactivate consensus on asset

Author: florianlega

src/kili/adapters/kili_api_gateway/asset/operations_mixin.py

@@ -25,6 +25,7 @@
 )
 from kili.adapters.kili_api_gateway.label.common import get_annotation_fragment
 from kili.adapters.kili_api_gateway.project.common import get_project
+from kili.core.graphql.operations.asset.mutations import GQL_SET_ASSET_CONSENSUS
 from kili.domain.asset import AssetFilters
 from kili.domain.types import ListOrTuple
 
@@ -166,3 +167,26 @@ def count_assets_annotations(self, filters: AssetFilters) -> int:
         count_result = self.graphql_client.execute(GQL_COUNT_ASSET_ANNOTATIONS, payload)
         count: int = count_result["data"]
         return count
+
+    def update_asset_consensus(
+        self,
+        project_id: str,
+        is_consensus: bool,
+        asset_id: str | None = None,
+        external_id: str | None = None,
+    ) -> bool:
+        """Update consensus on an asset."""
+        if asset_id is None and external_id is None:
+            raise ValueError("At least one of asset_id or external_id must be provided")
+
+        payload = {
+            "projectId": project_id,
+            "isConsensus": is_consensus,
+        }
+        if asset_id is not None:
+            payload["assetId"] = asset_id
+        if external_id is not None:
+            payload["externalId"] = external_id
+
+        result = self.graphql_client.execute(GQL_SET_ASSET_CONSENSUS, payload)
+        return result["data"]

src/kili/core/graphql/operations/asset/mutations.py

@@ -27,3 +27,19 @@
   }
 }
 """
+
+GQL_SET_ASSET_CONSENSUS = """
+mutation setAssetConsensus(
+    $assetId: ID,
+    $externalId: String,
+    $projectId: ID!,
+    $isConsensus: Boolean!
+  ) {
+  data: setAssetConsensus(
+    assetId: $assetId,
+    externalId: $externalId,
+    projectId: $projectId,
+    isConsensus: $isConsensus
+  )
+}
+"""

src/kili/domain_api/assets.py

@@ -1,5 +1,5 @@
 """Assets domain namespace for the Kili Python SDK."""
-# pylint: disable=too-many-lines
+# pylint: disable=too-many-lines,too-many-public-methods
 
 import warnings
 from collections.abc import Generator
@@ -266,6 +266,7 @@ class AssetsNamespace(DomainNamespace):  # pylint: disable=too-many-public-metho
     - update_priority(): Update asset priorities
     - skip(): Skip an asset
     - unskip(): Unskip an asset
+    - add_consensus(): Activate or deactivate consensus on an asset
 
     Examples:
         >>> kili = Kili()
@@ -2233,3 +2234,78 @@ def update_priority(
             priorities=priorities if priorities is not None else [],
             **kwargs,
         )
+
+    @overload
+    def update_consensus(
+        self,
+        *,
+        asset_id: str,
+        project_id: str,
+        is_consensus: bool,
+    ) -> bool:
+        ...
+
+    @overload
+    def update_consensus(
+        self,
+        *,
+        external_id: str,
+        project_id: str,
+        is_consensus: bool,
+    ) -> bool:
+        ...
+
+    @typechecked
+    def update_consensus(
+        self,
+        *,
+        project_id: str,
+        is_consensus: bool,
+        asset_id: Optional[str] = None,
+        external_id: Optional[str] = None,
+    ) -> bool:
+        """Activate or deactivate consensus on an asset.
+
+        Args:
+            project_id: The project ID.
+            is_consensus: Whether to activate (True) or deactivate (False) consensus on the asset.
+            asset_id: The internal asset ID to modify. Either asset_id or external_id must be provided.
+            external_id: The external ID of the asset to modify. Either asset_id or external_id must be provided.
+
+        Returns:
+            The consensus value that was set (True if consensus was activated, False if deactivated).
+
+        Raises:
+            ValueError: If neither asset_id nor external_id is provided.
+
+        Examples:
+            >>> # Activate consensus on an asset using asset_id
+            >>> result = kili.assets.update_consensus(
+            ...     project_id="my_project",
+            ...     is_consensus=True,
+            ...     asset_id="ckg22d81r0jrg0885unmuswj8"
+            ... )
+            >>> # result is True
+
+            >>> # Activate consensus on an asset using external_id
+            >>> result = kili.assets.update_consensus(
+            ...     project_id="my_project",
+            ...     is_consensus=True,
+            ...     external_id="my_asset_001"
+            ... )
+            >>> # result is True
+
+            >>> # Deactivate consensus on an asset
+            >>> result = kili.assets.update_consensus(
+            ...     project_id="my_project",
+            ...     is_consensus=False,
+            ...     asset_id="ckg22d81r0jrg0885unmuswj8"
+            ... )
+            >>> # result is False
+        """
+        return self._client.update_asset_consensus(
+            project_id=project_id,
+            is_consensus=is_consensus,
+            asset_id=asset_id,
+            external_id=external_id,
+        )

src/kili/domain_api/exports.py

@@ -1,4 +1,5 @@
 """Tags domain namespace for the Kili Python SDK."""
+# pylint: disable=too-many-public-methods
 
 from typing import TYPE_CHECKING, Any, Optional, TypedDict, Union
 

src/kili/domain_api/issues.py

@@ -3,6 +3,7 @@
 This module provides a comprehensive interface for issue-related operations
 including creation, querying, status management, and lifecycle operations.
 """
+# pylint: disable=too-many-public-methods
 
 from collections.abc import Generator
 from itertools import repeat

src/kili/domain_api/labels.py

@@ -1,4 +1,4 @@
-# pylint: disable=too-many-lines
+# pylint: disable=too-many-lines,too-many-public-methods
 """Labels domain namespace for the Kili Python SDK.
 
 This module provides a comprehensive interface for label-related operations

src/kili/domain_api/organizations.py

@@ -1,4 +1,5 @@
 """Organizations domain namespace for the Kili Python SDK."""
+# pylint: disable=too-many-public-methods
 
 from collections.abc import Generator
 from datetime import datetime

src/kili/domain_api/plugins.py

@@ -1,4 +1,5 @@
 """Plugins domain namespace for the Kili Python SDK."""
+# pylint: disable=too-many-public-methods
 
 from datetime import datetime
 from typing import List, Optional

src/kili/domain_api/projects.py

@@ -3,6 +3,7 @@
 This module provides a comprehensive interface for project-related operations
 including lifecycle management, user management, workflow configuration, and versioning.
 """
+# pylint: disable=too-many-public-methods
 
 from collections.abc import Generator, Iterable, Sequence
 from functools import cached_property

src/kili/domain_api/questions.py

@@ -3,6 +3,7 @@
 This module provides a comprehensive interface for question-related operations
 including creation, querying, status management, and lifecycle operations.
 """
+# pylint: disable=too-many-public-methods
 
 from collections.abc import Generator
 from itertools import repeat