Coverage for src / zmqtt / _internal / packets / _wire.py: 82%

57 statements  

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

1"""Internal wire-format helpers: variable-length integers, UTF-8 strings, binary data.""" 

2 

3import struct 

4from typing import Final 

5 

6_MAX_MQTT_VARINT: Final = 268_435_455 

7 

8 

9def encode_varint(value: int) -> bytes: 

10 """Encode a non-negative integer as MQTT variable-length integer (1-4 bytes).""" 

11 if value < 0 or value > _MAX_MQTT_VARINT: 

12 msg = f"Value {value} out of varint range" 

13 raise ValueError(msg) 

14 result = bytearray() 

15 while True: 

16 byte = value & 0x7F 

17 value >>= 7 

18 if value: 

19 byte |= 0x80 

20 result.append(byte) 

21 if not value: 

22 break 

23 return bytes(result) 

24 

25 

26def decode_varint(buf: bytes | memoryview, offset: int = 0) -> tuple[int, int]: 

27 """Decode MQTT variable-length integer. 

28 

29 Returns (value, bytes_consumed). Raises ValueError if buffer is incomplete 

30 or the encoding exceeds 4 bytes. 

31 """ 

32 multiplier = 1 

33 value = 0 

34 for i in range(4): 

35 pos = offset + i 

36 if pos >= len(buf): 

37 msg = "Buffer too short for varint" 

38 raise ValueError(msg) 

39 byte = buf[pos] 

40 value += (byte & 0x7F) * multiplier 

41 if byte & 0x80 == 0: 

42 return value, i + 1 

43 multiplier *= 128 

44 msg = "Varint exceeds 4 bytes" 

45 raise ValueError(msg) 

46 

47 

48def encode_str(s: str) -> bytes: 

49 encoded = s.encode("utf-8") 

50 return struct.pack("!H", len(encoded)) + encoded 

51 

52 

53def decode_str(buf: bytes | memoryview, offset: int) -> tuple[str, int]: 

54 if offset + 2 > len(buf): 

55 msg = "Buffer too short for string length prefix" 

56 raise ValueError(msg) 

57 (length,) = struct.unpack_from("!H", buf, offset) 

58 end = offset + 2 + length 

59 if end > len(buf): 

60 msg = "Buffer too short for string data" 

61 raise ValueError(msg) 

62 return bytes(buf[offset + 2 : end]).decode("utf-8"), 2 + length 

63 

64 

65def encode_bytes_field(data: bytes) -> bytes: 

66 return struct.pack("!H", len(data)) + data 

67 

68 

69def decode_bytes_field(buf: bytes | memoryview, offset: int) -> tuple[bytes, int]: 

70 if offset + 2 > len(buf): 

71 msg = "Buffer too short for bytes length prefix" 

72 raise ValueError(msg) 

73 (length,) = struct.unpack_from("!H", buf, offset) 

74 end = offset + 2 + length 

75 if end > len(buf): 

76 msg = "Buffer too short for bytes data" 

77 raise ValueError(msg) 

78 return bytes(buf[offset + 2 : end]), 2 + length