ee-client 2.0.1__tar.gz → 2.0.3__tar.gz

{ee_client-2.0.1 → ee_client-2.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.0.1
+Version: 2.0.3
 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.0.1 → ee_client-2.0.3}/ee_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.0.1
+Version: 2.0.3
 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.0.1 → ee_client-2.0.3}/ee_client.egg-info/SOURCES.txt

@@ -14,8 +14,13 @@ eeclient/helpers.py
 eeclient/models.py
 eeclient/oauth_app.py
 eeclient/tasks.py
+eeclient/export/__init__.py
 eeclient/export/image.py
 eeclient/export/table.py
+eeclient/interfaces/__init__.py
+eeclient/interfaces/export.py
+eeclient/interfaces/operations.py
+eeclient/interfaces/tasks.py
 tests/test_client.py
 tests/test_data.py
 tests/test_models.py

{ee_client-2.0.1 → ee_client-2.0.3}/eeclient/__init__.py

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

{ee_client-2.0.1 → ee_client-2.0.3}/eeclient/client.py

@@ -7,18 +7,19 @@ import httpx
 import logging
 from contextlib import asynccontextmanager
 
-from eeclient.export.table import table_to_asset, table_to_drive
-from eeclient.export.image import image_to_asset, image_to_drive
 from eeclient.exceptions import EEClientError, EERestException
-from eeclient.tasks import get_task, get_task_by_name, get_tasks
-from eeclient.models import GEEHeaders, GoogleTokens, MapTileOptions, SepalHeaders
-from eeclient.data import (
-    create_folder,
-    delete_asset,
-    get_asset,
-    get_assets_async,
-    get_info,
-    get_map_id,
+from eeclient.models import GEEHeaders, GoogleTokens, SepalHeaders
+
+import eeclient.export as _export_module
+import eeclient.data as _operations_module
+import eeclient.tasks as _tasks_module
+
+from eeclient.interfaces import (
+    _ModuleProxy,
+    ExportProtocol,
+    OperationsProtocol,
+    TasksProtocol,
+    expose_module_methods,
 )
 
 logger = logging.getLogger("eeclient")
@@ -411,82 +412,18 @@ class EESession:
         )
 
     @property
-    def operations(self):
-        # Return an object that bundles operations, passing self as the session.
-        return _Operations(self)
+    def export(self) -> ExportProtocol:
+        return _ModuleProxy(self, _export_module)  # type: ignore
 
     @property
-    def export(self):
-        return _Export(self)
+    def operations(self) -> OperationsProtocol:
+        return _ModuleProxy(self, _operations_module)  # type: ignore
 
     @property
-    def tasks(self):
-        return _Tasks(self)
+    def tasks(self) -> TasksProtocol:
+        return _ModuleProxy(self, _tasks_module)  # type: ignore
 
 
-class _Operations:
-    def __init__(self, session):
-        self._session = session
-
-    async def get_assets_async(self, folder: str):
-        return await get_assets_async(
-            self._session,
-            folder=folder,
-        )
-
-    async def get_info(self, ee_object=None, workloadTag=None, serialized_object=None):
-        return await get_info(
-            self._session,
-            ee_object,
-            workloadTag,
-            serialized_object,
-        )
-
-    async def get_map_id(
-        self,
-        ee_image,
-        vis_params: MapTileOptions = {},  # type: ignore
-        bands=None,
-        format=None,
-    ):
-        return await get_map_id(self._session, ee_image, vis_params, bands, format)
-
-    async def get_asset(self, asset_id: str, not_exists_ok: bool = False):
-        return await get_asset(self._session, asset_id, not_exists_ok)
-
-    async def create_folder(self, folder: str):
-        return await create_folder(self._session, folder)
-
-    async def delete_asset(self, asset_id):
-        return await delete_asset(self._session, asset_id)
-
-
-class _Export:
-    def __init__(self, session):
-        self._session = session
-
-    async def table_to_drive(self, collection, **kwargs):
-        return await table_to_drive(self._session, collection, **kwargs)
-
-    async def table_to_asset(self, collection, **kwargs):
-        return await table_to_asset(self._session, collection, **kwargs)
-
-    async def image_to_drive(self, image, **kwargs):
-        return await image_to_drive(self._session, image, **kwargs)
-
-    async def image_to_asset(self, image, **kwargs):
-        return await image_to_asset(self._session, image, **kwargs)
-
-
-class _Tasks:
-    def __init__(self, session):
-        self._session = session
-
-    async def get_tasks(self):
-        return await get_tasks(self._session)
-
-    async def get_task(self, task_id):
-        return await get_task(self._session, task_id)
-
-    async def get_task_by_name(self, asset_name):
-        return await get_task_by_name(self._session, asset_name)
+expose_module_methods(_ModuleProxy, _export_module)
+expose_module_methods(_ModuleProxy, _operations_module)
+expose_module_methods(_ModuleProxy, _tasks_module)

