earthscope-sdk 1.0.0b0__py3-none-any.whl → 1.0.0b1__py3-none-any.whl

earthscope_sdk/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.0b0"
+__version__ = "1.0.0b1"
 
 from earthscope_sdk.client import AsyncEarthScopeClient, EarthScopeClient
 

earthscope_sdk/auth/auth_flow.py

@@ -157,12 +157,14 @@ class AuthFlow(httpx.Auth):
             NoRefreshTokenError: no refresh token is present
             InvalidRefreshTokenError: the token refresh failed
         """
+        from httpx import HTTPStatusError, ReadTimeout
+
         refresh_token = self.refresh_token
         scope = scope or self._settings.scope
 
-        r = await self._ctx.httpx_client.post(
+        request = self._ctx.httpx_client.build_request(
+            "POST",
             f"{self._settings.domain}oauth/token",
-            auth=None,  # override client default
             headers={"content-type": "application/x-www-form-urlencoded"},
             data={
                 "grant_type": "refresh_token",
@@ -171,9 +173,22 @@ class AuthFlow(httpx.Auth):
                 "scopes": scope,
             },
         )
-        if r.status_code != 200:
-            logger.error(f"error during token refresh: {r.content}")
+
+        try:
+            async for attempt in self._settings.retry.retry_context(ReadTimeout):
+                with attempt:
+                    r = await self._ctx.httpx_client.send(request, auth=None)
+                    r.raise_for_status()
+        except HTTPStatusError as e:
+            logger.error(
+                f"error during token refresh ({attempt.num} attempts): {e.response.content}"
+            )
             raise InvalidRefreshTokenError("refresh token exchange failed")
+        except Exception as e:
+            logger.error(
+                f"error during token refresh ({attempt.num} attempts)", exc_info=e
+            )
+            raise InvalidRefreshTokenError("refresh token exchange failed") from e
 
         # add previous refresh token to new tokens if omitted from resp
         # (i.e. we have a non-rotating refresh token)

earthscope_sdk/client/user/_base.py

@@ -18,7 +18,7 @@ class UserBaseService(SdkService):
             url=f"{self.resources.api_url}beta/user/credentials/aws/{role}",
         )
 
-        resp = await self._send(req)
+        resp = await self._send_with_retries(req)
 
         return AwsTemporaryCredentials.model_validate_json(resp.content)
 
@@ -34,6 +34,6 @@ class UserBaseService(SdkService):
             url=f"{self.resources.api_url}beta/user/profile",
         )
 
-        resp = await self._send(req)
+        resp = await self._send_with_retries(req)
 
         return UserProfile.model_validate_json(resp.content)

earthscope_sdk/common/service.py

@@ -52,3 +52,8 @@ class SdkService:
         resp.raise_for_status()
 
         return resp
+
+    async def _send_with_retries(self, request: "Request"):
+        async for attempt in self.ctx.settings.http.retry.retry_context():
+            with attempt:
+                return await self._send(request=request)

earthscope_sdk/config/models.py

@@ -1,11 +1,13 @@
 import base64
 import binascii
 import datetime as dt
+import functools
 from contextlib import suppress
 from enum import Enum
 from functools import cached_property
-from typing import Annotated, Any, Optional, Union
+from typing import Annotated, Any, Optional, Type, Union
 
+from annotated_types import Ge, Gt
 from pydantic import (
     AliasChoices,
     BaseModel,
@@ -86,7 +88,7 @@ class Tokens(BaseModel):
             return None
 
         with suppress(IndexError, binascii.Error, ValidationError):
-            payload_b64 = self.access_token.get_secret_value().split(".")[1]
+            payload_b64 = self.access_token.get_secret_value().split(".", 2)[1]
             payload = base64.b64decode(payload_b64 + "==")  # extra padding
             return AccessTokenBody.model_validate_json(payload)
 
@@ -121,6 +123,76 @@ class Tokens(BaseModel):
         raise ValueError("At least one of access token and refresh token is required.")
 
 
+class RetrySettings(BaseModel):
+    """
+    Retry configuration for the [Stamina library](https://stamina.hynek.me/en/stable/index.html)
+    """
+
+    # same defaults as AWS SDK "standard" mode:
+    # https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html#standard-retry-mode
+
+    attempts: Annotated[int, Ge(0)] = 3
+    timeout: Timedelta = dt.timedelta(seconds=20)
+
+    wait_initial: Timedelta = dt.timedelta(milliseconds=100)
+    wait_max: Timedelta = dt.timedelta(seconds=5)
+    wait_jitter: Timedelta = dt.timedelta(seconds=1)
+    wait_exp_base: Annotated[float, Gt(0)] = 2
+
+    async def retry_context(self, *retry_exc: Type[Exception]):
+        """
+        Obtain a [Stamina](https://stamina.hynek.me/en/stable/index.html) retry iterator.
+        """
+        from stamina import retry_context
+
+        retry_on = functools.partial(self.is_retriable, retry_exc=retry_exc)
+
+        ctx = retry_context(
+            on=retry_on,
+            attempts=self.attempts,
+            timeout=self.timeout,
+            wait_initial=self.wait_initial,
+            wait_jitter=self.wait_jitter,
+            wait_max=self.wait_max,
+            wait_exp_base=self.wait_exp_base,
+        )
+        async for attempt in ctx:
+            yield attempt
+
+    def is_retriable(
+        self,
+        exc: Exception,
+        *args,
+        retry_exc: tuple[Type[Exception]] = (),
+        **kwargs,
+    ) -> bool:
+        """
+        Check if the given exception can be retried
+        """
+        if retry_exc and isinstance(exc, retry_exc):
+            return True
+
+        return False
+
+
+class HttpRetrySettings(RetrySettings):
+    status_codes: set[int] = {429, 500, 502, 503, 504}
+
+    def is_retriable(
+        self,
+        exc: Exception,
+        *args,
+        **kwargs,
+    ) -> bool:
+        from httpx import HTTPStatusError
+
+        if isinstance(exc, HTTPStatusError):
+            if exc.response.status_code in self.status_codes:
+                return True
+
+        return super().is_retriable(exc, *args, **kwargs)
+
+
 class AuthFlowSettings(Tokens):
     """
     Auth flow configuration
@@ -135,6 +207,14 @@ class AuthFlowSettings(Tokens):
     scope: str = "offline_access"
     client_secret: Optional[SecretStr] = None
 
+    # Auth exchange retries
+    retry: HttpRetrySettings = HttpRetrySettings(
+        attempts=5,
+        timeout=dt.timedelta(seconds=30),
+        wait_initial=dt.timedelta(seconds=1),
+        wait_jitter=dt.timedelta(seconds=3),
+    )
+
     @cached_property
     def auth_flow_type(self) -> AuthFlowType:
         if self.client_secret is not None:
@@ -157,6 +237,9 @@ class HttpSettings(BaseModel):
     timeout_connect: Timedelta = dt.timedelta(seconds=5)
     timeout_read: Timedelta = dt.timedelta(seconds=5)
 
+    # automatically retry requests
+    retry: HttpRetrySettings = HttpRetrySettings()
+
     # Other
     user_agent: str = f"earthscope-sdk py/{__version__}"
 

{earthscope_sdk-1.0.0b0.dist-info → earthscope_sdk-1.0.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: earthscope-sdk
-Version: 1.0.0b0
+Version: 1.0.0b1
 Summary: An SDK for EarthScope API
 Author-email: EarthScope <data-help@earthscope.org>
 License:                                  Apache License
@@ -214,7 +214,8 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27.0
-Requires-Dist: pydantic-settings[toml]>=2.7.0
+Requires-Dist: pydantic-settings[toml]>=2.8.0
+Requires-Dist: stamina>=24.3.0
 Provides-Extra: dev
 Requires-Dist: bumpver; extra == "dev"
 Requires-Dist: build; extra == "dev"
@@ -224,6 +225,7 @@ Requires-Dist: pip-tools; extra == "dev"
 Requires-Dist: pytest-httpx; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
 
 # EarthScope SDK
 

{earthscope_sdk-1.0.0b0.dist-info → earthscope_sdk-1.0.0b1.dist-info}/RECORD

@@ -1,28 +1,28 @@
-earthscope_sdk/__init__.py,sha256=6InyrqE0KEsb_XBBKCbUIb8s0LTJ6N20HFsrO-rHVtI,156
+earthscope_sdk/__init__.py,sha256=GUJAs2cToEo9f8MaCUP_VnRsyqZWNhsN-pId5vzPk4U,156
 earthscope_sdk/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-earthscope_sdk/auth/auth_flow.py,sha256=HZyLrt8o3I-0KC7XRg9W0n2NAVXX7EOl9pG-5blv7sA,9613
+earthscope_sdk/auth/auth_flow.py,sha256=6jBQxLJ2gAxXGgtZYXDH1yg5L_WUmgu7fRvW4JoCi4Q,10198
 earthscope_sdk/auth/client_credentials_flow.py,sha256=1GyDSIR1OgYP4u0xZoTov1u_YhY1AzHFpOcBCzY1h6E,2769
 earthscope_sdk/auth/device_code_flow.py,sha256=dC5Ffj3HzBguRxSHCZYvTe1MD3C-iKf2AlanGuRKNvI,7922
 earthscope_sdk/auth/error.py,sha256=eC33Bw1HaBEJE7-eI2krtE__5PxStc3EyiYO12v0kVw,693
 earthscope_sdk/client/__init__.py,sha256=JotTr5oTiiOsUc0RTg82EVCUSg_-u80Qu_R0-crCXkY,139
 earthscope_sdk/client/_client.py,sha256=ai7WdsTOYglA6bLkT-Wntvxlke6nSaGHwqrtg5PEy80,833
 earthscope_sdk/client/user/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-earthscope_sdk/client/user/_base.py,sha256=nut1Ojsksohqy3X3L5FPDQ-rh-BmHLJ6sId5xVqLal0,1050
+earthscope_sdk/client/user/_base.py,sha256=8dn4pfQMwVDpF0E6dl6P6HJuNVvozUzfgUGefnPXMnw,1076
 earthscope_sdk/client/user/_service.py,sha256=wRktOZF5GXajXXxij3Nkule6wvuWOV0vn4QsA1IXVHc,3063
 earthscope_sdk/client/user/models.py,sha256=drZAMwOYC1NVCzBZQhNL-pPTB28SURKfoZF8HdjlIj8,1214
 earthscope_sdk/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 earthscope_sdk/common/_sync_runner.py,sha256=h_A2pSEjZCLj7ov50M6cWHVoX6eXVmGzz5nX0MwLWDY,4131
 earthscope_sdk/common/client.py,sha256=g5ZTNhFm33H68J9pWD5fDu760Yd5cBdfQmsbU3t8D_4,2156
 earthscope_sdk/common/context.py,sha256=vrCB_Ez-98Ir7c0GrCe-g7DuRCgc9vPaoRWFYf5q8Ko,5138
-earthscope_sdk/common/service.py,sha256=qBz6OV8rQf3WQojubEVfQ4HYeeKNN3_uIcXuOdvfH8w,1287
+earthscope_sdk/common/service.py,sha256=SCUZVJA3jFaEPeFrOf0v9osf2UpqldhlFmirOYWJjxM,1506
 earthscope_sdk/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 earthscope_sdk/config/_compat.py,sha256=P3F5y_Kf5zp9m9uOhl1Bp3ke6expxq4Sm9AeVaBbAHk,4610
 earthscope_sdk/config/_util.py,sha256=RZ6zvKrvjUkO7i69s7AVoIDhamRg4x71CAZLnucr9QM,1249
 earthscope_sdk/config/error.py,sha256=jh25q-b317lAvp32WwQw0zdYoV-MxZtg-n5FgZOMymI,95
-earthscope_sdk/config/models.py,sha256=CarL0O6RjFtufsc-q7g61uBEvETLjQr6HSmjCc0EVig,5775
+earthscope_sdk/config/models.py,sha256=1334Rxzw4qDLSdQg9btxFQySBOCb8TEW6J95M-lyKEc,8198
 earthscope_sdk/config/settings.py,sha256=I2DwEvfmETcaYbSvUybs0EIih0yiJO9D46WnWzKPqbo,8812
-earthscope_sdk-1.0.0b0.dist-info/LICENSE,sha256=E_MrVXxRaMQNpvZhsDuz_J9N_ux7dlL_WpYSsE391HU,11349
-earthscope_sdk-1.0.0b0.dist-info/METADATA,sha256=jbeHzNrmHRZUGOFai1WmCDK1CQ-kWSbIsaNRjHq_WhA,17935
-earthscope_sdk-1.0.0b0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-earthscope_sdk-1.0.0b0.dist-info/top_level.txt,sha256=zTtIT9yN3JPJF7TqmTzqQcAvZZe4pAm907DLoGa5T_E,15
-earthscope_sdk-1.0.0b0.dist-info/RECORD,,
+earthscope_sdk-1.0.0b1.dist-info/licenses/LICENSE,sha256=E_MrVXxRaMQNpvZhsDuz_J9N_ux7dlL_WpYSsE391HU,11349
+earthscope_sdk-1.0.0b1.dist-info/METADATA,sha256=BHeAUzZ882lmEExnoVKIywGSYvIbyNdnIh8BzRJs2Ng,17988
+earthscope_sdk-1.0.0b1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+earthscope_sdk-1.0.0b1.dist-info/top_level.txt,sha256=zTtIT9yN3JPJF7TqmTzqQcAvZZe4pAm907DLoGa5T_E,15
+earthscope_sdk-1.0.0b1.dist-info/RECORD,,

{earthscope_sdk-1.0.0b0.dist-info → earthscope_sdk-1.0.0b1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any