ee-client 2.2.0__tar.gz → 2.3.0__tar.gz

{ee_client-2.2.0 → ee_client-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.2.0
+Version: 2.3.0
 Summary: extends the capabilities of the earthengine-api by providing custom session management and client interactions
 Author-email: Daniel Guerrero <dfgm2006@gmail.com>
 Project-URL: Homepage, https://github.com/dfguerrerom/ee-client
@@ -15,7 +15,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: earthengine-api
-Requires-Dist: httpx
+Requires-Dist: httpx[http2]
 Requires-Dist: aiogoogle
 Requires-Dist: tenacity
 Requires-Dist: pydantic

{ee_client-2.2.0 → ee_client-2.3.0}/ee_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.2.0
+Version: 2.3.0
 Summary: extends the capabilities of the earthengine-api by providing custom session management and client interactions
 Author-email: Daniel Guerrero <dfgm2006@gmail.com>
 Project-URL: Homepage, https://github.com/dfguerrerom/ee-client
@@ -15,7 +15,7 @@ Requires-Python: >=3.9
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: earthengine-api
-Requires-Dist: httpx
+Requires-Dist: httpx[http2]
 Requires-Dist: aiogoogle
 Requires-Dist: tenacity
 Requires-Dist: pydantic

{ee_client-2.2.0 → ee_client-2.3.0}/ee_client.egg-info/requires.txt

@@ -1,5 +1,5 @@
 earthengine-api
-httpx
+httpx[http2]
 aiogoogle
 tenacity
 pydantic

{ee_client-2.2.0 → ee_client-2.3.0}/eeclient/__init__.py

@@ -1,6 +1,6 @@
 __title__ = "eeclient"
 __summary__ = "A client for Google Earth Engine"
-__version__ = "2.2.0"
+__version__ = "2.3.0"
 
 __author__ = "Daniel Guerrero"
 __email__ = "dfgm2006@gmail.com"

{ee_client-2.2.0 → ee_client-2.3.0}/eeclient/client.py

@@ -33,6 +33,23 @@ SEPAL_API_DOWNLOAD_URL = None
 VERIFY_SSL = True
 
 
+class SimpleRateLimiter:
+    def __init__(self, qps: float | None):
+        self.qps = qps
+        self._lock = asyncio.Lock()
+        self._next = 0.0
+
+    async def acquire(self):
+        if not self.qps or self.qps <= 0:
+            return
+        async with self._lock:
+            now = asyncio.get_running_loop().time()
+            wait = max(0.0, self._next - now)
+            if wait:
+                await asyncio.sleep(wait)
+            self._next = max(now, self._next) + 1.0 / self.qps
+
+
 class EESession(SepalCredentialMixin):
     def __init__(
         self,
@@ -52,12 +69,18 @@ class EESession(SepalCredentialMixin):
         Raises:
             ValueError: If SEPAL_HOST environment variable is not set
         """
+        self._inflight = asyncio.BoundedSemaphore(30)
+        self._rate = SimpleRateLimiter(60)
+
+        self._auth_refresh_lock = asyncio.Lock()
+
+        self._client: httpx.AsyncClient | None = None
+        self._client_lock = asyncio.Lock()
+
         self.enforce_project_id = enforce_project_id
         super().__init__(sepal_headers)
 
-        # Create user-specific logger
         self.logger = logging.getLogger(f"eeclient.{self.user}")
-
         self.logger.debug(
             "EESession initialized"
             if self._credentials
@@ -127,29 +150,37 @@ class EESession(SepalCredentialMixin):
 
         return GEEHeaders.model_validate(data)
 
-    async def get_headers(self) -> GEEHeaders:
-        """Async method to get headers, refreshing credentials if needed"""
+    async def get_headers(self):
+        # Only one task refreshes the token; others wait briefly.
         if self.needs_credentials_refresh():
-            await self.set_credentials()
+            async with self._auth_refresh_lock:
+                if self.needs_credentials_refresh():  # double-check after lock
+                    await self.set_credentials()
         return self.get_current_headers()
 
+    async def _ensure_client(self) -> httpx.AsyncClient:
+        if self._client is None:
+            async with self._client_lock:
+                if self._client is None:
+                    self._client = httpx.AsyncClient(
+                        http2=True,
+                        timeout=httpx.Timeout(connect=60, read=360, write=60, pool=60),
+                        limits=httpx.Limits(
+                            max_connections=40, max_keepalive_connections=20
+                        ),
+                        verify=getattr(self, "verify_ssl", True),
+                    )
+        return self._client
+
     @asynccontextmanager
     async def get_client(self):
-        """Context manager for an HTTP client using the current headers.
-        A new client is created each time to ensure fresh headers."""
-
-        timeout = httpx.Timeout(connect=60.0, read=360.0, write=60.0, pool=60.0)
-        headers = await self.get_headers()
-        # Use the model_dump with by_alias=True to keep the original HTTP header names
-        headers = headers.model_dump(by_alias=True)  # type: ignore
-        limits = httpx.Limits(max_connections=100, max_keepalive_connections=50)
-        async_client = httpx.AsyncClient(
-            headers=headers, timeout=timeout, limits=limits
-        )
-        try:
-            yield async_client
-        finally:
-            await async_client.aclose()
+        client = await self._ensure_client()
+        yield client
+
+    async def aclose(self):
+        if self._client is not None:
+            await self._client.aclose()
+            self._client = None
 
     async def rest_call(
         self,
@@ -168,51 +199,61 @@ class EESession(SepalCredentialMixin):
 
         while attempt < max_attempts:
             try:
-                async with self.get_client() as client:
-                    url_with_project = self.set_url_project(url)
+                headers = (await self.get_headers()).model_dump(by_alias=True)
+                url_with_project = self.set_url_project(url)
+
+                async with self._inflight:
+                    await self._rate.acquire()
+                    async with self.get_client() as client:
 
-                    if "assets" not in url_with_project:
-                        # Do not log assets requests
-                        self.logger.debug(
-                            f"Making async  {method} request to {url_with_project}"
+                        if "assets" not in url_with_project:
+                            # Do not log assets requests
+                            self.logger.debug(
+                                f"Making async  {method} request to {url_with_project}"
+                            )
+                        response = await client.request(
+                            method,
+                            url_with_project,
+                            json=data,
+                            params=params,
+                            headers=headers,
                         )
-                    response = await client.request(
-                        method, url_with_project, json=data, params=params
-                    )
 
-                    if response.status_code >= 400:
-                        if "application/json" in response.headers.get(
-                            "Content-Type", ""
-                        ):
-                            error_data = response.json().get("error", {})
-                            self.logger.error(
-                                f"Request failed with error: {error_data}"
+                        if response.status_code >= 400:
+                            if "application/json" in response.headers.get(
+                                "Content-Type", ""
+                            ):
+                                error_data = response.json().get("error", {})
+                                self.logger.error(
+                                    f"Request failed with error: {error_data}"
+                                )
+                                raise EERestException(error_data)
+                            else:
+                                error_data = {
+                                    "code": response.status_code,
+                                    "message": response.reason_phrase
+                                    or "Unknown HTTP error",
+                                    "status": response.status_code,
+                                }
+                                self.logger.error(
+                                    f"Request failed with HTTP error: {error_data}"
+                                )
+                                raise EERestException(error_data)
+
+                        try:
+                            return response.json()
+                        except Exception as e:
+                            self.logger.error(f"Error parsing JSON response: {str(e)}")
+                            self.logger.debug(
+                                f"Response content: {response.text[:500]}..."
                             )
-                            raise EERestException(error_data)
-                        else:
-                            error_data = {
-                                "code": response.status_code,
-                                "message": response.reason_phrase
-                                or "Unknown HTTP error",
-                                "status": response.status_code,
-                            }
-                            self.logger.error(
-                                f"Request failed with HTTP error: {error_data}"
+                            raise EERestException(
+                                {
+                                    "code": 500,
+                                    "message": f"Invalid JSON response: {str(e)}",
+                                    "status": response.status_code,
+                                }
                             )
-                            raise EERestException(error_data)
-
-                    try:
-                        return response.json()
-                    except Exception as e:
-                        self.logger.error(f"Error parsing JSON response: {str(e)}")
-                        self.logger.debug(f"Response content: {response.text[:500]}...")
-                        raise EERestException(
-                            {
-                                "code": 500,
-                                "message": f"Invalid JSON response: {str(e)}",
-                                "status": response.status_code,
-                            }
-                        )
 
             except EERestException as e:
                 last_error = e

ee_client-2.3.0/eeclient/exceptions.py

@@ -0,0 +1,100 @@
+from ee.ee_exception import EEException
+
+
+class EERestException(EEException):
+    def __init__(self, error):
+        self.message = error.get("message", "EE responded with an error")
+        super().__init__(self.message)
+        self.code = error.get("code", -1)
+        self.status = error.get("status", "UNDEFINED")
+        self.details = error.get("details")
+
+
+class EEClientError(Exception):
+    """Custom exception class for EEClient errors."""
+
+    def __init__(self, error):
+        if isinstance(error, str):
+            self.message = error
+            self.code = -1
+            self.status = "UNDEFINED"
+            self.details = None
+        else:
+            self.message = error.get("message", "EEClient responded with an error")
+            self.code = error.get("code", -1)
+            self.status = error.get("status", "UNDEFINED")
+            self.details = error.get("details")
+        super().__init__(self.message)
+
+
+class CredentialsFileNotFoundError(EEClientError):
+    """Raised when local credentials file is not found."""
+
+    def __init__(self, file_path: str):
+        self.file_path = file_path
+        error = {
+            "code": 404,
+            "message": (
+                "There was an error when trying to authenticate with Google "
+                "Earth Engine. Make sure your GEE account is properly "
+                "connected to SEPAL. For more information, please visit "
+                "<a href='https://docs.sepal.io/en/latest/setup/gee.html' "
+                "target='_blank'> the documentation </a>."
+            ),
+            "status": "CREDENTIALS_NOT_FOUND",
+            "details": f"Credentials file not found at {file_path}",
+        }
+        super().__init__(error)
+
+
+class CredentialsFileUnknownError(EEClientError):
+    """Raised when unknown error occurred while accessing credentials file."""
+
+    def __init__(self):
+        error = {
+            "code": 500,
+            "message": (
+                "There was an error when trying to authenticate with Google "
+                "Earth Engine. Please re-authenticate your GEE account with "
+                "SEPAL. For more information, visit "
+                "<a href='https://docs.sepal.io/en/latest/setup/gee.html' "
+                "target='_blank'> the documentation </a>."
+            ),
+            "status": "CREDENTIALS_ERROR",
+            "details": "Unknown error occurred while accessing credentials file",
+        }
+        super().__init__(error)
+
+
+class SepalCredentialsUnavailableError(EEClientError):
+    """Raised when SEPAL API cannot provide credentials (e.g., 500 error)."""
+
+    def __init__(self, status_code: int | None = None):
+        self.status_code = status_code
+        error = {
+            "code": status_code or 500,
+            "message": (
+                "There was an error when trying to authenticate with Google "
+                "Earth Engine. Make sure your GEE account is properly "
+                "connected to SEPAL. Please visit "
+                "<a href='https://docs.sepal.io/en/latest/setup/gee.html' "
+                "target='_blank'> the documentation </a> for more information."
+            ),
+            "status": "SEPAL_CREDENTIALS_UNAVAILABLE",
+            "details": (
+                f"SEPAL API returned error {status_code}"
+                if status_code
+                else "SEPAL API is unable to provide credentials"
+            ),
+        }
+        super().__init__(error)
+
+
+# {'code': 401, 'message': 'Request had invalid authentication credentials.
+# Expected OAuth 2 access token, login cookie or other valid authentication
+# credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.',
+# 'status': 'UNAUTHENTICATED'}
+# Exception in _run_task: Request had invalid authentication credentials.
+# Expected OAuth 2 access token, login cookie or other valid authentication
+# credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.
+# when that error happens, I need to re-set the credentials

{ee_client-2.2.0 → ee_client-2.3.0}/eeclient/sepal_credential_mixin.py

@@ -1,4 +1,9 @@
 from eeclient.models import SepalHeaders, GoogleTokens
+from eeclient.exceptions import (
+    CredentialsFileNotFoundError,
+    CredentialsFileUnknownError,
+    SepalCredentialsUnavailableError,
+)
 import os
 import logging
 import json
@@ -84,10 +89,14 @@ class SepalCredentialMixin:
     def _load_credentials_from_file(self):
         """Load credentials from file and update internal state"""
         if not self.credentials_path.exists():
-            raise ValueError(f"Credentials file not found at {self.credentials_path}")
+            raise CredentialsFileNotFoundError(str(self.credentials_path))
 
         try:
-            credentials_data = json.loads(self.credentials_path.read_text())
+            file_content = self.credentials_path.read_text().strip()
+            if not file_content:
+                raise CredentialsFileNotFoundError(str(self.credentials_path))
+
+            credentials_data = json.loads(file_content)
             self._credentials = GoogleTokens.model_validate(credentials_data)
             self.access_token = self._credentials.access_token
             self.project_id = self._credentials.project_id
@@ -166,6 +175,12 @@ class SepalCredentialMixin:
                         f"Project: {self.project_id}"
                     )
                     return
+                elif response.status_code == 500:
+                    self.logger.error(
+                        "SEPAL API returned 500 error - "
+                        "credentials not available on server"
+                    )
+                    raise SepalCredentialsUnavailableError(500)
                 else:
                     self.logger.debug(
                         f"Attempt {attempt}/{self.max_retries} failed with "
@@ -191,6 +206,8 @@ class SepalCredentialMixin:
         )
         attempt = 0
 
+        log.debug(f"Credentials path: {self.credentials_path}")
+
         while attempt < self.max_retries:
             attempt += 1
             try:
@@ -214,11 +231,17 @@ class SepalCredentialMixin:
                         f"Credentials from file are still expired."
                     )
 
+            except CredentialsFileNotFoundError:
+                self.logger.error(
+                    f"Credentials file not found: {self.credentials_path}"
+                )
+                raise
             except Exception as e:
                 self.logger.error(
                     f"Attempt {attempt}/{self.max_retries} "
                     f"encountered an exception while reading file: {e}"
                 )
+                raise
 
             # Wait before retrying (the file might be updated externally)
             if attempt < self.max_retries:
@@ -226,11 +249,7 @@ class SepalCredentialMixin:
                 self.logger.debug(f"Waiting {wait_time} seconds before retry...")
                 await asyncio.sleep(wait_time)
 
-        raise ValueError(
-            f"Failed to retrieve valid credentials from file after "
-            f"{self.max_retries} attempts. File may not be automatically "
-            f"updated or credentials are permanently expired."
-        )
+        raise CredentialsFileUnknownError()
 
     def set_credentials_sync(self) -> None:
         """
@@ -282,6 +301,13 @@ class SepalCredentialMixin:
                         f"Project: {self.project_id}"
                     )
                     return
+                elif response.status_code == 500:
+                    self.logger.error(
+                        "SEPAL API returned 500 error - "
+                        "credentials not available on server"
+                    )
+                    session.close()
+                    raise SepalCredentialsUnavailableError(500)
                 else:
                     self.logger.debug(
                         f"Attempt {attempt}/{self.max_retries} failed with "
@@ -336,6 +362,9 @@ class SepalCredentialMixin:
                         f"Credentials from file are still expired."
                     )
 
+            except CredentialsFileNotFoundError:
+                # Re-raise immediately - no point in retrying if file doesn't exist
+                raise
             except Exception as e:
                 self.logger.error(
                     f"Attempt {attempt}/{self.max_retries} "

{ee_client-2.2.0 → ee_client-2.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ee-client"
-version = "2.2.0"
+version = "2.3.0"
 description = "extends the capabilities of the earthengine-api by providing custom session management and client interactions"
 readme = { file = "README.rst",  content-type = "text/x-rst" }
 authors = [
@@ -12,7 +12,7 @@ authors = [
 ]
 dependencies = [
 	"earthengine-api",
-    "httpx",
+    "httpx[http2]",
     "aiogoogle",
     "tenacity",
     "pydantic",
@@ -66,7 +66,7 @@ branch = true
 [tool.commitizen]
 tag_format = "v$major.$minor.$patch$prerelease"
 update_changelog_on_bump = false
-version = "2.2.0"
+version = "2.3.0"
 version_files = [
     "pyproject.toml:version",
     "eeclient/__init__.py:__version__",

ee_client-2.2.0/eeclient/exceptions.py

@@ -1,26 +0,0 @@
-from ee.ee_exception import EEException
-
-
-class EERestException(EEException):
-    def __init__(self, error):
-        self.message = error.get("message", "EE responded with an error")
-        super().__init__(self.message)
-        self.code = error.get("code", -1)
-        self.status = error.get("status", "UNDEFINED")
-        self.details = error.get("details")
-
-
-class EEClientError(Exception):
-    """Custom exception class for EEClient errors."""
-
-    pass
-
-
-# {'code': 401, 'message': 'Request had invalid authentication credentials.
-# Expected OAuth 2 access token, login cookie or other valid authentication
-# credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.',
-# 'status': 'UNAUTHENTICATED'}
-# Exception in _run_task: Request had invalid authentication credentials.
-# Expected OAuth 2 access token, login cookie or other valid authentication
-# credential. See https://developers.google.com/identity/sign-in/web/devconsole-project.
-# when that error happens, I need to re-set the credentials