Migrating away from from_get() method, using abstract request() method for easier exception handling

Author: Jason Costello

hypervector/resources/abstract/api_resource.py

@@ -1,6 +1,6 @@
 import requests
 import hypervector
-from hypervector.errors import APIKeyNotSetError, HypervectorError, APIBaseError
+from hypervector.errors import APIKeyNotSetError, HypervectorError, APIConnectionError
 
 
 class APIResource:
@@ -17,30 +17,26 @@ def get_headers(cls):
         return cls.headers
 
     @classmethod
-    def get(cls, uuid):
-        endpoint = f'{hypervector.API_BASE}/{cls.resource_name}/{uuid}'
+    def request(cls, endpoint, method=requests.get, json=None):
         try:
-            response = requests.get(endpoint, headers=cls.get_headers())
+            response = method(url=endpoint, headers=cls.get_headers(), json=json)
         except requests.ConnectionError:
-            raise APIBaseError
-
-        if response.ok:
-            return cls.from_get(response)
-        else:
-            raise HypervectorError
-
-    @classmethod
-    def request(cls, endpoint, method=requests.get):
-        try:
-            response = method(url=endpoint, headers=cls.get_headers())
-        except requests.ConnectionError:
-            raise APIBaseError
+            raise APIConnectionError(
+                "There was a problem reaching the Hypervector API. Please "
+                "check your hypervector.API_BASE setting"
+            )
 
         if response.ok:
             return response.json()
         else:
             raise HypervectorError(response)
 
+    @classmethod
+    def get(cls, uuid):
+        endpoint = f'{hypervector.API_BASE}/{cls.resource_name}/{uuid}'
+        response = cls.request(endpoint)
+        return cls.from_response(response)
+
     @classmethod
     def delete(cls, uuid):
         endpoint = f'{hypervector.API_BASE}/{cls.resource_name}/{uuid}/delete'

hypervector/resources/core/benchmark.py

@@ -28,10 +28,6 @@ def to_response(self):
             "definition_uuid": self.definition_uuid
         }
 
-    @classmethod
-    def from_get(cls, response):
-        return cls.from_response(response.json())
-
     def refresh(self):
         benchmark = self.get(self.benchmark_uuid)
         self.__dict__.update(benchmark.__dict__)
@@ -53,7 +49,7 @@ def new(cls, ensemble, expected_output):
             expected_output = expected_output.tolist()
 
         data = {"expected_output": expected_output}
-        response = requests.post(endpoint, json=data, headers=cls.get_headers()).json()
+        response = cls.request(endpoint, method=requests.post, json=data)
         return cls.from_response(response)
 
     def assert_equal(self, output_to_assert):

hypervector/resources/core/definition.py

@@ -34,10 +34,6 @@ def to_response(self):
             "ensembles": self.ensembles
         }
 
-    @classmethod
-    def from_get(cls, response):
-        return cls.from_response(response.json())
-
     def refresh(self):
         definition = self.get(self.definition_uuid)
         self.__dict__.update(definition.__dict__)

hypervector/resources/core/ensemble.py

@@ -42,10 +42,6 @@ def to_response(self):
             "benchmarks": self.benchmarks
         }
 
-    @classmethod
-    def from_get(cls, response):
-        return cls.from_response(response.json())
-
     def refresh(self):
         ensemble = self.get(self.ensemble_uuid)
         self.__dict__.update(ensemble.__dict__)

hypervector/resources/core/project.py

@@ -29,10 +29,6 @@ def to_response(self):
             "definitions": self.definitions
         }
 
-    @classmethod
-    def from_get(cls, response):
-        return cls.from_response(response.json())
-
     def refresh(self):
         project = self.get(self.project_uuid)
         self.__dict__.update(project.__dict__)
@@ -46,7 +42,7 @@ def list(cls):
     @classmethod
     def new(cls):
         endpoint = hypervector.API_BASE + "/" + cls.resource_name + "/new"
-        response = requests.post(endpoint, headers=cls.get_headers()).json()
+        response = cls.request(endpoint, method=requests.post)
         return cls.from_response(response)