fix: Correctly catch JSONDecodeError exceptions #26
Conversation
This file contains 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
Problem:
Since `requests` version `2.27.0` [1], the library has introduced its
own `JSONDecodeError` exception, to fix inconsistencies between `json`
and `simplejson`.
From that version onwards, if the project has `simplejson` installed,
the exception raised by `json()` is a subclass of
`simplejson.JSONDecodeError` instead of `json.JSONDecodeError`.
The Knock client is only handling `json.JSONDecodeError`, so in projects
where `simplejson` is installed, the exception is raised when `json()`
is not able to decode the response body (e.g. in 204 responses).
How to reproduce:
In a new virtualenv, install `requests`.
```python
>>> import json, requests
>>> isinstance(requests.exceptions.JSONDecodeError("", "", 0), json.JSONDecodeError)
True
```
Now, install `simplejson`.
```python
>>> import json, requests, simplejson
>>> isinstance(requests.exceptions.JSONDecodeError("", "", 0), json.JSONDecodeError)
False
>>> isinstance(requests.exceptions.JSONDecodeError("", "", 0), simplejson.JSONDecodeError)
True
```
Solution:
When available, import the `JSONDecodeError` class provided by
`requests`, and use that one to handle exceptions from the `json()`
method. Otherwise, first try to use the exception provided by
`simplejson`, and only use the one from `json` if none is available.
[1] psf/requests@db575ee
adamantike
force-pushed
the
fix/correctly-catch-json-decode-errors
branch
from
5b910b7
to
94beb00
Compare
|
@cjbell, gentle ping, based on previous commits. |
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.
Problem
Since
requestsversion2.27.0[1], the library has introduced its ownJSONDecodeErrorexception, to fix inconsistencies betweenjsonandsimplejson.From that version onwards, if the project has
simplejsoninstalled, the exception raised byjson()is a subclass ofsimplejson.JSONDecodeErrorinstead ofjson.JSONDecodeError.The Knock client is only handling
json.JSONDecodeError, so in projects wheresimplejsonis installed, the exception is raised whenjson()is not able to decode the response body (e.g. in 204 responses).How to reproduce
In a new virtualenv, install
requests.Now, install
simplejson.Solution
When available, import the
JSONDecodeErrorclass provided byrequests, and use that one to handle exceptions from thejson()method.[1] psf/requests@db575ee