refactor: wraps 500 and 504 erros to specific exceptions

It was created specific exceptions for each status code: InternalServerErrorException for status 500 and GatewayTimeoutException for status 504. Additionally, it was created a base exception class, ServerErrorException, that both specific exceptions will inherit from.
danielnsilva · Jul 7, 2024 · 76645ef · 76645ef
1 parent 4d88364
commit 76645ef
Show file tree

Hide file tree

Showing 3 changed files with 74 additions and 4 deletions.
diff --git a/semanticscholar/ApiRequester.py b/semanticscholar/ApiRequester.py
@@ -9,7 +9,8 @@
 from tenacity import retry_if_exception_type, stop_after_attempt, wait_fixed
 
 from semanticscholar.SemanticScholarException import (
-    BadQueryParametersException, ObjectNotFoundException)
+    BadQueryParametersException, GatewayTimeoutException,
+    InternalServerErrorException, ObjectNotFoundException)
 
 logger = logging.getLogger('semanticscholar')
 
@@ -132,9 +133,12 @@ async def _get_data_async(
             raise ObjectNotFoundException(data['error'])
         elif r.status_code == 429:
             raise ConnectionRefusedError('HTTP status 429 Too Many Requests.')
-        elif r.status_code in [500, 504]:
+        elif r.status_code == 500:
             data = r.json()
-            raise Exception(data['message'])
+            raise InternalServerErrorException(data['message'])
+        elif r.status_code == 504:
+            data = r.json()
+            raise GatewayTimeoutException(data['message'])
 
         return data
 

diff --git a/semanticscholar/SemanticScholarException.py b/semanticscholar/SemanticScholarException.py
@@ -14,3 +14,12 @@ class ObjectNotFoundException(SemanticScholarException):
 
 class NoMorePagesException(SemanticScholarException):
     '''No more pages to fetch.'''
+
+class ServerErrorException(SemanticScholarException):
+    '''A base class for HTTP Status Code 5xx errors.'''
+
+class InternalServerErrorException(ServerErrorException):
+    '''HTTP Status Code 500.'''
+
+class GatewayTimeoutException(ServerErrorException):
+    '''HTTP Status Code 504.'''
diff --git a/tests/test_semanticscholar.py b/tests/test_semanticscholar.py
@@ -5,7 +5,9 @@
 import sys
 import unittest
 from datetime import datetime
+from unittest import mock
 
+import httpx
 import vcr
 from httpx import TimeoutException
 
@@ -18,7 +20,9 @@
 from semanticscholar.Reference import Reference
 from semanticscholar.SemanticScholar import SemanticScholar
 from semanticscholar.SemanticScholarException import (
-    BadQueryParametersException, NoMorePagesException, ObjectNotFoundException)
+    BadQueryParametersException, GatewayTimeoutException,
+    InternalServerErrorException, NoMorePagesException,
+    ObjectNotFoundException, ServerErrorException)
 from semanticscholar.Tldr import Tldr
 
 test_vcr = vcr.VCR(
@@ -580,6 +584,33 @@ def test_debug(self):
             self.sch.get_papers(list_of_paper_ids)
             self.assertIn(expected_output, log.output)
 
+    @mock.patch('httpx.AsyncClient.request')
+    def test_exception_internal_server_error(self, mock_request):
+        mock_response = httpx.Response(
+            status_code=500, json={'message': 'message'})
+        mock_request.return_value = mock_response
+        with self.assertRaises(InternalServerErrorException):
+            self.sch.get_paper('10.1093/mind/lix.236.433')
+
+    @mock.patch('httpx.AsyncClient.request')
+    def test_exception_gateway_timeout(self, mock_request):
+        mock_response = httpx.Response(
+            status_code=504, json={'message': 'message'})
+        mock_request.return_value = mock_response
+        with self.assertRaises(GatewayTimeoutException):
+            self.sch.get_paper('10.1093/mind/lix.236.433')
+
+    @mock.patch('httpx.AsyncClient.request')
+    def test_exception_server_error(self, mock_request):
+        error_status = [500, 504]
+        for status_code in error_status:
+            mock_response = httpx.Response(
+                status_code=status_code, json={'message': 'message'})
+            mock_request.return_value = mock_response
+            with self.assertRaises(ServerErrorException):
+                self.sch.get_paper('10.1093/mind/lix.236.433')
+
+
 class AsyncSemanticScholarTest(unittest.IsolatedAsyncioTestCase):
 
     def setUp(self) -> None:
@@ -938,6 +969,32 @@ async def test_limit_value_exceeded_async(self):
                     await method(query, limit=0)
                     self.assertEqual(str(context.exception), error_message)
 
+    @mock.patch('httpx.AsyncClient.request')
+    async def test_exception_internal_server_error_async(self, mock_request):
+        mock_response = httpx.Response(
+            status_code=500, json={'message': 'message'})
+        mock_request.return_value = mock_response
+        with self.assertRaises(InternalServerErrorException):
+            await self.sch.get_paper('10.1093/mind/lix.236.433')
+
+    @mock.patch('httpx.AsyncClient.request')
+    async def test_exception_gateway_timeout_async(self, mock_request):
+        mock_response = httpx.Response(
+            status_code=504, json={'message': 'message'})
+        mock_request.return_value = mock_response
+        with self.assertRaises(GatewayTimeoutException):
+            await self.sch.get_paper('10.1093/mind/lix.236.433')
+
+    @mock.patch('httpx.AsyncClient.request')
+    async def test_exception_server_error_async(self, mock_request):
+        error_status = [500, 504]
+        for status_code in error_status:
+            mock_response = httpx.Response(
+                status_code=status_code, json={'message': 'message'})
+            mock_request.return_value = mock_response
+            with self.assertRaises(ServerErrorException):
+                await self.sch.get_paper('10.1093/mind/lix.236.433')
+
 
 if __name__ == '__main__':
     unittest.main()