earthengine-api 1.5.13rc0__py3-none-any.whl → 1.7.4__py3-none-any.whl

ee/ee_date.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 
 import datetime
 import math
-from typing import Any, Dict, Optional, Union
+from typing import Any, Union
 
 from ee import _arg_types
 from ee import _utils
@@ -31,7 +31,7 @@ class Date(computedobject.ComputedObject):
 
   @_utils.accept_opt_prefix('opt_tz')
   def __init__(
-      self, date: Union[_DateType], tz: Optional[_arg_types.String] = None
+      self, date: _DateType, tz: _arg_types.String | None = None
   ):
     """Construct a date.
 
@@ -50,7 +50,7 @@ class Date(computedobject.ComputedObject):
     self.initialize()
 
     func = apifunction.ApiFunction(self.name())
-    args: Dict[str, Any]
+    args: dict[str, Any]
     var_name = None
     if isinstance(date, datetime.datetime):
       args = {'value':
@@ -108,8 +108,8 @@ class Date(computedobject.ComputedObject):
       delta: _arg_types.Number,
       unit: _arg_types.String,
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
-  ) -> 'Date':
+      timeZone: _arg_types.String | None = None,
+  ) -> Date:
     """Create a new Date by adding the specified units to the given Date.
 
     Args:
@@ -147,9 +147,9 @@ class Date(computedobject.ComputedObject):
   def format(
       self,
       # pylint: disable-next=redefined-builtin
-      format: Optional[_arg_types.String] = None,
+      format: _arg_types.String | None = None,
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
+      timeZone: _arg_types.String | None = None,
   ) -> ee_string.String:
     """Convert a date to string.
 
@@ -175,8 +175,8 @@ class Date(computedobject.ComputedObject):
       month: _arg_types.Integer,
       day: _arg_types.Integer,
       # pylint: disable=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
-  ) -> 'Date':
+      timeZone: _arg_types.String | None = None,
+  ) -> Date:
     """Returns a Date given year, month, day.
 
     Args:
@@ -194,7 +194,7 @@ class Date(computedobject.ComputedObject):
       self,
       unit: _arg_types.String,
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
+      timeZone: _arg_types.String | None = None,
   ) -> ee_number.Number:
     """Returns the specified unit of this date.
 
@@ -215,7 +215,7 @@ class Date(computedobject.ComputedObject):
       self,
       unit: _arg_types.String,
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
+      timeZone: _arg_types.String | None = None,
   ) -> ee_number.Number:
     """Returns this date's elapsed fraction of the specified unit.
 
@@ -236,7 +236,7 @@ class Date(computedobject.ComputedObject):
       self,
       unit: _arg_types.String,
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
+      timeZone: _arg_types.String | None = None,
   ) -> daterange.DateRange:
     """Returns a DateRange covering the unit that contains this date.
 
@@ -266,7 +266,7 @@ class Date(computedobject.ComputedObject):
       unit: _arg_types.String,
       inUnit: _arg_types.String,  # pylint: disable=invalid-name
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
+      timeZone: _arg_types.String | None = None,
   ) -> ee_number.Number:
     """Returns the specified unit of this date relative to a larger unit.
 
@@ -295,8 +295,8 @@ class Date(computedobject.ComputedObject):
       format: _arg_types.String,  # pylint: disable=redefined-builtin
       date: _arg_types.String,
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
-  ) -> 'Date':
+      timeZone: _arg_types.String | None = None,
+  ) -> Date:
     """Parse a date string, given a string describing its format.
 
     Args:
@@ -336,15 +336,15 @@ class Date(computedobject.ComputedObject):
 
   def update(
       self,
-      year: Optional[_arg_types.Integer] = None,
-      month: Optional[_arg_types.Integer] = None,
-      day: Optional[_arg_types.Integer] = None,
-      hour: Optional[_arg_types.Integer] = None,
-      minute: Optional[_arg_types.Integer] = None,
-      second: Optional[_arg_types.Number] = None,
+      year: _arg_types.Integer | None = None,
+      month: _arg_types.Integer | None = None,
+      day: _arg_types.Integer | None = None,
+      hour: _arg_types.Integer | None = None,
+      minute: _arg_types.Integer | None = None,
+      second: _arg_types.Number | None = None,
       # pylint: disable-next=invalid-name
-      timeZone: Optional[_arg_types.String] = None,
-  ) -> 'Date':
+      timeZone: _arg_types.String | None = None,
+  ) -> Date:
     """Create a new Date by setting one or more of the units of the given Date.
 
     If a timeZone is given the new value(s) is interpreted in that zone. Skip or

ee/ee_list.py

