feat: return datetime object for start_time and end_time

Co-authored-by: Moritz Schott <moritz.schott@heigit.org>
GIScience · Nov 17, 2023 · c70358c · c70358c
1 parent 76508d5
commit c70358c
Show file tree

Hide file tree

Showing 37 changed files with 65 additions and 62 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
  - support for python 3.12
  - custom [retry](https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html#urllib3.util.Retry) configuration
+ - start and end timestamp meta information of the client are now datetime objects
 
 ### Removed
 

diff --git a/ohsome/clients.py b/ohsome/clients.py
@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 
 """OhsomeClient classes to build and handle requests to ohsome API"""
+import datetime as dt
 import json
 from pathlib import Path
 from typing import Union, Optional
@@ -140,7 +141,11 @@ def start_timestamp(self):
         """
         if self._metadata is None:
             self._query_metadata()
-        return self._metadata["extractRegion"]["temporalExtent"]["fromTimestamp"]
+        return dt.datetime.fromisoformat(
+            self._metadata["extractRegion"]["temporalExtent"]["fromTimestamp"].strip(
+                "Z"
+            )
+        )
 
     @property
     def end_timestamp(self):
@@ -150,8 +155,9 @@ def end_timestamp(self):
         """
         if self._metadata is None:
             self._query_metadata()
-        return self._metadata["extractRegion"]["temporalExtent"]["toTimestamp"]
-        # return dt.datetime.fromisoformat(end_timestamp.strip("Z"))
+        return dt.datetime.fromisoformat(
+            self._metadata["extractRegion"]["temporalExtent"]["toTimestamp"].strip("Z")
+        )
 
     @property
     def api_version(self):

diff --git a/ohsome/test/cassettes/test_client/test_check_time_parameter_datetime.yaml b/ohsome/test/cassettes/test_client/test_check_time_parameter_datetime.yaml
@@ -43,7 +43,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:49 GMT
+      - Fri, 17 Nov 2023 11:28:23 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_check_time_parameter_list.yaml b/ohsome/test/cassettes/test_client/test_check_time_parameter_list.yaml
@@ -44,7 +44,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:47 GMT
+      - Fri, 17 Nov 2023 11:28:23 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_end_timestamp_as_time_input.yaml b/ohsome/test/cassettes/test_client/test_end_timestamp_as_time_input.yaml
@@ -1,6 +1,6 @@
 interactions:
 - request:
-    body: bcircles=0%3A8.678770065307615%2C49.414435400453954%2C100%7C1%3A8.697137832641602%2C49.41007968889129%2C150&time=2023-11-11T22%3A00Z&filter=amenity%3Drestaurant+and+type%3Away
+    body: bcircles=0%3A8.678770065307615%2C49.414435400453954%2C100%7C1%3A8.697137832641602%2C49.41007968889129%2C150&time=2023-11-11T22%3A00%3A00&filter=amenity%3Drestaurant+and+type%3Away
     headers:
       Accept:
       - '*/*'
@@ -9,7 +9,7 @@ interactions:
       Connection:
       - keep-alive
       Content-Length:
-      - '175'
+      - '179'
       Content-Type:
       - application/x-www-form-urlencoded
       user-agent:
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:49 GMT
+      - Fri, 17 Nov 2023 11:28:26 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bboxes_dataframe.yaml b/ohsome/test/cassettes/test_client/test_format_bboxes_dataframe.yaml
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:52 GMT
+      - Fri, 17 Nov 2023 11:28:32 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bboxes_list.yaml b/ohsome/test/cassettes/test_client/test_format_bboxes_list.yaml
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:53 GMT
+      - Fri, 17 Nov 2023 11:28:32 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -99,7 +99,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:53 GMT
+      - Fri, 17 Nov 2023 11:28:34 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -156,7 +156,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:55 GMT
+      - Fri, 17 Nov 2023 11:28:34 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -213,7 +213,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:55 GMT
+      - Fri, 17 Nov 2023 11:28:36 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -270,7 +270,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:55 GMT
+      - Fri, 17 Nov 2023 11:28:36 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bcircles_dataframe.yaml b/ohsome/test/cassettes/test_client/test_format_bcircles_dataframe.yaml
@@ -45,7 +45,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:50 GMT
+      - Fri, 17 Nov 2023 11:28:26 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bcircles_geodataframe.yaml b/ohsome/test/cassettes/test_client/test_format_bcircles_geodataframe.yaml
@@ -51,7 +51,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:51 GMT
+      - Fri, 17 Nov 2023 11:28:31 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bcircles_list.yaml b/ohsome/test/cassettes/test_client/test_format_bcircles_list.yaml
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:50 GMT
+      - Fri, 17 Nov 2023 11:28:27 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -102,7 +102,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:50 GMT
+      - Fri, 17 Nov 2023 11:28:27 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -159,7 +159,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:51 GMT
+      - Fri, 17 Nov 2023 11:28:29 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -216,7 +216,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:51 GMT
+      - Fri, 17 Nov 2023 11:28:29 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_format_bpolys.yaml b/ohsome/test/cassettes/test_client/test_format_bpolys.yaml
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:52 GMT
+      - Fri, 17 Nov 2023 11:28:31 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_post_with_endpoint_string.yaml b/ohsome/test/cassettes/test_client/test_post_with_endpoint_string.yaml
@@ -50,7 +50,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Thu, 16 Nov 2023 12:52:56 GMT
+      - Fri, 17 Nov 2023 11:28:37 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:
@@ -115,7 +115,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Thu, 16 Nov 2023 12:52:56 GMT
+      - Fri, 17 Nov 2023 11:28:37 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_client/test_user_agent.yaml b/ohsome/test/cassettes/test_client/test_user_agent.yaml
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:47 GMT
+      - Fri, 17 Nov 2023 11:28:22 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_exceptions/test_disable_logging.yaml b/ohsome/test/cassettes/test_exceptions/test_disable_logging.yaml
@@ -18,7 +18,7 @@ interactions:
     uri: https://api.ohsome.org/v1/elements/geometry
   response:
     body:
-      string: "{\n  \"timestamp\" : \"2023-11-16T12:52:57.788982831\",\n  \"status\"
+      string: "{\n  \"timestamp\" : \"2023-11-17T11:28:39.812288772\",\n  \"status\"
         : 413,\n  \"message\" : \"The given query is too large in respect to the given
         timeout. Please use a smaller region and/or coarser time period.\",\n  \"requestUrl\"
         : \"https://api.ohsome.org/v1/elements/geometry\"\n}"
@@ -44,7 +44,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Thu, 16 Nov 2023 12:52:57 GMT
+      - Fri, 17 Nov 2023 11:28:39 GMT
       Server:
       - Apache
       Strict-Transport-Security:

diff --git a/ohsome/test/cassettes/test_exceptions/test_exception_connection_reset.yaml b/ohsome/test/cassettes/test_exceptions/test_exception_connection_reset.yaml
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:04 GMT
+      - Fri, 17 Nov 2023 11:28:47 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_exceptions/test_exception_invalid_parameters.yaml b/ohsome/test/cassettes/test_exceptions/test_exception_invalid_parameters.yaml
@@ -18,7 +18,7 @@ interactions:
     uri: https://api.ohsome.org/v1/elements/count/groupBy/tag
   response:
     body:
-      string: "{\n  \"timestamp\" : \"2023-11-16T12:53:04.15640038\",\n  \"status\"
+      string: "{\n  \"timestamp\" : \"2023-11-17T11:28:47.569104003\",\n  \"status\"
         : 400,\n  \"message\" : \"You need to give one groupByKey parameter, if you
         want to use groupBy/tag.\",\n  \"requestUrl\" : \"https://api.ohsome.org/v1/elements/count/groupBy/tag\"\n}"
     headers:
@@ -41,7 +41,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:04 GMT
+      - Fri, 17 Nov 2023 11:28:47 GMT
       Server:
       - Apache
       Strict-Transport-Security:

diff --git a/ohsome/test/cassettes/test_exceptions/test_invalid_url.yaml b/ohsome/test/cassettes/test_exceptions/test_invalid_url.yaml
@@ -38,7 +38,7 @@ interactions:
       Content-Type:
       - text/html
       Date:
-      - Thu, 16 Nov 2023 12:52:57 GMT
+      - Fri, 17 Nov 2023 11:28:39 GMT
       ETag:
       - '"25c-5c7180820e5fc"'
       Keep-Alive:

diff --git a/ohsome/test/cassettes/test_exceptions/test_log_bpolys.yaml b/ohsome/test/cassettes/test_exceptions/test_log_bpolys.yaml
@@ -18,7 +18,7 @@ interactions:
     uri: https://api.ohsome.org/v1/elements/count
   response:
     body:
-      string: "{\n  \"timestamp\" : \"2023-11-16T12:52:57.984489101\",\n  \"status\"
+      string: "{\n  \"timestamp\" : \"2023-11-17T11:28:40.637302314\",\n  \"status\"
         : 413,\n  \"message\" : \"The given query is too large in respect to the given
         timeout. Please use a smaller region and/or coarser time period.\",\n  \"requestUrl\"
         : \"https://api.ohsome.org/v1/elements/count\"\n}"
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:52:57 GMT
+      - Fri, 17 Nov 2023 11:28:39 GMT
       Server:
       - Apache
       Strict-Transport-Security:

diff --git a/ohsome/test/cassettes/test_exceptions/test_timeout_error.yaml b/ohsome/test/cassettes/test_exceptions/test_timeout_error.yaml
@@ -18,7 +18,7 @@ interactions:
     uri: https://api.ohsome.org/v1/elements/geometry
   response:
     body:
-      string: "{\n  \"timestamp\" : \"2023-11-16T12:52:57.463419205\",\n  \"status\"
+      string: "{\n  \"timestamp\" : \"2023-11-17T11:28:39.141569932\",\n  \"status\"
         : 413,\n  \"message\" : \"The given query is too large in respect to the given
         timeout. Please use a smaller region and/or coarser time period.\",\n  \"requestUrl\"
         : \"https://api.ohsome.org/v1/elements/geometry\"\n}"
@@ -44,7 +44,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Thu, 16 Nov 2023 12:52:56 GMT
+      - Fri, 17 Nov 2023 11:28:38 GMT
       Server:
       - Apache
       Strict-Transport-Security:

diff --git a/ohsome/test/cassettes/test_response/test_contributions_centroid.yaml b/ohsome/test/cassettes/test_response/test_contributions_centroid.yaml
@@ -46,7 +46,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Thu, 16 Nov 2023 12:53:13 GMT
+      - Fri, 17 Nov 2023 11:29:01 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_contributions_latest.yaml b/ohsome/test/cassettes/test_response/test_contributions_latest.yaml
@@ -50,7 +50,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Thu, 16 Nov 2023 12:53:13 GMT
+      - Fri, 17 Nov 2023 11:29:01 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_elementsFullHistory_geometry.yaml b/ohsome/test/cassettes/test_response/test_elementsFullHistory_geometry.yaml
@@ -50,7 +50,7 @@ interactions:
       Content-disposition:
       - attachment;filename=ohsome.geojson
       Date:
-      - Thu, 16 Nov 2023 12:53:12 GMT
+      - Fri, 17 Nov 2023 11:28:59 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_elements_count.yaml b/ohsome/test/cassettes/test_response/test_elements_count.yaml
@@ -42,7 +42,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:05 GMT
+      - Fri, 17 Nov 2023 11:28:49 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_elements_count_groupby_boundary.yaml b/ohsome/test/cassettes/test_response/test_elements_count_groupby_boundary.yaml
@@ -45,7 +45,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:08 GMT
+      - Fri, 17 Nov 2023 11:28:54 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_elements_count_groupby_boundary_groupby_tag.yaml b/ohsome/test/cassettes/test_response/test_elements_count_groupby_boundary_groupby_tag.yaml
@@ -45,7 +45,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:08 GMT
+      - Fri, 17 Nov 2023 11:28:56 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_elements_count_groupby_key.yaml b/ohsome/test/cassettes/test_response/test_elements_count_groupby_key.yaml
@@ -50,7 +50,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:05 GMT
+      - Fri, 17 Nov 2023 11:28:50 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_elements_count_groupby_tag.yaml b/ohsome/test/cassettes/test_response/test_elements_count_groupby_tag.yaml
@@ -128,7 +128,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:06 GMT
+      - Fri, 17 Nov 2023 11:28:52 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server:

diff --git a/ohsome/test/cassettes/test_response/test_elements_count_groupby_type.yaml b/ohsome/test/cassettes/test_response/test_elements_count_groupby_type.yaml
@@ -50,7 +50,7 @@ interactions:
       Content-Type:
       - application/json
       Date:
-      - Thu, 16 Nov 2023 12:53:08 GMT
+      - Fri, 17 Nov 2023 11:28:54 GMT
       Keep-Alive:
       - timeout=5, max=100
       Server: