earthengine-api 1.6.13__py3-none-any.whl → 1.7.4__py3-none-any.whl

ee/model.py

@@ -1,7 +1,5 @@
 """A wrapper for Models."""
 
-from typing import Optional
-
 from ee import _arg_types
 from ee import apifunction
 from ee import computedobject
@@ -66,26 +64,26 @@ class Model(computedobject.ComputedObject):
   @deprecation.Deprecated('Migrate to Vertex AI')
   def fromAiPlatformPredictor(
       # pylint: disable=invalid-name
-      projectName: Optional[_arg_types.Any] = None,
-      projectId: Optional[_arg_types.String] = None,
-      modelName: Optional[_arg_types.String] = None,
+      projectName: _arg_types.Any | None = None,
+      projectId: _arg_types.String | None = None,
+      modelName: _arg_types.String | None = None,
       # pylint: enable=invalid-name
-      version: Optional[_arg_types.String] = None,
-      region: Optional[_arg_types.String] = None,
+      version: _arg_types.String | None = None,
+      region: _arg_types.String | None = None,
       # pylint: disable=invalid-name
-      inputProperties: Optional[_arg_types.List] = None,
-      inputTypeOverride: Optional[_arg_types.Dictionary] = None,
-      inputShapes: Optional[_arg_types.Dictionary] = None,
+      inputProperties: _arg_types.List | None = None,
+      inputTypeOverride: _arg_types.Dictionary | None = None,
+      inputShapes: _arg_types.Dictionary | None = None,
       # pylint: enable=invalid-name
-      proj: Optional[_arg_types.Projection] = None,
+      proj: _arg_types.Projection | None = None,
       # pylint: disable=invalid-name
-      fixInputProj: Optional[_arg_types.Bool] = None,
-      inputTileSize: Optional[_arg_types.List] = None,
-      inputOverlapSize: Optional[_arg_types.List] = None,
-      outputTileSize: Optional[_arg_types.List] = None,
-      outputBands: Optional[_arg_types.Dictionary] = None,
-      outputProperties: Optional[_arg_types.Dictionary] = None,
-      outputMultiplier: Optional[_arg_types.Number] = None,
+      fixInputProj: _arg_types.Bool | None = None,
+      inputTileSize: _arg_types.List | None = None,
+      inputOverlapSize: _arg_types.List | None = None,
+      outputTileSize: _arg_types.List | None = None,
+      outputBands: _arg_types.Dictionary | None = None,
+      outputProperties: _arg_types.Dictionary | None = None,
+      outputMultiplier: _arg_types.Number | None = None,
       # pylint: enable=invalid-name
   ) -> 'Model':
     """Returns an ee.Model from a description of an AI Platform prediction model.
@@ -168,21 +166,21 @@ class Model(computedobject.ComputedObject):
   def fromVertexAi(
       endpoint: _arg_types.String,
       # pylint: disable=invalid-name
-      inputProperties: Optional[_arg_types.List] = None,
-      inputTypeOverride: Optional[_arg_types.Dictionary] = None,
-      inputShapes: Optional[_arg_types.Dictionary] = None,
+      inputProperties: _arg_types.List | None = None,
+      inputTypeOverride: _arg_types.Dictionary | None = None,
+      inputShapes: _arg_types.Dictionary | None = None,
       # pylint: enable=invalid-name
-      proj: Optional[_arg_types.Projection] = None,
+      proj: _arg_types.Projection | None = None,
       # pylint: disable=invalid-name
-      fixInputProj: Optional[_arg_types.Bool] = None,
-      inputTileSize: Optional[_arg_types.List] = None,
-      inputOverlapSize: Optional[_arg_types.List] = None,
-      outputTileSize: Optional[_arg_types.List] = None,
-      outputBands: Optional[_arg_types.Dictionary] = None,
-      outputProperties: Optional[_arg_types.Dictionary] = None,
-      outputMultiplier: Optional[_arg_types.Number] = None,
-      maxPayloadBytes: Optional[_arg_types.Integer] = None,
-      payloadFormat: Optional[_arg_types.String] = None,
+      fixInputProj: _arg_types.Bool | None = None,
+      inputTileSize: _arg_types.List | None = None,
+      inputOverlapSize: _arg_types.List | None = None,
+      outputTileSize: _arg_types.List | None = None,
+      outputBands: _arg_types.Dictionary | None = None,
+      outputProperties: _arg_types.Dictionary | None = None,
+      outputMultiplier: _arg_types.Number | None = None,
+      maxPayloadBytes: _arg_types.Integer | None = None,
+      payloadFormat: _arg_types.String | None = None,
       # pylint: enable=invalid-name
   ) -> 'Model':
     """Returns an ee.Model from a description of a Vertex AI model endpoint.

