Admin: coerce resource temporal extents into datetime objects (geopython#1877)

* coerce resource temporal extents into datetime objects

* fix ref

* fix test

* fix test

* fix test

* fix test

* fix ref

Author: tomkralidis

pygeoapi/admin.py

@@ -3,7 +3,7 @@
 # Authors: Tom Kralidis <[email protected]>
 #          Benjamin Webb <[email protected]>
 #
-# Copyright (c) 2023 Tom Kralidis
+# Copyright (c) 2024 Tom Kralidis
 # Copyright (c) 2023 Benjamin Webb
 #
 # Permission is hereby granted, free of charge, to any person
@@ -32,16 +32,16 @@
 from copy import deepcopy
 import os
 import json
-from jsonpatch import make_patch
-from jsonschema.exceptions import ValidationError
 import logging
 from typing import Any, Tuple, Union
 
-from pygeoapi.api import API, APIRequest, F_HTML, pre_process
+from dateutil.parser import parse as parse_date
+from jsonpatch import make_patch
+from jsonschema.exceptions import ValidationError
 
+from pygeoapi.api import API, APIRequest, F_HTML, pre_process
 from pygeoapi.config import get_config, validate_config
 from pygeoapi.openapi import get_oas
-# from pygeoapi.openapi import validate_openapi_document
 from pygeoapi.util import to_json, render_j2_template, yaml_dump
 
 
@@ -221,6 +221,8 @@ def put_config(
 
         try:
             data = json.loads(data)
+            for key, value in data.get('resources', {}).items():
+                temporal_extents_str2datetime(value.get('extents', {}))
         except (json.decoder.JSONDecodeError, TypeError) as err:
             # Input is not valid JSON
             LOGGER.error(err)
@@ -277,6 +279,8 @@ def patch_config(
 
         try:
             data = json.loads(data)
+            for key, value in data.get('resources', {}).items():
+                temporal_extents_str2datetime(value.get('extents', {}))
         except (json.decoder.JSONDecodeError, TypeError) as err:
             # Input is not valid JSON
             LOGGER.error(err)
@@ -367,6 +371,8 @@ def post_resource(
 
         try:
             data = json.loads(data)
+            res = list(data.keys())[0]
+            temporal_extents_str2datetime(data[res].get('extents', {}))
         except (json.decoder.JSONDecodeError, TypeError) as err:
             # Input is not valid JSON
             LOGGER.error(err)
@@ -528,6 +534,7 @@ def put_resource(
 
         try:
             data = json.loads(data)
+            temporal_extents_str2datetime(data.get('extents', {}))
         except (json.decoder.JSONDecodeError, TypeError) as err:
             # Input is not valid JSON
             LOGGER.error(err)
@@ -594,6 +601,7 @@ def patch_resource(
 
         try:
             data = json.loads(data)
+            temporal_extents_str2datetime(data.get('extents', {}))
         except (json.decoder.JSONDecodeError, TypeError) as err:
             # Input is not valid JSON
             LOGGER.error(err)
@@ -621,3 +629,19 @@ def patch_resource(
         content = to_json(resource, self.pretty_print)
 
         return headers, 204, content
+
+
+def temporal_extents_str2datetime(extents: dict) -> None:
+    """
+    Helper function to coerce datetime strings into datetime objects
+
+    :extents: `dict` of pygeoapi resource extents object
+
+    :returns: `None` (changes made directly)
+    """
+
+    try:
+        extents['temporal']['begin'] = parse_date(extents['temporal']['begin'])
+        extents['temporal']['end'] = parse_date(extents['temporal']['end'])
+    except (KeyError, TypeError):
+        LOGGER.debug('No temporal extents found')

tests/test_admin_api.py

@@ -3,7 +3,7 @@
 # Authors: Tom Kralidis <[email protected]>
 # Authors: Benjamin Webb <[email protected]>
 #
-# Copyright (c) 2023 Tom Kralidis
+# Copyright (c) 2024 Tom Kralidis
 # Copyright (c) 2023 Benjamin Webb
 #
 # Permission is hereby granted, free of charge, to any person
@@ -29,13 +29,15 @@
 #
 # =================================================================
 
+from datetime import datetime
 import time
-
-from pathlib import Path
 import unittest
 
+from pathlib import Path
 from requests import Session
 
+from pygeoapi.util import yaml_load
+
 THISDIR = Path(__file__).resolve().parent
 
 
@@ -110,12 +112,16 @@ def test_resources_crud(self):
         content = self.http.get(url).json()
         self.assertEqual(len(content.keys()), 2)
 
+        with get_abspath('../../pygeoapi-test-config-admin.yml').open() as fh:
+            d = yaml_load(fh)
+            temporal_extent_begin = d['resources']['data2']['extents']['temporal']['begin']  # noqa
+            self.assertIsInstance(temporal_extent_begin, datetime)
+
         # PUT an existing resource
         url = f'{self.admin_endpoint}/resources/data2'
         with get_abspath('resource-put.json').open() as fh:
             post_data = fh.read()
-        print(url)
-        print(get_abspath('resource-put.json'))
+
         response = self.http.put(url, data=post_data)
         self.assertEqual(response.status_code, 204)