Skip to content

Commit cc5b004

Browse files
committed
Rename FormulaBuilder to ResampledFormulaBuilder
The class is for building formulas using streams from the resampling actor. The renaming makes it clear, and allows for the `FormulaBuilder` name to be repurposed. Signed-off-by: Sahas Subramanian <[email protected]>
1 parent 458047f commit cc5b004

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

src/frequenz/sdk/timeseries/logical_meter/_logical_meter.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
from ...actor import ChannelRegistry, ComponentMetricRequest
1313
from ...microgrid.component import ComponentMetricId
1414
from .._sample import Sample
15-
from ._formula_builder import FormulaBuilder
1615
from ._formula_engine import FormulaEngine
16+
from ._resampled_formula_builder import ResampledFormulaBuilder
1717

1818

1919
class LogicalMeter:
@@ -54,7 +54,7 @@ def __init__(
5454
async def _engine_from_formula_string(
5555
self, formula: str, metric_id: ComponentMetricId, nones_are_zeros: bool
5656
) -> FormulaEngine:
57-
builder = FormulaBuilder(
57+
builder = ResampledFormulaBuilder(
5858
self._namespace,
5959
self._channel_registry,
6060
self._resampler_subscription_sender,

src/frequenz/sdk/timeseries/logical_meter/_formula_builder.py renamed to src/frequenz/sdk/timeseries/logical_meter/_resampled_formula_builder.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
from ._tokenizer import Tokenizer, TokenType
1414

1515

16-
class FormulaBuilder:
16+
class ResampledFormulaBuilder:
1717
"""Provides a way to build a FormulaEngine from resampled data streams."""
1818

1919
def __init__(
@@ -23,7 +23,7 @@ def __init__(
2323
resampler_subscription_sender: Sender[ComponentMetricRequest],
2424
metric_id: ComponentMetricId,
2525
) -> None:
26-
"""Create a `FormulaBuilder` instance.
26+
"""Create a `ResampledFormulaBuilder` instance.
2727
2828
Args:
2929
namespace: The unique namespace to allow reuse of streams in the data
@@ -44,7 +44,7 @@ async def _get_resampled_receiver(self, component_id: int) -> Receiver[Sample]:
4444
"""Get a receiver with the resampled data for the given component id.
4545
4646
This receiver would contain data for the `metric_id` specified when creating the
47-
`FormulaBuilder` instance.
47+
`ResampledFormulaBuilder` instance.
4848
4949
Args:
5050
component_id: The component id for which to get a resampled data receiver.

tests/timeseries/test_logical_meter.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
)
2626
from frequenz.sdk.microgrid.component import ComponentMetricId
2727
from frequenz.sdk.timeseries.logical_meter import LogicalMeter
28-
from frequenz.sdk.timeseries.logical_meter._formula_builder import FormulaBuilder
28+
from frequenz.sdk.timeseries.logical_meter._resampled_formula_builder import (
29+
ResampledFormulaBuilder,
30+
)
2931
from tests.microgrid import mock_api
3032

3133

@@ -149,7 +151,7 @@ async def test_1(self, mocker: MockerFixture) -> None:
149151
# `_get_resampled_receiver` function implementation.
150152

151153
# pylint: disable=protected-access
152-
builder = FormulaBuilder(
154+
builder = ResampledFormulaBuilder(
153155
logical_meter._namespace,
154156
channel_registry,
155157
request_sender,

0 commit comments

Comments
 (0)