@planqk/planqk-service-sdk 2.6.2 → 2.7.0

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

@@ -10,7 +10,7 @@ class BaseClientWrapper:
     def __init__(
         self,
         *,
-        token: typing.Union[str, typing.Callable[[], str]],
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
@@ -25,11 +25,13 @@ class BaseClientWrapper:
             "X-Fern-Language": "Python",
             **(self.get_custom_headers() or {}),
         }
-        headers["Authorization"] = f"Bearer {self._get_token()}"
+        token = self._get_token()
+        if token is not None:
+            headers["Authorization"] = f"Bearer {token}"
         return headers
 
-    def _get_token(self) -> str:
-        if isinstance(self._token, str):
+    def _get_token(self) -> typing.Optional[str]:
+        if isinstance(self._token, str) or self._token is None:
             return self._token
         else:
             return self._token()
@@ -48,7 +50,7 @@ class SyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
-        token: typing.Union[str, typing.Callable[[], str]],
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,
@@ -67,7 +69,7 @@ class AsyncClientWrapper(BaseClientWrapper):
     def __init__(
         self,
         *,
-        token: typing.Union[str, typing.Callable[[], str]],
+        token: typing.Optional[typing.Union[str, typing.Callable[[], str]]] = None,
         headers: typing.Optional[typing.Dict[str, str]] = None,
         base_url: str,
         timeout: typing.Optional[float] = None,

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

@@ -1,7 +1,9 @@
 # This file was auto-generated by Fern from our API Definition.
 
+from typing import Any, Dict
 
-class ForceMultipartDict(dict):
+
+class ForceMultipartDict(Dict[str, Any]):
     """
     A dictionary subclass that always evaluates to True in boolean contexts.
 
@@ -9,7 +11,7 @@ class ForceMultipartDict(dict):
     the dictionary is empty, which would normally evaluate to False.
     """
 
-    def __bool__(self):
+    def __bool__(self) -> bool:
         return True
 
 

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

@@ -4,8 +4,8 @@ from typing import Dict, Generic, TypeVar
 
 import httpx
 
+# Generic to represent the underlying type of the data wrapped by the HTTP response.
 T = TypeVar("T")
-"""Generic to represent the underlying type of the data wrapped by the HTTP response."""
 
 
 class BaseHttpResponse:

package/planqk/service/sdk/core/http_sse/__init__.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from ._api import EventSource, aconnect_sse, connect_sse
+    from ._exceptions import SSEError
+    from ._models import ServerSentEvent
+_dynamic_imports: typing.Dict[str, str] = {
+    "EventSource": "._api",
+    "SSEError": "._exceptions",
+    "ServerSentEvent": "._models",
+    "aconnect_sse": "._api",
+    "connect_sse": "._api",
+}
+
+
+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__ = ["EventSource", "SSEError", "ServerSentEvent", "aconnect_sse", "connect_sse"]

package/planqk/service/sdk/core/http_sse/_api.py

@@ -0,0 +1,112 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import re
+from contextlib import asynccontextmanager, contextmanager
+from typing import Any, AsyncGenerator, AsyncIterator, Iterator, cast
+
+import httpx
+from ._decoders import SSEDecoder
+from ._exceptions import SSEError
+from ._models import ServerSentEvent
+
+
+class EventSource:
+    def __init__(self, response: httpx.Response) -> None:
+        self._response = response
+
+    def _check_content_type(self) -> None:
+        content_type = self._response.headers.get("content-type", "").partition(";")[0]
+        if "text/event-stream" not in content_type:
+            raise SSEError(
+                f"Expected response header Content-Type to contain 'text/event-stream', got {content_type!r}"
+            )
+
+    def _get_charset(self) -> str:
+        """Extract charset from Content-Type header, fallback to UTF-8."""
+        content_type = self._response.headers.get("content-type", "")
+
+        # Parse charset parameter using regex
+        charset_match = re.search(r"charset=([^;\s]+)", content_type, re.IGNORECASE)
+        if charset_match:
+            charset = charset_match.group(1).strip("\"'")
+            # Validate that it's a known encoding
+            try:
+                # Test if the charset is valid by trying to encode/decode
+                "test".encode(charset).decode(charset)
+                return charset
+            except (LookupError, UnicodeError):
+                # If charset is invalid, fall back to UTF-8
+                pass
+
+        # Default to UTF-8 if no charset specified or invalid charset
+        return "utf-8"
+
+    @property
+    def response(self) -> httpx.Response:
+        return self._response
+
+    def iter_sse(self) -> Iterator[ServerSentEvent]:
+        self._check_content_type()
+        decoder = SSEDecoder()
+        charset = self._get_charset()
+
+        buffer = ""
+        for chunk in self._response.iter_bytes():
+            # Decode chunk using detected charset
+            text_chunk = chunk.decode(charset, errors="replace")
+            buffer += text_chunk
+
+            # Process complete lines
+            while "\n" in buffer:
+                line, buffer = buffer.split("\n", 1)
+                line = line.rstrip("\r")
+                sse = decoder.decode(line)
+                # when we reach a "\n\n" => line = ''
+                # => decoder will attempt to return an SSE Event
+                if sse is not None:
+                    yield sse
+
+        # Process any remaining data in buffer
+        if buffer.strip():
+            line = buffer.rstrip("\r")
+            sse = decoder.decode(line)
+            if sse is not None:
+                yield sse
+
+    async def aiter_sse(self) -> AsyncGenerator[ServerSentEvent, None]:
+        self._check_content_type()
+        decoder = SSEDecoder()
+        lines = cast(AsyncGenerator[str, None], self._response.aiter_lines())
+        try:
+            async for line in lines:
+                line = line.rstrip("\n")
+                sse = decoder.decode(line)
+                if sse is not None:
+                    yield sse
+        finally:
+            await lines.aclose()
+
+
+@contextmanager
+def connect_sse(client: httpx.Client, method: str, url: str, **kwargs: Any) -> Iterator[EventSource]:
+    headers = kwargs.pop("headers", {})
+    headers["Accept"] = "text/event-stream"
+    headers["Cache-Control"] = "no-store"
+
+    with client.stream(method, url, headers=headers, **kwargs) as response:
+        yield EventSource(response)
+
+
+@asynccontextmanager
+async def aconnect_sse(
+    client: httpx.AsyncClient,
+    method: str,
+    url: str,
+    **kwargs: Any,
+) -> AsyncIterator[EventSource]:
+    headers = kwargs.pop("headers", {})
+    headers["Accept"] = "text/event-stream"
+    headers["Cache-Control"] = "no-store"
+
+    async with client.stream(method, url, headers=headers, **kwargs) as response:
+        yield EventSource(response)

package/planqk/service/sdk/core/http_sse/_decoders.py

@@ -0,0 +1,61 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from typing import List, Optional
+
+from ._models import ServerSentEvent
+
+
+class SSEDecoder:
+    def __init__(self) -> None:
+        self._event = ""
+        self._data: List[str] = []
+        self._last_event_id = ""
+        self._retry: Optional[int] = None
+
+    def decode(self, line: str) -> Optional[ServerSentEvent]:
+        # See: https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation  # noqa: E501
+
+        if not line:
+            if not self._event and not self._data and not self._last_event_id and self._retry is None:
+                return None
+
+            sse = ServerSentEvent(
+                event=self._event,
+                data="\n".join(self._data),
+                id=self._last_event_id,
+                retry=self._retry,
+            )
+
+            # NOTE: as per the SSE spec, do not reset last_event_id.
+            self._event = ""
+            self._data = []
+            self._retry = None
+
+            return sse
+
+        if line.startswith(":"):
+            return None
+
+        fieldname, _, value = line.partition(":")
+
+        if value.startswith(" "):
+            value = value[1:]
+
+        if fieldname == "event":
+            self._event = value
+        elif fieldname == "data":
+            self._data.append(value)
+        elif fieldname == "id":
+            if "\0" in value:
+                pass
+            else:
+                self._last_event_id = value
+        elif fieldname == "retry":
+            try:
+                self._retry = int(value)
+            except (TypeError, ValueError):
+                pass
+        else:
+            pass  # Field is ignored.
+
+        return None

package/planqk/service/sdk/core/http_sse/_exceptions.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import httpx
+
+
+class SSEError(httpx.TransportError):
+    pass

package/planqk/service/sdk/core/http_sse/_models.py

@@ -0,0 +1,17 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import json
+from dataclasses import dataclass
+from typing import Any, Optional
+
+
+@dataclass(frozen=True)
+class ServerSentEvent:
+    event: str = "message"
+    data: str = ""
+    id: str = ""
+    retry: Optional[int] = None
+
+    def json(self) -> Any:
+        """Parse the data field as JSON."""
+        return json.loads(self.data)

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

@@ -61,7 +61,7 @@ class UniversalBaseModel(pydantic.BaseModel):
 
         @pydantic.model_serializer(mode="plain", when_used="json")  # type: ignore[attr-defined]
         def serialize_model(self) -> Any:  # type: ignore[name-defined]
-            serialized = self.model_dump()
+            serialized = self.dict()  # type: ignore[attr-defined]
             data = {k: serialize_datetime(v) if isinstance(v, dt.datetime) else v for k, v in serialized.items()}
             return data
 
@@ -147,7 +147,10 @@ class UniversalBaseModel(pydantic.BaseModel):
 
             dict_dump = super().dict(**kwargs_with_defaults_exclude_unset_include_fields)
 
-        return convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write")
+        return cast(
+            Dict[str, Any],
+            convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write"),
+        )
 
 
 def _union_list_of_pydantic_dicts(source: List[Any], destination: List[Any]) -> List[Any]:

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

@@ -0,0 +1,341 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import inspect
+import typing
+import uuid
+
+import pydantic
+import typing_extensions
+from .pydantic_utilities import (
+    IS_PYDANTIC_V2,
+    ModelField,
+    UniversalBaseModel,
+    get_args,
+    get_origin,
+    is_literal_type,
+    is_union,
+    parse_date,
+    parse_datetime,
+    parse_obj_as,
+)
+from .serialization import get_field_to_alias_mapping
+from pydantic_core import PydanticUndefined
+
+
+class UnionMetadata:
+    discriminant: str
+
+    def __init__(self, *, discriminant: str) -> None:
+        self.discriminant = discriminant
+
+
+Model = typing.TypeVar("Model", bound=pydantic.BaseModel)
+
+
+class UncheckedBaseModel(UniversalBaseModel):
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow")  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            extra = pydantic.Extra.allow
+
+    @classmethod
+    def model_construct(
+        cls: typing.Type["Model"],
+        _fields_set: typing.Optional[typing.Set[str]] = None,
+        **values: typing.Any,
+    ) -> "Model":
+        # Fallback construct function to the specified override below.
+        return cls.construct(_fields_set=_fields_set, **values)
+
+    # Allow construct to not validate model
+    # Implementation taken from: https://github.com/pydantic/pydantic/issues/1168#issuecomment-817742836
+    @classmethod
+    def construct(
+        cls: typing.Type["Model"],
+        _fields_set: typing.Optional[typing.Set[str]] = None,
+        **values: typing.Any,
+    ) -> "Model":
+        m = cls.__new__(cls)
+        fields_values = {}
+
+        if _fields_set is None:
+            _fields_set = set(values.keys())
+
+        fields = _get_model_fields(cls)
+        populate_by_name = _get_is_populate_by_name(cls)
+        field_aliases = get_field_to_alias_mapping(cls)
+
+        for name, field in fields.items():
+            # Key here is only used to pull data from the values dict
+            # you should always use the NAME of the field to for field_values, etc.
+            # because that's how the object is constructed from a pydantic perspective
+            key = field.alias
+            if (key is None or field.alias == name) and name in field_aliases:
+                key = field_aliases[name]
+
+            if key is None or (key not in values and populate_by_name):  # Added this to allow population by field name
+                key = name
+
+            if key in values:
+                if IS_PYDANTIC_V2:
+                    type_ = field.annotation  # type: ignore # Pydantic v2
+                else:
+                    type_ = typing.cast(typing.Type, field.outer_type_)  # type: ignore # Pydantic < v1.10.15
+
+                fields_values[name] = (
+                    construct_type(object_=values[key], type_=type_) if type_ is not None else values[key]
+                )
+                _fields_set.add(name)
+            else:
+                default = _get_field_default(field)
+                fields_values[name] = default
+
+                # If the default values are non-null act like they've been set
+                # This effectively allows exclude_unset to work like exclude_none where
+                # the latter passes through intentionally set none values.
+                if default != None and default != PydanticUndefined:
+                    _fields_set.add(name)
+
+        # Add extras back in
+        extras = {}
+        pydantic_alias_fields = [field.alias for field in fields.values()]
+        internal_alias_fields = list(field_aliases.values())
+        for key, value in values.items():
+            # If the key is not a field by name, nor an alias to a field, then it's extra
+            if (key not in pydantic_alias_fields and key not in internal_alias_fields) and key not in fields:
+                if IS_PYDANTIC_V2:
+                    extras[key] = value
+                else:
+                    _fields_set.add(key)
+                    fields_values[key] = value
+
+        object.__setattr__(m, "__dict__", fields_values)
+
+        if IS_PYDANTIC_V2:
+            object.__setattr__(m, "__pydantic_private__", None)
+            object.__setattr__(m, "__pydantic_extra__", extras)
+            object.__setattr__(m, "__pydantic_fields_set__", _fields_set)
+        else:
+            object.__setattr__(m, "__fields_set__", _fields_set)
+            m._init_private_attributes()  # type: ignore # Pydantic v1
+        return m
+
+
+def _validate_collection_items_compatible(collection: typing.Any, target_type: typing.Type[typing.Any]) -> bool:
+    """
+    Validate that all items in a collection are compatible with the target type.
+
+    Args:
+        collection: The collection to validate (list, set, or dict values)
+        target_type: The target type to validate against
+
+    Returns:
+        True if all items are compatible, False otherwise
+    """
+    if inspect.isclass(target_type) and issubclass(target_type, pydantic.BaseModel):
+        for item in collection:
+            try:
+                # Try to validate the item against the target type
+                if isinstance(item, dict):
+                    parse_obj_as(target_type, item)
+                else:
+                    # If it's not a dict, it might already be the right type
+                    if not isinstance(item, target_type):
+                        return False
+            except Exception:
+                return False
+    return True
+
+
+def _convert_undiscriminated_union_type(union_type: typing.Type[typing.Any], object_: typing.Any) -> typing.Any:
+    inner_types = get_args(union_type)
+    if typing.Any in inner_types:
+        return object_
+
+    for inner_type in inner_types:
+        # Handle lists of objects that need parsing
+        if get_origin(inner_type) is list and isinstance(object_, list):
+            list_inner_type = get_args(inner_type)[0]
+            try:
+                if inspect.isclass(list_inner_type) and issubclass(list_inner_type, pydantic.BaseModel):
+                    # Validate that all items in the list are compatible with the target type
+                    if _validate_collection_items_compatible(object_, list_inner_type):
+                        parsed_list = [parse_obj_as(object_=item, type_=list_inner_type) for item in object_]
+                        return parsed_list
+            except Exception:
+                pass
+
+        try:
+            if inspect.isclass(inner_type) and issubclass(inner_type, pydantic.BaseModel):
+                # Attempt a validated parse until one works
+                return parse_obj_as(inner_type, object_)
+        except Exception:
+            continue
+
+    # If none of the types work, just return the first successful cast
+    for inner_type in inner_types:
+        try:
+            return construct_type(object_=object_, type_=inner_type)
+        except Exception:
+            continue
+
+
+def _convert_union_type(type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any:
+    base_type = get_origin(type_) or type_
+    union_type = type_
+    if base_type == typing_extensions.Annotated:  # type: ignore[comparison-overlap]
+        union_type = get_args(type_)[0]
+        annotated_metadata = get_args(type_)[1:]
+        for metadata in annotated_metadata:
+            if isinstance(metadata, UnionMetadata):
+                try:
+                    # Cast to the correct type, based on the discriminant
+                    for inner_type in get_args(union_type):
+                        try:
+                            objects_discriminant = getattr(object_, metadata.discriminant)
+                        except:
+                            objects_discriminant = object_[metadata.discriminant]
+                        if inner_type.__fields__[metadata.discriminant].default == objects_discriminant:
+                            return construct_type(object_=object_, type_=inner_type)
+                except Exception:
+                    # Allow to fall through to our regular union handling
+                    pass
+    return _convert_undiscriminated_union_type(union_type, object_)
+
+
+def construct_type(*, type_: typing.Type[typing.Any], object_: typing.Any) -> typing.Any:
+    """
+    Here we are essentially creating the same `construct` method in spirit as the above, but for all types, not just
+    Pydantic models.
+    The idea is to essentially attempt to coerce object_ to type_ (recursively)
+    """
+    # Short circuit when dealing with optionals, don't try to coerces None to a type
+    if object_ is None:
+        return None
+
+    base_type = get_origin(type_) or type_
+    is_annotated = base_type == typing_extensions.Annotated  # type: ignore[comparison-overlap]
+    maybe_annotation_members = get_args(type_)
+    is_annotated_union = is_annotated and is_union(get_origin(maybe_annotation_members[0]))
+
+    if base_type == typing.Any:  # type: ignore[comparison-overlap]
+        return object_
+
+    if base_type == dict:
+        if not isinstance(object_, typing.Mapping):
+            return object_
+
+        key_type, items_type = get_args(type_)
+        d = {
+            construct_type(object_=key, type_=key_type): construct_type(object_=item, type_=items_type)
+            for key, item in object_.items()
+        }
+        return d
+
+    if base_type == list:
+        if not isinstance(object_, list):
+            return object_
+
+        inner_type = get_args(type_)[0]
+        return [construct_type(object_=entry, type_=inner_type) for entry in object_]
+
+    if base_type == set:
+        if not isinstance(object_, set) and not isinstance(object_, list):
+            return object_
+
+        inner_type = get_args(type_)[0]
+        return {construct_type(object_=entry, type_=inner_type) for entry in object_}
+
+    if is_union(base_type) or is_annotated_union:
+        return _convert_union_type(type_, object_)
+
+    # Cannot do an `issubclass` with a literal type, let's also just confirm we have a class before this call
+    if (
+        object_ is not None
+        and not is_literal_type(type_)
+        and (
+            (inspect.isclass(base_type) and issubclass(base_type, pydantic.BaseModel))
+            or (
+                is_annotated
+                and inspect.isclass(maybe_annotation_members[0])
+                and issubclass(maybe_annotation_members[0], pydantic.BaseModel)
+            )
+        )
+    ):
+        if IS_PYDANTIC_V2:
+            return type_.model_construct(**object_)
+        else:
+            return type_.construct(**object_)
+
+    if base_type == dt.datetime:
+        try:
+            return parse_datetime(object_)
+        except Exception:
+            return object_
+
+    if base_type == dt.date:
+        try:
+            return parse_date(object_)
+        except Exception:
+            return object_
+
+    if base_type == uuid.UUID:
+        try:
+            return uuid.UUID(object_)
+        except Exception:
+            return object_
+
+    if base_type == int:
+        try:
+            return int(object_)
+        except Exception:
+            return object_
+
+    if base_type == bool:
+        try:
+            if isinstance(object_, str):
+                stringified_object = object_.lower()
+                return stringified_object == "true" or stringified_object == "1"
+
+            return bool(object_)
+        except Exception:
+            return object_
+
+    return object_
+
+
+def _get_is_populate_by_name(model: typing.Type["Model"]) -> bool:
+    if IS_PYDANTIC_V2:
+        return model.model_config.get("populate_by_name", False)  # type: ignore # Pydantic v2
+    return model.__config__.allow_population_by_field_name  # type: ignore # Pydantic v1
+
+
+PydanticField = typing.Union[ModelField, pydantic.fields.FieldInfo]
+
+
+# Pydantic V1 swapped the typing of __fields__'s values from ModelField to FieldInfo
+# And so we try to handle both V1 cases, as well as V2 (FieldInfo from model.model_fields)
+def _get_model_fields(
+    model: typing.Type["Model"],
+) -> typing.Mapping[str, PydanticField]:
+    if IS_PYDANTIC_V2:
+        return model.model_fields  # type: ignore # Pydantic v2
+    else:
+        return model.__fields__  # type: ignore # Pydantic v1
+
+
+def _get_field_default(field: PydanticField) -> typing.Any:
+    try:
+        value = field.get_default()  # type: ignore # Pydantic < v1.10.15
+    except:
+        value = field.default
+    if IS_PYDANTIC_V2:
+        from pydantic_core import PydanticUndefined
+
+        if value == PydanticUndefined:
+            return None
+        return value
+    return value

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

@@ -2,6 +2,3 @@
 
 # isort: skip_file
 
-from .types import GetResultResponse, GetResultResponseEmbedded, GetResultResponseLinks
-
-__all__ = ["GetResultResponse", "GetResultResponseEmbedded", "GetResultResponseLinks"]