qi-compute-api-client 0.53.0__py3-none-any.whl → 0.54.0__py3-none-any.whl

compute_api_client/models/user.py

@@ -17,34 +17,31 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictBool, StrictInt
-from pydantic import Field
 from typing_extensions import Annotated
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class User(BaseModel):
     """
     User
     """ # noqa: E501
-    id: StrictInt
-    full_name: Annotated[str, Field(strict=True, max_length=64)]
-    email: Annotated[str, Field(strict=True, max_length=256)]
-    is_superuser: StrictBool
-    is_staff: StrictBool
-    is_active: StrictBool
-    is_confirmed: StrictBool
-    oidc_sub: Annotated[str, Field(strict=True, max_length=256)]
+    id: StrictInt = Field(description="The id of the user")
+    full_name: Annotated[str, Field(strict=True, max_length=64)] = Field(description="The full name of the user")
+    email: Annotated[str, Field(strict=True, max_length=256)] = Field(description="The email id of the user")
+    is_superuser: StrictBool = Field(description="If the user is superuser")
+    is_staff: StrictBool = Field(description="If the user is staff")
+    is_active: StrictBool = Field(description="If the user is active")
+    is_confirmed: StrictBool = Field(description="If the user is confirmed")
+    oidc_sub: Annotated[str, Field(strict=True, max_length=256)] = Field(description="User identifier from OIDC provider")
     __properties: ClassVar[List[str]] = ["id", "full_name", "email", "is_superuser", "is_staff", "is_active", "is_confirmed", "oidc_sub"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -57,7 +54,7 @@ class User(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of User from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -71,16 +68,18 @@ class User(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of User from a dict"""
         if obj is None:
             return None

compute_api_client/models/user_in.py

@@ -17,33 +17,30 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, Field, StrictBool
 from typing import Any, ClassVar, Dict, List, Optional
-from pydantic import BaseModel, StrictBool
-from pydantic import Field
 from typing_extensions import Annotated
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from typing import Optional, Set
+from typing_extensions import Self
 
 class UserIn(BaseModel):
     """
     UserIn
     """ # noqa: E501
-    full_name: Annotated[str, Field(strict=True, max_length=64)]
-    email: Annotated[str, Field(strict=True, max_length=256)]
-    is_superuser: Optional[StrictBool] = False
-    is_staff: Optional[StrictBool] = False
-    is_active: Optional[StrictBool] = False
-    is_confirmed: Optional[StrictBool] = False
-    oidc_sub: Annotated[str, Field(strict=True, max_length=256)]
+    full_name: Annotated[str, Field(strict=True, max_length=64)] = Field(description="The full name of the user")
+    email: Annotated[str, Field(strict=True, max_length=256)] = Field(description="The email id of the user")
+    is_superuser: Optional[StrictBool] = Field(default=False, description="If the user is superuser")
+    is_staff: Optional[StrictBool] = Field(default=False, description="If the user is staff")
+    is_active: Optional[StrictBool] = Field(default=False, description="If the user is active")
+    is_confirmed: Optional[StrictBool] = Field(default=False, description="If the user is confirmed")
+    oidc_sub: Annotated[str, Field(strict=True, max_length=256)] = Field(description="User identifier from OIDC provider")
     __properties: ClassVar[List[str]] = ["full_name", "email", "is_superuser", "is_staff", "is_active", "is_confirmed", "oidc_sub"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -56,7 +53,7 @@ class UserIn(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of UserIn from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -70,16 +67,18 @@ class UserIn(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of UserIn from a dict"""
         if obj is None:
             return None

compute_api_client/models/validation_error.py

@@ -17,28 +17,26 @@ import pprint
 import re  # noqa: F401
 import json
 
-
+from pydantic import BaseModel, ConfigDict, StrictStr
 from typing import Any, ClassVar, Dict, List
-from pydantic import BaseModel, StrictStr
-from compute_api_client.models.location_inner import LocationInner
-try:
-    from typing import Self
-except ImportError:
-    from typing_extensions import Self
+from compute_api_client.models.validation_error_loc_inner import ValidationErrorLocInner
+from typing import Optional, Set
+from typing_extensions import Self
 
 class ValidationError(BaseModel):
     """
     ValidationError
     """ # noqa: E501
-    loc: List[LocationInner]
+    loc: List[ValidationErrorLocInner]
     msg: StrictStr
     type: StrictStr
     __properties: ClassVar[List[str]] = ["loc", "msg", "type"]
 
-    model_config = {
-        "populate_by_name": True,
-        "validate_assignment": True
-    }
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
 
 
     def to_str(self) -> str:
@@ -51,7 +49,7 @@ class ValidationError(BaseModel):
         return json.dumps(self.to_dict())
 
     @classmethod
-    def from_json(cls, json_str: str) -> Self:
+    def from_json(cls, json_str: str) -> Optional[Self]:
         """Create an instance of ValidationError from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
@@ -65,23 +63,25 @@ class ValidationError(BaseModel):
           were set at model initialization. Other fields with value `None`
           are ignored.
         """
+        excluded_fields: Set[str] = set([
+        ])
+
         _dict = self.model_dump(
             by_alias=True,
-            exclude={
-            },
+            exclude=excluded_fields,
             exclude_none=True,
         )
         # override the default output from pydantic by calling `to_dict()` of each item in loc (list)
         _items = []
         if self.loc:
-            for _item in self.loc:
-                if _item:
-                    _items.append(_item.to_dict())
+            for _item_loc in self.loc:
+                if _item_loc:
+                    _items.append(_item_loc.to_dict())
             _dict['loc'] = _items
         return _dict
 
     @classmethod
-    def from_dict(cls, obj: Dict) -> Self:
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
         """Create an instance of ValidationError from a dict"""
         if obj is None:
             return None
@@ -90,7 +90,7 @@ class ValidationError(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "loc": [LocationInner.from_dict(_item) for _item in obj.get("loc")] if obj.get("loc") is not None else None,
+            "loc": [ValidationErrorLocInner.from_dict(_item) for _item in obj["loc"]] if obj.get("loc") is not None else None,
             "msg": obj.get("msg"),
             "type": obj.get("type")
         })

compute_api_client/models/validation_error_loc_inner.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+
+"""
+    Quantum Inspire 2
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, ValidationError, field_validator
+from typing import Optional
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+VALIDATIONERRORLOCINNER_ANY_OF_SCHEMAS = ["int", "str"]
+
+class ValidationErrorLocInner(BaseModel):
+    """
+    ValidationErrorLocInner
+    """
+
+    # data type: str
+    anyof_schema_1_validator: Optional[StrictStr] = None
+    # data type: int
+    anyof_schema_2_validator: Optional[StrictInt] = None
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[int, str]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "int", "str" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = ValidationErrorLocInner.model_construct()
+        error_messages = []
+        # validate data type: str
+        try:
+            instance.anyof_schema_1_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # validate data type: int
+        try:
+            instance.anyof_schema_2_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in ValidationErrorLocInner with anyOf schemas: int, str. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # deserialize data into str
+        try:
+            # validation
+            instance.anyof_schema_1_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_1_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into int
+        try:
+            # validation
+            instance.anyof_schema_2_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_2_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into ValidationErrorLocInner with anyOf schemas: int, str. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], int, str]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

compute_api_client/rest.py

@@ -16,13 +16,17 @@ import io
 import json
 import re
 import ssl
+from typing import Optional, Union
 
 import aiohttp
+import aiohttp_retry
 
 from compute_api_client.exceptions import ApiException, ApiValueError
 
 RESTResponseType = aiohttp.ClientResponse
 
+ALLOW_RETRY_METHODS = frozenset({'DELETE', 'GET', 'HEAD', 'OPTIONS', 'PUT', 'TRACE'})
+
 class RESTResponse(io.IOBase):
 
     def __init__(self, resp) -> None:
@@ -50,36 +54,34 @@ class RESTClientObject:
     def __init__(self, configuration) -> None:
 
         # maxsize is number of requests to host that are allowed in parallel
-        maxsize = configuration.connection_pool_maxsize
+        self.maxsize = configuration.connection_pool_maxsize
 
-        ssl_context = ssl.create_default_context(
-            cafile=configuration.ssl_ca_cert
+        self.ssl_context = ssl.create_default_context(
+            cafile=configuration.ssl_ca_cert,
+            cadata=configuration.ca_cert_data,
         )
         if configuration.cert_file:
-            ssl_context.load_cert_chain(
+            self.ssl_context.load_cert_chain(
                 configuration.cert_file, keyfile=configuration.key_file
             )
 
         if not configuration.verify_ssl:
-            ssl_context.check_hostname = False
-            ssl_context.verify_mode = ssl.CERT_NONE
-
-        connector = aiohttp.TCPConnector(
-            limit=maxsize,
-            ssl=ssl_context
-        )
+            self.ssl_context.check_hostname = False
+            self.ssl_context.verify_mode = ssl.CERT_NONE
 
         self.proxy = configuration.proxy
         self.proxy_headers = configuration.proxy_headers
 
-        # https pool manager
-        self.pool_manager = aiohttp.ClientSession(
-            connector=connector,
-            trust_env=True
-        )
+        self.retries = configuration.retries
+
+        self.pool_manager: Optional[aiohttp.ClientSession] = None
+        self.retry_client: Optional[aiohttp_retry.RetryClient] = None
 
-    async def close(self):
-        await self.pool_manager.close()
+    async def close(self) -> None:
+        if self.pool_manager:
+            await self.pool_manager.close()
+        if self.retry_client is not None:
+            await self.retry_client.close()
 
     async def request(
         self,
@@ -163,13 +165,18 @@ class RESTClientObject:
                             content_type=v[2]
                         )
                     else:
+                        # Ensures that dict objects are serialized
+                        if isinstance(v, dict):
+                            v = json.dumps(v)
+                        elif isinstance(v, int):
+                            v = str(v)
                         data.add_field(k, v)
                 args["data"] = data
 
-            # Pass a `bytes` parameter directly in the body to support
+            # Pass a `bytes` or `str` parameter directly in the body to support
             # other content types than Json when `body` argument is provided
             # in serialized form
-            elif isinstance(body, bytes):
+            elif isinstance(body, str) or isinstance(body, bytes):
                 args["data"] = body
             else:
                 # Cannot generate the request from given parameters
@@ -178,11 +185,29 @@ class RESTClientObject:
                          declared content type."""
                 raise ApiException(status=0, reason=msg)
 
-        r = await self.pool_manager.request(**args)
-
-        return RESTResponse(r)
-
-
-
+        pool_manager: Union[aiohttp.ClientSession, aiohttp_retry.RetryClient]
 
+        # https pool manager
+        if self.pool_manager is None:
+            self.pool_manager = aiohttp.ClientSession(
+                connector=aiohttp.TCPConnector(limit=self.maxsize, ssl=self.ssl_context),
+                trust_env=True,
+            )
+        pool_manager = self.pool_manager
+
+        if self.retries is not None and method in ALLOW_RETRY_METHODS:
+            if self.retry_client is None:
+                self.retry_client = aiohttp_retry.RetryClient(
+                    client_session=self.pool_manager,
+                    retry_options=aiohttp_retry.ExponentialRetry(
+                        attempts=self.retries,
+                        factor=2.0,
+                        start_timeout=0.1,
+                        max_timeout=120.0
+                    )
+                )
+            pool_manager = self.retry_client
+
+        r = await pool_manager.request(**args)
 
+        return RESTResponse(r)

{qi_compute_api_client-0.53.0.dist-info → qi_compute_api_client-0.54.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qi-compute-api-client
-Version: 0.53.0
+Version: 0.54.0
 Summary: An API client for the Compute Job Manager of Quantum Inspire.
 Project-URL: Repository, https://github.com/QuTech-Delft/compute-api-client
 Author-email: Quantum Inspire <support@quantum-inspire.eu>
@@ -14,6 +14,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: ~=3.9
+Requires-Dist: aiohttp-retry>=2.9.1
 Requires-Dist: aiohttp<4,>=3.10.5
 Requires-Dist: pydantic<3,>=2.10.4
 Requires-Dist: python-dateutil<3,>=2.8.2
@@ -31,11 +32,12 @@ project:
 
 - API version: 0.1.0
 - Package version: 1.0.0
+- Generator version: 7.14.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
 
 ## Requirements.
 
-Python 3.7+
+Python 3.9+
 
 ## Installation & Usage
 
@@ -43,10 +45,12 @@ This python library package is generated without supporting files like setup.py
 
 To be able to use it, you will need these dependencies in your own package that uses this library:
 
-- urllib3 >= 1.25.3
-- python-dateutil
-- aiohttp
-- pydantic
+- urllib3 >= 2.1.0, < 3.0.0
+- python-dateutil >= 2.8.2
+- aiohttp >= 3.8.4
+- aiohttp-retry >= 2.8.3
+- pydantic >= 2
+- typing-extensions >= 4.7.1
 
 ## Getting Started
 
@@ -54,7 +58,6 @@ In your own code, to use this library to connect and interact with compute-api-c
 
 ```python
 
-import time
 import compute_api_client
 from compute_api_client.rest import ApiException
 from pprint import pprint
@@ -201,7 +204,6 @@ All URIs are relative to _http://localhost_
 - [JobPatch](compute_api_client/docs/JobPatch.md)
 - [JobStatus](compute_api_client/docs/JobStatus.md)
 - [Language](compute_api_client/docs/Language.md)
-- [LocationInner](compute_api_client/docs/LocationInner.md)
 - [Member](compute_api_client/docs/Member.md)
 - [MemberIn](compute_api_client/docs/MemberIn.md)
 - [PageAlgorithm](compute_api_client/docs/PageAlgorithm.md)
@@ -237,6 +239,7 @@ All URIs are relative to _http://localhost_
 - [User](compute_api_client/docs/User.md)
 - [UserIn](compute_api_client/docs/UserIn.md)
 - [ValidationError](compute_api_client/docs/ValidationError.md)
+- [ValidationErrorLocInner](compute_api_client/docs/ValidationErrorLocInner.md)
 
 <a id="documentation-for-authorization"></a>
 
@@ -248,7 +251,7 @@ Authentication schemes defined for the API: <a id="user_bearer"></a>
 
 - **Type**: OAuth
 - **Flow**: accessCode
-- **Authorization URL**: https://quantum-inspire-staging.eu.auth0.com/authorize
+- **Authorization URL**: https://auth.qi2.quantum-inspire.com/realms/oidc_development/protocol/openid-connect/auth
 - **Scopes**: N/A
 
 <a id="backend"></a>