updates2mqtt 1.4.0__py3-none-any.whl → 1.4.2__py3-none-any.whl

updates2mqtt/app.py

@@ -16,7 +16,7 @@ from updates2mqtt.model import Discovery, ReleaseProvider
 
 from .config import Config, load_app_config, load_package_info
 from .integrations.docker import DockerProvider
-from .mqtt import MqttClient
+from .mqtt import MqttPublisher
 
 log = structlog.get_logger()
 
@@ -48,7 +48,7 @@ class App:
         log.debug("Logging initialized", level=self.cfg.log.level)
         self.common_pkg = load_package_info(PKG_INFO_FILE)
 
-        self.publisher = MqttClient(self.cfg.mqtt, self.cfg.node, self.cfg.homeassistant)
+        self.publisher = MqttPublisher(self.cfg.mqtt, self.cfg.node, self.cfg.homeassistant)
 
         self.scanners: list[ReleaseProvider] = []
         self.scan_count: int = 0
@@ -74,7 +74,7 @@ class App:
                 break
             log.info("Scanning", source=scanner.source_type, session=session)
             async with asyncio.TaskGroup() as tg:
-                async for discovery in scanner.scan(session):  # type: ignore[attr-defined]
+                async for discovery in scanner.scan(session):  # xtype: ignore[attr-defined]
                     tg.create_task(self.on_discovery(discovery), name=f"discovery-{discovery.name}")
             if self.stopped.is_set():
                 break
@@ -83,7 +83,7 @@ class App:
             log.info("Scan complete", source_type=scanner.source_type)
         self.last_scan_timestamp = datetime.now(UTC).isoformat()
 
-    async def run(self) -> None:
+    async def main_loop(self) -> None:
         log.debug("Starting run loop")
         self.publisher.start()
 
@@ -93,7 +93,7 @@ class App:
                 f"Setting up healthcheck every {self.cfg.node.healthcheck.interval} seconds to topic {self.healthcheck_topic}"
             )
             self.healthcheck_loop_task = asyncio.create_task(
-                repeated_call(self.healthcheck, interval=self.cfg.node.healthcheck.interval)
+                repeated_call(self.healthcheck, interval=self.cfg.node.healthcheck.interval), name="healthcheck"
             )
 
         for scanner in self.scanners:
@@ -145,7 +145,8 @@ class App:
         log.info(f"Cancelling {len(running_tasks)} tasks")
         for t in running_tasks:
             log.debug("Cancelling task", task=t.get_name())
-            t.cancel()
+            if t.get_name() == "healthcheck" or t.get_name().startswith("discovery-"):
+                t.cancel()
         await asyncio.gather(*running_tasks, return_exceptions=True)
         log.debug("Cancellation task completed")
 
@@ -154,7 +155,11 @@ class App:
         self.stopped.set()
         for scanner in self.scanners:
             scanner.stop()
-        interrupt_task = asyncio.get_event_loop().create_task(self.interrupt_tasks(), eager_start=True)  # type: ignore[call-arg] # pyright: ignore[reportCallIssue]
+        interrupt_task = asyncio.get_event_loop().create_task(
+            self.interrupt_tasks(),
+            eager_start=True,  # type: ignore[call-arg] # pyright: ignore[reportCallIssue]
+            name="interrupt",
+        )
         for t in asyncio.all_tasks():
             log.debug("Tasks waiting = %s", t)
         self.publisher.stop()
@@ -168,7 +173,7 @@ class App:
         self.publisher.publish(
             topic=self.healthcheck_topic,
             payload={
-                "version": updates2mqtt.version,
+                "version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
                 "node": self.cfg.node.name,
                 "heartbeat_raw": time.time(),
                 "heartbeat_stamp": datetime.now(UTC).isoformat(),
@@ -197,12 +202,12 @@ def run() -> None:
 
     from .app import App
 
-    log.debug(f"Starting updates2mqtt v{updates2mqtt.version}")
+    log.debug(f"Starting updates2mqtt v{updates2mqtt.version}")  # pyright: ignore[reportAttributeAccessIssue]
     app = App()
 
     signal.signal(signal.SIGTERM, app.shutdown)
     try:
-        asyncio.run(app.run(), debug=False)
+        asyncio.run(app.main_loop(), debug=False)
         log.debug("App exited gracefully")
     except asyncio.CancelledError:
         log.debug("App exited on cancelled task")

updates2mqtt/config.py

@@ -49,6 +49,8 @@ class HomeAssistantDiscoveryConfig:
 class HomeAssistantConfig:
     discovery: HomeAssistantDiscoveryConfig = field(default_factory=HomeAssistantDiscoveryConfig)
     state_topic_suffix: str = "state"
+    device_creation: bool = True
+    area: str | None = None
 
 
 @dataclass
@@ -74,7 +76,7 @@ class LogConfig:
 class Config:
     log: LogConfig = field(default_factory=LogConfig)
     node: NodeConfig = field(default_factory=NodeConfig)
-    mqtt: MqttConfig = field(default_factory=MqttConfig)
+    mqtt: MqttConfig = field(default_factory=MqttConfig)  # pyright: ignore[reportCallIssue, reportArgumentType]
     homeassistant: HomeAssistantConfig = field(default_factory=HomeAssistantConfig)
     docker: DockerConfig = field(default_factory=DockerConfig)
     scan_interval: int = 60 * 60 * 3

updates2mqtt/hass_formatter.py

@@ -19,9 +19,16 @@ HASS_UPDATE_SCHEMA = [
 
 
 def hass_format_config(
-    discovery: Discovery, object_id: str, node_name: str, state_topic: str, command_topic: str | None, session: str
+    discovery: Discovery,
+    object_id: str,
+    node_name: str,
+    state_topic: str,
+    command_topic: str | None,
+    device_creation: bool = True,
+    area: str | None = None,
+    session: str | None = None,
 ) -> dict[str, Any]:
-    config = {
+    config: dict[str, Any] = {
         "name": f"{discovery.name} {discovery.source_type} on {node_name}",
         "device_class": None,  # not firmware, so defaults to null
         "unique_id": object_id,
@@ -37,11 +44,20 @@ def hass_format_config(
         "latest_version_topic": state_topic,
         "latest_version_template": "{{value_json.latest_version}}",
         "origin": {
-            "name": "updates2mqtt",
-            "sw_version": updates2mqtt.version,
+            "name": f"{node_name} updates2mqtt Agent",
+            "sw_version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
             "support_url": "https://github.com/rhizomatics/updates2mqtt/issues",
         },
     }
+    if device_creation:
+        config["device"] = {
+            "name": f"{node_name} updates2mqtt Agent",
+            "sw_version": updates2mqtt.version,  # pyright: ignore[reportAttributeAccessIssue]
+            "manufacturer": "rhizomatics",
+            "identifiers": [f"{node_name}.updates2mqtt"],
+        }
+        if area:
+            config["device"]["suggested_area"] = area
     if command_topic:
         config["command_topic"] = command_topic
         config["payload_install"] = f"{discovery.source_type}|{discovery.name}|install"

updates2mqtt/integrations/docker.py

@@ -135,8 +135,8 @@ class DockerProvider(ReleaseProvider):
         image_ref = None
         image_name = None
         local_versions = None
-        if c.attrs is None:
-            logger.warn("No container attributes found, discovery rejected")  # type: ignore[unreachable]
+        if c.attrs is None or not c.attrs:
+            logger.warn("No container attributes found, discovery rejected")
             return None
         if c.name is None:
             logger.warn("No container name found, discovery rejected")
@@ -145,7 +145,7 @@ class DockerProvider(ReleaseProvider):
         def env_override(env_var: str, default: Any) -> Any | None:
             return default if c_env.get(env_var) is None else c_env.get(env_var)
 
-        env_str = c.attrs["Config"]["Env"]
+        env_str = c.attrs.get("Config", {}).get("Env")
         c_env = dict(env.split("=", maxsplit=1) for env in env_str if "==" not in env)
         ignore_container: str | None = env_override("UPD2MQTT_IGNORE", "FALSE")
         if ignore_container and ignore_container.upper() in ("1", "TRUE"):
@@ -247,11 +247,17 @@ class DockerProvider(ReleaseProvider):
             can_build: bool = self.cfg.allow_build and custom.get("git_repo_path") is not None
             can_restart: bool = self.cfg.allow_restart and custom.get("compose_path") is not None
             can_update: bool = False
+            if self.cfg.allow_pull and not can_pull and not can_build:
+                logger.info(
+                    f"Pull not available, image_ref:{image_ref},local_version:{local_version},latest_version:{latest_version}"
+                )
             if can_pull or can_build or can_restart:
                 # public install-neutral capabilities and Home Assistant features
                 can_update = True
                 features.append("INSTALL")
                 features.append("PROGRESS")
+            elif any((self.cfg.allow_build, self.cfg.allow_restart, self.cfg.allow_pull)):
+                logger.info(f"Update not available, can_pull:{can_pull}, can_build:{can_build},can_restart{can_restart}")
             if relnotes_url:
                 features.append("RELEASE_NOTES")
             custom["can_pull"] = can_pull
@@ -279,7 +285,7 @@ class DockerProvider(ReleaseProvider):
             logger.exception("Docker Discovery Failure", container_attrs=c.attrs)
         return None
 
-    async def scan(self, session: str) -> AsyncGenerator[Discovery]:  # type: ignore  # noqa: PGH003
+    async def scan(self, session: str) -> AsyncGenerator[Discovery]:
         logger = self.log.bind(session=session, action="scan")
         containers = results = 0
         for c in self.client.containers.list():

updates2mqtt/model.py

@@ -80,6 +80,10 @@ class ReleaseProvider:
     @abstractmethod
     async def scan(self, session: str) -> AsyncGenerator[Discovery]:
         """Scan for components to monitor"""
+        raise NotImplementedError
+        # force recognition as an async generator
+        if False:  # type: ignore[unreachable]
+            yield 0
 
     def hass_config_format(self, discovery: Discovery) -> dict:
         _ = discovery

updates2mqtt/mqtt.py

@@ -28,7 +28,7 @@ class LocalMessage:
     payload: str | None = field(default=None)
 
 
-class MqttClient:
+class MqttPublisher:
     def __init__(self, cfg: MqttConfig, node_cfg: NodeConfig, hass_cfg: HomeAssistantConfig) -> None:
         self.cfg: MqttConfig = cfg
         self.node_cfg: NodeConfig = node_cfg
@@ -90,7 +90,7 @@ class MqttClient:
             self.client = None
 
     def is_available(self) -> bool:
-        return not self.fatal_failure.is_set()
+        return self.client is not None and not self.fatal_failure.is_set()
 
     def on_connect(
         self, _client: mqtt.Client, _userdata: Any, _flags: mqtt.ConnectFlags, rc: ReasonCode, _props: Properties | None
@@ -103,8 +103,8 @@ class MqttClient:
             log.error("Invalid MQTT credentials", result_code=rc)
 
         self.log.info("Connected to broker", result_code=rc)
-        for topic in self.providers_by_topic:
-            self.log.info("(Re)subscribing", topic=topic)
+        for topic, provider in self.providers_by_topic.items():
+            self.log.info("(Re)subscribing", topic=topic, provider=provider.source_type)
             self.client.subscribe(topic)
 
     def on_disconnect(
@@ -272,7 +272,8 @@ class MqttClient:
         if msg.topic in self.providers_by_topic:
             self.handle_message(msg)
         else:
-            self.log.warn("Unhandled message: %s", msg.topic)
+            # apparently the root non-wildcard sub sometimes brings in child topics
+            self.log.debug("Unhandled message #%s on %s:%s", msg.mid, msg.topic, msg.payload)
 
     def handle_message(self, msg: mqtt.MQTTMessage | LocalMessage) -> None:
         def update_start(discovery: Discovery) -> None:
@@ -314,12 +315,14 @@ class MqttClient:
         self.publish(
             self.config_topic(discovery),
             hass_format_config(
-                discovery,
-                object_id,
-                self.node_cfg.name,
-                self.state_topic(discovery),
-                command_topic,
-                discovery.session,
+                discovery=discovery,
+                object_id=object_id,
+                node_name=self.node_cfg.name,
+                area=self.hass_cfg.area,
+                state_topic=self.state_topic(discovery),
+                command_topic=command_topic,
+                device_creation=self.hass_cfg.device_creation,
+                session=discovery.session,
             ),
         )
 

{updates2mqtt-1.4.0.dist-info → updates2mqtt-1.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: updates2mqtt
-Version: 1.4.0
+Version: 1.4.2
 Summary: System update and docker image notification and execution over MQTT
 Project-URL: Homepage, https://updates2mqtt.rhizomatics.org.uk
 Project-URL: Repository, https://github.com/rhizomatics/updates2mqtt
@@ -35,18 +35,27 @@ Requires-Dist: structlog>=25.4.0
 Requires-Dist: usingversion>=0.1.2
 Description-Content-Type: text/markdown
 
-[![Rhizomatics Open Source](https://avatars.githubusercontent.com/u/162821163?s=96&v=4)](https://github.com/rhizomatics)
+![updates2mqtt](/images/updates2mqtt-dark-256x256.png){ align=left }
 
 # updates2mqtt
 
+[![Rhizomatics Open Source](https://img.shields.io/badge/rhizomatics%20open%20source-lightseagreen)](https://github.com/rhizomatics)
+
 [![PyPI - Version](https://img.shields.io/pypi/v/updates2mqtt)](https://pypi.org/project/updates2mqtt/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/rhizomatics/supernotify)
+[![Coverage](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/refs/heads/badges/badges/coverage.svg)](https://updates2mqtt.rhizomatics.org.uk/developer/coverage/)
+![Tests](https://raw.githubusercontent.com/rhizomatics/updates2mqtt/refs/heads/badges/badges/tests.svg)
 [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/rhizomatics/updates2mqtt/main.svg)](https://results.pre-commit.ci/latest/github/rhizomatics/updates2mqtt/main)
 [![Publish Python 🐍 distribution 📦 to PyPI and TestPyPI](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/pypi-publish.yml)
 [![Github Deploy](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/python-package.yml)
 [![CodeQL](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/github-code-scanning/codeql)
 [![Dependabot Updates](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/rhizomatics/updates2mqtt/actions/workflows/dependabot/dependabot-updates)
 
+
+<br/>
+<br/>
+
+
 ## Summary
 
 Let Home Assistant tell you about new updates to Docker images for your containers.

updates2mqtt-1.4.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+updates2mqtt/__init__.py,sha256=gnmHrLOSYc-N1-c5VG46OpNpoXEybKzYhEvFMm955P8,237
+updates2mqtt/__main__.py,sha256=HBF00oH5fhS33sI_CdbxNlaUvbIzuuGxwnRYdhHqx0M,194
+updates2mqtt/app.py,sha256=-jAe9HcSSRmq5SZCvlsb8bFq2yVBNZQ0alQ5iRjl3tY,8518
+updates2mqtt/config.py,sha256=G7_5L7Ypc7dl35nnd5dP2AobSA08ZuyEM_ETCTPg_co,5144
+updates2mqtt/hass_formatter.py,sha256=GrVtxqpaXNFaQWXjmOFhOxYwXVjeNjzUwAjFdJdsrwI,3337
+updates2mqtt/model.py,sha256=O6GQFhfQvwQDxlZScFHrpQgFNkUrUAeaGGP6AqNua78,3827
+updates2mqtt/mqtt.py,sha256=I8g-SekY-AIVRcSCZyb7fTGji5a8zT1PJ7d34l7LGyY,14832
+updates2mqtt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+updates2mqtt/integrations/__init__.py,sha256=KmNTUxvVWvqI7rl4I0xZg7XaCmcMS2O4OSv-ClsWM4Q,109
+updates2mqtt/integrations/docker.py,sha256=Yb0XsrRyNZYAkw_ayd2iYLPFwgeA51Lz9HBVAGq3rs4,19273
+updates2mqtt/integrations/git_utils.py,sha256=bPCmQiZpKpMcrGI7xAVmePXHFn8WwjcPNkf7xqDsGQA,2319
+updates2mqtt-1.4.2.dist-info/METADATA,sha256=1wqWYIbcNbC-SQxk2FiI_SPmw9F-RFwdoOE_vviSXzw,9290
+updates2mqtt-1.4.2.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+updates2mqtt-1.4.2.dist-info/entry_points.txt,sha256=Hc6NZ2dBevYSUKTJU6NOs8Mw7Vt0S-9lq5FuKb76NCc,54
+updates2mqtt-1.4.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+updates2mqtt-1.4.2.dist-info/RECORD,,

updates2mqtt-1.4.0.dist-info/RECORD

@@ -1,16 +0,0 @@
-updates2mqtt/__init__.py,sha256=gnmHrLOSYc-N1-c5VG46OpNpoXEybKzYhEvFMm955P8,237
-updates2mqtt/__main__.py,sha256=HBF00oH5fhS33sI_CdbxNlaUvbIzuuGxwnRYdhHqx0M,194
-updates2mqtt/app.py,sha256=7jnmtIkXlX4e4lIt8WCzV19IYrICkA7cU4m9u9QXvRU,8229
-updates2mqtt/config.py,sha256=SK6uhDyUb9C2JYVd0j6KBHzSAfaCFcOUbmmgsq6VSs0,5027
-updates2mqtt/hass_formatter.py,sha256=Ulfj8F0e_1QMmRuJzHsNM2WxHbz9sIkWOWjRq3kQZzs,2772
-updates2mqtt/model.py,sha256=5tWlj3appGGZjkuBeYR2lb-kXoy5mzCn4P_EJQjnwok,3676
-updates2mqtt/mqtt.py,sha256=LDy9x7Mmq_Em6lV-w9J3TjzBCuu8eehI8PK4E0i015A,14468
-updates2mqtt/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-updates2mqtt/integrations/__init__.py,sha256=KmNTUxvVWvqI7rl4I0xZg7XaCmcMS2O4OSv-ClsWM4Q,109
-updates2mqtt/integrations/docker.py,sha256=c1y3Xkv57_frxZOlq9LoYQRnfX-1XeedCjDcBLx1it0,18849
-updates2mqtt/integrations/git_utils.py,sha256=bPCmQiZpKpMcrGI7xAVmePXHFn8WwjcPNkf7xqDsGQA,2319
-updates2mqtt-1.4.0.dist-info/METADATA,sha256=0wYbNmGsu4nQF5C49M0pegMkpmMgW7rNR5n6FTbTwlA,8916
-updates2mqtt-1.4.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-updates2mqtt-1.4.0.dist-info/entry_points.txt,sha256=Hc6NZ2dBevYSUKTJU6NOs8Mw7Vt0S-9lq5FuKb76NCc,54
-updates2mqtt-1.4.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-updates2mqtt-1.4.0.dist-info/RECORD,,