ignore_keys in costs (#263)

* ignore_keys in costs

Author: EddyCMWF

cads_adaptors/costing.py

@@ -3,6 +3,8 @@
 import warnings
 from typing import Any
 
+from cads_adaptors.tools.general import ensure_list
+
 from . import constraints
 
 EXCLUDED_WIDGETS = [
@@ -197,7 +199,8 @@ def estimate_number_of_fields(
 ) -> int:
     weighted_values = kwargs.get("weighted_values", {})
     weighted_keys = kwargs.get("weighted_keys", {})
-    excluded_variables = get_excluded_keys(form)
+    ignore_keys: list[str] = ensure_list(kwargs.get("ignore_keys", []))
+    excluded_variables = get_excluded_keys(form) + ensure_list(ignore_keys)
     number_of_values = []
     for variable_id, variable_value in request.items():
         weights_v = weighted_values.get(variable_id, {})

tests/test_10_costing.py

@@ -465,6 +465,59 @@ def test_estimate_number_of_fields() -> None:
     assert number_of_fields == 6
 
 
+def test_estimate_number_of_fields_ignore_keys() -> None:
+    form = [
+        {
+            "name": "key1",
+            "label": "Key1",
+            "details": {"values": {"value1", "value2"}},
+            "type": "StringListWidget",
+        },
+        {
+            "name": "key2",
+            "label": "Key2",
+            "details": {"values": {"value1", "value2"}},
+            "type": "StringListWidget",
+        },
+        {
+            "name": "key3",
+            "label": "Key3",
+            "details": {"values": {"value1", "value2"}},
+            "type": "StringListWidget",
+        },
+    ]
+
+    costing_kwargs = {
+        "ignore_keys": ["key3"],
+    }
+
+    request = {
+        "key1": ["value1", "value2"],
+        "key2": ["value1", "value2"],
+    }
+    number_of_fields = costing.estimate_number_of_fields(form, request)
+    assert number_of_fields == 4
+    number_of_fields = costing.estimate_number_of_fields(
+        form, request, **costing_kwargs
+    )
+    assert number_of_fields == 4
+
+    request = {
+        "key1": ["value1", "value2"],
+        "key2": ["value1", "value2"],
+        "key3": ["value1", "value2"],
+    }
+    number_of_fields = costing.estimate_number_of_fields(
+        form,
+        request,
+    )
+    assert number_of_fields == 8
+    number_of_fields = costing.estimate_number_of_fields(
+        form, request, **costing_kwargs
+    )
+    assert number_of_fields == 4
+
+
 def test_estimate_costs() -> None:
     from cads_adaptors import DummyCdsAdaptor