@planqk/planqk-service-sdk 2.6.2 → 2.7.0

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

@@ -4,9 +4,11 @@ import typing
 
 from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
 from ..core.request_options import RequestOptions
+from ..types.log_entry import LogEntry
+from ..types.request_body import RequestBody
+from ..types.result_response import ResultResponse
 from ..types.service_execution import ServiceExecution
 from .raw_client import AsyncRawServiceApiClient, RawServiceApiClient
-from .types.get_result_response import GetResultResponse
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -57,10 +59,7 @@ class ServiceApiClient:
         return _response.data
 
     def start_execution(
-        self,
-        *,
-        request: typing.Dict[str, typing.Optional[typing.Any]],
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, request: RequestBody, request_options: typing.Optional[RequestOptions] = None
     ) -> ServiceExecution:
         """
         Starts a service execution, which in turn is processed asynchronously.
@@ -68,7 +67,7 @@ class ServiceApiClient:
 
         Parameters
         ----------
-        request : typing.Dict[str, typing.Optional[typing.Any]]
+        request : RequestBody
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -124,7 +123,7 @@ class ServiceApiClient:
         _response = self._raw_client.get_status(id, request_options=request_options)
         return _response.data
 
-    def get_result(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> GetResultResponse:
+    def get_result(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ResultResponse:
         """
         Retrieves the result of a service execution.
         The result is returned as a JSON object containing the status and any additional data.
@@ -140,7 +139,7 @@ class ServiceApiClient:
 
         Returns
         -------
-        GetResultResponse
+        ResultResponse
             The service execution result
 
         Examples
@@ -184,7 +183,7 @@ class ServiceApiClient:
         with self._raw_client.get_result_file(id, file, request_options=request_options) as r:
             yield from r.data
 
