[Option Appraisal Module] [Package 1: Measures] Split 1: Adds `MeasureConfig` dataclasses for serializable measure configuration. by spjuhel · Pull Request #1276 · CLIMADA-project/climada_python

spjuhel · 2026-04-07T07:50:14Z

Changes proposed in this PR:

This PR introduces a new module defining a family of dataclasses that encode adaptation measure parameters in a serializable, declarative form. This is a preparatory step for the broader Measure/MeasureSet rework.

The objective is to retain the possibility to define measures from modifiers in addition to the upcoming system that will use python functions directly, and provide a (better) user interface for this.

no existing code is changed.

New dataclasses:

MeasureConfig top-level configuration for a single measure, aggregating all modifier configs below.
ImpfsetModifierConfig parameters for modifying impact functions (intensity, MDD, PAA scaling, optional replacement)
HazardModifierConfig parameters for modifying hazard (intensity scaling, frequency cutoff, optional replacement)
ExposuresModifierConfig parameters for modifying exposures (impact function remapping, zeroing regions, optional replacement)
CostIncomeConfig serializable representation of cost/income cash flow parameters

All configs inherit from the abstract _ModifierConfig base, which provides shared to_dict/from_dict and a __repr__ that highlights non-default fields.

MeasureConfig supports full serialization to/from dict, YAML, and legacy Excel rows (from_row), which will serve as the migration path for the existing file-based I/O in MeasureSet.

PR Author Checklist

PR Reviewer Checklist

chahank · 2026-04-07T08:09:38Z

Excellent idea!

Cleans-up, Docstringfies Better to_dict, color parser, and post_inits Removes duplicate docstring

…MADA-project/climada_python into feature/option-appraisal-dataclasses

spjuhel · 2026-04-08T09:48:43Z

@chahank

Question: Should measures (defined by MeasureConfig) be specific to a hazard? (I see reasons for both yes and no)

Currently, they are specific (thus configs require you to provide haz_type).

I see how you could want modifications of impact function to be for multiple hazards
But also you should probably not be able to apply a shift in intensity for multiple hazards?

Any opinion on that?

spjuhel · 2026-04-08T14:09:04Z

This PR is officially open for review! Review is advised after #1274 is merged.

Actual changes to be reviewed are in:

climada/entity/measures/measure_config.py
climada/entity/measures/test/test_measure_config.py
doc/user-guide/climada_measure_config.ipynb (and a few other tutos where a target was added at the top)

chahank · 2026-04-09T12:21:19Z

@chahank

Question: Should measures (defined by MeasureConfig) be specific to a hazard? (I see reasons for both yes and no)

Currently, they are specific (thus configs require you to provide haz_type).

I see how you could want modifications of impact function to be for multiple hazards But also you should probably not be able to apply a shift in intensity for multiple hazards?

Any opinion on that?

Good question. I would then to keep it hazard type specific. But maybe best is to ask core users of the model :).
@ChrisFairless : any opinion?

…e/option-appraisal-dataclasses

This reverts commit 775c621.

peanutfun

I reviewed mostly on a technical level. Very nice code quality overall, nice class structure! I found a few issues. Sorry for the brevity 😬 ✌️

peanutfun · 2026-04-17T10:21:47Z

+            if defined_field.default_factory is not field().default_factory:
+                default = defined_field.default_factory()


Needs from dataclasses import MISSING:

Suggested change

if defined_field.default_factory is not field().default_factory:

default = defined_field.default_factory()

if default is MISSING:

default = defined_field.default_factory()

See https://docs.python.org/3/library/dataclasses.html#dataclasses.MISSING and https://docs.python.org/3/library/dataclasses.html#dataclasses.Field:

default, default_factory, init, repr, hash, compare, metadata, and kw_only have the identical meaning and values as they do in the field() function.

peanutfun · 2026-04-17T10:22:36Z

+    be instantiated directly.
+    """
+
+    def _filter_out_default_fields(self):


Suggested change

def _filter_out_default_fields(self):

def _filter_out_default_fields(self) -> dict[str, Any]:

peanutfun · 2026-04-17T10:23:15Z

+
+
+@dataclass
+class _ModifierConfig(ABC):


You do not define abstract methods, so you can omit deriving from ABC:

Suggested change

class _ModifierConfig(ABC):

class _ModifierConfig:

Also, why private? Just exclude from all?

peanutfun · 2026-04-17T10:26:03Z

+            non_defaults.pop("haz_type")
+        return non_defaults, defaults
+
+    def to_dict(self):


Judging from its name, I would not expect such a method to omit default values. Even if this is never used, maybe add a parameter?

Suggested change

def to_dict(self):

def to_dict(self, omit_default : bool = True) -> dict[str, Any]:

peanutfun · 2026-04-17T10:28:38Z

+        filtered = dict(
+            filter(lambda k: k[0] in [f.name for f in fields(cls)], to_filter.items())
+        )
+        return filtered


Dict comprehension is easier to read. Also, I am not sure if the list comprehension is evaluated once or each time the lambda runs.

Suggested change

filtered = dict(

filter(lambda k: k[0] in [f.name for f in fields(cls)], to_filter.items())

)

return filtered

fields = [f.name for f in fields(cls)]

return {key: val for key, val in to_filter.items() if key in fields}

peanutfun · 2026-04-17T10:39:10Z

+    freq : str, optional
+        Pandas offset alias defining the period length (e.g. ``"Y"`` for
+        yearly, ``"M"`` for monthly). Default is ``"Y"``.


Not sure exactly how these values are used, but Y and M are deprecated as frequencies. You need to also specify start or end, like YS or ME, see https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases

peanutfun · 2026-04-17T10:40:42Z

+            Destination file path. Will be created or overwritten.
+        """
+
+        import yaml


Need to add a dependency, preferably ruamel.yaml. Why no top-level import?

peanutfun · 2026-04-17T10:40:54Z

+            ``measures``.
+        """
+
+        import yaml


peanutfun · 2026-04-17T10:43:08Z

+def test_modifier_config_filter_dict_to_fields_filters_extra_keys():
+    d = {"haz_type": "TC", "impf_mdd_mult": 0.5, "not_a_field": 123}
+    filtered = ImpfsetModifierConfig._filter_dict_to_fields(d)
+    assert "not_a_field" not in filtered
+    assert "haz_type" in filtered
+    assert "impf_mdd_mult" in filtered
+    assert filtered["haz_type"] == "TC"
+    assert filtered["impf_mdd_mult"] == 0.5


Private methods are private also in the context of tests. Unit tests should not call private methods. A linter will also complain. Private methods must be implicitly tested via calling public methods.

peanutfun · 2026-04-17T10:45:47Z

+# ---------------------------------------------------------------------------
+# ImpfsetModifierConfig
+# ---------------------------------------------------------------------------


Create a class to group tests? Would make test names shorter. Pytest creates a sub-suite, grouping the tests accordingly:

class TestImpfsetModifierConfig: def test_defaults(self): ... def test_from_dict_roundtrip(self): ...

spjuhel added 4 commits April 2, 2026 11:45

makes soon to be old measures module a legacy

1a755c3

Oups these shouldn't be here!

ceaf479

Forgotten places

c176e80

Introduces measure config dataclasses

2c0dffa

chahank reviewed Apr 7, 2026

View reviewed changes

Comment thread climada/entity/measures/measure_config.py Outdated

chahank reviewed Apr 7, 2026

View reviewed changes

Comment thread climada/entity/measures/measure_config.py

spjuhel added 7 commits April 7, 2026 10:22

Cleans-up, Docstringfies

e9f4831

Better to_dict, color parser, and post_inits

bcf6811

Unit tests

2718c84

Removes duplicate docstring

c5345fb

Forgotten places

4551e3c

Cleans-up, Docstringfies Better to_dict, color parser, and post_inits Removes duplicate docstring

tests again

78c4968

Merge branch 'feature/option-appraisal-dataclasses' of github.com:CLI…

3cae5d7

…MADA-project/climada_python into feature/option-appraisal-dataclasses

spjuhel changed the title ~~[Option Appraisal Module] - Adds MeasureConfig dataclasses for serializable measure configuration.~~ [Option Appraisal Module] [Package 1: Measures] Split 1: Adds MeasureConfig dataclasses for serializable measure configuration. Apr 7, 2026

spjuhel added 2 commits April 8, 2026 10:06

Updates changelog

108bcb2

Adds freq modifiers

c96a061

spjuhel added 2 commits April 8, 2026 16:02

Improves __repr__

4e416bc

Tutorial first draft

30bdce6

spjuhel marked this pull request as ready for review April 8, 2026 14:04

spjuhel requested review from emanuel-schmid and peanutfun as code owners April 8, 2026 14:04

spjuhel added 5 commits April 9, 2026 14:52

Adds future documentation placeholders, warnings in legacy guides

bc5fefc

This one does not exist yet

3725078

Merge branch 'feature/option-appraisal-split-make-legacy' into featur…

5c80864

…e/option-appraisal-dataclasses

Includes guide in documentation index

cc70476

Updates changelog

44a36d4

spjuhel added 6 commits April 10, 2026 11:07

Updates rst files

e4d7fc4

Merge branch 'feature/option-appraisal-split-make-legacy' into featur…

5634482

…e/option-appraisal-dataclasses

Adds new class to API ref

8a09101

Fixes wrong filename

775c621

Revert "Fixes wrong filename"

3ddf2b4

This reverts commit 775c621.

Correct rename

5b11b68

peanutfun requested changes Apr 17, 2026

View reviewed changes

		if defined_field.default_factory is not field().default_factory:
		default = defined_field.default_factory()

	def _filter_out_default_fields(self):
	def _filter_out_default_fields(self) -> dict[str, Any]:

	def to_dict(self):
	def to_dict(self, omit_default : bool = True) -> dict[str, Any]:

Conversation

spjuhel commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Author Checklist

PR Reviewer Checklist

Uh oh!

Uh oh!

Uh oh!

chahank commented Apr 7, 2026

Uh oh!

spjuhel commented Apr 8, 2026

Uh oh!

spjuhel commented Apr 8, 2026

Uh oh!

chahank commented Apr 9, 2026

Uh oh!

peanutfun left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

peanutfun Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

spjuhel commented Apr 7, 2026 •

edited

Loading

peanutfun Apr 17, 2026 •

edited

Loading