qunicorn_core.api package

Subpackages

• qunicorn_core.api.api_models package
  • Submodules
    • qunicorn_core.api.api_models.deployment_dtos module
      • DeploymentDto
      • DeploymentDtoSchema
      • DeploymentFilterParamsSchema
      • DeploymentUpdateDto
      • DeploymentUpdateDtoSchema
      • SimpleDeploymentDtoSchema
    • qunicorn_core.api.api_models.device_dtos module
      • ApiTokenHeaderSchema
      • DeviceDto
      • DeviceDtoSchema
      • DeviceFilterParamsSchema
      • DeviceRequestDtoSchema
      • DeviceStatusResponseSchema
      • DeviceUpdateFilterParamsSchema
      • SimpleDeviceDto
      • SimpleDeviceDtoSchema
    • qunicorn_core.api.api_models.job_dtos module
      • JobCommandSchema
      • JobExecutePythonFileDto
      • JobExecutionDtoSchema
      • JobFilterParamsSchema
      • JobRequestDto
      • JobRequestDtoSchema
      • JobResponseDto
      • JobResponseDtoSchema
      • QueuedJobsDtoSchema
      • SimpleJobDto
      • SimpleJobDtoSchema
      • TokenSchema
    • qunicorn_core.api.api_models.provider_dtos module
      • ProviderDto
      • ProviderDtoSchema
      • ProviderFilterParamsSchema
      • ProviderIDSchema
    • qunicorn_core.api.api_models.quantum_program_dtos module
      • QuantumProgramDto
      • QuantumProgramDtoSchema
      • QuantumProgramRequestDto
      • QuantumProgramRequestDtoSchema
    • qunicorn_core.api.api_models.result_dtos module
      • ResultDto
      • ResultDtoSchema
    • qunicorn_core.api.api_models.root module
      • RootSchema
  • Module contents
• qunicorn_core.api.deployment_api package
  • Submodules
    • qunicorn_core.api.deployment_api.blueprint module
    • qunicorn_core.api.deployment_api.deployment_view module
      • DeploymentDetailView
      • DeploymentIDView
      • DeploymentProgramDetailsView
      • DeploymentProgramsView
      • JobsByDeploymentView
  • Module contents
• qunicorn_core.api.device_api package
  • Submodules
    • qunicorn_core.api.device_api.blueprint module
    • qunicorn_core.api.device_api.device_view module
      • DeviceIdView
      • DeviceView
      • DevicesCalibrationView
      • DevicesStatusStatus
  • Module contents
• qunicorn_core.api.job_api package
  • Submodules
    • qunicorn_core.api.job_api.blueprint module
    • qunicorn_core.api.job_api.job_view module
      • JobCancelView
      • JobDetailView
      • JobIDView
      • JobQueueView
      • JobReRunView
      • JobResultDetailView
      • JobResultsView
      • JobRunView
  • Module contents
• qunicorn_core.api.provider_api package
  • Submodules
    • qunicorn_core.api.provider_api.blueprint module
    • qunicorn_core.api.provider_api.provider_view module
      • ProviderIDView
      • ProviderView
  • Module contents

Submodules

• qunicorn_core.api.flask_api_utils module
  • MaBaseSchema
    • MaBaseSchema.on_bind_field()
    • MaBaseSchema.opts
  • SecurityBlueprint
  • camelcase()
• qunicorn_core.api.jwt module
  • JWTMixin
    • JWTMixin.require_jwt()
  • JWT_SCHEME

Module contents

Module containing all API related code of the project.

class qunicorn_core.api.RootView

Bases: MethodView

get() → Dict[str, str]

Get the Root API information containing the links to all versions of this api.

methods: t.ClassVar[t.Collection[str] | None] = {'GET'}

The methods this view is registered for. Uses the same default (["GET", "HEAD", "OPTIONS"]) as route and add_url_rule by default.

class qunicorn_core.api.VersionsRootSchema(*, 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.register_root_api(app: Flask)

Register the API with the flask app.