cognite-toolkit 0.7.54__py3-none-any.whl → 0.7.56__py3-none-any.whl

cognite_toolkit/_cdf_tk/client/http_client/_data_classes2.py

@@ -1,23 +1,17 @@
 import gzip
 from abc import ABC, abstractmethod
-from collections.abc import Hashable
 from typing import Any, Literal
 
 import httpx
 from cognite.client import global_config
-from pydantic import BaseModel, JsonValue, TypeAdapter, model_validator
-
-from cognite_toolkit._cdf_tk.client.http_client._data_classes import (
-    ErrorDetails,
-    FailedRequestItems,
-    FailedRequestMessage,
-    FailedResponseItems,
-    ResponseMessage,
-    SuccessResponseItems,
-)
+from pydantic import TYPE_CHECKING, BaseModel, JsonValue, TypeAdapter, model_validator
+
 from cognite_toolkit._cdf_tk.client.http_client._exception import ToolkitAPIError
 from cognite_toolkit._cdf_tk.utils.useful_types import PrimitiveType
 
+if TYPE_CHECKING:
+    from cognite_toolkit._cdf_tk.client.http_client._item_classes import ItemsResultMessage2
+
 
 class HTTPResult2(BaseModel):
     def get_success_or_raise(self) -> "SuccessResponse2":
@@ -35,18 +29,24 @@ class HTTPResult2(BaseModel):
         else:
             raise ToolkitAPIError("Unknown HTTPResult2 type")
 
-    # Todo: Remove when HTTPResult2 is renamed to HTTPResponse and the old HTTPResponse is deleted
-    def as_item_response(self, item_id: Hashable) -> ResponseMessage | FailedRequestMessage:
+    def as_item_response(self, item_id: str) -> "ItemsResultMessage2":
+        # Avoid circular import
+        from cognite_toolkit._cdf_tk.client.http_client._item_classes import (
+            ItemsFailedRequest2,
+            ItemsFailedResponse2,
+            ItemsSuccessResponse2,
+        )
+
         if isinstance(self, SuccessResponse2):
