@planqk/planqk-service-sdk 2.2.1 → 2.4.0

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

@@ -2,98 +2,67 @@
 
 # nopycln: file
 import datetime as dt
-import typing
 from collections import defaultdict
-
-import typing_extensions
+from typing import Any, Callable, ClassVar, Dict, List, Mapping, Optional, Set, Tuple, Type, TypeVar, Union, cast
 
 import pydantic
 
-from .datetime_utils import serialize_datetime
-from .serialization import convert_and_respect_annotation_metadata
-
 IS_PYDANTIC_V2 = pydantic.VERSION.startswith("2.")
 
 if IS_PYDANTIC_V2:
-    # isort will try to reformat the comments on these imports, which breaks mypy
-    # isort: off
-    from pydantic.v1.datetime_parse import (  # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2
-        parse_date as parse_date,
-    )
-    from pydantic.v1.datetime_parse import (  # pyright: ignore[reportMissingImports] # Pydantic v2
-        parse_datetime as parse_datetime,
-    )
-    from pydantic.v1.json import (  # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2
-        ENCODERS_BY_TYPE as encoders_by_type,
-    )
-    from pydantic.v1.typing import (  # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2
-        get_args as get_args,
-    )
-    from pydantic.v1.typing import (  # pyright: ignore[reportMissingImports] # Pydantic v2
-        get_origin as get_origin,
-    )
-    from pydantic.v1.typing import (  # pyright: ignore[reportMissingImports] # Pydantic v2
-        is_literal_type as is_literal_type,
-    )
-    from pydantic.v1.typing import (  # pyright: ignore[reportMissingImports] # Pydantic v2
-        is_union as is_union,
-    )
-    from pydantic.v1.fields import ModelField as ModelField  # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2
+    from pydantic.v1.datetime_parse import parse_date as parse_date
+    from pydantic.v1.datetime_parse import parse_datetime as parse_datetime
+    from pydantic.v1.fields import ModelField as ModelField
+    from pydantic.v1.json import ENCODERS_BY_TYPE as encoders_by_type  # type: ignore[attr-defined]
+    from pydantic.v1.typing import get_args as get_args
+    from pydantic.v1.typing import get_origin as get_origin
+    from pydantic.v1.typing import is_literal_type as is_literal_type
+    from pydantic.v1.typing import is_union as is_union
 else:
-    from pydantic.datetime_parse import parse_date as parse_date  # type: ignore # Pydantic v1
-    from pydantic.datetime_parse import parse_datetime as parse_datetime  # type: ignore # Pydantic v1
-    from pydantic.fields import ModelField as ModelField  # type: ignore # Pydantic v1
-    from pydantic.json import ENCODERS_BY_TYPE as encoders_by_type  # type: ignore # Pydantic v1
-    from pydantic.typing import get_args as get_args  # type: ignore # Pydantic v1
-    from pydantic.typing import get_origin as get_origin  # type: ignore # Pydantic v1
-    from pydantic.typing import is_literal_type as is_literal_type  # type: ignore # Pydantic v1
-    from pydantic.typing import is_union as is_union  # type: ignore # Pydantic v1
-
-    # isort: on
+    from pydantic.datetime_parse import parse_date as parse_date  # type: ignore[no-redef]
+    from pydantic.datetime_parse import parse_datetime as parse_datetime  # type: ignore[no-redef]
+    from pydantic.fields import ModelField as ModelField  # type: ignore[attr-defined, no-redef]
+    from pydantic.json import ENCODERS_BY_TYPE as encoders_by_type  # type: ignore[no-redef]
+    from pydantic.typing import get_args as get_args  # type: ignore[no-redef]
+    from pydantic.typing import get_origin as get_origin  # type: ignore[no-redef]
+    from pydantic.typing import is_literal_type as is_literal_type  # type: ignore[no-redef]
+    from pydantic.typing import is_union as is_union  # type: ignore[no-redef]
 
+from .datetime_utils import serialize_datetime
+from .serialization import convert_and_respect_annotation_metadata
+from typing_extensions import TypeAlias
 
