qunicorn_core.api.api_models package

Submodules

qunicorn_core.api.api_models.deployment_dtos module

Module containing all Dtos and their Schemas for tasks in the Deployment API.

class qunicorn_core.api.api_models.deployment_dtos.DeploymentDto(id: int, programs: list[qunicorn_core.api.api_models.quantum_program_dtos.QuantumProgramDto], deployed_by: qunicorn_core.api.api_models.user_dtos.UserDto, deployed_at: datetime.datetime, name: str)

Bases: object

deployed_at: datetime

deployed_by: UserDto

id: int

name: str

programs: list[QuantumProgramDto]

class qunicorn_core.api.api_models.deployment_dtos.DeploymentDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.deployment_dtos.DeploymentRequestDto(programs: list[qunicorn_core.api.api_models.quantum_program_dtos.QuantumProgramRequestDto], name: str)

Bases: object

static from_dict(body: dict) → DeploymentRequestDto

name: str

programs: list[QuantumProgramRequestDto]

class qunicorn_core.api.api_models.deployment_dtos.DeploymentRequestDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.api_models.device_dtos module

Module containing all Dtos and their Schemas for tasks in the Devices API.

class qunicorn_core.api.api_models.device_dtos.DeviceDto(id: int, name: str, num_qubits: int, is_simulator: bool, is_local: bool, provider: qunicorn_core.api.api_models.provider_dtos.ProviderDto | None = None)

Bases: object

id: int

is_local: bool

is_simulator: bool

name: str

num_qubits: int

provider: ProviderDto | None = None

class qunicorn_core.api.api_models.device_dtos.DeviceDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.device_dtos.DeviceRequestDto(provider_name: qunicorn_core.static.enums.provider_name.ProviderName, token: str | None = None)

Bases: object

provider_name: ProviderName

token: str | None = None

class qunicorn_core.api.api_models.device_dtos.DeviceRequestDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.device_dtos.SimpleDeviceDto(device_id: int, device_name: str, provider_name: qunicorn_core.static.enums.provider_name.ProviderName)

Bases: object

device_id: int

device_name: str

provider_name: ProviderName

class qunicorn_core.api.api_models.device_dtos.SimpleDeviceDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.api_models.job_dtos module

Module containing all Dtos and their Schemas for tasks in the Jobmanager API.

class qunicorn_core.api.api_models.job_dtos.JobCoreDto(executed_by: UserDto, executed_on: DeviceDto, deployment: DeploymentDto, progress: int, state: JobState, shots: int, type: JobType, started_at: datetime, name: str, results: list[ResultDto], id: int | None = None, parameters: str | None = None, data: str | None = None, finished_at: datetime | None = None, ibm_file_options: dict | None = None, ibm_file_inputs: dict | None = None, token: str | None = None, transpiled_circuits: list | None = None)

Bases: object

JobDto that is used for all internal job handling

data: str | None = None

deployment: DeploymentDto

executed_by: UserDto

executed_on: DeviceDto

finished_at: datetime | None = None

ibm_file_inputs: dict | None = None

ibm_file_options: dict | None = None

id: int | None = None

name: str

parameters: str | None = None

progress: int

results: list[ResultDto]

shots: int

started_at: datetime

state: JobState

token: str | None = None

transpiled_circuits: list | None = None

type: JobType

class qunicorn_core.api.api_models.job_dtos.JobExecutePythonFileDto(token: str | None = None, python_file_options: str | None = None, python_file_inputs: str | None = None)

Bases: object

python_file_inputs: str | None = None

python_file_options: str | None = None

token: str | None = None

class qunicorn_core.api.api_models.job_dtos.JobExecutionDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.JobRequestDto(name: str, provider_name: str, device_name: str, shots: int, parameters: str, token: str, type: JobType, deployment_id: int)

Bases: object

JobDto that was sent from the user as a request

deployment_id: int

device_name: str

name: str

parameters: str

provider_name: str

shots: int

token: str

type: JobType

class qunicorn_core.api.api_models.job_dtos.JobRequestDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.JobResponseDto(id: int, executed_by: UserDto, executed_on: DeviceDto, progress: int, state: str, type: JobType, started_at: datetime, finished_at: datetime, name: str, data: str, results: list[ResultDto], parameters: str)

Bases: object

JobDto that is sent to the user as a response

data: str

executed_by: UserDto

executed_on: DeviceDto

finished_at: datetime

id: int

name: str

parameters: str

progress: int

results: list[ResultDto]

started_at: datetime

state: str

type: JobType

class qunicorn_core.api.api_models.job_dtos.JobResponseDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.SimpleJobDto(id: int, name: str, state: qunicorn_core.static.enums.job_state.JobState = <JobState.RUNNING: 'RUNNING'>)

Bases: object

id: int

name: str

state: JobState = 'RUNNING'

class qunicorn_core.api.api_models.job_dtos.SimpleJobDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.job_dtos.TokenSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.api_models.provider_dtos module

Module containing all Dtos and their Schemas for tasks in the Services API.

class qunicorn_core.api.api_models.provider_dtos.ProviderDto(id: int, with_token: bool, supported_language: str, name: qunicorn_core.static.enums.provider_name.ProviderName)

Bases: object

id: int

name: ProviderName

supported_language: str

with_token: bool

class qunicorn_core.api.api_models.provider_dtos.ProviderDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.provider_dtos.ProviderIDSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.api_models.quantum_program_dtos module

Module containing all Dtos and their Schemas for tasks in the QuantumProgram API.

class qunicorn_core.api.api_models.quantum_program_dtos.QuantumProgramDto(id: int | None = None, quantum_circuit: str | None = None, assembler_language: qunicorn_core.static.enums.assembler_languages.AssemblerLanguage | None = None, python_file_path: str | None = None, python_file_metadata: str | None = None)

Bases: object

assembler_language: AssemblerLanguage | None = None

id: int | None = None

python_file_metadata: str | None = None

python_file_path: str | None = None

quantum_circuit: str | None = None

class qunicorn_core.api.api_models.quantum_program_dtos.QuantumProgramDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

class qunicorn_core.api.api_models.quantum_program_dtos.QuantumProgramRequestDto(quantum_circuit: str, assembler_language: qunicorn_core.static.enums.assembler_languages.AssemblerLanguage, python_file_path: str | None = None, python_file_metadata: str | None = None)

Bases: object

assembler_language: AssemblerLanguage

python_file_metadata: str | None = None

python_file_path: str | None = None

quantum_circuit: str

class qunicorn_core.api.api_models.quantum_program_dtos.QuantumProgramRequestDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.api_models.result_dtos module

Module containing all Dtos and their Schemas for tasks in the Jobmanager API.

class qunicorn_core.api.api_models.result_dtos.ResultDto(id: int, circuit: str, result_dict: dict, meta_data: dict, result_type: qunicorn_core.static.enums.result_type.ResultType)

Bases: object

circuit: str

id: int

meta_data: dict

result_dict: dict

result_type: ResultType

class qunicorn_core.api.api_models.result_dtos.ResultDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.api_models.root module

Module containing all API schemas for the root API endpoint.

class qunicorn_core.api.api_models.root.RootSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

qunicorn_core.api.api_models.user_dtos module

Module containing all Dtos and their Schemas for tasks in the Users API.

class qunicorn_core.api.api_models.user_dtos.UserDto(id: int, name: str | None = None)

Bases: object

static get_default_user() → UserDto

id: int

name: str | None = None

class qunicorn_core.api.api_models.user_dtos.UserDtoSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool = False, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: MaBaseSchema

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>

Module contents

Module to import all Dtos and their Schemas.