earthengine-api 1.5.20rc0__py3-none-any.whl → 1.5.21rc0__py3-none-any.whl

{earthengine_api-1.5.20rc0.dist-info → earthengine_api-1.5.21rc0.dist-info}/METADATA

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

{earthengine_api-1.5.20rc0.dist-info → earthengine_api-1.5.21rc0.dist-info}/RECORD

@@ -1,5 +1,5 @@
-earthengine_api-1.5.20rc0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-ee/__init__.py,sha256=qPcRFNQNq5dD59LAjW-KiTHgnBU0-9aTJIF6fXCPHTc,16867
+earthengine_api-1.5.21rc0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+ee/__init__.py,sha256=VuJ2nCg0wUazK8D1HKTDyu3rTGy1nGOxccoBVnz8VAY,16867
 ee/_arg_types.py,sha256=iKWKK4KjkgIv6s4hZDCakHLdBxVp3jcoBsbaJYjtIe4,2674
 ee/_cloud_api_utils.py,sha256=ABvZ6h80GHndnoDVM6Q0i8xsFe4z5gD6K1sGpU4T8TA,32485
 ee/_helpers.py,sha256=roBMok5ZvoWmQx2Pd4F26uTFN1q-SNeoFiHo-aGuE0A,4684
@@ -17,7 +17,7 @@ ee/customfunction.py,sha256=fc-c0FuhX2En6iCMparExnn2gl592MV5_09D8lXDIME,7403
 ee/data.py,sha256=Jntk9lXyHUrhzxhfPmdh3ygaAE3Pgef4LpILoBqL96c,88678
 ee/daterange.py,sha256=5HArg4214QKmEj6ZQR3ZTLwMtVW5DUCVGjdz1wbdeyc,5009
 ee/deprecation.py,sha256=DCSrDE5kVxOJLiuZXKw1rSreRVFlVOt8HXRKN1VUQ4o,6068
-ee/deserializer.py,sha256=D6y0Td_LVsG82YnGKYvKHkF1PRM9Nu7_887VhLDhO9I,8168
+ee/deserializer.py,sha256=sIQB-4jcZFmG40jMfxTFc1Eq9RaMxsH4WbYqhvaKSO0,8432
 ee/dictionary.py,sha256=x_NR18NoCuGVEq0hM6jnjiJte2BzFIkD6iR3tRES--0,10554
 ee/ee_array.py,sha256=eWGkxxn8rELf_xI9JKXFkx3Xp1YXDyD86sbRaFn1bNg,36375
 ee/ee_date.py,sha256=C6tv5VyLB5O-0zon9GbwcyfQ2ika3puZRYe52ffCd2E,10839
@@ -27,7 +27,7 @@ ee/ee_number.py,sha256=zb5LyiA4j24ml-B8ib4DTFne0Dzry2K4bSYhEdturtI,22615
 ee/ee_string.py,sha256=gNMEJIWxRGiAa-FQrHYeAtEqdU9vJgXv4zyas3DHRZQ,7761
 ee/ee_types.py,sha256=MWfXc0h3KgT8bLraI6qw-b0D3ogVkY5aDZKM3eoTsJA,3089
 ee/element.py,sha256=awb1ufzfC9YwzonH0V3KKkTRbM-sFc2yPoSDjFsHjLE,6305
-ee/encodable.py,sha256=vifFNsZt6WxZA3qpJR9Lg94YdLQEOj2Bh0CffrINcL8,1734
+ee/encodable.py,sha256=ZzZBOVOEwc8a8Dby3oHwIhW-5za-4tvLDE0Q2oVaNwQ,1884
 ee/errormargin.py,sha256=worYjc36VNP_M76NxlCFpXtq1HBfHThug1sOKUkaV8Q,3061
 ee/feature.py,sha256=TwXn_uwvjBOremgoow-dbykFL59h6ortI1I7UDLdM-8,30543
 ee/featurecollection.py,sha256=BZbhXhpSJD87RrilBVVJZb3pH-_w7ZuNd4tdSSPr620,14510
@@ -70,7 +70,7 @@ ee/tests/confusionmatrix_test.py,sha256=L7-yXE1XkWmw-n890Vra9WrjgoxP3R1qwtq2mDtc
 ee/tests/data_test.py,sha256=HNHI2RDL9oFzA_-dG48zYtpc10I9HeCdFa5vtyndInY,35299
 ee/tests/daterange_test.py,sha256=CFVCIrfGz7ZqZCjAbyrP-j3tsd4auDdS-Pu8xvqEc5A,8589
 ee/tests/deprecation_test.py,sha256=P3_Rn8-7QqfQ9ztvxrTlqF9-oL3Y-brCmxgMVbc75Qc,8358
-ee/tests/deserializer_test.py,sha256=0zWOJS5AQwpdm4RGFu0navyOKMOAutEh94ELY1kyCjg,3041
+ee/tests/deserializer_test.py,sha256=-tbrL0cjrXdSLF7M3wl-QQuj6TjXJdkjp7RZvVErUy4,3427
 ee/tests/dictionary_test.py,sha256=k8iVRCtWZ6_uvGZy7L40z3ZG0AJnhlwqowf1TCKQKoQ,11815
 ee/tests/ee_array_test.py,sha256=9AFv0_d12fWmG84bMNVyLBPne3cc0KVO4KvnzEdTkpI,50274
 ee/tests/ee_date_test.py,sha256=csMDTfBf-F_vkpnP6C8wvvfKBgoHFyUqn1rFZ2kAORQ,11112
@@ -100,8 +100,8 @@ ee/tests/reducer_test.py,sha256=wzwESob1ZPtC2IfkmDYFkL631Ph9VtmCl2UhQQOzZBc,3152
 ee/tests/serializer_test.py,sha256=5aApenGb9_tOTM4J8zFcT0JFzAOO_Av6dYGFz93COP8,8814
 ee/tests/table_converter_test.py,sha256=HSZpEvDG-H1RATnQXcZNR8O3kEJdJ3rHc-46KTiOWpY,3385
 ee/tests/terrain_test.py,sha256=kV901v89SBKzgSNqG6k3wxh3IdDfQeNdxmD5f9ouV18,4334
-earthengine_api-1.5.20rc0.dist-info/METADATA,sha256=BjYtzu53xUsN-3FtyZX6aiW29kCtw9-oHpHpIJ3db_c,2146
-earthengine_api-1.5.20rc0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-earthengine_api-1.5.20rc0.dist-info/entry_points.txt,sha256=-Ax4SCU-S474r8OD2LIxata6PRmkZoDrppQ4fP_exNc,50
-earthengine_api-1.5.20rc0.dist-info/top_level.txt,sha256=go5zOwCgm5lIS3yTR-Vsxp1gNI4qdS-MP5eY-7zMxVY,3
-earthengine_api-1.5.20rc0.dist-info/RECORD,,
+earthengine_api-1.5.21rc0.dist-info/METADATA,sha256=gVy3TYUbVtEpP2t4ebS2XWPf1FzyZO1jeRs0sLHLejo,2146
+earthengine_api-1.5.21rc0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+earthengine_api-1.5.21rc0.dist-info/entry_points.txt,sha256=-Ax4SCU-S474r8OD2LIxata6PRmkZoDrppQ4fP_exNc,50
+earthengine_api-1.5.21rc0.dist-info/top_level.txt,sha256=go5zOwCgm5lIS3yTR-Vsxp1gNI4qdS-MP5eY-7zMxVY,3
+earthengine_api-1.5.21rc0.dist-info/RECORD,,

ee/__init__.py

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

ee/deserializer.py

@@ -1,6 +1,7 @@
 """A deserializer that decodes EE object trees from JSON DAGs."""
 
 import json
+from typing import Any, Union
 
 from ee import apifunction
 from ee import computedobject
@@ -12,7 +13,7 @@ from ee import function
 from ee import geometry
 
 
-def fromJSON(json_obj):  # pylint: disable=g-bad-name
+def fromJSON(json_obj: Union[bytes, str]) -> Any:  # pylint: disable=g-bad-name
   """Deserialize an object from a JSON string appropriate for API calls.
 
   Args:
@@ -24,7 +25,7 @@ def fromJSON(json_obj):  # pylint: disable=g-bad-name
   return decode(json.loads(json_obj))
 
 
-def decode(json_obj):
+def decode(json_obj: Any) -> Any:
   """Decodes an object previously encoded using the EE API v2 (DAG) format.
 
   Args:
@@ -50,7 +51,8 @@ def decode(json_obj):
   return _decodeValue(json_obj, named_values)
 
 
-def _decodeValue(json_obj, named_values):  # pylint: disable=g-bad-name
+# pylint: disable-next=g-bad-name
+def _decodeValue(json_obj: Any, named_values: dict[str, Any]) -> Any:
   """Decodes an object previously encoded using the EE API v2 (DAG) format.
 
   This uses a provided scope for ValueRef lookup and does not allow the
@@ -82,7 +84,7 @@ def _decodeValue(json_obj, named_values):  # pylint: disable=g-bad-name
     if json_obj['value'] in named_values:
       return named_values[json_obj['value']]
     else:
-      raise ee_exception.EEException('Unknown ValueRef: ' + json_obj)
+      raise ee_exception.EEException(f'Unknown ValueRef: {json_obj}')
   elif type_name == 'ArgumentRef':
     var_name = json_obj['value']
     if not isinstance(var_name, str):
@@ -132,7 +134,7 @@ def _decodeValue(json_obj, named_values):  # pylint: disable=g-bad-name
     raise ee_exception.EEException('Unknown encoded object type: ' + type_name)
 
 
-def _invocation(func, args):
+def _invocation(func: Any, args: dict[str, Any]) -> Any:
   """Creates an EE object representing the application of `func` to `args`."""
   if isinstance(func, function.Function):
     return func.apply(args)
@@ -151,7 +153,7 @@ def _invocation(func, args):
   raise ee_exception.EEException('Invalid function value: %s' % func)
 
 
-def fromCloudApiJSON(json_obj):  # pylint: disable=g-bad-name
+def fromCloudApiJSON(json_obj: Union[str, bytes]) -> Any:  # pylint: disable=g-bad-name
   """Deserializes an object from the JSON string used in Cloud API calls.
 
   Args:
@@ -163,7 +165,8 @@ def fromCloudApiJSON(json_obj):  # pylint: disable=g-bad-name
   return decodeCloudApi(json.loads(json_obj))
 
 
-def decodeCloudApi(json_obj):  # pylint: disable=g-bad-name
+# pylint: disable-next=g-bad-name
+def decodeCloudApi(json_obj: dict[str, Any]) -> Any:
   """Decodes an object previously encoded using the EE Cloud API format.
 
   Args:
@@ -206,14 +209,16 @@ def decodeCloudApi(json_obj):  # pylint: disable=g-bad-name
       return lookup(node['valueReference'], 'reference')
     return None
 
-  def decode_function_definition(defined):
+  def decode_function_definition(
+      defined: dict[str, Any],
+  ) -> customfunction.CustomFunction:
     body = lookup(defined['body'], 'function body')
     signature_args = [{'name': name, 'type': 'Object', 'optional': False}
                       for name in defined['argumentNames']]
     signature = {'args': signature_args, 'name': '', 'returns': 'Object'}
     return customfunction.CustomFunction(signature, lambda *args: body)
 
-  def decode_function_invocation(invoked):
+  def decode_function_invocation(invoked: dict[str, Any]) -> Any:
     if 'functionReference' in invoked:
       func = lookup(invoked['functionReference'], 'function')
     else:

ee/encodable.py

@@ -1,10 +1,12 @@
 """Interfaces implemented by serializable objects."""
 
+from typing import Any, Callable
+
 
 class Encodable:
   """An interface implemented by objects that can serialize themselves."""
 
-  def encode(self, encoder):
+  def encode(self, encoder: Callable[[Any], Any]) -> Any:
     """Encodes the object in a format compatible with Serializer.
 
     Args:
@@ -16,7 +18,7 @@ class Encodable:
     """
     raise NotImplementedError('Encodable classes must implement encode().')
 
-  def encode_cloud_value(self, encoder):
+  def encode_cloud_value(self, encoder: Callable[[Any], Any]) -> Any:
     """Encodes the object as a ValueNode.
 
     Args:
@@ -33,7 +35,7 @@ class Encodable:
 class EncodableFunction:
   """An interface implemented by functions that can serialize themselves."""
 
-  def encode_invocation(self, encoder):
+  def encode_invocation(self, encoder: Callable[[Any], Any]) -> Any:
     """Encodes the function in a format compatible with Serializer.
 
     Args:
@@ -46,7 +48,7 @@ class EncodableFunction:
     raise NotImplementedError(
         'EncodableFunction classes must implement encode_invocation().')
 
-  def encode_cloud_invocation(self, encoder):
+  def encode_cloud_invocation(self, encoder: Callable[[Any], Any]) -> Any:
     """Encodes the function as a FunctionInvocation.
 
     Args:

ee/tests/deserializer_test.py

@@ -12,7 +12,7 @@ from ee import serializer
 
 class DeserializerTest(apitestcase.ApiTestCase):
 
-  def testLegacyRoundTrip(self):
+  def test_legacy_roundtrip(self):
     """Verifies a round trip of a comprehensive serialization case."""
     encoded = apitestcase.ENCODED_JSON_SAMPLE
     decoded = deserializer.decode(encoded)
@@ -25,7 +25,7 @@ class DeserializerTest(apitestcase.ApiTestCase):
         serializer.toJSON(cloud_decoded, for_cloud_api=True))
     self.assertEqual(cloud_encoded, cloud_re_encoded)
 
-  def testCloudRoundTrip(self):
+  def test_cloud_roundtrip(self):
     """Verifies a round trip of a comprehensive serialization case."""
     cloud_encoded = apitestcase.ENCODED_CLOUD_API_JSON_SAMPLE
     cloud_decoded = deserializer.decode(cloud_encoded)  # Supports both formats
@@ -38,7 +38,7 @@ class DeserializerTest(apitestcase.ApiTestCase):
     re_encoded = json.loads(serializer.toJSON(decoded, for_cloud_api=False))
     self.assertEqual(encoded, re_encoded)
 
-  def testCast(self):
+  def test_cast(self):
     """Verifies that decoding casts the result to the right class."""
     input_image = ee.Image(13).addBands(42)
     output = deserializer.fromJSON(serializer.toJSON(input_image))
@@ -47,7 +47,7 @@ class DeserializerTest(apitestcase.ApiTestCase):
         serializer.toJSON(input_image, for_cloud_api=True))
     self.assertIsInstance(cloud_output, ee.Image)
 
-  def testReuse(self):
+  def test_reuse(self):
     """Verifies that decoding results can be used and re-encoded."""
     input_image = ee.Image(13)
     output = deserializer.fromJSON(serializer.toJSON(input_image))
@@ -60,7 +60,7 @@ class DeserializerTest(apitestcase.ApiTestCase):
         cloud_output.addBands(42).serialize(),
         input_image.addBands(42).serialize())
 
-  def testImageExpression(self):
+  def test_image_expression(self):
     """Verifies that ee.Image.expression results can be re-encoded."""
     image = ee.Image(13)
     expression = image.expression('x', {'x': image})
@@ -69,5 +69,17 @@ class DeserializerTest(apitestcase.ApiTestCase):
     expression_re_encoded = serializer.toJSON(expression_decoded)
     self.assertEqual(expression_encoded, expression_re_encoded)
 
+  def test_unknown_value_ref(self):
+    """Verifies raising Unknown ValueRef in _decodeValue()."""
+    encoded = {
+        'type': 'CompoundValue',
+        'scope': [['key', {'type': 'ValueRef', 'value': 'bar'}]],
+    }
+    with self.assertRaisesRegex(
+        ee.EEException, "Unknown ValueRef: {'type': 'ValueRef', 'value': 'bar'}"
+    ):
+      deserializer.decode(encoded)
+
+
 if __name__ == '__main__':
   unittest.main()