@@ -1,8 +1,7 @@
 """A wrapper for lists."""
 from __future__ import annotations
 
-# List clashes with the class List, so call it ListType
-from typing import Any, List as ListType, Optional, Tuple, Union
+from typing import Any
 
 from ee import _arg_types
 from ee import _utils
@@ -18,16 +17,16 @@ from ee import geometry
 
 class List(computedobject.ComputedObject):
   """An object to represent lists."""
-  _list: Optional[
-      Union[ListType[Any], Tuple[Any, Any]]
-  ]
+  _list: None | (
+      list[Any] | tuple[Any, Any]
+  )
 
   _initialized = False
 
   # Tell pytype to not complain about dynamic attributes.
   _HAS_DYNAMIC_ATTRIBUTES = True
 
-  def __init__(self, arg: Optional[_arg_types.List]):
+  def __init__(self, arg: _arg_types.List | None):
     """Construct a list wrapper.
 
     This constructor accepts the following args:
@@ -65,9 +64,9 @@ class List(computedobject.ComputedObject):
   @staticmethod
   def sequence(
       start: _arg_types.Number,
-      end: Optional[_arg_types.Number] = None,
-      step: Optional[_arg_types.Number] = None,
-      count: Optional[_arg_types.Integer] = None,
+      end: _arg_types.Number | None = None,
+      step: _arg_types.Number | None = None,
+      count: _arg_types.Integer | None = None,
   ) -> List:
     """Returns a List of numbers from start to end (inclusive).
 
@@ -105,7 +104,7 @@ class List(computedobject.ComputedObject):
     return 'List'
 
   @_utils.accept_opt_prefix('opt_encoder')
-  def encode(self, encoder: Optional[Any] = None) -> Any:
+  def encode(self, encoder: Any | None = None) -> Any:
     if isinstance(self._list, (list, tuple)):
       assert self._list is not None
       return [encoder(elem) for elem in self._list]
@@ -113,7 +112,7 @@ class List(computedobject.ComputedObject):
       return super().encode(encoder)
 
   @_utils.accept_opt_prefix('opt_encoder')
-  def encode_cloud_value(self, encoder: Optional[Any] = None) -> Any:
+  def encode_cloud_value(self, encoder: Any | None = None) -> Any:
     if isinstance(self._list, (list, tuple)):
       return {'valueReference': encoder(self._list)}
     else:
@@ -558,7 +557,7 @@ class List(computedobject.ComputedObject):
         self.name() + '.set', self, index, element
     )
 
-  def shuffle(self, seed: Optional[_arg_types.Integer] = None) -> List:
+  def shuffle(self, seed: _arg_types.Integer | None = None) -> List:
     """Randomly permute the specified list.
 
     Note that the permutation order will always be the same for any given seed,
@@ -583,8 +582,8 @@ class List(computedobject.ComputedObject):
   def slice(
       self,
       start: _arg_types.Integer,
-      end: Optional[_arg_types.Integer] = None,
-      step: Optional[_arg_types.Integer] = None,
+      end: _arg_types.Integer | None = None,
+      step: _arg_types.Integer | None = None,
   ) -> List:
     """Returns a range of elements from a list.
 
@@ -608,7 +607,7 @@ class List(computedobject.ComputedObject):
         self.name() + '.slice', self, start, end, step
     )
 
-  def sort(self, keys: Optional[_arg_types.List] = None) -> List:
+  def sort(self, keys: _arg_types.List | None = None) -> List:
     """Sorts the list into ascending order.
 
     If the keys argument is provided, then it is sorted first, and the
@@ -628,7 +627,7 @@ class List(computedobject.ComputedObject):
       self,
       start: _arg_types.Integer,
       count: _arg_types.Integer,
-      other: Optional[_arg_types.List] = None,
+      other: _arg_types.List | None = None,
   ) -> List:
     """Removes elements from list and replaces with elements from other.
 

ee/ee_number.py

@@ -1,7 +1,7 @@
 """A wrapper for numbers."""
 from __future__ import annotations
 
-from typing import Any, Optional, Union
+from typing import Any
 
 from ee import _arg_types
 from ee import _cloud_api_utils
@@ -15,7 +15,7 @@ from ee import ee_string
 class Number(computedobject.ComputedObject):
   """An object to represent numbers."""
 
-  _number: Optional[float]
+  _number: float | None
 
   _initialized = False
 
@@ -299,7 +299,7 @@ class Number(computedobject.ComputedObject):
   def expression(
       expression: _arg_types.String,
       # pylint: disable-next=redefined-builtin
-      vars: Optional[_arg_types.Dictionary] = None,
+      vars: _arg_types.Dictionary | None = None,
   ) -> Number:
     """Returns a number from computing a numeric expression.
 
@@ -351,7 +351,7 @@ class Number(computedobject.ComputedObject):
     return apifunction.ApiFunction.call_(self.name() + '.floor', self)
 
   def format(
-      self, pattern: Optional[_arg_types.String] = None
+      self, pattern: _arg_types.String | None = None
   ) -> ee_string.String:
     r"""Convert a number to a string using printf-style formatting.
 
@@ -586,10 +586,10 @@ class Number(computedobject.ComputedObject):
 
     return apifunction.ApiFunction.call_(self.name() + '.or', self, right)
 
+  @staticmethod
   def parse(
-      # pylint: disable=redefined-builtin
-      input: _arg_types.String,
-      radix: Optional[_arg_types.Integer] = None,
+      input: _arg_types.String,  # pylint: disable=redefined-builtin
+      radix: _arg_types.Integer | None = None,
   ) -> Number:
     """Returns a number from a string.
 
@@ -772,27 +772,17 @@ class Number(computedobject.ComputedObject):
 
     return apifunction.ApiFunction.call_(self.name() + '.uint8', self)
 
-  # pylint: disable=redefined-builtin
-  # pytype: disable=invalid-annotation
-  def unitScale(
-      self,
-      min: Union[int, float, computedobject.ComputedObject],
-      max: Union[int, float, computedobject.ComputedObject],
-  ) -> Number:
-    """Scales the input so that [min, max] becomes [0, 1].
+  # pylint: disable-next=redefined-builtin
+  def unitScale(self, min: _arg_types.Number, max: _arg_types.Number) -> Number:
+    """Returns the input scaled so that [min, max] becomes [0, 1].
 
-    Values outside the range are NOT clamped.  If min == max, 0 is returned.
+    Values outside the range are NOT clamped. If min == max, 0 is returned.
 
     Args:
       min: Minimum value of the input to be scaled to 0.
       max: Maximum value of the input to be scaled to 1.
-
-    Returns:
-      An ee.Number.
     """
 
     return apifunction.ApiFunction.call_(
         self.name() + '.unitScale', self, min, max
     )
-  # pytype: enable=invalid-annotation
-  # pylint: enable=redefined-builtin

ee/ee_string.py

@@ -1,7 +1,7 @@
 """A wrapper for strings."""
 from __future__ import annotations
 
-from typing import Any, Optional, Union
+from typing import Any
 
 from ee import _arg_types
 from ee import _utils
@@ -15,7 +15,7 @@ from ee import ee_number
 class String(computedobject.ComputedObject):
   """An object to represent strings."""
 
-  _string: Optional[str]
+  _string: str | None
 
   _initialized = False
 
@@ -37,19 +37,19 @@ class String(computedobject.ComputedObject):
     if isinstance(string, str):
       super().__init__(None, None)
       self._string = string
-
     elif isinstance(string, computedobject.ComputedObject):
       if self.is_func_returning_same(string):
         # If it's a call that's already returning a String, just cast.
         super().__init__(string.func, string.args, string.varName)
       else:
+        # Wrap some other ComputedObject.
         super().__init__(
             apifunction.ApiFunction(self.name()), {'input': string}
         )
       self._string = None
     else:
       raise ee_exception.EEException(
-          'Invalid argument specified for ee.String(): %s' % string)
+          f'Invalid argument specified for ee.String(): {string}')
 
   @classmethod
   def initialize(cls) -> None:
@@ -91,8 +91,7 @@ class String(computedobject.ComputedObject):
     Returns:
       Returns the result of joining self and string2.
     """
-
-    return apifunction.ApiFunction.call_(self.name() + '.cat', self, string2)
+    return apifunction.ApiFunction.call_(f'{self.name()}.cat', self, string2)
 
   def compareTo(self, string2: _arg_types.String) -> ee_number.Number:
     """Compares two strings lexicographically.
@@ -107,15 +106,15 @@ class String(computedobject.ComputedObject):
     """
 
     return apifunction.ApiFunction.call_(
-        self.name() + '.compareTo', self, string2
+        f'{self.name()}.compareTo', self, string2
     )
 
   def decodeJSON(self) -> computedobject.ComputedObject:
     """Decodes self as a JSON string."""
-
-    return apifunction.ApiFunction.call_(self.name() + '.decodeJSON', self)
+    return apifunction.ApiFunction.call_(f'{self.name()}.decodeJSON', self)
 
   @staticmethod
+  # pylint: disable=redefined-builtin
   def encodeJSON(object: _arg_types.Any) -> String:
     """Returns an ee.String with an object encoded as JSON.
 
