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: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str | None = None)

Bases: MaBaseSchema

deployed_by = <UserDtoSchema(many=False)>

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, device_name: str, provider: qunicorn_core.api.api_models.provider_dtos.ProviderDto | None = None, url: str | None = None)

Bases: object

device_name: str

id: int

provider: qunicorn_core.api.api_models.provider_dtos.ProviderDto | None = None

url: str | None = None

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

Bases: MaBaseSchema

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

provider = <ProviderDtoSchema(many=False)>

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

Bases: MaBaseSchema

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

class qunicorn_core.api.api_models.device_dtos.DeviceRequest(token: str)

Bases: object

token: str

class qunicorn_core.api.api_models.device_dtos.DeviceRequestSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, 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(id: int, executed_by: UserDto, executed_on: DeviceDto, deployment: DeploymentDto, progress: str, state: JobState, shots: int, type: JobType, started_at: datetime, finished_at: datetime, name: str, data: str, results: list[qunicorn_core.api.api_models.result_dtos.ResultDto], parameters: str, ibm_file_options: dict | None = None, ibm_file_inputs: dict | None = None, token: str | None = None)

Bases: object

JobDto that is used for all internal job handling

data: str

deployment: DeploymentDto

executed_by: UserDto

executed_on: DeviceDto

finished_at: datetime

ibm_file_inputs: dict | None = None

ibm_file_options: dict | None = None

id: int

name: str

parameters: str

progress: str

results: list[qunicorn_core.api.api_models.result_dtos.ResultDto]

shots: int

started_at: datetime

state: JobState

token: str | None = None

type: JobType

class qunicorn_core.api.api_models.job_dtos.JobExecutionDto(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.JobRequestDto(name: str, provider_name: str, device_name: str, shots: int, parameters: str, token: str, type: JobType, assembler_language: AssemblerLanguage, programs: Optional[List[QuantumProgramDto]] = None, circuits: list[str] | None = None)

Bases: object

JobDto that was sent from the user as a request

assembler_language: AssemblerLanguage

circuits: list[str] | None = None

device_name: str

static from_dict(body: dict) → JobRequestDto

name: str

parameters: str

programs: Optional[List[QuantumProgramDto]] = None

provider_name: str

shots: int

token: str

type: JobType

class qunicorn_core.api.api_models.job_dtos.JobRequestDtoSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, 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: str, state: str, type: JobType, started_at: datetime, finished_at: datetime, name: str, data: str, results: list[qunicorn_core.api.api_models.result_dtos.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: str

results: list[qunicorn_core.api.api_models.result_dtos.ResultDto]

started_at: datetime

state: str

type: JobType

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

Bases: MaBaseSchema

executed_by = <UserDtoSchema(many=False)>

executed_on = <DeviceDtoSchema(many=False)>

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

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

Bases: object

id: int

job_state: JobState = 'RUNNING'

name: str

class qunicorn_core.api.api_models.job_dtos.SimpleJobDtoSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, 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: str)

Bases: object

id: int

name: str

supported_language: str

with_token: bool

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

Bases: MaBaseSchema

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

class qunicorn_core.api.api_models.provider_dtos.ProviderIDSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, 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: qunicorn_core.static.enums.assembler_languages.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.QuantumProgramSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, 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, header: dict, result_type: qunicorn_core.static.enums.result_type.ResultType)

Bases: object

circuit: str

header: dict

id: int

result_dict: dict

result_type: ResultType

class qunicorn_core.api.api_models.result_dtos.ResultDtoSchema(*, only: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, 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: Optional[Union[Sequence[str], Set[str]]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: dict | None = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, 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

id: int

name: str | None = None

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

Bases: MaBaseSchema

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

Module contents

Module to import all Dtos and their Schemas.