edc-vitals 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

edc_vitals/calculators/__init__.py

@@ -0,0 +1 @@
+from .bmi import BMI, CalculatorError, calculate_bmi

edc_vitals/calculators/bmi.py

@@ -0,0 +1,69 @@
+from dateutil.relativedelta import relativedelta
+from edc_utils import age, get_utcnow
+from edc_utils.round_up import round_half_away_from_zero
+
+__all__ = ["calculate_bmi", "BMI", "CalculatorError"]
+
+
+class CalculatorError(Exception):
+    pass
+
+
+class BMI:
+    """Calculate BMI, raise if not adult."""
+
+    def __init__(
+        self,
+        weight_kg=None,
+        height_cm=None,
+        lower_bmi_value=None,
+        upper_bmi_value=None,
+        dob=None,
+        report_datetime=None,
+        **kwargs,
+    ):
+        if not weight_kg or not height_cm:
+            raise CalculatorError(f"Unable to calculate BMI. Got {weight_kg}kg, {height_cm}cm")
+        if age(dob, report_datetime).years < 18:
+            raise CalculatorError("Unable to calculate BMI. Got age<18")
+        self.lower = float(lower_bmi_value or 5.0)
+        self.upper = float(upper_bmi_value or 75.0)
+        self.weight = float(weight_kg)
+        self.height = float(height_cm) / 100.0
+        self.raw_bmi_value = self.weight / (self.height**2)
+        if not (self.lower <= self.raw_bmi_value <= self.upper):
+            raise CalculatorError(
+                "BMI value is absurd. "
+                f"Using {self.weight}kg, {self.height}m. Got {self.value}."
+            )
+
+    @property
+    def value(self):
+        return round_half_away_from_zero(self.raw_bmi_value, 4)
+
+
+def calculate_bmi(
+    weight_kg=None,
+    height_cm=None,
+    lower_bmi_value=None,
+    upper_bmi_value=None,
+    dob=None,
+    report_datetime=None,
+    **kwargs,
+):
+    """Returns a BMI instance or None.
+
+    Assumes adult dob (18) if dob not provided."""
+    bmi = None
+    if height_cm and weight_kg:
+        report_datetime = report_datetime or get_utcnow()
+        bmi = BMI(
+            weight_kg=weight_kg,
+            height_cm=height_cm,
+            lower_bmi_value=lower_bmi_value,
+            upper_bmi_value=upper_bmi_value,
+            dob=dob or report_datetime - relativedelta(years=18),
+            report_datetime=report_datetime,
+            **kwargs,
+        )
+    return bmi

edc_vitals/form_validators/__init__.py

@@ -1,2 +1,5 @@
 from .blood_pressure_form_validator_mixin import BloodPressureFormValidatorMixin
-from .weight_height_bmi_form_validator_mixin import WeightHeightBmiFormValidatorMixin
+from .bmi_form_validator_mixin import BmiFormValidatorMixin
+from .weight_height_with_bmi_form_validator_mixin import (
+    WeightHeightBmiFormValidatorMixin,
+)

edc_vitals/form_validators/bmi_form_validator_mixin.py

@@ -0,0 +1,19 @@
+from django import forms
+
+from ..calculators import CalculatorError, calculate_bmi
+
+__all__ = ["BmiFormValidatorMixin"]
+
+
+class BmiFormValidatorMixin:
+    def validate_bmi(self, **kwargs):
+        try:
+            bmi = calculate_bmi(
+                height_cm=self.cleaned_data.get("height"),
+                weight_kg=self.cleaned_data.get("weight"),
+                **self.cleaned_data,
+                **kwargs,
+            )
+        except CalculatorError as e:
+            raise forms.ValidationError(e)
+        return bmi

edc_vitals/form_validators/{weight_height_bmi_form_validator_mixin.py → weight_height_with_bmi_form_validator_mixin.py}

@@ -1,5 +1,6 @@
 from django import forms
-from edc_reportable import CalculatorError, calculate_bmi
+
+from ..calculators import CalculatorError, calculate_bmi
 
 
 class WeightHeightBmiFormValidatorMixin:

edc_vitals/model_mixins/weight_height_bmi_model_mixin.py

@@ -1,6 +1,6 @@
 from django.db import models
-from edc_reportable import calculate_bmi
 
+from ..calculators import calculate_bmi
 from ..models import HeightField, WeightField
 
 

edc_vitals/tests/tests/test_calculators.py

