Simplify ApiError messages and add data attributes #69
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Python 2 `json` module doesn't have a `JSONDecodeError`. **ugh** Fortunately `JSONDecodeError` is a subclass of `ValueError`, so we can use this to catch the same parsing error in both Python 2 and 3.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per issue #62: Simplify the default string interpretation of the
ApiErrormessages.The simplified messages will use the
messageattribute of the returned JSON (if present) to provide more insight as to why the request failed and will default to the generic error descriptions from the API docs if amessageattribute is not available.Example of the New Message Format:
The
ApiErrorexceptions now have several attributes exposed for inspection:response- Therequests.Responseobject returned from the API call.request- Therequests.PreparedRequestused to submit the API request.status_code- The HTTP status code from the API response.status- The HTTP status from the API response.details- The parsed JSON details from the API response.message- The error message from the parsed API response.description- A description of the HTTP Response Code from the API docs.This enhancement also solves issue #68.