ee/oauth.py

@@ -9,6 +9,7 @@ Typical use-case consists of:
 """
 
 import base64
+from collections.abc import Sequence
 import errno
 import hashlib
 import http.server
@@ -17,8 +18,7 @@ import os
 import shutil
 import subprocess
 import sys
-from typing import Any, Optional, Union
-from collections.abc import Sequence
+from typing import Any
 import urllib.error
 import urllib.parse
 import urllib.request
@@ -101,13 +101,13 @@ def get_credentials_arguments() -> dict[str, Any]:
     return args
 
 
-def is_sdk_credentials(credentials: Optional[Any]) -> bool:
+def is_sdk_credentials(credentials: Any | None) -> bool:
   return is_sdk_project(project_number_from_credentials(credentials))
 
 
 def project_number_from_credentials(
-    credentials: Optional[Any],
-) -> Optional[str]:
+    credentials: Any | None,
+) -> str | None:
   client_id = credentials and getattr(credentials, 'client_id', None)
   return _project_number_from_client_id(client_id)
 
@@ -116,7 +116,7 @@ def is_sdk_project(project: str) -> bool:
   return project in SDK_PROJECTS
 
 
-def get_appdefault_project() -> Optional[str]:
+def get_appdefault_project() -> str | None:
   try:
     adc_path = _cloud_sdk.get_application_default_credentials_path()
     with open(adc_path) as adc_json:
@@ -134,7 +134,7 @@ def _valid_credentials_exist() -> bool:
     return False
 
 
-def is_valid_credentials(credentials: Optional[Any]) -> bool:
+def is_valid_credentials(credentials: Any | None) -> bool:
   if credentials is None:
     return False
   try:
@@ -146,8 +146,8 @@ def is_valid_credentials(credentials: Optional[Any]) -> bool:
 
 def get_authorization_url(
     code_challenge: str,
-    scopes: Optional[Sequence[str]] = None,
-    redirect_uri: Optional[str] = None,
+    scopes: Sequence[str] | None = None,
+    redirect_uri: str | None = None,
 ) -> str:
   """Returns a URL to generate an auth code."""
 
@@ -164,9 +164,9 @@ def get_authorization_url(
 def request_token(
     auth_code: str,
     code_verifier: str,
-    client_id: Optional[str] = None,
-    client_secret: Optional[str] = None,
-    redirect_uri: Optional[str] = None,
+    client_id: str | None = None,
+    client_secret: str | None = None,
+    redirect_uri: str | None = None,
 ) -> str:
   """Uses authorization code to request tokens."""
 
@@ -201,7 +201,7 @@ def write_private_json(json_path: str, info_dict: dict[str, Any]) -> None:
   except OSError as e:
     if e.errno != errno.EEXIST:
       # pylint:disable=broad-exception-raised,raise-missing-from
-      raise Exception('Error creating directory {}: {}'.format(dirname, e))
+      raise Exception(f'Error creating directory {dirname}: {e}')
       # pylint:enable=broad-exception-raised,raise-missing-from
 
   file_content = json.dumps(info_dict)
@@ -226,7 +226,7 @@ def _in_jupyter_shell() -> bool:
   """Tests if the code is being executed within Jupyter."""
   try:
     import ipykernel.zmqshell
-    return isinstance(IPython.get_ipython(),
+    return isinstance(IPython.get_ipython(),  # pylint: disable=undefined-variable
                       ipykernel.zmqshell.ZMQInteractiveShell)
   except ImportError:
     return False
@@ -234,7 +234,7 @@ def _in_jupyter_shell() -> bool:
     return False
 
 
-def _project_number_from_client_id(client_id: Optional[str]) -> Optional[str]:
+def _project_number_from_client_id(client_id: str | None) -> str | None:
   """Returns the project number associated with the given OAuth client ID."""
   # Client IDs are of the form:
   # PROJECTNUMBER-BASE32STUFF.apps.googleusercontent.com.
@@ -243,10 +243,10 @@ def _project_number_from_client_id(client_id: Optional[str]) -> Optional[str]:
 
 
 def _obtain_and_write_token(
-    auth_code: Optional[str] = None,
-    code_verifier: Optional[str] = None,
-    scopes: Optional[Sequence[str]] = None,
-    redirect_uri: Optional[str] = None,
+    auth_code: str | None = None,
+    code_verifier: str | None = None,
+    scopes: Sequence[str] | None = None,
+    redirect_uri: str | None = None,
 ) -> None:
   """Obtains and writes credentials token based on an authorization code."""
   fetch_data = {}
@@ -283,7 +283,7 @@ def _obtain_and_write_token(
 
 
 def _display_auth_instructions_for_noninteractive(
-    auth_url: str, code_verifier: Union[bytes, str]
+    auth_url: str, code_verifier: bytes | str
 ) -> None:
   """Displays instructions for authenticating without blocking for user input."""
   # Python 3 `bytes` should be decoded to `str` if used as an argument of
@@ -310,7 +310,7 @@ def _display_auth_instructions_for_noninteractive(
 
 
 def _display_auth_instructions_with_print(
-    auth_url: str, coda: Optional[str] = None
+    auth_url: str, coda: str | None = None
 ) -> None:
   """Displays instructions for authenticating using a print statement."""
   print(
@@ -325,11 +325,11 @@ def _display_auth_instructions_with_print(
 
 
 def _display_auth_instructions_with_html(
-    auth_url: str, coda: Optional[str] = None
+    auth_url: str, coda: str | None = None
 ) -> None:
   """Displays instructions for authenticating using HTML code."""
   try:
-    IPython.display.display(IPython.display.HTML(
+    IPython.display.display(IPython.display.HTML(  # pylint: disable=undefined-variable
         """<p>To authorize access needed by Earth Engine, open the following
         URL in a web browser and follow the instructions:</p>
         <p><a href={0}>{0}</a></p>
