Rename power distributing actor result OutOfBound -> OutOfBounds

Also rename `OutOfBounds.bound` to `OutOfBounds.bounds`.  Because
bounds are a range and not a single value in a single direction,
calling it `Bounds` is more accurate.

Signed-off-by: Sahas Subramanian <[email protected]>

Author: shsms

benchmarks/power_distribution/power_distributor.py

@@ -17,7 +17,7 @@
 from frequenz.sdk.actor.power_distributing import (
     BatteryStatus,
     Error,
-    OutOfBound,
+    OutOfBounds,
     PartialFailure,
     PowerDistributingActor,
     Request,
@@ -75,7 +75,7 @@ def parse_result(result: List[List[Result]]) -> Dict[str, float]:
         Error: 0,
         Success: 0,
         PartialFailure: 0,
-        OutOfBound: 0,
+        OutOfBounds: 0,
     }
 
     for result_list in result:
@@ -86,7 +86,7 @@ def parse_result(result: List[List[Result]]) -> Dict[str, float]:
         "success_num": result_counts[Success],
         "failed_num": result_counts[PartialFailure],
         "error_num": result_counts[Error],
-        "out_of_bound": result_counts[OutOfBound],
+        "out_of_bounds": result_counts[OutOfBounds],
     }
 
 

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

@@ -13,15 +13,15 @@
 from ._battery_pool_status import BatteryStatus
 from .power_distributing import PowerDistributingActor
 from .request import Request
-from .result import Error, OutOfBound, PartialFailure, Result, Success
+from .result import Error, OutOfBounds, PartialFailure, Result, Success
 
 __all__ = [
     "PowerDistributingActor",
     "Request",
     "Result",
     "Error",
     "Success",
-    "OutOfBound",
+    "OutOfBounds",
     "PartialFailure",
     "BatteryStatus",
 ]

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

@@ -43,7 +43,7 @@
     InvBatPair,
 )
 from .request import Request
-from .result import Error, OutOfBound, PartialFailure, PowerBounds, Result, Success
+from .result import Error, OutOfBounds, PartialFailure, PowerBounds, Result, Success
 
 _logger = logging.getLogger(__name__)
 
@@ -482,7 +482,7 @@ def _check_request(
             # If the requested power is in the exclusion bounds, it is NOT possible to
             # increase it so that it is outside the exclusion bounds.
             if bounds.exclusion_lower < request.power < bounds.exclusion_upper:
-                return OutOfBound(request=request, bound=bounds)
+                return OutOfBounds(request=request, bounds=bounds)
         else:
             in_lower_range = (
                 bounds.inclusion_lower <= request.power <= bounds.exclusion_lower
@@ -491,7 +491,7 @@ def _check_request(
                 bounds.exclusion_upper <= request.power <= bounds.inclusion_upper
             )
             if not (in_lower_range or in_upper_range):
-                return OutOfBound(request=request, bound=bounds)
+                return OutOfBounds(request=request, bounds=bounds)
 
         return None
 

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

@@ -88,14 +88,14 @@ class PowerBounds:
 
 
 @dataclasses.dataclass
-class OutOfBound(Result):
+class OutOfBounds(Result):
     """Result returned when the power was not set because it was out of bounds.
 
     This result happens when the originating request was done with
     `adjust_power = False` and the requested power is not within the batteries bounds.
     """
 
-    bound: PowerBounds
+    bounds: PowerBounds
     """The power bounds for the requested batteries.
 
     If the requested power negative, then this value is the lower bound.

tests/actor/power_distributing/test_power_distributing.py

@@ -25,7 +25,7 @@
 from frequenz.sdk.actor.power_distributing._battery_pool_status import BatteryPoolStatus
 from frequenz.sdk.actor.power_distributing.result import (
     Error,
-    OutOfBound,
+    OutOfBounds,
     PowerBounds,
     Result,
     Success,
@@ -448,10 +448,10 @@ async def test_power_distributor_one_user_adjust_power_consume(
         assert len(done) == 1
 
         result = done.pop().result()
-        assert isinstance(result, OutOfBound)
+        assert isinstance(result, OutOfBounds)
         assert result is not None
         assert result.request == request
-        assert result.bound.inclusion_upper == 1000
+        assert result.bounds.inclusion_upper == 1000
 
     async def test_power_distributor_one_user_adjust_power_supply(
         self, mocker: MockerFixture
@@ -501,10 +501,10 @@ async def test_power_distributor_one_user_adjust_power_supply(
         assert len(done) == 1
 
         result = done.pop().result()
-        assert isinstance(result, OutOfBound)
+        assert isinstance(result, OutOfBounds)
         assert result is not None
         assert result.request == request
-        assert result.bound.inclusion_lower == -1000
+        assert result.bounds.inclusion_lower == -1000
 
     async def test_power_distributor_one_user_adjust_power_success(
         self, mocker: MockerFixture