Merge pull request #24 from KNMI/data-type

Add support for Parameter.`data-type`

Author: PaulVanSchayck

README.md

@@ -86,12 +86,13 @@ c = Collection(
             observedProperty=ObservedProperty(
                 id="https://codes.wmo.int/common/quantity-kind/_windDirection",
                 label="Wind Direction"
-            )
+            ),
+            dataType="integer"
         )
     })
 )
 
-print(c.model_dump_json(indent=2, exclude_none=True))
+print(c.model_dump_json(indent=2, exclude_none=True, by_alias=True))
 ```
 
 Will print
@@ -136,6 +137,7 @@ Will print
   "parameter_names": {
     "Wind Direction": {
       "type": "Parameter",
+      "data-type": "integer",
       "unit": {
         "label": "degree true"
       },
@@ -148,6 +150,9 @@ Will print
 }
 ```
 
+**IMPORTANT**: The arguments `by_alias=True` to `model_dump_json()` or `model_dump()` is required to get the output as shown above. Without `by_alias=True` the attribute `data-type` will be wrongly outputted as `dataType`. This is due an issue in the [EDR spec](https://github.com/opengeospatial/ogcapi-environmental-data-retrieval/issues/605) and [Pydantic](https://github.com/pydantic/pydantic/issues/8379).
+
+
 ## Contributing
 
 Make an editable install from within the repository root

example.py

@@ -33,9 +33,10 @@
                 observedProperty=ObservedProperty(
                     id="https://codes.wmo.int/common/quantity-kind/_windDirection", label="Wind Direction"
                 ),
+                dataType="integer",
             )
         }
     ),
 )
 
-print(c.model_dump_json(indent=2, exclude_none=True))
+print(c.model_dump_json(indent=2, exclude_none=True, by_alias=True))

src/edr_pydantic/base_model.py

@@ -10,4 +10,5 @@ class EdrBaseModel(PydanticBaseModel):
         validate_default=True,
         validate_assignment=True,
         strict=True,
+        populate_by_name=True,
     )

src/edr_pydantic/parameter.py

@@ -3,6 +3,7 @@
 from typing import Literal
 from typing import Optional
 
+from pydantic import Field
 from pydantic import model_validator
 from pydantic import RootModel
 
@@ -23,6 +24,7 @@ class Parameter(EdrBaseModel, extra="allow"):
     id: Optional[str] = None
     label: Optional[str] = None
     description: Optional[str] = None
+    dataType: Optional[Literal["integer", "float", "string"]] = Field(None, alias="data-type")  # noqa: N815
     unit: Optional[Unit] = None
     observedProperty: ObservedProperty  # noqa: N815
     extent: Optional[Extent] = None

tests/test_data/knmi-example-collections.json

@@ -449,6 +449,7 @@
                 "tx_dryb_10": {
                     "type": "Parameter",
                     "description": "Temperature, air, maximum, 10'",
+                    "data-type": "float",
                     "unit": {
                         "label": "degree Celsius",
                         "symbol": {
@@ -479,6 +480,7 @@
                 "ww_cor_10": {
                     "type": "Parameter",
                     "description": "Weather, validated code, present weather sensor, 10'",
+                    "data-type": "integer",
                     "unit": {
                         "label": "weather code",
                         "symbol": {

tests/test_data/parameter-invalid-data-type.json

@@ -0,0 +1,7 @@
+{
+    "type": "Parameter",
+    "data-type": "foobar",
+    "observedProperty": {
+        "label": "invalid parameter"
+    }
+}

tests/test_data/parameter-with-data-type.json

@@ -0,0 +1,23 @@
+{
+    "str-parameter": {
+        "type": "Parameter",
+        "data-type": "string",
+        "observedProperty": {
+            "label": "string parameter"
+        }
+    },
+    "int-parameter": {
+        "type": "Parameter",
+        "data-type": "integer",
+        "observedProperty": {
+            "label": "int parameter"
+        }
+    },
+    "float-parameter": {
+        "type": "Parameter",
+        "data-type": "float",
+        "observedProperty": {
+            "label": "float parameter"
+        }
+    }
+}

tests/test_edr.py

@@ -1,16 +1,16 @@
 import json
 from pathlib import Path
-from typing import Dict
 
 import pytest
 from edr_pydantic.capabilities import LandingPageModel
 from edr_pydantic.collections import Collections
 from edr_pydantic.collections import Instance
 from edr_pydantic.extent import Extent
 from edr_pydantic.extent import Temporal
+from edr_pydantic.observed_property import ObservedProperty
 from edr_pydantic.parameter import Parameter
+from edr_pydantic.parameter import Parameters
 from edr_pydantic.unit import Unit
-from pydantic import RootModel
 from pydantic import ValidationError
 
 happy_cases = [
@@ -19,7 +19,8 @@
     ("simple-instance.json", Instance),
     ("landing-page.json", LandingPageModel),
     ("doc-example-extent.json", Extent),
-    ("parameter-names.json", RootModel[Dict[str, Parameter]]),
+    ("parameter-names.json", Parameters),
+    ("parameter-with-data-type.json", Parameters),
     ("parameter-with-extent.json", Parameter),
 ]
 
@@ -33,13 +34,14 @@ def test_happy_cases(file_name, object_type):
     json_string = json.dumps(data, separators=(",", ":"), ensure_ascii=False)
 
     # Round-trip
-    assert object_type.model_validate_json(json_string).model_dump_json(exclude_none=True) == json_string
+    assert object_type.model_validate_json(json_string).model_dump_json(exclude_none=True, by_alias=True) == json_string
 
 
 error_cases = [
     ("label-or-symbol-unit.json", Unit, r"Either 'label' or 'symbol' should be set"),
     ("temporal-interval-length1.json", Temporal, r"List should have at least 2 items after validation"),
     ("temporal-interval-length3.json", Temporal, r"List should have at most 2 items after validation, not 3"),
+    ("parameter-invalid-data-type.json", Parameter, r"Input should be 'integer', 'float' or 'string'"),
 ]
 
 
@@ -53,3 +55,17 @@ def test_error_cases(file_name, object_type, error_message):
 
     with pytest.raises(ValidationError, match=error_message):
         object_type.model_validate_json(json_string)
+
+
+def test_data_type_alias():
+    p = Parameter(observedProperty=ObservedProperty(label="Wind"), dataType="integer")
+
+    # This tests for the current observed Pydantic behavior with model_dump() and the `by_alias` setting
+    assert (
+        p.model_dump_json(exclude_none=True)
+        == '{"type":"Parameter","dataType":"integer","observedProperty":{"label":"Wind"}}'
+    )
+    assert (
+        p.model_dump_json(exclude_none=True, by_alias=True)
+        == '{"type":"Parameter","data-type":"integer","observedProperty":{"label":"Wind"}}'
+    )