fix(helper): GeoSeries not working as bpolys input (#158)

simplify bpoly formatting and tests Addresses #139 Closes #155 Co-authored-by: Matthias (~talfus-laddus) <[email protected]>
GIScience · Jul 4, 2024 · addb892 · addb892
1 parent 47876c7
commit addb892
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 91 deletions.
diff --git a/ohsome/helper.py b/ohsome/helper.py
@@ -182,9 +182,9 @@ def format_bboxes(
         )
     elif isinstance(bboxes, str):
         return bboxes
-    elif isinstance(bboxes, gpd.GeoDataFrame):
+    elif isinstance(bboxes, gpd.GeoDataFrame) or isinstance(bboxes, gpd.GeoSeries):
         raise OhsomeException(
-            message="Use the 'bpolys' parameter to specify the boundaries using a geopandas.GeoDataFrame."
+            message="Use the 'bpolys' parameter to specify the boundaries using a geopandas object."
         )
     elif isinstance(bboxes, pd.DataFrame):
         try:
@@ -204,29 +204,34 @@ def format_bboxes(
 
 
 def format_bpolys(
-    bpolys: Union[gpd.GeoDataFrame, shapely.Polygon, shapely.MultiPolygon, str]
+    bpolys: Union[
+        gpd.GeoDataFrame, gpd.GeoSeries, shapely.Polygon, shapely.MultiPolygon, str
+    ]
 ) -> str:
     """
     Formats bpolys parameter to comply with ohsome API
     :param
-    bpolys: Polygons given as geopandas.GeoDataFrame or string formatted as GeoJSON FeatureCollection.
+    bpolys: Polygons given as geopandas.GeoDataFrame, geopandas.GeoSeries, Shapely.Polygon or GeoJSON FeatureCollection as string.
     :return:
     """
-    if isinstance(bpolys, gpd.GeoDataFrame) or isinstance(bpolys, gpd.GeoSeries):
-        return bpolys.to_json(na="drop")
+    if isinstance(bpolys, gpd.GeoDataFrame):
+        return bpolys.to_json(na="drop", show_bbox=False, drop_id=False, to_wgs84=True)
+    elif isinstance(bpolys, gpd.GeoSeries):
+        return format_bpolys(bpolys.to_frame("geometry"))
     elif isinstance(bpolys, shapely.Polygon) or isinstance(
         bpolys, shapely.MultiPolygon
     ):
-        return format_bpolys(gpd.GeoDataFrame(geometry=[bpolys]))
+        return format_bpolys(gpd.GeoDataFrame(geometry=[bpolys], crs="EPSG:4326"))
     elif isinstance(bpolys, str):
         try:
-            return format_bpolys(gpd.GeoDataFrame.from_features(json.loads(bpolys)))
+            return format_bpolys(
+                gpd.GeoDataFrame.from_features(json.loads(bpolys), crs="EPSG:4326")
+            )
         except Exception as e:
             raise OhsomeException(message="Invalid geojson.") from e
     else:
         raise OhsomeException(
-            message="bpolys must be a geojson string, a shapely polygonal object or a geopandas "
-            "object"
+            message="bpolys must be a geojson string, a shapely polygonal object or a geopandas object"
         )
 
 

diff --git a/ohsome/test/cassettes/test_client/test_format_bpolys.yaml b/ohsome/test/cassettes/test_client/test_format_bpolys.yaml
diff --git a/ohsome/test/test_client.py b/ohsome/test/test_client.py
@@ -181,20 +181,6 @@ def test_format_bcircles_geodataframe_geometry_error(base_client):
     del client
 
 
-@pytest.mark.vcr
-def test_format_bpolys(base_client):
-    """
-    Test whether a GeoDataFrame obejct is formatted correctly for ohsome api.
-    :return:
-    """
-    bpolys = gpd.read_file(f"{script_path}/data/polygons.geojson")
-    time = "2018-01-01"
-    fltr = "amenity=restaurant and type:node"
-
-    client = base_client
-    client.elements.count.post(bpolys=bpolys, time=time, filter=fltr)
-
-
 @pytest.mark.vcr
 def test_format_bboxes_dataframe(base_client):
     """
@@ -254,7 +240,7 @@ def test_format_bboxes_geodataframe(base_client):
 
     assert (
         "Use the 'bpolys' parameter to specify the boundaries using a "
-        "geopandas.GeoDataFrame." in e_info.value.message
+        "geopandas object." in e_info.value.message
     )
 
 

diff --git a/ohsome/test/test_helper.py b/ohsome/test/test_helper.py
@@ -7,6 +7,7 @@
 import logging
 import os
 
+import geopandas as gpd
 import numpy as np
 import pandas as pd
 import pytest
@@ -225,13 +226,38 @@ def test_format_bpolys():
             == "bolys must be a geojson string, a shapely polygonal object or a geopandas object"
         )
 
-    with open(f"{script_path}/data/polygons.geojson") as geojson:
-        json_str = geojson.read()
-        assert json.loads(format_bpolys(json_str)) == json.loads(json_str)
+    geojson = json.dumps(
+        {
+            "type": "FeatureCollection",
+            "features": [
+                {
+                    "id": "0",
+                    "type": "Feature",
+                    "properties": {},
+                    "geometry": {
+                        "type": "Polygon",
+                        "coordinates": [
+                            [[0.0, 0.0], [0.0, 1.0], [1.0, 1.0], [1.0, 0.0], [0.0, 0.0]]
+                        ],
+                    },
+                }
+            ],
+        }
+    )
+
+    assert format_bpolys(geojson) == geojson
 
     polygon = Polygon(((0.0, 0.0), (0.0, 1.0), (1.0, 1.0), (1.0, 0.0), (0.0, 0.0)))
-    assert format_bpolys(polygon) == (
-        '{"type": "FeatureCollection", "features": [{"id": "0", "type": "Feature", '
-        '"properties": {}, "geometry": {"type": "Polygon", "coordinates": [[[0.0, '
-        "0.0], [0.0, 1.0], [1.0, 1.0], [1.0, 0.0], [0.0, 0.0]]]}}]}"
+    assert format_bpolys(polygon) == geojson
+
+    series = gpd.GeoSeries(
+        data=[polygon],
+        crs="EPSG:4326",
+    )
+    assert format_bpolys(series) == geojson
+
+    df = gpd.GeoDataFrame(
+        geometry=[polygon],
+        crs="EPSG:4326",
     )
+    assert format_bpolys(df) == geojson