docs: Change error parsing to check for 'message' (#1083)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [x] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [x] Ensure the tests and linter pass
- [x] Code coverage does not decrease (if any source code was changed)
- [x] Appropriate docs were updated (if necessary)
Fixes #1082 🦕
diff --git a/tests/test_errors.py b/tests/test_errors.py
index b0d1e43..8b99532 100644
--- a/tests/test_errors.py
+++ b/tests/test_errors.py
@@ -47,6 +47,24 @@
}
"""
+JSON_ERROR_CONTENT_NO_DETAIL = b"""
+{
+ "error": {
+ "errors": [
+ {
+ "domain": "global",
+ "reason": "required",
+ "message": "country is required",
+ "locationType": "parameter",
+ "location": "country"
+ }
+ ],
+ "code": 400,
+ "message": "country is required"
+ }
+}
+"""
+
def fake_response(data, headers, reason="Ok"):
response = httplib2.Response(headers)
@@ -112,3 +130,14 @@
resp, content = fake_response(b"}NOT OK", {"status": "400"}, reason=None)
error = HttpError(resp, content)
self.assertEqual(str(error), '<HttpError 400 "">')
+
+ def test_error_detail_for_missing_message_in_error(self):
+ """Test handling of data with missing 'details' or 'detail' element."""
+ resp, content = fake_response(
+ JSON_ERROR_CONTENT_NO_DETAIL,
+ {"status": "400", "content-type": "application/json"},
+ reason="Failed",
+ )
+ error = HttpError(resp, content)
+ self.assertEqual(str(error), '<HttpError 400 when requesting None returned "country is required". Details: "country is required">')
+ self.assertEqual(error.error_details, 'country is required')