docs: Change error parsing to check for 'message' (googleapis#1083)

mm326 · web-flow · commit a341c5a5e31b · 2020-11-08T20:30:02.000Z
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 googleapis#1082 🦕
diff --git a/docs/start.md b/docs/start.md
@@ -94,7 +94,10 @@ request = collection.list(cents=5)
 Creating a request does not actually call the API. To execute the request and get a response, call the `execute()` function:
 
 ```python
-response = request.execute()
+try:
+    response = request.execute()
+except HttpError as e:
+    print('Error response status code : {0}, reason : {1}'.format(e.resp.status, e.error_details))
 ```
 
 Alternatively, you can combine previous steps on a single line:
diff --git a/googleapiclient/errors.py b/googleapiclient/errors.py
@@ -51,10 +51,9 @@ def _get_reason(self):
             data = json.loads(self.content.decode("utf-8"))
             if isinstance(data, dict):
                 reason = data["error"]["message"]
-                if "details" in data["error"]:
-                    self.error_details = data["error"]["details"]
-                elif "detail" in data["error"]:
-                    self.error_details = data["error"]["detail"]
+                error_detail_keyword = next((kw for kw in ["detail", "details", "message"] if kw in data["error"]), "")
+                if error_detail_keyword:
+                    self.error_details = data["error"][error_detail_keyword]
             elif isinstance(data, list) and len(data) > 0:
                 first_error = data[0]
                 reason = first_error["error"]["message"]
diff --git 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 @@ def test_missing_reason(self):
         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')
diff --git a/tests/test_http.py b/tests/test_http.py
@@ -1567,7 +1567,8 @@ def test_execute_batch_http_error(self):
         expected = (
             "<HttpError 403 when requesting "
             "https://www.googleapis.com/someapi/v1/collection/?foo=bar returned "
-            '"Access Not Configured">'
+            '"Access Not Configured". '
+            'Details: "Access Not Configured">'
         )
         self.assertEqual(expected, str(callbacks.exceptions["2"]))
 

Original file line number	Diff line number	Diff line change
`@@ -1567,7 +1567,8 @@ def test_execute_batch_http_error(self):`
`1567`	`1567`	`expected = (`
`1568`	`1568`	`"<HttpError 403 when requesting "`
`1569`	`1569`	`"https://www.googleapis.com/someapi/v1/collection/?foo=bar returned "`
`1570`		`- '"Access Not Configured">'`
	`1570`	`+ '"Access Not Configured". '`
	`1571`	`+ 'Details: "Access Not Configured">'`
`1571`	`1572`	`)`
`1572`	`1573`	`self.assertEqual(expected, str(callbacks.exceptions["2"]))`
`1573`	`1574`