Skip to content

Replace FormulaEngine subclasses with type aliases #1331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shsms merged 2 commits into from
Dec 16, 2025
Merged

Replace FormulaEngine subclasses with type aliases #1331

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
947566c
Replace FormulaEngine subclasses with type aliases
shsms Dec 16, 2025
79ad357
Update release notes
shsms Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
# Frequenz Python SDK Release Notes

## Upgrading
## Bug fixes

- The `FormulaEngine` is now replaced by a newly implemented `Formula` type. This doesn't affect the high level interfaces. `FormulaEngine` is now a deprecated wrapper to `Formula`.

- The `ComponentGraph` has been replaced by the `frequenz-microgrid-component-graph` package, which provides python bindings for the rust implementation.

## New Features

- The power manager algorithm for batteries can now be changed from the default ShiftingMatryoshka, by passing it as an argument to `microgrid.initialize()`
- `FormulaEngine` and `FormulaEngine3Phase` are now type aliases to `Formula` and `Formula3Phase`, fixing a typing issue introduced in `v1.0.0-rc2202`.
27 changes: 3 additions & 24 deletions src/frequenz/sdk/timeseries/formula_engine/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,14 @@
"""Deprecated Formula Engine."""


from typing_extensions import deprecated
from typing_extensions import TypeAlias

from .._base_types import QuantityT
from ..formulas._formula import Formula
from ..formulas._formula_3_phase import Formula3Phase


@deprecated(
"The FormulaEngine class is deprecated and will be removed in a future release. "
+ "Please use the Formula class instead."
)
class FormulaEngine(Formula[QuantityT]):
"""Deprecated Formula Engine class.

This class is deprecated and will be removed in a future release.
Please use the `Formula` and `Formula3Phase` classes directly.
"""


@deprecated(
"The FormulaEngine3Phase class is deprecated and will be removed in a future release. "
+ "Please use the Formula3Phase class instead."
)
class FormulaEngine3Phase(Formula3Phase[QuantityT]):
"""Deprecated FormulaEngine3Phase class.

This class is deprecated and will be removed in a future release.
Please use the `Formula3Phase` class directly.
"""
FormulaEngine: TypeAlias = Formula[QuantityT]
FormulaEngine3Phase: TypeAlias = Formula3Phase[QuantityT]


__all__ = ["FormulaEngine", "FormulaEngine3Phase"]