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

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.42.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.42.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

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

@@ -184,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.42.0.dist-info/LICENSE.md,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-qi_compute_api_client-0.42.0.dist-info/METADATA,sha256=2wADK8A17dlrCqrhQ-a1--wULpT15mRdisKRPydqQsA,20573
-qi_compute_api_client-0.42.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-qi_compute_api_client-0.42.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,,