python-ember-mug 1.1.1__tar.gz → 1.2.0b1__tar.gz

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-ember-mug
-Version: 1.1.1
+Version: 1.2.0b1
 Summary: Python Library for Ember Mugs.
 Project-URL: Changelog, https://sopelj.github.io/python-ember-mug/changelog/
 Project-URL: Documentation, https://sopelj.github.io/python-ember-mug/
@@ -20,6 +20,8 @@ Requires-Python: >=3.11
 Requires-Dist: bleak-retry-connector>=3.5.0
 Requires-Dist: bleak>=0.22.2; python_version < '3.13'
 Requires-Dist: bleak>=0.22.3; python_version <= '3.13'
+Provides-Extra: dev
+Requires-Dist: ipython; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: black; extra == 'docs'
 Requires-Dist: mkdocs-autorefs; extra == 'docs'

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/ember_mug/__init__.py

@@ -6,4 +6,4 @@ __all__ = ("EmberMug",)
 
 __author__ = """Jesse Sopel"""
 __email__ = "jesse.sopel@gmail.com"
-__version__ = "1.1.1"
+__version__ = "1.2.0b1"

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/ember_mug/consts.py

@@ -149,10 +149,10 @@ TRAVEL_MUG_SERVICE_UUIDS = (
     str(MugCharacteristic.TRAVEL_MUG_SERVICE_OTHER),
 )
 
-DEVICE_SERVICE_UUIDS = (
+DEVICE_SERVICE_UUIDS = [
     str(MugCharacteristic.STANDARD_SERVICE),
     *TRAVEL_MUG_SERVICE_UUIDS,
-)
+]
 
 
 class LiquidState(IntEnum):

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/ember_mug/scanner.py

@@ -5,29 +5,37 @@ from __future__ import annotations
 import asyncio
 import contextlib
 import logging
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, cast
 
 from bleak import BleakScanner
 
 from .consts import DEVICE_SERVICE_UUIDS, IS_LINUX
 
 if TYPE_CHECKING:
+    from typing import NotRequired, TypedDict
+
     from bleak.backends.device import BLEDevice
     from bleak.backends.scanner import AdvertisementData
 
+    class ScannerKwargs(TypedDict):
+        """Optional kwargs for scanner."""
+
+        adapter: NotRequired[str]
+        service_uuids: NotRequired[list[str]]
+
 
 DEFAULT_TIMEOUT = 30
 
 logger = logging.getLogger(__name__)
 
 
-def build_scanner_kwargs(adapter: str | None = None) -> dict[str, Any]:
+def build_scanner_kwargs(adapter: str | None = None, *, service_uuids: list[str] | None = None) -> ScannerKwargs:
     """Add Adapter to kwargs for scanner if specified and using BlueZ."""
     if adapter and IS_LINUX is not True:
         msg = "The adapter option is only valid for the Linux BlueZ Backend."
         raise ValueError(msg)
