Add fine-grained Result types for the PowerDistributingActor (#104)

Improve power distributing results.

Author: ela-kotulska-frequenz

RELEASE_NOTES.md

@@ -8,6 +8,10 @@
 
 <!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with --> 
 
+- Add fine-grained Result types for the PowerDistributingActor.
+    Previously Result was one class with many fields. Now each result has its own class
+    that derives from Result parent class.
+
 ## New Features
 
 <!-- Here goes the main new features and examples or instructions on how to use them -->

benchmarks/power_distribution/power_distributor.py

@@ -14,9 +14,14 @@
 from frequenz.channels import Bidirectional
 
 from frequenz.sdk.actor.power_distributing import (
+    Error,
+    Ignored,
+    OutOfBound,
+    PartialFailure,
     PowerDistributingActor,
     Request,
     Result,
+    Success,
 )
 from frequenz.sdk.microgrid import ComponentGraph
 from frequenz.sdk.microgrid._graph import _MicrogridComponentGraph
@@ -75,21 +80,23 @@ def parse_result(result: List[List[Result]]) -> Dict[str, float]:
         Number of each result.
     """
     result_counts = {
-        Result.Status.ERROR: 0,
-        Result.Status.IGNORED: 0,
-        Result.Status.SUCCESS: 0,
-        Result.Status.FAILED: 0,
+        Error: 0,
+        Ignored: 0,
+        Success: 0,
+        PartialFailure: 0,
+        OutOfBound: 0,
     }
 
     for result_list in result:
         for item in result_list:
-            result_counts[item.status] += 1
+            result_counts[type(item)] += 1
 
     return {
-        "success_num": result_counts[Result.Status.SUCCESS],
-        "failed_num": result_counts[Result.Status.FAILED],
-        "ignore_num": result_counts[Result.Status.IGNORED],
-        "error_num": result_counts[Result.Status.ERROR],
+        "success_num": result_counts[Success],
+        "failed_num": result_counts[PartialFailure],
+        "ignore_num": result_counts[Ignored],
+        "error_num": result_counts[Error],
+        "out_of_bound": result_counts[OutOfBound],
     }
 
 

examples/power_distribution.py

@@ -27,6 +27,7 @@
     PowerDistributingActor,
     Request,
     Result,
+    Success,
 )
 from frequenz.sdk.microgrid.component import Component, ComponentCategory
 
@@ -97,14 +98,12 @@ async def run(self) -> None:
                 continue
             if result is None:
                 raise RuntimeError("PowerDistributingActor channel has been closed.")
-            if result.status != Result.Status.SUCCESS:
+            if not isinstance(result, Success):
                 _logger.error(
-                    "Could not set %d power. Result: %s", power_to_set, str(result)
+                    "Could not set %d power. Result: %s", power_to_set, type(result)
                 )
             else:
-                _logger.info(
-                    "Set power with %d succeed, result: %s", power_to_set, str(result)
-                )
+                _logger.info("Set power with %d succeed.", power_to_set)
 
 
 @actor

src/frequenz/sdk/actor/__init__.py

@@ -3,7 +3,6 @@
 
 """A base class for creating simple composable actors."""
 
-from . import power_distributing
 from ._channel_registry import ChannelRegistry
 from ._config_managing import ConfigManagingActor
 from ._data_sourcing import ComponentMetricRequest, DataSourcingActor
@@ -17,5 +16,4 @@
     "ConfigManagingActor",
     "DataSourcingActor",
     "actor",
-    "power_distributing",
 ]

src/frequenz/sdk/actor/power_distributing/__init__.py

@@ -0,0 +1,26 @@
+# License: MIT
+# Copyright © 2022 Frequenz Energy-as-a-Service GmbH
+
+"""This module provides feature to set power between many batteries.
+
+Distributing power is very important to keep the microgrid ready
+for the power requirements.
+This module provides PowerDistributingActor that knows how to distribute power.
+It also provides all the secondary features that should be used to communicate with
+PowerDistributingActor and send requests for charging or discharging power.
+"""
+
+from .power_distributing import PowerDistributingActor
+from .request import Request
+from .result import Error, Ignored, OutOfBound, PartialFailure, Result, Success
+
+__all__ = [
+    "PowerDistributingActor",
+    "Request",
+    "Result",
+    "Error",
+    "Success",
+    "Ignored",
+    "OutOfBound",
+    "PartialFailure",
+]