Skip to content

Commit a7d04e5

Browse files
committed
Rename frequenz.sdk.{_formula_engine => formula_engine}
This makes the formula engine a public module, and allows the public facing `FormulaEngine` and `FormulaEngine3Phase` types to be better documented. Signed-off-by: Sahas Subramanian <[email protected]>
1 parent 0fb0e58 commit a7d04e5

28 files changed

+24
-23
lines changed

src/frequenz/sdk/timeseries/battery_pool/_battery_pool.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717
from ..._internal._channels import ReceiverFetcher
1818
from ...actor import _power_managing
1919
from ...timeseries import Energy, Percentage, Power, Sample, Temperature
20-
from .._formula_engine import FormulaEngine
21-
from .._formula_engine._formula_generators import (
20+
from ..formula_engine import FormulaEngine
21+
from ..formula_engine._formula_generators import (
2222
BatteryPowerFormula,
2323
FormulaGeneratorConfig,
2424
FormulaType,

src/frequenz/sdk/timeseries/battery_pool/_battery_pool_reference_store.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
from ...actor.power_distributing._battery_pool_status import BatteryStatus
1818
from ...microgrid import connection_manager
1919
from ...microgrid.component import ComponentCategory
20-
from .._formula_engine import FormulaEnginePool
20+
from ..formula_engine import FormulaEnginePool
2121
from ._methods import MetricAggregator
2222

2323

src/frequenz/sdk/timeseries/ev_charger_pool/_ev_charger_pool.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@
1919
from ...microgrid import connection_manager
2020
from ...microgrid.component import ComponentCategory, ComponentMetricId
2121
from .. import Sample, Sample3Phase
22-
from .._formula_engine import FormulaEngine, FormulaEngine3Phase, FormulaEnginePool
23-
from .._formula_engine._formula_generators import (
22+
from .._quantities import Current, Power, Quantity
23+
from ..formula_engine import FormulaEngine, FormulaEngine3Phase, FormulaEnginePool
24+
from ..formula_engine._formula_generators import (
2425
EVChargerCurrentFormula,
2526
EVChargerPowerFormula,
2627
FormulaGeneratorConfig,
2728
FormulaType,
2829
)
29-
from .._quantities import Current, Power, Quantity
3030
from ._set_current_bounds import BoundsSetter, ComponentCurrentLimit
3131
from ._state_tracker import EVChargerState, StateTracker
3232

src/frequenz/sdk/timeseries/_formula_engine/__init__.py renamed to src/frequenz/sdk/timeseries/formula_engine/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
# Copyright © 2023 Frequenz Energy-as-a-Service GmbH
33

44
"""A formula engine for applying formulas."""
5+
56
from ._formula_engine import FormulaEngine, FormulaEngine3Phase
67
from ._formula_engine_pool import FormulaEnginePool
78
from ._resampled_formula_builder import ResampledFormulaBuilder

src/frequenz/sdk/timeseries/_formula_engine/_exceptions.py renamed to src/frequenz/sdk/timeseries/formula_engine/_exceptions.py

File renamed without changes.

src/frequenz/sdk/timeseries/_formula_engine/_formula_engine.py renamed to src/frequenz/sdk/timeseries/formula_engine/_formula_engine.py

File renamed without changes.

src/frequenz/sdk/timeseries/_formula_engine/_formula_engine_pool.py renamed to src/frequenz/sdk/timeseries/formula_engine/_formula_engine_pool.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
if TYPE_CHECKING:
2222
# Break circular import by enclosing these type hints in a `TYPE_CHECKING` block.
23-
from .._formula_engine import FormulaEngine, FormulaEngine3Phase
23+
from ..formula_engine import FormulaEngine, FormulaEngine3Phase
2424

2525

2626
class FormulaEnginePool:

src/frequenz/sdk/timeseries/_formula_engine/_formula_evaluator.py renamed to src/frequenz/sdk/timeseries/formula_engine/_formula_evaluator.py

File renamed without changes.

src/frequenz/sdk/timeseries/_formula_engine/_formula_formatter.py renamed to src/frequenz/sdk/timeseries/formula_engine/_formula_formatter.py

File renamed without changes.

src/frequenz/sdk/timeseries/_formula_engine/_formula_generators/__init__.py renamed to src/frequenz/sdk/timeseries/formula_engine/_formula_generators/__init__.py

File renamed without changes.

0 commit comments

Comments
 (0)