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

ee/feature.py

@@ -1,7 +1,7 @@
 """An object representing EE Features."""
 from __future__ import annotations
 
-from typing import Any, Dict, Optional, Union
+from typing import Any
 
 from ee import _arg_types
 from ee import _utils
@@ -10,7 +10,6 @@ from ee import computedobject
 from ee import dictionary
 from ee import ee_array
 from ee import ee_exception
-from ee import ee_list
 from ee import ee_number
 from ee import ee_string
 from ee import element
@@ -28,17 +27,15 @@ class Feature(element.Element):
   @_utils.accept_opt_prefix('opt_properties')
   def __init__(
       self,
-      geom: Optional[
-          Union[
-              Feature,
-              geometry.Geometry,
-              Dict[str, Any],
-              computedobject.ComputedObject,
-          ]
-      ],
-      properties: Optional[
-          Union[Dict[str, Any], computedobject.ComputedObject]
-      ] = None,
+      geom: None | (
+              Feature |
+              geometry.Geometry |
+              dict[str, Any] |
+              computedobject.ComputedObject
+      ),
+      properties: None | (
+          dict[str, Any] | computedobject.ComputedObject
+      ) = None,
   ):
     """Creates a feature a geometry or computed object.
 
@@ -113,8 +110,8 @@ class Feature(element.Element):
     cls._initialized = False
 
   def getMapId(
-      self, vis_params: Optional[Dict[str, Any]] = None
-  ) -> Dict[str, Any]:
+      self, vis_params: dict[str, Any] | None = None
+  ) -> dict[str, Any]:
     """Fetch and return a map id and token, suitable for use in a Map overlay.
 
     Args:
