graviti.exception#

Basic concepts of Graviti custom exceptions.

Module Contents#

exception graviti.exception.GravitiException(message=None)[source]#

Bases: Exception

This is the base class for Graviti custom exceptions.

Parameters

message (Optional[str]) – The error message.

exception graviti.exception.ClientError(message=None)[source]#

Bases: GravitiException

This is the base class for custom exceptions in Graviti client module.

Parameters

message (Optional[str]) –

exception graviti.exception.StatusError(message=None, *, is_draft=None)[source]#

Bases: ClientError

This class defines the exception for illegal status.

Parameters

  • is_draft (Optional[bool]) – Whether the status is draft.

  • message (Optional[str]) – The error message.

exception graviti.exception.ResponseError(message=None, *, response=None)[source]#

Bases: ClientError

This class defines the exception for post response error.

Parameters

  • response (Optional[requests.models.Response]) – The response of the request.

  • message (Optional[str]) –

response#

The response of the request.

exception graviti.exception.AccessDeniedError(message=None, *, response=None)[source]#

Bases: ResponseError

This class defines the exception for access denied response error.

Parameters

  • message (Optional[str]) –

  • response (Optional[requests.models.Response]) –

exception graviti.exception.ForbiddenError(message=None, *, response=None)[source]#

Bases: ResponseError

This class defines the exception for illegal operations Graviti forbids.

Parameters

  • message (Optional[str]) –

  • response (Optional[requests.models.Response]) –

exception graviti.exception.InvalidParamsError(message=None, *, response=None, param_name=None, param_value=None)[source]#

Bases: ResponseError

This class defines the exception for invalid parameters response error.

Parameters

  • response (Optional[requests.models.Response]) – The response of the request.

  • param_name (Optional[str]) – The name of the invalid parameter.

  • param_value (Optional[str]) – The value of the invalid parameter.

  • message (Optional[str]) –

response#

The response of the request.

exception graviti.exception.NameConflictError(message=None, *, response=None, resource=None, identification=None)[source]#

Bases: ResponseError

This class defines the exception for name conflict response error.

Parameters

  • response (Optional[requests.models.Response]) – The response of the request.

  • resource (Optional[str]) – The type of the conflict resource.

  • identification (Union[int, str, None]) – The identification of the conflict resource.

  • message (Optional[str]) –

response#

The response of the request.

exception graviti.exception.RequestParamsMissingError(message=None, *, response=None)[source]#

Bases: ResponseError

This class defines the exception for request parameters missing response error.

Parameters

  • message (Optional[str]) –

  • response (Optional[requests.models.Response]) –

exception graviti.exception.ResourceNotExistError(message=None, *, response=None, resource=None, identification=None)[source]#

Bases: ResponseError

This class defines the exception for resource not existing response error.

Parameters

  • response (Optional[requests.models.Response]) – The response of the request.

  • resource (Optional[str]) – The type of the conflict resource.

  • identification (Union[int, str, None]) – The identification of the conflict resource.

  • response – The response of the request.

  • message (Optional[str]) –

exception graviti.exception.InternalServerError(message=None, *, response=None)[source]#

Bases: ResponseError

This class defines the exception for internal server error.

Parameters

  • message (Optional[str]) –

  • response (Optional[requests.models.Response]) –

exception graviti.exception.UnauthorizedError(message=None, *, response=None)[source]#

Bases: ResponseError

This class defines the exception for unauthorized response error.

Parameters

  • message (Optional[str]) –

  • response (Optional[requests.models.Response]) –

graviti.exception.RESPONSE_ERROR_DISTRIBUTOR :Dict[str, Type[ResponseError]][source]#
exception graviti.exception.UtilityError(message=None)[source]#

Bases: GravitiException

This is the base class for custom exceptions in Graviti utility module.

Parameters

message (Optional[str]) –

exception graviti.exception.AttrError(message=None)[source]#

Bases: UtilityError

This class defines the exception for dynamic attr have default value.

Parameters

message (Optional[str]) –