Reorganize the config module

RELEASE_NOTES.md

@@ -6,7 +6,7 @@
 
 ## Upgrading
 
-<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
+- The `LoggingConfigUpdater` was renamed to `LoggingConfigUpdatingActor` to follow the actor naming convention.
 
 ## New Features
 

src/frequenz/sdk/config/__init__.py

@@ -3,14 +3,14 @@
 
 """Read and update config variables."""
 
-from ._config_managing import ConfigManagingActor
-from ._logging_config_updater import LoggerConfig, LoggingConfig, LoggingConfigUpdater
+from ._logging_actor import LoggerConfig, LoggingConfig, LoggingConfigUpdatingActor
+from ._managing_actor import ConfigManagingActor
 from ._util import load_config
 
 __all__ = [
     "ConfigManagingActor",
     "LoggingConfig",
     "LoggerConfig",
-    "LoggingConfigUpdater",
+    "LoggingConfigUpdatingActor",
     "load_config",
 ]

src/frequenz/sdk/config/_logging_config_updater.py → src/frequenz/sdk/config/_logging_actor.py

@@ -85,7 +85,7 @@ def load(cls, configs: Mapping[str, Any]) -> Self:  # noqa: DOC502
         return cast(Self, schema.load(configs, unknown=RAISE))
 
 
-class LoggingConfigUpdater(Actor):
+class LoggingConfigUpdatingActor(Actor):
     """Actor that listens for logging configuration changes and sets them.
 
     Example:
@@ -107,14 +107,16 @@ class LoggingConfigUpdater(Actor):
         from typing import Any
 
         from frequenz.channels import Broadcast
-        from frequenz.sdk.config import LoggingConfigUpdater, ConfigManager
+        from frequenz.sdk.config import LoggingConfigUpdatingActor, ConfigManagingActor
         from frequenz.sdk.actor import run as run_actors
 
         async def run() -> None:
             config_channel = Broadcast[Mapping[str, Any]](name="config", resend_latest=True)
             actors = [
-                ConfigManager(config_paths=["config.toml"], output=config_channel.new_sender()),
-                LoggingConfigUpdater(
+                ConfigManagingActor(
+                    config_paths=["config.toml"], output=config_channel.new_sender()
+                ),
+                LoggingConfigUpdatingActor(
                     config_recv=config_channel.new_receiver(limit=1)).map(
                         lambda app_config: app_config.get("logging", {}
                     )

tests/config/test_config_manager.py → tests/config/test_actor.py

@@ -16,7 +16,7 @@
 from pytest_mock import MockerFixture
 
 from frequenz.sdk.config import ConfigManagingActor
-from frequenz.sdk.config._config_managing import _recursive_update
+from frequenz.sdk.config._managing_actor import _recursive_update
 
 
 class Item:

tests/config/test_logging_config_updater.py → tests/config/test_logging_actor.py

@@ -13,7 +13,7 @@
 from marshmallow import ValidationError
 from pytest_mock import MockerFixture
 
-from frequenz.sdk.config import LoggerConfig, LoggingConfig, LoggingConfigUpdater
+from frequenz.sdk.config import LoggerConfig, LoggingConfig, LoggingConfigUpdatingActor
 
 
 def test_logging_config() -> None:
@@ -60,7 +60,7 @@ def cleanup_logs() -> Any:
     logging.getLogger("frequenz.sdk.timeseries").setLevel(logging.NOTSET)
 
 
-async def test_logging_config_updater_actor(
+async def test_logging_config_updating_actor(
     mocker: MockerFixture,
     cleanup_logs: Any,
 ) -> None:
@@ -70,11 +70,11 @@ async def test_logging_config_updater_actor(
     # Overriding logging.basicConfig would mess up other tests, so we mock it.
     # This is just for extra safety because changing root logging level in unit tests
     # is not working anyway - python ignores it.
-    mocker.patch("frequenz.sdk.config._logging_config_updater.logging.basicConfig")
+    mocker.patch("frequenz.sdk.config._logging_actor.logging.basicConfig")
 
     config_channel = Broadcast[Mapping[str, Any]](name="config")
     config_sender = config_channel.new_sender()
-    async with LoggingConfigUpdater(
+    async with LoggingConfigUpdatingActor(
         config_recv=config_channel.new_receiver().map(
             lambda app_config: app_config.get("logging", {})
         )