wy_qcos_client.common package

Submodules

wy_qcos_client.common.args_schema module

wy_qcos_client.common.args_schema.is_valid_url(url, schemes)

Check if url is valid.

参数:

  • url -- url to check

  • schemes -- url schemes

返回:

True if valid, False otherwise

wy_qcos_client.common.client_library module

class wy_qcos_client.common.client_library.ClientLibrary

基类：object

Client library.

static get_current_datetime()

Get current datetime.

返回:

datetime

static call_http_api(url, method, *, data=None, json=None, files=None, params=None, func_name=None, headers=None, auth=None, use_ssl=False, verify_ssl=True, cert_file=None, key_file=None, retries=1, timeout=30, success_http_code=[200, 201], debug=False)

Call http api.

参数:

  • url -- api url

  • method -- http method

  • data -- data for http body (Default value = None)

  • json -- json data for http body (Default value = None)

  • files -- files for http body (Default value = None)

  • params -- params for http url (Default value = None)

  • func_name -- function name (Default value = None)

  • headers -- http headers (Default value = None)

  • auth -- http auth (Default value = None)

  • use_ssl -- if use ssl certificate

  • verify_ssl -- if verify ssl certificate (Default value = False)

  • cert_file -- ssl cert file

  • key_file -- ssl key file

  • retries -- times to retry if failed (Default value = 1)

  • timeout -- timeout in seconds (Default value = 10)

  • success_http_code -- success http status (Default value = [200)

  • debug -- enable or disable debug (Default value = False)

static read_file(file_path, replace_pattern=None, customer_format=None)

Read text file.

参数:

  • file_path -- file path

  • replace_pattern -- replace pattern (Default value = None)

  • customer_format -- customer format (Default value = None)

返回:

file content

static read_csv_file(file_path)
static validate_schema(value, schema_obj, allow_none=False, ignore_extra_keys=False)

Validate schema values.

参数:

  • value -- value to be validated

  • schema_obj -- schema obj

  • allow_none -- allow None value (Default value = False)

  • ignore_extra_keys -- ignore extra keys (Default value = False)

返回:

success of failed (bool), error message list

static validate_values_enum(value, param_name, value_list, allow_none=False)

Validate values for enum.

参数:

  • value -- value

  • param_name -- param name

  • value_list -- valid value list

  • allow_none -- allow None value (Default value = False)

返回:

success of failed (bool), error message list

static validate_values_uuid(value, param_name)

Validate values for uuid.

参数:

  • value -- value

  • param_name -- param name

返回:

success of failed (bool), error message list

static validate_values_range(value, param_name, min_value=None, max_value=None)

Validate values for int range.

参数:

  • value -- value

  • param_name -- param name

  • min_value -- minimum value (Default value = None)

  • max_value -- maximum value (Default value = None)

返回:

success of failed (bool), error message list

static validate_values_length(value, param_name, min_value=None, max_value=None, allow_none=False)

Validate values for int range.

参数:

  • value -- value

  • param_name -- param name

  • min_value -- minimum value (Default value = None)

  • max_value -- maximum value (Default value = None)

  • allow_none -- allow None value (Default value = False)

返回:

success of failed (bool), error message list

wy_qcos_client.common.constant module

class wy_qcos_client.common.constant.Constant

基类：object

Constants.

DEFAULT_API_SERVER_LISTEN_IP = ''
DEFAULT_API_SERVER_LISTEN_PORT = 18400
DEFAULT_API_VERSION = 'v1'
DEFAULT_QCOS_SERVER_IP = '127.0.0.1'
DEFAULT_QCOS_SERVER_PORT = 18400
CODE_TYPE_QASM = 'qasm'
CODE_TYPE_QASM2 = 'qasm2'
CODE_TYPE_QASM3 = 'qasm3'
CODE_TYPE_QUBO = 'qubo'
CODE_TYPES_ALL_QASM = ['qasm', 'qasm2', 'qasm3']
CODE_TYPES = ['qasm', 'qasm2', 'qasm3', 'qubo']
CALLBACK_TYPE_RESULTS = 'results'
CALLBACK_TYPES = ['results']
AGGREGATION_TYPE_INTERNAL = 'internal'
AGGREGATION_TYPE_EXTERNAL = 'external'
AGGREGATION_TYPE_NONE = 'None'
AGGREGATION_TYPES = ['None', 'internal', 'external']
FILE_TYPE_QASM = '.qasm'
FILE_TYPE_JSON = '.json'
FILE_TYPE_CSV = '.csv'
MIN_DESCRIPTION_LENGTH = 1
MAX_DESCRIPTION_LENGTH = 255
JOB_TYPE_SAMPLING = 'sampling'
JOB_TYPE_ESTIMATION = 'estimation'
JOB_TYPES = ['sampling', 'estimation']
DEFAULT_JOB_PRIORITY = 5
MIN_JOB_PRIORITY = 1
MAX_JOB_PRIORITY = 10
ENV_VAR_ACCESS_TOKEN = 'QCOS_ACCESS_TOKEN'
ENV_VAR_REFRESH_TOKEN = 'QCOS_REFRESH_TOKEN'
ENV_VAR_VIRTUAL_INSTANCE_ID = 'QCOS_VIRTUAL_INSTANCE_ID'
JOB_STATUS_UNKNOWN = 'UNKNOWN'
JOB_STATUS_QUEUED = 'QUEUED'
JOB_STATUS_RUNNING = 'RUNNING'
JOB_STATUS_FAILED = 'FAILED'
JOB_STATUS_COMPLETED = 'COMPLETED'
JOB_STATUS_CANCELLING = 'CANCELLING'
JOB_STATUS_CANCELLED = 'CANCELLED'
JOB_STATUS_DELETED = 'DELETED'
JOB_STATUSES = ['UNKNOWN', 'QUEUED', 'RUNNING', 'FAILED', 'COMPLETED', 'CANCELLING', 'CANCELLED', 'DELETED']
DEFAULT_SHOTS = 1
MIN_SHOTS = 1
MAX_SHOTS = 10240
DRIVER_DUMMY = 'dummy'
DEVICE_DUMMY = 'dummy'
TRANSPILER_CMSS = 'cmss'
PROFILING_TYPE_ALL = 'all'
PROFILING_TYPE_CODE = 'code'
PROFILING_TYPE_SCHEDULING = 'scheduling'
PROFILING_TYPE_DRIVER_PARSE = 'driver:parse'
PROFILING_TYPE_DRIVER_TRANSPILE = 'driver:transpile'
PROFILING_TYPE_DRIVER_RUN = 'driver:run'
PROFILING_TYPE_MACHINE = 'machine'
PROFILING_TYPES = ['all', 'code', 'scheduling', 'driver:parse', 'driver:transpile', 'driver:run', 'machine']
class wy_qcos_client.common.constant.HttpHeaders

基类：object

DEFAULT_JSON_HEADERS = {'Accept': 'application/json', 'Content-Type': 'application/json'}
class wy_qcos_client.common.constant.HttpMethod

基类：object

HTTP methods.

GET = 'get'
POST = 'post'
PUT = 'put'
PATCH = 'patch'
DELETE = 'delete'
class wy_qcos_client.common.constant.HttpCode

基类：object

HTTP status codes.

SUCCESS_OK = 200
SUCCESS_CREATED = 201
SUCCESS_ACCEPTED = 202
SUCCESS_NO_CONTENT = 204
ERROR_BAD_REQUEST = 400
ERROR_UNAUTHORIZED = 401
ERROR_FORBIDDEN = 403
ERROR_NOT_FOUND = 404
ERROR_TIMEOUT = 408
ERROR_CONFLICT = 409
ERROR_INTERNAL_SERVER = 500
ERROR_INTERNAL_SERVER_ERROR = 500
ERROR_NOT_IMPLEMENTED = 501
ERROR_SERVICE_UNAVAILABLE = 503

wy_qcos_client.common.errors module

exception wy_qcos_client.common.errors.BaseException(message)

基类：Exception

Base exception.

get_error_code()

Get error code.

返回:

error code

get_err_msgs()
exception wy_qcos_client.common.errors.GenericException(message)

基类：BaseException

Generic exception.

module_name = 'Generic'
error_code = -10
err_type = 'Error'
exception wy_qcos_client.common.errors.InvalidArguments(message)

基类：BaseException

Invalid arguments.

module_name = 'Generic'
error_code = -11
err_type = 'Invalid arguments'

wy_qcos_client.common.qcos_version module

class wy_qcos_client.common.qcos_version.QcosVersion

基类：object

QCOS Version.

VERSION = '1.1.0'

Module contents