cognite-toolkit 0.7.46__py3-none-any.whl → 0.7.48__py3-none-any.whl

cognite_toolkit/_cdf_tk/client/api/spaces.py

@@ -0,0 +1,117 @@
+"""Spaces API for managing CDF data modeling spaces.
+
+Based on the API specification at:
+https://api-docs.cognite.com/20230101/tag/Spaces/operation/ApplySpaces
+"""
+
+from collections.abc import Iterable, Sequence
+
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, Endpoint, PagedResponse
+from cognite_toolkit._cdf_tk.client.http_client import HTTPClient, ItemsSuccessResponse2, SuccessResponse2
+from cognite_toolkit._cdf_tk.client.resource_classes.data_modeling import SpaceReference, SpaceRequest, SpaceResponse
+
+
+class SpacesAPI(CDFResourceAPI[SpaceReference, SpaceRequest, SpaceResponse]):
+    """API for managing CDF data modeling spaces.
+
+    Spaces use an apply/upsert pattern for create and update operations.
+    """
+
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "upsert": Endpoint(method="POST", path="/models/spaces", item_limit=100),
+                "retrieve": Endpoint(method="POST", path="/models/spaces/byids", item_limit=100),
+                "delete": Endpoint(method="POST", path="/models/spaces/delete", item_limit=100),
+                "list": Endpoint(method="GET", path="/models/spaces", item_limit=1000),
+            },
+        )
+
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[SpaceResponse]:
+        return PagedResponse[SpaceResponse].model_validate_json(response.body)
+
+    def apply(self, items: Sequence[SpaceRequest]) -> list[SpaceResponse]:
+        """Apply (create or update) spaces in CDF.
+
+        Args:
+            items: List of SpaceRequest objects to apply.
+
+        Returns:
+            List of applied SpaceResponse objects.
+        """
+        return self._request_item_response(items, "upsert")
+
+    def retrieve(self, items: Sequence[SpaceReference]) -> list[SpaceResponse]:
+        """Retrieve spaces from CDF.
+
+        Args:
+            items: List of SpaceReference objects to retrieve.
+
+        Returns:
+            List of retrieved SpaceResponse objects.
+        """
+        return self._request_item_response(items, method="retrieve")
+
+    def delete(self, items: Sequence[SpaceReference]) -> None:
+        """Delete spaces from CDF.
+
+        Args:
+            items: List of SpaceReference objects to delete.
+        """
+        self._request_no_response(items, "delete")
+
+    def paginate(
+        self,
+        include_global: bool = False,
+        limit: int = 100,
+        cursor: str | None = None,
+    ) -> PagedResponse[SpaceResponse]:
+        """Get a page of spaces from CDF.
+
+        Args:
+            include_global: Whether to include global spaces.
+            limit: Maximum number of spaces to return.
+            cursor: Cursor for pagination.
+
+        Returns:
+            PagedResponse of SpaceResponse objects.
+        """
+        return self._paginate(
+            cursor=cursor,
+            limit=limit,
+            params={"includeGlobal": include_global},
+        )
+
+    def iterate(
+        self,
+        include_global: bool = False,
+        limit: int | None = None,
+    ) -> Iterable[list[SpaceResponse]]:
+        """Iterate over all spaces in CDF.
+
+        Args:
+            include_global: Whether to include global spaces.
+            limit: Maximum total number of spaces to return.
+
+        Returns:
+            Iterable of lists of SpaceResponse objects.
+        """
+        return self._iterate(
+            limit=limit,
+            params={"includeGlobal": include_global},
+        )
+
+    def list(self, include_global: bool = False, limit: int | None = None) -> list[SpaceResponse]:
+        """List all spaces in CDF.
+
+        Args:
+            include_global: Whether to include global spaces.
+            limit: Maximum total number of spaces to return.
+
+        Returns:
+            List of SpaceResponse objects.
+        """
+        return self._list(limit=limit, params={"includeGlobal": include_global})

cognite_toolkit/_cdf_tk/client/api/streams.py

@@ -1,24 +1,33 @@
 from collections.abc import Sequence
 
-from pydantic import TypeAdapter
-from rich.console import Console
-
-from cognite_toolkit._cdf_tk.client.cdf_client.responses import PagedResponse
+from cognite_toolkit._cdf_tk.client.cdf_client import CDFResourceAPI, PagedResponse
+from cognite_toolkit._cdf_tk.client.cdf_client.api import Endpoint
 from cognite_toolkit._cdf_tk.client.http_client import (
     HTTPClient,
-    ItemsRequest2,
+    ItemsSuccessResponse2,
     RequestMessage2,
+    SuccessResponse2,
 )
+from cognite_toolkit._cdf_tk.client.resource_classes.identifiers import ExternalId
 from cognite_toolkit._cdf_tk.client.resource_classes.streams import StreamRequest, StreamResponse
 
 
