wy_qcos.api.posiq.routes_jsonrpc package

Subpackages

Submodules

wy_qcos.api.posiq.routes_jsonrpc.device module

wy_qcos.api.posiq.routes_jsonrpc.device.get_devices(body=None, auth_data=Depends(auth))

Get device dict request.

参数:

  • body (schemas.GetDevicesRequest) -- devices request

  • auth_data (dict | None) -- auth data

返回:

Get devices response

返回类型:

dict[str, GetDeviceResponse]

wy_qcos.api.posiq.routes_jsonrpc.device.get_device(body, auth_data=Depends(auth))

Get device info request.

参数:

  • body (schemas.GetDeviceRequest) -- device name

  • auth_data (dict | None) -- auth data

返回:

Get device info response

返回类型:

GetDeviceResponse

wy_qcos.api.posiq.routes_jsonrpc.device.calibrate(body, auth_data=Depends(auth))

Calibrate device.

参数:

  • body (schemas.CalibrateDeviceRequest) -- device name

  • auth_data (dict | None) -- auth data

wy_qcos.api.posiq.routes_jsonrpc.device.set_device_options(body, auth_data=Depends(auth))

Set device Options request.

参数:

  • body (schemas.SetDeviceOptionsRequest) -- device name

  • auth_data (dict | None) -- auth data

返回:

Set device Options response

返回类型:

SetDeviceOptionsResponse

wy_qcos.api.posiq.routes_jsonrpc.device.enable_and_disable_qubit(body, auth_data=Depends(auth))

Enable and Disable Qubit request.

参数:

  • body (schemas.EnableAndDisableQubitRequest) -- device name

  • auth_data (dict | None) -- auth data

返回:

Enable and Disable Qubit response

返回类型:

EnableAndDisableQubitResponse

wy_qcos.api.posiq.routes_jsonrpc.driver module

wy_qcos.api.posiq.routes_jsonrpc.driver.get_drivers(body=None)

Get driver dict request.

参数:

body (schemas.GetDriversRequest) -- message

返回:

Get drivers response

返回类型:

dict[str, GetDriverResponse]

wy_qcos.api.posiq.routes_jsonrpc.driver.get_driver(body)

Get driver info request.

参数:

body (schemas.GetDriverRequest) -- driver_name

返回:

Get driver info response

返回类型:

GetDriverResponse

wy_qcos.api.posiq.routes_jsonrpc.errors module

JSON-RPC/RestfulAPI error-code mappings.

Error codes mappings and descriptions: .. code-block:: text

err_code

http_code

Description

Examples / Scenarios

0 -400 -401 -403 -404 -409

-500 -501 -503

2XX 400 401 403 404 409

500 501 503

Accepted / OK Bad Request Unauthorized Forbidden Not Found Conflict

Internal Server Error Not Implemented Service Unavailable

success invalid params / request unauthorized login / token unauthorized operations resource not found create duplicated resource name resource deps not met bug / exception not implemented service offline
class wy_qcos.api.posiq.routes_jsonrpc.errors.JsonRpcBaseError(*args, **kwargs)

基类：BaseError

JsonRpc Base Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

pydantic model DataModel

基类：BaseModel

Data Model.

Show JSON schema
{
   "title": "DataModel",
   "description": "Data Model.",
   "type": "object",
   "properties": {
      "details": {
         "title": "Details",
         "type": "string"
      }
   },
   "required": [
      "details"
   ]
}

Fields:

  • details (str)

field details: str [Required]
class wy_qcos.api.posiq.routes_jsonrpc.errors.BadRequestError(*args, **kwargs)

基类：JsonRpcBaseError

Bad Request Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -400
MESSAGE: str | None = 'Bad Request'
class wy_qcos.api.posiq.routes_jsonrpc.errors.UnauthorizedError(*args, **kwargs)

基类：JsonRpcBaseError

Unauthorized Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -401
MESSAGE: str | None = 'Unauthorized'
class wy_qcos.api.posiq.routes_jsonrpc.errors.ForbiddenError(*args, **kwargs)

基类：JsonRpcBaseError

Forbidden Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -403
MESSAGE: str | None = 'Forbidden'
class wy_qcos.api.posiq.routes_jsonrpc.errors.NotFoundError(*args, **kwargs)

基类：JsonRpcBaseError

Not Found Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -404
MESSAGE: str | None = 'Not Found'
class wy_qcos.api.posiq.routes_jsonrpc.errors.ConflictError(*args, **kwargs)

基类：JsonRpcBaseError

Conflict Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -409
MESSAGE: str | None = 'Conflict'
class wy_qcos.api.posiq.routes_jsonrpc.errors.InternalServerError(*args, **kwargs)

基类：JsonRpcBaseError

Internal Server Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -500
MESSAGE: str | None = 'Internal Server Error'
class wy_qcos.api.posiq.routes_jsonrpc.errors.NotImplementedError(*args, **kwargs)

基类：JsonRpcBaseError

Not Implemented Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -501
MESSAGE: str | None = 'Not Implemented'
class wy_qcos.api.posiq.routes_jsonrpc.errors.ServiceUnavailableError(*args, **kwargs)

基类：JsonRpcBaseError

Service Unavailable Error.

参数:

  • args (Any)

  • kwargs (Any)

返回类型:

Any

CODE: int | None = -503
MESSAGE: str | None = 'Service Unavailable'
wy_qcos.api.posiq.routes_jsonrpc.errors.handle_errors(err_cls, module_name, func_name, results, param_name, code)

