HDXDSYS-753 switch * with all and fix tests

changelog.md

@@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Changes
 - Add unit to food\_price table primary key
+- Rewrite enums to use values rather than variable names
+- Switch from "*" to "all" for rollup in enums
+- Add "intersectoral" to sample sector data (distinct from "all")
+- Ensure that constraint names end consistently with "\_constraint"
 
 ## 0.8.6
 

src/hapi_schema/db_conflict_event.py

@@ -4,7 +4,6 @@
 
 from sqlalchemy import (
     DateTime,
-    Enum,
     ForeignKey,
     Integer,
     select,
@@ -18,7 +17,7 @@
     population_constraint,
     reference_period_constraint,
 )
-from hapi_schema.utils.enums import EventType
+from hapi_schema.utils.enums import EventType, build_enum_using_values
 from hapi_schema.utils.view_params import ViewParams
 
 
@@ -43,7 +42,7 @@ class DBConflictEvent(Base):
         primary_key=True,
     )
     event_type: Mapped[EventType] = mapped_column(
-        Enum(EventType), nullable=False, primary_key=True
+        build_enum_using_values(EventType), nullable=False, primary_key=True
     )
     events: Mapped[int] = mapped_column(Integer, nullable=True, index=True)
     fatalities: Mapped[int] = mapped_column(Integer, nullable=True, index=True)

src/hapi_schema/db_funding.py

@@ -24,15 +24,15 @@ class DBFunding(Base):
     __table_args__ = (
         CheckConstraint(
             "requirements_usd >= 0.0",
-            name="requirements_usd",
+            name="requirements_usd_constraint",
         ),
         CheckConstraint(
             "funding_usd >= 0.0",
-            name="funding_usd",
+            name="funding_usd_constraint",
         ),
         CheckConstraint(
             "funding_pct >= 0.0",
-            name="funding_pct",
+            name="funding_pct_constraint",
         ),
         reference_period_constraint(),
     )

src/hapi_schema/db_national_risk.py

@@ -32,7 +32,8 @@ class DBNationalRisk(Base):
         general_risk_constraint("vulnerability"),
         general_risk_constraint("coping_capacity"),
         CheckConstraint(
-            "(global_rank >= 1) AND (global_rank <= 250)", name="global_rank"
+            "(global_rank >= 1) AND (global_rank <= 250)",
+            name="global_rank_constraint",
         ),
         CheckConstraint(
             "meta_avg_recentness_years >= 0.0",

src/hapi_schema/db_poverty_rate.py

@@ -34,7 +34,7 @@ class DBPovertyRate(Base):
         reference_period_constraint(),
         CheckConstraint(
             sqltext="ABS(headcount_ratio / 100 * intensity_of_deprivation / 100  - mpi) < 0.00001",
-            name="mpi_product",
+            name="mpi_product_constraint",
         ),
     )
 

src/hapi_schema/utils/constraints.py