-class StreamsAPI:
-    ENDPOINT = "/streams"
+class StreamsAPI(CDFResourceAPI[ExternalId, StreamRequest, StreamResponse]):
+    def __init__(self, http_client: HTTPClient) -> None:
+        super().__init__(
+            http_client=http_client,
+            method_endpoint_map={
+                "create": Endpoint(method="POST", path="/streams", item_limit=1),
+                "delete": Endpoint(method="POST", path="/streams/delete", item_limit=1),
+                "retrieve": Endpoint(method="GET", path="/streams/{streamId}", item_limit=1),
+                "list": Endpoint(method="GET", path="/streams", item_limit=1000),
+            },
+        )
 
-    def __init__(self, http_client: HTTPClient, console: Console) -> None:
-        self._http_client = http_client
-        self._console = console
-        self._config = http_client.config
+    def _validate_page_response(
+        self, response: SuccessResponse2 | ItemsSuccessResponse2
+    ) -> PagedResponse[StreamResponse]:
+        return PagedResponse[StreamResponse].model_validate_json(response.body)
 
     def create(self, items: Sequence[StreamRequest]) -> list[StreamResponse]:
         """Create one or more streams.
@@ -29,60 +38,59 @@ class StreamsAPI:
         Returns:
             List of created StreamResponse items.
         """
-        responses = self._http_client.request_items_retries(
-            ItemsRequest2(
-                endpoint_url=self._config.create_api_url(self.ENDPOINT),
-                method="POST",
-                items=items,
-            )
-        )
-        responses.raise_for_status()
-        return TypeAdapter(list[StreamResponse]).validate_python(responses.get_items())
+        return self._request_item_response(items, "create")
 
-    def delete(self, external_id: str) -> None:
-        """Delete stream using its external ID.
+    def delete(self, items: Sequence[ExternalId], ignore_unknown_ids: bool = False) -> None:
+        """Delete streams using their external IDs.
 
         Args:
-            external_id: External ID of the stream to delete.
+            items: Sequence of ExternalId objects to delete.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
         """
-        response = self._http_client.request_single_retries(
-            RequestMessage2(
-                endpoint_url=self._config.create_api_url(f"{self.ENDPOINT}/{external_id}"),
-                method="DELETE",
-            )
-        )
-        _ = response.get_success_or_raise()
+        if ignore_unknown_ids:
+            # The endpoint does not support ignoreUnknownIds, so we have to do it on the client side
+            return self._request_item_split_retries_no_response(items, "delete")
+        else:
+            return self._request_no_response(items, "delete")
 
-    def list(self) -> list[StreamResponse]:
-        """List streams.
+    def retrieve(
+        self, items: Sequence[ExternalId], include_statistics: bool = False, ignore_unknown_ids: bool = False
+    ) -> list[StreamResponse]:
+        """Retrieve streams by their external IDs.
+
+        Note: The streams API only supports retrieving one stream at a time via path parameter.
+
+        Args:
+            items: Sequence of ExternalId objects to retrieve.
+            include_statistics: Whether to include usage statistics in the response.
+            ignore_unknown_ids: Whether to ignore unknown IDs.
 
         Returns:
-            StreamResponseList containing the listed streams.
+            List of StreamResponse items.
         """
-        response = self._http_client.request_single_retries(
-            RequestMessage2(
-                endpoint_url=self._config.create_api_url(self.ENDPOINT),
-                method="GET",
+        results: list[StreamResponse] = []
+        endpoint = self._method_endpoint_map["retrieve"]
+        for item in items:
+            response = self._http_client.request_single_retries(
+                RequestMessage2(
+                    endpoint_url=self._make_url(endpoint.path.format(streamId=item.external_id)),
+                    method=endpoint.method,
+                    parameters={"includeStatistics": include_statistics},
+                )
             )
-        )
-        success = response.get_success_or_raise()
-        return PagedResponse[StreamResponse].model_validate(success.body_json).items
+            if isinstance(response, SuccessResponse2):
+                results.append(StreamResponse.model_validate(response.body_json))
+            elif ignore_unknown_ids:
+                continue
+            _ = response.get_success_or_raise()
+        return results
 
-    def retrieve(self, external_id: str, include_statistics: bool = True) -> StreamResponse:
-        """Retrieve a stream by its external ID.
+    def list(self) -> list[StreamResponse]:
+        """List all streams.
+
+        Note: The streams API does not support pagination.
 
-        Args:
-            external_id: External ID of the stream to retrieve.
-            include_statistics: Whether to include usage statistics in the response.
         Returns:
-            StreamResponse item.
+            List of StreamResponse items.
         """
-        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},
-            )
-        )
-        success = response.get_success_or_raise()
-        return StreamResponse.model_validate(success.body_json)
+        return self._list(limit=None)