Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Improve support for error_details #1126

Merged
merged 3 commits into from Dec 9, 2020
Merged

fix: Improve support for error_details #1126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8746a7d
fix: Improve support for error_details(HttpErrors)
parthea Dec 6, 2020
64849b7
Catch JSONDecodeError instead of all exceptions
parthea Dec 8, 2020
4ad9969
Merge branch 'master' into allow-non-json-errors
parthea Dec 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 7 additions & 1 deletion googleapiclient/errors.py
View file
Open in desktop
Expand Up @@ -48,7 +48,11 @@ def _get_reason(self):
"""Calculate the reason for the error from the response content."""
reason = self.resp.reason
try:
data = json.loads(self.content.decode("utf-8"))
try:
data = json.loads(self.content.decode("utf-8"))
except json.JSONDecodeError:
# In case it is not json
data = self.content.decode("utf-8")
if isinstance(data, dict):
reason = data["error"]["message"]
error_detail_keyword = next((kw for kw in ["detail", "details", "message"] if kw in data["error"]), "")
Expand All @@ -59,6 +63,8 @@ def _get_reason(self):
reason = first_error["error"]["message"]
if "details" in first_error["error"]:
self.error_details = first_error["error"]["details"]
else:
self.error_details = data
except (ValueError, KeyError, TypeError):
pass
if reason is None:
Expand Down
10 changes: 5 additions & 5 deletions tests/test_errors.py
View file
Open in desktop
Expand Up @@ -94,7 +94,7 @@ def test_bad_json_body(self):
b"{", {"status": "400", "content-type": "application/json"}, reason="Failed"
)
error = HttpError(resp, content)
self.assertEqual(str(error), '<HttpError 400 "Failed">')
self.assertEqual(str(error), '<HttpError 400 when requesting None returned "Failed". Details: "{">')

def test_with_uri(self):
"""Test handling of passing in the request uri."""
Expand All @@ -106,7 +106,7 @@ def test_with_uri(self):
error = HttpError(resp, content, uri="http://example.org")
self.assertEqual(
str(error),
'<HttpError 400 when requesting http://example.org returned "Failure">',
'<HttpError 400 when requesting http://example.org returned "Failure". Details: "{">',
)

def test_missing_message_json_body(self):
Expand All @@ -121,15 +121,15 @@ def test_missing_message_json_body(self):

def test_non_json(self):
"""Test handling of non-JSON bodies"""
resp, content = fake_response(b"}NOT OK", {"status": "400"})
resp, content = fake_response(b"Invalid request", {"status": "400"})
error = HttpError(resp, content)
self.assertEqual(str(error), '<HttpError 400 "Ok">')
self.assertEqual(str(error), '<HttpError 400 when requesting None returned "Ok". Details: "Invalid request">')

def test_missing_reason(self):
"""Test an empty dict with a missing resp.reason."""
resp, content = fake_response(b"}NOT OK", {"status": "400"}, reason=None)
error = HttpError(resp, content)
self.assertEqual(str(error), '<HttpError 400 "">')
self.assertEqual(str(error), '<HttpError 400 when requesting None returned "". Details: "}NOT OK">')

def test_error_detail_for_missing_message_in_error(self):
"""Test handling of data with missing 'details' or 'detail' element."""
Expand Down