@@ -124,7 +123,7 @@ class String(computedobject.ComputedObject):
     Args:
       object: The object to encode.
     """
-
+    # object is probably not an ee.String, so use "String." instead of object.
     return apifunction.ApiFunction.call_('String.encodeJSON', object)
 
   def equals(self, target: _arg_types.String) -> computedobject.ComputedObject:
@@ -137,8 +136,7 @@ class String(computedobject.ComputedObject):
       True if the target is a string and is lexicographically equal to the
       reference, or false otherwise.
     """
-
-    return apifunction.ApiFunction.call_(self.name() + '.equals', self, target)
+    return apifunction.ApiFunction.call_(f'{self.name()}.equals', self, target)
 
   def index(self, pattern: _arg_types.String) -> ee_number.Number:
     """Searches a string for the first occurrence of a substring.
@@ -149,16 +147,14 @@ class String(computedobject.ComputedObject):
     Returns:
       The index of the first match, or -1.
     """
-
-    return apifunction.ApiFunction.call_(self.name() + '.index', self, pattern)
+    return apifunction.ApiFunction.call_(f'{self.name()}.index', self, pattern)
 
   def length(self) -> ee_number.Number:
     """Returns the length of a string."""
-
-    return apifunction.ApiFunction.call_(self.name() + '.length', self)
+    return apifunction.ApiFunction.call_(f'{self.name()}.length', self)
 
   def match(
-      self, regex: _arg_types.String, flags: Optional[_arg_types.String] = None
+      self, regex: _arg_types.String, flags: _arg_types.String | None = None
   ) -> ee_list.List:
     """Matches a string against a regular expression.
 
@@ -172,14 +168,14 @@ class String(computedobject.ComputedObject):
     """
 
     return apifunction.ApiFunction.call_(
-        self.name() + '.match', self, regex, flags
+        f'{self.name()}.match', self, regex, flags
     )
 
   def replace(
       self,
       regex: _arg_types.String,
       replacement: _arg_types.String,
-      flags: Optional[_arg_types.String] = None,
+      flags: _arg_types.String | None = None,
   ) -> String:
     """Returns a string with some or all matches of a pattern replaced.
 
@@ -194,7 +190,7 @@ class String(computedobject.ComputedObject):
     """
 
     return apifunction.ApiFunction.call_(
-        self.name() + '.replace', self, regex, replacement, flags
+        f'{self.name()}.replace', self, regex, replacement, flags
     )
 
   def rindex(self, pattern: _arg_types.String) -> ee_number.Number:
@@ -206,11 +202,10 @@ class String(computedobject.ComputedObject):
     Returns:
       The index of the first match or -1 if no match.
     """
-
-    return apifunction.ApiFunction.call_(self.name() + '.rindex', self, pattern)
+    return apifunction.ApiFunction.call_(f'{self.name()}.rindex', self, pattern)
 
   def slice(
-      self, start: _arg_types.Integer, end: Optional[_arg_types.Integer] = None
+      self, start: _arg_types.Integer, end: _arg_types.Integer | None = None
   ) -> String:
     """Returns a substring of the given string.
 
@@ -228,11 +223,11 @@ class String(computedobject.ComputedObject):
     """
 
     return apifunction.ApiFunction.call_(
-        self.name() + '.slice', self, start, end
+        f'{self.name()}.slice', self, start, end
     )
 
   def split(
-      self, regex: _arg_types.String, flags: Optional[_arg_types.String] = None
+      self, regex: _arg_types.String, flags: _arg_types.String | None = None
   ) -> ee_list.List:
     """Splits a string on a regular expression into a list of strings.
 
@@ -246,20 +241,17 @@ class String(computedobject.ComputedObject):
     """
 
     return apifunction.ApiFunction.call_(
-        self.name() + '.split', self, regex, flags
+        f'{self.name()}.split', self, regex, flags
     )
 
   def toLowerCase(self) -> String:
     """Converts all of the characters in a string to lower case."""
-
-    return apifunction.ApiFunction.call_(self.name() + '.toLowerCase', self)
+    return apifunction.ApiFunction.call_(f'{self.name()}.toLowerCase', self)
 
   def toUpperCase(self) -> String:
     """Converts all of the characters in a string to upper case."""
-
-    return apifunction.ApiFunction.call_(self.name() + '.toUpperCase', self)
+    return apifunction.ApiFunction.call_(f'{self.name()}.toUpperCase', self)
 
   def trim(self) -> String:
     """Returns a string with any leading and trailing whitespace removed."""
-
-    return apifunction.ApiFunction.call_(self.name() + '.trim', self)
+    return apifunction.ApiFunction.call_(f'{self.name()}.trim', self)

ee/ee_types.py

@@ -4,12 +4,12 @@
 # pylint: disable=g-bad-name
 
 import datetime
-from typing import Any, Type
+from typing import Any
 
 from ee import computedobject
 
 
-# A dictionary of the classes in the ee module.  Set by registerClasses.
+# A dictionary of the classes in the ee module. Set by registerClasses.
 _registered_classes = {}
 
 
@@ -23,7 +23,7 @@ def _registerClasses(classes) -> None:
   _registered_classes = classes
 
 
-def classToName(a_class: Type[Any]) -> str:
+def classToName(a_class: type[Any]) -> str:
   """Converts a class to the API-friendly type name.
 
   Args:
