qcs_api_client.client._configuration.settings

Module Contents

Classes

QCSAuthServer	Specifies an OAuth2 authorization server against which to refresh tokens.
QCSClientConfigurationSettingsApplicationsCLI
QCSClientConfigurationSettingsApplicationsPyquil
QCSClientConfigurationSettingsApplications	Section of a profile specifying per-application settings.
QCSAccountType	Generic enumeration.
QCSClientConfigurationSettingsProfile	Specifies the authorization server, credentials, and API URL.
QCSClientConfigurationSettings	A fully parsed settings configuration file.

class qcs_api_client.client._configuration.settings.QCSAuthServer

Bases: pydantic.BaseModel

Specifies an OAuth2 authorization server against which to refresh tokens.

class Config

env_prefix = QCS_SETTINGS_AUTH_SERVER_

client_id :str

issuer :str

authorize_url()

token_url()

static scopes()

class qcs_api_client.client._configuration.settings.QCSClientConfigurationSettingsApplicationsCLI

Bases: qcs_api_client.client._configuration.environment.EnvironmentModel

class Config

env_prefix = QCS_SETTINGS_APPLICATIONS_CLI_

verbosity :str =

class qcs_api_client.client._configuration.settings.QCSClientConfigurationSettingsApplicationsPyquil

Bases: qcs_api_client.client._configuration.environment.EnvironmentModel

class Config

env_prefix = QCS_SETTINGS_APPLICATIONS_PYQUIL_

qvm_url :str = http://127.0.0.1:5000

quilc_url :str = tcp://127.0.0.1:5555

class qcs_api_client.client._configuration.settings.QCSClientConfigurationSettingsApplications

Bases: pydantic.BaseModel

Section of a profile specifying per-application settings.

cli :QCSClientConfigurationSettingsApplicationsCLI

pyquil :QCSClientConfigurationSettingsApplicationsPyquil

class qcs_api_client.client._configuration.settings.QCSAccountType

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

user = user

group = group

class qcs_api_client.client._configuration.settings.QCSClientConfigurationSettingsProfile

Bases: qcs_api_client.client._configuration.environment.EnvironmentModel

Specifies the authorization server, credentials, and API URL.

The attributes of this class can be used to initialize an httpx.Client with the correct base URL and the QCSAuth middleware for making authenticated API calls against the QCS API.

QCSClientConfigurationSettings may contain several profiles, which QCSClientConfiguration.profile_name may key into.

class Config

env_prefix = QCS_SETTINGS_

api_url :pydantic.networks.HttpUrl = https://api.qcs.rigetti.com

URL of the QCS API to use for all API calls

auth_server_name :str = default

Which of the configured QCSClientConfigurationSettings.auth_servers to use

applications :QCSClientConfigurationSettingsApplications

Application-specific configuration values

credentials_name :str = default

Which of the configured QCSClientConfigurationSecrets.credentials to use and update

account_id :Optional[str]

Account ID on behalf of which to make requests. If set to None, QCS services will use your personal user account. Clients may also set this to a QCS group name for which they are authorized to make requests.

account_type :Optional[QCSAccountType]

Account type on behalf of which to make requests. When setting the account_id to a group name, this must be set to AccountType.group.

class qcs_api_client.client._configuration.settings.QCSClientConfigurationSettings

Bases: qcs_api_client.client._configuration.file.QCSClientConfigurationFile

A fully parsed settings configuration file.

This contains all of the user’s configured authorization servers and profiles. It may optionally contain a default_profile_name to use to override the “default” value.

QCSClientConfiguration keys into these configured values when instantiated.

default_profile_name :str = default

Which profile to select settings from when none is specified.

See QCSClientConfiguration.load.

profiles :Dict[str, QCSClientConfigurationSettingsProfile]

All available configuration profiles, keyed by name

auth_servers :Dict[str, QCSAuthServer]

All available authorization servers, keyed by name