@@ -382,8 +382,8 @@ def _no_gcloud() -> bool:
 
 
 def _load_gcloud_credentials(
-    scopes: Optional[Sequence[str]] = None,
-    quiet: Optional[bool] = None,
+    scopes: Sequence[str] | None = None,
+    quiet: bool | None = None,
     run_gcloud_legacy: bool = False,
 ) -> None:
   """Initializes credentials by running gcloud flows."""
@@ -435,7 +435,7 @@ def _start_server(port: int):
   class Handler(http.server.BaseHTTPRequestHandler):
     """Handles the OAuth callback and reports a success page."""
 
-    code: Optional[str] = None
+    code: str | None = None
 
     def do_GET(self) -> None:  # pylint: disable=invalid-name
       Handler.code = urllib.parse.parse_qs(
@@ -460,7 +460,7 @@ def _start_server(port: int):
       self.server = http.server.HTTPServer(('localhost', port), Handler)
       self.url = 'http://localhost:%s' % self.server.server_address[1]
 
-    def fetch_code(self) -> Optional[str]:
+    def fetch_code(self) -> str | None:
       self.server.handle_request()  # Blocks until a single request arrives.
       self.server.server_close()
       return Handler.code
@@ -469,13 +469,13 @@ def _start_server(port: int):
 
 
 def authenticate(
-    cli_authorization_code: Optional[str] = None,
-    quiet: Optional[bool] = None,
-    cli_code_verifier: Optional[str] = None,
-    auth_mode: Optional[str] = None,
-    scopes: Optional[Sequence[str]] = None,
+    cli_authorization_code: str | None = None,
+    quiet: bool | None = None,
+    cli_code_verifier: str | None = None,
+    auth_mode: str | None = None,
+    scopes: Sequence[str] | None = None,
     force: bool = False,
-) -> Optional[bool]:
+) -> bool | None:
   """Prompts the user to authorize access to Earth Engine via OAuth2.
 
   Args:
@@ -564,11 +564,11 @@ class Flow:
   """Holds state for auth flows."""
   code_verifier: str
   scopes: Sequence[str]
-  server: Optional[Any]
+  server: Any | None
   auth_url: str
 
   def __init__(
-      self, auth_mode: str = 'notebook', scopes: Optional[Sequence[str]] = None
+      self, auth_mode: str = 'notebook', scopes: Sequence[str] | None = None
   ):
     """Initializes auth URL and PKCE verifier, for use in save_code().
 