@@ -48,7 +48,7 @@ def classToName(a_class: Type[Any]) -> str:
 
 # TODO(user): Any -> Optional[type[Any]].
 def nameToClass(name: str) -> Any:
-  """Converts a class name to a class.  Returns None if not an ee class.
+  """Converts a class name to a class. Returns None if not an ee class.
 
   Args:
     name: The class name.

ee/element.py

@@ -6,7 +6,7 @@ This class is never intended to be instantiated by the user.
 from __future__ import annotations
 
 import datetime
-from typing import Any, Dict, Optional, Union
+from typing import Any
 
 from ee import _arg_types
 from ee import _utils
@@ -29,9 +29,9 @@ class Element(computedobject.ComputedObject):
   @_utils.accept_opt_prefix('opt_varName')
   def __init__(
       self,
-      func: Optional[apifunction.ApiFunction],
-      args: Optional[Dict[str, Any]],
-      varName: Optional[str] = None,  # pylint: disable=g-bad-name
+      func: apifunction.ApiFunction | None,
+      args: dict[str, Any] | None,
+      varName: str | None = None,  # pylint: disable=g-bad-name
   ):
     """Constructs a collection by initializing its ComputedObject."""
     super().__init__(func, args, varName)
@@ -58,8 +58,8 @@ class Element(computedobject.ComputedObject):
   def copyProperties(
       self,
       source: _arg_types.Element,
-      properties: Optional[_arg_types.List] = None,
-      exclude: Optional[_arg_types.List] = None,
+      properties: _arg_types.List | None = None,
+      exclude: _arg_types.List | None = None,
   ) -> Element:
     """Copies metadata properties from one element to another.
 
@@ -121,13 +121,13 @@ class Element(computedobject.ComputedObject):
 
   def set(
       self,
-      *args: Union[
-          Dict[str, Any],
-          float,
-          str,
-          datetime.datetime,
-          computedobject.ComputedObject,
-      ],
+      *args: (
+          dict[str, Any] |
+          float |
+          str |
+          datetime.datetime |
+          computedobject.ComputedObject
+      ),
   ) -> Element:
     """Overrides one or more metadata properties of an Element.
 
@@ -182,12 +182,12 @@ class Element(computedobject.ComputedObject):
     return self._cast(result)
 
   def toDictionary(
-      self, properties: Optional[_arg_types.List] = None
+      self, properties: _arg_types.List | None = None
   ) -> dictionary.Dictionary:
     """Returns properties from a feature as a dictionary.
 
     Args:
-      properties: The list of properties to extract.  Defaults to all non-system
+      properties: The list of properties to extract. Defaults to all non-system
         properties
     """
 

ee/encodable.py

@@ -1,10 +1,13 @@
 """Interfaces implemented by serializable objects."""
 
+from collections.abc import Callable
+from typing import Any
+
 
 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 +19,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 +36,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 +49,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/errormargin.py

@@ -1,7 +1,7 @@
 """A wrapper for ErrorMargins."""
 from __future__ import annotations
 
-from typing import Any, Dict, Optional
+from typing import Any
 
 from ee import _arg_types
 from ee import apifunction
@@ -36,8 +36,8 @@ class ErrorMargin(computedobject.ComputedObject):
 
   def __init__(
       self,
-      value: Optional[_arg_types.Number] = None,
-      unit: Optional[_arg_types.String] = None,
+      value: _arg_types.Number | None = None,
+      unit: _arg_types.String | None = None,
   ):
     """Creates a ErrorMargin wrapper.
 
@@ -64,7 +64,7 @@ class ErrorMargin(computedobject.ComputedObject):
     ):
       raise TypeError('value must be provided if unit is not infinite')
 
-    args: Dict[str, Any] = {}
+    args: dict[str, Any] = {}
     if value is not None:
       args['value'] = value
     if unit is not None: