@planqk/planqk-service-sdk 2.2.1 → 2.4.0

package/planqk/service/sdk/service_api/raw_client.py

@@ -0,0 +1,606 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import contextlib
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.jsonable_encoder import jsonable_encoder
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..types.service_execution import ServiceExecution
+from .types.get_result_response import GetResultResponse
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawServiceApiClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def get_service_executions(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[typing.List[ServiceExecution]]:
+        """
+        Retrieves a list of all service executions.
+        The response includes links to each service execution, allowing for further queries on their status and results.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.List[ServiceExecution]]
+            List of service executions
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[ServiceExecution],
+                    parse_obj_as(
+                        type_=typing.List[ServiceExecution],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def start_execution(
+        self,
+        *,
+        request: typing.Dict[str, typing.Optional[typing.Any]],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[ServiceExecution]:
+        """
+        Starts a service execution, which in turn is processed asynchronously.
+        The location header of the response contains the URL which can be used to query the status and the result of the service execution.
+
+        Parameters
+        ----------
+        request : typing.Dict[str, typing.Optional[typing.Any]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ServiceExecution]
+            Service execution is submitted
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            method="POST",
+            json=request,
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ServiceExecution,
+                    parse_obj_as(
+                        type_=ServiceExecution,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_status(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[ServiceExecution]:
+        """
+        Retrieves the status of a service execution.
+        The status can be one of the following: UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ServiceExecution]
+            A service execution
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ServiceExecution,
+                    parse_obj_as(
+                        type_=ServiceExecution,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get_result(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[GetResultResponse]:
+        """
+        Retrieves the result of a service execution.
+        The result is returned as a JSON object containing the status and any additional data.
+        The result may include links to download specific result files.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetResultResponse]
+            The service execution result
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}/result",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetResultResponse,
+                    parse_obj_as(
+                        type_=GetResultResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    @contextlib.contextmanager
+    def get_result_file(
+        self, id: str, file: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.Iterator[HttpResponse[typing.Iterator[bytes]]]:
+        """
+        Retrieves a specific result file of a service execution.
+        The file name is provided in the path parameter.
+        The result file is returned as a binary stream.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        file : str
+            The name of the result file
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+        Returns
+        -------
+        typing.Iterator[HttpResponse[typing.Iterator[bytes]]]
+            The content of a result file
+        """
+        with self._client_wrapper.httpx_client.stream(
+            f"{jsonable_encoder(id)}/result/{jsonable_encoder(file)}",
+            method="GET",
+            request_options=request_options,
+        ) as _response:
+
+            def _stream() -> HttpResponse[typing.Iterator[bytes]]:
+                try:
+                    if 200 <= _response.status_code < 300:
+                        _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                        return HttpResponse(
+                            response=_response, data=(_chunk for _chunk in _response.iter_bytes(chunk_size=_chunk_size))
+                        )
+                    _response.read()
+                    _response_json = _response.json()
+                except JSONDecodeError:
+                    raise ApiError(
+                        status_code=_response.status_code, headers=dict(_response.headers), body=_response.text
+                    )
+                raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+            yield _stream()
+
+    def get_logs(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[typing.List[str]]:
+        """
+        Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[typing.List[str]]
+            List of log entries
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}/log",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[str],
+                    parse_obj_as(
+                        type_=typing.List[str],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def cancel_execution(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[ServiceExecution]:
+        """
+        Cancel a pending or running service execution.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[ServiceExecution]
+            Service execution is cancelled
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}/cancel",
+            method="PUT",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ServiceExecution,
+                    parse_obj_as(
+                        type_=ServiceExecution,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawServiceApiClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def get_service_executions(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[typing.List[ServiceExecution]]:
+        """
+        Retrieves a list of all service executions.
+        The response includes links to each service execution, allowing for further queries on their status and results.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.List[ServiceExecution]]
+            List of service executions
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[ServiceExecution],
+                    parse_obj_as(
+                        type_=typing.List[ServiceExecution],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def start_execution(
+        self,
+        *,
+        request: typing.Dict[str, typing.Optional[typing.Any]],
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[ServiceExecution]:
+        """
+        Starts a service execution, which in turn is processed asynchronously.
+        The location header of the response contains the URL which can be used to query the status and the result of the service execution.
+
+        Parameters
+        ----------
+        request : typing.Dict[str, typing.Optional[typing.Any]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ServiceExecution]
+            Service execution is submitted
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            method="POST",
+            json=request,
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ServiceExecution,
+                    parse_obj_as(
+                        type_=ServiceExecution,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_status(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[ServiceExecution]:
+        """
+        Retrieves the status of a service execution.
+        The status can be one of the following: UNKNOWN, PENDING, RUNNING, SUCCEEDED, CANCELLED, FAILED.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ServiceExecution]
+            A service execution
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ServiceExecution,
+                    parse_obj_as(
+                        type_=ServiceExecution,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get_result(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[GetResultResponse]:
+        """
+        Retrieves the result of a service execution.
+        The result is returned as a JSON object containing the status and any additional data.
+        The result may include links to download specific result files.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetResultResponse]
+            The service execution result
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}/result",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetResultResponse,
+                    parse_obj_as(
+                        type_=GetResultResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    @contextlib.asynccontextmanager
+    async def get_result_file(
+        self, id: str, file: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]:
+        """
+        Retrieves a specific result file of a service execution.
+        The file name is provided in the path parameter.
+        The result file is returned as a binary stream.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        file : str
+            The name of the result file
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration. You can pass in configuration such as `chunk_size`, and more to customize the request and response.
+
+        Returns
+        -------
+        typing.AsyncIterator[AsyncHttpResponse[typing.AsyncIterator[bytes]]]
+            The content of a result file
+        """
+        async with self._client_wrapper.httpx_client.stream(
+            f"{jsonable_encoder(id)}/result/{jsonable_encoder(file)}",
+            method="GET",
+            request_options=request_options,
+        ) as _response:
+
+            async def _stream() -> AsyncHttpResponse[typing.AsyncIterator[bytes]]:
+                try:
+                    if 200 <= _response.status_code < 300:
+                        _chunk_size = request_options.get("chunk_size", None) if request_options is not None else None
+                        return AsyncHttpResponse(
+                            response=_response,
+                            data=(_chunk async for _chunk in _response.aiter_bytes(chunk_size=_chunk_size)),
+                        )
+                    await _response.aread()
+                    _response_json = _response.json()
+                except JSONDecodeError:
+                    raise ApiError(
+                        status_code=_response.status_code, headers=dict(_response.headers), body=_response.text
+                    )
+                raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+            yield await _stream()
+
+    async def get_logs(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[typing.List[str]]:
+        """
+        Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[typing.List[str]]
+            List of log entries
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}/log",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    typing.List[str],
+                    parse_obj_as(
+                        type_=typing.List[str],  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def cancel_execution(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[ServiceExecution]:
+        """
+        Cancel a pending or running service execution.
+
+        Parameters
+        ----------
+        id : str
+            The id of a service execution
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[ServiceExecution]
+            Service execution is cancelled
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"{jsonable_encoder(id)}/cancel",
+            method="PUT",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    ServiceExecution,
+                    parse_obj_as(
+                        type_=ServiceExecution,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

package/planqk/service/sdk/service_api/types/__init__.py

@@ -1,13 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
+# isort: skip_file
+
 from .get_result_response import GetResultResponse
 from .get_result_response_embedded import GetResultResponseEmbedded
 from .get_result_response_links import GetResultResponseLinks
-from .health_check_response import HealthCheckResponse
 
-__all__ = [
-    "GetResultResponse",
-    "GetResultResponseEmbedded",
-    "GetResultResponseLinks",
-    "HealthCheckResponse",
-]
+__all__ = ["GetResultResponse", "GetResultResponseEmbedded", "GetResultResponseLinks"]

package/planqk/service/sdk/service_api/types/get_result_response.py

@@ -1,27 +1,23 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
-import typing_extensions
 import typing
-from .get_result_response_links import GetResultResponseLinks
+
+import pydantic
+import typing_extensions
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
 from ...core.serialization import FieldMetadata
 from .get_result_response_embedded import GetResultResponseEmbedded
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
-import pydantic
+from .get_result_response_links import GetResultResponseLinks
 
 
 class GetResultResponse(UniversalBaseModel):
-    links: typing_extensions.Annotated[
-        typing.Optional[GetResultResponseLinks], FieldMetadata(alias="_links")
-    ] = None
+    links: typing_extensions.Annotated[typing.Optional[GetResultResponseLinks], FieldMetadata(alias="_links")] = None
     embedded: typing_extensions.Annotated[
         typing.Optional[GetResultResponseEmbedded], FieldMetadata(alias="_embedded")
     ] = None
 
     if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
-            extra="allow", frozen=True
-        )  # type: ignore # Pydantic v2
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:
 
         class Config:

package/planqk/service/sdk/service_api/types/get_result_response_embedded.py

@@ -1,19 +1,17 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from ...core.pydantic_utilities import UniversalBaseModel
 import typing
-from ...types.service_execution import ServiceExecution
-from ...core.pydantic_utilities import IS_PYDANTIC_V2
+
 import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...types.service_execution import ServiceExecution
 
 
 class GetResultResponseEmbedded(UniversalBaseModel):
     status: typing.Optional[ServiceExecution] = None
 
     if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
-            extra="allow", frozen=True
-        )  # type: ignore # Pydantic v2
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
     else:
 
         class Config: