refactor: rename _Settings -> _State

systemctl_mqtt/__init__.py

@@ -112,7 +112,7 @@ def _schedule_shutdown(action: str) -> None:
     _log_shutdown_inhibitors(login_manager)
 
 
-class _Settings:
+class _State:
     def __init__(self, mqtt_topic_prefix: str) -> None:
         self._mqtt_topic_prefix = mqtt_topic_prefix
         self._shutdown_lock = None  # type: typing.Optional[dbus.types.UnixFd]
@@ -151,7 +151,7 @@ class _MQTTAction:
     def mqtt_message_callback(
         self,
         mqtt_client: paho.mqtt.client.Client,
-        settings: _Settings,
+        state: _State,
         message: paho.mqtt.client.MQTTMessage,
     ) -> None:
         # pylint: disable=unused-argument; callback
@@ -175,7 +175,7 @@ _MQTT_TOPIC_SUFFIX_ACTION_MAPPING = {
 
 def _mqtt_on_connect(
     mqtt_client: paho.mqtt.client.Client,
-    settings: _Settings,
+    state: _State,
     flags: typing.Dict,
     return_code: int,
 ) -> None:
@@ -184,9 +184,9 @@ def _mqtt_on_connect(
     assert return_code == 0, return_code  # connection accepted
     mqtt_broker_host, mqtt_broker_port = mqtt_client.socket().getpeername()
     _LOGGER.debug("connected to MQTT broker %s:%d", mqtt_broker_host, mqtt_broker_port)
-    settings.acquire_shutdown_lock()
+    state.acquire_shutdown_lock()
     for topic_suffix, action in _MQTT_TOPIC_SUFFIX_ACTION_MAPPING.items():
-        topic = settings.mqtt_topic_prefix + "/" + topic_suffix
+        topic = state.mqtt_topic_prefix + "/" + topic_suffix
         _LOGGER.info("subscribing to %s", topic)
         mqtt_client.subscribe(topic)
         mqtt_client.message_callback_add(
@@ -206,7 +206,7 @@ def _run(
 ) -> None:
     # https://pypi.org/project/paho-mqtt/
     mqtt_client = paho.mqtt.client.Client(
-        userdata=_Settings(mqtt_topic_prefix=mqtt_topic_prefix)
+        userdata=_State(mqtt_topic_prefix=mqtt_topic_prefix)
     )
     mqtt_client.on_connect = _mqtt_on_connect
     mqtt_client.tls_set(ca_certs=None)  # enable tls trusting default system certs

tests/test_mqtt.py

@@ -265,19 +265,19 @@ def test_mqtt_message_callback_poweroff_retained(
 
 
 def test_shutdown_lock():
-    settings = systemctl_mqtt._Settings(mqtt_topic_prefix="any")
+    state = systemctl_mqtt._State(mqtt_topic_prefix="any")
     lock_fd = unittest.mock.MagicMock()
     with unittest.mock.patch(
         "systemctl_mqtt._get_login_manager"
     ) as get_login_manager_mock:
         get_login_manager_mock.return_value.Inhibit.return_value = lock_fd
-        settings.acquire_shutdown_lock()
+        state.acquire_shutdown_lock()
     get_login_manager_mock.return_value.Inhibit.assert_called_once_with(
         "shutdown", "systemctl-mqtt", "Report shutdown via MQTT", "delay",
     )
-    assert settings._shutdown_lock == lock_fd
+    assert state._shutdown_lock == lock_fd
     # https://dbus.freedesktop.org/doc/dbus-python/dbus.types.html#dbus.types.UnixFd.take
     lock_fd.take.return_value = "fdnum"
     with unittest.mock.patch("os.close") as close_mock:
-        settings.release_shutdown_lock()
+        state.release_shutdown_lock()
     close_mock.assert_called_once_with("fdnum")