@@ -137,8 +134,8 @@ class Feature(element.Element):
   def area(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> ee_number.Number:
     """Returns the area of the feature's default geometry.
 
@@ -160,8 +157,8 @@ class Feature(element.Element):
   def bounds(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns a feature containing the bounding box of the geometry.
 
@@ -180,8 +177,8 @@ class Feature(element.Element):
       self,
       distance: _arg_types.Number,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns the input buffered by a given distance.
 
@@ -208,8 +205,8 @@ class Feature(element.Element):
   def centroid(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns a point at the center.
 
@@ -234,8 +231,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Element,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> computedobject.ComputedObject:
     """Returns the point on the right input that is nearest to the left input.
 
@@ -261,8 +258,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Element,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> computedobject.ComputedObject:
     """Returns the points on the right input that are nearest to the left input.
 
@@ -292,8 +289,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> computedobject.ComputedObject:
     """Returns true if the geometry is contained in the geometry of another.
 
@@ -318,8 +315,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> computedobject.ComputedObject:
     """Returns true if the geometry contains the geometry of another.
 
@@ -343,8 +340,8 @@ class Feature(element.Element):
   def convexHull(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns the convex hull of the original geometry.
 
@@ -369,8 +366,8 @@ class Feature(element.Element):
       self,
       distances: _arg_types.List,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns a feature containing the cut lines.
 
@@ -398,8 +395,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns the geometry of the feature minus the 'right' geometry.
 
@@ -425,8 +422,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> computedobject.ComputedObject:
     """Returns true if and only if the feature geometries are disjoint.
 
@@ -450,8 +447,8 @@ class Feature(element.Element):
   def dissolve(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns a feature containing the union of the geometry of a feature.
 
@@ -472,9 +469,9 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
-      spherical: Optional[_arg_types.Bool] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
+      spherical: _arg_types.Bool | None = None,
   ) -> ee_number.Number:
     """Returns the minimum distance between the geometries of two features.
 
@@ -498,10 +495,10 @@ class Feature(element.Element):
   def geometry(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
-      geodesics: Optional[_arg_types.Bool] = None,
-  ) -> 'geometry.Geometry':
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
+      geodesics: _arg_types.Bool | None = None,
+  ) -> geometry.Geometry:
     """Returns the geometry of a given feature in a given projection.
 
     Args:
@@ -521,10 +518,10 @@ class Feature(element.Element):
 
   def hersDescriptor(
       self,
-      selectors: Optional[_arg_types.List] = None,
-      buckets: Optional[_arg_types.Integer] = None,
+      selectors: _arg_types.List | None = None,
+      buckets: _arg_types.Integer | None = None,
       # pylint: disable-next=invalid-name
-      peakWidthScale: Optional[_arg_types.Number] = None,
+      peakWidthScale: _arg_types.Number | None = None,
   ) -> dictionary.Dictionary:
     """Returns a dictionary of Histogram Error Ring Statistic (HERS) arrays.
 
@@ -560,8 +557,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns the intersection of the geometries with right.
 
@@ -589,8 +586,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> computedobject.ComputedObject:
     """Returns true if and only if the feature geometries intersect.
 
@@ -614,8 +611,8 @@ class Feature(element.Element):
   def length(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> ee_number.Number:
     """Returns the length of the linear parts of the geometry of a feature.
 
@@ -636,8 +633,8 @@ class Feature(element.Element):
   def perimeter(
       self,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> ee_number.Number:
     """Returns the length of the perimeter of the polygonal parts of the geometry of a given feature.
 
@@ -659,8 +656,8 @@ class Feature(element.Element):
       self,
       # pylint: disable=invalid-name
       propertySelectors: _arg_types.List,
-      newProperties: Optional[_arg_types.List] = None,
-      retainGeometry: Optional[_arg_types.Bool] = None,
+      newProperties: _arg_types.List | None = None,
+      retainGeometry: _arg_types.Bool | None = None,
       # pylint: enable=invalid-name
   ) -> Feature:
     """Returns a feature with the selected properties.
@@ -685,7 +682,7 @@ class Feature(element.Element):
     )
 
   def setGeometry(
-      self, geometry: Optional[_arg_types.Geometry] = None
+      self, geometry: _arg_types.Geometry | None = None
   ) -> Feature:
     """Returns the feature with the geometry replaced by the specified geometry.
 
@@ -701,7 +698,7 @@ class Feature(element.Element):
       self,
       # pylint: disable-next=invalid-name
       maxError: _arg_types.ErrorMargin,
-      proj: Optional[_arg_types.Projection] = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns a feature with geometry simplified to within an error margin.
 
@@ -732,8 +729,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns a feature containing the symmetric difference with right.
 
@@ -766,9 +763,9 @@ class Feature(element.Element):
 
   def transform(
       self,
-      proj: Optional[_arg_types.Projection] = None,
+      proj: _arg_types.Projection | None = None,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
   ) -> Feature:
     """Transforms the geometry of a feature to a specific projection.
 
@@ -791,8 +788,8 @@ class Feature(element.Element):
       self,
       right: _arg_types.Any,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> Feature:
     """Returns a feature containing the union of the geometries of two features.
 
@@ -815,8 +812,8 @@ class Feature(element.Element):
       right: _arg_types.Any,
       distance: _arg_types.Number,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
-      proj: Optional[_arg_types.Projection] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
+      proj: _arg_types.Projection | None = None,
   ) -> computedobject.ComputedObject:
     """Returns true if the geometries of right are within a specified distance.
 

ee/featurecollection.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-from typing import Any, Dict, List, Optional, Type, Union
+from typing import Any
 
 from ee import _arg_types
 from ee import _utils
@@ -22,7 +22,7 @@ from ee import geometry
 from ee import image
 
 
-class FeatureCollection(collection.Collection):
+class FeatureCollection(collection.Collection[feature.Feature]):
   """A representation of a FeatureCollection."""
 
   _initialized = False
@@ -34,25 +34,26 @@ class FeatureCollection(collection.Collection):
   @deprecation.WarnForDeprecatedAsset('args')
   def __init__(
       self,
-      args: Optional[
-          Union[
-              Dict[str, Any],
-              List[Any],
-              str,
-              feature.Feature,
-              geometry.Geometry,
-              computedobject.ComputedObject,
-          ]
-      ],
-      column: Optional[Any] = None,
+      args: None | (
+              dict[str, Any] |
+              list[Any] |
+              str |
+              feature.Feature |
+              geometry.Geometry |
+              computedobject.ComputedObject
+      ),
+      column: Any | None = None,
   ):
     """Constructs a collection features.
 
     Args:
-      args: constructor argument.  One of: 1) A string - assumed to be the name
-        of a collection. 2) A geometry. 3) A feature. 4) An array of features.
-        5) A GeoJSON FeatureCollection. 6) A computed object - reinterpreted as
-        a collection.
+      args: constructor argument. One of:
+        1) A string - assumed to be the name of a collection.
+        2) A geometry.
+        3) A feature.
+        4) An array of features.
+        5) A GeoJSON FeatureCollection.
+        6) A computed object - reinterpreted as a collection.
       column: The name of the geometry column to use. Only useful with the
         string constructor.
 
@@ -116,8 +117,8 @@ class FeatureCollection(collection.Collection):
     cls._initialized = False
 
   def getMapId(
-      self, vis_params: Optional[Dict[str, Any]] = None
-  ) -> Dict[str, Any]:
+      self, vis_params: dict[str, Any] | None = None
+  ) -> dict[str, Any]:
     """Fetch and return a map id and token, suitable for use in a Map overlay.
 
     Args:
@@ -137,9 +138,9 @@ class FeatureCollection(collection.Collection):
 
   def getDownloadURL(
       self,
-      filetype: Optional[str] = None,
-      selectors: Optional[Any] = None,
-      filename: Optional[str] = None,
+      filetype: str | None = None,
+      selectors: Any | None = None,
+      filename: str | None = None,
   ) -> str:
     """Gets a download URL.
 
