pytest-mqtt 0.6.2.dev0__tar.gz → 0.7.1__tar.gz

{pytest_mqtt-0.6.2.dev0/pytest_mqtt.egg-info → pytest_mqtt-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-mqtt
-Version: 0.6.2.dev0
+Version: 0.7.1
 Summary: pytest-mqtt supports testing systems based on MQTT
 Author-email: Andreas Motl <andreas.motl@panodata.org>, Richard Pobering <richard.pobering@panodata.org>
 Project-URL: changelog, https://github.com/mqtt-tools/pytest-mqtt/blob/main/CHANGES.rst
@@ -31,6 +31,8 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Communications
 Classifier: Topic :: Education
 Classifier: Topic :: Home Automation
@@ -51,18 +53,17 @@ Requires-Dist: importlib-metadata; python_version < "3.8"
 Requires-Dist: paho-mqtt<3
 Requires-Dist: pytest-docker-fixtures<2
 Provides-Extra: develop
-Requires-Dist: mypy<1.20; extra == "develop"
+Requires-Dist: mypy<2.4; extra == "develop"
 Requires-Dist: poethepoet<1; extra == "develop"
 Requires-Dist: pyproject-fmt<3; extra == "develop"
-Requires-Dist: ruff<0.15; extra == "develop"
+Requires-Dist: ruff==0.17.*; extra == "develop"
 Requires-Dist: validate-pyproject<1; extra == "develop"
 Provides-Extra: release
 Requires-Dist: build<2; extra == "release"
-Requires-Dist: twine<7; extra == "release"
+Requires-Dist: twine<8; extra == "release"
 Provides-Extra: test
 Requires-Dist: coverage<8; extra == "test"
-Requires-Dist: pytest<9; extra == "test"
-Requires-Dist: pytest-fixture-order<1; extra == "test"
+Requires-Dist: pytest<10; extra == "test"
 Requires-Dist: pytest-httpserver<2; extra == "test"
 Requires-Dist: pytest-ordering<1; extra == "test"
 Dynamic: license-file
@@ -103,7 +104,7 @@ pytest-mqtt
     :target: https://pypi.org/project/pytest-mqtt/
     :alt: Supported Python versions
 
-.. |license| image:: https://img.shields.io/pypi/l/pytest-mqtt.svg
+.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
     :target: https://github.com/mqtt-tools/pytest-mqtt/blob/main/LICENSE
     :alt: Project license
 
@@ -130,6 +131,10 @@ MQTT server host and port are configurable via pytest cli arguments:
 You may additionally specify a username and password for connecting to the broker with:
 ``--mqtt-username`` and ``--mqtt-password``. Default values are ``guest``/``guest``.
 
+By default, the test fixture subscribes to all topics, listening on ``#``. This can be
+disabled with the ``--no-subscribe-all`` option. You can then subscribe to the topics
+you are interested in within each test using ``capmqtt.mqtt_client.client.subscribe(cpe.info)``.
+
 ``mosquitto`` fixture
 =====================
 

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/README.rst

@@ -34,7 +34,7 @@ pytest-mqtt
     :target: https://pypi.org/project/pytest-mqtt/
     :alt: Supported Python versions
 
-.. |license| image:: https://img.shields.io/pypi/l/pytest-mqtt.svg
+.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
     :target: https://github.com/mqtt-tools/pytest-mqtt/blob/main/LICENSE
     :alt: Project license
 
@@ -61,6 +61,10 @@ MQTT server host and port are configurable via pytest cli arguments:
 You may additionally specify a username and password for connecting to the broker with:
 ``--mqtt-username`` and ``--mqtt-password``. Default values are ``guest``/``guest``.
 
+By default, the test fixture subscribes to all topics, listening on ``#``. This can be
+disabled with the ``--no-subscribe-all`` option. You can then subscribe to the topics
+you are interested in within each test using ``capmqtt.mqtt_client.client.subscribe(cpe.info)``.
+
 ``mosquitto`` fixture
 =====================
 

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/pyproject.toml

@@ -6,7 +6,7 @@
 
 [project]
 name = "pytest-mqtt"
-version = "0.6.2.dev0"
+version = "0.7.1"
 description = "pytest-mqtt supports testing systems based on MQTT"
 readme = "README.rst"
 keywords = [ "mosquitto", "mqtt", "paho", "pytest", "testing" ]
@@ -39,6 +39,8 @@ classifiers = [
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
   "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
   "Topic :: Communications",
   "Topic :: Education",
   "Topic :: Home Automation",
@@ -61,20 +63,19 @@ dependencies = [
 ]
 
 optional-dependencies.develop = [
-  "mypy<1.20",
+  "mypy<2.4",
   "poethepoet<1",
   "pyproject-fmt<3",
-  "ruff<0.15",
+  "ruff==0.17.*",
   "validate-pyproject<1",
 ]
 optional-dependencies.release = [
   "build<2",
-  "twine<7",
+  "twine<8",
 ]
 optional-dependencies.test = [
   "coverage<8",
-  "pytest<9",
-  "pytest-fixture-order<1",
+  "pytest<10",
   "pytest-httpserver<2",
   "pytest-ordering<1",
 ]
@@ -100,7 +101,7 @@ line-length = 120
 [tool.pytest.ini_options]
 minversion = "2.0"
 addopts = """
-  -rfEX -p pytester --strict-markers --verbosity=3
+  -rfEXS -p pytester --strict-markers --verbosity=3
   """
 log_level = "DEBUG"
 log_cli_level = "DEBUG"

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/pytest_mqtt/__init__.py

@@ -1,7 +1,7 @@
 try:
-    from importlib.metadata import PackageNotFoundError, version  # noqa
+    from importlib.metadata import PackageNotFoundError, version
 except ImportError:  # pragma: no cover
-    from importlib_metadata import PackageNotFoundError, version  # type: ignore[no-redef]  # noqa
+    from importlib_metadata import PackageNotFoundError, version  # type: ignore[no-redef]
 
 from .model import MqttMessage  # noqa: F401
 

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/pytest_mqtt/capmqtt.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 # Copyright (c) 2020-2022 Andreas Motl <andreas.motl@panodata.org>
 # Copyright (c) 2020-2022 Richard Pobering <richard.pobering@panodata.org>
 #
@@ -14,6 +13,8 @@ Source: https://github.com/hiveeyes/terkin-datalogger/blob/0.13.0/test/fixtures/
 .. _Paho MQTT Python Client: https://github.com/eclipse/paho.mqtt.python
 """
 
+from __future__ import annotations
+
 import logging
 import threading
 import typing as t
@@ -30,11 +31,12 @@ logger = logging.getLogger(__name__)
 class MqttClientAdapter(threading.Thread):
     def __init__(
         self,
-        on_message_callback: t.Optional[t.Callable] = None,
+        on_message_callback: t.Callable | None = None,
         host: str = "localhost",
         port: int = 1883,
         username: str = "guest",
         password: str = "guest",
+        subscribe_all: bool = True,
     ):
         super().__init__()
         self.client: mqtt.Client
@@ -51,6 +53,7 @@ class MqttClientAdapter(threading.Thread):
         self.port = int(port)
         self.username = username
         self.password = password
+        self.subscribe_all = subscribe_all
 
         self.setup()
 
@@ -66,7 +69,8 @@ class MqttClientAdapter(threading.Thread):
 
         logger.debug("[PYTEST] Connecting to MQTT broker")
         client.connect(host=self.host, port=self.port)
-        client.subscribe("#")
+        if self.subscribe_all:
+            client.subscribe("#")
 
     def run(self) -> None:
         self.client.loop_start()
@@ -99,7 +103,7 @@ class MqttClientAdapter(threading.Thread):
     def publish(
         self,
         topic: str,
-        payload: t.Union[str, bytes, bytearray, int, float, None],
+        payload: str | bytes | bytearray | float | None,
         **kwargs,
     ) -> mqtt.MQTTMessageInfo:
         message_info = self.client.publish(topic, payload, **kwargs)
@@ -112,18 +116,24 @@ class MqttCaptureFixture:
 
     def __init__(
         self,
-        decode_utf8: t.Optional[bool],
+        decode_utf8: bool | None,
         host: str = "localhost",
         port: int = 1883,
         username: str = "guest",
         password: str = "guest",
+        subscribe_all: bool = True,
     ) -> None:
         """Creates a new funcarg."""
-        self._buffer: t.List[MqttMessage] = []
+        self._buffer: list[MqttMessage] = []
         self._decode_utf8: bool = decode_utf8 or False
 
         self.mqtt_client = MqttClientAdapter(
-            on_message_callback=self.on_message, host=host, port=port, username=username, password=password
+            on_message_callback=self.on_message,
+            host=host,
+            port=port,
+            username=username,
+            password=password,
+            subscribe_all=subscribe_all,
         )
         self.mqtt_client.start()
         # time.sleep(0.1)
@@ -148,17 +158,17 @@ class MqttCaptureFixture:
         self._buffer = []
 
     @property
-    def messages(self) -> t.List[MqttMessage]:
+    def messages(self) -> list[MqttMessage]:
         return self._buffer
 
     @property
-    def records(self) -> t.List[t.Tuple[str, t.Union[str, bytes], t.Union[t.Dict, None]]]:
+    def records(self) -> list[tuple[str, str | bytes, dict | None]]:
         return [(item.topic, item.payload, item.userdata) for item in self._buffer]
 
     def publish(
         self,
         topic: str,
-        payload: t.Union[str, bytes, bytearray, int, float, None],
+        payload: str | bytes | bytearray | float | None,
         **kwargs,
     ) -> mqtt.MQTTMessageInfo:
         message_info = self.mqtt_client.publish(topic=topic, payload=payload, **kwargs)
@@ -178,6 +188,7 @@ def capmqtt(request, mqtt_settings: MqttSettings):
 
     host, port = mqtt_settings.host, mqtt_settings.port
     username, password = mqtt_settings.username, mqtt_settings.password
+    subscribe_all = mqtt_settings.subscribe_all
 
     capmqtt_decode_utf8 = (
         getattr(request.config.option, "capmqtt_decode_utf8", False)
@@ -185,7 +196,12 @@ def capmqtt(request, mqtt_settings: MqttSettings):
         or request.node.get_closest_marker("capmqtt_decode_utf8") is not None
     )
     result = MqttCaptureFixture(
-        decode_utf8=capmqtt_decode_utf8, host=host, port=port, username=username, password=password
+        decode_utf8=capmqtt_decode_utf8,
+        host=host,
+        port=port,
+        username=username,
+        password=password,
+        subscribe_all=subscribe_all,
     )
     delay()
     yield result

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/pytest_mqtt/model.py

@@ -1,5 +1,6 @@
+from __future__ import annotations
+
 import dataclasses
-import typing as t
 
 
 @dataclasses.dataclass
@@ -9,8 +10,8 @@ class MqttMessage:
     """
 
     topic: str
-    payload: t.Union[str, bytes]
-    userdata: t.Optional[t.Union[t.Dict, None]]
+    payload: str | bytes
+    userdata: None | dict
 
 
 @dataclasses.dataclass
@@ -19,3 +20,4 @@ class MqttSettings:
     port: int
     username: str
     password: str
+    subscribe_all: bool

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/pytest_mqtt/mosquitto.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 # Copyright (c) 2020-2022 Andreas Motl <andreas.motl@panodata.org>
 # Copyright (c) 2020-2022 Richard Pobering <richard.pobering@panodata.org>
 #
@@ -64,14 +62,16 @@ class Mosquitto(BaseImage):
         try:
             docker_client = docker.from_env(version=self.docker_version)
             docker_url = docker_client.api.base_url
-        except Exception:
-            raise ConnectionError("Cannot connect to the Docker daemon. Is the docker daemon running?")
+        except Exception as e:
+            raise ConnectionError("Cannot connect to the Docker daemon. Is the docker daemon running?") from e
         try:
             docker_client.ping()
-        except Exception:
-            raise ConnectionError(f"Cannot connect to the Docker daemon at {docker_url}. Is the docker daemon running?")
+        except Exception as e:
+            raise ConnectionError(
+                f"Cannot connect to the Docker daemon at {docker_url}. Is the docker daemon running?"
+            ) from e
         self.pull_image()
-        return super(Mosquitto, self).run()
+        return super().run()
 
 
 mosquitto_image = Mosquitto()
@@ -86,6 +86,9 @@ def pytest_addoption(parser) -> None:
     parser.addoption("--mqtt-port", action="store", type=int, default=1883, help="MQTT port number")
     parser.addoption("--mqtt-username", action="store", type=str, default="guest", help="Username for connection")
     parser.addoption("--mqtt-password", action="store", type=str, default="guest", help="Password for connection")
+    parser.addoption(
+        "--no-subscribe-all", action="store_false", dest="subscribe_all", help="Do not subscribe to all topics"
+    )
 
 
 @pytest.fixture(scope="session")
@@ -95,6 +98,7 @@ def mqtt_settings(pytestconfig) -> MqttSettings:
         port=pytestconfig.getoption("--mqtt-port"),
         username=pytestconfig.getoption("--mqtt-username"),
         password=pytestconfig.getoption("--mqtt-password"),
+        subscribe_all=pytestconfig.getoption("subscribe_all"),
     )
 
 

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1/pytest_mqtt.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytest-mqtt
-Version: 0.6.2.dev0
+Version: 0.7.1
 Summary: pytest-mqtt supports testing systems based on MQTT
 Author-email: Andreas Motl <andreas.motl@panodata.org>, Richard Pobering <richard.pobering@panodata.org>
 Project-URL: changelog, https://github.com/mqtt-tools/pytest-mqtt/blob/main/CHANGES.rst
@@ -31,6 +31,8 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Communications
 Classifier: Topic :: Education
 Classifier: Topic :: Home Automation
@@ -51,18 +53,17 @@ Requires-Dist: importlib-metadata; python_version < "3.8"
 Requires-Dist: paho-mqtt<3
 Requires-Dist: pytest-docker-fixtures<2
 Provides-Extra: develop
-Requires-Dist: mypy<1.20; extra == "develop"
+Requires-Dist: mypy<2.4; extra == "develop"
 Requires-Dist: poethepoet<1; extra == "develop"
 Requires-Dist: pyproject-fmt<3; extra == "develop"
-Requires-Dist: ruff<0.15; extra == "develop"
+Requires-Dist: ruff==0.17.*; extra == "develop"
 Requires-Dist: validate-pyproject<1; extra == "develop"
 Provides-Extra: release
 Requires-Dist: build<2; extra == "release"
-Requires-Dist: twine<7; extra == "release"
+Requires-Dist: twine<8; extra == "release"
 Provides-Extra: test
 Requires-Dist: coverage<8; extra == "test"
-Requires-Dist: pytest<9; extra == "test"
-Requires-Dist: pytest-fixture-order<1; extra == "test"
+Requires-Dist: pytest<10; extra == "test"
 Requires-Dist: pytest-httpserver<2; extra == "test"
 Requires-Dist: pytest-ordering<1; extra == "test"
 Dynamic: license-file
@@ -103,7 +104,7 @@ pytest-mqtt
     :target: https://pypi.org/project/pytest-mqtt/
     :alt: Supported Python versions
 
-.. |license| image:: https://img.shields.io/pypi/l/pytest-mqtt.svg
+.. |license| image:: https://img.shields.io/badge/license-MIT-green.svg
     :target: https://github.com/mqtt-tools/pytest-mqtt/blob/main/LICENSE
     :alt: Project license
 
@@ -130,6 +131,10 @@ MQTT server host and port are configurable via pytest cli arguments:
 You may additionally specify a username and password for connecting to the broker with:
 ``--mqtt-username`` and ``--mqtt-password``. Default values are ``guest``/``guest``.
 
+By default, the test fixture subscribes to all topics, listening on ``#``. This can be
+disabled with the ``--no-subscribe-all`` option. You can then subscribe to the topics
+you are interested in within each test using ``capmqtt.mqtt_client.client.subscribe(cpe.info)``.
+
 ``mosquitto`` fixture
 =====================
 

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/pytest_mqtt.egg-info/requires.txt

@@ -8,19 +8,18 @@ dataclasses
 importlib-metadata
 
 [develop]
-mypy<1.20
+mypy<2.4
 poethepoet<1
 pyproject-fmt<3
-ruff<0.15
+ruff==0.17.*
 validate-pyproject<1
 
 [release]
 build<2
-twine<7
+twine<8
 
 [test]
 coverage<8
-pytest<9
-pytest-fixture-order<1
+pytest<10
 pytest-httpserver<2
 pytest-ordering<1

{pytest_mqtt-0.6.2.dev0 → pytest_mqtt-0.7.1}/setup.py

@@ -1,5 +1,3 @@
-#!/usr/bin/env python
-
 # This is a shim to hopefully allow GitHub to detect the package.
 # The build is done with Poetry.