Coverage for src / zmqtt / _internal / transport / base.py: 100%

48 statements  

« prev     ^ index     » next       coverage.py v7.13.4, created at 2026-11-12 08:49 +0000

1import asyncio 

2import contextlib 

3from typing import Protocol, runtime_checkable 

4 

5from zmqtt._internal._compat import wait_for 

6from zmqtt.errors import MQTTDisconnectedError 

7 

8_DRAIN_TIMEOUT_SECONDS = 30.0 

9_CLOSE_TIMEOUT_SECONDS = 1.0 

10 

11 

12@runtime_checkable 

13class Transport(Protocol): 

14 async def read(self, n: int) -> bytes: ... 

15 async def write(self, data: bytes) -> None: ... 

16 async def close(self) -> None: ... 

17 

18 @property 

19 def is_connected(self) -> bool: ... 

20 

21 

22class StreamTransport: 

23 """Asyncio StreamReader/StreamWriter pair wrapped as a Transport.""" 

24 

25 def __init__( 

26 self, 

27 reader: asyncio.StreamReader, 

28 writer: asyncio.StreamWriter, 

29 ) -> None: 

30 self._reader = reader 

31 self._writer = writer 

32 self._closed = False 

33 self._writer_closed = False 

34 

35 async def read(self, n: int) -> bytes: 

36 try: 

37 data = await self._reader.read(n) 

38 except OSError as exc: 

39 # RST / ENETUNREACH / TLS drop on a live socket: same reconnect path as EOF. 

40 self._closed = True 

41 msg = "Connection lost" 

42 raise MQTTDisconnectedError(msg) from exc 

43 if not data: 

44 self._closed = True 

45 msg = "Connection closed by remote" 

46 raise MQTTDisconnectedError(msg) 

47 return data 

48 

49 async def write(self, data: bytes) -> None: 

50 try: 

51 self._writer.write(data) 

52 await wait_for(self._writer.drain(), timeout=_DRAIN_TIMEOUT_SECONDS) 

53 except (OSError, asyncio.TimeoutError) as exc: 

54 # The file descriptor is released by close(), same as on the read side. 

55 self._closed = True 

56 msg = "Connection lost" 

57 raise MQTTDisconnectedError(msg) from exc 

58 

59 async def close(self) -> None: 

60 self._closed = True 

61 if not self._writer_closed: 

62 self._writer_closed = True 

63 self._writer.close() 

64 try: 

65 await wait_for(self._writer.wait_closed(), timeout=_CLOSE_TIMEOUT_SECONDS) 

66 except Exception: # noqa: BLE001 - a hung or failed close must not block reconnect 

67 with contextlib.suppress(Exception): 

68 self._writer.transport.abort() 

69 

70 @property 

71 def is_connected(self) -> bool: 

72 return not self._closed