{ee_client-2.0.1 → ee_client-2.0.3}/eeclient/data.py

@@ -22,7 +22,7 @@ from ee.data import TileFetcher
 logger = logging.getLogger("eeclient")
 
 
-async def get_map_id(
+async def get_map_id_async(
     client: "EESession",
     ee_image: Image,
     vis_params: Union[dict, MapTileOptions] = {},
@@ -74,7 +74,7 @@ async def get_map_id(
     }
 
 
-async def get_info(
+async def get_info_async(
     client: "EESession",
     ee_object: Union[ComputedObject, None] = None,
     workloadTag=None,
@@ -110,7 +110,7 @@ async def get_info(
     return response["result"]
 
 
-async def get_asset(
+async def get_asset_async(
     client: "EESession", asset_id: str, not_exists_ok: bool = True
 ) -> Optional[dict]:
     """Async version of get_asset.
@@ -144,7 +144,7 @@ async def get_asset(
         raise
 
 
-async def list_assets_concurrently(client: "EESession", folders):
+async def _list_assets_concurrently(client: "EESession", folders):
     """List assets concurrently.
 
     Args:
@@ -182,7 +182,7 @@ async def get_assets_async(client: "EESession", folder: str = "") -> List[dict]:
         current_folders = [
             await folder_queue.get() for _ in range(folder_queue.qsize())
         ]
-        assets_groups = await list_assets_concurrently(client, current_folders)
+        assets_groups = await _list_assets_concurrently(client, current_folders)
 
         for assets in assets_groups:
             for asset in assets:
@@ -195,7 +195,7 @@ async def get_assets_async(client: "EESession", folder: str = "") -> List[dict]:
     return asset_list
 
 
-async def create_folder(client: "EESession", folder: Union[Path, str]) -> str:
+async def create_folder_async(client: "EESession", folder: Union[Path, str]) -> str:
     """Create a folder and its parents in Earth Engine if they don't exist.
 
     Args:
@@ -217,7 +217,7 @@ async def create_folder(client: "EESession", folder: Union[Path, str]) -> str:
 
     full_path = str(await client.get_assets_folder() / Path(folder))
 
-    if asset := await get_asset(client, full_path):
+    if asset := await get_asset_async(client, full_path):
         logger.debug(f"Folder already exists: {full_path}")
         return full_path
 
@@ -232,7 +232,7 @@ async def create_folder(client: "EESession", folder: Union[Path, str]) -> str:
         folder_id = f"projects/{{project}}/assets/{current}"
 
         logger.debug(f"Checking if folder exists: {current}, {folder_id}")
-        asset = await get_asset(client, folder_id)
+        asset = await get_asset_async(client, folder_id)
         if asset:
             continue
         else:
@@ -251,7 +251,7 @@ async def create_folder(client: "EESession", folder: Union[Path, str]) -> str:
     return full_path
 
 
-async def delete_asset(client, asset_id: Union[str, Path]) -> None:
+async def delete_asset_async(client, asset_id: Union[str, Path]) -> None:
     """Delete an asset from Earth Engine."""
 
     asset_id = str(asset_id)
@@ -272,7 +272,7 @@ async def delete_asset(client, asset_id: Union[str, Path]) -> None:
         raise
 
 
-async def delete_folder(
+async def delete_folder_async(
     client, folder_id: Union[str, Path], recursive: bool = False
 ) -> None:
     """Delete a folder asset. If recursive is True, first delete all child
@@ -297,13 +297,38 @@ async def delete_folder(
             # Process deletion from the deepest assets to the shallowest.
             for depth in sorted(depth_to_assets.keys(), reverse=True):
                 tasks = [
-                    asyncio.create_task(delete_asset(client, asset["id"]))
+                    asyncio.create_task(delete_asset_async(client, asset["id"]))
                     for asset in depth_to_assets[depth]
                 ]
                 # Await deletion of all assets at the current depth level.
                 await asyncio.gather(*tasks)
                 logger.info(f"Deleted all assets at depth {depth}")
 
-        await delete_asset(client, folder_id)
+        await delete_asset_async(client, folder_id)
     else:
-        await delete_asset(client, folder_id)
+        await delete_asset_async(client, folder_id)
+
+
+# Backward compatibility aliases
+async def get_map_id(*args, **kwargs):
+    return await get_map_id_async(*args, **kwargs)
+
+
+async def get_info(*args, **kwargs):
+    return await get_info_async(*args, **kwargs)
+
+
+async def get_asset(*args, **kwargs):
+    return await get_asset_async(*args, **kwargs)
+
+
+async def create_folder(*args, **kwargs):
+    return await create_folder_async(*args, **kwargs)
+
+
+async def delete_asset(*args, **kwargs):
+    return await delete_asset_async(*args, **kwargs)
+
+
+async def delete_folder(*args, **kwargs):
+    return await delete_folder_async(*args, **kwargs)

ee_client-2.0.3/eeclient/export/__init__.py

@@ -0,0 +1,2 @@
+from .image import *  # noqa: F401, F403
+from .table import *  # noqa: F401, F403

{ee_client-2.0.1 → ee_client-2.0.3}/eeclient/export/image.py

@@ -79,6 +79,7 @@ class PixelGrid(BaseModel):
 
     @model_validator(mode="before")
     def check_crs_exclusivity(cls, values):
+        log.debug(f">>>>>>>>>>>>>>>>>>>>>>>>>>>>>> {values}")
         crs_code = values.get("crs_code")
         crs_wkt = values.get("crs_wkt")
         if crs_code is not None and crs_wkt is not None:
@@ -108,7 +109,7 @@ class ExtraExportOptions(BaseExportModel):
     # TODO I didn't add dimensions...
 
 
-async def export_image(
+async def _export_image(
     client: "EESession",
     image,
     *,
@@ -179,7 +180,7 @@ async def export_image(
     return await client.rest_call("POST", url, data=request_params)
 
 
-async def image_to_drive(
+async def image_to_drive_async(
     client: "EESession",
     image,
     filename_prefix: str = "",
@@ -206,7 +207,7 @@ async def image_to_drive(
         ),
     )
 
-    return await export_image(
+    return await _export_image(
         client=client,
         image=image,
         drive_options=drive_options,
@@ -223,7 +224,7 @@ async def image_to_drive(
     )
 
 
-async def image_to_asset(
+async def image_to_asset_async(
     client: "EESession",
     image,
     asset_id: str,
@@ -245,7 +246,7 @@ async def image_to_asset(
         earth_engine_destination=EarthEngineDestination(name=asset_id),
     )
 
-    return await export_image(
+    return await _export_image(
         client=client,
         image=image,
         asset_options=asset_options,
@@ -260,3 +261,12 @@ async def image_to_asset(
         crs=crs,
         crs_transform=crs_transform,
     )
+
+
+# Backward compatibility aliases
+async def image_to_drive(*args, **kwargs):
+    return await image_to_drive_async(*args, **kwargs)
+
+
+async def image_to_asset(*args, **kwargs):
+    return await image_to_asset_async(*args, **kwargs)

{ee_client-2.0.1 → ee_client-2.0.3}/eeclient/export/table.py

@@ -62,7 +62,7 @@ class ExportOptions(BaseExportModel):
     # See the api: https://developers.google.com/earth-engine/reference/rest/v1alpha/projects.table/export#TableFileExportOptions
 
 
-async def export_table(
+async def _export_table(
     client: "EESession",
     collection,
     *,
@@ -110,7 +110,7 @@ async def export_table(
     return await client.rest_call("POST", url, data=params)
 
 
-async def table_to_drive(
+async def table_to_drive_async(
     client: "EESession",
     collection,
     filename_prefix: str,
@@ -129,7 +129,7 @@ async def table_to_drive(
         file_format=file_format, drive_destination=drive_destination
     )
 
-    return await export_table(
+    return await _export_table(
         client=client,
         collection=collection,
         drive_options=drive_options,
@@ -140,7 +140,7 @@ async def table_to_drive(
     )
 
 
-async def table_to_asset(
+async def table_to_asset_async(
     client: "EESession",
     collection,
     asset_id: str,
@@ -156,7 +156,7 @@ async def table_to_asset(
         earth_engine_destination=EarthEngineDestination(name=asset_id)
     )
 
-    return await export_table(
+    return await _export_table(
         client=client,
         collection=collection,
         asset_options=asset_options,
@@ -165,3 +165,12 @@ async def table_to_asset(
         max_vertices=max_vertices,
         priority=priority,
     )
+
+
+# Backward compatibility aliases
+async def table_to_drive(*args, **kwargs):
+    return await table_to_drive_async(*args, **kwargs)
+
+
+async def table_to_asset(*args, **kwargs):
+    return await table_to_asset_async(*args, **kwargs)

ee_client-2.0.3/eeclient/interfaces/__init__.py

@@ -0,0 +1,25 @@
+from functools import wraps
+import inspect
+from .export import ExportProtocol  # noqa: F401
+from .operations import OperationsProtocol  # noqa: F401
+from .tasks import TasksProtocol  # noqa: F401
+
+
+class _ModuleProxy:
+    def __init__(self, session, module):
+        self._session = session
+        self._module = module
+
+    def __repr__(self):
+        return f"<Proxy for {self._module.__name__}>"
+
+
+def expose_module_methods(proxy_cls, module):
+    for name, func in inspect.getmembers(module, inspect.iscoroutinefunction):
+
+        @wraps(func)
+        async def method(self, *args, __func=func, **kwargs):
+            return await __func(self._session, *args, **kwargs)
+
+        method.__signature__ = inspect.signature(func)  # type: ignore
+        setattr(proxy_cls, name, method)

ee_client-2.0.3/eeclient/interfaces/export.py

@@ -0,0 +1,65 @@
+from typing import Optional, Protocol, Union, Any
+from eeclient.export.image import ImageFileFormat, PixelGrid, AffineTransform
+from eeclient.export.table import TableFileFormat
+
+
+class ExportProtocol(Protocol):
+    async def image_to_asset_async(
+        self,
+        image,
+        asset_id: str,
+        description: str = ...,
+        max_pixels: Optional[int] = ...,
+        grid: Optional[PixelGrid] = ...,
+        request_id: Optional[str] = ...,
+        workload_tag: Optional[str] = ...,
+        priority: Optional[int] = ...,
+        region: Union[Any, str] = ...,
+        scale: Optional[float] = ...,
+        crs: Optional[str] = ...,
+        crs_transform: Optional[AffineTransform] = ...,
+    ) -> dict:
+        ...
+
+    async def image_to_drive_async(
+        self,
+        image,
+        filename_prefix: str = ...,
+        folder: Optional[str] = ...,
+        file_format: ImageFileFormat = ...,
+        description: str = ...,
+        max_pixels: Optional[int] = ...,
+        grid: Optional[PixelGrid] = ...,
+        request_id: Optional[str] = ...,
+        workload_tag: Optional[str] = ...,
+        priority: Optional[int] = ...,
+        region: Union[Any, str] = ...,
+        scale: Optional[float] = ...,
+        crs: Optional[str] = ...,
+        crs_transform: Optional[AffineTransform] = ...,
+    ) -> dict:
+        ...
+
+    async def table_to_drive_async(
+        self,
+        collection,
+        filename_prefix: str,
+        file_format: TableFileFormat,
+        folder: Optional[str] = ...,
+        description: str = ...,
+        selectors: Optional[list] = ...,
+        max_vertices: Optional[int] = ...,
+        priority: Optional[int] = ...,
+    ) -> dict:
+        ...
+
+    async def table_to_asset(
+        self,
+        collection,
+        asset_id: str,
+        description: str = ...,
+        selectors: Optional[list] = ...,
+        max_vertices: Optional[int] = ...,
+        priority: Optional[int] = ...,
+    ) -> dict:
+        ...

ee_client-2.0.3/eeclient/interfaces/operations.py

@@ -0,0 +1,43 @@
+from typing import Protocol, Union, Optional, List
+from pathlib import Path
+from eeclient.models import MapTileOptions
+from ee.image import Image
+from ee.computedobject import ComputedObject
+
+
+class OperationsProtocol(Protocol):
+    async def get_map_id_async(
+        self,
+        ee_image: Image,
+        vis_params: Union[dict, MapTileOptions] = {},
+        bands: Optional[str] = None,
+        format: Optional[str] = None,
+    ) -> dict:
+        ...
+
+    async def get_info_async(
+        self,
+        ee_object: Union[ComputedObject, None] = None,
+        workloadTag=None,
+        serialized_object=None,
+    ) -> dict:
+        ...
+
+    async def get_asset_async(
+        self, asset_id: str, not_exists_ok: bool = True
+    ) -> Optional[dict]:
+        ...
+
+    async def get_assets_async(self, folder: str = "") -> List[dict]:
+        ...
+
+    async def create_folder_async(self, folder: Union[Path, str]) -> str:
+        ...
+
+    async def delete_asset_async(self, asset_id: Union[str, Path]) -> None:
+        ...
+
+    async def delete_folder_async(
+        self, folder_id: Union[str, Path], recursive: bool = False
+    ) -> None:
+        ...

ee_client-2.0.3/eeclient/interfaces/tasks.py

@@ -0,0 +1,13 @@
+from typing import Protocol, Optional
+from eeclient.tasks import TasksResponse, Task
+
+
+class TasksProtocol(Protocol):
+    async def get_tasks_async(self) -> TasksResponse:
+        ...
+
+    async def get_task_async(self, task_id: str) -> Optional[Task]:
+        ...
+
+    async def get_task_by_name_async(self, asset_name: str) -> Optional[Task]:
+        ...

{ee_client-2.0.1 → ee_client-2.0.3}/eeclient/tasks.py

@@ -63,7 +63,7 @@ class TasksResponse(CamelCaseModel):
     operations: List[Task]
 
 
-async def get_tasks(client: "EESession") -> TasksResponse:
+async def get_tasks_async(client: "EESession") -> TasksResponse:
     """Search for the described task in the user Task list return None if
     nothing is found.
 
@@ -79,7 +79,7 @@ async def get_tasks(client: "EESession") -> TasksResponse:
     return operations_response
 
 
-async def get_task(client: "EESession", task_id: str):
+async def get_task_async(client: "EESession", task_id: str):
     """Search for the described task in the user Task list return None if
     nothing is found.
 
@@ -103,7 +103,9 @@ async def get_task(client: "EESession", task_id: str):
         raise e
 
 
-async def get_task_by_name(client: "EESession", asset_name: str) -> Optional[Task]:
+async def get_task_by_name_async(
+    client: "EESession", asset_name: str
+) -> Optional[Task]:
     """Search for the described task in the user Task list return None if
     nothing is found.
 
@@ -113,8 +115,21 @@ async def get_task_by_name(client: "EESession", asset_name: str) -> Optional[Tas
     Returns:
         return the found task else None
     """
-    operations_response = await get_tasks(client)
+    operations_response = await get_tasks_async(client)
     for task in operations_response.operations:
         if task.metadata.description == asset_name:
             return task
     return None
+
+
+# Backward compatibility aliases
+async def get_tasks(*args, **kwargs):
+    return await get_tasks_async(*args, **kwargs)
+
+
+async def get_task(*args, **kwargs):
+    return await get_task_async(*args, **kwargs)
+
+
+async def get_task_by_name(*args, **kwargs):
+    return await get_task_by_name_async(*args, **kwargs)

{ee_client-2.0.1 → ee_client-2.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ee-client"
-version = "2.0.1"
+version = "2.0.3"
 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.0.1"
+version = "2.0.3"
 version_files = [
     "pyproject.toml:version",
     "eeclient/__init__.py:__version__",

{ee_client-2.0.1 → ee_client-2.0.3}/tests/test_data.py

@@ -16,7 +16,7 @@ from eeclient.data import (
     get_assets_async,
     get_info,
     get_map_id,
-    list_assets_concurrently,
+    _list_assets_concurrently,
 )
 from eeclient.exceptions import EERestException
 from eeclient.client import EESession
@@ -155,7 +155,7 @@ async def test_list_assets_concurrently(sepal_headers):
     # Wait a moment for propagation.
     await asyncio.sleep(2)
     folders = [folder_id]
-    assets_lists = await list_assets_concurrently(session, folders)
+    assets_lists = await _list_assets_concurrently(session, folders)
     assert isinstance(assets_lists, list)
 
     # Depending on your project, the list might be empty or not.