burst-link-protocol 1.1.4__tar.gz → 1.1.5__tar.gz

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/.github/workflows/wheel.yml

@@ -44,7 +44,7 @@ jobs:
       with:
         submodules: true
 
-    - uses: pypa/cibuildwheel@v2.22
+    - uses: pypa/cibuildwheel@v2.23
 
       # env:
         # CIBW_BUILD: "cp312-*"

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: burst-link-protocol
-Version: 1.1.4
+Version: 1.1.5
 Summary: Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams into and from a byte stream.
 Author-Email: Floris vernieuwe <floris@vernieuwe.eu>
 License-File: LICENSE

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "burst-link-protocol"
-version = "1.1.4"  # Choose one version reference here
+version = "1.1.5"  # Choose one version reference here
 description = "Binary Utility for Reliable Stream Transfer (BURST) is a library for encoding and decoding binary data streams into and from a byte stream."
 requires-python = ">=3.10,<4.0"
 authors = [
@@ -62,3 +62,16 @@ test-skip="cp38-macosx_*:arm64"
 # Needed for full C++17 support
 [tool.cibuildwheel.macos.environment]
 MACOSX_DEPLOYMENT_TARGET = "10.14"
+
+
+[tool.ruff.lint]
+select = ["E", "F"]
+ignore = ["E402"]
+
+[tool.ruff]
+line-length = 120
+exclude = ["**.pyi", "**/.venv/**"]
+include = ["src/**.py", "test/**.py"]
+
+[tool.pyright]
+ignore = ["**.pyi", "**/.venv/**"]

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/src/burst_link_protocol/__init__.py

@@ -1,5 +1,5 @@
 from burst_interface_c import BurstInterfaceC
 from .main import BurstInterfacePy
-from .serial_burst_interface import SerialBurstInterface
+from .serial_burst_interface import SerialBurstInterface, BurstSerialStatistics
 
-__all__ = ["BurstInterfaceC", "BurstInterfacePy", "SerialBurstInterface"]
+__all__ = ["BurstInterfaceC", "BurstInterfacePy", "SerialBurstInterface", "BurstSerialStatistics"]

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/src/burst_link_protocol/main.py

@@ -1,7 +1,8 @@
 from cobs import cobs
-from crc import Calculator,Crc16
+from crc import Calculator, Crc16
+
+crc = Calculator(Crc16.IBM_3740)  # type: ignore
 
-crc = Calculator(Crc16.IBM_3740)
 
 class BurstInterfacePy:
     buffer = b""
@@ -10,9 +11,8 @@ class BurstInterfacePy:
         pass
 
     @staticmethod
-    def crc16( data: bytes) -> bytes:
+    def crc16(data: bytes) -> bytes:
         return crc.checksum(data).to_bytes(2, "big")
-    
 
     @staticmethod
     def encode_packet(packet: bytes) -> bytes:
@@ -38,4 +38,3 @@ class BurstInterfacePy:
         # Add last packet to buffer
         self.buffer = separated_packets.pop()
         return [self.decode_packet(packet) for packet in separated_packets]
-

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/src/burst_link_protocol/serial_burst_interface.py

@@ -1,4 +1,4 @@
-from burst_interface_c import  BurstInterfaceC
+from burst_interface_c import BurstInterfaceC
 import serial
 import time
 import threading
@@ -6,6 +6,7 @@ import asyncio
 import janus
 from pydantic import BaseModel, Field
 
+
 def to_si(value: float, suffix: str) -> str:
     """
     Convert a value to a string with SI suffix.
@@ -34,9 +35,9 @@ class BurstSerialStatistics(BaseModel):
     overflow_errors: int = 0
     decode_errors: int = 0
 
-    handled_bytes_per_second: float = 0
-    processed_bytes_per_second: float = 0
-    processed_packets_per_second: float = 0
+    handled_bytes_per_second: float = 0.0
+    processed_bytes_per_second: float = 0.0
+    processed_packets_per_second: float = 0.0
 
     def update(
         self,
@@ -47,21 +48,14 @@ class BurstSerialStatistics(BaseModel):
         overflow_errors,
         decode_errors,
     ):
-
         now = time.time()
         if now - self.last_update_timestamp > 1:
             delta_time = now - self.last_update_timestamp
             self.last_update_timestamp = now
 
-            self.handled_bytes_per_second = (
-                (bytes_handled - self.bytes_handled) / delta_time
-            )
-            self.processed_bytes_per_second = (
-                (bytes_processed - self.bytes_processed) / delta_time
-            )
-            self.processed_packets_per_second = (
-                (packets_processed - self.packets_processed) / delta_time
-            )
+            self.handled_bytes_per_second = (bytes_handled - self.bytes_handled) / delta_time
+            self.processed_bytes_per_second = (bytes_processed - self.bytes_processed) / delta_time
+            self.processed_packets_per_second = (packets_processed - self.packets_processed) / delta_time
 
             self.bytes_handled = bytes_handled
             self.bytes_processed = bytes_processed
@@ -74,12 +68,16 @@ class BurstSerialStatistics(BaseModel):
 
     def __str__(self):
         return (
-            f"Byte Raw: {to_si(self.bytes_handled, 'B')} ({to_si(self.handled_bytes_per_second*8, 'bps')}), "
-            f"Bytes processed: {to_si(self.bytes_processed, 'B')} ({to_si(self.processed_bytes_per_second*8, 'bps')}), "
+            f"Byte Raw: {to_si(self.bytes_handled, 'B')} ({to_si(self.handled_bytes_per_second * 8, 'bps')}), "
+            f"Bytes processed: {to_si(self.bytes_processed, 'B')} ({to_si(self.processed_bytes_per_second * 8, 'bps')}), "
             f"Packets processed: {self.packets_processed} ({to_si(self.processed_packets_per_second, 'packets/s')}), "
             f"Errors (CRC: {self.crc_errors}, Overflow: {self.overflow_errors}, Decode: {self.decode_errors})"
         )
 
+    def to_dict(self):
+        return self.model_dump(exclude={"last_update_timestamp"})
+
+
 class SerialBurstInterface:
     debug_timings = False
     debug_io = False

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/test/test_burst.py

@@ -24,7 +24,7 @@ def test_multi_payload():
     # payload = bytes.fromhex("0A 0F 0A 0B 08 80 80 88 50 12 04 26 00 00 00 10 00")
     for payload in payloads:
         payload = bytes.fromhex(payload.replace(" ", ""))
-        
+
         if len(payload) < 20:
             print(f"Testing payload: {payload.hex()}")
         else:
@@ -38,16 +38,10 @@ def test_multi_payload():
         py_decoded_packet = py_interface.decode(c_payload)
         c_decoded_packet = c_interface.decode(py_payload, fail_on_crc_error=True)
 
-        assert len(c_decoded_packet) == 1, (
-            f"Expected 1 packet, got {len(c_decoded_packet)}"
-        )
-        assert len(py_decoded_packet) == 1, (
-            f"Expected 1 packet, got {len(py_decoded_packet)}"
-        )
+        assert len(c_decoded_packet) == 1, f"Expected 1 packet, got {len(c_decoded_packet)}"
+        assert len(py_decoded_packet) == 1, f"Expected 1 packet, got {len(py_decoded_packet)}"
 
-        assert py_decoded_packet[0] == c_decoded_packet[0], (
-            f"Expected {py_decoded_packet}, got {c_decoded_packet}"
-        )
+        assert py_decoded_packet[0] == c_decoded_packet[0], f"Expected {py_decoded_packet}, got {c_decoded_packet}"
 
 
 if __name__ == "__main__":

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/test/test_burst_decoding.py

@@ -2,10 +2,15 @@ from burst_link_protocol import BurstInterfaceC, BurstInterfacePy
 
 payloads = [
     # Malformed packet
-    ("04 01 ff 0e 06 d3 23 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 03 85 1f 00 0b 02 04 02 07 02 0b 02 04 02 08 02 0b 02 04 02 0c 02 0b 02 02 02 0d 02 0b 02 02 03 aa 94 00 04 02 ff 0e 03 d3 23 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 03 85 1f 00")
+    (
+        "04 01 ff 0e 06 d3 23 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 03 85 1f 00 0b 02 04 02 07 02 0b 02 04 02 08 02 0b 02 04 02 0c 02 0b 02 02 02 0d 02 0b 02 02 03 aa 94 00 04 02 ff 0e 03 d3 23 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 03 85 1f 00"
+    )
     # Good packet
-    ("04 02 ff 0e 03 e1 23 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 03 99 fe 00")
-    ("04 01 ff 0e 06 ef be ad de c1 02 0b 02 01 02 01 02 0b 02 04 02 02 02 0b 02 04 02 03 02 0b 02 04 02 04 02 0b 02 04 02 05 02 0b 02 04 02 06 02 0b 02 04 02 a6 02 0b 02 04 02 07 02 0b 02 04 02 08 02 0b 02 04 02 0c 02 0b 02 02 02 0d 02 0b 02 02 03 aa 94 00")
+    (
+        "04 02 ff 0e 03 e1 23 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 01 03 99 fe 00"
+    )(
+        "04 01 ff 0e 06 ef be ad de c1 02 0b 02 01 02 01 02 0b 02 04 02 02 02 0b 02 04 02 03 02 0b 02 04 02 04 02 0b 02 04 02 05 02 0b 02 04 02 06 02 0b 02 04 02 a6 02 0b 02 04 02 07 02 0b 02 04 02 08 02 0b 02 04 02 0c 02 0b 02 02 02 0d 02 0b 02 02 03 aa 94 00"
+    )
 ]
 
 

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/test/test_c.py

@@ -20,5 +20,6 @@ def test_c_encoding_decoding_fail():
     print(decoded)
     assert packets == decoded, f"Expected {packets}, got {decoded}"
 
+
 if __name__ == "__main__":
     test_c_encoding_decoding()

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/test/test_c_validation.py

@@ -31,9 +31,7 @@ def test_python_crc_validation():
         with pytest.raises(Exception):
             decoded = c_interface.decode(bytes(data_copy), fail_on_crc_error=True)
             print(decoded)
-            assert len(decoded) == len(packets), (
-                f"Expected {len(packets)} packets, got {len(decoded)}"
-            )
+            assert len(decoded) == len(packets), f"Expected {len(packets)} packets, got {len(decoded)}"
 
 
 def test_max_size_error():

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/test/test_python_validation.py

@@ -1,22 +1,23 @@
-
 from burst_link_protocol import BurstInterfacePy
 import pytest
 
+
 def test_python():
-    interface =  BurstInterfacePy()
+    interface = BurstInterfacePy()
     packets = [b"Hello, world!", b"Goodbye, world!"]
 
     data = interface.encode(packets)
     decoded = interface.decode(data)
     assert packets == decoded
 
+
 def test_python_crc_validation():
-    interface =  BurstInterfacePy()
+    interface = BurstInterfacePy()
     packets = [b"Hello, world!", b"Goodbye, world!"]
 
     data = bytearray(interface.encode(packets))
 
-    for i in range( len(data)):
+    for i in range(len(data)):
         data_copy = data.copy()
 
         # modify byte x

{burst_link_protocol-1.1.4 → burst_link_protocol-1.1.5}/test/test_speed.py

@@ -1,20 +1,20 @@
-
-from burst_link_protocol import BurstInterfacePy,BurstInterfaceC
+from burst_link_protocol import BurstInterfacePy, BurstInterfaceC
 import pytest
 import numpy as np
 
-def prepare_packets(packet_size:int) -> bytes:
-    python_interface =  BurstInterfacePy()
-    return python_interface.encode([np.zeros(packet_size).tobytes()])
 
+def prepare_packets(packet_size: int) -> bytes:
+    python_interface = BurstInterfacePy()
+    return python_interface.encode([np.zeros(packet_size).tobytes()])
 
 
 @pytest.mark.parametrize("n", [1, 10, 100, 1000])
 def test_performance_c(benchmark, n):
-    c_interface =  BurstInterfaceC()
+    c_interface = BurstInterfaceC()
     benchmark(c_interface.decode, prepare_packets(n))
 
+
 @pytest.mark.parametrize("n", [1, 10, 100, 1000])
 def test_performance_python(benchmark, n):
-    c_interface =  BurstInterfacePy()
+    c_interface = BurstInterfacePy()
     benchmark(c_interface.decode, prepare_packets(n))