Rename and improve discovery function

Author: CoMPaTech

airos/discovery.py

@@ -276,7 +276,9 @@ def parse_airos_packet(self, data: bytes, host_ip: str) -> dict[str, Any] | None
         return parsed_info
 
 
-async def async_discover_devices(timeout: int) -> dict[str, dict[str, Any]]:
+async def airos_discover_devices(
+    timeout: int = 30, listen_ip: str = "0.0.0.0", port: int = DISCOVERY_PORT
+) -> dict[str, dict[str, Any]]:
     """Discover unconfigured airOS devices on the network for a given timeout.
 
     This function sets up a listener, waits for a period, and returns
@@ -301,7 +303,7 @@ async def _async_airos_device_found(device_info: dict[str, Any]) -> None:
             protocol,
         ) = await asyncio.get_running_loop().create_datagram_endpoint(
             lambda: AirOSDiscoveryProtocol(_async_airos_device_found),
-            local_addr=("0.0.0.0", DISCOVERY_PORT),
+            local_addr=(listen_ip, port),
         )
         try:
             await asyncio.sleep(timeout)

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name            = "airos"
-version         = "0.2.5"
+version         = "0.2.6a0"
 license         = "MIT"
 description     = "Ubiquity airOS module(s) for Python 3."
 readme          = "README.md"

tests/test_discovery.py

@@ -8,7 +8,7 @@
 from airos.discovery import (
     DISCOVERY_PORT,
     AirOSDiscoveryProtocol,
-    async_discover_devices,
+    airos_discover_devices,
 )
 from airos.exceptions import AirOSDiscoveryError, AirOSEndpointError, AirOSListenerError
 import pytest
@@ -247,7 +247,7 @@ async def _simulate_discovery():
             mock_protocol_factory(MagicMock()).callback(parsed_data)
 
         with patch("asyncio.sleep", new=AsyncMock()):
-            discovery_task = asyncio.create_task(async_discover_devices(timeout=1))
+            discovery_task = asyncio.create_task(airos_discover_devices(timeout=1))
 
             await _simulate_discovery()
 
@@ -264,7 +264,7 @@ async def test_async_discover_devices_no_devices(mock_datagram_endpoint):
     mock_transport, _ = mock_datagram_endpoint
 
     with patch("asyncio.sleep", new=AsyncMock()):
-        result = await async_discover_devices(timeout=1)
+        result = await airos_discover_devices(timeout=1)
 
     assert result == {}
     mock_transport.close.assert_called_once()
@@ -284,7 +284,7 @@ async def test_async_discover_devices_oserror(mock_datagram_endpoint):
             side_effect=OSError(98, "Address in use")
         )
 
-        await async_discover_devices(timeout=1)
+        await airos_discover_devices(timeout=1)
 
     assert "address_in_use" in str(excinfo.value)
     mock_transport.close.assert_not_called()
@@ -300,7 +300,7 @@ async def test_async_discover_devices_cancelled(mock_datagram_endpoint):
         patch("asyncio.sleep", new=AsyncMock(side_effect=asyncio.CancelledError)),
         pytest.raises(AirOSListenerError) as excinfo,
     ):
-        await async_discover_devices(timeout=1)
+        await airos_discover_devices(timeout=1)
 
     assert "cannot_connect" in str(excinfo.value)
     mock_transport.close.assert_called_once()
@@ -373,7 +373,7 @@ async def test_async_discover_devices_generic_oserror(mock_datagram_endpoint):
         mock_loop.create_datagram_endpoint = AsyncMock(
             side_effect=OSError(13, "Permission denied")
         )
-        await async_discover_devices(timeout=1)
+        await airos_discover_devices(timeout=1)
 
     assert "cannot_connect" in str(excinfo.value)
     mock_transport.close.assert_not_called()