refactor: use <observation class>:<observed_property> in observed property

Author: jacob-a-brown

api/observation.py

@@ -177,12 +177,11 @@ def get_observations(
         sql = sql.where(Observation.observation_datetime <= end_time)
 
     if observation_class == "groundwater level":
-        sql = sql.where(Observation.observed_property == "groundwater level")
+        sql = sql.where(Observation.observed_property.like("groundwater level:%"))
     elif observation_class == "water chemistry":
-        sql = sql.where(Observation.observed_property != "groundwater level")
-        sql = sql.where(Observation.observed_property != "temperature")
+        sql = sql.where(Observation.observed_property.like("water chemistry:%"))
     elif observation_class == "geothermal":
-        sql = sql.where(Observation.observed_property == "temperature")
+        sql = sql.where(Observation.observed_property.like("geothermal:%"))
 
     sql = order_sort_filter(sql, Observation, sort, order, filter_)
 

core/lexicon.json

@@ -13,12 +13,12 @@
   {"category": "unit", "term": "m²/s", "definition": "square meters per second"},
   {"category": "unit", "term": "deg C", "definition": "degree Celsius"},
 
-  {"category": "observed_property", "term": "groundwater level", "definition": "groundwater level measurement" },
+  {"category": "observed_property", "term": "groundwater level:groundwater level", "definition": "groundwater level measurement" },
 
-  {"category": "observed_property", "term": "temperature", "definition": "Temperature measurement"},
-  
-  {"category": "observed_property", "term": "pH", "definition": "pH"},
-  {"category": "observed_property", "term": "Alkalinity as CaCO3", "definition": "Alkalinity as CaCO3"},
+  {"category": "observed_property", "term": "geothermal:temperature", "definition": "Temperature measurement"},
+
+  {"category": "observed_property", "term": "water chemistry:pH", "definition": "pH"},
+  {"category": "observed_property", "term": "water chemistry:Alkalinity as CaCO3", "definition": "Alkalinity as CaCO3"},
 
 
 

schemas/observation.py

@@ -36,7 +36,8 @@
 
 
 class ValidateObservation(BaseModel):
-
+    _observation_class: str
+    observed_property: str
     observation_datetime: AwareDatetime
 
     @field_validator("observation_datetime", check_fields=False)
@@ -54,6 +55,16 @@ def convert_observation_datetime_to_utc(
             return observation_datetime.astimezone(timezone.utc)
         return observation_datetime
 
+    @model_validator(mode="after")
+    def prepend_observed_property(self: Self) -> Self:
+        observed_property = self.observed_property
+        observation_class = self._observation_class
+        if observed_property is not None:
+            observation_class = self._observation_class
+            if not observed_property.startswith(f"{observation_class}:"):
+                self.observed_property = f"{observation_class}:{observed_property}"
+        return self
+
 
 # -------- CREATE ----------
 class CreateBaseObservation(ValidateObservation):
@@ -67,15 +78,17 @@ class CreateBaseObservation(ValidateObservation):
 
 
 class CreateGroundwaterLevelObservation(CreateBaseObservation):
+    _observation_class: str = "groundwater level"
     measuring_point_height: float
     level_status: str
 
 
 class CreateWaterChemistryObservation(CreateBaseObservation):
-    pass
+    _observation_class: str = "water chemistry"
 
 
 class CreateGeothermalObservation(CreateBaseObservation):
+    _observation_class: str = "geothermal"
     observation_depth: float
 
 
@@ -93,15 +106,17 @@ class UpdateBaseObservation(ValidateObservation):
 
 
 class UpdateGroundwaterLevelObservation(UpdateBaseObservation):
+    _observation_class: str = "groundwater level"
     measuring_point_height: float | None = None
     level_status: str | None = None
 
 
 class UpdateWaterChemistryObservation(UpdateBaseObservation):
-    pass
+    _observation_class: str = "water chemistry"
 
 
 class UpdateGeothermalObservation(UpdateBaseObservation):
+    _observation_class: str = "geothermal"
     observation_depth: float | None = None
 
 
@@ -115,6 +130,11 @@ class BaseObservationResponse(ORMBaseModel):
     value: float | None
     unit: str
 
+    @field_validator("observed_property")
+    def remove_observed_property_prefix(cls, v: str) -> str:
+        colon_index = v.find(":")
+        return v[colon_index + 1 :]
+
 
 class GroundwaterLevelObservationResponse(BaseObservationResponse):
     depth_to_water_bgs: float | None

services/observation_helper.py

@@ -6,35 +6,15 @@
 from services.exceptions_helper import PydanticStyleException
 from services.query_helper import simple_get_by_id
 
-observation_class_to_observed_properties = {
-    "groundwater level": ["groundwater level"],
-    "geothermal": ["temperature"],
-    "water chemistry": ["pH", "Alkalinity as CaCO3"],
-}
-
-observation_property_to_class = {}
-for key, value in observation_class_to_observed_properties.items():
-    for prop in value:
-        observation_property_to_class[prop] = key
-
 
 def verify_observed_property_corresponds_with_observation_class(
     observation: Observation, observation_class: str
-) -> None:
-    """
-    Verify that the observed property of the retrieved Observation corresponds
-    with the observation class as defined by the path
-    (e.g. /observation/water-chemistry). Raise an error if they do not
-    correspond.
-    """
+):
     observed_property = observation.observed_property
+    colon_index = observed_property.find(":")
+    actual_observation_class = observed_property[:colon_index]
 
-    if (
-        observed_property
-        not in observation_class_to_observed_properties[observation_class]
-    ):
-        actual_observation_class = observation_property_to_class[observed_property]
-
+    if actual_observation_class != observation_class:
         raise PydanticStyleException(
             status_code=HTTP_404_NOT_FOUND,
             detail=[

tests/conftest.py

@@ -175,7 +175,7 @@ def groundwater_level_observation(sensor, sample):
             observation_datetime="2025-01-01T00:04:00Z",
             sample_id=sample.id,
             sensor_id=sensor.id,
-            observed_property="groundwater level",
+            observed_property="groundwater level:groundwater level",
             release_status="draft",
             value=10.0,
             unit="ft",
@@ -196,7 +196,7 @@ def water_chemistry_observation(sensor, sample):
             observation_datetime="2025-01-01T00:03:00Z",
             sample_id=sample.id,
             sensor_id=sensor.id,
-            observed_property="pH",
+            observed_property="water chemistry:pH",
             release_status="draft",
             value=4.0,
             unit="dimensionless",
@@ -215,7 +215,7 @@ def geothermal_observation(sensor, sample):
             observation_datetime="2025-01-01T00:02:00Z",
             sample_id=sample.id,
             sensor_id=sensor.id,
-            observed_property="temperature",
+            observed_property="geothermal:temperature",
             release_status="draft",
             value=20.0,
             unit="deg C",

tests/test_observation.py

@@ -49,7 +49,7 @@ def observation_to_delete(sample, sensor):
             observation_datetime="2019-01-01T00:03:00Z",
             sample_id=sample.id,
             sensor_id=sensor.id,
-            observed_property="pH",
+            observed_property="water chemistry:pH",
             release_status="draft",
             value=4.0,
             unit="dimensionless",
@@ -182,7 +182,7 @@ def test_patch_groundwater_level_observation_404_wrong_observation_class(
         assert response.status_code == 404
         data = response.json()
 
-        if obs.observed_property == "temperature":
+        if obs.observed_property == "geothermal:temperature":
             observation_class = "geothermal"
         else:
             observation_class = "water chemistry"
@@ -225,7 +225,7 @@ def test_patch_water_chemistry_observation_404_wrong_observation_class(
         assert response.status_code == 404
         data = response.json()
 
-        if obs.observed_property == "temperature":
+        if obs.observed_property == "geothermal:temperature":
             observation_class = "geothermal"
         else:
             observation_class = "groundwater level"
@@ -266,7 +266,7 @@ def test_patch_geothermal_observation_404_wrong_observation_class(
         assert response.status_code == 404
         data = response.json()
 
-        if obs.observed_property == "groundwater level":
+        if obs.observed_property == "groundwater level:groundwater level":
             observation_class = "groundwater level"
         else:
             observation_class = "water chemistry"
@@ -305,10 +305,10 @@ def test_get_observation_by_id(
         data = response.json()
 
         assert data["id"] == obs.id
-        if obs.observed_property == "groundwater level":
+        if obs.observed_property == "groundwater level:groundwater level":
             assert data["depth_to_water_bgs"] == obs.value - obs.measuring_point_height
             assert data["observation_depth"] is None
-        elif obs.observed_property == "temperature":
+        elif obs.observed_property == "geothermal:temperature":
             assert data["depth_to_water_bgs"] is None
             assert data["observation_depth"] == obs.observation_depth
         else:
@@ -340,9 +340,10 @@ def test_get_groundwater_level_observations(
         data["items"][0]["observation_datetime"]
         == groundwater_level_observation.observation_datetime
     )
+    colon_index = groundwater_level_observation.observed_property.find(":")
     assert (
         data["items"][0]["observed_property"]
-        == groundwater_level_observation.observed_property
+        == groundwater_level_observation.observed_property[colon_index + 1 :]
     )
     assert (
         data["items"][0]["release_status"]
@@ -380,7 +381,11 @@ def test_get_groundwater_level_observation_by_id(groundwater_level_observation):
         data["observation_datetime"]
         == groundwater_level_observation.observation_datetime
     )
-    assert data["observed_property"] == groundwater_level_observation.observed_property
+    colon_index = groundwater_level_observation.observed_property.find(":")
+    assert (
+        data["observed_property"]
+        == groundwater_level_observation.observed_property[colon_index + 1 :]
+    )
     assert data["release_status"] == groundwater_level_observation.release_status
     assert data["level_status"] == groundwater_level_observation.level_status
     assert data["value"] == groundwater_level_observation.value
@@ -416,7 +421,7 @@ def test_get_groundwater_level_observation_by_id_404_wrong_observation_class(
         assert response.status_code == 404
         data = response.json()
 
-        if obs.observed_property == "temperature":
+        if obs.observed_property == "geothermal:temperature":
             actual_observation_class = "geothermal"
         else:
             actual_observation_class = "water chemistry"
@@ -512,9 +517,10 @@ def test_get_water_chemistry_observations(water_chemistry_observation):
         data["items"][0]["observation_datetime"]
         == water_chemistry_observation.observation_datetime
     )
+    colon_index = water_chemistry_observation.observed_property.find(":")
     assert (
         data["items"][0]["observed_property"]
-        == water_chemistry_observation.observed_property
+        == water_chemistry_observation.observed_property[colon_index + 1 :]
     )
     assert data["items"][0]["value"] == water_chemistry_observation.value
     assert data["items"][0]["unit"] == water_chemistry_observation.unit
@@ -535,7 +541,11 @@ def test_get_water_chemistry_observation_by_id(water_chemistry_observation):
     assert (
         data["observation_datetime"] == water_chemistry_observation.observation_datetime
     )
-    assert data["observed_property"] == water_chemistry_observation.observed_property
+    colon_index = water_chemistry_observation.observed_property.find(":")
+    assert (
+        data["observed_property"]
+        == water_chemistry_observation.observed_property[colon_index + 1 :]
+    )
     assert data["value"] == water_chemistry_observation.value
     assert data["unit"] == water_chemistry_observation.unit
 
@@ -558,12 +568,10 @@ def test_get_water_chemistry_observation_by_id_404_wrong_observation_class(
         assert response.status_code == 404
         data = response.json()
 
-        if obs.observed_property == "groundwater level":
+        if obs.observed_property == "groundwater level:groundwater level":
             actual_observation_class = "groundwater level"
-        elif obs.observed_property == "temperature":
-            actual_observation_class = "geothermal"
         else:
-            url = f"/observation/water-chemistry/{obs.id}"
+            actual_observation_class = "geothermal"
 
         assert (
             data["detail"][0]["msg"]
@@ -586,9 +594,10 @@ def test_get_geothermal_observations(geothermal_observation):
         data["items"][0]["observation_datetime"]
         == geothermal_observation.observation_datetime
     )
+    colon_index = geothermal_observation.observed_property.find(":")
     assert (
         data["items"][0]["observed_property"]
-        == geothermal_observation.observed_property
+        == geothermal_observation.observed_property[colon_index + 1 :]
     )
     assert data["items"][0]["value"] == geothermal_observation.value
     assert data["items"][0]["unit"] == geothermal_observation.unit
@@ -609,7 +618,11 @@ def test_get_geothermal_observation_by_id(geothermal_observation):
     assert data["sample_id"] == geothermal_observation.sample_id
     assert data["sensor_id"] == geothermal_observation.sensor_id
     assert data["observation_datetime"] == geothermal_observation.observation_datetime
-    assert data["observed_property"] == geothermal_observation.observed_property
+    colon_index = geothermal_observation.observed_property.find(":")
+    assert (
+        data["observed_property"]
+        == geothermal_observation.observed_property[colon_index + 1 :]
+    )
     assert data["value"] == geothermal_observation.value
     assert data["unit"] == geothermal_observation.unit
     assert data["observation_depth"] == geothermal_observation.observation_depth
@@ -631,7 +644,7 @@ def test_get_geothermal_observation_by_id_404_wrong_observation_class(
         assert response.status_code == 404
         data = response.json()
 
-        if obs.observed_property == "groundwater level":
+        if obs.observed_property == "groundwater level:groundwater level":
             actual_observation_class = "groundwater level"
         else:
             actual_observation_class = "water chemistry"