@@ -0,0 +1,77 @@
+from dateutil.relativedelta import relativedelta
+from django import forms
+from django.test import TestCase, tag
+from edc_constants.constants import BLACK, MALE
+from edc_form_validators import FormValidator
+from edc_utils import get_utcnow
+from edc_utils.round_up import round_half_away_from_zero
+
+from edc_vitals.calculators import BMI, CalculatorError, calculate_bmi
+from edc_vitals.form_validators import BmiFormValidatorMixin
+
+
+class TestCalculators(TestCase):
+    @tag("1")
+    def test_bmi_calculator(self):
+        dob = get_utcnow() - relativedelta(years=25)
+        self.assertRaises(CalculatorError, BMI, weight_kg=56, height_cm=None)
+        try:
+            calculate_bmi(weight_kg=56, height_cm=None, dob=dob)
+        except CalculatorError:
+            self.fail("CalculatorError unexpectedly raised ")
+
+        for func in [BMI, calculate_bmi]:
+            with self.subTest(func=func):
+                self.assertRaises(
+                    CalculatorError,
+                    func,
+                    weight_kg=56,
+                    height_cm=1.50,
+                    dob=dob,
+                    report_datetime=get_utcnow(),
+                )
+                try:
+                    bmi = func(
+                        weight_kg=56, height_cm=150, dob=dob, report_datetime=get_utcnow()
+                    )
+                except CalculatorError as e:
+                    self.fail(f"CalculatorError unexpectedly raises. Got {e}")
+                else:
+                    self.assertEqual(round_half_away_from_zero(bmi.value, 2), 24.89)
+
+    @tag("1")
+    def test_bmi_form_validator(self):
+        data = dict(
+            gender=MALE,
+            ethnicity=BLACK,
+            age_in_years=30,
+        )
+
+        class BmiFormValidator(BmiFormValidatorMixin, FormValidator):
+            pass
+
+        # not enough data
+        form_validator = BmiFormValidator(cleaned_data=data)
+        bmi = form_validator.validate_bmi()
+        self.assertIsNone(bmi)
+
+        # calculates
+        data.update(
+            weight=56,
+            height=150,
+            dob=get_utcnow() - relativedelta(years=30),
+            report_datetime=get_utcnow(),
+        )
+        form_validator = BmiFormValidator(cleaned_data=data)
+        bmi = form_validator.validate_bmi()
+        self.assertEqual(bmi.value, 24.8889)
+
+        # calculation error
+        data.update(
+            weight=56,
+            height=1.5,
+            dob=get_utcnow() - relativedelta(years=25),
+            report_datetime=get_utcnow(),
+        )
+        form_validator = BmiFormValidator(cleaned_data=data)
+        self.assertRaises(forms.ValidationError, form_validator.validate_bmi)