@@ -601,7 +601,7 @@ class Flow:
       # pylint:disable-next=broad-exception-raised
       raise ee_exception.EEException('Unknown auth_mode "%s"' % auth_mode)
 
-  def save_code(self, code: Optional[str] = None) -> None:
+  def save_code(self, code: str | None = None) -> None:
     """Fetches auth code if not given, and saves the generated credentials."""
     redirect_uri = None
     if self.server and not code:
@@ -609,7 +609,7 @@ class Flow:
       code = self.server.fetch_code()  # Waits for oauth callback
     _obtain_and_write_token(code, self.code_verifier, self.scopes, redirect_uri)
 
-  def display_instructions(self, quiet: Optional[bool] = None) -> bool:
+  def display_instructions(self, quiet: bool | None = None) -> bool:
     """Prints to stdout, and returns True if a browser should be opened."""
 
     if quiet:

ee/reducer.py

@@ -465,8 +465,10 @@ class Reducer(computedobject.ComputedObject):
 
   def group(
       self,
+      # pylint: disable=invalid-name
       groupField: _arg_types.Integer | None = None,
       groupName: _arg_types.String | None = None,
+      # pylint: enable=invalid-name
   ) -> Reducer:
     """Returns a reducer groups reducer records by the value of a given input.
 

ee/serializer.py

@@ -4,7 +4,7 @@ import collections
 import datetime
 import hashlib
 import json
-from typing import Any, Optional
+from typing import Any
 
 from ee import _cloud_api_utils
 from ee import _utils
@@ -32,7 +32,7 @@ def DatetimeToMicroseconds(date: datetime.datetime) -> int:
 
 class Serializer:
   """A serializer for EE object trees."""
-  unbound_name: Optional[str]
+  unbound_name: str | None
 
   # Whether the encoding should factor out shared subtrees.
   _is_compound: bool
@@ -48,7 +48,7 @@ class Serializer:
       self,
       is_compound: bool = True,
       for_cloud_api: bool = False,
-      unbound_name: Optional[str] = None,
+      unbound_name: str | None = None,
   ):
     """Constructs a serializer.
 
@@ -280,7 +280,7 @@ def encode(
     obj: Any,
     is_compound: bool = True,
     for_cloud_api: bool = True,
-    unbound_name: Optional[str] = None,
+    unbound_name: str | None = None,
 ) -> Any:
   """Serialize an object to a JSON-compatible structure for API calls.
 
@@ -358,7 +358,7 @@ class _ExpressionOptimizer:
   - Collapse dicts and arrays of constants to constant dicts/arrays.
   """
 
