feat: required region arg to init stac client

Author: martibosch

swisstopopy/buildings.py

@@ -117,7 +117,7 @@ def get_bldg_gdf(
     )
 
     # use the STAC API to get building heights from swissSURFACE3D and swissALTI3D
-    client = stac.SwissTopoClient(region=region_gser)
+    client = stac.SwissTopoClient(region_gser)
 
     # surface3d-raster (raster dsm)
     surface3d_gdf = client.gdf_from_collection(

swisstopopy/dem.py

@@ -47,7 +47,7 @@ def get_dem_raster(
         `settings.RIO_MERGE_DST_KWARGS` are used.
     """
     # use the STAC API to get the DEM from swissALTI3D
-    client = stac.SwissTopoClient(region=region, region_crs=region_crs)
+    client = stac.SwissTopoClient(region, region_crs=region_crs)
     alti3d_gdf = client.gdf_from_collection(
         stac.SWISSALTI3D_COLLECTION_ID,
         datetime=alti3d_datetime,

swisstopopy/stac.py

@@ -126,9 +126,8 @@ class SwissTopoClient:
 
     Parameters
     ----------
-    region : region-like, optional
+    region : region-like
         Region to get the data for. Can any argument accepted by the pyregeon library.
-        If None, all the collection data will be returned.
     region_crs : crs-like, optional
         Coordinate reference system (CRS) of the region. Required if `region` is a naive
         geometry or a list of bounding box coordinates. Ignored if `region` already has
@@ -138,8 +137,8 @@ class SwissTopoClient:
 
     def __init__(
         self,
+        region: RegionType,
         *,
-        region: RegionType | None = None,
         region_crs: CRSType = None,
     ):
         """Initialize a swisstopo client."""

swisstopopy/tree_canopy.py

@@ -105,7 +105,7 @@ def get_tree_canopy_raster(
     # note that we need to pass the STAC client's CRS to both `_process_region_arg` and
     # `to_crs`, because `region` may have another CRS and we need the extend in the
     # client's CRS
-    client = stac.SwissTopoClient(region=region, region_crs=region_crs)
+    client = stac.SwissTopoClient(region, region_crs=region_crs)
     surface3d_gdf = client.gdf_from_collection(
         stac.SWISSSURFACE3D_COLLECTION_ID,
         datetime=surface3d_datetime,

tests/test_swisstopopy.py

@@ -18,19 +18,20 @@ def setUp(self):
         ]
 
     def test_region(self):
-        # test without region (all collection items)
-        client = swisstopopy.SwissTopoClient()
+        # # test without region (all collection items)
+        # client = swisstopopy.SwissTopoClient()
 
-        # since this is slow, test init one collection only
-        collection_id = self.collection_ids[0]
-        gdf = client.gdf_from_collection(collection_id)
+        # # since this is slow, test init one collection only
+        # collection_id = self.collection_ids[0]
+        # gdf = client.gdf_from_collection(collection_id)
 
         # test with region
         region_client = swisstopopy.SwissTopoClient(region=self.nominatim_query)
-        # test that there are at most as many items as when not filtering spatially
-        self.assertLessEqual(
-            len(region_client.gdf_from_collection(collection_id).index), len(gdf.index)
-        )
+        # # test that there are at most as many items as when not filtering spatially
+        # self.assertLessEqual(
+        #     len(region_client.gdf_from_collection(collection_id).index),
+        #     len(gdf.index)
+        # )
         # test init all collections
         for collection_id in self.collection_ids:
             gdf = region_client.gdf_from_collection(collection_id)