qiskit_quantuminspire.api package

Submodules

qiskit_quantuminspire.api.authentication module

exception qiskit_quantuminspire.api.authentication.AuthorisationError

Bases: Exception

Indicates that the authorisation permanently went wrong.

class qiskit_quantuminspire.api.authentication.IdentityProvider(well_known_endpoint: str)

Bases: object

Class for interfacing with the IdentityProvider.

refresh_access_token(client_id: str, refresh_token: str) → dict[str, Any]

class qiskit_quantuminspire.api.authentication.OauthDeviceSession(host: ~typing.Annotated[str, ~pydantic.functional_validators.BeforeValidator(func=~qiskit_quantuminspire.api.settings.<lambda>, json_schema_input_type=PydanticUndefined)], settings: ~qiskit_quantuminspire.api.settings.ApiSettings, identity_provider: ~qiskit_quantuminspire.api.authentication.IdentityProvider)

Bases: object

Class for storing OAuth session information and refreshing tokens when needed.

refresh() → TokenInfo

qiskit_quantuminspire.api.client module

class qiskit_quantuminspire.api.client.Configuration(host: str, oauth_session: OauthDeviceSession, **kwargs: Any)

Bases: Configuration

Original Configuration class in compute_api_client does not handle refreshing bearer tokens, so we need to add some functionality.

auth_settings() → Any

Gets Auth Settings dict for api client.

Returns:

The Auth Settings information dict.

qiskit_quantuminspire.api.client.config() → Configuration

qiskit_quantuminspire.api.client.connect() → None

Set connection configuration for the Quantum Inspire API.

Call after logging in with the CLI. Will remove old configuration.

qiskit_quantuminspire.api.pagination module

class qiskit_quantuminspire.api.pagination.PageInterface(*, items: List[ItemType], total: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None, page: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1)])] | None, size: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1)])] | None, pages: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None = None)

Bases: 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]

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

page: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1)])] | None

pages: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None

size: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=1)])] | None

total: Annotated[int, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), Ge(ge=0)])] | None

class qiskit_quantuminspire.api.pagination.PageReader

Bases: Generic[PageType, ItemType]

Helper class for reading fastapi-pagination style pages returned by the compute_api_client.

async get_all(api_call: Callable[[...], Awaitable[PageType]], **kwargs: Any) → List[ItemType]

Get all items from an API call that supports paging.

async get_single(api_call: Callable[[...], Awaitable[PageType]], **kwargs: Any) → ItemType | None

Get a single item from an API call that supports paging.

qiskit_quantuminspire.api.settings module

Module containing the handler for the Quantum Inspire persistent configuration.

class qiskit_quantuminspire.api.settings.ApiSettings(*, auths: ~typing.Dict[~typing.Annotated[str, ~pydantic.functional_validators.BeforeValidator(func=~qiskit_quantuminspire.api.settings.<lambda>, json_schema_input_type=PydanticUndefined)], ~qiskit_quantuminspire.api.settings.AuthSettings], default_host: ~typing.Annotated[str, ~pydantic.functional_validators.BeforeValidator(func=~qiskit_quantuminspire.api.settings.<lambda>, json_schema_input_type=PydanticUndefined)])

Bases: BaseModel

The settings class for the Quantum Inspire persistent configuration.

auths: Dict[Url, AuthSettings]

default_host: Url

classmethod from_config_file(path: Path = PosixPath('/home/runner/.quantuminspire/config.json')) → ApiSettings

Load the configuration from a file.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

store_tokens(host: ~typing.Annotated[str, ~pydantic.functional_validators.BeforeValidator(func=~qiskit_quantuminspire.api.settings.<lambda>, json_schema_input_type=PydanticUndefined)], tokens: ~qiskit_quantuminspire.api.settings.TokenInfo, path: ~pathlib.Path = PosixPath('/home/runner/.quantuminspire/config.json')) → None

Stores the team_member_id, access and refresh tokens in the config.json file.

Parameters:

• 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

class qiskit_quantuminspire.api.settings.AuthSettings(*, client_id: str, code_challenge_method: str, code_verifyer_length: int, well_known_endpoint: ~typing.Annotated[str, ~pydantic.functional_validators.BeforeValidator(func=~qiskit_quantuminspire.api.settings.<lambda>, json_schema_input_type=PydanticUndefined)], tokens: ~qiskit_quantuminspire.api.settings.TokenInfo | None, team_member_id: int | None)

Bases: BaseModel

Pydantic model for storing all auth related settings for a given host.

client_id: str

code_challenge_method: str

code_verifyer_length: int

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

team_member_id: int | None

tokens: TokenInfo | None

well_known_endpoint: Url

class qiskit_quantuminspire.api.settings.TokenInfo(*, access_token: str, expires_in: int, refresh_token: str, refresh_expires_in: int | None = None, generated_at: float = <factory>)

Bases: BaseModel

A pydantic model for storing all information regarding oauth access and refresh tokens.

property access_expires_at: float

Unix timestamp containing the time when the access token will expire.

access_token: str

expires_in: int

generated_at: float

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

refresh_expires_in: int | None

refresh_token: str

Module contents