hestia-earth-models 0.61.8__py3-none-any.whl → 0.62.1__py3-none-any.whl

tests/models/utils/test_blank_node.py

@@ -12,16 +12,14 @@ from hestia_earth.models.utils.blank_node import (
     _get_datestr_format,
     _run_required,
     _run_model_required,
-    _should_run_array_treatment,
-    ArrayTreatment,
     cumulative_nodes_match,
     DatestrFormat,
     DatestrGapfillMode,
     DatetimeRange,
-    get_node_value,
     group_nodes_by_year,
     group_nodes_by_year_and_month,
-    GroupNodesByYearMode
+    GroupNodesByYearMode,
+    split_node_by_dates
 )
 
 
@@ -62,282 +60,6 @@ def test_run_model_required():
     })
 
 
-# --- test should_run_array_treatment ---
-
-
-def test_should_run_array_treatment_true():
-    VALUE = [24, 87, 34, 12]
-    assert _should_run_array_treatment(VALUE) is True
-
-
-def test_should_run_array_treatment_false_empty_list():
-    VALUE = []
-    assert _should_run_array_treatment(VALUE) is False
-
-
-def test_should_run_array_treatment_false_not_iterable():
-    VALUE = 1
-    assert _should_run_array_treatment(VALUE) is False
-
-
-# --- test get_node_value ---
-
-
-FULL_TILLAGE_AS_PRACTICE = {
-    "@type": "Practice",
-    "term": {
-        "@type": "Term",
-        "@id": "fullTillage"
-    },
-    "value": [50, 50, 60, 70]
-}
-
-FULL_TILLAGE_AS_MANAGEMENT = {
-    "@type": "Management",
-    "term": {
-        "@type": "Term",
-        "@id": "fullTillage"
-    },
-    "value": 100
-}
-
-EXPECTED_EMPTY_LIST = 0
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_reduce_default(*args):
-    """
-    Should return the reduced value of the value list using the array treatment specified in the term lookup
-    (or ArrayTreatment.FIRST if no lookup value available).
-
-    The lookup array treatment for `fullTillage` is `first`, therefore a return value of `50` is expected.
-    """
-    EXPECTED = 50
-    result = get_node_value(FULL_TILLAGE_AS_PRACTICE)
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_reduce_mean(*args):
-    """
-    Should return the mean value of the value list.
-
-    `statistics.mean` function is used here.
-    """
-    EXPECTED = 57.5
-    result = get_node_value(
-        FULL_TILLAGE_AS_PRACTICE, array_treatment=ArrayTreatment.MEAN
-    )
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_reduce_mode(*args):
-    """
-    Should return the mode value of the value list.
-
-    `statistics.mode` function is used here.
-    """
-    EXPECTED = 50
-    result = get_node_value(
-        FULL_TILLAGE_AS_PRACTICE, array_treatment=ArrayTreatment.MODE
-    )
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_reduce_sum(*args):
-    """
-    Should return the sum value of the value list.
-    """
-    EXPECTED = 230
-    result = get_node_value(
-        FULL_TILLAGE_AS_PRACTICE, array_treatment=ArrayTreatment.SUM
-    )
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_reduce_first(*args):
-    """
-    Should return the first value of the value list.
-    """
-    EXPECTED = 50
-    result = get_node_value(
-        FULL_TILLAGE_AS_PRACTICE, array_treatment=ArrayTreatment.FIRST
-    )
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_reduce_last(*args):
-    """
-    Should return the last value of the value list.
-    """
-    EXPECTED = 70
-    result = get_node_value(
-        FULL_TILLAGE_AS_PRACTICE, array_treatment=ArrayTreatment.LAST
-    )
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_bools_reduce_mean(*args):
-    """
-    If value is list of bools, the `satistics.mean` interprets them as integers (0 or 1),
-    therefore number is returned.
-    """
-    EXPECTED = 1/3
-    NODE = {"value": [False, False, True]}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.MEAN
-    )
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_bools_reduce_mode(*args):
-    """
-    If value is list of bools, the `satistics.mode` interprets them as bools and returns the most
-    common bool value as expected.
-    """
-    EXPECTED = False
-    NODE = {"value": [False, False, True]}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.MODE
-    )
-    assert result == EXPECTED
-    assert isinstance(result, bool)
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_list_bools_reduce_sum(*args):
-    """
-    If value is list of bools, the built-in `sum` interprets them as integers (0 or 1),
-    therefore number is returned.
-    """
-    EXPECTED = 1
-    NODE = {"value": [False, False, True]}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.SUM
-    )
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_empty_list_reduce_default(*args):
-    """
-    Empty list return as 0 if keyword arg `reduce_value_list` = `True`.
-    """
-    NODE = {"value": []}
-    result = get_node_value(NODE)
-    assert result == EXPECTED_EMPTY_LIST
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_empty_list_reduce_mean(*args):
-    """
-    Empty list return as 0 if keyword arg `reduce_value_list` = `True`.
-    """
-    NODE = {"value": []}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.MEAN
-    )
-    assert result == EXPECTED_EMPTY_LIST
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_empty_list_reduce_mode(*args):
-    """
-    Empty list return as 0 if keyword arg `reduce_value_list` = `True`.
-    """
-    NODE = {"value": []}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.MODE
-    )
-    assert result == EXPECTED_EMPTY_LIST
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_empty_list_reduce_sum(*args):
-    """
-    Empty list return as 0 if keyword arg `reduce_value_list` = `True`.
-    """
-    NODE = {"value": []}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.SUM
-    )
-    assert result == EXPECTED_EMPTY_LIST
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_empty_list_reduce_first(*args):
-    """
-    Empty list return as 0 if keyword arg `reduce_value_list` = `True`.
-    """
-    NODE = {"value": []}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.FIRST
-    )
-    assert result == EXPECTED_EMPTY_LIST
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_empty_list_reduce_last(*args):
-    """
-    Empty list return as 0 if keyword arg `reduce_value_list` = `True`.
-    """
-    NODE = {"value": []}
-    result = get_node_value(
-        NODE, array_treatment=ArrayTreatment.LAST
-    )
-    assert result == EXPECTED_EMPTY_LIST
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_float(*args):
-    """
-    Non-list values are returned directly, even if if keyword arg `reduce_value_list` = `True`.
-    """
-    EXPECTED = 100
-    result = get_node_value(FULL_TILLAGE_AS_MANAGEMENT)
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_bool_true(*args):
-    """
-    Non-list values are returned directly, even if if keyword arg `reduce_value_list` = `True`.
-    """
-    EXPECTED = True
-    NODE = {"value": True}
-    result = get_node_value(NODE)
-    assert result == EXPECTED
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_bool_false(*args):
-    """
-    Non-list values are returned directly, even if if keyword arg `reduce_value_list` = `True`.
-    """
-    EXPECTED = False
-    NODE = {"value": False}
-    result = get_node_value(NODE)
-    assert result == EXPECTED
-    assert isinstance(result, bool)
-
-
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.FIRST)
-def test_get_node_value_no_value(*args):
-    """
-    Missing values are returned as 0.
-    """
-    EXPECTED = 0
-    NODE = {}
-    result = get_node_value(NODE)
-    assert result == EXPECTED
-
-
 # --- test cumulative_nodes_match ---
 
 
