aiobmsble 0.4__tar.gz → 0.4.1__tar.gz

{aiobmsble-0.4/aiobmsble.egg-info → aiobmsble-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiobmsble
-Version: 0.4
+Version: 0.4.1
 Summary: Asynchronous Python library to query battery management systems via Bluetooth Low Energy.
 Author: Patrick Loschmidt
 Maintainer: Patrick Loschmidt
@@ -114,16 +114,14 @@ if __name__ == "__main__":
 ```
 
 ### Testing
-For integrations tests (using pytest) the library provides advertisement data that can be used to verify detection of BMSs. To use it, include the following line into your `conftest.py`:
-```python
-pytest_plugins: list[str] = ["aiobmsble.test_data"]
-```
+For integrations tests (using pytest) the library provides advertisement data that can be used to verify detection of BMSs. For your tests you can use
 
-For your tests you can then use
 ```python
-def test_advertisements(bms_advertisements) -> None:
+from aiobmsble.test_data import bms_advertisements
+
+def test_advertisements() -> None:
     """Run some tests with the advertisements"""
-    for advertisement, bms_type, _comments in bms_advertisements:
+    for advertisement, bms_type, _comments in bms_advertisements():
         ...
 ```
 

{aiobmsble-0.4 → aiobmsble-0.4.1}/README.md

@@ -82,16 +82,14 @@ if __name__ == "__main__":
 ```
 
 ### Testing
-For integrations tests (using pytest) the library provides advertisement data that can be used to verify detection of BMSs. To use it, include the following line into your `conftest.py`:
-```python
-pytest_plugins: list[str] = ["aiobmsble.test_data"]
-```
+For integrations tests (using pytest) the library provides advertisement data that can be used to verify detection of BMSs. For your tests you can use
 
-For your tests you can then use
 ```python
-def test_advertisements(bms_advertisements) -> None:
+from aiobmsble.test_data import bms_advertisements
+
+def test_advertisements() -> None:
     """Run some tests with the advertisements"""
-    for advertisement, bms_type, _comments in bms_advertisements:
+    for advertisement, bms_type, _comments in bms_advertisements():
         ...
 ```
 

{aiobmsble-0.4 → aiobmsble-0.4.1}/aiobmsble/test_data/__init__.py

@@ -5,7 +5,6 @@ import json
 from typing import Any
 
 from bleak.backends.scanner import AdvertisementData
-import pytest
 
 from tests.bluetooth import generate_advertisement_data
 
@@ -29,11 +28,15 @@ def _json_dict_to_advdata(json_dict: dict[str, Any]) -> AdvertisementData:
     return generate_advertisement_data(**json_dict)
 
 
-@pytest.fixture
 def bms_advertisements() -> BmsAdvList:
     """Provide all available BMS advertisements from test data directory.
 
     Load all *_bms.json files from the packaged test data directory.
+
+    Returns:
+        BmsAdvList: List of tuples containing advertisement, bms type,
+        and a list of comments, i.e. list[tuple[AdvertisementData, str, list[str]]]
+
     """
     all_data: BmsAdvList = []
 
@@ -62,11 +65,15 @@ def bms_advertisements() -> BmsAdvList:
     return all_data
 
 
-@pytest.fixture
 def ignore_advertisements() -> BmsAdvList:
     """Provide a list of advertisements that shall not be identified as a valid BMS.
 
     Load ignore.json files from the packaged test data directory.
+
+    Returns:
+        BmsAdvList: List of tuples containing advertisement, reason why not to detect,
+        and a list of comments, i.e. list[tuple[AdvertisementData, str, list[str]]]
+
     """
     data: BmsAdvList = []
 

{aiobmsble-0.4 → aiobmsble-0.4.1/aiobmsble.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aiobmsble
-Version: 0.4
+Version: 0.4.1
 Summary: Asynchronous Python library to query battery management systems via Bluetooth Low Energy.
 Author: Patrick Loschmidt
 Maintainer: Patrick Loschmidt
@@ -114,16 +114,14 @@ if __name__ == "__main__":
 ```
 
 ### Testing
-For integrations tests (using pytest) the library provides advertisement data that can be used to verify detection of BMSs. To use it, include the following line into your `conftest.py`:
-```python
-pytest_plugins: list[str] = ["aiobmsble.test_data"]
-```
+For integrations tests (using pytest) the library provides advertisement data that can be used to verify detection of BMSs. For your tests you can use
 
-For your tests you can then use
 ```python
-def test_advertisements(bms_advertisements) -> None:
+from aiobmsble.test_data import bms_advertisements
+
+def test_advertisements() -> None:
     """Run some tests with the advertisements"""
-    for advertisement, bms_type, _comments in bms_advertisements:
+    for advertisement, bms_type, _comments in bms_advertisements():
         ...
 ```
 

{aiobmsble-0.4 → aiobmsble-0.4.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "aiobmsble"
-version = "0.4"
+version = "0.4.1"
 requires-python = ">=3.12"
 description = "Asynchronous Python library to query battery management systems via Bluetooth Low Energy."
 readme = "README.md"

{aiobmsble-0.4 → aiobmsble-0.4.1}/tests/test_plugins.py

@@ -3,6 +3,7 @@
 from types import ModuleType
 
 from aiobmsble.basebms import BaseBMS
+from aiobmsble.test_data import bms_advertisements, ignore_advertisements
 from aiobmsble.utils import bms_supported, load_bms_plugins
 
 
@@ -20,9 +21,9 @@ def test_matcher_dict(plugin_fixture: ModuleType) -> None:
     assert len(bms_class.matcher_dict_list())
 
 
-def test_advertisements_unique(bms_advertisements) -> None:
+def test_advertisements_unique() -> None:
     """Check that each advertisement only matches one, the right BMS."""
-    for adv, bms_real, _comments in bms_advertisements:
+    for adv, bms_real, _comments in bms_advertisements():
         for bms_under_test in load_bms_plugins():
             supported: bool = bms_supported(bms_under_test.BMS, adv)
             assert supported == (
@@ -30,9 +31,9 @@ def test_advertisements_unique(bms_advertisements) -> None:
             ), f"{adv} {"incorrectly matches"if supported else "does not match"} {bms_under_test}!"
 
 
-def test_advertisements_ignore(ignore_advertisements) -> None:
+def test_advertisements_ignore() -> None:
     """Check that each advertisement only matches one, the right BMS."""
-    for adv, reason, _comments in ignore_advertisements:
+    for adv, reason, _comments in ignore_advertisements():
         for bms_under_test in load_bms_plugins():
             supported: bool = bms_supported(bms_under_test.BMS, adv)
             assert (

{aiobmsble-0.4 → aiobmsble-0.4.1}/tests/test_test_data.py

@@ -2,15 +2,17 @@
 
 from bleak.backends.scanner import AdvertisementData
 
-from aiobmsble.test_data import BmsAdvList, _json_dict_to_advdata
+from aiobmsble.test_data import (
+    _json_dict_to_advdata,
+    bms_advertisements,
+    ignore_advertisements,
+)
 
 
-def test_test_data_availability(
-    bms_advertisements: BmsAdvList, ignore_advertisements: BmsAdvList
-) -> None:
+def test_test_data_availability() -> None:
     """That fixtures work, safety measure to avoid package corruption."""
-    assert len(bms_advertisements) > 0
-    assert len(ignore_advertisements) > 0
+    assert len(bms_advertisements()) > 0
+    assert len(ignore_advertisements()) > 0
 
 
 def test_json_dict_to_advdata() -> None:

{aiobmsble-0.4 → aiobmsble-0.4.1}/tests/test_utils.py

@@ -7,6 +7,7 @@ import pytest
 
 from aiobmsble import MatcherPattern
 from aiobmsble.basebms import BaseBMS
+from aiobmsble.test_data import bms_advertisements
 from aiobmsble.utils import (
     _advertisement_matches,
     bms_cls,
@@ -36,14 +37,14 @@ def get_advertisement_by_type(advertisements, name: str) -> AdvertisementData |
     return None
 
 
-def test_bms_identify(bms_advertisements, plugin: ModuleType) -> None:
+def test_bms_identify(plugin: ModuleType) -> None:
     """Test that each BMS is correctly detected by a pattern.
 
     This also ensures that each BMS has at least one advertisement.
     """
     bms_type: str = getattr(plugin, "__name__", "").rsplit(".", 1)[-1]
     adv: AdvertisementData | None = (
-        get_advertisement_by_type(bms_advertisements, bms_type)
+        get_advertisement_by_type(bms_advertisements(), bms_type)
         if bms_type != "dummy_bms"  # generate advertisement for dummy
         else generate_advertisement_data(local_name="dummy")
     )