arkindex-client 1.0.15__py3-none-any.whl → 1.0.16__py3-none-any.whl

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.
@@ -245,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.
@@ -274,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/pagination.py

@@ -124,7 +124,7 @@ class ResponsePaginator(Sized, Iterator):
                 )
 
             # Fetch the next page
-            self.data = self.client.request(
+            self.data = self.client.single_request(
                 self.operation_id,
                 *self.request_args,
                 **self.request_kwargs,

{arkindex_client-1.0.15.dist-info → arkindex_client-1.0.16.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: arkindex-client
-Version: 1.0.15
+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>
@@ -21,6 +21,7 @@ Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 Requires-Dist: apistar ==0.7.2
 Requires-Dist: requests ~=2.28
+Requires-Dist: tenacity ==8.2.3
 Requires-Dist: typesystem ==0.2.5
 
 Arkindex API Client

{arkindex_client-1.0.15.dist-info → arkindex_client-1.0.16.dist-info}/RECORD

@@ -1,11 +1,11 @@
 arkindex/__init__.py,sha256=OBw25Nwe6r1AN3a36-8lnUcDy3nkDIiebBgYNK2Zo9o,99
 arkindex/auth.py,sha256=O45HgpsblBqNJr9nRALU14wZgCGcmCgcGjAoD0zAyrg,1073
-arkindex/client.py,sha256=nTD_P4mjiyjKsgTprDFJbpswKDoZkGJTuxxrznkcZWc,10592
+arkindex/client.py,sha256=SLFJzZI31y3UAufyUBdDiUgh7_IwRK0ItRwOSgCZflU,11984
 arkindex/exceptions.py,sha256=3jzuuXgsPA28qH7GMwPVQisWCvitAQtYiQ5uKxzFQ_M,155
 arkindex/mock.py,sha256=hWU8EKfvVBAQ8VVI4Rgic809GLLDoh8Nvuvih54luKQ,2762
-arkindex/pagination.py,sha256=CfcHtqJb9MtuCfZPMTLYCnXlPfHEG3nCurt7bCYEByg,8947
+arkindex/pagination.py,sha256=tIt3ecD44UcuxT3mV7gtwvqoqdeAICaq5okr1z4_xgo,8954
 arkindex/transports.py,sha256=RmQ9fXdnLd6PizifyVI5E7QTIj3MU6Xua76jp87TKpM,464
-arkindex_client-1.0.15.dist-info/METADATA,sha256=P1C2tmJTUnFpfrotrQewS1EBOzT62ISRGa6Q4OGIKDs,7027
-arkindex_client-1.0.15.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-arkindex_client-1.0.15.dist-info/top_level.txt,sha256=iP1TxDW_jSDQA4FIcahBFXiDcZXqam2a_gFVnDbR3c4,9
-arkindex_client-1.0.15.dist-info/RECORD,,
+arkindex_client-1.0.16.dist-info/METADATA,sha256=noYxsy3dMHgo0Ob_bmU3qT0c_KBAap7hW6CDz-AuEIE,7059
+arkindex_client-1.0.16.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
+arkindex_client-1.0.16.dist-info/top_level.txt,sha256=iP1TxDW_jSDQA4FIcahBFXiDcZXqam2a_gFVnDbR3c4,9
+arkindex_client-1.0.16.dist-info/RECORD,,