-    kwargs = {"service_uuids": DEVICE_SERVICE_UUIDS}
-    return kwargs | {"adapter": adapter} if adapter else kwargs
+    kwargs = {"service_uuids": service_uuids} if service_uuids else {}
+    return cast("ScannerKwargs", kwargs | {"adapter": adapter} if adapter else kwargs)
 
 
 async def discover_devices(
@@ -47,7 +55,7 @@ async def discover_devices(
         ```
 
     """
-    async with BleakScanner(**build_scanner_kwargs(adapter)) as scanner:
+    async with BleakScanner(**build_scanner_kwargs(adapter, service_uuids=DEVICE_SERVICE_UUIDS)) as scanner:
         await asyncio.sleep(wait)
         return [
             (d, a)

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/ember_mug/utils.py

@@ -134,7 +134,7 @@ def guess_model_from_name(name: str | None) -> DeviceModel | None:
 
 def get_model_info_from_advertiser_data(advertisement: AdvertisementData) -> ModelInfo:
     """Extract model info from manufacturer data in advertiser data."""
-    from ember_mug.data import ModelInfo
+    from ember_mug.data import ModelInfo  # noqa: PLC0415
 
     model_data = advertisement.manufacturer_data.get(EMBER_BLE_SIG, None)
     if model_data is not None:

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/pyproject.toml

@@ -1,5 +1,3 @@
-[tool]
-
 [project]
 name = "python-ember-mug"
 readme = "README.md"
@@ -43,6 +41,9 @@ docs = [
   "black",
   "termynal",
 ]
+dev = [
+  "ipython",
+]
 
 [project.urls]
 "Changelog" = "https://sopelj.github.io/python-ember-mug/changelog/"

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/tests/cli/test_commands.py

@@ -316,7 +316,7 @@ def test_ember_cli():
 @patch("ember_mug.consts.IS_LINUX", False)
 def test_ember_cli_windows():
     del sys.modules["ember_mug.cli.commands"]  # force re-import
-    from ember_mug.cli.commands import EmberMugCli
+    from ember_mug.cli.commands import EmberMugCli  # noqa: PLC0415
 
     cli = EmberMugCli()
 
@@ -364,7 +364,7 @@ async def test_cli_run_discover_debug(mock_logging_config: Mock):
 @patch("sys.argv", ["file.py", "find", "-m", TEST_MAC, "--raw"])
 async def test_cli_run_non_linux():
     del sys.modules["ember_mug.cli.commands"]  # force re-import
-    from ember_mug.cli.commands import EmberMugCli
+    from ember_mug.cli.commands import EmberMugCli  # noqa: PLC0415
 
     cli = EmberMugCli()
     mock_find = AsyncMock()

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/tests/test_consts.py

@@ -4,9 +4,17 @@ from __future__ import annotations
 
 from uuid import UUID
 
+import pytest
+
 from ember_mug.consts import LiquidState, MugCharacteristic, VolumeLevel
 
 
+@pytest.mark.parametrize("characteristic", MugCharacteristic)
+def test_characteristic_uuids(characteristic: MugCharacteristic) -> None:
+    assert characteristic.uuid == UUID(f"fc54{characteristic.value:04x}-236c-4c94-8fa9-944a3e5353fa")
+    assert str(characteristic) == f"fc54{characteristic.value:04x}-236c-4c94-8fa9-944a3e5353fa"
+
+
 def test_mug_uuids() -> None:
     assert MugCharacteristic.MUG_NAME.uuid == UUID("fc540001-236c-4c94-8fa9-944a3e5353fa")
     assert str(MugCharacteristic.MUG_NAME) == "fc540001-236c-4c94-8fa9-944a3e5353fa"

{python_ember_mug-1.1.1 → python_ember_mug-1.2.0b1}/tests/test_scanner.py

@@ -1,5 +1,8 @@
 """Tests for scanner."""
 
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
 from unittest.mock import AsyncMock, MagicMock, patch
 
 import pytest
@@ -10,15 +13,20 @@ from ember_mug.scanner import build_scanner_kwargs, discover_devices, find_devic
 
 from .conftest import TEST_MUG_ADVERTISEMENT
 
+if TYPE_CHECKING:
+    from ember_mug.scanner import ScannerKwargs
+
 MUG_1 = BLEDevice(address="32:36:a5:be:88:cb", name="Ember Ceramic Mug", details={}, rssi=1)
 MUG_2 = BLEDevice(address="9c:da:8c:19:27:da", name="Ember Ceramic Mug", details={}, rssi=1)
 EXAMPLE_MUGS = [MUG_1, MUG_2]
+SERVICE_UUID_KWARG = {"service_uuids": DEVICE_SERVICE_UUIDS}
+ADAPTER_KWARG = {"adapter": "hci0"}
 
 
 @patch("ember_mug.scanner.IS_LINUX", True)
-def test_build_scanner_kwargs_linux() -> None:
-    assert build_scanner_kwargs() == {"service_uuids": DEVICE_SERVICE_UUIDS}
-    assert build_scanner_kwargs(adapter="hci0") == {"adapter": "hci0", "service_uuids": DEVICE_SERVICE_UUIDS}
+@pytest.mark.parametrize("kwargs", [{}, ADAPTER_KWARG, SERVICE_UUID_KWARG, ADAPTER_KWARG | SERVICE_UUID_KWARG])
+def test_build_scanner_kwargs_linux(kwargs: ScannerKwargs) -> None:
+    assert build_scanner_kwargs(**kwargs) == kwargs
 
 
 @patch("ember_mug.scanner.IS_LINUX", False)