-  def __init__(self, result: Any, values: Optional[Any] = None):
+  def __init__(self, result: Any, values: Any | None = None):
     """Builds an ExpressionOptimizer.
 
     Args:
@@ -385,7 +385,7 @@ class _ExpressionOptimizer:
     reference_counts = collections.defaultdict(int)
     reference_counts[self._result] += 1
 
-    def _contained_reference(value: Any) -> Optional[Any]:
+    def _contained_reference(value: Any) -> Any | None:
       """Gets a contained reference from a ValueNode, if there is one."""
       if 'functionDefinitionValue' in value:
         return value['functionDefinitionValue']['body']

ee/table_converter.py

@@ -1,7 +1,7 @@
 """Converters used in the table data fetching methods."""
 
 from collections.abc import Iterator
-from typing import Any, Optional, Union
+from typing import Any
 
 
 class TableConverter:
@@ -59,8 +59,8 @@ _TABLE_DATA_CONVERTERS: dict[str, type[TableConverter]] = {
 
 
 def from_file_format(
-    file_format: Union[str, TableConverter]
-) -> Optional[TableConverter]:
+    file_format: str | TableConverter
+) -> TableConverter | None:
   if isinstance(file_format, TableConverter):
     return file_format
   if file_format in _TABLE_DATA_CONVERTERS:

ee/terrain.py

@@ -13,7 +13,7 @@ class Terrain:
 
   def __init__(self):
     raise RuntimeError(
-        self.__name__
+        self.__class__.__name__
         + ' should not be used as an object. Only direct usage of Terrain'
         ' static methods is allowed. For example, use this: '
         ' `ee.Terrain.aspect(...)`'

ee/tests/batch_test.py

@@ -2,7 +2,7 @@
 """Test for the ee.batch module."""
 
 import json
-from typing import Any, Optional
+from typing import Any
 import unittest
 from unittest import mock
 
@@ -138,6 +138,14 @@ class TaskTest(unittest.TestCase):
     ):
       self.assertFalse(task.active())
 
+  def test_success(self):
+    self.assertTrue(batch.Task.State.success(batch.Task.State.COMPLETED))
+    self.assertTrue(batch.Task.State.success('COMPLETED'))
+    for state in batch.Task.State:
+      if state != batch.Task.State.COMPLETED:
+        self.assertFalse(batch.Task.State.success(state))
+        self.assertFalse(batch.Task.State.success(state.value))
+
   def test_repr_without_config(self):
     task = batch.Task('an id', 'a task type', 'a state')
     self.assertEqual('<Task "an id">', task.__repr__())
@@ -193,8 +201,8 @@ class ExportTest(unittest.TestCase):
 class BatchTestCase(apitestcase.ApiTestCase):
   """A test case for batch functionality."""
 
-  start_call_params: Optional[Any]
-  update_call_params: Optional[Any]
+  start_call_params: Any | None
+  update_call_params: Any | None
 
   def setUp(self):
     super().setUp()
@@ -266,6 +274,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   }
               },
               'description': 'myExportImageTask',
@@ -417,6 +426,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   },
                   'pyramidingPolicyOverrides': {'B1': 'MIN'},
               },
@@ -443,6 +453,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   },
                   'tileSize': {'value': 4},
               },
@@ -452,6 +463,43 @@ class BatchTestCase(apitestcase.ApiTestCase):
           task_ordered.config,
       )
 
+      task_with_overwrite = ee.batch.Export.image.toAsset(
+          image=config['image'],
+          assetId=config['assetId'],
+          overwrite=True,
+      )
+      self.assertTrue(
+          task_with_overwrite.config['assetExportOptions'][
+              'earthEngineDestination'
+          ]['overwrite']
+      )
+
+      task_with_priority = ee.batch.Export.image.toAsset(
+          image=config['image'],
+          assetId=config['assetId'],
+          priority=999,
+      )
+      self.assertIsNone(task_with_priority.id)
+      self.assertIsNone(task_with_priority.name)
+      self.assertEqual('EXPORT_IMAGE', task_with_priority.task_type)
+      self.assertEqual('UNSUBMITTED', task_with_priority.state)
+      self.assertEqual(
+          {
+              'expression': expected_expression,
+              'description': 'myExportImageTask',
+              'assetExportOptions': {
+                  'earthEngineDestination': {
+                      'name': (
+                          'projects/earthengine-legacy/assets/users/foo/bar'
+                      ),
+                      'overwrite': False,
+                  }
+              },
+              'priority': {'value': 999},
+          },
+          task_with_priority.config,
+      )
+
   def test_export_image_to_asset_cloud_api_with_tile_size(self):
     """Verifies the Asset export task created by Export.image.toAsset()."""
     with apitestcase.UsingCloudApi():
@@ -481,6 +529,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   },
                   'tileSize': {'value': 4},
               },
@@ -1125,11 +1174,25 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   }
               },
           },
           task.config,
       )
+
+      task_with_overwrite = ee.batch.Export.table.toAsset(
+          collection=ee.FeatureCollection('foo'),
+          description='foo',
+          assetId='users/foo/bar',
+          overwrite=True,
+      )
+      self.assertTrue(
+          task_with_overwrite.config['assetExportOptions'][
+              'earthEngineDestination'
+          ]['overwrite']
+      )
+
       task_with_priority = ee.batch.Export.table.toAsset(
           collection=ee.FeatureCollection('foo'),
           description='foo',
@@ -1145,6 +1208,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   }
               },
               'priority': {'value': 999},

ee/tests/collection_test.py

@@ -47,6 +47,10 @@ class CollectionTestCase(apitestcase.ApiTestCase):
 
     # We don't allow empty filters.
     self.assertRaises(Exception, collection.filter)
+    with self.assertRaisesRegex(ee.EEException, 'Empty filters.'):
+      collection.filter(None)  # pytype: disable=wrong-arg-types
+    with self.assertRaisesRegex(ee.EEException, 'Empty filters.'):
+      collection.filter('')
 
     filtered = collection.filter(ee.Filter.eq('foo', 1))
     self.assertEqual(ee.ApiFunction.lookup('Collection.filter'), filtered.func)
@@ -75,6 +79,37 @@ class CollectionTestCase(apitestcase.ApiTestCase):
         collection.filter(ee.Filter.eq('foo', 13)),
         collection.filterMetadata('foo', 'equals', 13))
 
+  def test_load_table(self):
+    """Verifies Collection.loadTable()."""
+    table_id = 'a/table/id'
+    geometry_column = 'geom'
+    version = 123
+    result = ee.Collection.loadTable(
+        tableId=table_id, geometryColumn=geometry_column, version=version
+    )
+    self.assertEqual(ee.ApiFunction.lookup('Collection.loadTable'), result.func)
+    self.assertEqual(
+        {
+            'tableId': ee.String(table_id),
+            'geometryColumn': ee.String(geometry_column),
+            'version': ee.Number(version),
+        },
+        result.args,
+    )
+    self.assertIsInstance(result, ee.FeatureCollection)
+
+    result2 = ee.Collection.loadTable(tableId=table_id)
+    self.assertEqual(ee.ApiFunction.lookup('Collection.loadTable'), result2.func)
+    self.assertEqual(
+        {
+            'tableId': ee.String(table_id),
+            'geometryColumn': None,
+            'version': None,
+        },
+        result2.args,
+    )
+    self.assertIsInstance(result2, ee.FeatureCollection)
+
   def test_mapping(self):
     """Verifies the behavior of the map() method."""
     collection = ee.ImageCollection('foo')