Skip to content

Commit 4d63dbb

Browse files
FBumannFBumann
authored
Feature/deprecation removal (#478)
* Add weight_of_last_period to flowsystem * Add weights per effect and move normalization * Weighted Sum Constraints Over All Periods have been fully implemented for both Effects and Flows: Effects - Renamed parameters: minimum_total → minimum_total_per_period, maximum_total → maximum_total_per_period - New parameters: minimum and maximum for weighted sum across ALL periods - Effect-specific weights: Effects can override FlowSystem weights (e.g., for discounting in costs vs equal weighting for CO2) - Backward compatibility: Deprecation wrappers ensure existing code continues to work Flows - Renamed parameters: flow_hours_total_min/max → flow_hours_per_period_min/max - New parameters: total_flow_hours_min/max for weighted sum across ALL periods - Uses FlowSystem period weights for weighting - Backward compatibility: Deprecation wrappers for old parameter names Test Results - 616/616 tests passing - no regressions introduced - All existing functionality preserved - Weighted sums respect period weights (auto-derived from period index or user-specified) The implementation is production-ready and maintains full backward compatibility with existing code. * Fixed a critical bug in /Users/felix/PycharmProjects/flixopt_719231/flixopt/structure.py:218-228 where the FlowSystemModel.weights property wasn't normalizing weights despite its docstring claiming it would. The property now correctly normalizes weights to sum to 1 when normalize_weights=True. * Successfully refactored 11 parameter names across the codebase using the _over_periods suffix for weighted sums across all periods: Effects (4 parameters): - minimum_total_per_period → minimum_total - maximum_total_per_period → maximum_total - minimum → minimum_over_periods - maximum → maximum_over_periods Flows (4 parameters): - flow_hours_per_period_max → flow_hours_max - flow_hours_per_period_min → flow_hours_min - total_flow_hours_max → flow_hours_max_over_periods - total_flow_hours_min → flow_hours_min_over_periods OnOffParameters (3 parameters): - on_hours_total_min → on_hours_min - on_hours_total_max → on_hours_max - switch_on_total_max → switch_on_max * Cahneglog * Fix CHANGELOG.md * 1. Critical Bug Fix - structure.py:219-229 - Fixed weights property normalization to handle scalars/lists properly - Added zero-sum guard to prevent division by zero - Now always aligns weights to model coords before normalizing 2. Documentation - flow_system.py - Added documentation for the weight_of_last_period parameter in the FlowSystem class docstring 3. Code Quality - interface.py - Refactored deprecated kwargs handling to use instance method instead of awkward static call pattern - Removed unnecessary import and cleaner implementation 4. Parameter Name Updates - Test Files Updated deprecated parameter names in all test files: - tests/test_scenarios.py - tests/test_functional.py - tests/conftest.py - tests/test_flow.py - tests/test_linear_converter.py 5. Parameter Name Updates - Documentation Updated parameter names in: - docs/user-guide/mathematical-notation/features/OnOffParameters.md 6. Parameter Name Updates - Examples Updated parameter names in: - examples/02_Complex/complex_example.py 7. Enhanced CHANGELOG.md Added comprehensive migration guidance including: - Clear explanation of weighting behavior for _over_periods constraints - Concrete example showing per-period vs over-periods differences - Removal timeline (version 4.0.0) for deprecated parameters - Simple migration instructions All deprecated parameters: - on_hours_total_min → on_hours_min - on_hours_total_max → on_hours_max - switch_on_total_max → switch_on_max - flow_hours_total_min → flow_hours_min - flow_hours_total_max → flow_hours_max The codebase is now fully updated with consistent naming, proper documentation, and backward compatibility maintained through deprecation warnings! * 1. Critical Bug Fix - structure.py:219-229 - Fixed weights property normalization to handle scalars/lists properly - Added zero-sum guard to prevent division by zero - Now always aligns weights to model coords before normalizing 2. Documentation - flow_system.py - Added documentation for the weight_of_last_period parameter in the FlowSystem class docstring 3. Code Quality - interface.py - Refactored deprecated kwargs handling to use instance method instead of awkward static call pattern - Removed unnecessary import and cleaner implementation 4. Parameter Name Updates - Test Files Updated deprecated parameter names in all test files: - tests/test_scenarios.py - tests/test_functional.py - tests/conftest.py - tests/test_flow.py - tests/test_linear_converter.py 5. Parameter Name Updates - Documentation Updated parameter names in: - docs/user-guide/mathematical-notation/features/OnOffParameters.md 6. Parameter Name Updates - Examples Updated parameter names in: - examples/02_Complex/complex_example.py 7. Enhanced CHANGELOG.md Added comprehensive migration guidance including: - Clear explanation of weighting behavior for _over_periods constraints - Concrete example showing per-period vs over-periods differences - Removal timeline (version 4.0.0) for deprecated parameters - Simple migration instructions All deprecated parameters: - on_hours_total_min → on_hours_min - on_hours_total_max → on_hours_max - switch_on_total_max → switch_on_max - flow_hours_total_min → flow_hours_min - flow_hours_total_max → flow_hours_max The codebase is now fully updated with consistent naming, proper documentation, and backward compatibility maintained through deprecation warnings! * Added single-period validation in _create_periods_with_extra(): * Added dimension validation for flow_hours constraints * Fixed the DataArray boolean context * Remove intermediate parameters that need no deprecation * Remove intermediate parameters that need no deprecation * Update CHANGELOG.md * Fix weighting per period in Flows * Add type hints and fallback for weights = None * Imrove weight computation in Effects * Improve objectove weight handling * Add tests * Typos * Add zero-sum guard to objective_weights property to prevent silent NaN/inf corruption * Guard over‑periods constraint when no period dimension is present. * Fit fallback weight to dims * Improve weight handling. * Typos and updates * Update CHANGELOG.md * Update tests * Improve handling of scenario weights * Improve docs * Typos * Rename in tests * Add removal warnings to deprecated parameters * Update CHANGELOG.md * Add deprectation test * Add deprectation test * Add remaining deprectation warnings and tests * Move DEPRECATION_REMOVAL_VERSION to core.py * Reevrt Merge issue * Add infos to CHANGELOG.md
1 parent 401654c commit 4d63dbb

8 files changed

Lines changed: 500 additions & 85 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,11 @@ Period weights are now always computed from the period index.
142142

143143
All deprecated names continue working with warnings. **They will be removed in v5.0.0.**
144144

145+
**Additional property deprecations now include removal version:**
146+
- `InvestParameters`: `fix_effects`, `specific_effects`, `divest_effects`, `piecewise_effects`
147+
- `OnOffParameters`: `on_hours_total_min`, `on_hours_total_max`, `switch_on_total_max`
148+
- `Flow`: `flow_hours_total_min`, `flow_hours_total_max`
149+
145150
### 🐛 Fixed
146151
- Fixed inconsistent boundary checks in linear converters with array-like inputs
147152

‎flixopt/components.py‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from .features import InvestmentModel, PiecewiseModel
1818
from .interface import InvestParameters, OnOffParameters, PiecewiseConversion
1919
from .modeling import BoundingPatterns
20-
from .structure import FlowSystemModel, register_class_for_io
20+
from .structure import DEPRECATION_REMOVAL_VERSION, FlowSystemModel, register_class_for_io
2121

2222
if TYPE_CHECKING:
2323
import linopy
@@ -416,7 +416,8 @@ def __init__(
416416
)
417417
if isinstance(initial_charge_state, str) and initial_charge_state == 'lastValueOfSim':
418418
warnings.warn(
419-
f'{initial_charge_state=} is deprecated. Use "equals_final" instead.',
419+
f'{initial_charge_state=} is deprecated. Use "equals_final" instead. '
420+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
420421
DeprecationWarning,
421422
stacklevel=2,
422423
)
@@ -1122,7 +1123,8 @@ def __init__(
11221123
@property
11231124
def source(self) -> Flow:
11241125
warnings.warn(
1125-
'The source property is deprecated. Use the outputs property instead.',
1126+
'The source property is deprecated. Use the outputs property instead. '
1127+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
11261128
DeprecationWarning,
11271129
stacklevel=2,
11281130
)
@@ -1131,7 +1133,8 @@ def source(self) -> Flow:
11311133
@property
11321134
def sink(self) -> Flow:
11331135
warnings.warn(
1134-
'The sink property is deprecated. Use the inputs property instead.',
1136+
'The sink property is deprecated. Use the inputs property instead. '
1137+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
11351138
DeprecationWarning,
11361139
stacklevel=2,
11371140
)
@@ -1140,7 +1143,8 @@ def sink(self) -> Flow:
11401143
@property
11411144
def prevent_simultaneous_sink_and_source(self) -> bool:
11421145
warnings.warn(
1143-
'The prevent_simultaneous_sink_and_source property is deprecated. Use the prevent_simultaneous_flow_rates property instead.',
1146+
'The prevent_simultaneous_sink_and_source property is deprecated. Use the prevent_simultaneous_flow_rates property instead. '
1147+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
11441148
DeprecationWarning,
11451149
stacklevel=2,
11461150
)
@@ -1248,7 +1252,8 @@ def __init__(
12481252
@property
12491253
def source(self) -> Flow:
12501254
warnings.warn(
1251-
'The source property is deprecated. Use the outputs property instead.',
1255+
'The source property is deprecated. Use the outputs property instead. '
1256+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
12521257
DeprecationWarning,
12531258
stacklevel=2,
12541259
)
@@ -1373,7 +1378,8 @@ def __init__(
13731378
@property
13741379
def sink(self) -> Flow:
13751380
warnings.warn(
1376-
'The sink property is deprecated. Use the inputs property instead.',
1381+
'The sink property is deprecated. Use the inputs property instead. '
1382+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
13771383
DeprecationWarning,
13781384
stacklevel=2,
13791385
)

‎flixopt/core.py‎

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
FlowSystemDimensions = Literal['time', 'period', 'scenario']
1818
"""Possible dimensions of a FlowSystem."""
1919

20+
# Deprecation removal version - update this when planning the next major version
21+
DEPRECATION_REMOVAL_VERSION = '5.0.0'
22+
2023

2124
class PlausibilityError(Exception):
2225
"""Error for a failing Plausibility check."""
@@ -54,10 +57,20 @@ def __init__(
5457
**kwargs: Additional arguments passed to DataArray
5558
"""
5659
if agg_group is not None:
57-
warnings.warn('agg_group is deprecated, use aggregation_group instead', DeprecationWarning, stacklevel=2)
60+
warnings.warn(
61+
f'agg_group is deprecated, use aggregation_group instead. '
62+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
63+
DeprecationWarning,
64+
stacklevel=2,
65+
)
5866
aggregation_group = agg_group
5967
if agg_weight is not None:
60-
warnings.warn('agg_weight is deprecated, use aggregation_weight instead', DeprecationWarning, stacklevel=2)
68+
warnings.warn(
69+
f'agg_weight is deprecated, use aggregation_weight instead. '
70+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
71+
DeprecationWarning,
72+
stacklevel=2,
73+
)
6174
aggregation_weight = agg_weight
6275

6376
if (aggregation_group is not None) and (aggregation_weight is not None):
@@ -132,12 +145,22 @@ def __repr__(self):
132145

133146
@property
134147
def agg_group(self):
135-
warnings.warn('agg_group is deprecated, use aggregation_group instead', DeprecationWarning, stacklevel=2)
148+
warnings.warn(
149+
f'agg_group is deprecated, use aggregation_group instead. '
150+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
151+
DeprecationWarning,
152+
stacklevel=2,
153+
)
136154
return self.aggregation_group
137155

138156
@property
139157
def agg_weight(self):
140-
warnings.warn('agg_weight is deprecated, use aggregation_weight instead', DeprecationWarning, stacklevel=2)
158+
warnings.warn(
159+
f'agg_weight is deprecated, use aggregation_weight instead. '
160+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
161+
DeprecationWarning,
162+
stacklevel=2,
163+
)
141164
return self.aggregation_weight
142165

143166

‎flixopt/elements.py‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,14 @@
1717
from .features import InvestmentModel, OnOffModel
1818
from .interface import InvestParameters, OnOffParameters
1919
from .modeling import BoundingPatterns, ModelingPrimitives, ModelingUtilitiesAbstract
20-
from .structure import Element, ElementModel, FlowSystemModel, Interface, register_class_for_io
20+
from .structure import (
21+
DEPRECATION_REMOVAL_VERSION,
22+
Element,
23+
ElementModel,
24+
FlowSystemModel,
25+
Interface,
26+
register_class_for_io,
27+
)
2128

2229
if TYPE_CHECKING:
2330
import linopy
@@ -615,7 +622,8 @@ def size_is_fixed(self) -> bool:
615622
def flow_hours_total_max(self):
616623
"""DEPRECATED: Use 'flow_hours_max' property instead."""
617624
warnings.warn(
618-
"Property 'flow_hours_total_max' is deprecated. Use 'flow_hours_max' instead.",
625+
f"Property 'flow_hours_total_max' is deprecated. Use 'flow_hours_max' instead. "
626+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
619627
DeprecationWarning,
620628
stacklevel=2,
621629
)
@@ -625,7 +633,8 @@ def flow_hours_total_max(self):
625633
def flow_hours_total_max(self, value):
626634
"""DEPRECATED: Use 'flow_hours_max' property instead."""
627635
warnings.warn(
628-
"Property 'flow_hours_total_max' is deprecated. Use 'flow_hours_max' instead.",
636+
f"Property 'flow_hours_total_max' is deprecated. Use 'flow_hours_max' instead. "
637+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
629638
DeprecationWarning,
630639
stacklevel=2,
631640
)
@@ -635,7 +644,8 @@ def flow_hours_total_max(self, value):
635644
def flow_hours_total_min(self):
636645
"""DEPRECATED: Use 'flow_hours_min' property instead."""
637646
warnings.warn(
638-
"Property 'flow_hours_total_min' is deprecated. Use 'flow_hours_min' instead.",
647+
f"Property 'flow_hours_total_min' is deprecated. Use 'flow_hours_min' instead. "
648+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
639649
DeprecationWarning,
640650
stacklevel=2,
641651
)
@@ -645,7 +655,8 @@ def flow_hours_total_min(self):
645655
def flow_hours_total_min(self, value):
646656
"""DEPRECATED: Use 'flow_hours_min' property instead."""
647657
warnings.warn(
648-
"Property 'flow_hours_total_min' is deprecated. Use 'flow_hours_min' instead.",
658+
f"Property 'flow_hours_total_min' is deprecated. Use 'flow_hours_min' instead. "
659+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
649660
DeprecationWarning,
650661
stacklevel=2,
651662
)

‎flixopt/interface.py‎

Lines changed: 35 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
from loguru import logger
1515

1616
from .config import CONFIG
17-
from .structure import Interface, register_class_for_io
17+
from .structure import DEPRECATION_REMOVAL_VERSION, Interface, register_class_for_io
1818

1919
if TYPE_CHECKING: # for type checking and preventing circular imports
2020
from collections.abc import Iterator
@@ -916,7 +916,8 @@ def __init__(
916916
# For mandatory parameter with non-None default, disable conflict checking
917917
if 'optional' in kwargs:
918918
warnings.warn(
919-
'Deprecated parameter "optional" used. Check conflicts with new parameter "mandatory" manually!',
919+
'Deprecated parameter "optional" used. Check conflicts with new parameter "mandatory" manually! '
920+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
920921
DeprecationWarning,
921922
stacklevel=2,
922923
)
@@ -1009,20 +1010,31 @@ def optional(self) -> bool:
10091010
"""DEPRECATED: Use 'mandatory' property instead. Returns the opposite of 'mandatory'."""
10101011
import warnings
10111012

1012-
warnings.warn("Property 'optional' is deprecated. Use 'mandatory' instead.", DeprecationWarning, stacklevel=2)
1013+
warnings.warn(
1014+
f"Property 'optional' is deprecated. Use 'mandatory' instead. "
1015+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
1016+
DeprecationWarning,
1017+
stacklevel=2,
1018+
)
10131019
return not self.mandatory
10141020

10151021
@optional.setter
10161022
def optional(self, value: bool):
10171023
"""DEPRECATED: Use 'mandatory' property instead. Sets the opposite of the given value to 'mandatory'."""
1018-
warnings.warn("Property 'optional' is deprecated. Use 'mandatory' instead.", DeprecationWarning, stacklevel=2)
1024+
warnings.warn(
1025+
f"Property 'optional' is deprecated. Use 'mandatory' instead. "
1026+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
1027+
DeprecationWarning,
1028+
stacklevel=2,
1029+
)
10191030
self.mandatory = not value
10201031

10211032
@property
10221033
def fix_effects(self) -> Effect_PS | Numeric_PS:
10231034
"""Deprecated property. Use effects_of_investment instead."""
10241035
warnings.warn(
1025-
'The fix_effects property is deprecated. Use effects_of_investment instead.',
1036+
f'The fix_effects property is deprecated. Use effects_of_investment instead. '
1037+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
10261038
DeprecationWarning,
10271039
stacklevel=2,
10281040
)
@@ -1032,7 +1044,8 @@ def fix_effects(self) -> Effect_PS | Numeric_PS:
10321044
def specific_effects(self) -> Effect_PS | Numeric_PS:
10331045
"""Deprecated property. Use effects_of_investment_per_size instead."""
10341046
warnings.warn(
1035-
'The specific_effects property is deprecated. Use effects_of_investment_per_size instead.',
1047+
f'The specific_effects property is deprecated. Use effects_of_investment_per_size instead. '
1048+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
10361049
DeprecationWarning,
10371050
stacklevel=2,
10381051
)
@@ -1042,7 +1055,8 @@ def specific_effects(self) -> Effect_PS | Numeric_PS:
10421055
def divest_effects(self) -> Effect_PS | Numeric_PS:
10431056
"""Deprecated property. Use effects_of_retirement instead."""
10441057
warnings.warn(
1045-
'The divest_effects property is deprecated. Use effects_of_retirement instead.',
1058+
f'The divest_effects property is deprecated. Use effects_of_retirement instead. '
1059+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
10461060
DeprecationWarning,
10471061
stacklevel=2,
10481062
)
@@ -1052,7 +1066,8 @@ def divest_effects(self) -> Effect_PS | Numeric_PS:
10521066
def piecewise_effects(self) -> PiecewiseEffects | None:
10531067
"""Deprecated property. Use piecewise_effects_of_investment instead."""
10541068
warnings.warn(
1055-
'The piecewise_effects property is deprecated. Use piecewise_effects_of_investment instead.',
1069+
f'The piecewise_effects property is deprecated. Use piecewise_effects_of_investment instead. '
1070+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
10561071
DeprecationWarning,
10571072
stacklevel=2,
10581073
)
@@ -1378,10 +1393,9 @@ def use_switch_on(self) -> bool:
13781393
@property
13791394
def on_hours_total_min(self):
13801395
"""DEPRECATED: Use 'on_hours_min' property instead."""
1381-
import warnings
1382-
13831396
warnings.warn(
1384-
"Property 'on_hours_total_min' is deprecated. Use 'on_hours_min' instead.",
1397+
f"Property 'on_hours_total_min' is deprecated. Use 'on_hours_min' instead. "
1398+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
13851399
DeprecationWarning,
13861400
stacklevel=2,
13871401
)
@@ -1390,10 +1404,9 @@ def on_hours_total_min(self):
13901404
@on_hours_total_min.setter
13911405
def on_hours_total_min(self, value):
13921406
"""DEPRECATED: Use 'on_hours_min' property instead."""
1393-
import warnings
1394-
13951407
warnings.warn(
1396-
"Property 'on_hours_total_min' is deprecated. Use 'on_hours_min' instead.",
1408+
f"Property 'on_hours_total_min' is deprecated. Use 'on_hours_min' instead. "
1409+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
13971410
DeprecationWarning,
13981411
stacklevel=2,
13991412
)
@@ -1402,10 +1415,9 @@ def on_hours_total_min(self, value):
14021415
@property
14031416
def on_hours_total_max(self):
14041417
"""DEPRECATED: Use 'on_hours_max' property instead."""
1405-
import warnings
1406-
14071418
warnings.warn(
1408-
"Property 'on_hours_total_max' is deprecated. Use 'on_hours_max' instead.",
1419+
f"Property 'on_hours_total_max' is deprecated. Use 'on_hours_max' instead. "
1420+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
14091421
DeprecationWarning,
14101422
stacklevel=2,
14111423
)
@@ -1414,10 +1426,9 @@ def on_hours_total_max(self):
14141426
@on_hours_total_max.setter
14151427
def on_hours_total_max(self, value):
14161428
"""DEPRECATED: Use 'on_hours_max' property instead."""
1417-
import warnings
1418-
14191429
warnings.warn(
1420-
"Property 'on_hours_total_max' is deprecated. Use 'on_hours_max' instead.",
1430+
f"Property 'on_hours_total_max' is deprecated. Use 'on_hours_max' instead. "
1431+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
14211432
DeprecationWarning,
14221433
stacklevel=2,
14231434
)
@@ -1426,10 +1437,9 @@ def on_hours_total_max(self, value):
14261437
@property
14271438
def switch_on_total_max(self):
14281439
"""DEPRECATED: Use 'switch_on_max' property instead."""
1429-
import warnings
1430-
14311440
warnings.warn(
1432-
"Property 'switch_on_total_max' is deprecated. Use 'switch_on_max' instead.",
1441+
f"Property 'switch_on_total_max' is deprecated. Use 'switch_on_max' instead. "
1442+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
14331443
DeprecationWarning,
14341444
stacklevel=2,
14351445
)
@@ -1438,10 +1448,9 @@ def switch_on_total_max(self):
14381448
@switch_on_total_max.setter
14391449
def switch_on_total_max(self, value):
14401450
"""DEPRECATED: Use 'switch_on_max' property instead."""
1441-
import warnings
1442-
14431451
warnings.warn(
1444-
"Property 'switch_on_total_max' is deprecated. Use 'switch_on_max' instead.",
1452+
f"Property 'switch_on_total_max' is deprecated. Use 'switch_on_max' instead. "
1453+
f'Will be removed in v{DEPRECATION_REMOVAL_VERSION}.',
14451454
DeprecationWarning,
14461455
stacklevel=2,
14471456
)

0 commit comments

Comments
 (0)