feat: rename _async_on_raw_advertisement to _async_on_raw_advertisements (#184)

Author: bdraco

src/habluetooth/base_scanner.pxd

@@ -56,6 +56,19 @@ cdef class BaseHaRemoteScanner(BaseHaScanner):
         info=BluetoothServiceInfoBleak,
         prev_info=BluetoothServiceInfoBleak
     )
+    cdef void _async_on_advertisement_internal(
+        self,
+        str address,
+        int rssi,
+        str local_name,
+        list service_uuids,
+        dict service_data,
+        dict manufacturer_data,
+        object tx_power,
+        dict details,
+        double advertisement_monotonic_time
+    )
+
     cpdef void _async_on_advertisement(
         self,
         str address,
@@ -70,7 +83,7 @@ cdef class BaseHaRemoteScanner(BaseHaScanner):
     )
 
     @cython.locals(parsed=tuple, address_rssi_raw_details=tuple, now=double)
-    cpdef void _async_on_raw_advertisement(self, list advertisements)
+    cpdef void _async_on_raw_advertisements(self, list advertisements)
 
     @cython.locals(now=double, timestamp=double, info=BluetoothServiceInfoBleak)
     cpdef void _async_expire_devices(self)

src/habluetooth/base_scanner.py

@@ -408,7 +408,7 @@ def get_discovered_device_advertisement_data(
             return info.device, info.advertisement
         return None
 
-    def _async_on_raw_advertisement(
+    def _async_on_raw_advertisements(
         self, advertisements: list[AdvertisementTupleType]
     ) -> None:
         """
@@ -422,7 +422,7 @@ def _async_on_raw_advertisement(
         now = _MONOTONIC_NOW()
         for address_rssi_raw_details in advertisements:
             parsed = parse_advertisement_data_tuple(address_rssi_raw_details[2])
-            self._async_on_advertisement(
+            self._async_on_advertisement_internal(
                 address_rssi_raw_details[0],
                 address_rssi_raw_details[1],
                 parsed[0],
@@ -446,7 +446,36 @@ def _async_on_advertisement(
         details: dict[Any, Any],
         advertisement_monotonic_time: _float,
     ) -> None:
-        """Call the registered callback."""
+        """Call on new advertisement data."""
+        self._async_on_advertisement_internal(
+            address,
+            rssi,
+            local_name,
+            service_uuids,
+            service_data,
+            manufacturer_data,
+            tx_power,
+            details,
+            advertisement_monotonic_time,
+        )
+
+    def _async_on_advertisement_internal(
+        self,
+        address: _str,
+        rssi: _int,
+        local_name: _str | None,
+        service_uuids: list[str],
+        service_data: dict[str, bytes],
+        manufacturer_data: dict[int, bytes],
+        tx_power: _int | None,
+        details: dict[Any, Any],
+        advertisement_monotonic_time: _float,
+    ) -> None:
+        """
+        Internal implementation of _async_on_advertisement.
+
+        This method is unstable and not part of the public API.
+        """
         self.scanning = not self._connecting
         self._last_detection = advertisement_monotonic_time
         info = BluetoothServiceInfoBleak.__new__(BluetoothServiceInfoBleak)

tests/test_base_scanner.py

@@ -63,7 +63,7 @@ def inject_raw_advertisement(
         self, address: str, data: tuple[bytes, ...], details: dict[Any, Any], rssi: int
     ) -> None:
         """Inject a raw advertisement."""
-        self._async_on_raw_advertisement([(address, rssi, data, details)])
+        self._async_on_raw_advertisements([(address, rssi, data, details)])
 
 
 @pytest.mark.parametrize("name_2", [None, "w"])

tests/test_benchmark_base_scanner.py

@@ -2,12 +2,19 @@
 
 from __future__ import annotations
 
+import base64
+
 import pytest
 from bleak.backends.scanner import AdvertisementData
 from bluetooth_data_tools import monotonic_time_coarse
 from pytest_codspeed import BenchmarkFixture
 
-from habluetooth import BaseHaRemoteScanner, HaBluetoothConnector, get_manager
+from habluetooth import (
+    AdvertisementTupleType,
+    BaseHaRemoteScanner,
+    HaBluetoothConnector,
+    get_manager,
+)
 
 from . import (
     MockBleakClient,
@@ -73,6 +80,46 @@ def run():
     unsetup()
 
 
+@pytest.mark.usefixtures("enable_bluetooth")
+@pytest.mark.asyncio
+async def test_inject_100_simple_raw_advertisements(
+    benchmark: BenchmarkFixture,
+) -> None:
+    """Test injecting 100 simple raw advertisements."""
+    manager = get_manager()
+
+    switchbot_device = generate_ble_device(
+        "44:44:33:11:23:45",
+        "wohand",
+        {},
+        rssi=-100,
+    )
+    connector = HaBluetoothConnector(
+        MockBleakClient, "mock_bleak_client", lambda: False
+    )
+
+    class SubclassedBaseHaRemoteScanner(BaseHaRemoteScanner):
+        """Subclassed BaseHaRemoteScanner to expose _async_on_raw_advertisements."""
+
+    scanner = SubclassedBaseHaRemoteScanner("esp32", "esp32", connector, True)
+    unsetup = scanner.async_setup()
+    cancel = manager.async_register_scanner(scanner)
+    _address = switchbot_device.address
+    _rssi = switchbot_device.rssi
+    adv_bytes = (base64.b64decode("AgEaAgoFCv9MABAFChx3+Vs="),)
+    advs: list[AdvertisementTupleType] = [
+        (_address, _rssi, adv_bytes, {}) for _ in range(100)
+    ]
+
+    def run():
+        scanner._async_on_raw_advertisements(advs)
+
+    benchmark(run)
+
+    cancel()
+    unsetup()
+
+
 @pytest.mark.usefixtures("enable_bluetooth")
 @pytest.mark.asyncio
 async def test_inject_100_complex_advertisements(benchmark: BenchmarkFixture) -> None: