Browse Source

private class _ReceivePacket: rename attribute `data` to `payload` to match argument of `transmit` method

Fabian Peter Hammerle 3 years ago
parent
commit
283dc66a0d
3 changed files with 13 additions and 10 deletions
  1. 4 4
      cc1101/__init__.py
  2. 4 4
      tests/test_receive.py
  3. 5 2
      tests/test_received_packet.py

+ 4 - 4
cc1101/__init__.py

@@ -77,12 +77,12 @@ class _ReceivedPacket:  # unstable
     def __init__(
         self,
         # *,
-        data: bytes,
+        payload: bytes,
         rssi_index: int,  # byte
         checksum_valid: bool,
         link_quality_indicator: int,  # 7bit
     ):
-        self.data = data
+        self.payload = payload
         self._rssi_index = rssi_index
         assert 0 <= rssi_index < (1 << 8), rssi_index
         self.checksum_valid = checksum_valid
@@ -104,7 +104,7 @@ class _ReceivedPacket:  # unstable
         return "{}(RSSI {:.0f}dBm, 0x{})".format(
             type(self).__name__,
             self.rssi_dbm,
-            "".join("{:02x}".format(b) for b in self.data),
+            "".join("{:02x}".format(b) for b in self.payload),
         )
 
 
@@ -866,7 +866,7 @@ class CC1101:
             return None
         buffer = self._read_burst(start_register=FIFORegisterAddress.RX, length=rxbytes)
         return _ReceivedPacket(
-            data=bytes(buffer[:-2]),
+            payload=bytes(buffer[:-2]),
             rssi_index=buffer[-2],
             checksum_valid=bool(buffer[-1] >> 7),
             link_quality_indicator=buffer[-1] & 0b0111111,

+ 4 - 4
tests/test_receive.py

@@ -11,9 +11,9 @@ def test__enable_receive_mode(transceiver):
     transceiver._spi.xfer.assert_called_once_with([0x34 | 0x00])
 
 
-@pytest.mark.parametrize("data", [b"\0", b"\x12\x45\x56"])
-def test__get_received_packet(transceiver, data):
-    fifo_buffer = list(data) + [128, (1 << 7) | 42]
+@pytest.mark.parametrize("payload", [b"\0", b"\x12\x45\x56"])
+def test__get_received_packet(transceiver, payload):
+    fifo_buffer = list(payload) + [128, (1 << 7) | 42]
     with unittest.mock.patch.object(
         transceiver, "_read_status_register", return_value=len(fifo_buffer)
     ) as read_status_register, unittest.mock.patch.object(
@@ -24,7 +24,7 @@ def test__get_received_packet(transceiver, data):
     read_burst_mock.assert_called_once_with(
         start_register=0x3F, length=len(fifo_buffer)
     )
-    assert received_packet.data == data
+    assert received_packet.payload == payload
     assert received_packet._rssi_index == 128
     assert received_packet.checksum_valid
     assert received_packet.link_quality_indicator == 42

+ 5 - 2
tests/test_received_packet.py

@@ -18,14 +18,17 @@ import cc1101
 )
 def test_rss_dbm(rssi_index, rssi_dbm):
     packet = cc1101._ReceivedPacket(
-        data=b"\0", rssi_index=rssi_index, checksum_valid=True, link_quality_indicator=0
+        payload=b"\0",
+        rssi_index=rssi_index,
+        checksum_valid=True,
+        link_quality_indicator=0,
     )
     assert packet.rssi_dbm == pytest.approx(rssi_dbm)
 
 
 def test___str__():
     packet = cc1101._ReceivedPacket(
-        data=b"\0\x12\x34",
+        payload=b"\0\x12\x34",
         rssi_index=204,
         checksum_valid=True,
         link_quality_indicator=0,