Merge pull request #94 from azogue/env/maintenance-update

Enable compatibility with new `fastapi-slim` and update examples

Author: azogue

.pre-commit-config.yaml

@@ -1,15 +1,15 @@
 minimum_pre_commit_version: 2.9.2
 repos:
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.1.9
+    rev: v0.4.4
     hooks:
       - id: ruff
         args:
           - --fix
       - id: ruff-format
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.5.0"
+    rev: "v4.6.0"
     hooks:
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -24,6 +24,8 @@ repos:
         types_or: [yaml, markdown]
 
   - repo: "https://github.com/pre-commit/mirrors-mypy"
-    rev: "v1.8.0"
+    rev: "v1.10.0"
     hooks:
       - id: "mypy"
+        additional_dependencies:
+          - pydantic

README.md

@@ -41,6 +41,7 @@ pip install fastapi-mqtt
 ### 🕹 Guide
 
 ```python
+from contextlib import asynccontextmanager
 from typing import Any
 
 from fastapi import FastAPI
@@ -49,11 +50,17 @@ from gmqtt import Client as MQTTClient
 from fastapi_mqtt import FastMQTT, MQTTConfig
 
 mqtt_config = MQTTConfig()
-
 fast_mqtt = FastMQTT(config=mqtt_config)
 
-app = FastAPI()
-fast_mqtt.init_app(app)
+
+@asynccontextmanager
+async def _lifespan(_app: FastAPI):
+    await fast_mqtt.mqtt_startup()
+    yield
+    await fast_mqtt.mqtt_shutdown()
+
+
+app = FastAPI(lifespan=_lifespan)
 
 
 @fast_mqtt.on_connect()

docs/example.md

@@ -1,38 +1,41 @@
 ### Full example
 
 ```python
+from contextlib import asynccontextmanager
 
-from fastapi_mqtt.fastmqtt import FastMQTT
 from fastapi import FastAPI
 from fastapi_mqtt.config import MQTTConfig
+from fastapi_mqtt.fastmqtt import FastMQTT
 
-app = FastAPI()
-
-mqtt_config = MQTTConfig()
+fast_mqtt = FastMQTT(config=MQTTConfig())
 
-fast_mqtt = FastMQTT(config=mqtt_config)
+@asynccontextmanager
+async def _lifespan(_app: FastAPI):
+    await fast_mqtt.mqtt_startup()
+    yield
+    await fast_mqtt.mqtt_shutdown()
 
-fast_mqtt.init_app(app)
+app = FastAPI(lifespan=_lifespan)
 
-@mqtt.on_connect()
+@fast_mqtt.on_connect()
 def connect(client, flags, rc, properties):
-    mqtt.client.subscribe("/mqtt") #subscribing mqtt topic
+    fast_mqtt.client.subscribe("/mqtt") #subscribing mqtt topic
     print("Connected: ", client, flags, rc, properties)
 
-@mqtt.on_message()
+@fast_mqtt.on_message()
 async def message(client, topic, payload, qos, properties):
     print("Received message: ",topic, payload.decode(), qos, properties)
     return 0
 
-@mqtt.subscribe("my/mqtt/topic/#")
+@fast_mqtt.subscribe("my/mqtt/topic/#")
 async def message_to_topic(client, topic, payload, qos, properties):
     print("Received message to specific topic: ", topic, payload.decode(), qos, properties)
 
-@mqtt.on_disconnect()
+@fast_mqtt.on_disconnect()
 def disconnect(client, packet, exc=None):
     print("Disconnected")
 
-@mqtt.on_subscribe()
+@fast_mqtt.on_subscribe()
 def subscribe(client, mid, qos, properties):
     print("subscribed", client, mid, qos, properties)
 

examples/app.py

@@ -1,3 +1,4 @@
+from contextlib import asynccontextmanager
 from typing import Any
 
 from fastapi import FastAPI
@@ -9,8 +10,15 @@
 
 fast_mqtt = FastMQTT(config=mqtt_config)
 
-app = FastAPI()
-fast_mqtt.init_app(app)
+
+@asynccontextmanager
+async def _lifespan(_app: FastAPI):
+    await fast_mqtt.mqtt_startup()
+    yield
+    await fast_mqtt.mqtt_shutdown()
+
+
+app = FastAPI(lifespan=_lifespan)
 
 
 @fast_mqtt.on_connect()

examples/app_will_message.py

@@ -1,3 +1,5 @@
+from contextlib import asynccontextmanager
+
 from fastapi import FastAPI
 
 from fastapi_mqtt.config import MQTTConfig
@@ -12,9 +14,14 @@
 fast_mqtt = FastMQTT(config=mqtt_config)
 
 
-app = FastAPI()
+@asynccontextmanager
+async def _lifespan(_app: FastAPI):
+    await fast_mqtt.mqtt_startup()
+    yield
+    await fast_mqtt.mqtt_shutdown()
+
 
-fast_mqtt.init_app(app)
+app = FastAPI(lifespan=_lifespan)
 
 
 @fast_mqtt.on_connect()

fastapi_mqtt/config.py

@@ -2,7 +2,7 @@
 from typing import Optional, Union
 
 from gmqtt.mqtt.constants import MQTTv50
-from pydantic import BaseModel, ConfigDict
+from pydantic import BaseModel, ConfigDict, Field
 
 
 class MQTTConfig(BaseModel):
@@ -47,7 +47,7 @@ class MQTTConfig(BaseModel):
     keepalive: int = 60
     username: Optional[str] = None
     password: Optional[str] = None
-    version: int = MQTTv50
+    version: int = Field(default=MQTTv50, ge=4, le=5)
 
     reconnect_retries: Optional[int] = 1
     reconnect_delay: Optional[int] = 6

fastapi_mqtt/fastmqtt.py

@@ -4,13 +4,18 @@
 from itertools import zip_longest
 from typing import Any, Callable, Dict, List, Optional, Tuple
 
-from fastapi import FastAPI
 from gmqtt import Client as MQTTClient
 from gmqtt import Message, Subscription
 from gmqtt.mqtt.constants import MQTTv50
 
 from .config import MQTTConfig
-from .handlers import MQTTHandlers
+from .handlers import (
+    MQTTConnectionHandler,
+    MQTTDisconnectHandler,
+    MQTTHandlers,
+    MQTTMessageHandler,
+    MQTTSubscriptionHandler,
+)
 
 try:
     from uvicorn.config import logger as log_info
@@ -67,7 +72,7 @@ def __init__(
         self.client._connect_properties = kwargs
         self.client.on_message = self.__on_message
         self.client.on_connect = self.__on_connect
-        self.subscriptions: Dict[str, Tuple[Subscription, List[Callable]]] = {}
+        self.subscriptions: Dict[str, Tuple[Subscription, List[MQTTMessageHandler]]] = {}
         self._logger = mqtt_logger or log_info
         self.mqtt_handlers = MQTTHandlers(self.client, self._logger)
 
@@ -225,14 +230,14 @@ async def mqtt_shutdown(self) -> None:
         """Final disconnection for MQTT client, for lifespan shutdown."""
         await self.client.disconnect()
 
-    def init_app(self, app: FastAPI) -> None:  # pragma: no cover
+    def init_app(self, fastapi_app) -> None:  # pragma: no cover
         """Add startup and shutdown event handlers for app without lifespan."""
 
-        @app.on_event("startup")
+        @fastapi_app.on_event("startup")
         async def startup() -> None:
             await self.mqtt_startup()
 
-        @app.on_event("shutdown")
+        @fastapi_app.on_event("shutdown")
         async def shutdown() -> None:
             await self.mqtt_shutdown()
 
@@ -249,7 +254,7 @@ def subscribe(
         Decorator method used to subscribe for specific topics.
         """
 
-        def subscribe_handler(handler: Callable) -> Callable:
+        def subscribe_handler(handler: MQTTMessageHandler) -> MQTTMessageHandler:
             self._logger.debug("Subscribe for topics: %s", topics)
             for topic in topics:
                 if topic not in self.subscriptions:
@@ -290,7 +295,7 @@ def on_connect(self) -> Callable[..., Any]:
         Decorator method used to handle the connection to MQTT.
         """
 
-        def connect_handler(handler: Callable) -> Callable:
+        def connect_handler(handler: MQTTConnectionHandler) -> MQTTConnectionHandler:
             self._logger.debug("handler accepted")
             return self.mqtt_handlers.on_connect(handler)
 
@@ -301,7 +306,7 @@ def on_message(self) -> Callable[..., Any]:
         The decorator method is used to subscribe to messages from all topics.
         """
 
-        def message_handler(handler: Callable) -> Callable:
+        def message_handler(handler: MQTTMessageHandler) -> MQTTMessageHandler:
             self._logger.debug("on_message handler accepted")
             return self.mqtt_handlers.on_message(handler)
 
@@ -312,7 +317,7 @@ def on_disconnect(self) -> Callable[..., Any]:
         The Decorator method used wrap disconnect callback.
         """
 
-        def disconnect_handler(handler: Callable) -> Callable:
+        def disconnect_handler(handler: MQTTDisconnectHandler) -> MQTTDisconnectHandler:
             self._logger.debug("on_disconnect handler accepted")
             return self.mqtt_handlers.on_disconnect(handler)
 
@@ -323,7 +328,7 @@ def on_subscribe(self) -> Callable[..., Any]:
         Decorator method is used to obtain subscribed topics and properties.
         """
 
-        def subscribe_handler(handler: Callable):
+        def subscribe_handler(handler: MQTTSubscriptionHandler) -> MQTTSubscriptionHandler:
             self._logger.debug("on_subscribe handler accepted")
             return self.mqtt_handlers.on_subscribe(handler)
 

fastapi_mqtt/handlers.py

@@ -8,6 +8,10 @@
 MQTTMessageHandler = Callable[[MQTTClient, str, bytes, int, Any], Awaitable[Any]]
 # client: MQTTClient, flags: int, rc: int, properties: Any
 MQTTConnectionHandler = Callable[[MQTTClient, int, int, Any], Any]
+# client: MQTTClient, mid: int, qos: int, properties: Any
+MQTTSubscriptionHandler = Callable[[MQTTClient, int, int, Any], Any]
+# client: MQTTClient, packet: bytes, exc=None
+MQTTDisconnectHandler = Callable[[MQTTClient, bytes, Optional[Exception]], Any]
 
 
 class MQTTHandlers:
@@ -22,15 +26,15 @@ def on_message(self, handler: MQTTMessageHandler) -> MQTTMessageHandler:
         self.user_message_handler = handler
         return handler
 
-    def on_subscribe(self, handler: Callable) -> Callable[..., Any]:
+    def on_subscribe(self, handler: MQTTSubscriptionHandler) -> MQTTSubscriptionHandler:
         """
         Decorator method is used to obtain subscribed topics and properties.
         """
         self._logger.info("on_subscribe handler accepted")
         self.client.on_subscribe = handler
         return handler
 
-    def on_disconnect(self, handler: Callable) -> Callable[..., Any]:
+    def on_disconnect(self, handler: MQTTDisconnectHandler) -> MQTTDisconnectHandler:
         self.client.on_disconnect = handler
         return handler