cognite-toolkit 0.7.31__tar.gz → 0.7.32__tar.gz

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cognite_toolkit
-Version: 0.7.31
+Version: 0.7.32
 Summary: Official Cognite Data Fusion tool for project templates and configuration deployment
 Author: Cognite AS
 Author-email: Cognite AS <support@cognite.com>

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf.py

@@ -27,6 +27,7 @@ from cognite_toolkit._cdf_tk.apps import (
     DataApp,
     DevApp,
     DumpApp,
+    ImportApp,
     LandingApp,
     MigrateApp,
     ModulesApp,
@@ -42,7 +43,7 @@ from cognite_toolkit._cdf_tk.constants import HINT_LEAD_TEXT, URL, USE_SENTRY
 from cognite_toolkit._cdf_tk.exceptions import (
     ToolkitError,
 )
-from cognite_toolkit._cdf_tk.feature_flags import FeatureFlag, Flags
+from cognite_toolkit._cdf_tk.feature_flags import Flags
 from cognite_toolkit._cdf_tk.plugins import Plugins
 from cognite_toolkit._cdf_tk.tracker import Tracker
 from cognite_toolkit._cdf_tk.utils import (
@@ -108,6 +109,9 @@ if Flags.PROFILE.is_enabled():
 if Flags.MIGRATE.is_enabled():
     _app.add_typer(MigrateApp(**default_typer_kws), name="migrate")
 
+if Flags.IMPORT_CMD.is_enabled():
+    _app.add_typer(ImportApp(**default_typer_kws), name="import")
+
 if Plugins.data.value.is_enabled():
     _app.add_typer(DataApp(**default_typer_kws), name="data")
 
@@ -126,11 +130,6 @@ def app() -> NoReturn:
     # --- Main entry point ---
     # Users run 'app()' directly, but that doesn't allow us to control excepton handling:
     try:
-        if FeatureFlag.is_enabled(Flags.IMPORT_CMD):
-            from cognite_toolkit._cdf_tk.prototypes.import_app import import_app
-
-            _app.add_typer(import_app, name="import")
-
         _app()
     except ToolkitError as err:
         if "--verbose" in sys.argv:

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/apps/__init__.py

@@ -4,6 +4,7 @@ from ._data_app import DataApp
 from ._dev_app import DevApp
 from ._download_app import DownloadApp
 from ._dump_app import DumpApp
+from ._import_app import ImportApp
 from ._landing_app import LandingApp
 from ._migrate_app import MigrateApp
 from ._modules_app import ModulesApp
@@ -20,6 +21,7 @@ __all__ = [
     "DevApp",
     "DownloadApp",
     "DumpApp",
+    "ImportApp",
     "LandingApp",
     "MigrateApp",
     "ModulesApp",

cognite_toolkit-0.7.32/cognite_toolkit/_cdf_tk/apps/_import_app.py

@@ -0,0 +1,41 @@
+from pathlib import Path
+from typing import Any
+
+import typer
+
+from cognite_toolkit._cdf_tk.client import ToolkitClient
+from cognite_toolkit._cdf_tk.commands._import_cmd import ImportTransformationCLI
+from cognite_toolkit._cdf_tk.utils.auth import EnvironmentVariables
+
+
+class ImportApp(typer.Typer):
+    def __init__(self, *args: Any, **kwargs: Any) -> None:
+        super().__init__(*args, **kwargs)
+        self.callback(invoke_without_command=True)(self.main)
+        self.command("transformation-cli")(self.transformation_cli)
+
+    def main(self, ctx: typer.Context) -> None:
+        """PREVIEW FEATURE Import resources into Cognite-Toolkit."""
+        if ctx.invoked_subcommand is None:
+            print("Use [bold yellow]cdf-tk import --help[/] for more information.")
+        return None
+
+    @staticmethod
+    def transformation_cli(
+        source: Path = typer.Argument(..., help="Path to the transformation CLI manifest directory or files."),
+        destination: Path = typer.Argument(..., help="Path to the destination directory."),
+        overwrite: bool = typer.Option(False, help="Overwrite destination if it already exists."),
+        flatten: bool = typer.Option(False, help="Flatten the directory structure."),
+        clean: bool = typer.Option(False, help="Remove the source directory after import."),
+        verbose: bool = typer.Option(False, help="Turn on to get more verbose output when running the command"),
+    ) -> None:
+        """Import transformation CLI manifests into Cognite-Toolkit modules."""
+
+        # We are lazy loading the client as we only need it if we need to look up dataset ids.
+        # This is to ensure the command can be executed without a client if the user does not need to look up dataset ids.
+        # (which is likely 99% of the time)
+        def get_client() -> ToolkitClient:
+            return EnvironmentVariables.create_from_environment().get_client()
+
+        cmd = ImportTransformationCLI(print_warning=True, get_client=get_client)
+        cmd.execute(source, destination, overwrite, flatten, clean, verbose=verbose)

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/api/extended_functions.py

@@ -7,7 +7,7 @@ from rich.console import Console
 
 from cognite_toolkit._cdf_tk.client.config import ToolkitClientConfig
 from cognite_toolkit._cdf_tk.utils.collection import chunker
-from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, SimpleBodyRequest
+from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, RequestMessage2
 from cognite_toolkit._cdf_tk.utils.useful_types import JsonVal
 
 
@@ -34,21 +34,20 @@ class ExtendedFunctionsAPI(FunctionsAPI):
 
         Args:
             function (FunctionWrite): The function to create.
-            console (Console | None): The rich console to use for printing warnings.
 
         Returns:
             Function: The created function object.
         """
-        result = self._toolkit_http_client.request_with_retries(
-            message=SimpleBodyRequest(
+        result = self._toolkit_http_client.request_single_retries(
+            message=RequestMessage2(
                 endpoint_url=self._toolkit_config.create_api_url("/functions"),
                 method="POST",
                 body_content={"items": [function.dump(camel_case=True)]},
             )
         )
-        result.raise_for_status()
+        success = result.get_success_or_raise()
         # We assume the API response is one item on a successful creation
-        return Function._load(result.get_first_body()["items"][0], cognite_client=self._cognite_client)  # type: ignore[arg-type,index]
+        return Function._load(success.body_json["items"][0], cognite_client=self._cognite_client)
 
     def delete_with_429_retry(self, external_id: SequenceNotStr[str], ignore_unknown_ids: bool = False) -> None:
         """Delete one or more functions with retry handling for 429 Too Many Requests responses.
@@ -70,11 +69,12 @@ class ExtendedFunctionsAPI(FunctionsAPI):
             }
             if ignore_unknown_ids:
                 body_content["ignoreUnknownIds"] = True
-            self._toolkit_http_client.request_with_retries(
-                message=SimpleBodyRequest(
+            result = self._toolkit_http_client.request_single_retries(
+                message=RequestMessage2(
                     endpoint_url=self._toolkit_config.create_api_url("/functions/delete"),
                     method="POST",
                     body_content=body_content,
                 )
-            ).raise_for_status()
+            )
+            result.get_success_or_raise()
         return None

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/api/infield.py

@@ -1,6 +1,7 @@
 from collections.abc import Sequence
 from typing import Any, cast
 
+from pydantic import TypeAdapter
 from rich.console import Console
 
 from cognite_toolkit._cdf_tk.client.data_classes.api_classes import PagedResponse, QueryResponse
@@ -15,7 +16,12 @@ from cognite_toolkit._cdf_tk.client.data_classes.instance_api import (
     NodeIdentifier,
 )
 from cognite_toolkit._cdf_tk.tk_warnings import HighSeverityWarning
-from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, ItemsRequest, SimpleBodyRequest
+from cognite_toolkit._cdf_tk.utils.http_client import (
+    HTTPClient,
+    ItemsRequest,
+    ItemsRequest2,
+    RequestMessage2,
+)
 
 
 class InfieldConfigAPI:
@@ -40,31 +46,31 @@ class InfieldConfigAPI:
             else [item.as_request_item(), item.data_exploration_config.as_request_item()]
             for item in items
         )
-        responses = self._http_client.request_with_retries(
-            ItemsRequest(
+        responses = self._http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self._config.create_api_url(self.ENDPOINT),
                 method="POST",
                 items=[item for sublist in request_items for item in sublist],
             )
         )
         responses.raise_for_status()
-        return PagedResponse[InstanceResult].model_validate(responses.get_first_body()).items
+        return TypeAdapter(list[InstanceResult]).validate_python(responses.get_items())
 
     def retrieve(self, items: Sequence[NodeIdentifier]) -> list[InfieldLocationConfig]:
         if len(items) > 100:
             raise ValueError("Cannot retrieve more than 100 InfieldLocationConfig items at once.")
         if not items:
             return []
-        responses = self._http_client.request_with_retries(
-            SimpleBodyRequest(
+        response = self._http_client.request_single_retries(
+            RequestMessage2(
                 # We use the query endpoint to be able to retrieve linked DataExplorationConfig items
                 endpoint_url=self._config.create_api_url(f"{self.ENDPOINT}/query"),
                 method="POST",
                 body_content=self._retrieve_query(items),
             )
         )
-        responses.raise_for_status()
-        parsed_response = QueryResponse[InstanceResponseItem].model_validate(responses.get_first_body())
+        success = response.get_success_or_raise()
+        parsed_response = QueryResponse[InstanceResponseItem].model_validate(success.body_json)
         return self._parse_retrieve_response(parsed_response)
 
     def delete(self, items: Sequence[InfieldLocationConfig]) -> list[NodeIdentifier]:
@@ -168,30 +174,30 @@ class InFieldCDMConfigAPI:
             raise ValueError("Cannot apply more than 500 InFieldCDMLocationConfig items at once.")
 
         request_items = [item.as_request_item() for item in items]
-        responses = self._http_client.request_with_retries(
-            ItemsRequest(
+        results = self._http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self._config.create_api_url(self.ENDPOINT),
                 method="POST",
-                items=request_items,  # type: ignore[arg-type]
+                items=request_items,
             )
         )
-        responses.raise_for_status()
-        return PagedResponse[InstanceResult].model_validate(responses.get_first_body()).items
+        results.raise_for_status()
+        return TypeAdapter(list[InstanceResult]).validate_python(results.get_items())
 
     def retrieve(self, items: Sequence[NodeIdentifier]) -> list[InFieldCDMLocationConfig]:
         if len(items) > 100:
             raise ValueError("Cannot retrieve more than 100 InFieldCDMLocationConfig items at once.")
         if not items:
             return []
-        responses = self._http_client.request_with_retries(
-            SimpleBodyRequest(
+        result = self._http_client.request_single_retries(
+            RequestMessage2(
                 endpoint_url=self._config.create_api_url(f"{self.ENDPOINT}/query"),
                 method="POST",
                 body_content=self._retrieve_query(items),
             )
         )
-        responses.raise_for_status()
-        parsed_response = QueryResponse[InstanceResponseItem].model_validate(responses.get_first_body())
+        success = result.get_success_or_raise()
+        parsed_response = QueryResponse[InstanceResponseItem].model_validate(success.body_json)
         return self._parse_retrieve_response(parsed_response)
 
     def delete(self, items: Sequence[InFieldCDMLocationConfig]) -> list[NodeIdentifier]:

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/api/project.py

@@ -2,7 +2,7 @@ from cognite.client import CogniteClient
 
 from cognite_toolkit._cdf_tk.client.config import ToolkitClientConfig
 from cognite_toolkit._cdf_tk.client.data_classes.project import ProjectStatusList
-from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, ParamRequest
+from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, RequestMessage2
 
 
 class ProjectAPI:
@@ -13,11 +13,12 @@ class ProjectAPI:
 
     def status(self) -> ProjectStatusList:
         """Retrieve information about the current project."""
-        response = self._http_client.request_with_retries(
-            ParamRequest(
-                endpoint_url=f"{self._config.base_url}/api/v1/projects?withDataModelingStatus=true", method="GET"
+        response = self._http_client.request_single_retries(
+            RequestMessage2(
+                endpoint_url=f"{self._config.base_url}/api/v1/projects",
+                method="GET",
+                parameters={"withDataModelingStatus": True},
             )
         )
-        response.raise_for_status()
-        body = response.get_first_body()
-        return ProjectStatusList._load(body["items"], cognite_client=self._cognite_client)  # type: ignore[arg-type]
+        success = response.get_success_or_raise()
+        return ProjectStatusList._load(success.body_json["items"], cognite_client=self._cognite_client)

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/api/streams.py

@@ -1,10 +1,16 @@
 from collections.abc import Sequence
 
+from pydantic import TypeAdapter
 from rich.console import Console
 
 from cognite_toolkit._cdf_tk.client.data_classes.api_classes import PagedResponse
 from cognite_toolkit._cdf_tk.client.data_classes.streams import StreamRequest, StreamResponse
-from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, ItemsRequest, ParamRequest
+from cognite_toolkit._cdf_tk.utils.http_client import (
+    HTTPClient,
+    ItemsRequest2,
+    ParamRequest,
+    RequestMessage2,
+)
 
 
 class StreamsAPI:
@@ -24,15 +30,15 @@ class StreamsAPI:
         Returns:
             List of created StreamResponse items.
         """
-        responses = self._http_client.request_with_retries(
-            ItemsRequest(
+        responses = self._http_client.request_items_retries(
+            ItemsRequest2(
                 endpoint_url=self._config.create_api_url(self.ENDPOINT),
                 method="POST",
-                items=list(items),
+                items=items,
             )
         )
         responses.raise_for_status()
-        return PagedResponse[StreamResponse].model_validate(responses.get_first_body()).items
+        return TypeAdapter(list[StreamResponse]).validate_python(responses.get_items())
 
     def delete(self, external_id: str) -> None:
         """Delete stream using its external ID.
@@ -54,14 +60,14 @@ class StreamsAPI:
         Returns:
             StreamResponseList containing the listed streams.
         """
-        responses = self._http_client.request_with_retries(
-            ParamRequest(
+        response = self._http_client.request_single_retries(
+            RequestMessage2(
                 endpoint_url=self._config.create_api_url(self.ENDPOINT),
                 method="GET",
             )
         )
-        responses.raise_for_status()
-        return PagedResponse[StreamResponse].model_validate(responses.get_first_body()).items
+        success = response.get_success_or_raise()
+        return PagedResponse[StreamResponse].model_validate(success.body_json).items
 
     def retrieve(self, external_id: str, include_statistics: bool = True) -> StreamResponse:
         """Retrieve a stream by its external ID.
@@ -72,13 +78,12 @@ class StreamsAPI:
         Returns:
             StreamResponse item.
         """
-        responses = self._http_client.request_with_retries(
-            ParamRequest(
+        response = self._http_client.request_single_retries(
+            RequestMessage2(
                 endpoint_url=self._config.create_api_url(f"{self.ENDPOINT}/{external_id}"),
                 method="GET",
                 parameters={"includeStatistics": include_statistics},
             )
         )
-        responses.raise_for_status()
-        response_body = responses.get_first_body()
-        return StreamResponse.model_validate(response_body)
+        success = response.get_success_or_raise()
+        return StreamResponse.model_validate(success.body_json)

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/api/three_d.py

@@ -2,7 +2,7 @@ from rich.console import Console
 
 from cognite_toolkit._cdf_tk.client.data_classes.api_classes import PagedResponse
 from cognite_toolkit._cdf_tk.client.data_classes.three_d import ThreeDModelResponse
-from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, ParamRequest
+from cognite_toolkit._cdf_tk.utils.http_client import HTTPClient, RequestMessage2
 from cognite_toolkit._cdf_tk.utils.useful_types import PrimitiveType
 
 
@@ -34,15 +34,15 @@ class ThreeDModelAPI:
             parameters["published"] = published
         if cursor is not None:
             parameters["cursor"] = cursor
-        responses = self._http_client.request_with_retries(
-            ParamRequest(
+        responses = self._http_client.request_single_retries(
+            RequestMessage2(
                 endpoint_url=self._config.create_api_url(self.ENDPOINT),
                 method="GET",
                 parameters=parameters,
             )
         )
-        responses.raise_for_status()
-        return PagedResponse[ThreeDModelResponse].model_validate(responses.get_first_body())
+        success_response = responses.get_success_or_raise()
+        return PagedResponse[ThreeDModelResponse].model_validate(success_response.body_json)
 
 
 class ThreeDAPI:

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/data_classes/base.py

@@ -6,6 +6,8 @@ from typing import TYPE_CHECKING, Any, Generic, TypeVar
 from pydantic import BaseModel, ConfigDict
 from pydantic.alias_generators import to_camel
 
+from cognite_toolkit._cdf_tk.utils.http_client._data_classes2 import BaseModelObject, RequestResource
+
 if TYPE_CHECKING:
     from cognite.client import CogniteClient
 
@@ -15,28 +17,6 @@ else:
     from typing_extensions import Self
 
 
-class BaseModelObject(BaseModel):
-    """Base class for all object. This includes resources and nested objects."""
-
-    # We allow extra fields to support forward compatibility.
-    model_config = ConfigDict(alias_generator=to_camel, extra="allow")
-
-    def dump(self, camel_case: bool = True) -> dict[str, Any]:
-        """Dump the resource to a dictionary.
-
-        This is the default serialization method for request resources.
-        """
-        return self.model_dump(mode="json", by_alias=camel_case)
-
-    @classmethod
-    def _load(cls, resource: dict[str, Any]) -> "Self":
-        """Load method to match CogniteResource signature."""
-        return cls.model_validate(resource)
-
-
-class RequestResource(BaseModelObject): ...
-
-
 T_RequestResource = TypeVar("T_RequestResource", bound=RequestResource)
 
 

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/data_classes/instance_api.py

@@ -107,7 +107,7 @@ class InstanceSource(BaseModelObject):
         return value
 
 
-class InstanceRequestItem(BaseModelObject):
+class InstanceRequestItem(RequestResource):
     model_config = ConfigDict(populate_by_name=True)
     instance_type: InstanceType
     space: str

{cognite_toolkit-0.7.31 → cognite_toolkit-0.7.32}/cognite_toolkit/_cdf_tk/client/data_classes/three_d.py

@@ -19,6 +19,9 @@ class RevisionStatus(BaseModelObject):
 class ThreeDModelRequest(RequestResource):
     name: str
 
+    def as_id(self) -> str:
+        return self.name
+
 
 class ThreeDModelClassicRequest(ThreeDModelRequest):
     data_set_id: int | None = None