Merge pull request #259 from American-Institutes-for-Research/HEA-984/Livelihood_activity_valid_instances_errors_for_income_not_rounding_error

Hea 984/livelihood activity valid instances errors for income not rounding error

Author: rhunwicks

apps/baseline/migrations/0030_alter_foodpurchase_unit_multiple_and_more.py

@@ -0,0 +1,73 @@
+# Generated by Django 5.2.12 on 2026-04-04 12:57
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("baseline", "0029_alter_meatproduction_animals_slaughtered_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name="foodpurchase",
+            name="unit_multiple",
+            field=models.FloatField(
+                blank=True,
+                help_text="Multiple of the unit of measure in a single purchase",
+                null=True,
+                verbose_name="Unit Multiple",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="livelihoodactivity",
+            name="quantity_consumed",
+            field=models.FloatField(blank=True, null=True, verbose_name="Quantity Consumed"),
+        ),
+        migrations.AlterField(
+            model_name="livelihoodactivity",
+            name="quantity_other_uses",
+            field=models.FloatField(blank=True, null=True, verbose_name="Quantity Other Uses"),
+        ),
+        migrations.AlterField(
+            model_name="livelihoodactivity",
+            name="quantity_produced",
+            field=models.FloatField(blank=True, null=True, verbose_name="Quantity Produced"),
+        ),
+        migrations.AlterField(
+            model_name="livelihoodactivity",
+            name="quantity_purchased",
+            field=models.FloatField(blank=True, null=True, verbose_name="Quantity Purchased"),
+        ),
+        migrations.AlterField(
+            model_name="livelihoodactivity",
+            name="quantity_sold",
+            field=models.FloatField(blank=True, null=True, verbose_name="Quantity Sold/Exchanged"),
+        ),
+        migrations.AlterField(
+            model_name="milkproduction",
+            name="quantity_butter_production",
+            field=models.FloatField(blank=True, null=True, verbose_name="Quantity used for Butter Production"),
+        ),
+        migrations.AlterField(
+            model_name="otherpurchase",
+            name="unit_multiple",
+            field=models.FloatField(
+                blank=True,
+                help_text="Multiple of the unit of measure in a single purchase",
+                null=True,
+                verbose_name="Unit Multiple",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="reliefgiftother",
+            name="unit_multiple",
+            field=models.FloatField(
+                blank=True,
+                help_text="Multiple of the unit of measure received each time",
+                null=True,
+                verbose_name="Unit Multiple",
+            ),
+        ),
+    ]

apps/baseline/models.py

@@ -3,6 +3,7 @@
 """
 
 import datetime
+import math
 import numbers
 
 from django.conf import settings
@@ -1172,13 +1173,13 @@ class LivelihoodActivity(common_models.Model):
     wealth_group = models.ForeignKey(WealthGroup, on_delete=models.CASCADE, help_text=_("Wealth Group"))
 
     # Also used for the quantity received for the PaymentInKind and ReliefGiftsOther Livelihood Strategies
-    quantity_produced = models.PositiveIntegerField(blank=True, null=True, verbose_name=_("Quantity Produced"))
-    quantity_purchased = models.PositiveIntegerField(blank=True, null=True, verbose_name=_("Quantity Purchased"))
-    quantity_sold = models.PositiveIntegerField(blank=True, null=True, verbose_name=_("Quantity Sold/Exchanged"))
-    quantity_other_uses = models.PositiveIntegerField(blank=True, null=True, verbose_name=_("Quantity Other Uses"))
+    quantity_produced = models.FloatField(blank=True, null=True, verbose_name=_("Quantity Produced"))
+    quantity_purchased = models.FloatField(blank=True, null=True, verbose_name=_("Quantity Purchased"))
+    quantity_sold = models.FloatField(blank=True, null=True, verbose_name=_("Quantity Sold/Exchanged"))
+    quantity_other_uses = models.FloatField(blank=True, null=True, verbose_name=_("Quantity Other Uses"))
     # Can normally be calculated / validated as `quantity_produced + quantity_purchased - quantity_sold - quantity_other_uses`  # NOQA: E501
     # but there are exceptions, such as MilkProduction which also stores MilkProduction.quantity_butter_production
-    quantity_consumed = models.PositiveIntegerField(blank=True, null=True, verbose_name=_("Quantity Consumed"))
+    quantity_consumed = models.FloatField(blank=True, null=True, verbose_name=_("Quantity Consumed"))
 
     price = models.FloatField(
         blank=True,
@@ -1356,19 +1357,17 @@ def validate_quantity_consumed(self):
         )
 
         # Check if the actual quantity_consumed matches the expected quantity_consumed
-        if self.quantity_consumed and self.quantity_consumed != expected_quantity_consumed:
+        if self.quantity_consumed and not math.isclose(self.quantity_consumed, expected_quantity_consumed):
             if quantity_butter_production:
                 message = "Quantity consumed for Milk Production must be quantity produced + quantity purchased - quantity sold - quantity used for butter production - quantity used for other things"  # NOQA: E501
             else:
                 message = "Quantity consumed for a Livelihood Activity must be quantity produced + quantity purchased - quantity sold - quantity used for other things"  # NOQA: E501
             raise ValidationError(_(message))
 
     def validate_income(self):
-        income = self.income or 0
-        quantity_sold = self.quantity_sold or 0
-        price = self.price or 0
-        if self.income and income != quantity_sold * price:
-            raise ValidationError(_("Income for a Livelihood Activity must be quantity sold multiplied by price"))
+        if self.income and self.quantity_sold is not None and self.price is not None:
+            if not math.isclose(self.income, self.quantity_sold * self.price):
+                raise ValidationError(_("Income for a Livelihood Activity must be quantity sold multiplied by price"))
 
     def validate_expenditure(self):
         """
@@ -1386,7 +1385,7 @@ def validate_expenditure(self):
         price = self.price or 0
         expenditure = self.expenditure or 0
 
-        if self.expenditure and expenditure != quantity_produced * price:
+        if self.expenditure and not math.isclose(expenditure, quantity_produced * price):
             raise ValidationError(
                 _("Expenditure for a Livelihood Activity must be quantity produced multiplied by price")
             )
@@ -1409,9 +1408,9 @@ def validate_kcals_consumed(self):
                         "product": self.livelihood_strategy.product,
                     }
                 )
