feat: improve performance of dispatching discovery info to subclasses (#181)

Author: bdraco

src/habluetooth/manager.pxd

@@ -56,6 +56,7 @@ cdef class BluetoothManager:
     cdef public dict _adapter_sources
     cdef public dict _allocations
     cdef public dict _scanner_registration_callbacks
+    cdef public object _subclass_discover_info
 
     @cython.locals(stale_seconds=double)
     cdef bint _prefer_previous_adv_from_different_source(

src/habluetooth/manager.py

@@ -135,6 +135,7 @@ class BluetoothManager:
         "_unavailable_callbacks",
         "shutdown",
         "slot_manager",
+        "_subclass_discover_info",
     )
 
     def __init__(
@@ -184,6 +185,17 @@ def __init__(
         self._scanner_registration_callbacks: dict[
             str | None, set[Callable[[HaScannerRegistration], None]]
         ] = {}
+        self._subclass_discover_info = self._discover_service_info
+        if (
+            self._discover_service_info.__func__  # type: ignore[attr-defined]
+            is BluetoothManager._discover_service_info
+        ):
+            _LOGGER.warning(
+                "%s: does not implement _discover_service_info, "
+                "subclasses must implement this method to consume "
+                "discovery data",
+                type(self).__name__,
+            )
 
     @property
     def supports_passive_scan(self) -> bool:
@@ -639,7 +651,7 @@ def scanner_adv_received(self, service_info: BluetoothServiceInfoBleak) -> None:
                     bleak_callback, service_info.device, advertisement_data
                 )
 
-        self._discover_service_info(service_info)
+        self._subclass_discover_info(service_info)
 
     def _discover_service_info(self, service_info: BluetoothServiceInfoBleak) -> None:
         """

tests/test_manager.py

@@ -1214,3 +1214,39 @@ def _switchbot_device_unavailable_callback(
         get_manager().async_get_fallback_availability_interval("44:44:33:11:23:12")
         is None
     )
+
+
+@pytest.mark.asyncio
+async def test_subclassing_bluetooth_manager(caplog: pytest.LogCaptureFixture) -> None:
+    """Test subclassing BluetoothManager."""
+    slot_manager = BleakSlotManager()
+    bluetooth_adapters = FakeBluetoothAdapters()
+
+    class TestBluetoothManager(BluetoothManager):
+        """
+        Test class for BluetoothManager.
+
+        This class implements _discover_service_info.
+        """
+
+        def _discover_service_info(
+            self, service_info: BluetoothServiceInfoBleak
+        ) -> None:
+            """
+            Discover a new service info.
+
+            This method is intended to be overridden by subclasses.
+            """
+
+    TestBluetoothManager(bluetooth_adapters, slot_manager)
+    assert "does not implement _discover_service_info" not in caplog.text
+
+    class TestBluetoothManager2(BluetoothManager):
+        """
+        Test class for BluetoothManager.
+
+        This class does not implement _discover_service_info.
+        """
+
+    TestBluetoothManager2(bluetooth_adapters, slot_manager)
+    assert "does not implement _discover_service_info" in caplog.text