Add properties for client.publish()

src/mqttproto/_exceptions.py

@@ -56,7 +56,7 @@ class InsufficientData(MQTTDecodeError):
 
 class MQTTUnsupportedPropertyType(MQTTDecodeError):
     """
-    Raised when decoding an MQTT packet and it contains a property of a type not
+    Raised when decoding or encoding an MQTT packet and it contains a property of a type not
     supported by that packet type.
     """
 

src/mqttproto/_types.py

@@ -349,6 +349,9 @@ class PropertiesMixin:
     def encode_properties(self, buffer: bytearray) -> None:
         internal_buffer = bytearray()
         for identifier, value in self.properties.items():
+            if identifier not in self.allowed_property_types:
+                raise MQTTUnsupportedPropertyType(identifier, self.__class__)
+
             encode_variable_integer(identifier, internal_buffer)
             identifier.encoder(value, internal_buffer)
 

src/mqttproto/async_client.py

@@ -42,6 +42,7 @@
     MQTTSubscribeAckPacket,
     MQTTUnsubscribeAckPacket,
     PropertyType,
+    PropertyValue,
     QoS,
     ReasonCode,
     RetainHandling,
@@ -498,6 +499,7 @@ async def publish(
         *,
         qos: QoS = QoS.AT_MOST_ONCE,
         retain: bool = False,
+        properties: dict[PropertyType, PropertyValue] | None = None,
     ) -> None:
         """
         Publish a message to the given topic.
@@ -510,7 +512,9 @@ async def publish(
             before the subscription happened
 
         """
-        packet_id = self._state_machine.publish(topic, payload, qos=qos, retain=retain)
+        packet_id = self._state_machine.publish(
+            topic, payload, qos=qos, retain=retain, properties=properties
+        )
         if qos is QoS.EXACTLY_ONCE:
             assert packet_id is not None
             await self._run_operation(MQTTQoS2PublishOperation(packet_id))

src/mqttproto/client_state_machine.py

@@ -22,6 +22,7 @@
     MQTTUnsubscribeAckPacket,
     MQTTUnsubscribePacket,
     PropertyType,
+    PropertyValue,
     QoS,
     ReasonCode,
     Subscription,
@@ -153,6 +154,7 @@ def publish(
         *,
         qos: QoS = QoS.AT_MOST_ONCE,
         retain: bool = False,
+        properties: dict[PropertyType, PropertyValue] | None = None,
     ) -> int | None:
         """
         Send a ``PUBLISH`` request.
@@ -171,7 +173,12 @@ def publish(
         self._out_require_state(MQTTClientState.CONNECTED)
         packet_id = self._generate_packet_id() if qos > QoS.AT_MOST_ONCE else None
         packet = MQTTPublishPacket(
-            topic=topic, payload=payload, qos=qos, retain=retain, packet_id=packet_id
+            topic=topic,
+            payload=payload,
+            qos=qos,
+            retain=retain,
+            packet_id=packet_id,
+            properties=properties if properties is not None else {},
         )
         packet.encode(self._out_buffer)
         if packet_id is not None:

src/mqttproto/sync_client.py

@@ -10,7 +10,14 @@
 from anyio.from_thread import BlockingPortal, BlockingPortalProvider
 from attrs import define
 
-from ._types import MQTTPublishPacket, QoS, RetainHandling, Will
+from ._types import (
+    MQTTPublishPacket,
+    PropertyType,
+    PropertyValue,
+    QoS,
+    RetainHandling,
+    Will,
+)
 from .async_client import AsyncMQTTClient, AsyncMQTTSubscription
 
 if sys.version_info >= (3, 11):
@@ -104,9 +111,12 @@ def publish(
         *,
         qos: QoS = QoS.AT_MOST_ONCE,
         retain: bool = False,
+        properties: dict[PropertyType, PropertyValue] | None = None,
     ) -> None:
         return self._portal.call(
-            lambda: self._async_client.publish(topic, payload, qos=qos, retain=retain)
+            lambda: self._async_client.publish(
+                topic, payload, qos=qos, retain=retain, properties=properties
+            )
         )
 
     @contextmanager