Coverage for src/bluetooth_sig/types/protocols.py: 100%

1"""Protocol definitions for Bluetooth SIG standards.""" 

2 

3from __future__ import annotations 

4 

5from typing import Any, Protocol 

6 

7from .gatt_enums import GattProperty 

8 

9 

10class CharacteristicDataProtocol(Protocol): # pylint: disable=too-few-public-methods 

11 """Minimal protocol describing the attributes used by parsers. 

12 

13 This avoids importing the full `CharacteristicData` type here and 

14 gives callers a useful static type for `other_characteristics`. 

15 

16 Now includes field-level error reporting and parse trace capabilities 

17 for improved diagnostics. 

18 """ 

19 

20 value: Any 

21 raw_data: bytes 

22 parse_success: bool 

23 properties: list[GattProperty] 

24 name: str 

25 field_errors: list[Any] # ParseFieldError, but avoid circular import 

26 parse_trace: list[str] 

27 

28 

29class CharacteristicProtocol(Protocol): 

30 """Protocol for characteristic validation and round-trip testing. 

31 

32 Defines the minimal interface for characteristics that support 

33 parse/encode operations without requiring full BaseCharacteristic import. 

34 Used primarily by debug utilities. 

35 """ 

36 

37 def parse_value(self, data: bytearray) -> Any: # noqa: ANN401 

38 """Parse raw data into characteristic value.""" 

39 ... # pylint: disable=unnecessary-ellipsis # Ellipsis is required for Protocol method stubs 

40 

41 def encode_value(self, value: Any) -> bytearray: # noqa: ANN401 

42 """Encode characteristic value into raw data.""" 

43 ... # pylint: disable=unnecessary-ellipsis # Ellipsis is required for Protocol method stubs