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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.2.0
+Version: 2.2.1
 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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.2.0
+Version: 2.2.1
 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

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

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

ee_client-2.2.1/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.2.1}/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.2.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ee-client"
-version = "2.2.0"
+version = "2.2.1"
 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 = [
@@ -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.2.1"
 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