earthengine-api 1.7.1rc0__tar.gz → 1.7.3__tar.gz

{earthengine_api-1.7.1rc0/earthengine_api.egg-info → earthengine_api-1.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: earthengine-api
-Version: 1.7.1rc0
+Version: 1.7.3
 Summary: Earth Engine Python API
 Author-email: Google LLC <noreply@google.com>
 License: Apache-2.0

{earthengine_api-1.7.1rc0 → earthengine_api-1.7.3/earthengine_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: earthengine-api
-Version: 1.7.1rc0
+Version: 1.7.3
 Summary: Earth Engine Python API
 Author-email: Google LLC <noreply@google.com>
 License: Apache-2.0

{earthengine_api-1.7.1rc0 → earthengine_api-1.7.3}/ee/__init__.py

@@ -1,6 +1,6 @@
 """The EE Python library."""
 
-__version__ = '1.7.1rc0'
+__version__ = '1.7.3'
 
 # Using lowercase function naming to match the JavaScript names.
 # pylint: disable=g-bad-name

{earthengine_api-1.7.1rc0 → earthengine_api-1.7.3}/ee/batch.py

@@ -308,6 +308,7 @@ class Export:
         crsTransform=None,
         maxPixels=None,
         priority=None,
+        overwrite=False,
         **kwargs,
     ) -> Task:
       """Creates a task to export an EE Image to an EE Asset.
@@ -344,6 +345,7 @@ class Export:
         priority: The priority of the task within the project. Higher priority
           tasks are scheduled sooner. Must be an integer between 0 and 9999.
           Defaults to 100.
+        overwrite: If an existing asset can be overwritten by this export.
         **kwargs: Holds other keyword arguments that may have been deprecated
             such as 'crs_transform'.
 
@@ -739,6 +741,7 @@ class Export:
         assetId=None,
         maxVertices=None,
         priority=None,
+        overwrite=False,
         **kwargs,
     ) -> Task:
       """Creates a task to export a FeatureCollection to an EE table asset.
@@ -753,6 +756,7 @@ class Export:
         priority: The priority of the task within the project. Higher priority
           tasks are scheduled sooner. Must be an integer between 0 and 9999.
           Defaults to 100.
+        overwrite: If an existing asset can be overwritten by this export.
         **kwargs: Holds other keyword arguments that may have been deprecated.
 
       Returns:
@@ -763,6 +767,7 @@ class Export:
           'assetId': assetId,
           'maxVertices': maxVertices,
           'priority': priority,
+          'overwrite': overwrite,
       }
       config = {k: v for k, v, in config.items() if v is not None}
       config = _prepare_table_export_config(collection, config,
@@ -1738,6 +1743,8 @@ def _build_earth_engine_destination(config: dict[str, Any]) -> dict[str, Any]:
       'name':
           _cloud_api_utils.convert_asset_id_to_asset_name(
               config.pop('assetId')),
+      'overwrite':
+          config.pop('overwrite', False)
   }
 
 

{earthengine_api-1.7.1rc0 → earthengine_api-1.7.3}/ee/data.py

@@ -2161,6 +2161,7 @@ def setIamPolicy(asset_id: str, policy: Any) -> None:
       .setIamPolicy(resource=name, body={'policy': policy}, prettyPrint=False)
   )
 
+
 @deprecation.Deprecated('Use ee.data.updateAsset().')
 def setAssetProperties(assetId: str, properties: dict[str, Any]) -> None:
   """Sets metadata properties of the asset with the given ID.

{earthengine_api-1.7.1rc0 → earthengine_api-1.7.3}/ee/oauth.py

@@ -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
@@ -329,7 +329,7 @@ def _display_auth_instructions_with_html(
 ) -> 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>

{earthengine_api-1.7.1rc0 → earthengine_api-1.7.3}/ee/tests/batch_test.py

@@ -274,6 +274,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   }
               },
               'description': 'myExportImageTask',
@@ -425,6 +426,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   },
                   'pyramidingPolicyOverrides': {'B1': 'MIN'},
               },
@@ -451,6 +453,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   },
                   'tileSize': {'value': 4},
               },
@@ -460,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():
@@ -489,6 +529,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   },
                   'tileSize': {'value': 4},
               },
@@ -1133,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',
@@ -1153,6 +1208,7 @@ class BatchTestCase(apitestcase.ApiTestCase):
                       'name': (
                           'projects/earthengine-legacy/assets/users/foo/bar'
                       ),
+                      'overwrite': False,
                   }
               },
               'priority': {'value': 999},

{earthengine_api-1.7.1rc0 → earthengine_api-1.7.3}/ee/tests/data_test.py

@@ -87,6 +87,26 @@ class DataTest(unittest.TestCase):
         _state.get_state().cloud_api_user_project, 'earthengine-legacy'
     )
 
+  @mock.patch.object(ee.data, '_install_cloud_api_resource', return_value=None)
+  def test_initialize_with_credentials(
+      self, unused_mock_install_cloud_api_resource
+  ):
+    creds = mock.MagicMock()
+    ee.data.initialize(credentials=creds)
+
+    self.assertTrue(ee.data.is_initialized())
+    self.assertEqual(creds, _state.get_state().credentials)
+
+  @mock.patch.object(ee.data, '_install_cloud_api_resource', return_value=None)
+  def test_initialize_with_cloud_api_key(
+      self, unused_mock_install_cloud_api_resource
+  ):
+    cloud_api_key = 'a cloud api key'
+    ee.data.initialize(cloud_api_key=cloud_api_key)
+
+    self.assertTrue(ee.data.is_initialized())
+    self.assertEqual(cloud_api_key, _state.get_state().cloud_api_key)
+
   def test_set_max_retries_bad_values(self):
     with self.assertRaises(ValueError):
       ee.data.setMaxRetries(-1)
@@ -110,6 +130,46 @@ class DataTest(unittest.TestCase):
           .execute.call_args.kwargs['num_retries'],
       )
 
+  def test_set_cloud_api_key(self):
+    cloud_api_key = 'a cloud api key'
+    with mock.patch.object(
+        ee.data, '_install_cloud_api_resource', return_value=None
+    ) as mock_install_cloud_api_resource:
+      ee.data.setCloudApiKey(cloud_api_key)
+      self.assertEqual(cloud_api_key, _state.get_state().cloud_api_key)
+      mock_install_cloud_api_resource.assert_called_once()
+
+  def test_set_deadline(self):
+    deadline_ms = 12345
+    with mock.patch.object(
+        ee.data, '_install_cloud_api_resource', return_value=None
+    ) as mock_install_cloud_api_resource:
+      ee.data.setDeadline(deadline_ms)
+      self.assertEqual(deadline_ms, _state.get_state().deadline_ms)
+      mock_install_cloud_api_resource.assert_called_once()
+
+  def test_get_set_user_agent(self):
+    self.assertIsNone(ee.data.getUserAgent())
+    user_agent = 'user-agent'
+    ee.data.setUserAgent(user_agent)
+    self.assertEqual(user_agent, ee.data.getUserAgent())
+
+  def test_authorize_http_no_credentials(self):
+    self.assertIsNone(ee.data._get_state().credentials)
+    http = mock.MagicMock()
+    self.assertEqual(http, ee.data.authorizeHttp(http))
+
+  def test_authorize_http_with_credentials(self):
+    creds = mock.MagicMock()
+    ee.data._get_state().credentials = creds
+    http = mock.MagicMock()
+    with mock.patch.object(
+        ee.data.google_auth_httplib2, 'AuthorizedHttp'
+    ) as mock_authorized_http:
+      result = ee.data.authorizeHttp(http)
+      self.assertEqual(mock_authorized_http.return_value, result)
+      mock_authorized_http.assert_called_once_with(creds)
+
   def test_list_operations(self):
     mock_http = mock.MagicMock(httplib2.Http)
     # Return in three groups.
@@ -342,6 +402,14 @@ class DataTest(unittest.TestCase):
       asset = mock_create_asset.call_args.kwargs['body']
       self.assertEqual(asset, {'type': 'FOLDER'})
 
+  @mock.patch.object(ee.data, 'createAsset')
+  def test_create_asset_home(self, mock_create_asset):
+    ee.data.createAssetHome('users/test')
+    mock_create_asset.assert_called_once_with({
+        'name': 'projects/earthengine-legacy/assets/users/test',
+        'type': 'FOLDER',
+    })
+
   def test_create_assets(self):
     cloud_api_resource = mock.MagicMock()
     with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
@@ -432,6 +500,68 @@ class DataTest(unittest.TestCase):
       )
       self.assertTrue(import_args['overwrite'])
 
+  def test_start_table_ingestion(self):
+    cloud_api_resource = mock.MagicMock()
+    with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
+      mock_result = {'name': 'operations/ingestion', 'done': False}
+      cloud_api_resource.projects().table().import_.return_value.execute.return_value = (
+          mock_result
+      )
+      params = {
+          'id': 'users/test/table',
+          'sources': [{'uris': ['gs://bucket/file.shp'], 'charset': 'UTF-8'}],
+      }
+      result = ee.data.startTableIngestion('request_id', params, True)
+      self.assertEqual(result['id'], 'ingestion')
+      self.assertEqual(result['name'], 'operations/ingestion')
+
+      mock_import = cloud_api_resource.projects().table().import_
+      mock_import.assert_called_once()
+      call_kwargs = mock_import.call_args.kwargs
+      self.assertEqual(call_kwargs['project'], 'projects/earthengine-legacy')
+      body = call_kwargs['body']
+      self.assertEqual(
+          body['tableManifest'],
+          {
+              'name': 'projects/earthengine-legacy/assets/users/test/table',
+              'sources': [
+                  {'uris': ['gs://bucket/file.shp'], 'charset': 'UTF-8'}
+              ],
+          },
+      )
+      self.assertEqual(body['requestId'], 'request_id')
+      self.assertTrue(body['overwrite'])
+
+  def test_start_external_image_ingestion(self):
+    cloud_api_resource = mock.MagicMock()
+    with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
+      cloud_api_resource.projects().image().importExternal.return_value.execute.return_value = (
+          {}
+      )
+      manifest = {
+          'id': 'users/test/image',
+          'tilesets': [{'sources': [{'uris': ['gs://bucket/file.tif']}]}],
+      }
+      result = ee.data.startExternalImageIngestion(manifest, True)
+      expected_name = 'projects/earthengine-legacy/assets/users/test/image'
+      self.assertEqual(result['name'], expected_name)
+
+      mock_import_external = (
+          cloud_api_resource.projects().image().importExternal
+      )
+      mock_import_external.assert_called_once()
+      call_kwargs = mock_import_external.call_args.kwargs
+      self.assertEqual(call_kwargs['project'], 'projects/earthengine-legacy')
+      body = call_kwargs['body']
+      self.assertEqual(
+          body['imageManifest'],
+          {
+              'name': expected_name,
+              'tilesets': [{'sources': [{'uris': ['gs://bucket/file.tif']}]}],
+          },
+      )
+      self.assertTrue(body['overwrite'])
+
   def test_set_asset_properties(self):
     mock_http = mock.MagicMock(httplib2.Http)
     with apitestcase.UsingCloudApi(mock_http=mock_http), mock.patch.object(
@@ -453,6 +583,18 @@ class DataTest(unittest.TestCase):
           {'properties.\"mYPropErTy\"',
                'properties.\"system:time_start\"'})
 
+  def test_update_asset(self):
+    cloud_api_resource = mock.MagicMock()
+    with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
+      asset_id = 'users/test/asset'
+      asset = {'properties': {'foo': 'bar'}}
+      update_mask = ['properties.foo']
+      ee.data.updateAsset(asset_id, asset, update_mask)
+      cloud_api_resource.projects().assets().patch.assert_called_once_with(
+          name='projects/earthengine-legacy/assets/users/test/asset',
+          body={'updateMask': {'paths': update_mask}, 'asset': asset},
+      )
+
   def test_list_assets(self):
     cloud_api_resource = mock.MagicMock()
     with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
@@ -576,6 +718,16 @@ class DataTest(unittest.TestCase):
     cloud_api_resource.projects().listAssets().execute.assert_called_once()
     self.assertEqual(mock_result, actual_result)
 
+  def test_get_asset_roots(self):
+    with mock.patch.object(
+        ee.data,
+        'listBuckets',
+        return_value={'assets': [{'name': 'id1', 'type': 'FOLDER'}]},
+    ) as mock_list_buckets:
+      result = ee.data.getAssetRoots()
+      mock_list_buckets.assert_called_once()
+      self.assertEqual([{'id': 'id1', 'type': 'Folder'}], result)
+
   def test_simple_get_list_via_cloud_api(self):
     cloud_api_resource = mock.MagicMock()
     with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
@@ -881,6 +1033,50 @@ class DataTest(unittest.TestCase):
       ).execute.assert_called_once()
       self.assertEqual(mock_result, actual_result)
 
+  def test_get_pixels(self):
+    cloud_api_resource_raw = mock.MagicMock()
+    with apitestcase.UsingCloudApi(
+        cloud_api_resource_raw=cloud_api_resource_raw
+    ):
+      assets = cloud_api_resource_raw.projects().assets()
+      mock_result = b'pixel data'
+      assets.getPixels.return_value.execute.return_value = mock_result
+      asset_id = 'users/foo/bar'
+      params = {'assetId': asset_id}
+      result = ee.data.getPixels(params)
+      self.assertEqual(mock_result, result)
+      assets.getPixels.assert_called_once_with(
+          name='projects/earthengine-legacy/assets/users/foo/bar',
+          body={'fileFormat': 'AUTO_JPEG_PNG'},
+      )
+
+  def test_compute_pixels(self):
+    cloud_api_resource_raw = mock.MagicMock()
+    with apitestcase.UsingCloudApi(
+        cloud_api_resource_raw=cloud_api_resource_raw
+    ):
+      mock_result = b'pixel data'
+      (
+          cloud_api_resource_raw.projects()
+          .image()
+          .computePixels.return_value.execute.return_value
+      ) = mock_result
+      expression = ee.Image(1)
+      params = {'expression': expression}
+      result = ee.data.computePixels(params)
+      self.assertEqual(mock_result, result)
+      (
+          cloud_api_resource_raw.projects()
+          .image()
+          .computePixels.assert_called_once_with(
+              project='projects/earthengine-legacy',
+              body={
+                  'expression': ee.serializer.encode(expression),
+                  'fileFormat': 'AUTO_JPEG_PNG',
+              },
+          )
+      )
+
   def test_get_feature_view_tiles_key(self):
     cloud_api_resource = mock.MagicMock()
     _state.get_state().tile_base_url = 'base_url'
@@ -922,8 +1118,31 @@ class DataTest(unittest.TestCase):
       cloud_api_resource.projects().updateConfig().execute.return_value = (
           mock_result
       )
+      project_config = {'maxConcurrentExports': 2}
       actual_result = ee.data.updateProjectConfig(
-          {'maxConcurrentExports': 2}, ['max_concurrent_exports']
+          project_config, ['max_concurrent_exports']
+      )
+      cloud_api_resource.projects().updateConfig.assert_called_with(
+          name='projects/earthengine-legacy/config',
+          body=project_config,
+          updateMask='max_concurrent_exports',
+      )
+      cloud_api_resource.projects().updateConfig().execute.assert_called_once()
+      self.assertEqual(mock_result, actual_result)
+
+  def test_update_project_config_no_mask(self) -> None:
+    cloud_api_resource = mock.MagicMock()
+    with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
+      mock_result = {'fake-project-config-value': 1}
+      cloud_api_resource.projects().updateConfig().execute.return_value = (
+          mock_result
+      )
+      project_config = {'maxConcurrentExports': 2}
+      actual_result = ee.data.updateProjectConfig(project_config)
+      cloud_api_resource.projects().updateConfig.assert_called_with(
+          name='projects/earthengine-legacy/config',
+          body=project_config,
+          updateMask='max_concurrent_exports',
       )
       cloud_api_resource.projects().updateConfig().execute.assert_called_once()
       self.assertEqual(mock_result, actual_result)
@@ -1040,6 +1259,81 @@ class DataTest(unittest.TestCase):
       }
       self.assertEqual(expected, quota)
 
+  def test_get_asset_root_quota_not_root(self):
+    cloud_api_resource = mock.MagicMock()
+    with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
+      asset_id = 'users/test/asset'
+      fake_asset = {
+          'type': 'IMAGE',
+          'name': 'projects/earthengine-legacy/assets/users/test/asset',
+      }
+      cloud_api_resource.projects().assets().get().execute.return_value = (
+          fake_asset
+      )
+      with self.assertRaisesRegex(
+          ee.ee_exception.EEException, f'{asset_id} is not a root folder.'
+      ):
+        ee.data.getAssetRootQuota(asset_id)
+
+  def test_get_iam_policy(self):
+    cloud_api_resource = mock.MagicMock()
+    with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
+      asset_id = 'users/test/asset'
+      ee.data.getIamPolicy(asset_id)
+      cloud_api_resource.projects().assets().getIamPolicy.assert_called_once_with(
+          resource='projects/earthengine-legacy/assets/users/test/asset',
+          body={},
+          prettyPrint=False,
+      )
+
+  def test_get_asset_acl(self):
+    asset_id = 'users/test/asset'
+    policy = {'bindings': [{'role': 'roles/viewer', 'members': ['allUsers']}]}
+    acl = {'readers': ['allUsers']}
+    with mock.patch.object(
+        ee.data, 'getIamPolicy', return_value=policy
+    ) as mock_get_iam_policy, mock.patch.object(
+        ee.data._cloud_api_utils, 'convert_iam_policy_to_acl', return_value=acl
+    ) as mock_convert:
+      result = ee.data.getAssetAcl(asset_id)
+      mock_get_iam_policy.assert_called_once_with(asset_id)
+      mock_convert.assert_called_once_with(policy)
+      self.assertEqual(acl, result)
+
+  def test_set_asset_acl(self):
+    asset_id = 'users/test/asset'
+    acl_update_dict = {'readers': ['allUsers']}
+    acl_update_str = '{"readers": ["allUsers"]}'
+    policy = {'bindings': [{'role': 'roles/viewer', 'members': ['allUsers']}]}
+    with mock.patch.object(
+        ee.data._cloud_api_utils,
+        'convert_acl_to_iam_policy',
+        return_value=policy,
+    ) as mock_convert, mock.patch.object(
+        ee.data, 'setIamPolicy'
+    ) as mock_set_iam_policy:
+      ee.data.setAssetAcl(asset_id, acl_update_dict)
+      mock_convert.assert_called_once_with(acl_update_dict)
+      mock_set_iam_policy.assert_called_once_with(asset_id, policy)
+
+      mock_convert.reset_mock()
+      mock_set_iam_policy.reset_mock()
+      ee.data.setAssetAcl(asset_id, acl_update_str)
+      mock_convert.assert_called_once_with(acl_update_dict)
+      mock_set_iam_policy.assert_called_once_with(asset_id, policy)
+
+  def test_set_iam_policy(self):
+    cloud_api_resource = mock.MagicMock()
+    with apitestcase.UsingCloudApi(cloud_api_resource=cloud_api_resource):
+      asset_id = 'users/test/asset'
+      policy = {'bindings': [{'role': 'roles/viewer', 'members': ['allUsers']}]}
+      ee.data.setIamPolicy(asset_id, policy)
+      cloud_api_resource.projects().assets().setIamPolicy.assert_called_once_with(
+          resource='projects/earthengine-legacy/assets/users/test/asset',
+          body={'policy': policy},
+          prettyPrint=False,
+      )
+
 
 def DoCloudProfileStubHttp(test, expect_profiling):