arkindex-client 1.0.14__tar.gz → 1.0.16__tar.gz

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arkindex-client
-Version: 1.0.14
+Version: 1.0.16
 Summary: API client for the Arkindex project
 Home-page: https://gitlab.teklia.com/arkindex/api-client
 Author: Teklia <contact@teklia.com>
@@ -164,7 +164,7 @@ exception's attributes:
    except ErrorResponse as e:
        print(e.title)   # "400 Bad Request"
        print(e.status_code)  # 400
-       print(e.result)  # Any kind of response body the server might give
+       print(e.content)  # Any kind of response body the server might give
 
 Note that by default, using ``repr()`` or ``str()`` on APIStar exceptions will
 not give any useful messages; a fix in APIStar is waiting to be merged. In

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/README.rst

@@ -142,7 +142,7 @@ exception's attributes:
    except ErrorResponse as e:
        print(e.title)   # "400 Bad Request"
        print(e.status_code)  # 400
-       print(e.result)  # Any kind of response body the server might give
+       print(e.content)  # Any kind of response body the server might give
 
 Note that by default, using ``repr()`` or ``str()`` on APIStar exceptions will
 not give any useful messages; a fix in APIStar is waiting to be merged. In

arkindex-client-1.0.16/VERSION

@@ -0,0 +1 @@
+1.0.16

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/arkindex/client.py

@@ -11,6 +11,14 @@ from urllib.parse import urljoin, urlsplit, urlunsplit
 import apistar
 import requests
 import yaml
+from apistar.exceptions import ErrorResponse
+from tenacity import (
+    before_sleep_log,
+    retry,
+    retry_if_exception,
+    stop_after_attempt,
+    wait_exponential,
+)
 
 from arkindex.auth import TokenSessionAuthentication
 from arkindex.exceptions import SchemaError
@@ -27,6 +35,17 @@ SCHEMA_ENDPOINT = "/api/v1/openapi/?format=json"
 logger = logging.getLogger(__name__)
 
 
+def _is_500_error(exc: Exception) -> bool:
+    """
+    Check if an Arkindex API error is a 50x
+    This is used to retry most API calls implemented here
+    """
+    if not isinstance(exc, ErrorResponse):
+        return False
+
+    return 500 <= exc.status_code < 600
+
+
 def options_from_env():
     """
     Get API client keyword arguments from environment variables.
@@ -84,6 +103,7 @@ class ArkindexClient(apistar.Client):
         schema_url=None,
         csrf_cookie=None,
         sleep=0,
+        verify=True,
         **kwargs,
     ):
         r"""
@@ -103,6 +123,7 @@ class ArkindexClient(apistar.Client):
         if not schema_url:
             schema_url = urljoin(base_url, SCHEMA_ENDPOINT)
 
+        self.verify = verify
         try:
             split = urlsplit(schema_url)
             if split.scheme == "file" or not (split.scheme or split.netloc):
@@ -110,7 +131,7 @@ class ArkindexClient(apistar.Client):
                 with open(schema_url) as f:
                     schema = yaml.safe_load(f)
             else:
-                resp = requests.get(schema_url)
+                resp = requests.get(schema_url, verify=self.verify)
                 resp.raise_for_status()
                 schema = yaml.safe_load(resp.content)
         except Exception as e:
@@ -173,7 +194,7 @@ class ArkindexClient(apistar.Client):
         )
 
     def init_transport(self, *args, **kwargs):
