interaction.exception.base¶
_IResponseInformation¶
- class ding.interaction.exception.base._IResponseInformation[source]¶
- Overview:
Response information basic structure interface
- property code: int¶
- Overview:
Get response error code (0 means success)
- Returns:
code (
int): Response error code
- property data: Mapping[str, Any]¶
- Overview:
Get response data
- Returns:
data (
Mapping[str, Any]): Response data
- property message: str¶
- Overview:
Get response message
- Returns:
message (
str): Response message
- property success: bool¶
- Overview:
Get response success or not
- Returns:
success (
bool): Response success or not
ResponseException¶
- class ding.interaction.exception.base.ResponseException(error: requests.exceptions.HTTPError)[source]¶
- Overview:
Response exception, which can be directly raised in methods to create fail http response.
- __init__(error: requests.exceptions.HTTPError)[source]¶
- Overview:
Constructor of ResponseException
- Arguments:
error (
HTTPError): Original http exception object
- property code: int¶
- Overview:
Get response error code (0 means success)
- Returns:
code (
int): Response error code
- property data: Mapping[str, Any]¶
- Overview:
Get response data
- Returns:
data (
Mapping[str, Any]): Response data
- property message: str¶
- Overview:
Get response message
- Returns:
message (
str): Response message
- property status_code: int¶
- Overview:
Get http status code of response
- Returns:
status_code (
int): Http status code
- property success: bool¶
- Overview:
Get response success or not
- Returns:
success (
bool): Response success or not