-T = typing.TypeVar("T")
-Model = typing.TypeVar("Model", bound=pydantic.BaseModel)
+T = TypeVar("T")
+Model = TypeVar("Model", bound=pydantic.BaseModel)
 
 
-def parse_obj_as(type_: typing.Type[T], object_: typing.Any) -> T:
-    dealiased_object = convert_and_respect_annotation_metadata(
-        object_=object_, annotation=type_, direction="read"
-    )
+def parse_obj_as(type_: Type[T], object_: Any) -> T:
+    dealiased_object = convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read")
     if IS_PYDANTIC_V2:
-        adapter = pydantic.TypeAdapter(type_)  # type: ignore # Pydantic v2
+        adapter = pydantic.TypeAdapter(type_)  # type: ignore[attr-defined]
         return adapter.validate_python(dealiased_object)
-    else:
-        return pydantic.parse_obj_as(type_, dealiased_object)
+    return pydantic.parse_obj_as(type_, dealiased_object)
 
 
-def to_jsonable_with_fallback(
-    obj: typing.Any, fallback_serializer: typing.Callable[[typing.Any], typing.Any]
-) -> typing.Any:
+def to_jsonable_with_fallback(obj: Any, fallback_serializer: Callable[[Any], Any]) -> Any:
     if IS_PYDANTIC_V2:
         from pydantic_core import to_jsonable_python
 
         return to_jsonable_python(obj, fallback=fallback_serializer)
-    else:
-        return fallback_serializer(obj)
+    return fallback_serializer(obj)
 
 
 class UniversalBaseModel(pydantic.BaseModel):
     if IS_PYDANTIC_V2:
-        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
+        model_config: ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(  # type: ignore[typeddict-unknown-key]
             # Allow fields beginning with `model_` to be used in the model
             protected_namespaces=(),
-        )  # type: ignore # Pydantic v2
-
-        @pydantic.model_serializer(mode="wrap", when_used="json")  # type: ignore # Pydantic v2
-        def serialize_model(
-            self, handler: pydantic.SerializerFunctionWrapHandler
-        ) -> typing.Any:  # type: ignore # Pydantic v2
-            serialized = handler(self)
-            data = {
-                k: serialize_datetime(v) if isinstance(v, dt.datetime) else v
-                for k, v in serialized.items()
-            }
+        )
+
+        @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()
+            data = {k: serialize_datetime(v) if isinstance(v, dt.datetime) else v for k, v in serialized.items()}
             return data
 
     else:
@@ -103,42 +72,28 @@ class UniversalBaseModel(pydantic.BaseModel):
             json_encoders = {dt.datetime: serialize_datetime}
 
     @classmethod
-    def model_construct(
-        cls: typing.Type["Model"],
-        _fields_set: typing.Optional[typing.Set[str]] = None,
-        **values: typing.Any,
-    ) -> "Model":
-        dealiased_object = convert_and_respect_annotation_metadata(
-            object_=values, annotation=cls, direction="read"
-        )
+    def model_construct(cls: Type["Model"], _fields_set: Optional[Set[str]] = None, **values: Any) -> "Model":
+        dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read")
         return cls.construct(_fields_set, **dealiased_object)
 
     @classmethod
-    def construct(
-        cls: typing.Type["Model"],
-        _fields_set: typing.Optional[typing.Set[str]] = None,
-        **values: typing.Any,
-    ) -> "Model":
-        dealiased_object = convert_and_respect_annotation_metadata(
-            object_=values, annotation=cls, direction="read"
-        )
+    def construct(cls: Type["Model"], _fields_set: Optional[Set[str]] = None, **values: Any) -> "Model":
+        dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read")
         if IS_PYDANTIC_V2:
-            return super().model_construct(_fields_set, **dealiased_object)  # type: ignore # Pydantic v2
-        else:
-            return super().construct(_fields_set, **dealiased_object)
+            return super().model_construct(_fields_set, **dealiased_object)  # type: ignore[misc]
+        return super().construct(_fields_set, **dealiased_object)
 
