fix: add documentation and simplify the tests (#456)

Author: 12rambau

geetools/ee_feature_collection.py

@@ -223,7 +223,30 @@ def mergeGeometries(self, maxError: float | int | ee.Number | None = None) -> ee
         return ee.Geometry(union).dissolve(maxError=maxError)
 
     def columnNames(self) -> ee.List:
-        """Get the name of the columns (Feature's properties)."""
+        """Get the name of the columns (Feature's properties).
+
+        get a flatten list of all the columns names in the FeatureCollection including the ones that
+        are not in all features.
+
+        Returns:
+            A list of all the column names in the FeatureCollection.
+
+        Example:
+            .. jupyter-execute::
+
+                import ee, geetools
+                from geetools.utils import initialize_documentation
+
+                initialize_documentation()
+
+                fc = ee.FeatureCollection([
+                    ee.Feature(ee.Geometry.Point([0, 0]), {"name": "A", "value": 1}),
+                    ee.Feature(ee.Geometry.Point([1, 1]), {"name": "B", "value": 2, "extra": "extra_value"})
+                ])
+
+                column_names = fc.geetools.columnNames()
+                column_names.getInfo()
+        """
         temp_property_name = "__geetools_properties__"
         fc = self._obj.map(lambda feat: feat.set(temp_property_name, feat.propertyNames()))
         return fc.aggregate_array(temp_property_name).flatten().distinct()

tests/test_FeatureCollection.py

@@ -68,22 +68,15 @@ def test_column_names(self, fc_instance, ee_list_regression):
 
     @pytest.fixture
     def fc_instance(self):
-        geometry = ee.Geometry.Polygon(
-            [
-                [
-                    [-111.108203125, 38.72726135581648],
-                    [-111.108203125, 34.42385763998893],
-                    [-106.362109375, 34.42385763998893],
-                    [-106.362109375, 38.72726135581648],
-                ]
-            ]
-        )
-        image = ee.Image.random().clip(geometry)
+        image = ee.Image.random().clip(ee.Geometry.Rectangle([-1, -1, 1, 1]))
+        # Create a Feature
         fc = ee.FeatureCollection(
             [
-                ee.Feature(ee.Geometry.Point([-101.1765625, 35.71859799956555]), {"system:index": "0"}),
-                ee.Feature(ee.Geometry.Point([-106.186328125, 41.41694364515647]), {"system:index": "1"}),
-                ee.Feature(ee.Geometry.Point([-108.471484375, 37.132906371577455]), {"system:index": "2"}),
+                # outside the image
+                ee.Feature(ee.Geometry.Point([2, 2]), {"system:index": "0"}),
+                # inside the image
+                ee.Feature(ee.Geometry.Point([0, 0.5]), {"system:index": "1"}),
+                ee.Feature(ee.Geometry.Point([0.5, 0]), {"system:index": "2"}),
             ]
         )
         return image.reduceRegions(collection=fc, reducer=ee.Reducer.first(), scale=1000)

tests/test_FeatureCollection/serialized_test_column_names.yml

@@ -33,8 +33,8 @@ values:
                                                     arguments:
                                                       coordinates:
                                                         constantValue:
-                                                        - -101.1765625
-                                                        - 35.71859799956555
+                                                        - 2
+                                                        - 2
                                                     functionName: GeometryConstructors.Point
                                                 metadata:
                                                   constantValue:
@@ -47,8 +47,8 @@ values:
                                                     arguments:
                                                       coordinates:
                                                         constantValue:
-                                                        - -106.186328125
-                                                        - 41.41694364515647
+                                                        - 0
+                                                        - 0.5
                                                     functionName: GeometryConstructors.Point
                                                 metadata:
                                                   constantValue:
@@ -61,8 +61,8 @@ values:
                                                     arguments:
                                                       coordinates:
                                                         constantValue:
-                                                        - -108.471484375
-                                                        - 37.132906371577455
+                                                        - 0.5
+                                                        - 0
                                                     functionName: GeometryConstructors.Point
                                                 metadata:
                                                   constantValue:
@@ -77,14 +77,14 @@ values:
                                           arguments:
                                             coordinates:
                                               constantValue:
-                                              - - - -111.108203125
-                                                  - 38.72726135581648
-                                                - - -111.108203125
-                                                  - 34.42385763998893
-                                                - - -106.362109375
-                                                  - 34.42385763998893
-                                                - - -106.362109375
-                                                  - 38.72726135581648
+                                              - - - -1
+                                                  - 1
+                                                - - -1
+                                                  - -1
+                                                - - 1
+                                                  - -1
+                                                - - 1
+                                                  - 1
                                             evenOdd:
                                               constantValue: true
                                           functionName: GeometryConstructors.Polygon

tests/test_FeatureCollection/test_column_names_legacy.yml

@@ -0,0 +1,3 @@
+- system:index
+- first
+