qi-compute-api-client 0.39.0__py3-none-any.whl → 0.43.0__py3-none-any.whl

compute_api_client/__init__.py

@@ -18,6 +18,7 @@ __version__ = "1.0.0"
 
 # import apis into sdk package
 from compute_api_client.api.algorithms_api import AlgorithmsApi
+from compute_api_client.api.auth_config_api import AuthConfigApi
 from compute_api_client.api.backend_api import BackendApi
 from compute_api_client.api.backend_types_api import BackendTypesApi
 from compute_api_client.api.batch_jobs_api import BatchJobsApi
@@ -52,6 +53,7 @@ from compute_api_client.exceptions import ApiException
 from compute_api_client.models.algorithm import Algorithm
 from compute_api_client.models.algorithm_in import AlgorithmIn
 from compute_api_client.models.algorithm_type import AlgorithmType
+from compute_api_client.models.auth_config import AuthConfig
 from compute_api_client.models.backend import Backend
 from compute_api_client.models.backend_in import BackendIn
 from compute_api_client.models.backend_patch import BackendPatch
@@ -70,6 +72,7 @@ from compute_api_client.models.file import File
 from compute_api_client.models.file_in import FileIn
 from compute_api_client.models.final_result import FinalResult
 from compute_api_client.models.final_result_in import FinalResultIn
+from compute_api_client.models.http_bad_request_error import HTTPBadRequestError
 from compute_api_client.models.http_not_found_error import HTTPNotFoundError
 from compute_api_client.models.http_validation_error import HTTPValidationError
 from compute_api_client.models.job import Job

compute_api_client/api/__init__.py

@@ -2,6 +2,7 @@
 
 # import apis into api package
 from compute_api_client.api.algorithms_api import AlgorithmsApi
+from compute_api_client.api.auth_config_api import AuthConfigApi
 from compute_api_client.api.backend_api import BackendApi
 from compute_api_client.api.backend_types_api import BackendTypesApi
 from compute_api_client.api.batch_jobs_api import BatchJobsApi

compute_api_client/api/auth_config_api.py

