fermioniq.client.ClientConfig#

class fermioniq.client.ClientConfig(*, ws_event_loop: AbstractEventLoop | None = None, access_token_id: str | None = None, access_token_secret: str | None = None, verbosity_level: int = 0)#

Class for configuring the fermioniq.client.Client() class.

Examples

>>> custom_event_loop = asyncio.new_event_loop()
>>> config = ClientConfig(ws_event_loop=custom_event_loop)
>>> client = Client(config=config)
Attributes:
access_token_id

API Key. Can be overwritten with environment variable FERMIONIQ_ACCESS_TOKEN_ID.

access_token_secret

API Secret. Can be overwritten with environment variable FERMIONIQ_ACCESS_TOKEN_SECRET.

ws_event_loop

The event loop to be used by the Fermioniq class. If set to None, a new event loop will be created. Users can provide their own event loop if desired.

verbosity_level

Level of Client verbosity. The higher the number, the more emulator output will be sent to the client. This has an impact on runtime performance and costs.

Methods

construct([_fields_set])

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data.

copy(*[, include, exclude, update, deep])

Duplicate a model, optionally choose which fields to include, exclude and change.

dict(*[, include, exclude, by_alias, ...])

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

json(*[, include, exclude, by_alias, ...])

Generate a JSON representation of the model, include and exclude arguments as per dict().

update_forward_refs(**localns)

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Config

from_orm

parse_file

parse_obj

parse_raw

schema

schema_json

validate