ee-client 2.5.2__tar.gz → 2.6.1__tar.gz

{ee_client-2.5.2 → ee_client-2.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.5.2
+Version: 2.6.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
@@ -32,7 +32,27 @@ Dynamic: license-file
 Earth Engine Client 🌎
 ==============================
 
-The **Earth Engine Session Client** is a Python package that extends the Google Earth Engine (GEE) API by introducing multi-user session management through custom authentication. 
+.. image:: https://github.com/dfguerrerom/ee-client/actions/workflows/tests.yaml/badge.svg?branch=main
+    :target: https://github.com/dfguerrerom/ee-client/actions/workflows/tests.yaml
+    :alt: Tests
+
+.. image:: https://img.shields.io/pypi/v/ee-client.svg
+    :target: https://pypi.org/project/ee-client/
+    :alt: PyPI version
+
+.. image:: https://img.shields.io/pypi/pyversions/ee-client.svg
+    :target: https://pypi.org/project/ee-client/
+    :alt: Python versions
+
+.. image:: https://img.shields.io/conda/vn/conda-forge/ee-client.svg
+    :target: https://anaconda.org/conda-forge/ee-client
+    :alt: Conda-Forge version
+
+.. image:: https://img.shields.io/pypi/l/ee-client.svg
+    :target: https://github.com/dfguerrerom/ee-client/blob/main/LICENSE
+    :alt: License
+
+The **Earth Engine Session Client** is a Python package that extends the Google Earth Engine (GEE) API by introducing multi-user session management through custom authentication.
 
 **Why This Package?**
 

{ee_client-2.5.2 → ee_client-2.6.1}/README.rst

@@ -1,7 +1,27 @@
 Earth Engine Client 🌎
 ==============================
 
-The **Earth Engine Session Client** is a Python package that extends the Google Earth Engine (GEE) API by introducing multi-user session management through custom authentication. 
+.. image:: https://github.com/dfguerrerom/ee-client/actions/workflows/tests.yaml/badge.svg?branch=main
+    :target: https://github.com/dfguerrerom/ee-client/actions/workflows/tests.yaml
+    :alt: Tests
+
+.. image:: https://img.shields.io/pypi/v/ee-client.svg
+    :target: https://pypi.org/project/ee-client/
+    :alt: PyPI version
+
+.. image:: https://img.shields.io/pypi/pyversions/ee-client.svg
+    :target: https://pypi.org/project/ee-client/
+    :alt: Python versions
+
+.. image:: https://img.shields.io/conda/vn/conda-forge/ee-client.svg
+    :target: https://anaconda.org/conda-forge/ee-client
+    :alt: Conda-Forge version
+
+.. image:: https://img.shields.io/pypi/l/ee-client.svg
+    :target: https://github.com/dfguerrerom/ee-client/blob/main/LICENSE
+    :alt: License
+
+The **Earth Engine Session Client** is a Python package that extends the Google Earth Engine (GEE) API by introducing multi-user session management through custom authentication.
 
 **Why This Package?**
 

{ee_client-2.5.2 → ee_client-2.6.1}/ee_client.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ee-client
-Version: 2.5.2
+Version: 2.6.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
@@ -32,7 +32,27 @@ Dynamic: license-file
 Earth Engine Client 🌎
 ==============================
 
-The **Earth Engine Session Client** is a Python package that extends the Google Earth Engine (GEE) API by introducing multi-user session management through custom authentication. 
+.. image:: https://github.com/dfguerrerom/ee-client/actions/workflows/tests.yaml/badge.svg?branch=main
+    :target: https://github.com/dfguerrerom/ee-client/actions/workflows/tests.yaml
+    :alt: Tests
+
+.. image:: https://img.shields.io/pypi/v/ee-client.svg
+    :target: https://pypi.org/project/ee-client/
+    :alt: PyPI version
+
+.. image:: https://img.shields.io/pypi/pyversions/ee-client.svg
+    :target: https://pypi.org/project/ee-client/
+    :alt: Python versions
+
+.. image:: https://img.shields.io/conda/vn/conda-forge/ee-client.svg
+    :target: https://anaconda.org/conda-forge/ee-client
+    :alt: Conda-Forge version
+
+.. image:: https://img.shields.io/pypi/l/ee-client.svg
+    :target: https://github.com/dfguerrerom/ee-client/blob/main/LICENSE
+    :alt: License
+
+The **Earth Engine Session Client** is a Python package that extends the Google Earth Engine (GEE) API by introducing multi-user session management through custom authentication.
 
 **Why This Package?**
 

{ee_client-2.5.2 → ee_client-2.6.1}/ee_client.egg-info/SOURCES.txt

@@ -26,6 +26,7 @@ eeclient/interfaces/tasks.py
 tests/test_cache.py
 tests/test_client.py
 tests/test_data.py
+tests/test_export_image.py
 tests/test_export_table.py
 tests/test_integration_get_assets.py
 tests/test_models.py

{ee_client-2.5.2 → ee_client-2.6.1}/eeclient/__init__.py

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

{ee_client-2.5.2 → ee_client-2.6.1}/eeclient/export/image.py

@@ -1,6 +1,6 @@
 from enum import Enum
 from typing import TYPE_CHECKING, Optional, Union
-from pydantic import BaseModel, ConfigDict, model_validator
+from pydantic import BaseModel, ConfigDict, field_validator, model_validator
 from pydantic.alias_generators import to_camel
 
 if TYPE_CHECKING:
@@ -44,11 +44,23 @@ class EarthEngineDestination(BaseExportModel):
     name: str
 
 
+_IMAGE_FILE_FORMAT_ALIASES = {
+    "GeoTIFF": "GEO_TIFF",
+}
+
+
 class DriveOptions(BaseExportModel):
     # Removed default so that users must supply a file_format.
     file_format: ImageFileFormat
     drive_destination: DriveDestination
 
+    @field_validator("file_format", mode="before")
+    @classmethod
+    def _accept_legacy_aliases(cls, v):
+        if isinstance(v, str):
+            return _IMAGE_FILE_FORMAT_ALIASES.get(v, v)
+        return v
+
     # TODO: Add support for other export options
     # TODO: add support for format_options
     # See the api: https://developers.google.com/earth-engine/reference/rest/v1alpha/ImageFileExportOptions
@@ -173,7 +185,13 @@ async def _export_image(
     image, updated_image_params, dimensions_consumed = image._apply_crs_and_affine(
         image_params
     )
-    image._apply_selection_and_scale(updated_image_params, dimensions_consumed)
+    # _apply_selection_and_scale returns a new image wrapped in
+    # clipToBoundsAndScale(geometry=region); discarding the return value would
+    # serialize the original unbounded image and cause GEE to reject the task
+    # with "Unable to export unbounded image." (issue #20)
+    image, _ = image._apply_selection_and_scale(
+        updated_image_params, dimensions_consumed
+    )
 
     expression = serializer.encode(image, for_cloud_api=True)
     request_params["expression"] = expression

{ee_client-2.5.2 → ee_client-2.6.1}/eeclient/export/table.py

@@ -1,6 +1,6 @@
 from enum import Enum
 from typing import TYPE_CHECKING, Optional
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, field_validator
 from pydantic.alias_generators import to_camel
 
 if TYPE_CHECKING:
@@ -38,11 +38,24 @@ class EarthEngineDestination(BaseExportModel):
     name: str
 
 
+_TABLE_FILE_FORMAT_ALIASES = {
+    "GeoJSON": "GEO_JSON",
+    "Shapefile": "SHP",
+}
+
+
 class DriveOptions(BaseExportModel):
     # Removed default so that users must supply a file_format.
     file_format: TableFileFormat
     drive_destination: DriveDestination
 
+    @field_validator("file_format", mode="before")
+    @classmethod
+    def _accept_legacy_aliases(cls, v):
+        if isinstance(v, str):
+            return _TABLE_FILE_FORMAT_ALIASES.get(v, v)
+        return v
+
 
 class AssetOptions(BaseExportModel):
     earth_engine_destination: EarthEngineDestination

{ee_client-2.5.2 → ee_client-2.6.1}/pyproject.toml

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

ee_client-2.6.1/tests/test_export_image.py

@@ -0,0 +1,89 @@
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import pytest
+
+from eeclient.export.image import (
+    DriveDestination,
+    DriveOptions,
+    ImageFileFormat,
+    _export_image,
+)
+
+
+def test_drive_options_accepts_legacy_geotiff_alias():
+    opts = DriveOptions(
+        file_format="GeoTIFF",
+        drive_destination=DriveDestination(filename_prefix="out"),
+    )
+    assert opts.file_format == ImageFileFormat.GEO_TIFF
+
+
+def test_drive_options_accepts_canonical_value():
+    opts = DriveOptions(
+        file_format="GEO_TIFF",
+        drive_destination=DriveDestination(filename_prefix="out"),
+    )
+    assert opts.file_format == ImageFileFormat.GEO_TIFF
+
+
+def test_drive_options_rejects_unknown_string():
+    with pytest.raises(ValueError):
+        DriveOptions(
+            file_format="NotAFormat",
+            drive_destination=DriveDestination(filename_prefix="out"),
+        )
+
+
+@pytest.mark.asyncio
+async def test_export_image_uses_clipped_image_from_selection_and_scale():
+    """Regression test for issue #20.
+
+    `ee.Image._apply_selection_and_scale` returns a new image wrapped in
+    `clipToBoundsAndScale(geometry=region)`. The export flow must serialize
+    that clipped image, not the original, or GEE rejects the task as
+    "Unable to export unbounded image".
+    """
+    original_image = MagicMock(name="original_image")
+    crs_applied_image = MagicMock(name="crs_applied_image")
+    clipped_image = MagicMock(name="clipped_image")
+
+    original_image._apply_crs_and_affine.return_value = (
+        crs_applied_image,
+        {"region": "geom", "scale": 30},
+        False,
+    )
+    crs_applied_image._apply_selection_and_scale.return_value = (
+        clipped_image,
+        {},
+    )
+
+    client = MagicMock()
+    client.rest_call = AsyncMock(
+        return_value={"name": "projects/p/operations/op", "metadata": {}}
+    )
+
+    drive_options = DriveOptions(
+        file_format=ImageFileFormat.GEO_TIFF,
+        drive_destination=DriveDestination(filename_prefix="out"),
+    )
+
+    with (
+        patch("eeclient.export.image.serializer.encode") as mock_encode,
+        patch("eeclient.export.image.Task.model_validate") as mock_validate,
+    ):
+        mock_encode.return_value = {"result": "encoded"}
+        mock_validate.return_value = MagicMock()
+
+        await _export_image(
+            client=client,
+            image=original_image,
+            drive_options=drive_options,
+            region="geom",
+            scale=30,
+        )
+
+    # The serialized expression must be the clipped image, not the original
+    # or the intermediate crs-applied image.
+    mock_encode.assert_called_once()
+    encoded_image = mock_encode.call_args.args[0]
+    assert encoded_image is clipped_image

{ee_client-2.5.2 → ee_client-2.6.1}/tests/test_export_table.py

@@ -42,6 +42,29 @@ def test_drive_export_options_serialize_as_file_export_options():
     assert "assetExportOptions" not in payload
 
 
+@pytest.mark.parametrize(
+    "alias,canonical",
+    [
+        ("GeoJSON", TableFileFormat.GEO_JSON),
+        ("Shapefile", TableFileFormat.SHP),
+    ],
+)
+def test_drive_options_accepts_legacy_table_aliases(alias, canonical):
+    opts = DriveOptions(
+        file_format=alias,
+        drive_destination=DriveDestination(filename_prefix="out"),
+    )
+    assert opts.file_format == canonical
+
+
+def test_drive_options_rejects_unknown_string():
+    with pytest.raises(ValueError):
+        DriveOptions(
+            file_format="NotAFormat",
+            drive_destination=DriveDestination(filename_prefix="out"),
+        )
+
+
 @pytest.mark.asyncio
 async def test_table_to_asset_async_sends_asset_export_options():
     client = AsyncMock()