@@ -369,7 +91,6 @@ CROP_RESIDUE_NODES = [
 ]
 
 
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.MEAN)
 def test_cumulative_nodes_match_true(*args):
     result = cumulative_nodes_match(
         lambda node: node.get("term", {}).get("@id") in [
@@ -381,7 +102,6 @@ def test_cumulative_nodes_match_true(*args):
     assert result is True
 
 
-@patch(f"{class_path}._retrieve_array_treatment", return_value=ArrayTreatment.MEAN)
 def test_cumulative_nodes_match_false(*args):
     result = cumulative_nodes_match(
         lambda node: node.get("term", {}).get("@id") in ["aboveGroundCropResidueLeftOnField"],
@@ -1017,33 +737,67 @@ def test_group_nodes_by_year_multiple_values_and_dates(mock_parse, system_dateti
             "2001-02",
             "2002-03",
             "2003-01"
+        ],
+        "sd": [
+            0.8, 0.9, 1.0, 0.9, 0.8
+        ],
+        "observations": [
+            100, 100, 100, 100, 100
         ]
     }]
 
     EXPECTED = {
-        2000: [{
-            "dates": ["2000-01", "2000-06"],
-            "fraction_of_node_duration": 0.32475598935226263,
-            "fraction_of_group_duration": 1.0,
-            "value": [1, 2]
-        }],
+        2000: [
+            {
+                "dates": ["2000-01"],
+                "fraction_of_node_duration": 1.0,
+                "fraction_of_group_duration": 0.08469945355191257,
+                "value": [1],
+                "sd": [0.8],
+                "observations": [
+                    100
+                ]
+            },
+            {
+                "dates": ["2000-06"],
+                "fraction_of_node_duration": 1.0,
+                "fraction_of_group_duration": 0.08196721311475409,
+                "value": [2],
+                "sd": [0.9],
+                "observations": [
+                    100
+                ]
+            }
+        ],
         2001: [{
             "dates": ["2001-02"],
-            "fraction_of_node_duration": 0.323868677905945,
-            "fraction_of_group_duration": 1.0,
-            "value": [3]
+            "fraction_of_node_duration": 1.0,
+            "fraction_of_group_duration": 0.07671232876712329,
+            "value": [3],
+            "sd": [1.0],
+            "observations": [
+                100
+            ]
         }],
         2002: [{
             "dates": ["2002-03"],
-            "fraction_of_node_duration": 0.323868677905945,
-            "fraction_of_group_duration": 1.0,
-            "value": [4]
+            "fraction_of_node_duration": 1.0,
+            "fraction_of_group_duration": 0.08493150684931507,
+            "value": [4],
+            "sd": [0.9],
+            "observations": [
+                100
+            ]
         }],
         2003: [{
             "dates": ["2003-01"],
-            "fraction_of_node_duration": 0.027506654835847383,
+            "fraction_of_node_duration": 1.0,
             "fraction_of_group_duration": 0.08493150684931507,
-            "value": [5]
+            "value": [5],
+            "sd": [0.8],
+            "observations": [
+                100
+            ]
         }]
     }
 
@@ -1134,3 +888,107 @@ def test_group_nodes_by_year_and_month(mock_parse, system_datetime):
 
     result = group_nodes_by_year_and_month(MANAGEMENT)
     assert result == EXPECTED
+
+
+# node, expected
+PARAMS_SPLIT_NODE = [
+    (
+        {},
+        [{}]
+    ),
+    (
+        {"value": [1, 2, 3], "dates": ["2000"]},
+        [{"value": [1, 2, 3], "dates": ["2000"]}]
+    ),
+    (
+        {"value": [1, 2, 3], "startDate": "2000", "endDate": "2001"},
+        [{"value": [1, 2, 3], "startDate": "2000", "endDate": "2001"}]
+    ),
+    (
+        {"value": 1, "startDate": "2000", "endDate": "2001"},
+        [{"value": 1, "startDate": "2000", "endDate": "2001"}]
+    ),
+    (
+        {"value": None},
+        [{"value": None}]
+    ),
+    (
+        {"value": [1, 2, 3], "dates": ["2000", "2001", "2002"]},
+        [
+            {"value": [1], "dates": ["2000"]},
+            {"value": [2], "dates": ["2001"]},
+            {"value": [3], "dates": ["2002"]}
+        ]
+    ),
+    (
+        {
+            "value": [1, 2],
+            "dates": ["2000", "2001"],
+            "sd": [0.816496, 0.816496],
+            "min": [0, 1],
+            "max": [2, 3],
+            "observations": [3, 3]
+        },
+        [
+            {
+                "value": [1],
+                "dates": ["2000"],
+                "sd": [0.816496],
+                "min": [0],
+                "max": [2],
+                "observations": [3]
+            },
+            {
+                "value": [2],
+                "dates": ["2001"],
+                "sd": [0.816496],
+                "min": [1],
+                "max": [3],
+                "observations": [3]
+            }
+        ]
+    ),
+    (
+        {
+            "value": [1, 2],
+            "dates": ["2000", "2001"],
+            "sd": [0.816496, 0.816496],
+            "min": [0, 1],
+            "max": [2, 3],
+            "observations": [3]
+        },
+        [
+            {
+                "value": [1],
+                "dates": ["2000"],
+                "sd": [0.816496],
+                "min": [0],
+                "max": [2],
+                "observations": [3]
+            },
+            {
+                "value": [2],
+                "dates": ["2001"],
+                "sd": [0.816496],
+                "min": [1],
+                "max": [3],
+                "observations": [3]
+            }
+        ]
+    )
+]
+IDS_SPLIT_NODE = [
+    "no split -> empty node",
+    "no split -> not enough dates",  # len(value) and len(dates) MUST match
+    "no split -> startDate & endDate",
+    "no split -> non-iterable value",  # i.e., on a Management or Animal node.
+    "no split -> null value",  # i.e., on a Animal node where value is not required.
+    "value & dates",
+    "descriptive statistics",
+    "descriptive statistics w/ bad key"  # if descriptive statistic keys have wrong length, don't split them
+]
+
+
+@mark.parametrize("node, expected", PARAMS_SPLIT_NODE, ids=IDS_SPLIT_NODE)
+def test_split_node_by_dates(node, expected):
+    assert split_node_by_dates(node) == expected

tests/models/utils/test_lookup.py

@@ -0,0 +1,10 @@
+from hestia_earth.models.utils.lookup import is_siteType_allowed
+
+
+def test_is_siteType_allowed():
+    term = {'@id': 'pastureGrass', 'termType': 'landUseManagement'}
+    site = {'@type': 'Site', 'siteType': 'cropland'}
+    assert not is_siteType_allowed(site, term)
+
+    cycle = {'otherSites': [{'@type': 'Site', 'siteType': 'permanent pasture'}]}
+    assert is_siteType_allowed(cycle, term) is True