@@ -0,0 +1,286 @@
+# 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
+
+
+import io
+import warnings
+
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Dict, List, Optional, Tuple, Union, Any
+
+try:
+    from typing import Annotated
+except ImportError:
+    from typing_extensions import Annotated
+
+from compute_api_client.models.auth_config import AuthConfig
+
+from compute_api_client.api_client import ApiClient
+from compute_api_client.api_response import ApiResponse
+from compute_api_client.rest import RESTResponseType
+
+
+class AuthConfigApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    async def auth_config_auth_config_get(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> AuthConfig:
+        """Get suggested authentication configuration
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._auth_config_auth_config_get_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AuthConfig"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    async def auth_config_auth_config_get_with_http_info(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[AuthConfig]:
+        """Get suggested authentication configuration
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._auth_config_auth_config_get_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AuthConfig"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        await response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    async def auth_config_auth_config_get_without_preload_content(
+        self,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get suggested authentication configuration
+
+
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._auth_config_auth_config_get_serialize(
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "AuthConfig"
+            
+        }
+        response_data = await self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _auth_config_auth_config_get_serialize(
+        self,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> Tuple:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+            
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[str, str] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            [
+                'application/json'
+            ]
+        )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/auth_config',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

compute_api_client/api/backend_types_api.py

@@ -298,7 +298,8 @@ class BackendTypesApi:
 
         # authentication setting
         _auth_settings: List[str] = [
-            'user_bearer'
+            'user_bearer', 
+            'backend'
         ]
 
         return self.api_client.param_serialize(

compute_api_client/docs/AuthConfig.md

@@ -0,0 +1,30 @@
+# AuthConfig
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**client_id** | **str** |  | 
+**audience** | **str** |  | 
+**well_known_endpoint** | **str** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.auth_config import AuthConfig
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of AuthConfig from a JSON string
+auth_config_instance = AuthConfig.from_json(json)
+# print the JSON string representation of the object
+print AuthConfig.to_json()
+
+# convert the object into a dict
+auth_config_dict = auth_config_instance.to_dict()
+# create an instance of AuthConfig from a dict
+auth_config_form_dict = auth_config.from_dict(auth_config_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/docs/AuthConfigApi.md

@@ -0,0 +1,70 @@
+# compute_api_client.AuthConfigApi
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**auth_config_auth_config_get**](AuthConfigApi.md#auth_config_auth_config_get) | **GET** /auth_config | Get suggested authentication configuration
+
+
+# **auth_config_auth_config_get**
+> AuthConfig auth_config_auth_config_get()
+
+Get suggested authentication configuration
+
+### Example
+
+```python
+import time
+import os
+import compute_api_client
+from compute_api_client.models.auth_config import AuthConfig
+from compute_api_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = compute_api_client.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+async with compute_api_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = compute_api_client.AuthConfigApi(api_client)
+
+    try:
+        # Get suggested authentication configuration
+        api_response = await api_instance.auth_config_auth_config_get()
+        print("The response of AuthConfigApi->auth_config_auth_config_get:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling AuthConfigApi->auth_config_auth_config_get: %s\n" % e)
+```
+
+
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AuthConfig**](AuthConfig.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

compute_api_client/docs/BackendTypesApi.md

@@ -18,6 +18,7 @@ Get backend type by ID.
 ### Example
 
 * OAuth Authentication (user_bearer):
+* Api Key Authentication (backend):
 ```python
 import time
 import os
@@ -39,6 +40,12 @@ configuration = compute_api_client.Configuration(
 
 configuration.access_token = os.environ["ACCESS_TOKEN"]
 
+# Configure API key authorization: backend
+configuration.api_key['backend'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['backend'] = 'Bearer'
+
 # Enter a context with an instance of the API client
 async with compute_api_client.ApiClient(configuration) as api_client:
     # Create an instance of the API class
@@ -68,7 +75,7 @@ Name | Type | Description  | Notes
 
 ### Authorization
 
-[user_bearer](../README.md#user_bearer)
+[user_bearer](../README.md#user_bearer), [backend](../README.md#backend)
 
 ### HTTP request headers
 

compute_api_client/docs/CommitsApi.md

@@ -90,6 +90,7 @@ void (empty response body)
 |-------------|-------------|------------------|
 **204** | Compiled |  -  |
 **404** | Not Found |  -  |
+**400** | Bad Request |  -  |
 **422** | Validation Error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

compute_api_client/docs/HTTPBadRequestError.md

@@ -0,0 +1,28 @@
+# HTTPBadRequestError
+
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **str** |  | 
+
+## Example
+
+```python
+from compute_api_client.models.http_bad_request_error import HTTPBadRequestError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of HTTPBadRequestError from a JSON string
+http_bad_request_error_instance = HTTPBadRequestError.from_json(json)
+# print the JSON string representation of the object
+print HTTPBadRequestError.to_json()
+
+# convert the object into a dict
+http_bad_request_error_dict = http_bad_request_error_instance.to_dict()
+# create an instance of HTTPBadRequestError from a dict
+http_bad_request_error_form_dict = http_bad_request_error.from_dict(http_bad_request_error_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

compute_api_client/models/__init__.py

@@ -17,6 +17,7 @@
 from compute_api_client.models.algorithm import Algorithm
 from compute_api_client.models.algorithm_in import AlgorithmIn
 from compute_api_client.models.algorithm_type import AlgorithmType
+from compute_api_client.models.auth_config import AuthConfig
 from compute_api_client.models.backend import Backend
 from compute_api_client.models.backend_in import BackendIn
 from compute_api_client.models.backend_patch import BackendPatch
@@ -35,6 +36,7 @@ from compute_api_client.models.file import File
 from compute_api_client.models.file_in import FileIn
 from compute_api_client.models.final_result import FinalResult
 from compute_api_client.models.final_result_in import FinalResultIn
+from compute_api_client.models.http_bad_request_error import HTTPBadRequestError
 from compute_api_client.models.http_not_found_error import HTTPNotFoundError
 from compute_api_client.models.http_validation_error import HTTPValidationError
 from compute_api_client.models.job import Job

compute_api_client/models/auth_config.py

@@ -0,0 +1,91 @@
+# 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
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, StrictStr
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class AuthConfig(BaseModel):
+    """
+    AuthConfig
+    """ # noqa: E501
+    client_id: StrictStr
+    audience: StrictStr
+    well_known_endpoint: StrictStr
+    __properties: ClassVar[List[str]] = ["client_id", "audience", "well_known_endpoint"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AuthConfig from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of AuthConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "client_id": obj.get("client_id"),
+            "audience": obj.get("audience"),
+            "well_known_endpoint": obj.get("well_known_endpoint")
+        })
+        return _obj
+
+

compute_api_client/models/http_bad_request_error.py

@@ -0,0 +1,87 @@
+# 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
+import pprint
+import re  # noqa: F401
+import json
+
+
+from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, StrictStr
+try:
+    from typing import Self
+except ImportError:
+    from typing_extensions import Self
+
+class HTTPBadRequestError(BaseModel):
+    """
+    HTTPBadRequestError
+    """ # noqa: E501
+    detail: StrictStr
+    __properties: ClassVar[List[str]] = ["detail"]
+
+    model_config = {
+        "populate_by_name": True,
+        "validate_assignment": True
+    }
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of HTTPBadRequestError from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude={
+            },
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Dict) -> Self:
+        """Create an instance of HTTPBadRequestError from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "detail": obj.get("detail")
+        })
+        return _obj
+
+

qi2_shared/authentication.py

@@ -0,0 +1,65 @@
+import time
+from typing import Any, Tuple, cast
+
+import requests
+
+from qi2_shared.settings import ApiSettings, TokenInfo, Url
+
+
+class AuthorisationError(Exception):
+    """Indicates that the authorisation permanently went wrong."""
+    pass
+
+
+class IdentityProvider:
+    """Class for interfacing with the IdentityProvider."""
+
+    def __init__(self, well_known_endpoint: str):
+        self._well_known_endpoint = well_known_endpoint
+        self._token_endpoint, self._device_endpoint = self._get_endpoints()
+        self._headers = {"Content-Type": "application/x-www-form-urlencoded"}
+
+    def _get_endpoints(self) -> Tuple[str, str]:
+        response = requests.get(self._well_known_endpoint)
+        response.raise_for_status()
+        config = response.json()
+        return config["token_endpoint"], config["device_authorization_endpoint"]
+
+    def refresh_access_token(self, client_id: str, refresh_token: str) -> dict[str, Any]:
+        data = {
+            "grant_type": "refresh_token",
+            "client_id": client_id,
+            "refresh_token": refresh_token,
+        }
+        response = requests.post(self._token_endpoint, headers=self._headers, data=data)
+        response.raise_for_status()
+        return cast(dict[str, Any], response.json())
+
+
+class OauthDeviceSession:
+    """Class for storing OAuth session information and refreshing tokens when needed."""
+
+    def __init__(self, host: Url, settings: ApiSettings, identity_provider: IdentityProvider):
+        self._api_settings = settings
+        _auth_settings = settings.auths[host]
+        self._host = host
+        self._client_id = _auth_settings.client_id
+        self._token_info = _auth_settings.tokens
+        self._refresh_time_reduction = 5  # the number of seconds to refresh the expiration time
+        self._identity_provider = identity_provider
+
+    def refresh(self) -> TokenInfo:
+        if self._token_info is None:
+            raise AuthorisationError("You should authenticate first before you can refresh")
+
+        if self._token_info.access_expires_at > time.time() + self._refresh_time_reduction:
+            return self._token_info
+
+        try:
+            self._token_info = TokenInfo(
+                **self._identity_provider.refresh_access_token(self._client_id, self._token_info.refresh_token)
+            )
+            self._api_settings.store_tokens(self._host, self._token_info)
+            return self._token_info
+        except requests.HTTPError as e:
+            raise AuthorisationError(f"An error occurred during token refresh: {e}")

qi2_shared/client.py

@@ -0,0 +1,52 @@
+from typing import Any, Optional
+
+import compute_api_client
+
+from qi2_shared.authentication import IdentityProvider, OauthDeviceSession
+from qi2_shared.settings import ApiSettings
+
+
+class Configuration(compute_api_client.Configuration):  # type: ignore[misc]
+    """Original Configuration class in compute_api_client does not handle refreshing bearer tokens, so we need to add
+    some functionality."""
+
+    def __init__(self, host: str, oauth_session: OauthDeviceSession, **kwargs: Any):
+        self._oauth_session = oauth_session
+        super().__init__(host=host, **kwargs)
+
+    def auth_settings(self) -> Any:
+        token_info = self._oauth_session.refresh()
+        self.access_token = token_info.access_token
+        return super().auth_settings()
+
+
+_config: Optional[Configuration] = None
+
+
+def connect() -> None:
+    """Set connection configuration for the Quantum Inspire API.
+
+    Call after logging in with the CLI. Will remove old configuration.
+    """
+    global _config
+    settings = ApiSettings.from_config_file()
+
+    tokens = settings.auths[settings.default_host].tokens
+
+    if tokens is None:
+        raise ValueError("No access token found for the default host. Please connect to Quantum Inspire using the CLI.")
+
+    host = settings.default_host
+    _config = Configuration(
+        host=host,
+        oauth_session=OauthDeviceSession(host, settings, IdentityProvider(settings.auths[host].well_known_endpoint)),
+    )
+
+
+def config() -> Configuration:
+    global _config
+    if _config is None:
+        connect()
+
+    assert _config is not None
+    return _config

qi2_shared/pagination.py

@@ -0,0 +1,44 @@
+from typing import Any, Awaitable, Callable, Generic, List, Optional, TypeVar, Union, cast
+
+from pydantic import BaseModel, Field
+from typing_extensions import Annotated
+
+PageType = TypeVar("PageType")
+ItemType = TypeVar("ItemType")
+
+
+class PageInterface(BaseModel, Generic[ItemType]):
+    """The page models in the generated API client don't inherit from a common base class, so we have to trick the
+    typing system a bit with this fake base class."""
+
+    items: List[ItemType]
+    total: Optional[Annotated[int, Field(strict=True, ge=0)]]
+    page: Optional[Annotated[int, Field(strict=True, ge=1)]]
+    size: Optional[Annotated[int, Field(strict=True, ge=1)]]
+    pages: Optional[Annotated[int, Field(strict=True, ge=0)]] = None
+
+
+class PageReader(Generic[PageType, ItemType]):
+    """Helper class for reading fastapi-pagination style pages returned by the compute_api_client."""
+
+    async def get_all(self, api_call: Callable[..., Awaitable[PageType]], **kwargs: Any) -> List[ItemType]:
+        """Get all items from an API call that supports paging."""
+        items: List[ItemType] = []
+        page = 1
+
+        while True:
+            response = cast(PageInterface[ItemType], await api_call(page=page, **kwargs))
+
+            items.extend(response.items)
+            page += 1
+            if response.pages is None or page > response.pages:
+                break
+        return items
+
+    async def get_single(self, api_call: Callable[..., Awaitable[PageType]], **kwargs: Any) -> Union[ItemType, None]:
+        """Get a single item from an API call that supports paging."""
+        response = cast(PageInterface[ItemType], await api_call(**kwargs))
+        if len(response.items) > 1:
+            raise RuntimeError(f"Response contains more than one item -> {kwargs}.")
+
+        return response.items[0] if response.items else None

qi2_shared/settings.py

@@ -0,0 +1,68 @@
+"""Module containing the handler for the Quantum Inspire persistent configuration."""
+
+from __future__ import annotations
+
+import time
+from pathlib import Path
+from typing import Dict, Optional
+
+from pydantic import BaseModel, BeforeValidator, Field, HttpUrl
+from typing_extensions import Annotated
+
+Url = Annotated[str, BeforeValidator(lambda value: str(HttpUrl(value)).rstrip("/"))]
+API_SETTINGS_FILE = Path.joinpath(Path.home(), ".quantuminspire", "config.json")
+
+
+class TokenInfo(BaseModel):
+    """A pydantic model for storing all information regarding oauth access and refresh tokens."""
+
+    access_token: str
+    expires_in: int  # [s]
+    refresh_token: str
+    refresh_expires_in: Optional[int] = None  # [s]
+    generated_at: float = Field(default_factory=time.time)
+
+    @property
+    def access_expires_at(self) -> float:
+        """Unix timestamp containing the time when the access token will expire."""
+        return self.generated_at + self.expires_in
+
+
+class AuthSettings(BaseModel):
+    """Pydantic model for storing all auth related settings for a given host."""
+
+    client_id: str
+    code_challenge_method: str
+    code_verifyer_length: int
+    well_known_endpoint: Url
+    tokens: Optional[TokenInfo]
+    team_member_id: Optional[int]
+
+
+class ApiSettings(BaseModel):
+    """The settings class for the Quantum Inspire persistent configuration."""
+
+    auths: Dict[Url, AuthSettings]
+    default_host: Url
+
+    def store_tokens(self, host: Url, tokens: TokenInfo, path: Path = API_SETTINGS_FILE) -> None:
+        """Stores the team_member_id, access and refresh tokens in the config.json file.
+
+        Args:
+            host: The hostname of the API for which the tokens are intended.
+            tokens: OAuth access and refresh tokens.
+            path: The path to the config.json file. Defaults to API_SETTINGS_FILE.
+        Returns:
+            None
+        """
+        self.auths[host].tokens = tokens
+        path.write_text(self.model_dump_json(indent=2))
+
+    @classmethod
+    def from_config_file(cls, path: Path = API_SETTINGS_FILE) -> ApiSettings:
+        """Load the configuration from a file."""
+        if not path.is_file():
+            raise FileNotFoundError("No configuration file found. Please connect to Quantum Inspire using the CLI.")
+
+        api_settings = path.read_text()
+        return ApiSettings.model_validate_json(api_settings)

{qi_compute_api_client-0.39.0.dist-info → qi_compute_api_client-0.43.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: qi-compute-api-client
-Version: 0.39.0
+Version: 0.43.0
 Summary: An API client for the Compute Job Manager of Quantum Inspire.
 Home-page: https://github.com/QuTech-Delft/compute-api-client
 License: Apache-2.0
@@ -17,7 +17,9 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: aiohttp (>=3.10.5,<4.0.0)
+Requires-Dist: pydantic (>=2.10.4,<3.0.0)
 Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
 Requires-Dist: urllib3 (>=2.0.0,<3.0.0)
 Project-URL: Repository, https://github.com/QuTech-Delft/compute-api-client
 Description-Content-Type: text/markdown
@@ -99,6 +101,7 @@ Class | Method | HTTP request | Description
 *AlgorithmsApi* | [**read_algorithm_algorithms_id_get**](compute_api_client/docs/AlgorithmsApi.md#read_algorithm_algorithms_id_get) | **GET** /algorithms/{id} | Retrieve algorithm
 *AlgorithmsApi* | [**read_algorithms_algorithms_get**](compute_api_client/docs/AlgorithmsApi.md#read_algorithms_algorithms_get) | **GET** /algorithms | List algorithms
 *AlgorithmsApi* | [**update_algorithm_algorithms_id_put**](compute_api_client/docs/AlgorithmsApi.md#update_algorithm_algorithms_id_put) | **PUT** /algorithms/{id} | Update algorithm
+*AuthConfigApi* | [**auth_config_auth_config_get**](compute_api_client/docs/AuthConfigApi.md#auth_config_auth_config_get) | **GET** /auth_config | Get suggested authentication configuration
 *BackendApi* | [**create_backend_backends_post**](compute_api_client/docs/BackendApi.md#create_backend_backends_post) | **POST** /backends | Create backend
 *BackendApi* | [**read_backend_backends_id_get**](compute_api_client/docs/BackendApi.md#read_backend_backends_id_get) | **GET** /backends/{id} | Retrieve backend
 *BackendApi* | [**read_backend_self_backends_me_get**](compute_api_client/docs/BackendApi.md#read_backend_self_backends_me_get) | **GET** /backends/me | Retrieve backend
@@ -174,6 +177,7 @@ Class | Method | HTTP request | Description
  - [Algorithm](compute_api_client/docs/Algorithm.md)
  - [AlgorithmIn](compute_api_client/docs/AlgorithmIn.md)
  - [AlgorithmType](compute_api_client/docs/AlgorithmType.md)
+ - [AuthConfig](compute_api_client/docs/AuthConfig.md)
  - [Backend](compute_api_client/docs/Backend.md)
  - [BackendIn](compute_api_client/docs/BackendIn.md)
  - [BackendPatch](compute_api_client/docs/BackendPatch.md)
@@ -192,6 +196,7 @@ Class | Method | HTTP request | Description
  - [FileIn](compute_api_client/docs/FileIn.md)
  - [FinalResult](compute_api_client/docs/FinalResult.md)
  - [FinalResultIn](compute_api_client/docs/FinalResultIn.md)
+ - [HTTPBadRequestError](compute_api_client/docs/HTTPBadRequestError.md)
  - [HTTPNotFoundError](compute_api_client/docs/HTTPNotFoundError.md)
  - [HTTPValidationError](compute_api_client/docs/HTTPValidationError.md)
  - [Job](compute_api_client/docs/Job.md)

{qi_compute_api_client-0.39.0.dist-info → qi_compute_api_client-0.43.0.dist-info}/RECORD

@@ -1,8 +1,9 @@
-compute_api_client/__init__.py,sha256=KzYZR60xot6tcs9C3UEJXLx3Zn-6O3AWarbY8qyBvMc,6229
-compute_api_client/api/__init__.py,sha256=r1XAqXSWdvgMGLPSoqbjUEHsf6p2tYHMg7Aejad7u24,1199
+compute_api_client/__init__.py,sha256=6uTw7shPw1cSMPpZ9Oi-b8WMBdfem8HXp6MCjaFPh7Y,6436
+compute_api_client/api/__init__.py,sha256=nRY1G_pFDiKdCGFNpTIu91NbSjcomkC-g0loObSiF94,1264
 compute_api_client/api/algorithms_api.py,sha256=Iq3X7347R8ZsF3hDoIlEA8girl0ww_k1orMPMc6ygDE,59489
+compute_api_client/api/auth_config_api.py,sha256=O7XDoKk6-bWyUJkfiiOZRbb8OuDv_H0xvcs_XFfAGG8,10356
 compute_api_client/api/backend_api.py,sha256=zNX_CYAm-6IrCuR7hlgHOCTwOkR1YQXn-3Ck9VUsCK8,57958
-compute_api_client/api/backend_types_api.py,sha256=Dq00VucVeV_6QvWSan-TBhih6XYoQDWPURRtci9vmi4,30729
+compute_api_client/api/backend_types_api.py,sha256=NL8pscTuqUfTKoqC_HJ55clfpBgXQ6ZdFZjYEowlRuE,30753
 compute_api_client/api/batch_jobs_api.py,sha256=OB9EsaNpLvr80Tq3CUkNoJlwrO4CnDnVBeHne3FVJa8,83892
 compute_api_client/api/commits_api.py,sha256=ETcosKPwE8EYr_wd3rZItlmJqLtuSu8E2CpJt0t5y_0,57560
 compute_api_client/api/files_api.py,sha256=eItVegQVnni7AK2yyT_6Paj4WB01vUwM8fIwxwJEZuk,47862
@@ -26,13 +27,15 @@ compute_api_client/docs/Algorithm.md,sha256=LThexsNa9FuuIyP9Hs2yjP2L-04VszC7AdfO
 compute_api_client/docs/AlgorithmIn.md,sha256=ikR6b3TyLjXyWxqlUDcS25ZCwyion5VCQ5D6RNWpuz4,1013
 compute_api_client/docs/AlgorithmType.md,sha256=056KK2zjtdGqqTXkDsxg8mCzxr2sM8C37YmrR3txGVA,292
 compute_api_client/docs/AlgorithmsApi.md,sha256=86LvDgo-LpfLBI8E8hgEn3BMymEmIqNpfk_Q5v2U3hw,14474
+compute_api_client/docs/AuthConfig.md,sha256=aAw9GUKZpP92FKndD-V2tv3fb538a4w5CnyIJtOig1c,903
+compute_api_client/docs/AuthConfigApi.md,sha256=i5YETvw2H8RrO5JGp7DlwAzGRZSG85OwwHKzm7JbmEo,2060
 compute_api_client/docs/Backend.md,sha256=7xbvLaCTqqFzwcA2QONhY-QXa_Ts1fWiuBQBJegW50g,968
 compute_api_client/docs/BackendApi.md,sha256=KWld3mvfxlP_ZiYNSHxNNCkMSwuSnbKy9aFsrFvuHMg,13986
 compute_api_client/docs/BackendIn.md,sha256=7_drRygOUPHFWjrvAJGo7WwmcyK6EeRnlSnA6WtTCu0,978
 compute_api_client/docs/BackendPatch.md,sha256=xET1pnI8JStGhtHm7qT-1zv7RCuKl2CUIKtYueWq72U,927
 compute_api_client/docs/BackendStatus.md,sha256=ofnS843IHCIxoywjJJ01GP90Gn1XedAm5xR8TONmUbk,292
 compute_api_client/docs/BackendType.md,sha256=8NORl7QEvRr1lHOyHqdv8rnAiGWXaErw5kc1Kn74JfQ,1359
-compute_api_client/docs/BackendTypesApi.md,sha256=17u9tnQ5_A_bKjFICYB79T5xRhLP8wFEd65owopCIug,7137
+compute_api_client/docs/BackendTypesApi.md,sha256=c2WK6rKdNoTWh24yQz8NnLDR3ux5_9morfLnJtYPAL0,7432
 compute_api_client/docs/BackendWithAuthentication.md,sha256=u9lZh4FusMtOuV53yc0QXHdnTas-4HNC06NyDh8E1Go,1256
 compute_api_client/docs/BatchJob.md,sha256=IozaJI2zAL1zo_zmuI-RIKvLGK68KkyW53AH4jbIaIs,1210
 compute_api_client/docs/BatchJobIn.md,sha256=9-nP1Xgnzd5tfvo8WmandUWR8IY-2pMeZyW0HveKZEU,847
@@ -40,7 +43,7 @@ compute_api_client/docs/BatchJobStatus.md,sha256=UQift_l9A3L0azzYjQtr7UnmYk6X36U
 compute_api_client/docs/BatchJobsApi.md,sha256=h7MhwjOcDwfSuDOK44XrwYw30oUN4vOw4LrM12L2JtI,20832
 compute_api_client/docs/Commit.md,sha256=WI3TcSFBdLWRjvJ9OBKiAKSN5AX7gXHs7EZm-Zs77FE,894
 compute_api_client/docs/CommitIn.md,sha256=tnd4OQ1brIRnNGAGkH3x_HRIQIg68CZTuAEJ2JDKK9w,843
-compute_api_client/docs/CommitsApi.md,sha256=47BwU64D-s9OByJxEc-q7xzhvfF-Tc5u3wrOL4DIIOA,13756
+compute_api_client/docs/CommitsApi.md,sha256=FcRxDjqBQqI_1tqDBkF-cB06euahEhWl_choBd4aRCE,13786
 compute_api_client/docs/CompilePayload.md,sha256=W9x3x0CodJPGgiEbyKiaNm7rl0FzayVS8jv-3SiT8PI,954
 compute_api_client/docs/CompileStage.md,sha256=-U9wb4fyD8b_cjV1-GBIBJfbquFulRlHFm3C0GFnGik,291
 compute_api_client/docs/Domain.md,sha256=HONTAt17CX2vFhnkHOFqMpJEIJjPM8GTBBQriWA71UY,285
@@ -50,6 +53,7 @@ compute_api_client/docs/FilesApi.md,sha256=GC4e2AiIb0IVxw5e2pEHulw0bnYVexBRxdR1o
 compute_api_client/docs/FinalResult.md,sha256=sRCvqIH3TXruJvgaHp4s6zyfCEkuBReVoaqr2iHVkJU,939
 compute_api_client/docs/FinalResultIn.md,sha256=9RSstFSQ08-we_4TtoEAP1_KIq6FBdftRyc-DDkAGLQ,913
 compute_api_client/docs/FinalResultsApi.md,sha256=V7X34yAWXZMlUBhPgC7EKhW_TXenIlhYR84PiH3kG9A,8167
+compute_api_client/docs/HTTPBadRequestError.md,sha256=TtmChwzainHvcapRwqTjmZghUFfvG3LZvYlDvs2dYjw,962
 compute_api_client/docs/HTTPNotFoundError.md,sha256=1GluS5OAVTk1qNrQwBOb29eQiNMJnCXyJk-0oKf-Rlc,936
 compute_api_client/docs/HTTPValidationError.md,sha256=MRdybtO0HOeFCN3Zk221Q6XH6fw1Qyg8J9KLPn38tI4,1006
 compute_api_client/docs/HealthApi.md,sha256=K1eWpfCF0AIbMsi0mAvFnIW-xjnnJvoQoyDQf7vyKEE,1825
@@ -109,10 +113,11 @@ compute_api_client/docs/UserIn.md,sha256=xAPeVO5WTaNcbI151w0j_g6BEM-xYquMV5Nx6sr
 compute_api_client/docs/UsersApi.md,sha256=_i1dIB7AW349xb8JcFtGohvK4l6iovAEYUYKaY5DZYc,10802
 compute_api_client/docs/ValidationError.md,sha256=NZSCUyM9u2fx4CFZfPF9cl_e6zDxQ9siBX-WtNHJyeA,978
 compute_api_client/exceptions.py,sha256=SxnwGBUmd989OJ9knsPWbZ3v59nn3_kipRYzOQZztXE,5451
-compute_api_client/models/__init__.py,sha256=ZowuC1OJQuy88rfDPgWejU3XpTV30KEJKBA8expO5ME,4498
+compute_api_client/models/__init__.py,sha256=KsynU7092TuftNP1zO7_8F99IgG26FL7V4QWd9TcC6k,4640
 compute_api_client/models/algorithm.py,sha256=eA77q4e5gi8VStOJplR0UF-E9gBr6VFkxsqt8Ohx1Yo,3190
 compute_api_client/models/algorithm_in.py,sha256=-U2CoNZZSpAGBe6O7KFMJ9yIJAaOGEbPBdCTMIB3s2g,3148
 compute_api_client/models/algorithm_type.py,sha256=yKefgGvi-f_O6OReG1Tu8Me_u2YZrvx5CFOSlTk8-6M,862
+compute_api_client/models/auth_config.py,sha256=J37ORfetcs5S3sqma-cra08Vry9qhdBpjjAMJYkhRrE,2573
 compute_api_client/models/backend.py,sha256=cZ_q1zzW6t9hDF-Llu2Zm8bgVQLvef0qFWLIENmp1Bg,3006
 compute_api_client/models/backend_in.py,sha256=9XK17112GvDxH2jAJpedX7z4kQ4oNr14EsCQ5dmGsEk,2957
 compute_api_client/models/backend_patch.py,sha256=QMKRJkxMIRiIc4dFQscqIJFe5zgCU11cm_6d_rnKOaE,2556
@@ -131,6 +136,7 @@ compute_api_client/models/file.py,sha256=PBxeUINDtmevly7zqwWTbg_1gKq21c5__HlGSfD
 compute_api_client/models/file_in.py,sha256=MWC-9renc5TKWJ5C-xSEWa7jmtm8xlL0YmcWOa0axRo,3397
 compute_api_client/models/final_result.py,sha256=nikP4R6CF4otZ3kPmw1_VlrS51-y-2c1UdDhiVFmi28,2643
 compute_api_client/models/final_result_in.py,sha256=0a3BDpM21XdfMp-kdr7DQ3peU4IDa_Pe-2z6v_D1s_8,2477
+compute_api_client/models/http_bad_request_error.py,sha256=3Bqvic3dc-xeClqdEgClwRIvIFzkScpwbNEvw34paQU,2391
 compute_api_client/models/http_not_found_error.py,sha256=ZxTsaEc2MX_Sb6pyoqt-sEhnQ6uwzpd8uRTEklcfaSY,2383
 compute_api_client/models/http_validation_error.py,sha256=x7kRxeYeaVlQ-ckHPfkeFlsWsxZPDMKcvfOCR7jOlao,2882
 compute_api_client/models/job.py,sha256=XFjB2GqK40Wkp-mGHF5nxTXzB_3qJYhbu2-kLbl_3y4,4050
@@ -178,7 +184,12 @@ compute_api_client/models/user.py,sha256=WD1QyiqRlyObnK61QRE2NUCyY5Oc9ejeNcOGopm
 compute_api_client/models/user_in.py,sha256=gMWrBylb3ihoc-bm-K7AG9w3iWGn_ROV14wZnGlJU30,3330
 compute_api_client/models/validation_error.py,sha256=HWliEU5aNn3CkND3c0MxJf0D8bUJmE3HKncfUCKDk5o,2941
 compute_api_client/rest.py,sha256=-N7fantOYHH5Ot97NOHm2ouAUuw4kdqbnOvCtf25H7g,5836
-qi_compute_api_client-0.39.0.dist-info/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-qi_compute_api_client-0.39.0.dist-info/METADATA,sha256=WZhBR6I9JQVTfu9ZR9RqhxERuCc_kyWHT35cnef9ZwQ,20255
-qi_compute_api_client-0.39.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-qi_compute_api_client-0.39.0.dist-info/RECORD,,
+qi2_shared/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+qi2_shared/authentication.py,sha256=zTnbB9SIGowSZgetlyXj8NNM3p2beQ3fQo4R0lTrjk8,2550
+qi2_shared/client.py,sha256=vK_VC5V9p2cy02GeVXh0lKxqhMrM3lzUSRtts1CvF-A,1591
+qi2_shared/pagination.py,sha256=sypb9tSsi_7A1D9WoaUEuo7Xyfci8gG2QCX8XSIb7rI,1844
+qi2_shared/settings.py,sha256=x2wNv8nzftMFb-5K7wKvhfJVxQn0YYlZ_Guu6DHm_qU,2384
+qi_compute_api_client-0.43.0.dist-info/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+qi_compute_api_client-0.43.0.dist-info/METADATA,sha256=W9XGJv0kL7P1swJ-gw3TqBa8JT0WXP-x3Xe9Si0XaJ8,20657
+qi_compute_api_client-0.43.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+qi_compute_api_client-0.43.0.dist-info/RECORD,,