qcg.pilotjob.response module

class qcg.pilotjob.response.ResponseCode

Bases: enum.IntEnum

Response status.

OK = 0
ERROR = 1
class qcg.pilotjob.response.Response(code=<ResponseCode.OK: 0>, msg=None, data=None)

Bases: object

Response data.

The response is sent back to the sender of request.

code

response status

Type:ResponseCode
msg

response message

Type:str
data

response data

Type:

Initialize response.

Parameters:
  • code (ResponseCode) – response status
  • msg (str, optional) – message
  • data – data
classmethod ok(msg=None, data=None)

Create success response.

Parameters:
  • msg (str, optional) – message
  • data (*, optional) – data
classmethod error(msg=None, data=None)

Create error response.

Parameters:
  • msg (str, optional) – message
  • data (*, optional) – data
to_dict()

Serialize response to dictionary.

Returns:serialized response
Return type:dict
to_json()

Serialize response to JSON format.

Returns:serialized response
Return type:str