Handle errors.

参数:

  • err_cls -- error class

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param

  • code -- error code

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_bad_requests(module_name, func_name, results, param_name=None, code=None)

Handle bad_requests error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_unauthorized(module_name, func_name, results, param_name=None, code=None)

Handle unauthorized error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_forbidden(module_name, func_name, results, param_name=None, code=None)

Handle forbidden error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_not_found(module_name, func_name, results, param_name=None, code=None)

Handle forbidden error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_conflict(module_name, func_name, results, param_name=None, code=None)

Handle conflict error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_internal_server(module_name, func_name, results, param_name=None, code=None)

Handle internal server error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_not_implemented(module_name, func_name, results, param_name=None, code=None)

Handle not implemented error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.errors.handle_error_service_unavailable(module_name, func_name, results, param_name=None, code=None)

Handle service unavailable error.

参数:

  • module_name -- module name

  • func_name -- function name

  • results -- results for jsonrpc

  • param_name -- name of the param (Default value = None)

  • code -- error code (Default value = None)

wy_qcos.api.posiq.routes_jsonrpc.job module

wy_qcos.api.posiq.routes_jsonrpc.job.submit_job(body, auth_data=Depends(auth))

Submit job.

参数:

  • body (schemas.SubmitJobRequest) -- job info

  • auth_data (dict | None) -- auth data

返回:

job info

返回类型:

SubmitJobResponse

wy_qcos.api.posiq.routes_jsonrpc.job.get_job_status(body, auth_data=Depends(auth))

Get job status.

参数:

  • body (schemas.GetJobStatusRequest) -- job_id: job ID

  • auth_data (dict | None) -- auth data

返回:

job status

返回类型:

GetJobStatusResponse

wy_qcos.api.posiq.routes_jsonrpc.job.get_job_results(body, auth_data=Depends(auth))

Get job results.

参数:

  • body (schemas.GetJobResultsRequest) -- job_id: job ID

  • auth_data (dict | None) -- auth data

返回:

job results

返回类型:

GetJobResultsResponse

wy_qcos.api.posiq.routes_jsonrpc.job.get_jobs(body=None, auth_data=Depends(auth))

Get job list.

参数:

  • body (schemas.GetJobsRequest) -- job_id: job ID

  • auth_data (dict | None) -- auth data

返回:

job list

返回类型:

list[GetJobStatusResponse]

wy_qcos.api.posiq.routes_jsonrpc.job.cancel_jobs(body, auth_data=Depends(auth))

Cancel job.

参数:

  • body (schemas.CancelJobsRequest) -- job_ids: job IDs

  • auth_data (dict | None) -- auth data

返回:

cancelled jobs info

返回类型:

list[CancelJobsResponse]

wy_qcos.api.posiq.routes_jsonrpc.job.delete_jobs(body, auth_data=Depends(auth))

Delete job.

参数:

  • body (schemas.DeleteJobsRequest) -- job_ids: job IDs

  • auth_data (dict | None) -- auth data

返回:

deleted jobs info

返回类型:

list[DeleteJobsResponse]

wy_qcos.api.posiq.routes_jsonrpc.job.set_job_results(body, auth_data=Depends(auth))

Set job results for existing job.

参数:

  • body (schemas.SetJobResultsRequest) -- job_id: job ID

  • auth_data (dict | None) -- auth data

返回类型:

SetJobResultsResponse

wy_qcos.api.posiq.routes_jsonrpc.job.update_job(body, auth_data=Depends(auth))

Update job.

参数:

  • body (schemas.UpdateJobsRequest) -- job info

  • auth_data (dict | None) -- auth data

返回:

update job param

返回类型:

UpdateJobResponse

wy_qcos.api.posiq.routes_jsonrpc.job.merge_results(response_info, parameters, results=None)

Merge results.

参数:

  • response_info -- response info

  • parameters -- parameters from prefect

  • results -- results from prefect (Default value = None)

返回:

new response info

wy_qcos.api.posiq.routes_jsonrpc.routes module

wy_qcos.api.posiq.routes_jsonrpc.system module

wy_qcos.api.posiq.routes_jsonrpc.system.ping(body)

Ping-pong to verify the availability of the system.

参数:

body (schemas.PingRequest) -- message

返回:

pong response

返回类型:

PongResponse

wy_qcos.api.posiq.routes_jsonrpc.system.system_info(body=None, auth_data=Depends(auth))

Get system info.

参数:

  • body (schemas.SystemInfoRequest) -- System Info Request

  • auth_data (dict | None) -- auth data

返回:

system info response

返回类型:

SystemInfoResponse

wy_qcos.api.posiq.routes_jsonrpc.transpiler module

wy_qcos.api.posiq.routes_jsonrpc.transpiler.get_transpilers(body=None)

Get transpiler list request.

参数:

body (schemas.GetTranspilersRequest) -- message

返回:

Get transpilers response

返回类型:

dict[str, GetTranspilerResponse]

wy_qcos.api.posiq.routes_jsonrpc.transpiler.get_transpiler(body)

Get transpiler info request.

参数:

body (schemas.GetTranspilerRequest) -- driver_name

返回:

Get transpiler info response

返回类型:

GetTranspilerResponse

wy_qcos.api.posiq.routes_jsonrpc.version module

wy_qcos.api.posiq.routes_jsonrpc.version.version(body)

Get server version.

参数:

body (GetVersionRequest) -- schemas.GetVersionRequest: (Default value = None)

返回类型:

GetVersionResponse

Module contents