-        return ArkindexHTTPTransport(*args, **kwargs)
+        return ArkindexHTTPTransport(self.verify, *args, **kwargs)
 
     def configure(
         self,
@@ -243,7 +264,7 @@ class ArkindexClient(apistar.Client):
             self.transport.session.auth.token = resp["auth_token"]
         return resp
 
-    def request(self, operation_id, *args, **kwargs):
+    def single_request(self, operation_id, *args, **kwargs):
         """
         Perform an API request.
         :param args: Arguments passed to the APIStar client.
@@ -272,3 +293,23 @@ class ArkindexClient(apistar.Client):
             )
             sleep(self.sleep_duration)
         return super().request(operation_id, *args, **kwargs)
+
+    @retry(
+        retry=retry_if_exception(_is_500_error),
+        wait=wait_exponential(multiplier=2, min=3),
+        reraise=True,
+        stop=stop_after_attempt(5),
+        before_sleep=before_sleep_log(logger, logging.INFO),
+    )
+    def request(self, operation_id, *args, **kwargs):
+        """
+        Proxy all Arkindex API requests with a retry mechanism in case of 50X errors.
+        The same API call will be retried 5 times, with an exponential sleep time
+        going through 3, 4, 8 and 16 seconds of wait between call.
+        If the 5th call still gives a 50x, the exception is re-raised and the caller should catch it.
+        Log messages are displayed before sleeping (when at least one exception occurred).
+
+        :param args: Arguments passed to the APIStar client.
+        :param kwargs: Keyword arguments passed to the APIStar client.
+        """
+        return self.single_request(operation_id, *args, **kwargs)

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/arkindex/pagination.py

@@ -117,13 +117,14 @@ class ResponsePaginator(Sized, Iterator):
                 if "with_count" in operation_fields:
                     extra_kwargs["with_count"] = "true"
             else:
+                remaining_count = self.pages_count - self.pages_loaded
                 logger.info(
                     f"Loading {self.mode.value} {index} on try {self.retries - retry + 1}/{self.retries}"
-                    f" - remains {self.pages_count - self.pages_loaded} pages to load."
+                    f" - remains {remaining_count} page{'s' if remaining_count > 1 else ''} to load."
                 )
 
             # Fetch the next page
-            self.data = self.client.request(
+            self.data = self.client.single_request(
                 self.operation_id,
                 *self.request_args,
                 **self.request_kwargs,
@@ -147,7 +148,7 @@ class ResponsePaginator(Sized, Iterator):
                     return False
                 self.pages_count = math.ceil(self.count / len(self.results))
                 logger.info(
-                    f"Pagination will load a total of {self.pages_count} pages."
+                    f"Pagination will load a total of {self.pages_count} page{'s' if self.pages_count > 1 else ''}."
                 )
                 if self.mode == PaginationMode.PageNumber:
                     # Initialize all pages once

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/arkindex/transports.py

@@ -3,7 +3,12 @@ from apistar.client.transports import HTTPTransport
 
 
 class ArkindexHTTPTransport(HTTPTransport):
+    def __init__(self, verify=True, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.verify = verify
+
     def get_request_options(self, *args, **kwargs):
         options = super().get_request_options(*args, **kwargs)
         options["timeout"] = (30, 60)
+        options["verify"] = self.verify
         return options

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/arkindex_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arkindex-client
-Version: 1.0.14
+Version: 1.0.16
 Summary: API client for the Arkindex project
 Home-page: https://gitlab.teklia.com/arkindex/api-client
 Author: Teklia <contact@teklia.com>
@@ -164,7 +164,7 @@ exception's attributes:
    except ErrorResponse as e:
        print(e.title)   # "400 Bad Request"
        print(e.status_code)  # 400
-       print(e.result)  # Any kind of response body the server might give
+       print(e.content)  # Any kind of response body the server might give
 
 Note that by default, using ``repr()`` or ``str()`` on APIStar exceptions will
 not give any useful messages; a fix in APIStar is waiting to be merged. In

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/arkindex_client.egg-info/requires.txt

@@ -1,3 +1,4 @@
 apistar==0.7.2
 requests~=2.28
+tenacity==8.2.3
 typesystem==0.2.5

{arkindex-client-1.0.14 → arkindex-client-1.0.16}/requirements.txt

@@ -1,3 +1,4 @@
 apistar==0.7.2
 requests~=2.28
+tenacity==8.2.3
 typesystem==0.2.5

arkindex-client-1.0.14/VERSION

@@ -1 +0,0 @@
-1.0.14