{edc_vitals-1.0.0.dist-info → edc_vitals-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: edc-vitals
-Version: 1.0.0
+Version: 1.1.1
 Summary: Classes for BP, weight, etc for clinicedc/edc projects
 Home-page: https://github.com/clinicedc/edc-vitals
 Author: Erik van Widenfelt
@@ -9,7 +9,7 @@ License: GPL license, see LICENSE
 Keywords: django edc vitals,clinicedc,clinical trials
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
-Classifier: Framework :: Django :: 5.1
+Classifier: Framework :: Django :: 5.2
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
 Classifier: Operating System :: OS Independent
@@ -19,6 +19,7 @@ Requires-Python: >=3.12
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 License-File: AUTHORS
+Dynamic: license-file
 
 
 |pypi| |actions| |codecov| |downloads|

{edc_vitals-1.0.0.dist-info → edc_vitals-1.1.1.dist-info}/RECORD

@@ -2,13 +2,16 @@ edc_vitals/__init__.py,sha256=k7pm4XmS32dJU4XRYKHJrzEkA7CuQ75_Jj7nLkvUiDY,117
 edc_vitals/apps.py,sha256=AvV-Dwgo6KRe5VhriAP8CYM6OJG6kGh2_1BwQ6Wmc8o,145
 edc_vitals/utils.py,sha256=vXid44KUXxeaSyund_y5MNXc5DFJs052_PwUAjszE2k,1384
 edc_vitals/validators.py,sha256=9bNs-txdfA-v9iPS8mzFy_HLlY12jFcUHoy_bDbEpH0,164
-edc_vitals/form_validators/__init__.py,sha256=mNp0jCS5XZW5r-WNMt6yBBqQuP0DnIuVC4PTU_XFWfE,167
+edc_vitals/calculators/__init__.py,sha256=H2gtS_5Aw7r4kELDmNy3AtNqTPbaNUDMM0OzSx3ZiU4,53
+edc_vitals/calculators/bmi.py,sha256=DFJRChDR8zXL7WLNanJPUo6SE3Do44srFgIsb3TiLOQ,2055
+edc_vitals/form_validators/__init__.py,sha256=Kd3uFE_Qe2MOWsyQG72gfG62HGNw-8GyqKmgA8uIjWA,241
 edc_vitals/form_validators/blood_pressure_form_validator_mixin.py,sha256=RvIGvukC7RubqH7f6DUVArNUL__BVoTdRq1L4vPfX2A,1563
-edc_vitals/form_validators/weight_height_bmi_form_validator_mixin.py,sha256=xtPXCNQzSkUN_7zm7XvPex3cOInlECMtAwpShTjS4eI,460
+edc_vitals/form_validators/bmi_form_validator_mixin.py,sha256=dQPb3CrvkRdSXJtDUbZ33Z1dMYrybWwrK9WvPbdjhZA,529
+edc_vitals/form_validators/weight_height_with_bmi_form_validator_mixin.py,sha256=zJZJgyQ1KP5LZMPowf5Rs009Lq2sybm65UoHNP6pBxU,460
 edc_vitals/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 edc_vitals/model_mixins/__init__.py,sha256=Nvu9-rNd0P5efB7KS74OHUE_AMJL_qtjUepEt0BuT8I,177
 edc_vitals/model_mixins/blood_pressure_model_mixin.py,sha256=50J3xs3Po5IRaUodFs6qtPWzwOUckWhExVUEM25Ri4g,2052
-edc_vitals/model_mixins/weight_height_bmi_model_mixin.py,sha256=giZSiI38kynfRc4B5L_A4Rc_hreTS1vPKlYVnY2qj-A,1102
+edc_vitals/model_mixins/weight_height_bmi_model_mixin.py,sha256=DjxSSlMLy2FCr1LvJ7ppCZFe4-HxWSs0ZuXta6VtvQc,1101
 edc_vitals/models/__init__.py,sha256=kojBDnW6CZiBORa4hn7CtVl0D6pku3i7M1t8uVoVhWg,210
 edc_vitals/models/fields/__init__.py,sha256=2mpaP8hoI0-4c5vlZZVoUFvGuy9rjfT7im3k8jykDyU,327
 edc_vitals/models/fields/blood_pressure.py,sha256=5MLJcvNf6yOk5LJe1wmPCku4rpaA6JZrHrWoKX5EmiY,1369
@@ -32,13 +35,14 @@ edc_vitals/tests/etc/user-salt-local.key,sha256=8yXyuxh-EstHWMSkwqSNV7gakEQLnQLo
 edc_vitals/tests/etc/user-salt-restricted.key,sha256=w835r6mLFeL4IIYoovEVU8JfXOw8VR1Moh15gaIJJww,256
 edc_vitals/tests/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 edc_vitals/tests/tests/test_blood_pressure.py,sha256=dablDybatc_Z_4TxLdJoYzbe1ZVQ7dW3u6gAprAgB3w,7591
+edc_vitals/tests/tests/test_calculators.py,sha256=op0P4WbP-OAAr-73Usaod-xHl3Ptikcf8n0AmoirnsQ,2674
 edc_vitals/tests/tests/test_heart_rate.py,sha256=0-FpuWg1iDSRw6EmfFhH8u4OmvH9o1Ss_EKYwfOaVXI,1804
 edc_vitals/tests/tests/test_respiratory_rate.py,sha256=-R7XIIw6gHd0u69AHdOcEgFjLQrjdYdsGbf7B3d_GwU,1906
 edc_vitals/tests/tests/test_temperature.py,sha256=KYK-PrvCQIsNUPajUhl0R1FmuspwEYhxIZtc-TKgRjc,3518
 edc_vitals/tests/tests/test_weight_height_bmi.py,sha256=aMlxxvdbeNAKX8IMp6x6zxRmjd3oL_mO8nCE06vyBV4,2322
-edc_vitals-1.0.0.dist-info/AUTHORS,sha256=6jjF41GocVpG01NLt55LeDKdjuwuDdA77fb_MENCTOk,38
-edc_vitals-1.0.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-edc_vitals-1.0.0.dist-info/METADATA,sha256=teumq6ZayizP9sgiQ7aRLFY4CT6cSoDkwFCv_5wl_ZE,1757
-edc_vitals-1.0.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-edc_vitals-1.0.0.dist-info/top_level.txt,sha256=hwo2JnqOF-wcBFoQz-fEhszjPca4sZ9a3QDF7BHGFhI,11
-edc_vitals-1.0.0.dist-info/RECORD,,
+edc_vitals-1.1.1.dist-info/licenses/AUTHORS,sha256=cRyIwmYX7rwmqBPh9_4EA9hZ_kw6RWjNSGOW4RpIoiM,102
+edc_vitals-1.1.1.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+edc_vitals-1.1.1.dist-info/METADATA,sha256=oEG4Rboi936rDDYzyWyICTagF22x4CBpYnYcbx1jmmE,1779
+edc_vitals-1.1.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+edc_vitals-1.1.1.dist-info/top_level.txt,sha256=hwo2JnqOF-wcBFoQz-fEhszjPca4sZ9a3QDF7BHGFhI,11
+edc_vitals-1.1.1.dist-info/RECORD,,

{edc_vitals-1.0.0.dist-info → edc_vitals-1.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

edc_vitals-1.1.1.dist-info/licenses/AUTHORS

@@ -0,0 +1,2 @@
+Erik van Widenfelt <ew2789@gmail.com>
+Jonathan Willitts (GitHub: https://github.com/JonathanWillitts)

edc_vitals-1.0.0.dist-info/AUTHORS

@@ -1 +0,0 @@
-Erik van Widenfelt <ew2789@gmail.com>