@@ -179,8 +180,8 @@ class FeatureCollection(collection.Collection):
   def select(
       self,
       propertySelectors: Any,
-      newProperties: Optional[Any] = None,
-      retainGeometry: Union[bool, str] = True,
+      newProperties: Any | None = None,
+      retainGeometry: bool | str = True,
       *args,
   ) -> FeatureCollection:
     """Select properties from each feature in a collection.
@@ -189,9 +190,9 @@ class FeatureCollection(collection.Collection):
       propertySelectors: An array of names or regexes specifying the properties
           to select.
       newProperties: An array of strings specifying the new names for the
-          selected properties.  If supplied, the length must match the number
+          selected properties. If supplied, the length must match the number
           of properties selected.
-      retainGeometry: A boolean.  When false, the result will have no geometry.
+      retainGeometry: A boolean. When false, the result will have no geometry.
       *args: Selector elements as varargs.
 
     Returns:
@@ -218,14 +219,14 @@ class FeatureCollection(collection.Collection):
     return 'FeatureCollection'
 
   @staticmethod
-  def elementType() -> Type[feature.Feature]:
+  def elementType() -> type[feature.Feature]:
     return feature.Feature
 
   def classify(
       self,
       classifier: _arg_types.Classifier,
       # pylint: disable-next=invalid-name
-      outputName: Optional[_arg_types.String] = None,
+      outputName: _arg_types.String | None = None,
   ) -> FeatureCollection:
     """Returns the result of classifying each feature in a collection.
 
@@ -246,7 +247,7 @@ class FeatureCollection(collection.Collection):
       self,
       clusterer: _arg_types.Clusterer,
       # pylint: disable-next=invalid-name
-      outputName: Optional[_arg_types.String] = None,
+      outputName: _arg_types.String | None = None,
   ) -> FeatureCollection:
     """Returns the results of clustering each feature in a collection.
 
@@ -268,8 +269,8 @@ class FeatureCollection(collection.Collection):
       propertyName: _arg_types.String,  # pylint: disable=invalid-name
       mean: _arg_types.Number,
       stdDev: _arg_types.Number,  # pylint: disable=invalid-name
-      gamma: Optional[_arg_types.Number] = None,
-      reducer: Optional[_arg_types.Reducer] = None,
+      gamma: _arg_types.Number | None = None,
+      reducer: _arg_types.Reducer | None = None,
   ) -> image.Image:
     """Returns an inverse-distance weighted estimate of the value at each pixel.
 
@@ -302,8 +303,8 @@ class FeatureCollection(collection.Collection):
       sill: _arg_types.Number,
       nugget: _arg_types.Number,
       # pylint: disable-next=invalid-name
-      maxDistance: Optional[_arg_types.Number] = None,
-      reducer: Optional[_arg_types.Reducer] = None,
+      maxDistance: _arg_types.Number | None = None,
+      reducer: _arg_types.Reducer | None = None,
   ) -> image.Image:
     """Returns the results of sampling a Kriging estimator at each pixel.
 
@@ -334,7 +335,7 @@ class FeatureCollection(collection.Collection):
   @staticmethod
   def loadBigQueryTable(
       table: _arg_types.String,
-      geometryColumn: Optional[_arg_types.String] = None,
+      geometryColumn: _arg_types.String | None = None,
   ) -> FeatureCollection:
     """Returns a FeatureCollection containing data read from a BigQuery table.
 
@@ -353,7 +354,7 @@ class FeatureCollection(collection.Collection):
   def makeArray(
       self,
       properties: _arg_types.List,
-      name: Optional[_arg_types.String] = None,
+      name: _arg_types.String | None = None,
   ) -> FeatureCollection:
     """Returns a collection with a 1-D Array property for each feature.
 
@@ -376,10 +377,10 @@ class FeatureCollection(collection.Collection):
   @staticmethod
   def randomPoints(
       region: geometry.Geometry,
-      points: Optional[_arg_types.Integer] = None,
-      seed: Optional[_arg_types.Integer] = None,
+      points: _arg_types.Integer | None = None,
+      seed: _arg_types.Integer | None = None,
       # pylint: disable-next=invalid-name
-      maxError: Optional[_arg_types.ErrorMargin] = None,
+      maxError: _arg_types.ErrorMargin | None = None,
   ) -> FeatureCollection:
     """Returns a collection of random points.
 
@@ -407,8 +408,8 @@ class FeatureCollection(collection.Collection):
   @staticmethod
   def runBigQuery(
       query: _arg_types.String,
-      geometryColumn: Optional[_arg_types.String] = None,
-      maxBytesBilled: Optional[_arg_types.Integer] = int(1e11),
+      geometryColumn: _arg_types.String | None = None,
+      maxBytesBilled: _arg_types.Integer | None = int(1e11),
   ) -> FeatureCollection:
     """Returns a FeatureCollection containing result of a BigQuery query.