@planqk/planqk-service-sdk 2.2.1 → 2.4.0

package/planqk/service/sdk/core/client_wrapper.py

@@ -1,9 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
+
 import httpx
-from .http_client import HttpClient
-from .http_client import AsyncHttpClient
+from .http_client import AsyncHttpClient, HttpClient
 
 
 class BaseClientWrapper:
@@ -11,16 +11,19 @@ class BaseClientWrapper:
         self,
         *,
         token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
     ):
         self._token = token
+        self._headers = headers
         self._base_url = base_url
         self._timeout = timeout
 
     def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
+            **(self.get_custom_headers() or {}),
         }
         headers["Authorization"] = f"Bearer {self._get_token()}"
         return headers
@@ -31,6 +34,9 @@ class BaseClientWrapper:
         else:
             return self._token()
 
+    def get_custom_headers(self) -> typing.Optional[typing.Dict[str, str]]:
+        return self._headers
+
     def get_base_url(self) -> str:
         return self._base_url
 
@@ -43,11 +49,12 @@ class SyncClientWrapper(BaseClientWrapper):
         self,
         *,
         token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         httpx_client: httpx.Client,
     ):
-        super().__init__(token=token, base_url=base_url, timeout=timeout)
+        super().__init__(token=token, headers=headers, base_url=base_url, timeout=timeout)
         self.httpx_client = HttpClient(
             httpx_client=httpx_client,
             base_headers=self.get_headers,
@@ -61,11 +68,12 @@ class AsyncClientWrapper(BaseClientWrapper):
         self,
         *,
         token: typing.Union[str, typing.Callable[[], str]],
+        headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
         httpx_client: httpx.AsyncClient,
     ):
-        super().__init__(token=token, base_url=base_url, timeout=timeout)
+        super().__init__(token=token, headers=headers, base_url=base_url, timeout=timeout)
         self.httpx_client = AsyncHttpClient(
             httpx_client=httpx_client,
             base_headers=self.get_headers,

package/planqk/service/sdk/core/datetime_utils.py

@@ -13,9 +13,7 @@ def serialize_datetime(v: dt.datetime) -> str:
     """
 
     def _serialize_zoned_datetime(v: dt.datetime) -> str:
-        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(
-            None
-        ):
+        if v.tzinfo is not None and v.tzinfo.tzname(None) == dt.timezone.utc.tzname(None):
             # UTC is a special case where we use "Z" at the end instead of "+00:00"
             return v.isoformat().replace("+00:00", "Z")
         else:

package/planqk/service/sdk/core/file.py

@@ -53,15 +53,12 @@ def with_content_type(*, file: File, default_content_type: str) -> File:
             filename, content = cast(Tuple[Optional[str], FileContent], file)  # type: ignore
             return (filename, content, default_content_type)
         elif len(file) == 3:
-            filename, content, file_content_type = cast(
-                Tuple[Optional[str], FileContent, Optional[str]], file
-            )  # type: ignore
+            filename, content, file_content_type = cast(Tuple[Optional[str], FileContent, Optional[str]], file)  # type: ignore
             out_content_type = file_content_type or default_content_type
             return (filename, content, out_content_type)
         elif len(file) == 4:
             filename, content, file_content_type, headers = cast(  # type: ignore
-                Tuple[Optional[str], FileContent, Optional[str], Mapping[str, str]],
-                file,
+                Tuple[Optional[str], FileContent, Optional[str], Mapping[str, str]], file
             )
             out_content_type = file_content_type or default_content_type
             return (filename, content, out_content_type, headers)

package/planqk/service/sdk/core/force_multipart.py

@@ -0,0 +1,16 @@
+# This file was auto-generated by Fern from our API Definition.
+
+
+class ForceMultipartDict(dict):
+    """
+    A dictionary subclass that always evaluates to True in boolean contexts.
+
+    This is used to force multipart/form-data encoding in HTTP requests even when
+    the dictionary is empty, which would normally evaluate to False.
+    """
+
+    def __bool__(self):
+        return True
+
+
+FORCE_MULTIPART = ForceMultipartDict()

package/planqk/service/sdk/core/http_client.py

@@ -2,7 +2,6 @@
 
 import asyncio
 import email.utils
-import json
 import re
 import time
 import typing
@@ -11,12 +10,13 @@ from contextlib import asynccontextmanager, contextmanager
 from random import random
 
 import httpx
-
 from .file import File, convert_file_dict_to_httpx_tuples
+from .force_multipart import FORCE_MULTIPART
 from .jsonable_encoder import jsonable_encoder
 from .query_encoder import encode_query
 from .remove_none_from_dict import remove_none_from_dict
 from .request_options import RequestOptions
+from httpx._types import RequestFiles
 
 INITIAL_RETRY_DELAY_SECONDS = 0.5
 MAX_RETRY_DELAY_SECONDS = 10
@@ -77,9 +77,7 @@ def _retry_timeout(response: httpx.Response, retries: int) -> float:
         return retry_after
 
     # Apply exponential backoff, capped at MAX_RETRY_DELAY_SECONDS.
-    retry_delay = min(
-        INITIAL_RETRY_DELAY_SECONDS * pow(2.0, retries), MAX_RETRY_DELAY_SECONDS
-    )
+    retry_delay = min(INITIAL_RETRY_DELAY_SECONDS * pow(2.0, retries), MAX_RETRY_DELAY_SECONDS)
 
     # Add a randomness / jitter to the retry delay to avoid overwhelming the server with retries.
     timeout = retry_delay * (1 - 0.25 * random())
@@ -111,8 +109,7 @@ def maybe_filter_request_body(
 ) -> typing.Optional[typing.Any]:
     if data is None:
         return (
-            jsonable_encoder(request_options.get("additional_body_parameters", {}))
-            or {}
+            jsonable_encoder(request_options.get("additional_body_parameters", {})) or {}
             if request_options is not None
             else None
         )
@@ -122,8 +119,7 @@ def maybe_filter_request_body(
         data_content = {
             **(jsonable_encoder(remove_omit_from_dict(data, omit))),  # type: ignore
             **(
-                jsonable_encoder(request_options.get("additional_body_parameters", {}))
-                or {}
+                jsonable_encoder(request_options.get("additional_body_parameters", {})) or {}
                 if request_options is not None
                 else {}
             ),
@@ -148,9 +144,7 @@ def get_request_body(
         json_body = maybe_filter_request_body(json, request_options, omit)
 
     # If you have an empty JSON body, you should just send None
-    return (
-        json_body if json_body != {} else None
-    ), data_body if data_body != {} else None
+    return (json_body if json_body != {} else None), data_body if data_body != {} else None
 
 
 class HttpClient:
@@ -173,9 +167,7 @@ class HttpClient:
             base_url = self.base_url()
 
         if base_url is None:
-            raise ValueError(
-                "A base_url is required to make this request, please provide one and try again."
-            )
+            raise ValueError("A base_url is required to make this request, please provide one and try again.")
         return base_url
 
     def request(
@@ -187,29 +179,37 @@ class HttpClient:
         params: typing.Optional[typing.Dict[str, typing.Any]] = None,
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
-        content: typing.Optional[
-            typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]
-        ] = None,
+        content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
         files: typing.Optional[
-            typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
         ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
         retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> httpx.Response:
         base_url = self.get_base_url(base_url)
         timeout = (
             request_options.get("timeout_in_seconds")
-            if request_options is not None
-            and request_options.get("timeout_in_seconds") is not None
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
             else self.base_timeout()
         )
 
-        json_body, data_body = get_request_body(
-            json=json, data=data, request_options=request_options, omit=omit
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
         )
 
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
         response = self.httpx_client.request(
             method=method,
             url=urllib.parse.urljoin(f"{base_url}/", path),
@@ -218,11 +218,7 @@ class HttpClient:
                     {
                         **self.base_headers(),
                         **(headers if headers is not None else {}),
-                        **(
-                            request_options.get("additional_headers", {}) or {}
-                            if request_options is not None
-                            else {}
-                        ),
+                        **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}),
                     }
                 )
             ),
@@ -233,10 +229,7 @@ class HttpClient:
                             {
                                 **(params if params is not None else {}),
                                 **(
-                                    request_options.get(
-                                        "additional_query_parameters", {}
-                                    )
-                                    or {}
+                                    request_options.get("additional_query_parameters", {}) or {}
                                     if request_options is not None
                                     else {}
                                 ),
@@ -249,19 +242,11 @@ class HttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(
-                    remove_omit_from_dict(remove_none_from_dict(files), omit)
-                )
-                if (files is not None and files is not omit)
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         )
 
-        max_retries: int = (
-            request_options.get("max_retries", 0) if request_options is not None else 0
-        )
+        max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0
         if _should_retry(response=response):
             if max_retries > retries:
                 time.sleep(_retry_timeout(response=response, retries=retries))
@@ -291,29 +276,37 @@ class HttpClient:
         params: typing.Optional[typing.Dict[str, typing.Any]] = None,
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
-        content: typing.Optional[
-            typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]
-        ] = None,
+        content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
         files: typing.Optional[
-            typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
         ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
         retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> typing.Iterator[httpx.Response]:
         base_url = self.get_base_url(base_url)
         timeout = (
             request_options.get("timeout_in_seconds")
-            if request_options is not None
-            and request_options.get("timeout_in_seconds") is not None
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
             else self.base_timeout()
         )
 
-        json_body, data_body = get_request_body(
-            json=json, data=data, request_options=request_options, omit=omit
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
         )
 
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
         with self.httpx_client.stream(
             method=method,
             url=urllib.parse.urljoin(f"{base_url}/", path),
@@ -322,11 +315,7 @@ class HttpClient:
                     {
                         **self.base_headers(),
                         **(headers if headers is not None else {}),
-                        **(
-                            request_options.get("additional_headers", {})
-                            if request_options is not None
-                            else {}
-                        ),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
                     }
                 )
             ),
@@ -337,9 +326,7 @@ class HttpClient:
                             {
                                 **(params if params is not None else {}),
                                 **(
-                                    request_options.get(
-                                        "additional_query_parameters", {}
-                                    )
+                                    request_options.get("additional_query_parameters", {})
                                     if request_options is not None
                                     else {}
                                 ),
@@ -352,13 +339,7 @@ class HttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(
-                    remove_omit_from_dict(remove_none_from_dict(files), omit)
-                )
-                if (files is not None and files is not omit)
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         ) as stream:
             yield stream
@@ -384,9 +365,7 @@ class AsyncHttpClient:
             base_url = self.base_url()
 
         if base_url is None:
-            raise ValueError(
-                "A base_url is required to make this request, please provide one and try again."
-            )
+            raise ValueError("A base_url is required to make this request, please provide one and try again.")
         return base_url
 
     async def request(
@@ -398,29 +377,37 @@ class AsyncHttpClient:
         params: typing.Optional[typing.Dict[str, typing.Any]] = None,
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
-        content: typing.Optional[
-            typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]
-        ] = None,
+        content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
         files: typing.Optional[
-            typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
         ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
         retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> httpx.Response:
         base_url = self.get_base_url(base_url)
         timeout = (
             request_options.get("timeout_in_seconds")
-            if request_options is not None
-            and request_options.get("timeout_in_seconds") is not None
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
             else self.base_timeout()
         )
 
-        json_body, data_body = get_request_body(
-            json=json, data=data, request_options=request_options, omit=omit
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
         )
 
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
         # Add the input to each of these and do None-safety checks
         response = await self.httpx_client.request(
             method=method,
@@ -430,11 +417,7 @@ class AsyncHttpClient:
                     {
                         **self.base_headers(),
                         **(headers if headers is not None else {}),
-                        **(
-                            request_options.get("additional_headers", {}) or {}
-                            if request_options is not None
-                            else {}
-                        ),
+                        **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}),
                     }
                 )
             ),
@@ -445,10 +428,7 @@ class AsyncHttpClient:
                             {
                                 **(params if params is not None else {}),
                                 **(
-                                    request_options.get(
-                                        "additional_query_parameters", {}
-                                    )
-                                    or {}
+                                    request_options.get("additional_query_parameters", {}) or {}
                                     if request_options is not None
                                     else {}
                                 ),
@@ -461,19 +441,11 @@ class AsyncHttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(
-                    remove_omit_from_dict(remove_none_from_dict(files), omit)
-                )
-                if files is not None
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         )
 
-        max_retries: int = (
-            request_options.get("max_retries", 0) if request_options is not None else 0
-        )
+        max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0
         if _should_retry(response=response):
             if max_retries > retries:
                 await asyncio.sleep(_retry_timeout(response=response, retries=retries))
@@ -502,29 +474,37 @@ class AsyncHttpClient:
         params: typing.Optional[typing.Dict[str, typing.Any]] = None,
         json: typing.Optional[typing.Any] = None,
         data: typing.Optional[typing.Any] = None,
-        content: typing.Optional[
-            typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]
-        ] = None,
+        content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None,
         files: typing.Optional[
-            typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]
+            typing.Union[
+                typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]],
+                typing.List[typing.Tuple[str, File]],
+            ]
         ] = None,
         headers: typing.Optional[typing.Dict[str, typing.Any]] = None,
         request_options: typing.Optional[RequestOptions] = None,
         retries: int = 2,
         omit: typing.Optional[typing.Any] = None,
+        force_multipart: typing.Optional[bool] = None,
     ) -> typing.AsyncIterator[httpx.Response]:
         base_url = self.get_base_url(base_url)
         timeout = (
             request_options.get("timeout_in_seconds")
-            if request_options is not None
-            and request_options.get("timeout_in_seconds") is not None
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
             else self.base_timeout()
         )
 
-        json_body, data_body = get_request_body(
-            json=json, data=data, request_options=request_options, omit=omit
+        request_files: typing.Optional[RequestFiles] = (
+            convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit))
+            if (files is not None and files is not omit and isinstance(files, dict))
+            else None
         )
 
+        if (request_files is None or len(request_files) == 0) and force_multipart:
+            request_files = FORCE_MULTIPART
+
+        json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit)
+
         async with self.httpx_client.stream(
             method=method,
             url=urllib.parse.urljoin(f"{base_url}/", path),
@@ -533,11 +513,7 @@ class AsyncHttpClient:
                     {
                         **self.base_headers(),
                         **(headers if headers is not None else {}),
-                        **(
-                            request_options.get("additional_headers", {})
-                            if request_options is not None
-                            else {}
-                        ),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
                     }
                 )
             ),
@@ -548,9 +524,7 @@ class AsyncHttpClient:
                             {
                                 **(params if params is not None else {}),
                                 **(
-                                    request_options.get(
-                                        "additional_query_parameters", {}
-                                    )
+                                    request_options.get("additional_query_parameters", {})
                                     if request_options is not None
                                     else {}
                                 ),
@@ -563,13 +537,7 @@ class AsyncHttpClient:
             json=json_body,
             data=data_body,
             content=content,
-            files=(
-                convert_file_dict_to_httpx_tuples(
-                    remove_omit_from_dict(remove_none_from_dict(files), omit)
-                )
-                if files is not None
-                else None
-            ),
+            files=request_files,
             timeout=timeout,
         ) as stream:
             yield stream

package/planqk/service/sdk/core/http_response.py

@@ -0,0 +1,55 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import Dict, Generic, TypeVar
+
+import httpx
+
+T = TypeVar("T")
+"""Generic to represent the underlying type of the data wrapped by the HTTP response."""
+
+
+class BaseHttpResponse:
+    """Minimalist HTTP response wrapper that exposes response headers."""
+
+    _response: httpx.Response
+
+    def __init__(self, response: httpx.Response):
+        self._response = response
+
+    @property
+    def headers(self) -> Dict[str, str]:
+        return dict(self._response.headers)
+
+
+class HttpResponse(Generic[T], BaseHttpResponse):
+    """HTTP response wrapper that exposes response headers and data."""
+
+    _data: T
+
+    def __init__(self, response: httpx.Response, data: T):
+        super().__init__(response)
+        self._data = data
+
+    @property
+    def data(self) -> T:
+        return self._data
+
+    def close(self) -> None:
+        self._response.close()
+
+
+class AsyncHttpResponse(Generic[T], BaseHttpResponse):
+    """HTTP response wrapper that exposes response headers and data."""
+
+    _data: T
+
+    def __init__(self, response: httpx.Response, data: T):
+        super().__init__(response)
+        self._data = data
+
+    @property
+    def data(self) -> T:
+        return self._data
+
+    async def close(self) -> None:
+        await self._response.aclose()

package/planqk/service/sdk/core/jsonable_encoder.py

@@ -17,7 +17,6 @@ from types import GeneratorType
 from typing import Any, Callable, Dict, List, Optional, Set, Union
 
 import pydantic
-
 from .datetime_utils import serialize_datetime
 from .pydantic_utilities import (
     IS_PYDANTIC_V2,
@@ -29,9 +28,7 @@ SetIntStr = Set[Union[int, str]]
 DictIntStrAny = Dict[Union[int, str], Any]
 
 
-def jsonable_encoder(
-    obj: Any, custom_encoder: Optional[Dict[Any, Callable[[Any], Any]]] = None
-) -> Any:
+def jsonable_encoder(obj: Any, custom_encoder: Optional[Dict[Any, Callable[[Any], Any]]] = None) -> Any:
     custom_encoder = custom_encoder or {}
     if custom_encoder:
         if type(obj) in custom_encoder: