Rename DispatchManagingService to DispatchActorsService

Signed-off-by: Mathias L. Baumann <[email protected]>

Author: Marenz

src/frequenz/dispatch/__init__.py

@@ -15,11 +15,11 @@
 
 """
 
+from ._actors_service import DispatchActorsService, DispatchUpdate
 from ._bg_service import MergeByType, MergeByTypeTarget, _MergeStrategy
 from ._dispatch import Dispatch
 from ._dispatcher import Dispatcher
 from ._event import Created, Deleted, DispatchEvent, Updated
-from ._managing_actor import DispatchManagingActor, DispatchUpdate
 
 __all__ = [
     "Created",
@@ -28,7 +28,7 @@
     "Dispatcher",
     "Updated",
     "Dispatch",
-    "DispatchManagingActor",
+    "DispatchActorsService",
     "DispatchUpdate",
     "_MergeStrategy",  # To allow for user strategies
     "MergeByType",

src/frequenz/dispatch/_managing_actor.py src/frequenz/dispatch/_actors_service.pysrc/frequenz/dispatch/_managing_actor.py renamed to src/frequenz/dispatch/_actors_service.py

@@ -32,7 +32,7 @@ class DispatchUpdate:
     """Additional options."""
 
 
-class DispatchManagingActor(BackgroundService):
+class DispatchActorsService(BackgroundService):
     """Helper class to manage actors based on dispatches.
 
     Example usage:

tests/test_mananging_actor.py

@@ -18,7 +18,7 @@
 from frequenz.sdk.actor import Actor
 from pytest import fixture
 
-from frequenz.dispatch import Dispatch, DispatchManagingActor, DispatchUpdate
+from frequenz.dispatch import Dispatch, DispatchActorsService, DispatchUpdate
 from frequenz.dispatch._bg_service import DispatchScheduler
 
 
@@ -65,7 +65,7 @@ async def _run(self) -> None:
 class TestEnv:
     """Test environment."""
 
-    actors_service: DispatchManagingActor
+    actors_service: DispatchActorsService
     running_status_sender: Sender[Dispatch]
     generator: DispatchGenerator = DispatchGenerator()
 
@@ -90,7 +90,7 @@ async def test_env() -> AsyncIterator[TestEnv]:
     """Create a test environment."""
     channel = Broadcast[Dispatch](name="dispatch ready test channel")
 
-    actors_service = DispatchManagingActor(
+    actors_service = DispatchActorsService(
         actor_factory=MockActor,
         running_status_receiver=channel.new_receiver(),
     )
@@ -135,6 +135,7 @@ async def test_simple_start_stop(
     await asyncio.sleep(1)
     logging.info("Sent dispatch")
 
+    assert test_env.actor is not None
     event = test_env.actor.initial_dispatch
     assert event.options == {"test": True}
     assert event.components == dispatch.target
@@ -148,7 +149,7 @@ async def test_simple_start_stop(
     fake_time.shift(duration)
     await test_env.running_status_sender.send(Dispatch(dispatch))
 
-    # Give await actor.stop a chance to run in DispatchManagingActor
+    # Give await actor.stop a chance to run
     await asyncio.sleep(1)
 
     assert test_env.actor is None
@@ -223,6 +224,7 @@ async def test_dry_run(test_env: TestEnv, fake_time: time_machine.Coordinates) -
     fake_time.shift(timedelta(seconds=1))
     await asyncio.sleep(1)
 
+    assert test_env.actor is not None
     event = test_env.actor.initial_dispatch
 
     assert event.dry_run is dispatch.dry_run
@@ -235,7 +237,7 @@ async def test_dry_run(test_env: TestEnv, fake_time: time_machine.Coordinates) -
     fake_time.shift(dispatch.duration)
     await test_env.running_status_sender.send(Dispatch(dispatch))
 
-    # Give await actor.stop a chance to run in DispatchManagingActor
+    # Give await actor.stop a chance to run
     await asyncio.sleep(1)
 
     assert test_env.actor is None