Client¶
JijZeptClient ¶
__init__(*, url=None, token=None, proxy=None, config=None, config_env='default') ¶
Constructor of JijZept client.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url | str | None | url. Defaults to None. | None |
token | str | None | token string. Defaults to None. | None |
proxy | str | None | proxy string. Defaults to None. | None |
config | PATH_TYPE | None | config path. Defaults to None. | None |
config_env | str | config_env. Defaults to "default". | 'default' |
fetch_result(solution_id=None, endpoint='/query/solution') ¶
Fetch result and solution from JijZept.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
solution_id | Optional[str] | solution id. Defaults to None. | None |
endpoint | str | endpoint. Defaults to "/query/solution". | '/query/solution' |
Returns:
| Name | Type | Description |
|---|---|---|
dict | dict | serialized result of derived information |
post_instance(instance_type, instance, endpoint='/instance') ¶
Send instance to JijZept.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
instance_type | str | instance_type of the instance | required |
instance | Dict[str, Any] | serialized instance object. This object is compressed by zstandard | required |
endpoint | str | endpoint. Defaults to "/instance". | '/instance' |
Raises:
| Type | Description |
|---|---|
TypeError |
|
Returns:
| Name | Type | Description |
|---|---|---|
str | str | returned instance id |
submit_solve_query(queue_name, solver_name, parameters, instance_id=None, timeout=None, endpoint='/query/solution') ¶
Submit solve request to JijZept.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
queue_name | str | queue_name | required |
solver_name | str | solver_name | required |
parameters | dict | parameters to be sent to queue | required |
instance_id | Optional[str] | problem instance id. Defaults to None. | None |
timeout | Optional[float] | timeout paraemter [second]. if None, timeout is set to inifite. | None |
endpoint | str | endpoint. Defaults to "/query/solution". | '/query/solution' |
Returns:
| Type | Description |
|---|---|
dict[str, str] | Dict[str, str]: solution id information. |
status_check(res) ¶
Do status check of response data.
If request has some HTTPError, this function raises Exception.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
res | requests.Response | response from http request | required |
Raises:
| Type | Description |
|---|---|
requests.exceptions.HTTPError | response has some error. |