-            return SuccessResponseItems(
+            return ItemsSuccessResponse2(
                 status_code=self.status_code, content=self.content, ids=[item_id], body=self.body
             )
         elif isinstance(self, FailedResponse2):
-            return FailedResponseItems(
+            return ItemsFailedResponse2(
                 status_code=self.status_code,
                 ids=[item_id],
                 body=self.body,
-                error=ErrorDetails(
+                error=ErrorDetails2(
                     code=self.error.code,
                     message=self.error.message,
                     missing=self.error.missing,
@@ -54,9 +54,9 @@ class HTTPResult2(BaseModel):
                 ),
             )
         elif isinstance(self, FailedRequest2):
-            return FailedRequestItems(ids=[item_id], error=self.error)
+            return ItemsFailedRequest2(ids=[item_id], error_message=self.error)
         else:
-            raise ToolkitAPIError("Unknown HTTPResult2 type")
+            raise ToolkitAPIError(f"Unknown {type(self).__name__} type")
 
 
 class FailedRequest2(HTTPResult2):

cognite_toolkit/_cdf_tk/client/resource_classes/filemetadata.py

@@ -1,4 +1,4 @@
-from typing import ClassVar, Literal
+from typing import Any, ClassVar, Literal
 
 from pydantic import Field, JsonValue
 
@@ -37,6 +37,12 @@ class FileMetadataRequest(FileMetadata, UpdatableRequestResource):
     # from response to request.
     instance_id: NodeReference | None = Field(default=None, exclude=True)
 
+    def as_update(self, mode: Literal["patch", "replace"]) -> dict[str, Any]:
+        update = super().as_update(mode)
+        # Name cannot be updated.
+        update["update"].pop("name", None)
+        return update
+
 
 class FileMetadataResponse(FileMetadata, ResponseResource[FileMetadataRequest]):
     created_time: int

cognite_toolkit/_cdf_tk/commands/_migrate/command.py

@@ -9,10 +9,10 @@ from rich.table import Table
 
 from cognite_toolkit._cdf_tk.client import ToolkitClient
 from cognite_toolkit._cdf_tk.client.http_client import (
-    FailedRequestItems,
-    FailedResponseItems,
     HTTPClient,
-    SuccessResponseItems,
+    ItemsFailedRequest2,
+    ItemsFailedResponse2,
+    ItemsSuccessResponse2,
 )
 from cognite_toolkit._cdf_tk.commands._base import ToolkitCommand
 from cognite_toolkit._cdf_tk.commands._migrate.creators import MigrationCreator
@@ -187,20 +187,20 @@ class MigrationCommand(ToolkitCommand):
             # Todo: Move logging into the UploadableStorageIO class
             issues: list[WriteIssue] = []
             for item in responses:
-                if isinstance(item, SuccessResponseItems):
+                if isinstance(item, ItemsSuccessResponse2):
                     target.logger.tracker.finalize_item(item.ids, "success")
                     continue
-                if isinstance(item, FailedResponseItems):
+                if isinstance(item, ItemsFailedResponse2):
                     error = item.error
                     for id_ in item.ids:
                         issue = WriteIssue(id=str(id_), status_code=error.code, message=error.message)
                         issues.append(issue)
-                elif isinstance(item, FailedRequestItems):
+                elif isinstance(item, ItemsFailedRequest2):
                     for id_ in item.ids:
-                        issue = WriteIssue(id=str(id_), status_code=0, message=item.error)
+                        issue = WriteIssue(id=str(id_), status_code=0, message=item.error_message)
                         issues.append(issue)
 
-                if isinstance(item, FailedResponseItems | FailedRequestItems):
+                if isinstance(item, ItemsFailedResponse2 | ItemsFailedRequest2):
                     target.logger.tracker.finalize_item(item.ids, "failure")
             if issues:
                 target.logger.log(issues)

cognite_toolkit/_cdf_tk/commands/_migrate/migration_io.py

@@ -6,14 +6,16 @@ from cognite.client.data_classes.data_modeling import EdgeId, InstanceApply, Nod
 
 from cognite_toolkit._cdf_tk.client import ToolkitClient
 from cognite_toolkit._cdf_tk.client.http_client import (
-    FailedResponse,
     HTTPClient,
-    HTTPMessage,
-    ItemsRequest,
     RequestMessage2,
-    SuccessResponseItems,
     ToolkitAPIError,
 )
+from cognite_toolkit._cdf_tk.client.http_client._item_classes import (
+    ItemsFailedResponse2,
+    ItemsRequest2,
+    ItemsResultList,
+    ItemsSuccessResponse2,
+)
 from cognite_toolkit._cdf_tk.client.resource_classes.legacy.pending_instances_ids import PendingInstanceId
 from cognite_toolkit._cdf_tk.client.resource_classes.three_d import (
     AssetMappingClassicResponse,
@@ -170,20 +172,20 @@ class AssetCentricMigrationIO(
         data_chunk: Sequence[UploadItem[InstanceApply]],
         http_client: HTTPClient,
         selector: AssetCentricMigrationSelector | None = None,
-    ) -> Sequence[HTTPMessage]:
+    ) -> ItemsResultList:
         """Upload items by first linking them using files/set-pending-instance-ids and then uploading the instances."""
         if self.skip_linking:
-            return list(super().upload_items(data_chunk, http_client, None))
+            return super().upload_items(data_chunk, http_client, None)
         elif selector is None:
             raise ToolkitNotImplementedError(f"Selector must be provided for uploading {self.KIND} items.")
         elif selector.kind not in self.PENDING_INSTANCE_ID_ENDPOINT_BY_KIND:
-            return list(super().upload_items(data_chunk, http_client, None))
+            return super().upload_items(data_chunk, http_client, None)
 
         pending_instance_id_endpoint = self.PENDING_INSTANCE_ID_ENDPOINT_BY_KIND[selector.kind]
-        results: list[HTTPMessage] = []
+        results = ItemsResultList()
         to_upload = self.link_asset_centric(data_chunk, http_client, pending_instance_id_endpoint)
         if to_upload:
-            results.extend(list(super().upload_items(to_upload, http_client, None)))
+            results.extend(super().upload_items(to_upload, http_client, None))
         return results
 
     @classmethod
@@ -197,8 +199,8 @@ class AssetCentricMigrationIO(
         config = http_client.config
         successful_linked: set[str] = set()
         for batch in chunker_sequence(data_chunk, cls.CHUNK_SIZE):
-            batch_results = http_client.request_with_retries(
-                message=ItemsRequest(
+            batch_results = http_client.request_items_retries(
+                message=ItemsRequest2(
                     endpoint_url=config.create_api_url(pending_instance_id_endpoint),
                     method="POST",
                     api_version="alpha",
@@ -209,7 +211,7 @@ class AssetCentricMigrationIO(
                 )
             )
             for res in batch_results:
-                if isinstance(res, SuccessResponseItems):
+                if isinstance(res, ItemsSuccessResponse2):
                     successful_linked.update(res.ids)
         to_upload = [item for item in data_chunk if item.source_id in successful_linked]
         return to_upload
@@ -441,26 +443,26 @@ class ThreeDMigrationIO(UploadableStorageIO[ThreeDSelector, ThreeDModelResponse,
         data_chunk: Sequence[UploadItem[ThreeDMigrationRequest]],
         http_client: HTTPClient,
         selector: ThreeDSelector | None = None,
-    ) -> Sequence[HTTPMessage]:
+    ) -> ItemsResultList:
         """Migrate 3D models by uploading them to the migrate/models endpoint."""
         if len(data_chunk) > self.CHUNK_SIZE:
             raise RuntimeError(f"Uploading more than {self.CHUNK_SIZE} 3D models at a time is not supported.")
 
-        results: list[HTTPMessage] = []
-        responses = http_client.request_with_retries(
-            message=ItemsRequest(
+        results = ItemsResultList()
+        responses = http_client.request_items_retries(
+            message=ItemsRequest2(
                 endpoint_url=self.client.config.create_api_url(self.UPLOAD_ENDPOINT),
                 method="POST",
-                items=list(data_chunk),
+                items=data_chunk,
             )
         )
         if (
-            failed_response := next((res for res in responses if isinstance(res, FailedResponse)), None)
+            failed_response := next((res for res in responses if isinstance(res, ItemsFailedResponse2)), None)
         ) and failed_response.status_code == 400:
             raise ToolkitAPIError("3D model migration failed. You need to enable the 3D migration alpha feature flag.")
 
         results.extend(responses)
-        success_ids = {id for res in responses if isinstance(res, SuccessResponseItems) for id in res.ids}
+        success_ids = {id for res in responses if isinstance(res, ItemsSuccessResponse2) for id in res.ids}
         for data in data_chunk:
             if data.source_id not in success_ids:
                 continue
@@ -535,21 +537,21 @@ class ThreeDAssetMappingMigrationIO(
         data_chunk: Sequence[UploadItem[AssetMappingDMRequest]],
         http_client: HTTPClient,
         selector: T_Selector | None = None,
-    ) -> Sequence[HTTPMessage]:
+    ) -> ItemsResultList:
         """Migrate 3D asset mappings by uploading them to the migrate/asset-mappings endpoint."""
         if not data_chunk:
-            return []
+            return ItemsResultList()
         # Assume all items in the chunk belong to the same model and revision, they should
         # if the .stream_data method is used for downloading.
         first = data_chunk[0]
         model_id = first.item.model_id
         revision_id = first.item.revision_id
         endpoint = self.UPLOAD_ENDPOINT.format(modelId=model_id, revisionId=revision_id)
-        responses = http_client.request_with_retries(
-            ItemsRequest(
+        return http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self.client.config.create_api_url(endpoint),
                 method="POST",
-                items=list(data_chunk),
+                items=data_chunk,
                 extra_body_fields={
                     "dmsContextualizationConfig": {
                         "object3DSpace": self.object_3D_space,
@@ -558,7 +560,6 @@ class ThreeDAssetMappingMigrationIO(
                 },
             )
         )
-        return responses
 
     def json_to_resource(self, item_json: dict[str, JsonVal]) -> AssetMappingDMRequest:
         raise NotImplementedError("Deserializing 3D Asset Mappings from JSON is not supported.")

cognite_toolkit/_cdf_tk/commands/_profile.py

@@ -329,7 +329,7 @@ class ProfileCommand(ToolkitCommand, ABC, Generic[T_Index]):
             )
 
     def _ask_store_file(self) -> None:
-        if file_path := questionary.path("Where do you want to save the profile?").ask():
+        if file_path := questionary.path("Where do you want to save the profile?").unsafe_ask():
             self.output_spreadsheet = Path(file_path)
 
 

cognite_toolkit/_cdf_tk/commands/_purge.py

@@ -1,9 +1,9 @@
 import uuid
 from abc import ABC, abstractmethod
-from collections.abc import Callable, Hashable, Iterable, Sequence
+from collections.abc import Callable, Iterable, Sequence
 from dataclasses import dataclass
 from functools import partial
-from typing import Literal, cast
+from typing import Any, Literal, cast
 
 import questionary
 from cognite.client.data_classes import DataSetUpdate
@@ -11,17 +11,17 @@ from cognite.client.data_classes.data_modeling import Edge, NodeId
 from cognite.client.data_classes.data_modeling.statistics import SpaceStatistics
 from cognite.client.exceptions import CogniteAPIError
 from cognite.client.utils._identifier import InstanceId
+from pydantic import JsonValue
 from rich import print
 from rich.console import Console
 from rich.panel import Panel
 
 from cognite_toolkit._cdf_tk.client import ToolkitClient
+from cognite_toolkit._cdf_tk.client._resource_base import RequestItem
 from cognite_toolkit._cdf_tk.client.http_client import (
     HTTPClient,
-    ItemsRequest,
     ItemsRequest2,
     ItemsSuccessResponse2,
-    SuccessResponseItems,
 )
 from cognite_toolkit._cdf_tk.client.resource_classes.instance_api import TypedInstanceIdentifier
 from cognite_toolkit._cdf_tk.cruds import (
@@ -79,15 +79,14 @@ class DeleteResults:
     failed: int = 0
 
 
-@dataclass
-class DeleteItem:
-    item: JsonVal
-    as_id_fun: Callable[[JsonVal], Hashable]
+class DeleteItem(RequestItem):
+    item: JsonValue
+    as_id_fun: Callable[[JsonValue], str]
 
-    def dump(self) -> JsonVal:
-        return self.item
+    def dump(self, camel_case: bool = True, exclude_extra: bool = False) -> dict[str, Any]:
+        return self.item  # type: ignore[return-value]
 
-    def as_id(self) -> Hashable:
+    def __str__(self) -> str:
         return self.as_id_fun(self.item)
 
 
@@ -222,7 +221,7 @@ class PurgeCommand(ToolkitCommand):
         if not dry_run and not auto_yes:
             confirm = questionary.confirm(
                 f"Are you really sure you want to purge the {selected_space!r} space?", default=False
-            ).ask()
+            ).unsafe_ask()
             if not confirm:
                 return DeployResults([], "purge", dry_run=dry_run)
 
@@ -364,16 +363,16 @@ class PurgeCommand(ToolkitCommand):
     ) -> Callable[[list[JsonVal]], None]:
         crud = delete_item.crud
 
-        def as_id(item: JsonVal) -> Hashable:
+        def as_id(item: JsonVal) -> str:
             try:
-                return crud.get_id(item)
+                return str(crud.get_id(item))
             except KeyError:
                 # Fallback to internal ID
-                return crud.get_internal_id(item)
+                return str(crud.get_internal_id(item))
 
         def process(items: list[JsonVal]) -> None:
-            responses = delete_client.request_with_retries(
-                ItemsRequest(
+            responses = delete_client.request_items_retries(
+                ItemsRequest2(
                     endpoint_url=delete_url,
                     method="POST",
                     items=[DeleteItem(item=item, as_id_fun=as_id) for item in items],
@@ -381,10 +380,10 @@ class PurgeCommand(ToolkitCommand):
                 )
             )
             for response in responses:
-                if isinstance(response, SuccessResponseItems):
+                if isinstance(response, ItemsSuccessResponse2):
                     result.deleted += len(response.ids)
                 else:
-                    result.unchanged += len(items)
+                    result.unchanged += len(response.ids)
 
         return process
 
@@ -423,7 +422,7 @@ class PurgeCommand(ToolkitCommand):
         if not dry_run and not auto_yes:
             confirm = questionary.confirm(
                 f"Are you really sure you want to purge the {selected_data_set_external_id!r} dataSet?", default=False
-            ).ask()
+            ).unsafe_ask()
             if not confirm:
                 return DeployResults([], "purge", dry_run=dry_run)
 
@@ -595,7 +594,7 @@ class PurgeCommand(ToolkitCommand):
                 confirm = questionary.confirm(
                     f"Are you really sure you want to purge all {total:,} instances in {selector!s}?",
                     default=False,
-                ).ask()
+                ).unsafe_ask()
                 if not confirm:
                     return DeleteResults()
 

cognite_toolkit/_cdf_tk/commands/_upload.py

@@ -3,13 +3,11 @@ from collections.abc import Sequence
 from functools import partial
 from pathlib import Path
 
-from cognite.client.data_classes.data_modeling import (
-    ViewId,
-)
+from cognite.client.data_classes.data_modeling import ViewId
 from rich.console import Console
 
 from cognite_toolkit._cdf_tk.client import ToolkitClient
-from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemMessage, SuccessResponseItems
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsResultMessage2, ItemsSuccessResponse2
 from cognite_toolkit._cdf_tk.constants import DATA_MANIFEST_SUFFIX, DATA_RESOURCE_DIR
 from cognite_toolkit._cdf_tk.cruds import ViewCRUD
 from cognite_toolkit._cdf_tk.exceptions import ToolkitValueError
@@ -279,10 +277,10 @@ class UploadCommand(ToolkitCommand):
             return
         results = io.upload_items(data_chunk, upload_client, selector)
         for message in results:
-            if isinstance(message, SuccessResponseItems):
+            if isinstance(message, ItemsSuccessResponse2):
                 for id_ in message.ids:
                     tracker.set_progress(id_, step=cls._UPLOAD, status="success")
-            elif isinstance(message, ItemMessage):
+            elif isinstance(message, ItemsResultMessage2):
                 for id_ in message.ids:
                     tracker.set_progress(id_, step=cls._UPLOAD, status="failed")
             else:

cognite_toolkit/_cdf_tk/commands/auth.py

@@ -84,7 +84,7 @@ class AuthCommand(ToolkitCommand):
         ask_user = True
         if env_vars and not env_vars.get_missing_vars():
             print("Auth variables are already set.")
-            ask_user = questionary.confirm("Do you want to reconfigure the auth variables?", default=False).ask()
+            ask_user = questionary.confirm("Do you want to reconfigure the auth variables?", default=False).unsafe_ask()
 
         if ask_user or not env_vars:
             env_vars = prompt_user_environment_variables(env_vars)
@@ -111,10 +111,10 @@ class AuthCommand(ToolkitCommand):
             if questionary.confirm(
                 f"Do you want to overwrite the existing '.env' file? The existing will be renamed to {filename}",
                 default=False,
-            ).ask():
+            ).unsafe_ask():
                 shutil.move(".env", filename)
                 Path(".env").write_text(new_env_file, encoding="utf-8")
-        elif questionary.confirm("Do you want to save these to .env file for next time?", default=True).ask():
+        elif questionary.confirm("Do you want to save these to .env file for next time?", default=True).unsafe_ask():
             Path(".env").write_text(new_env_file, encoding="utf-8")
 
     def verify(
@@ -197,7 +197,7 @@ class AuthCommand(ToolkitCommand):
             if (
                 is_interactive
                 and missing_capabilities
-                and questionary.confirm("Do you want to update the group with the missing capabilities?").ask()
+                and questionary.confirm("Do you want to update the group with the missing capabilities?").unsafe_ask()
             ) or is_demo:
                 has_added_capabilities = self._update_missing_capabilities(
                     client, cdf_toolkit_group, missing_capabilities, dry_run
@@ -213,7 +213,7 @@ class AuthCommand(ToolkitCommand):
             if (
                 is_interactive
                 and missing_capabilities
-                and questionary.confirm("Do you want to update the group with the missing capabilities?").ask()
+                and questionary.confirm("Do you want to update the group with the missing capabilities?").unsafe_ask()
             ):
                 self._update_missing_capabilities(client, cdf_toolkit_group, missing_capabilities, dry_run)
         elif is_demo:
@@ -246,7 +246,7 @@ class AuthCommand(ToolkitCommand):
             if extra := self.check_duplicated_names(all_groups, cdf_toolkit_group):
                 if (
                     is_interactive
-                    and questionary.confirm("Do you want to delete the extra groups?", default=True).ask()
+                    and questionary.confirm("Do you want to delete the extra groups?", default=True).unsafe_ask()
                 ):
                     try:
                         client.iam.groups.delete(extra.as_ids())
@@ -274,7 +274,7 @@ class AuthCommand(ToolkitCommand):
         if not questionary.confirm(
             "Do you want to create it?",
             default=True,
-        ).ask():
+        ).unsafe_ask():
             return None
 
         if dry_run:
@@ -283,13 +283,10 @@ class AuthCommand(ToolkitCommand):
             )
             return None
 
-        while True:
-            source_id = questionary.text(
-                "What is the source id for the new group (typically a group id in the identity provider)?"
-            ).ask()
-            if source_id:
-                break
-            print("Source id cannot be empty.")
+        source_id = questionary.text(
+            "What is the source id for the new group (typically a group id in the identity provider)?",
+            validate=lambda value: value.strip() != "",
+        ).unsafe_ask()
 
         toolkit_group.source_id = source_id
         if already_used := [group.name for group in all_groups if group.source_id == source_id]:
@@ -298,7 +295,7 @@ class AuthCommand(ToolkitCommand):
                     f"The source id {source_id!r} is already used by the groups: {humanize_collection(already_used)!r}."
                 )
             )
-            if not questionary.confirm("This is NOT recommended. Do you want to continue?", default=False).ask():
+            if not questionary.confirm("This is NOT recommended. Do you want to continue?", default=False).unsafe_ask():
                 return None
 
         return self._create_toolkit_group_in_cdf(client, toolkit_group)

cognite_toolkit/_cdf_tk/commands/clean.py

@@ -197,7 +197,8 @@ class CleanCommand(ToolkitCommand):
             "Which modules would you like to clean?",
             instruction="Use arrow up/down, press space to select item(s) and enter to save",
             choices=choices,
-        ).ask()
+            validate=lambda choice: "You must select at least one module." if len(choice) == 0 else True,
+        ).unsafe_ask()
 
         if not selected_modules:
             return None