Merge pull request #94 from GIScience/development

Development

Author: redfrexx

.github/workflows/ci-development.yml

@@ -3,6 +3,7 @@ name: Continous Integration for development
 on:
   pull_request:
     branches: [ "**" ]
+  workflow_dispatch:
 
 jobs:
   lint:
@@ -41,7 +42,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     services:
       ohsome-api:
-        image: julianpsotta/ohsome-api:1.3.2
+        image: julianpsotta/ohsome-api:1.4.1
         ports:
           - 8080:8080
     steps:

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/ambv/black
-    rev: stable
+    rev: 22.3.0
     hooks:
       - id: black
         language_version: python3

README.md

@@ -35,7 +35,7 @@ $ pip install ohsome --no-deps
 
 ### Dependencies for Jupyter Notebooks
 
-If you want to run the Juypter Notebook [Tutorial](https://github.com/GIScience/ohsome-py/blob/master/notebooks/Tutorial.ipynb) you also need to install `jupyter` and `matplotlib` e.g.
+If you want to run the Jupyter Notebook [Tutorial](https://github.com/GIScience/ohsome-py/blob/master/notebooks/Tutorial.ipynb) you also need to install `jupyter` and `matplotlib` e.g.
 
 ```
 $ pip install jupyter matplotlib

ohsome/clients.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """OhsomeClient classes to build and handle requests to ohsome API"""
+import json
 import urllib
 
 import requests
@@ -38,6 +39,7 @@ def __init__(
         :param log: Log failed queries, default:True
         :param log_dir: Directory for log files, default: ./ohsome_log
         :param cache: Cache for endpoint components
+        :param user_agent: User agent passed with the request to the ohsome API
         """
         self.log = log
         self.log_dir = log_dir
@@ -95,6 +97,7 @@ def __init__(
         :param log: Log failed queries, default:True
         :param log_dir: Directory for log files, default: ./ohsome_log
         :param cache: Cache for endpoint components
+        :param user_agent: User agent passed with the request to the ohsome API
         """
         super(_OhsomeInfoClient, self).__init__(
             base_api_url, log, log_dir, cache, user_agent
@@ -190,6 +193,7 @@ def __init__(
         :param log: Log failed queries, default:True
         :param log_dir: Directory for log files, default: ./ohsome_log
         :param cache: Cache for endpoint components
+        :param user_agent: User agent passed with the request to the ohsome API
         """
         super(_OhsomePostClient, self).__init__(
             base_api_url, log, log_dir, cache, user_agent
@@ -286,13 +290,18 @@ def _handle_request(self):
             response.raise_for_status()
             response.json()
         except requests.exceptions.HTTPError as e:
-            ohsome_exception = OhsomeException(
-                message=e.response.json()["message"],
-                url=self._url,
-                params=self._parameters,
-                error_code=e.response.status_code,
-                response=e.response,
-            )
+            try:
+                error_message = e.response.json()["message"]
+            except json.decoder.JSONDecodeError:
+                error_message = f"Invalid URL: Is {self._url} valid?"
+            finally:
+                ohsome_exception = OhsomeException(
+                    message=error_message,
+                    url=self._url,
+                    params=self._parameters,
+                    error_code=e.response.status_code,
+                    response=e.response,
+                )
         except requests.exceptions.ConnectionError as e:
             ohsome_exception = OhsomeException(
                 message="Connection Error: Query could not be sent. Make sure there are no network "

ohsome/constants.py

@@ -6,4 +6,4 @@
 DEFAULT_LOG = True
 DEFAULT_LOG_DIR = "./ohsome_log"
 # update version in pyproject.toml as well
-OHSOME_VERSION = "0.1.0rc2"
+OHSOME_VERSION = "0.1.0"

ohsome/response.py

@@ -23,8 +23,8 @@ def as_dataframe(self, multi_index=True):
         """
         Converts the ohsome response to a pandas.DataFrame or a geopandas.GeoDataFrame if the
         response contains geometries
-        :param multi_index:
-        :return:
+        :param multi_index: If true returns the dataframe with a multi index
+        :return: pandas.DataFrame or geopandas.GeoDataFrame
         """
         if "features" not in self.data.keys():
             return self._as_dataframe(multi_index)
@@ -34,8 +34,10 @@ def as_dataframe(self, multi_index=True):
     def _as_dataframe(self, multi_index=True):
         """
         Converts the ohsome response to a pandas.DataFrame
-        :return: pandas dataframe
+        :param multi_index: If true returns the dataframe with a multi index
+        :return: pandas.DataFrame
         """
+
         groupby_names = []
         if "result" in self.data.keys():
             result_df = pd.DataFrame().from_records(self.data["result"])
@@ -65,13 +67,18 @@ def _as_dataframe(self, multi_index=True):
     def _as_geodataframe(self, multi_index=True):
         """
         Converts the ohsome response to a geopandas.GeoDataFrame
-        :return:
+        :param multi_index: If true returns the dataframe with a multi index
+        :return: geopandas.GeoDataFrame
         """
+
+        if len(self.data["features"]) == 0:
+            return gpd.GeoDataFrame(crs="epsg:4326", columns=["@osmId", "geometry"])
+
         try:
             features = gpd.GeoDataFrame().from_features(self.data, crs="epsg:4326")
         except TypeError():
             raise TypeError(
-                "This result type cannot be converted to a GeoPandas dataframe."
+                "This result type cannot be converted to a GeoPandas GeoDataFrame object."
             )
 
         if "@validFrom" in features.columns:
@@ -114,8 +121,8 @@ def to_json(self, outfile):
         :return:
         """
         assert outfile.endswith("json"), "Output file must be json"
-        with open(outfile, "w") as dst:
-            json.dump(self.data, dst, indent=2)
+        with open(outfile, "w", encoding="utf-8") as dst:
+            json.dump(self.data, dst, indent=2, ensure_ascii=False)
 
     def _set_index(self, result_df, groupby_names):
         """

ohsome/test/data/points.geojson

@@ -3,7 +3,10 @@
   "features": [
     {
       "type": "Feature",
-      "properties": {"id": 1, "radius":  100},
+      "properties": {
+        "id": 1,
+        "radius": 100
+      },
       "geometry": {
         "type": "Point",
         "coordinates": [
@@ -14,7 +17,10 @@
     },
     {
       "type": "Feature",
-      "properties": {"id": 2, "radius":  150},
+      "properties": {
+        "id": 2,
+        "radius": 150
+      },
       "geometry": {
         "type": "Point",
         "coordinates": [

ohsome/test/test_exceptions.py

@@ -55,6 +55,23 @@ def test_invalid_url():
     )
 
 
+def test_invalid_url2():
+    """
+    Test whether an OhsomeException is raises if the ohsome API url is invalid, i.e.
+    https://api.ohsome.org/ instead of https://api.ohsome.org/v1
+    :return:
+    """
+    base_api_url = "https://api.ohsome.org/"
+    bboxes = "8.7137,49.4096,8.717,49.4119"
+    time = "2018-01-01"
+    fltr = "name=Krautturm and type:way"
+
+    client = ohsome.OhsomeClient(base_api_url=base_api_url, log=False)
+    with pytest.raises(ohsome.OhsomeException) as e_info:
+        client.elements.count.post(bboxes=bboxes, time=time, filter=fltr)
+    assert "Invalid URL:" in e_info.value.message
+
+
 def test_invalid_endpoint():
     """
     Test whether request can be sent to alternative url

ohsome/test/test_response.py

@@ -4,6 +4,7 @@
 
 import geopandas as gpd
 import pandas as pd
+import pytest
 
 
 def test_elements_count(custom_client):
@@ -323,3 +324,22 @@ def test_contributions_latest(custom_client):
 
     assert isinstance(result, gpd.GeoDataFrame)
     assert len(result) == 1
+
+
+def test_empty_geodataframe(custom_client):
+    """
+    Tests whether an empty GeoDataFrame is created without a warning if no features are returned from ohsome
+    :return:
+    """
+    bboxes = "8.7137,49.4096,8.717,49.4119"
+    time = "2015-01-01,2016-01-01"
+    filter = "name=Krautturm1 and type:way"
+
+    client = custom_client
+    response = client.elements.bbox.post(bboxes=bboxes, time=time, filter=filter)
+    with pytest.warns(None) as record:
+        result = response.as_dataframe()
+
+    assert isinstance(result, gpd.GeoDataFrame)
+    assert result.empty
+    assert len(record) == 0