Allow targeting categories with subtypes #168

Marenz · 2025-05-19T17:25:34Z

Update to latest dispatch-api
Implement extra classes for each target type

Fixes #139

Renames a few fields, but stays compatible otherwise. Signed-off-by: Mathias L. Baumann <[email protected]>

..and support the latest CategoryAndType target type. This implements extra classes for each target component case: * List of Ids `TargetIds` * List of categories: `TargetCategories` * List of categories + subtypes: `TargetCategoriesAndTypes` This was easier to do together as the addition of the new type increased the places where it was difficult to find out what the actual target type/ids is/are. Signed-off-by: Mathias L. Baumann <[email protected]>

Marenz · 2025-05-19T17:28:30Z

src/frequenz/client/dispatch/__main__.py

@@ -86,7 +86,8 @@ def print_dispatch(dispatch: Dispatch) -> None:
    # Format the target
    if dispatch.target:
        if len(dispatch.target) == 1:
-            target_str: str = str(dispatch.target[0])
+            (el,) = dispatch.target
+            target_str: str = str(el)


This change is because target is a frozenset now

OK, but why can't use use [0] for something frozen? You should be able, or is it because it is a set now?

Also what the hell does el stands for? It look it is pretty cryptic. Also if you need to clarify in the PR, maybe it is best to add a comment in the code itself for the future ourselves looking at this code.

You cannot index-access a set, it has no order :)

el stands for element.. sure I'll make it more clear 😄
I was surprised as well, but this seems to be the easiest way to access the only element of a set with size 1

llucax

LGTM in general, although not completely convinced about the current approach with CategoryAndType, looks a bit too low-level for the "high-level interface".

llucax · 2025-05-20T07:55:25Z

src/frequenz/client/dispatch/__main__.py

@@ -86,7 +86,8 @@ def print_dispatch(dispatch: Dispatch) -> None:
    # Format the target
    if dispatch.target:
        if len(dispatch.target) == 1:
-            target_str: str = str(dispatch.target[0])
+            (el,) = dispatch.target
+            target_str: str = str(el)


OK, but why can't use use [0] for something frozen? You should be able, or is it because it is a set now?

Also what the hell does el stands for? It look it is pretty cryptic. Also if you need to clarify in the PR, maybe it is best to add a comment in the code itself for the future ourselves looking at this code.

llucax · 2025-05-20T07:58:41Z

src/frequenz/client/dispatch/types.py

+class EvChargerType(IntEnum):
+    """Enum representing the type of EV charger."""
+
+    EV_CHARGER_TYPE_UNSPECIFIED = PBEvChargerType.EV_CHARGER_TYPE_UNSPECIFIED
+    """Unspecified type of EV charger."""
+
+    EV_CHARGER_TYPE_AC = PBEvChargerType.EV_CHARGER_TYPE_AC
+    """AC EV charger."""
+
+    EV_CHARGER_TYPE_DC = PBEvChargerType.EV_CHARGER_TYPE_DC
+    """DC EV charger."""
+
+    EV_CHARGER_TYPE_HYBRID = PBEvChargerType.EV_CHARGER_TYPE_HYBRID
+    """Hybrid EV charger."""


I have these in the microgrid API too, next step is to move them to client-common so we can share it. I will do a PR with this soon after I finish the microgrid API 0.17 PR, probably this week. But just FYI, I think we should move forward adding it where needed locally as it might take some time to agree on something we are all happy about to put in common + release. In any case, I would remove the EV_CHARGER_TYPE_ prefix here.

llucax · 2025-05-20T08:25:40Z

src/frequenz/client/dispatch/test/generator.py

@@ -66,6 +76,30 @@ def generate_recurrence_rule(self) -> RecurrenceRule:
            ],
        )

+    def generate_target_cat_and_type(self) -> CategoryAndType:


Nitpick: This is already pretty long, I wouldn't save the 5 extra chars from egory.

You're worse than copilot

llucax · 2025-05-20T08:26:57Z

src/frequenz/client/dispatch/types.py

+
+This is a frozen set, so it is immutable.
+The target components are used to specify the components that a dispatch
+should target.


Maybe include a match example here?

llucax · 2025-05-20T08:34:17Z

tests/test_proto.py

@@ -99,7 +130,7 @@ def test_dispatch() -> None:
            start_time=datetime(2024, 10, 10, tzinfo=timezone.utc),
            end_time=datetime(2024, 10, 20, tzinfo=timezone.utc),
            duration=timedelta(days=10),
-            target=[1, 2, 3],
+            target=TargetIds([1, 2, 3]),


Maybe we can add a __init__() here to simply allow: TargetIds(1, 2, 3)?

llucax · 2025-05-20T08:34:36Z

tests/test_proto.py

@@ -120,7 +151,7 @@ def test_dispatch() -> None:
            start_time=datetime(2024, 11, 10, tzinfo=timezone.utc),
            end_time=datetime(2024, 11, 20, tzinfo=timezone.utc),
            duration=timedelta(seconds=20),
-            target=[ComponentCategory.BATTERY],
+            target=TargetCategories([ComponentCategory.BATTERY]),


Same here: TargetCategories(ComponentCategory.BATTERY) and for TargetCategoryAndTypes, maybe allow something like TargetCategoryAndTypes(ComponentCategory.BATTERY, InverterType.SOLAR) (as with the type, we can infer the category, seems to be pretty redundant to require both).

llucax · 2025-05-20T08:56:21Z

src/frequenz/client/dispatch/types.py

+@dataclass(frozen=True)
+class CategoryAndType:
+    """Represents a category and type of dispatch."""
+
+    category: ComponentCategory
+    """The category of the dispatch."""
+
+    type: BatteryType | EvChargerType | InverterType | None
+    """The type of the dispatch."""


This is probably for the API repo, but it seems we now have overlapping target options:

TargetCategories([cat1, cat2]) == TargetCategoryAndTypes([CategoryAndType(cat1), CategoryAndType(cat2)])

(figuratively speaking)

As for the high-level user interface, since as soon as we have a type, the category can be inferred, I would simplify for the end user:

# Could still be CategoryAndType, but it sounds a bit weird type is not always present @dataclass(frozen=True) class Group: target: ComponentCategory | BatteryType | EvChargerType | InverterType @property def category(self) -> ComponentCategory: match self.target: case ComponentCategory(): return self.target case BattertyType(): return ComponentCategory.BATTERY ... @property def type(self) -> ComponentCategory: match self.target: case ComponentCategory(): return None case type: return type ...

And then add a ctor to class TargetCategoryAndTypes to allow for:

TargetCategoryAndTypes(ComponentCategory.BATTERY, InverterType.SOLAR)

to result in:

frozenset([Group(ComponentCategory.BATTERY), Group(InverterType.SOLAR)])

I'm not sure if we already touched on the redundancy between CategorySet and CategoryTypeSet in the protocol, if not maybe we should.

I'm not sure if we already touched on the redundancy between CategorySet and CategoryTypeSet in the protocol, if not maybe we should.

We don't need to talk about those redundancies because they are deprecated and scheduled to be removed, the whole typeless category and it's field in the oneof construct will be gone once all clients are a capable of reading/writing both.

llucax · 2025-05-20T09:01:31Z

src/frequenz/client/dispatch/_cli_types.py

@@ -5,13 +5,23 @@

 import json
 from datetime import datetime, timedelta, timezone
+from sre_constants import IN


I bet this was Tab-oriented-programming + auto-import 😆

Suggested change

from sre_constants import IN

it was more desperation, but this is a draft after all :P

Marenz added 2 commits May 19, 2025 17:49

Update to latest dispatch-api

a6ff472

Renames a few fields, but stays compatible otherwise. Signed-off-by: Mathias L. Baumann <[email protected]>

Marenz commented May 19, 2025

View reviewed changes

llucax reviewed May 20, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow targeting categories with subtypes #168

Allow targeting categories with subtypes #168

Marenz commented May 19, 2025 •

edited

Loading

Marenz May 19, 2025

llucax May 20, 2025

Marenz May 20, 2025

llucax left a comment

llucax May 20, 2025

llucax May 20, 2025

llucax May 20, 2025

Marenz May 20, 2025

llucax May 20, 2025

llucax May 20, 2025

llucax May 20, 2025

llucax May 20, 2025

Marenz May 20, 2025

llucax May 20, 2025

Marenz May 20, 2025

Allow targeting categories with subtypes #168

Are you sure you want to change the base?

Allow targeting categories with subtypes #168

Conversation

Marenz commented May 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

llucax left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Marenz commented May 19, 2025 •

edited

Loading