-    def get_logs(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[str]:
+    def get_logs(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[LogEntry]:
         """
         Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
 
@@ -198,7 +197,7 @@ class ServiceApiClient:
 
         Returns
         -------
-        typing.List[str]
+        typing.List[LogEntry]
             List of log entries
 
         Examples
@@ -300,10 +299,7 @@ class AsyncServiceApiClient:
         return _response.data
 
     async def start_execution(
-        self,
-        *,
-        request: typing.Dict[str, typing.Optional[typing.Any]],
-        request_options: typing.Optional[RequestOptions] = None,
+        self, *, request: RequestBody, request_options: typing.Optional[RequestOptions] = None
     ) -> ServiceExecution:
         """
         Starts a service execution, which in turn is processed asynchronously.
@@ -311,7 +307,7 @@ class AsyncServiceApiClient:
 
         Parameters
         ----------
-        request : typing.Dict[str, typing.Optional[typing.Any]]
+        request : RequestBody
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -383,9 +379,7 @@ class AsyncServiceApiClient:
         _response = await self._raw_client.get_status(id, request_options=request_options)
         return _response.data
 
-    async def get_result(
-        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> GetResultResponse:
+    async def get_result(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> ResultResponse:
         """
         Retrieves the result of a service execution.
         The result is returned as a JSON object containing the status and any additional data.
@@ -401,7 +395,7 @@ class AsyncServiceApiClient:
 
         Returns
         -------
-        GetResultResponse
+        ResultResponse
             The service execution result
 
         Examples
@@ -454,7 +448,9 @@ class AsyncServiceApiClient:
             async for _chunk in r.data:
                 yield _chunk
 
-    async def get_logs(self, id: str, *, request_options: typing.Optional[RequestOptions] = None) -> typing.List[str]:
+    async def get_logs(
+        self, id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> typing.List[LogEntry]:
         """
         Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
 
@@ -468,7 +464,7 @@ class AsyncServiceApiClient:
 
         Returns
         -------
-        typing.List[str]
+        typing.List[LogEntry]
             List of log entries
 
         Examples

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

@@ -8,10 +8,12 @@ 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 ..core.unchecked_base_model import construct_type
+from ..types.log_entry import LogEntry
+from ..types.request_body import RequestBody
+from ..types.result_response import ResultResponse
 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, ...)
@@ -46,7 +48,7 @@ class RawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     typing.List[ServiceExecution],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[ServiceExecution],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -58,10 +60,7 @@ class RawServiceApiClient:
         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,
+        self, *, request: RequestBody, request_options: typing.Optional[RequestOptions] = None
     ) -> HttpResponse[ServiceExecution]:
         """
         Starts a service execution, which in turn is processed asynchronously.
@@ -69,7 +68,7 @@ class RawServiceApiClient:
 
         Parameters
         ----------
-        request : typing.Dict[str, typing.Optional[typing.Any]]
+        request : RequestBody
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -92,7 +91,7 @@ class RawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     ServiceExecution,
-                    parse_obj_as(
+                    construct_type(
                         type_=ServiceExecution,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -132,7 +131,7 @@ class RawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     ServiceExecution,
-                    parse_obj_as(
+                    construct_type(
                         type_=ServiceExecution,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -145,7 +144,7 @@ class RawServiceApiClient:
 
     def get_result(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[GetResultResponse]:
+    ) -> HttpResponse[ResultResponse]:
         """
         Retrieves the result of a service execution.
         The result is returned as a JSON object containing the status and any additional data.
@@ -161,7 +160,7 @@ class RawServiceApiClient:
 
         Returns
         -------
-        HttpResponse[GetResultResponse]
+        HttpResponse[ResultResponse]
             The service execution result
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -172,9 +171,9 @@ class RawServiceApiClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    GetResultResponse,
-                    parse_obj_as(
-                        type_=GetResultResponse,  # type: ignore
+                    ResultResponse,
+                    construct_type(
+                        type_=ResultResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -234,7 +233,7 @@ class RawServiceApiClient:
 
     def get_logs(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> HttpResponse[typing.List[str]]:
+    ) -> HttpResponse[typing.List[LogEntry]]:
         """
         Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
 
@@ -248,7 +247,7 @@ class RawServiceApiClient:
 
         Returns
         -------
-        HttpResponse[typing.List[str]]
+        HttpResponse[typing.List[LogEntry]]
             List of log entries
         """
         _response = self._client_wrapper.httpx_client.request(
@@ -259,9 +258,9 @@ class RawServiceApiClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    typing.List[str],
-                    parse_obj_as(
-                        type_=typing.List[str],  # type: ignore
+                    typing.List[LogEntry],
+                    construct_type(
+                        type_=typing.List[LogEntry],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -299,7 +298,7 @@ class RawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     ServiceExecution,
-                    parse_obj_as(
+                    construct_type(
                         type_=ServiceExecution,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -340,7 +339,7 @@ class AsyncRawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     typing.List[ServiceExecution],
-                    parse_obj_as(
+                    construct_type(
                         type_=typing.List[ServiceExecution],  # type: ignore
                         object_=_response.json(),
                     ),
@@ -352,10 +351,7 @@ class AsyncRawServiceApiClient:
         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,
+        self, *, request: RequestBody, request_options: typing.Optional[RequestOptions] = None
     ) -> AsyncHttpResponse[ServiceExecution]:
         """
         Starts a service execution, which in turn is processed asynchronously.
@@ -363,7 +359,7 @@ class AsyncRawServiceApiClient:
 
         Parameters
         ----------
-        request : typing.Dict[str, typing.Optional[typing.Any]]
+        request : RequestBody
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -386,7 +382,7 @@ class AsyncRawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     ServiceExecution,
-                    parse_obj_as(
+                    construct_type(
                         type_=ServiceExecution,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -426,7 +422,7 @@ class AsyncRawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     ServiceExecution,
-                    parse_obj_as(
+                    construct_type(
                         type_=ServiceExecution,  # type: ignore
                         object_=_response.json(),
                     ),
@@ -439,7 +435,7 @@ class AsyncRawServiceApiClient:
 
     async def get_result(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[GetResultResponse]:
+    ) -> AsyncHttpResponse[ResultResponse]:
         """
         Retrieves the result of a service execution.
         The result is returned as a JSON object containing the status and any additional data.
@@ -455,7 +451,7 @@ class AsyncRawServiceApiClient:
 
         Returns
         -------
-        AsyncHttpResponse[GetResultResponse]
+        AsyncHttpResponse[ResultResponse]
             The service execution result
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -466,9 +462,9 @@ class AsyncRawServiceApiClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    GetResultResponse,
-                    parse_obj_as(
-                        type_=GetResultResponse,  # type: ignore
+                    ResultResponse,
+                    construct_type(
+                        type_=ResultResponse,  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -529,7 +525,7 @@ class AsyncRawServiceApiClient:
 
     async def get_logs(
         self, id: str, *, request_options: typing.Optional[RequestOptions] = None
-    ) -> AsyncHttpResponse[typing.List[str]]:
+    ) -> AsyncHttpResponse[typing.List[LogEntry]]:
         """
         Returns a list of log entries for a service execution in chronological order, where the first entry is the oldest.
 
@@ -543,7 +539,7 @@ class AsyncRawServiceApiClient:
 
         Returns
         -------
-        AsyncHttpResponse[typing.List[str]]
+        AsyncHttpResponse[typing.List[LogEntry]]
             List of log entries
         """
         _response = await self._client_wrapper.httpx_client.request(
@@ -554,9 +550,9 @@ class AsyncRawServiceApiClient:
         try:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
-                    typing.List[str],
-                    parse_obj_as(
-                        type_=typing.List[str],  # type: ignore
+                    typing.List[LogEntry],
+                    construct_type(
+                        type_=typing.List[LogEntry],  # type: ignore
                         object_=_response.json(),
                     ),
                 )
@@ -594,7 +590,7 @@ class AsyncRawServiceApiClient:
             if 200 <= _response.status_code < 300:
                 _data = typing.cast(
                     ServiceExecution,
-                    parse_obj_as(
+                    construct_type(
                         type_=ServiceExecution,  # type: ignore
                         object_=_response.json(),
                     ),

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

@@ -2,8 +2,58 @@
 
 # isort: skip_file
 
-from .hal_link import HalLink
-from .service_execution import ServiceExecution
-from .service_execution_status import ServiceExecutionStatus
+import typing
+from importlib import import_module
 
-__all__ = ["HalLink", "ServiceExecution", "ServiceExecutionStatus"]
+if typing.TYPE_CHECKING:
+    from .hal_link import HalLink
+    from .log_entry import LogEntry
+    from .request_body import RequestBody
+    from .result_response import ResultResponse
+    from .result_response_embedded import ResultResponseEmbedded
+    from .result_response_links import ResultResponseLinks
+    from .service_execution import ServiceExecution
+    from .service_execution_status import ServiceExecutionStatus
+_dynamic_imports: typing.Dict[str, str] = {
+    "HalLink": ".hal_link",
+    "LogEntry": ".log_entry",
+    "RequestBody": ".request_body",
+    "ResultResponse": ".result_response",
+    "ResultResponseEmbedded": ".result_response_embedded",
+    "ResultResponseLinks": ".result_response_links",
+    "ServiceExecution": ".service_execution",
+    "ServiceExecutionStatus": ".service_execution_status",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "HalLink",
+    "LogEntry",
+    "RequestBody",
+    "ResultResponse",
+    "ResultResponseEmbedded",
+    "ResultResponseLinks",
+    "ServiceExecution",
+    "ServiceExecutionStatus",
+]

package/planqk/service/sdk/types/hal_link.py

@@ -3,10 +3,11 @@
 import typing
 
 import pydantic
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
 
 
-class HalLink(UniversalBaseModel):
+class HalLink(UncheckedBaseModel):
     href: typing.Optional[str] = pydantic.Field(default=None)
     """
     The URL of the link

package/planqk/service/sdk/types/log_entry.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class LogEntry(UncheckedBaseModel):
+    message: typing.Optional[str] = None
+    severity: typing.Optional[str] = None
+    timestamp: typing.Optional[dt.datetime] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

package/planqk/service/sdk/types/request_body.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+RequestBody = typing.Dict[str, typing.Optional[typing.Any]]

package/planqk/service/sdk/types/result_response.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .result_response_embedded import ResultResponseEmbedded
+from .result_response_links import ResultResponseLinks
+
+
+class ResultResponse(UncheckedBaseModel):
+    links: typing_extensions.Annotated[typing.Optional[ResultResponseLinks], FieldMetadata(alias="_links")] = None
+    embedded: typing_extensions.Annotated[typing.Optional[ResultResponseEmbedded], FieldMetadata(alias="_embedded")] = (
+        None
+    )
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

package/planqk/service/sdk/{service_api/types/get_result_response_embedded.py → types/result_response_embedded.py}

@@ -3,11 +3,12 @@
 import typing
 
 import pydantic
-from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ...types.service_execution import ServiceExecution
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .service_execution import ServiceExecution
 
 
-class GetResultResponseEmbedded(UniversalBaseModel):
+class ResultResponseEmbedded(UncheckedBaseModel):
     status: typing.Optional[ServiceExecution] = None
 
     if IS_PYDANTIC_V2:

package/planqk/service/sdk/{service_api/types/get_result_response_links.py → types/result_response_links.py}

@@ -3,11 +3,12 @@
 import typing
 
 import pydantic
-from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
-from ...types.hal_link import HalLink
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .hal_link import HalLink
 
 
-class GetResultResponseLinks(UniversalBaseModel):
+class ResultResponseLinks(UncheckedBaseModel):
     status: typing.Optional[HalLink] = None
 
     if IS_PYDANTIC_V2:

package/planqk/service/sdk/types/service_execution.py

@@ -4,12 +4,13 @@ import typing
 
 import pydantic
 import typing_extensions
-from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
 from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
 from .service_execution_status import ServiceExecutionStatus
 
 
-class ServiceExecution(UniversalBaseModel):
+class ServiceExecution(UncheckedBaseModel):
     id: typing.Optional[str] = None
     status: typing.Optional[ServiceExecutionStatus] = None
     created_at: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdAt")] = None

package/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "planqk-service-sdk"
-version = "2.6.2"
+version = "2.7.0"
 description = "SDK to interact with PLANQK Managed Services."
 authors = [
     { name = "Kipu Quantum GmbH", email = "info@kipu-quantum.com" },