Merge pull request #218 from American-Institutes-for-Research/HEA-772/end_point_for_baseline_wealthcharactersics

Hea 772/end point for baseline wealthcharactersics

Author: rhunwicks

apps/baseline/migrations/0023_baselinewealthgroupcharacteristicvalue_and_more.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.2.9 on 2026-01-13 17:58
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("baseline", "0022_alter_wealthgroup_options"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="BaselineWealthGroupCharacteristicValue",
+            fields=[],
+            options={
+                "verbose_name": "Baseline Wealth Group Characteristic Value",
+                "verbose_name_plural": "Baseline Wealth Group Characteristic Values",
+                "proxy": True,
+                "indexes": [],
+                "constraints": [],
+            },
+            bases=("baseline.wealthgroupcharacteristicvalue",),
+        ),
+        migrations.CreateModel(
+            name="CommunityWealthGroupCharacteristicValue",
+            fields=[],
+            options={
+                "verbose_name": "Community Wealth Group Characteristic Value",
+                "verbose_name_plural": "Community Wealth Group Characteristic Values",
+                "proxy": True,
+                "indexes": [],
+                "constraints": [],
+            },
+            bases=("baseline.wealthgroupcharacteristicvalue",),
+        ),
+    ]

apps/baseline/models.py

@@ -843,6 +843,56 @@ class Meta:
         ]
 
 
+class BaselineWealthGroupCharacteristicValueManager(InheritanceManager):
+    def get_queryset(self):
+        return super().get_queryset().filter(wealth_group__community__isnull=True).select_subclasses()
+
+
+class BaselineWealthGroupCharacteristicValue(WealthGroupCharacteristicValue):
+    """
+    An attribute of a Baseline Wealth Group such as the number of school-age children.
+    """
+
+    objects = BaselineWealthGroupCharacteristicValueManager()
+
+    def clean(self):
+        if self.wealth_group.community:
+            raise ValidationError(
+                _("A Baseline Wealth Group Characteristic Value cannot be for a Community Wealth Group")
+            )
+        super().clean()
+
+    class Meta:
+        verbose_name = _("Baseline Wealth Group Characteristic Value")
+        verbose_name_plural = _("Baseline Wealth Group Characteristic Values")
+        proxy = True
+
+
+class CommunityWealthGroupCharacteristicValueManager(InheritanceManager):
+    def get_queryset(self):
+        return super().get_queryset().exclude(wealth_group__community__isnull=True).select_subclasses()
+
+
+class CommunityWealthGroupCharacteristicValue(WealthGroupCharacteristicValue):
+    """
+    An attribute of a Community Wealth Group such as the number of school-age children.
+    """
+
+    objects = CommunityWealthGroupCharacteristicValueManager()
+
+    def clean(self):
+        if not self.wealth_group.community:
+            raise ValidationError(
+                _("A Community Wealth Group Characteristic Value must be for a Community Wealth Group")
+            )
+        super().clean()
+
+    class Meta:
+        verbose_name = _("Community Wealth Group Characteristic Value")
+        verbose_name_plural = _("Community Wealth Group Characteristic Values")
+        proxy = True
+
+
 class LivelihoodStrategyManager(common_models.IdentifierManager):
     def get_by_natural_key(
         self,

apps/baseline/serializers.py

@@ -8,11 +8,13 @@
 from .models import (
     BaselineLivelihoodActivity,
     BaselineWealthGroup,
+    BaselineWealthGroupCharacteristicValue,
     ButterProduction,
     Community,
     CommunityCropProduction,
     CommunityLivestock,
     CommunityWealthGroup,
+    CommunityWealthGroupCharacteristicValue,
     CopingStrategy,
     CropProduction,
     Event,
@@ -359,6 +361,12 @@ class Meta:
             "wealth_characteristic",
             "wealth_characteristic_name",
             "wealth_characteristic_description",
+            "variable_type",
+            "characteristic_group",
+            "product",
+            "product_common_name",
+            "unit_of_measure",
+            "unit_of_measure_description",
             "value",
             "min_value",
             "max_value",
@@ -389,6 +397,7 @@ def get_wealth_group_label(self, obj):
     wealth_characteristic_description = serializers.CharField(
         source="wealth_characteristic.description", read_only=True
     )
+    variable_type = serializers.CharField(source="wealth_characteristic.variable_type", read_only=True)
     livelihood_zone_baseline = serializers.IntegerField(
         source="wealth_group.community.livelihood_zone_baseline.pk", read_only=True
     )
@@ -413,6 +422,132 @@ def get_wealth_group_label(self, obj):
     source_organization_name = serializers.CharField(
         source="wealth_group.community.livelihood_zone_baseline.source_organization.name", read_only=True
     )
+    characteristic_group = serializers.SerializerMethodField()
+
+    def get_characteristic_group(self, obj):
+        """
+        Override the default characteristic_group for Livestock and Poultry.
+
+        This allows us to use the same wealth characteristic, e.g. 'Number owned' for both Livestock and Poultry,
+        as well as other wealth characteristics.
+        """
+        if obj.product and obj.product.cpc.startswith("L0215"):
+            return "Poultry"
+        if obj.product and obj.product.cpc.startswith("L02"):
+            return "Livestock"
+        return obj.wealth_characteristic.characteristic_group
+
+    product_common_name = serializers.CharField(source="product.common_name", read_only=True, allow_null=True)
+    unit_of_measure_description = serializers.CharField(
+        source="unit_of_measure.description", read_only=True, allow_null=True
+    )
+
+
+class BaselineWealthGroupCharacteristicValueSerializer(serializers.ModelSerializer):
+
+    class Meta:
+        model = BaselineWealthGroupCharacteristicValue
+        fields = [
+            "id",
+            "wealth_group",
+            "wealth_group_label",
+            "source_organization",
+            "source_organization_name",
+            "livelihood_zone_baseline",
+            "livelihood_zone_baseline_label",
+            "livelihood_zone",
+            "livelihood_zone_name",
+            "livelihood_zone_country_code",
+            "livelihood_zone_country_name",
+            "wealth_group_category",
+            "wealth_group_category_name",
+            "wealth_group_category_description",
+            "wealth_characteristic",
+            "wealth_characteristic_name",
+            "wealth_characteristic_description",
+            "variable_type",
+            "characteristic_group",
+            "product",
+            "product_common_name",
+            "unit_of_measure",
+            "unit_of_measure_description",
+            "value",
+            "min_value",
+            "max_value",
+        ]
+
+    livelihood_zone_baseline_label = serializers.SerializerMethodField()
+
+    def get_livelihood_zone_baseline_label(self, obj):
+        return (
+            str(obj.wealth_group.livelihood_zone_baseline)
+            if obj.wealth_group.community
+            else str(obj.wealth_group.livelihood_zone_baseline)
+        )
+
+    wealth_group_label = serializers.SerializerMethodField()
+
+    def get_wealth_group_label(self, obj):
+        return str(obj.wealth_group)
+
+    wealth_group_category = serializers.CharField(source="wealth_group.wealth_group_category.pk", read_only=True)
+    wealth_group_category_name = serializers.CharField(
+        source="wealth_group.wealth_group_category.name", read_only=True
+    )
+    wealth_group_category_description = serializers.CharField(
+        source="wealth_group.wealth_group_category.description", read_only=True
+    )
+    wealth_characteristic_name = serializers.CharField(source="wealth_characteristic.name", read_only=True)
+    wealth_characteristic_description = serializers.CharField(
+        source="wealth_characteristic.description", read_only=True
+    )
+    variable_type = serializers.CharField(source="wealth_characteristic.variable_type", read_only=True)
+    livelihood_zone_baseline = serializers.IntegerField(
+        source="wealth_group.livelihood_zone_baseline.pk", read_only=True
+    )
+    livelihood_zone_name = serializers.CharField(
+        source="wealth_group.livelihood_zone_baseline.livelihood_zone.name", read_only=True
+    )
+    livelihood_zone = serializers.CharField(
+        source="wealth_group.livelihood_zone_baseline.livelihood_zone.pk", read_only=True
+    )
+    livelihood_zone_country_code = serializers.CharField(
+        source="wealth_group.livelihood_zone_baseline.livelihood_zone.country.pk", read_only=True
+    )
+    livelihood_zone_country_name = serializers.CharField(
+        source="wealth_group.livelihood_zone_baseline.livelihood_zone.country.name", read_only=True
+    )
+    source_organization = serializers.IntegerField(
+        source="wealth_group.livelihood_zone_baseline.source_organization.pk", read_only=True
+    )
+    source_organization_name = serializers.CharField(
+        source="wealth_group.livelihood_zone_baseline.source_organization.name", read_only=True
+    )
+    characteristic_group = serializers.SerializerMethodField()
+
+    def get_characteristic_group(self, obj):
+        """
+        Override the default characteristic_group for Livestock and Poultry.
+
+        This allows us to use the same wealth characteristic, e.g. 'Number owned' for both Livestock and Poultry,
+        as well as other wealth characteristics.
+        """
+        if obj.product and obj.product.cpc.startswith("L0215"):
+            return "Poultry"
+        if obj.product and obj.product.cpc.startswith("L02"):
+            return "Livestock"
+        return obj.wealth_characteristic.characteristic_group
+
+    product_common_name = serializers.CharField(source="product.common_name", read_only=True, allow_null=True)
+    unit_of_measure_description = serializers.CharField(
+        source="unit_of_measure.description", read_only=True, allow_null=True
+    )
+
+
+class CommunityWealthGroupCharacteristicValueSerializer(WealthGroupCharacteristicValueSerializer):
+    class Meta:
+        model = CommunityWealthGroupCharacteristicValue
+        fields = WealthGroupCharacteristicValueSerializer.Meta.fields
 
 
 class LivelihoodStrategySerializer(serializers.ModelSerializer):
@@ -439,7 +574,6 @@ class Meta:
             "product_common_name",
             "product_description",
             "unit_of_measure",
-            "unit_of_measure_name",
             "unit_of_measure_description",
             "currency",
             "additional_identifier",
@@ -461,7 +595,6 @@ class Meta:
     source_organization_name = serializers.CharField(
         source="livelihood_zone_baseline.source_organization.name", read_only=True
     )
-    unit_of_measure_name = serializers.CharField(source="unit_of_measure.name", read_only=True)
     unit_of_measure_description = serializers.CharField(source="unit_of_measure.description", read_only=True)
     product_common_name = serializers.CharField(source="product.common_name", read_only=True)
     product_description = serializers.CharField(source="product.description", read_only=True)
@@ -510,7 +643,6 @@ class Meta:
             "product_common_name",
             "product_description",
             "unit_of_measure",
-            "unit_of_measure_name",
             "unit_of_measure_description",
             "currency",
             "additional_identifier",
@@ -570,7 +702,6 @@ def get_livelihood_zone_baseline_label(self, obj):
     community_name = serializers.CharField(source="wealth_group.community.name", read_only=True)
     community_full_name = serializers.CharField(source="wealth_group.community.full_name", read_only=True)
     unit_of_measure = serializers.CharField(source="livelihood_strategy.unit_of_measure.pk", read_only=True)
-    unit_of_measure_name = serializers.CharField(source="livelihood_strategy.unit_of_measure.name", read_only=True)
     unit_of_measure_description = serializers.CharField(
         source="livelihood_strategy.unit_of_measure.description", read_only=True
     )
@@ -910,19 +1041,15 @@ class Meta:
             "yield_without_inputs",
             "seed_requirement",
             "crop_unit_of_measure",
-            "crop_unit_of_measure_name",
             "crop_unit_of_measure_description",
             "land_unit_of_measure",
-            "land_unit_of_measure_name",
             "land_unit_of_measure_description",
         ]
 
     crop_common_name = serializers.CharField(source="crop.common_name", read_only=True)
     crop_description = serializers.CharField(source="crop.description", read_only=True)
     community_name = serializers.CharField(source="community.name", read_only=True)
-    crop_unit_of_measure_name = serializers.CharField(source="crop_unit_of_measure.name", read_only=True)
     crop_unit_of_measure_description = serializers.CharField(source="crop_unit_of_measure.description", read_only=True)
-    land_unit_of_measure_name = serializers.CharField(source="land_unit_of_measure.name", read_only=True)
     land_unit_of_measure_description = serializers.CharField(source="land_unit_of_measure.description", read_only=True)
     season_name = serializers.CharField(source="season.name", read_only=True)
     season_description = serializers.CharField(source="season.description", read_only=True)
@@ -1040,7 +1167,6 @@ class Meta:
             "product_common_name",
             "product_description",
             "unit_of_measure",
-            "unit_of_measure_name",
             "unit_of_measure_description",
             "currency",
             "description",
@@ -1057,7 +1183,6 @@ class Meta:
     product = serializers.CharField(source="product.pk", read_only=True)
     product_common_name = serializers.CharField(source="product.common_name", read_only=True)
     product_description = serializers.CharField(source="product.description", read_only=True)
-    unit_of_measure_name = serializers.CharField(source="unit_of_measure.name", read_only=True)
     unit_of_measure_description = serializers.CharField(source="unit_of_measure.description", read_only=True)
     livelihood_zone_baseline = serializers.IntegerField(source="community.livelihood_zone_baseline.pk", read_only=True)
     livelihood_zone_name = serializers.CharField(
@@ -1274,7 +1399,6 @@ class Meta:
             "product_common_name",
             "product_description",
             "unit_of_measure",
-            "unit_of_measure_name",
             "unit_of_measure_description",
             "currency",
             "additional_identifier",
@@ -1329,7 +1453,6 @@ def get_livelihood_zone_baseline_label(self, obj):
     community = serializers.IntegerField(source="wealth_group.community.pk", read_only=True)
     community_name = serializers.CharField(source="wealth_group.community.name", read_only=True)
     unit_of_measure = serializers.CharField(source="livelihood_strategy.unit_of_measure.pk", read_only=True)
-    unit_of_measure_name = serializers.CharField(source="livelihood_strategy.unit_of_measure.name", read_only=True)
     unit_of_measure_description = serializers.CharField(
         source="livelihood_strategy.unit_of_measure.description", read_only=True
     )
@@ -1408,7 +1531,6 @@ class Meta:
             "product_common_name",
             "product_description",
             "unit_of_measure",
-            "unit_of_measure_name",
             "unit_of_measure_description",
             "currency",
             "additional_identifier",
@@ -1445,7 +1567,6 @@ def get_livelihood_zone_baseline_label(self, obj):
     additional_identifier = serializers.CharField(source="livelihood_strategy.additional_identifier", read_only=True)
     currency = serializers.CharField(source="livelihood_strategy.currency.pk", read_only=True)
     unit_of_measure = serializers.CharField(source="livelihood_strategy.unit_of_measure.pk", read_only=True)
-    unit_of_measure_name = serializers.CharField(source="livelihood_strategy.unit_of_measure.name", read_only=True)
     unit_of_measure_description = serializers.CharField(
         source="livelihood_strategy.unit_of_measure.description", read_only=True
     )