-            if (
-                self.kcals_consumed
-                != self.quantity_consumed * conversion_factor * self.livelihood_strategy.product.kcals_per_unit
+            if not math.isclose(
+                self.kcals_consumed,
+                self.quantity_consumed * conversion_factor * self.livelihood_strategy.product.kcals_per_unit,
             ):
                 raise ValidationError(
                     _(
@@ -1637,7 +1636,7 @@ class MilkType(models.TextChoices):
     # https://unstats.un.org/unsd/classifications/Econ/Detail/EN/1074/22110. That LivelihoodActivity would have a
     # `quantity_produced` equal to the amount of whole milk that was used for ButterProduction, and then the
     # quantity_sold and the quantity_consumed could be tracked separately.
-    quantity_butter_production = models.PositiveIntegerField(
+    quantity_butter_production = models.FloatField(
         blank=True, null=True, verbose_name=_("Quantity used for Butter Production")
     )  # NOQA: E501
     type_of_milk_consumed = models.CharField(
@@ -1736,7 +1735,7 @@ def clean(self):
 
     def validate_quantity_produced(self):
         if self.quantity_produced is not None and self.animals_slaughtered and self.carcass_weight is not None:
-            if self.quantity_produced != self.animals_slaughtered * self.carcass_weight:
+            if not math.isclose(self.quantity_produced, self.animals_slaughtered * self.carcass_weight):
                 raise ValidationError(
                     _(
                         "Quantity Produced for a Meat Production must be animals slaughtered multiplied by carcass weight"
@@ -1789,7 +1788,7 @@ class FoodPurchase(LivelihoodActivity):
     # NIO93 Row B422 tia = 2.5kg
 
     # unit_multiple has names like wt_of_measure in the BSS.
-    unit_multiple = models.PositiveSmallIntegerField(
+    unit_multiple = models.FloatField(
         blank=True,
         null=True,
         verbose_name=_("Unit Multiple"),
@@ -1818,7 +1817,9 @@ def validate_quantity_purchased(self):
             and self.times_per_month is not None
             and self.months_per_year is not None
         ):
-            if self.quantity_purchased != self.unit_multiple * self.times_per_month * self.months_per_year:
+            if not math.isclose(
+                self.quantity_purchased, self.unit_multiple * self.times_per_month * self.months_per_year
+            ):
                 raise ValidationError(
                     _(
                         "Quantity purchased for a Food Purchase must be purchase amount * purchases per month * months per year"  # NOQA: E501
@@ -1830,7 +1831,7 @@ def validate_expenditure(self):
         price = self.price or 0
         expenditure = self.expenditure or 0
 
-        if self.expenditure and expenditure != quantity_purchased * price:
+        if self.expenditure and not math.isclose(expenditure, quantity_purchased * price):
             raise ValidationError(_("Expenditure for a Food Purchase must be quantity purchased multiplied by price"))
 
     class Meta:
@@ -1912,9 +1913,9 @@ def validate_quantity_produced(self):
             and self.times_per_month is not None
             and self.months_per_year is not None
         ):
-            if (
-                self.quantity_produced
-                != self.payment_per_time * self.people_per_household * self.times_per_month * self.months_per_year
+            if not math.isclose(
+                self.quantity_produced,
+                self.payment_per_time * self.people_per_household * self.times_per_month * self.months_per_year,
             ):
                 raise ValidationError(
                     _(
@@ -1937,7 +1938,7 @@ class ReliefGiftOther(LivelihoodActivity):
 
     # Production calculation /validation is `unit_of_measure * unit_multiple * times_per_year`
     # Also used for the number of children receiving school meals.
-    unit_multiple = models.PositiveSmallIntegerField(
+    unit_multiple = models.FloatField(
         blank=True,
         null=True,
         verbose_name=_("Unit Multiple"),
@@ -1963,7 +1964,7 @@ class ReliefGiftOther(LivelihoodActivity):
 
     def validate_quantity_produced(self):
         if self.quantity_produced is not None and self.unit_multiple is not None and self.times_per_year is not None:
-            if self.quantity_produced != self.unit_multiple * self.times_per_year:
+            if not math.isclose(self.quantity_produced, self.unit_multiple * self.times_per_year):
                 raise ValidationError(
                     _("Quantity produced for Relief, Gifts, Other must be amount received * times per year")
                 )
@@ -2072,17 +2073,17 @@ def validate_income(self):
             and self.times_per_month is not None
             and self.months_per_year is not None
         ):
-            if (
-                self.income
-                != self.payment_per_time * self.people_per_household * self.times_per_month * self.months_per_year
+            if not math.isclose(
+                self.income,
+                self.payment_per_time * self.people_per_household * self.times_per_month * self.months_per_year,
             ):
                 raise ValidationError(
                     _(
                         "Quantity produced for Other Cash Income must be payment per time * number of people * labor per month * months per year"  # NOQA: E501
                     )
                 )
-        if self.income is not None and self.payment_per_time is not None and self.times_per_year is not None:
-            if self.income != self.payment_per_time * self.times_per_year:
+        elif self.income is not None and self.payment_per_time is not None and self.times_per_year is not None:
+            if not math.isclose(self.income, self.payment_per_time * self.times_per_year):
                 raise ValidationError(_("Income for 'Other Cash Income' must be payment per time * times per year"))
 
     def calculate_fields(self):
@@ -2106,7 +2107,7 @@ class OtherPurchase(LivelihoodActivity):
     # individual fields must be nullable
     # Do we need this, or can we use combined units of measure like FDW, e.g. 5kg
     # NIO93 Row B422 tia = 2.5kg
-    unit_multiple = models.PositiveSmallIntegerField(
+    unit_multiple = models.FloatField(
         blank=True,
         null=True,
         verbose_name=_("Unit Multiple"),
@@ -2132,7 +2133,7 @@ def validate_expenditure(self):
         errors = []
         if self.times_per_month is not None and self.months_per_year is not None:
             expected_times_per_year = self.times_per_month * self.months_per_year
-            if self.times_per_year is not None and self.times_per_year != expected_times_per_year:
+            if self.times_per_year is not None and not math.isclose(self.times_per_year, expected_times_per_year):
                 errors.append(
                     _(
                         "Times per year must be times per month * months per year. Expected: %(expected)s, Found: %(found)s"
@@ -2144,7 +2145,7 @@ def validate_expenditure(self):
                 )
         if self.price is not None and self.unit_multiple is not None and self.times_per_year is not None:
             expected_expenditure = self.price * self.unit_multiple * self.times_per_year
-            if self.expenditure is not None and self.expenditure != expected_expenditure:
+            if self.expenditure is not None and not math.isclose(self.expenditure, expected_expenditure):
                 errors.append(
                     _(
                         "Expenditure for Other Purchases must be price * unit multiple * purchases per year. Expected: %(expected)s, Found: %(found)s"