@@ -9,8 +9,8 @@ def min_age_constraint() -> CheckConstraint:
     Otherwise, it can be NULL for unknown, or should be an
     integer of 0 or greater."""
     sqltext = (
-        "(age_range = '*' AND min_age IS NULL) OR "
-        "(age_range != '*' AND (min_age >= 0 OR min_age is NULL))"
+        "(age_range = 'all' AND min_age IS NULL) OR "
+        "(age_range != 'all' AND min_age >= 0)"
     )
     return CheckConstraint(sqltext=sqltext, name="min_age_constraint")
 
@@ -32,31 +32,35 @@ def population_constraint(
 ) -> CheckConstraint:
     """Population must not be a negative number."""
     sqltext = f"{population_var_name} >= 0"
-    return CheckConstraint(sqltext=sqltext, name=f"{population_var_name}")
+    return CheckConstraint(
+        sqltext=sqltext, name=f"{population_var_name}_constraint"
+    )
 
 
 def non_negative_constraint(
     var_name: str,
 ) -> CheckConstraint:
     """Require a column to be non-negative."""
     sqltext = f"{var_name} >= 0"
-    return CheckConstraint(sqltext=sqltext, name=f"{var_name}")
+    return CheckConstraint(sqltext=sqltext, name=f"{var_name}_constraint")
 
 
 def percentage_constraint(var_name: str) -> CheckConstraint:
     sqltext = f"{var_name} >= 0. AND {var_name} <= 100."
-    return CheckConstraint(sqltext=sqltext, name=f"{var_name}")
+    return CheckConstraint(sqltext=sqltext, name=f"{var_name}_constraint")
 
 
 def reference_period_constraint() -> CheckConstraint:
     """reference_period_end should be greater than reference_period_start"""
     sqltext = "reference_period_end >= reference_period_start "
-    return CheckConstraint(sqltext=sqltext, name="reference_period")
+    return CheckConstraint(sqltext=sqltext, name="reference_period_constraint")
 
 
 def general_risk_constraint(risk_name: str) -> CheckConstraint:
     sqltext = f"({risk_name}_risk >= 0) AND ({risk_name}_risk <= 10)"
-    return CheckConstraint(sqltext=sqltext, name=f"{risk_name}_risk")
+    return CheckConstraint(
+        sqltext=sqltext, name=f"{risk_name}_risk_constraint"
+    )
 
 
 def code_and_reference_period_unique_constraint(
@@ -65,11 +69,11 @@ def code_and_reference_period_unique_constraint(
     return UniqueConstraint(
         "code",
         "reference_period_start",
-        name=f"{admin_level}_code_and_reference_period_unique",
+        name=f"{admin_level}_code_and_reference_period_unique_constraint",
     )
 
 
 def latlon_constraint() -> CheckConstraint:
     """Latitude and longitude must be valid"""
     sqltext = "lat <= 90.0 AND lat >= -90.0 AND lon <= 180.0 AND lon >= -180.0"
-    return CheckConstraint(sqltext=sqltext, name="latlon")
+    return CheckConstraint(sqltext=sqltext, name="latlon_constraint")

src/hapi_schema/utils/enums.py

@@ -1,28 +1,41 @@
-import enum
+from enum import Enum as PythonEnum
+from typing import List
 
+from sqlalchemy import Enum as SQLAlchemyEnum
 
-class Gender(str, enum.Enum):
+"""The two functions below create enums using the values rather than the keys"""
+
+
+def _get_list_of_values(enum_class: PythonEnum) -> List[str]:
+    return [e.value for e in enum_class]
+
+
+def build_enum_using_values(enum_class: PythonEnum) -> SQLAlchemyEnum:
+    return SQLAlchemyEnum(enum_class, values_callable=_get_list_of_values)
+
+
+class Gender(str, PythonEnum):
     FEMALE = "f"
     MALE = "m"
     NONBINARY = "x"
     UNSPECIFIED = "u"
     OTHER = "o"
-    ALL = "*"
+    ALL = "all"
 
 
-class DisabledMarker(str, enum.Enum):
+class DisabledMarker(str, PythonEnum):
     YES = "y"
     NO = "n"
-    ALL = "*"
+    ALL = "all"
 
 
-class EventType(str, enum.Enum):
+class EventType(str, PythonEnum):
     CIVILIAN_TARGETING = "civilian_targeting"
     DEMONSTRATION = "demonstration"
     POLITICAL_VIOLENCE = "political_violence"
 
 
-class PopulationGroup(str, enum.Enum):
+class PopulationGroup(str, PythonEnum):
     REFUGEES = "REF"
     ROC = "ROC"
     ASYLUM_SEEKERS = "ASY"
@@ -38,55 +51,55 @@ class PopulationGroup(str, enum.Enum):
     POC = "POC"
     RDP = "RDP"
     RRI = "RRI"
-    ALL = "*"
+    ALL = "all"
 
 
-class PopulationStatus(str, enum.Enum):
+class PopulationStatus(str, PythonEnum):
     POPULATION = "POP"
     AFFECTED = "AFF"
     INNEED = "INN"
     TARGETED = "TGT"
     REACHED = "REA"
-    ALL = "*"
+    ALL = "all"
 
 
-class PriceFlag(str, enum.Enum):
+class PriceFlag(str, PythonEnum):
     ACTUAL = "actual"
     AGGREGATE = "aggregate"
     ACTUAL_AGGREGATE = "actual,aggregate"
 
 
-class PriceType(str, enum.Enum):
+class PriceType(str, PythonEnum):
     FARM_GATE = "Farm Gate"
     RETAIL = "Retail"
     WHOLESALE = "Wholesale"
 
 
-class IPCPhase(str, enum.Enum):
+class IPCPhase(str, PythonEnum):
     PHASE_1 = "1"
     PHASE_2 = "2"
     PHASE_3 = "3"
     PHASE_4 = "4"
     PHASE_5 = "5"
     PHASE_3_PLUS = "3+"
-    ALL = "*"
+    ALL = "all"
 
 
-class IPCType(str, enum.Enum):
+class IPCType(str, PythonEnum):
     CURRENT = "current"
     FIRST_PROJECTION = "first projection"
     SECOND_PROJECTION = "second projection"
 
 
-class RiskClass(str, enum.Enum):
+class RiskClass(str, PythonEnum):
     VERY_LOW = "1"
     LOW = "2"
     MEDIUM = "3"
     HIGH = "4"
     VERY_HIGH = "5"
 
 
-class CommodityCategory(str, enum.Enum):
+class CommodityCategory(str, PythonEnum):
     CEREALS_TUBERS = "cereals and tubers"
     MEAT_FISH_EGGS = "meat, fish and eggs"
     MILK_DAIRY = "milk and dairy"

tests/sample_data/data_humanitarian_needs.py

@@ -5,11 +5,11 @@
     dict(
         resource_hdx_id="90deb235-1bf5-4bae-b231-3393222c2d01",
         admin2_ref=1,
-        gender="*",
-        age_range="*",
-        disabled_marker="*",
-        sector_code="*",
-        population_group="*",
+        gender="all",
+        age_range="all",
+        disabled_marker="all",
+        sector_code="intersectoral",
+        population_group="all",
         population_status="AFF",
         population=1_000_000,
         reference_period_start=datetime(2023, 1, 1),
@@ -20,7 +20,7 @@
         resource_hdx_id="90deb235-1bf5-4bae-b231-3393222c2d01",
         admin2_ref=1,
         gender="f",
-        age_range="*",
+        age_range="all",
         disabled_marker="n",
         sector_code="SHL",
         population_group="REF",
@@ -49,7 +49,7 @@
     dict(
         resource_hdx_id="90deb235-1bf5-4bae-b231-3393222c2d01",
         admin2_ref=4,
-        gender="*",
+        gender="all",
         age_range="80+",
         min_age=80,
         disabled_marker="y",

tests/sample_data/data_population.py

@@ -5,8 +5,8 @@
     dict(
         resource_hdx_id="90deb235-1bf5-4bae-b231-3393222c2d01",
         admin2_ref=1,
-        gender="*",
-        age_range="*",
+        gender="all",
+        age_range="all",
         population=1_000_000,
         reference_period_start=datetime(2023, 1, 1),
         reference_period_end=datetime(2023, 6, 30),
@@ -16,7 +16,7 @@
         resource_hdx_id="90deb235-1bf5-4bae-b231-3393222c2d01",
         admin2_ref=1,
         gender="f",
-        age_range="*",
+        age_range="all",
         population=500_000,
         reference_period_start=datetime(2023, 1, 1),
         reference_period_end=datetime(2023, 6, 30),
@@ -37,7 +37,7 @@
     dict(
         resource_hdx_id="90deb235-1bf5-4bae-b231-3393222c2d01",
         admin2_ref=4,
-        gender="*",
+        gender="all",
         age_range="80+",
         min_age=80,
         population=500,

tests/sample_data/data_sector.py

@@ -16,7 +16,7 @@
         name="Health",
     ),
     dict(
-        code="*",
-        name="All",
+        code="intersectoral",
+        name="Intersectoral",
     ),
 ]

tests/test_admin1.py

@@ -42,7 +42,7 @@ def test_reference_period_constraint(run_constraints_test):
                 reference_period_end=datetime(2023, 1, 1),
             )
         ],
-        expected_constraint="reference_period",
+        expected_constraint="reference_period_constraint",
     )
 
 
@@ -65,5 +65,5 @@ def test_code_date_unique(run_constraints_test):
                 reference_period_start=datetime(2023, 1, 1),
             ),
         ],
-        expected_constraint="admin1_code_and_reference_period_unique",
+        expected_constraint="admin1_code_and_reference_period_unique_constraint",
     )

tests/test_admin2.py

@@ -43,7 +43,7 @@ def test_reference_period_constraint(run_constraints_test):
                 reference_period_end=datetime(2023, 1, 1),
             )
         ],
-        expected_constraint="reference_period",
+        expected_constraint="reference_period_constraint",
     )
 
 
@@ -66,5 +66,5 @@ def test_code_date_unique(run_constraints_test):
                 reference_period_start=datetime(2023, 1, 1),
             ),
         ],
-        expected_constraint="admin2_code_and_reference_period_unique",
+        expected_constraint="admin2_code_and_reference_period_unique_constraint",
     )

tests/test_conflict_event.py

@@ -46,7 +46,7 @@ def test_events_constraint(run_constraints_test):
         new_rows=[
             DBConflictEvent(**data),
         ],
-        expected_constraint="events",
+        expected_constraint="events_constraint",
     )
 
 
@@ -58,7 +58,7 @@ def test_fatalities_constraint(run_constraints_test):
         new_rows=[
             DBConflictEvent(**data),
         ],
-        expected_constraint="fatalities",
+        expected_constraint="fatalities_constraint",
     )
 
 
@@ -70,5 +70,5 @@ def test_reference_period_constraint(run_constraints_test):
         new_rows=[
             DBConflictEvent(**data),
         ],
-        expected_constraint="reference_period",
+        expected_constraint="reference_period_constraint",
     )