Rename DispatchManagingActor to ActorDispatcher

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

Author: Marenz

src/frequenz/dispatch/__init__.py

@@ -7,18 +7,18 @@
 
 * [Dispatcher][frequenz.dispatch.Dispatcher]: The entry point for the API.
 * [Dispatch][frequenz.dispatch.Dispatch]: A dispatch type with lots of useful extra functionality.
-* [DispatchManagingActor][frequenz.dispatch.DispatchManagingActor]: An actor to
-    manage other actors based on incoming dispatches.
+* [ActorDispatcher][frequenz.dispatch.ActorDispatcher]: A service to manage other actors based on
+  incoming dispatches.
 * [Created][frequenz.dispatch.Created],
   [Updated][frequenz.dispatch.Updated],
   [Deleted][frequenz.dispatch.Deleted]: Dispatch event types.
 
 """
 
+from ._actor_dispatcher import ActorDispatcher, DispatchUpdate
 from ._dispatch import Dispatch
 from ._dispatcher import Dispatcher
 from ._event import Created, Deleted, DispatchEvent, Updated
-from ._managing_actor import DispatchManagingActor, DispatchUpdate
 
 __all__ = [
     "Created",
@@ -27,6 +27,6 @@
     "Dispatcher",
     "Updated",
     "Dispatch",
-    "DispatchManagingActor",
+    "ActorDispatcher",
     "DispatchUpdate",
 ]

src/frequenz/dispatch/_managing_actor.py …c/frequenz/dispatch/_actor_dispatcher.pysrc/frequenz/dispatch/_managing_actor.py renamed to src/frequenz/dispatch/_actor_dispatcher.py src/frequenz/dispatch/_managing_actor.py renamed to src/frequenz/dispatch/_actor_dispatcher.py

@@ -32,7 +32,7 @@ class DispatchUpdate:
     """Additional options."""
 
 
-class DispatchManagingActor(BackgroundService):
+class ActorDispatcher(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 ActorDispatcher, Dispatch, 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: ActorDispatcher
     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 = ActorDispatcher(
         actor_factory=MockActor,
         running_status_receiver=channel.new_receiver(),
     )
@@ -149,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
@@ -237,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