Merge pull request #1993 from kili-technology/merge/lts-to-main

chore: merge lts to main

Author: baptiste-olivier

src/kili/domain_api/assets.py

@@ -239,7 +239,7 @@ def _prepare_video_processing_parameters(
     return transformed
 
 
-class AssetsNamespace(DomainNamespace):
+class AssetsNamespace(DomainNamespace):  # pylint: disable=too-many-public-methods
     """Assets domain namespace providing asset-related operations.
 
     This namespace provides access to all asset-related functionality
@@ -264,6 +264,8 @@ class AssetsNamespace(DomainNamespace):
     - move_to_next_step(): Move assets to the next workflow step
     - assign(): Assign assets to labelers
     - update_priority(): Update asset priorities
+    - skip(): Skip an asset
+    - unskip(): Unskip an asset
 
     Examples:
         >>> kili = Kili()
@@ -1808,6 +1810,64 @@ def set_metadata(
             external_ids=external_ids,
         )
 
+    @typechecked
+    def skip(
+        self,
+        *,
+        asset_id: str,
+        project_id: str,
+        reason: str,
+    ) -> str:
+        """Skip an asset.
+
+        Args:
+            asset_id: ID of the asset you want to skip.
+            project_id: The project ID.
+            reason: The reason why you skip an asset.
+
+        Returns:
+            The asset ID of the asset skipped. An error message if mutation failed.
+
+        Examples:
+            >>> kili.assets.skip(
+                project_id="ckg22d81r0jrg0885unmuswj8",
+                asset_id="ckg22d81s0jrh0885pdxfd03n",
+                reason="Test"
+                )
+        """
+        return self._client.skip_or_unskip(
+            action="skip",
+            asset_id=asset_id,
+            project_id=project_id,
+            reason=reason,
+        )
+
+    @typechecked
+    def unskip(
+        self,
+        *,
+        asset_id: str,
+        project_id: str,
+    ) -> str:
+        """Unskip an asset.
+
+        Args:
+            asset_id: ID of the asset you want to unskip.
+            project_id: The project ID.
+
+        Returns:
+            The asset ID of the asset unskipped. An error message if mutation failed.
+
+        Examples:
+            >>> kili.assets.unskip(
+                asset_id="ckg22d81s0jrh0885pdxfd03n"
+                project_id="ckg22d81r0jrg0885unmuswj8"
+            )
+        """
+        return self._client.skip_or_unskip(
+            action="unskip", asset_id=asset_id, project_id=project_id
+        )
+
     @overload
     def invalidate(
         self,

src/kili/entrypoints/mutations/asset/__init__.py

@@ -21,6 +21,8 @@
     GQL_ASSIGN_ASSETS,
     GQL_DELETE_MANY_FROM_DATASET,
     GQL_SEND_BACK_ASSETS_TO_QUEUE,
+    GQL_SKIP_ASSET,
+    GQL_UNSKIP_ASSET,
     GQL_UPDATE_PROPERTIES_IN_ASSETS,
 )
 from kili.entrypoints.mutations.exceptions import MutationError
@@ -860,3 +862,39 @@ def verify_last_batch(last_batch: dict, results: list) -> None:
             )
             result["asset_ids"] = [asset["id"] for asset in assets_in_queue]
         return result
+
+    def skip_or_unskip(
+        self,
+        action: Literal["skip", "unskip"],
+        asset_id: str,
+        project_id: str,
+        reason: Optional[str] = None,
+    ) -> str:
+        """Skip or unskip an asset.
+
+        Args:
+            action: The action you want to do. Either skip or unskip.
+            asset_id: ID of the asset you want to skip or unskip.
+            project_id: The project ID.
+            reason: The reason why you skip an asset. Only required if the action is `skip`.
+
+        Returns:
+            The asset ID of the asset modified. An error message if mutation failed.
+
+        Examples:
+            >>> kili.skip_or_unskip(
+            action="skip",
+            asset_id="ckg22d81s0jrh0885pdxfd03n",
+            project_id="ckg22d81r0jrg0885unmuswj8",
+            reason="Test"
+            )
+        """
+        if action == "skip":
+            if reason is None:
+                raise MissingArgumentError("You must provide a reason to skip an asset")
+            payload = {"reason": reason, "where": {"id": asset_id, "project": {"id": project_id}}}
+            self.graphql_client.execute(GQL_SKIP_ASSET, payload)
+        else:
+            payload = {"projectId": project_id, "assetId": asset_id}
+            self.graphql_client.execute(GQL_UNSKIP_ASSET, payload)
+        return asset_id

src/kili/entrypoints/mutations/asset/queries.py

@@ -53,3 +53,17 @@
   }}
 }}
 """
+
+GQL_SKIP_ASSET = """
+mutation SkipAsset($reason: String!, $where: AssetWhere!) {
+  skipAsset(reason: $reason, where: $where) {
+    id
+  }
+}
+"""
+
+GQL_UNSKIP_ASSET = """
+mutation UnskipAsset($projectId: ID!, $assetId: ID!) {
+  unskipAsset(projectId: $projectId, assetId: $assetId)
+}
+"""

tests/unit/domain_api/test_assets.py

@@ -28,6 +28,7 @@ def mock_client(self):
         client.change_asset_external_ids = MagicMock()
         client.add_metadata = MagicMock()
         client.set_metadata = MagicMock()
+        client.skip_or_unskip = MagicMock()
         return client
 
     @pytest.fixture()