-    def json(self, **kwargs: typing.Any) -> str:
-        kwargs_with_defaults: typing.Any = {
+    def json(self, **kwargs: Any) -> str:
+        kwargs_with_defaults = {
             "by_alias": True,
             "exclude_unset": True,
             **kwargs,
         }
         if IS_PYDANTIC_V2:
-            return super().model_dump_json(**kwargs_with_defaults)  # type: ignore # Pydantic v2
-        else:
-            return super().json(**kwargs_with_defaults)
+            return super().model_dump_json(**kwargs_with_defaults)  # type: ignore[misc]
+        return super().json(**kwargs_with_defaults)
 
-    def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
+    def dict(self, **kwargs: Any) -> Dict[str, Any]:
         """
         Override the default dict method to `exclude_unset` by default. This function patches
         `exclude_unset` to work include fields within non-None default values.
@@ -149,21 +104,21 @@ class UniversalBaseModel(pydantic.BaseModel):
         # We'd ideally do the same for Pydantic V2, but it shells out to a library to serialize models
         # that we have less control over, and this is less intrusive than custom serializers for now.
         if IS_PYDANTIC_V2:
-            kwargs_with_defaults_exclude_unset: typing.Any = {
+            kwargs_with_defaults_exclude_unset = {
                 **kwargs,
                 "by_alias": True,
                 "exclude_unset": True,
                 "exclude_none": False,
             }
-            kwargs_with_defaults_exclude_none: typing.Any = {
+            kwargs_with_defaults_exclude_none = {
                 **kwargs,
                 "by_alias": True,
                 "exclude_none": True,
                 "exclude_unset": False,
             }
             dict_dump = deep_union_pydantic_dicts(
-                super().model_dump(**kwargs_with_defaults_exclude_unset),  # type: ignore # Pydantic v2
-                super().model_dump(**kwargs_with_defaults_exclude_none),  # type: ignore # Pydantic v2
+                super().model_dump(**kwargs_with_defaults_exclude_unset),  # type: ignore[misc]
+                super().model_dump(**kwargs_with_defaults_exclude_none),  # type: ignore[misc]
             )
 
         else:
@@ -177,50 +132,38 @@ class UniversalBaseModel(pydantic.BaseModel):
                     # 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 is not None or (
-                        "exclude_unset" in kwargs and not kwargs["exclude_unset"]
-                    ):
+                    if default is not None or ("exclude_unset" in kwargs and not kwargs["exclude_unset"]):
                         _fields_set.add(name)
 
                         if default is not None:
                             self.__fields_set__.add(name)
 
-            kwargs_with_defaults_exclude_unset_include_fields: typing.Any = {
+            kwargs_with_defaults_exclude_unset_include_fields = {
                 "by_alias": True,
                 "exclude_unset": True,
                 "include": _fields_set,
                 **kwargs,
             }
 
-            dict_dump = super().dict(
-                **kwargs_with_defaults_exclude_unset_include_fields
-            )
+            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 convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write")
 
 
-def _union_list_of_pydantic_dicts(
-    source: typing.List[typing.Any], destination: typing.List[typing.Any]
-) -> typing.List[typing.Any]:
-    converted_list: typing.List[typing.Any] = []
+def _union_list_of_pydantic_dicts(source: List[Any], destination: List[Any]) -> List[Any]:
+    converted_list: List[Any] = []
     for i, item in enumerate(source):
-        destination_value = destination[i]  # type: ignore
+        destination_value = destination[i]
         if isinstance(item, dict):
             converted_list.append(deep_union_pydantic_dicts(item, destination_value))
         elif isinstance(item, list):
-            converted_list.append(
-                _union_list_of_pydantic_dicts(item, destination_value)
-            )
+            converted_list.append(_union_list_of_pydantic_dicts(item, destination_value))
         else:
             converted_list.append(item)
     return converted_list
 
 
-def deep_union_pydantic_dicts(
-    source: typing.Dict[str, typing.Any], destination: typing.Dict[str, typing.Any]
-) -> typing.Dict[str, typing.Any]:
+def deep_union_pydantic_dicts(source: Dict[str, Any], destination: Dict[str, Any]) -> Dict[str, Any]:
     for key, value in source.items():
         node = destination.setdefault(key, {})
         if isinstance(value, dict):
@@ -238,18 +181,16 @@ def deep_union_pydantic_dicts(
 
 if IS_PYDANTIC_V2:
 
-    class V2RootModel(UniversalBaseModel, pydantic.RootModel):  # type: ignore # Pydantic v2
+    class V2RootModel(UniversalBaseModel, pydantic.RootModel):  # type: ignore[misc, name-defined, type-arg]
         pass
 
-    UniversalRootModel: typing_extensions.TypeAlias = V2RootModel  # type: ignore
+    UniversalRootModel: TypeAlias = V2RootModel  # type: ignore[misc]
 else:
-    UniversalRootModel: typing_extensions.TypeAlias = UniversalBaseModel  # type: ignore
+    UniversalRootModel: TypeAlias = UniversalBaseModel  # type: ignore[misc, no-redef]
 
 
-def encode_by_type(o: typing.Any) -> typing.Any:
-    encoders_by_class_tuples: typing.Dict[
-        typing.Callable[[typing.Any], typing.Any], typing.Tuple[typing.Any, ...]
-    ] = defaultdict(tuple)
+def encode_by_type(o: Any) -> Any:
+    encoders_by_class_tuples: Dict[Callable[[Any], Any], Tuple[Any, ...]] = defaultdict(tuple)
     for type_, encoder in encoders_by_type.items():
         encoders_by_class_tuples[encoder] += (type_,)
 
@@ -260,58 +201,49 @@ def encode_by_type(o: typing.Any) -> typing.Any:
             return encoder(o)
 
 
-def update_forward_refs(model: typing.Type["Model"], **localns: typing.Any) -> None:
+def update_forward_refs(model: Type["Model"], **localns: Any) -> None:
     if IS_PYDANTIC_V2:
-        model.model_rebuild(raise_errors=False)  # type: ignore # Pydantic v2
+        model.model_rebuild(raise_errors=False)  # type: ignore[attr-defined]
     else:
         model.update_forward_refs(**localns)
 
 
 # Mirrors Pydantic's internal typing
-AnyCallable = typing.Callable[..., typing.Any]
+AnyCallable = Callable[..., Any]
 
 
 def universal_root_validator(
     pre: bool = False,
-) -> typing.Callable[[AnyCallable], AnyCallable]:
+) -> Callable[[AnyCallable], AnyCallable]:
     def decorator(func: AnyCallable) -> AnyCallable:
         if IS_PYDANTIC_V2:
-            return pydantic.model_validator(mode="before" if pre else "after")(func)  # type: ignore # Pydantic v2
-        else:
-            return pydantic.root_validator(pre=pre)(func)  # type: ignore # Pydantic v1
+            return cast(AnyCallable, pydantic.model_validator(mode="before" if pre else "after")(func))  # type: ignore[attr-defined]
+        return cast(AnyCallable, pydantic.root_validator(pre=pre)(func))  # type: ignore[call-overload]
 
     return decorator
 
 
-def universal_field_validator(
-    field_name: str, pre: bool = False
-) -> typing.Callable[[AnyCallable], AnyCallable]:
+def universal_field_validator(field_name: str, pre: bool = False) -> Callable[[AnyCallable], AnyCallable]:
     def decorator(func: AnyCallable) -> AnyCallable:
         if IS_PYDANTIC_V2:
-            return pydantic.field_validator(
-                field_name, mode="before" if pre else "after"
-            )(func)  # type: ignore # Pydantic v2
-        else:
-            return pydantic.validator(field_name, pre=pre)(func)  # type: ignore # Pydantic v1
+            return cast(AnyCallable, pydantic.field_validator(field_name, mode="before" if pre else "after")(func))  # type: ignore[attr-defined]
+        return cast(AnyCallable, pydantic.validator(field_name, pre=pre)(func))
 
     return decorator
 
 
-PydanticField = typing.Union[ModelField, pydantic.fields.FieldInfo]
+PydanticField = Union[ModelField, pydantic.fields.FieldInfo]
 
 
-def _get_model_fields(
-    model: typing.Type["Model"],
-) -> typing.Mapping[str, PydanticField]:
+def _get_model_fields(model: Type["Model"]) -> Mapping[str, PydanticField]:
     if IS_PYDANTIC_V2:
-        return model.model_fields  # type: ignore # Pydantic v2
-    else:
-        return model.__fields__  # type: ignore # Pydantic v1
+        return cast(Mapping[str, PydanticField], model.model_fields)  # type: ignore[attr-defined]
+    return cast(Mapping[str, PydanticField], model.__fields__)
 
 
-def _get_field_default(field: PydanticField) -> typing.Any:
+def _get_field_default(field: PydanticField) -> Any:
     try:
-        value = field.get_default()  # type: ignore # Pydantic < v1.10.15
+        value = field.get_default()  # type: ignore[union-attr]
     except:
         value = field.default
     if IS_PYDANTIC_V2:

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

@@ -6,9 +6,7 @@ import pydantic
 
 
 # Flattens dicts to be of the form {"key[subkey][subkey2]": value} where value is not a dict
-def traverse_query_dict(
-    dict_flat: Dict[str, Any], key_prefix: Optional[str] = None
-) -> List[Tuple[str, Any]]:
+def traverse_query_dict(dict_flat: Dict[str, Any], key_prefix: Optional[str] = None) -> List[Tuple[str, Any]]:
     result = []
     for k, v in dict_flat.items():
         key = f"{key_prefix}[{k}]" if key_prefix is not None else k

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

@@ -4,9 +4,8 @@ import collections
 import inspect
 import typing
 
-import typing_extensions
-
 import pydantic
+import typing_extensions
 
 
 class FieldMetadata:
@@ -68,9 +67,7 @@ def convert_and_respect_annotation_metadata(
     ):
         return _convert_mapping(object_, clean_type, direction)
     # TypedDicts
-    if typing_extensions.is_typeddict(clean_type) and isinstance(
-        object_, typing.Mapping
-    ):
+    if typing_extensions.is_typeddict(clean_type) and isinstance(object_, typing.Mapping):
         return _convert_mapping(object_, clean_type, direction)
 
     if (
@@ -163,7 +160,12 @@ def _convert_mapping(
     direction: typing.Literal["read", "write"],
 ) -> typing.Mapping[str, object]:
     converted_object: typing.Dict[str, object] = {}
-    annotations = typing_extensions.get_type_hints(expected_type, include_extras=True)
+    try:
+        annotations = typing_extensions.get_type_hints(expected_type, include_extras=True)
+    except NameError:
+        # The TypedDict contains a circular reference, so
+        # we use the __annotations__ attribute directly.
+        annotations = getattr(expected_type, "__annotations__", {})
     aliases_to_field_names = _get_alias_to_field_name(annotations)
     for key, value in object_.items():
         if direction == "read" and key in aliases_to_field_names:
@@ -183,10 +185,8 @@ def _convert_mapping(
                 object_=value, annotation=type_, direction=direction
             )
         else:
-            converted_object[
-                _alias_key(key, type_, direction, aliases_to_field_names)
-            ] = convert_and_respect_annotation_metadata(
-                object_=value, annotation=type_, direction=direction
+            converted_object[_alias_key(key, type_, direction, aliases_to_field_names)] = (
+                convert_and_respect_annotation_metadata(object_=value, annotation=type_, direction=direction)
             )
     return converted_object
 

package/planqk/service/sdk/environment.py

@@ -4,4 +4,4 @@ import enum
 
 
 class PlanqkServiceApiEnvironment(enum.Enum):
-    DEFAULT = "https://gateway.platform.planqk.de"
+    DEFAULT = "https://gateway.platform.planqk.de/<context>/<service>/<version>"

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

@@ -1,15 +1,7 @@
 # This file was auto-generated by Fern from our API Definition.
 
-from .types import (
-    GetResultResponse,
-    GetResultResponseEmbedded,
-    GetResultResponseLinks,
-    HealthCheckResponse,
-)
+# isort: skip_file
 
-__all__ = [
-    "GetResultResponse",
-    "GetResultResponseEmbedded",
-    "GetResultResponseLinks",
-    "HealthCheckResponse",
-]
+from .types import GetResultResponse, GetResultResponseEmbedded, GetResultResponseLinks
+
+__all__ = ["GetResultResponse", "GetResultResponseEmbedded", "GetResultResponseLinks"]