smpclient 4.3.0__tar.gz → 4.4.2__tar.gz

{smpclient-4.3.0 → smpclient-4.4.2}/PKG-INFO

@@ -1,18 +1,19 @@
 Metadata-Version: 2.1
 Name: smpclient
-Version: 4.3.0
+Version: 4.4.2
 Summary: Simple Management Protocol (SMP) Client for remotely managing MCU firmware
 Home-page: https://github.com/intercreate/smpclient
 License: Apache-2.0
 Author: J.P. Hutchins
 Author-email: jphutchins@gmail.com
-Requires-Python: >=3.8.1,<3.13
+Requires-Python: >=3.8.1,<3.14
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: async-timeout (>=4.0.3,<5.0.0) ; python_version < "3.11"
 Requires-Dist: bleak (>=0.22.1,<0.23.0)
 Requires-Dist: intelhex (>=2.3.0,<3.0.0)
@@ -73,7 +74,7 @@ An online version is generated and available [here](https://intercreate.github.i
 
 ### Install Dependencies
 
-- poetry: https://python-poetry.org/docs/#installation
+- poetry==1.8.5: https://python-poetry.org/docs/#installation
 
 ### Create the venv
 

{smpclient-4.3.0 → smpclient-4.4.2}/README.md

@@ -49,7 +49,7 @@ An online version is generated and available [here](https://intercreate.github.i
 
 ### Install Dependencies
 
-- poetry: https://python-poetry.org/docs/#installation
+- poetry==1.8.5: https://python-poetry.org/docs/#installation
 
 ### Create the venv
 

{smpclient-4.3.0 → smpclient-4.4.2}/pyproject.toml

@@ -19,7 +19,7 @@ mcuimg = "smpclient.mcuboot:mcuimg"
 source = "git-tag"
 
 [tool.poetry.dependencies]
-python = ">=3.8.1, <3.13"
+python = ">=3.8.1, <3.14"
 pyserial = "^3.5"
 smp = "^3.1.1"
 intelhex = "^2.3.0"
@@ -45,6 +45,7 @@ mike = "^2.1.3"
 mkdocs-material = "^9.5.38"
 griffe-inherited-docstrings = "^1.0.1"
 griffe = "^1.3.1"
+smp = "^3.1.1"
 
 [tool.black]
 line-length = 100
@@ -82,6 +83,7 @@ legacy_tox_ini = """
         py310
         py311
         py312
+        py313
 
     [testenv]
     allowlist_externals =

{smpclient-4.3.0 → smpclient-4.4.2}/smpclient/__init__.py

@@ -29,11 +29,12 @@ import asyncio
 import logging
 from hashlib import sha256
 from types import TracebackType
-from typing import AsyncIterator, Final, NoReturn, Tuple, Type
+from typing import AsyncIterator, Final, Tuple, Type
 
 from pydantic import ValidationError
 from smp import header as smpheader
 from smp import message as smpmsg
+from typing_extensions import assert_never
 
 from smpclient.exceptions import SMPBadSequence, SMPUploadError
 from smpclient.generics import SMPRequest, TEr1, TEr2, TRep, error, success
@@ -130,9 +131,11 @@ class SMPClient:
             print(f"Response: {response=}")
         elif error(response):
             print(f"Error: {response=}")
+        else:
+            assert_never(response)
         ```
 
-        Type Safety with Generic Typing:
+        Type Safety and Exhaustiveness with Generic Typing:
 
         ```python
         response = await client.request(EchoWrite(d="Hello, World!"))
@@ -147,9 +150,13 @@ class SMPClient:
             if error_v1(response):
                 reveal_type(response)
                 # Revealed type is 'EchoWriteErrorV1'
-            else:
+            elif error_v2(response):
                 reveal_type(response)
                 # Revealed type is 'EchoWriteErrorV2'
+            else:
+                assert_never(response)
+        else:
+            assert_never(response)
         ```
 
         """
@@ -244,8 +251,8 @@ class SMPClient:
             if response.off is None:
                 raise SMPUploadError(f"No offset received: {response=}")
             yield response.off
-        else:  # pragma: no cover
-            _unreachable()
+        else:
+            assert_never(response)  # pragma: no cover
 
         # send chunks until the SMP server reports that the offset is at the end of the image
         while response.off != len(image):
@@ -268,8 +275,8 @@ class SMPClient:
                 if response.off is None:
                     raise SMPUploadError(f"No offset received: {response=}")
                 yield response.off
-            else:  # pragma: no cover
-                _unreachable()
+            else:
+                assert_never(response)  # pragma: no cover
 
         logger.info("Upload complete")
 
@@ -313,8 +320,8 @@ class SMPClient:
             if response.off is None:
                 raise SMPUploadError(f"No offset received: {response=}")
             yield response.off
-        else:  # pragma: no cover
-            _unreachable()
+        else:
+            assert_never(response)  # pragma: no cover
 
         # send chunks until the SMP server reports that the offset is at the end of the image
         while response.off != len(file_data):
@@ -328,8 +335,8 @@ class SMPClient:
                 raise SMPUploadError(response)
             elif success(response):
                 yield response.off
-            else:  # pragma: no cover
-                _unreachable()
+            else:
+                assert_never(response)  # pragma: no cover
 
         logger.info("Upload complete")
 
@@ -359,8 +366,8 @@ class SMPClient:
             if response.len is None:
                 raise SMPUploadError(f"No length received: {response=}")
             file_length = response.len
-        else:  # pragma: no cover
-            _unreachable()
+        else:
+            assert_never(response)  # pragma: no cover
 
         file_data = response.data
 
@@ -374,8 +381,8 @@ class SMPClient:
                 raise SMPUploadError(response)
             elif success(response):
                 file_data += response.data
-            else:  # pragma: no cover
-                _unreachable()
+            else:
+                assert_never(response)  # pragma: no cover
 
         logger.info("Download complete")
         return file_data
@@ -407,7 +414,7 @@ class SMPClient:
         # If the integer is less than 24, then the size is encoded in the same
         # byte as the value.
         # https://datatracker.ietf.org/doc/html/rfc8949#name-core-deterministic-encoding
-        return 0 if integer < 24 else 1 if integer < 0xFF else 2 if integer < 0xFFFF else 4
+        return 0 if integer < 24 else 1 if integer <= 0xFF else 2 if integer <= 0xFFFF else 4
 
     def _get_max_cbor_and_data_size(self, request: smpmsg.WriteRequest) -> Tuple[int, int]:
         """Given an `ImageUploadWrite`, return the maximum CBOR size and data size."""
@@ -494,10 +501,6 @@ class SMPClient:
                 elif error(mcumgr_parameters):
                     logger.warning(f"Error reading MCUMgr parameters: {mcumgr_parameters}")
                 else:
-                    _unreachable()
+                    assert_never(mcumgr_parameters)
         except asyncio.TimeoutError:
             logger.warning("Timeout waiting for MCUMgr parameters")
-
-
-def _unreachable() -> NoReturn:
-    raise Exception("Unreachable")

{smpclient-4.3.0 → smpclient-4.4.2}/smpclient/generics.py

@@ -1,4 +1,4 @@
-"""Generics and TypeGuards for SMP Requests and Responses."""
+"""Generics and Type Narrowing for SMP Requests and Responses."""
 
 from __future__ import annotations
 
@@ -7,7 +7,7 @@ from typing import Protocol, Type, TypeVar, Union
 from smp import error as smperror
 from smp import header as smphdr
 from smp import message as smpmessage
-from typing_extensions import TypeGuard
+from typing_extensions import TypeIs
 
 TEr1 = TypeVar("TEr1", bound=smperror.ErrorV1)
 """Type of SMP Error V1."""
@@ -47,8 +47,8 @@ class SMPRequest(Protocol[TRep, TEr1, TEr2]):
         ...
 
 
-def error_v1(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.ErrorV1]:
-    """`TypeGuard` that returns `True` if the `response` is an `ErrorV1`.
+def error_v1(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeIs[smperror.ErrorV1]:
+    """`TypeIs` that returns `True` if the `response` is an `ErrorV1`.
 
     Args:
         response: The response to check.
@@ -59,8 +59,8 @@ def error_v1(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.Err
     return response.RESPONSE_TYPE == smpmessage.ResponseType.ERROR_V1
 
 
-def error_v2(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[TEr2]:
-    """`TypeGuard` that returns `True` if the `response` is an `ErrorV2`.
+def error_v2(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeIs[TEr2]:
+    """`TypeIs` that returns `True` if the `response` is an `ErrorV2`.
 
     Args:
         response: The response to check.
@@ -71,8 +71,8 @@ def error_v2(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[TEr2]:
     return response.RESPONSE_TYPE == smpmessage.ResponseType.ERROR_V2
 
 
-def error(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.ErrorV1 | TEr2]:
-    """`TypeGuard` that returns `True` if the `response` is an `ErrorV1` or `ErrorV2`.
+def error(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeIs[smperror.ErrorV1 | TEr2]:
+    """`TypeIs` that returns `True` if the `response` is an `ErrorV1` or `ErrorV2`.
 
     Args:
         response: The response to check.
@@ -83,8 +83,8 @@ def error(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[smperror.ErrorV
     return error_v1(response) or error_v2(response)
 
 
-def success(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeGuard[TRep]:
-    """`TypeGuard` that returns `True` if the `response` is a successful `Response`.
+def success(response: smperror.ErrorV1 | TEr2 | TRep) -> TypeIs[TRep]:
+    """`TypeIs` that returns `True` if the `response` is a successful `Response`.
 
     Args:
         response: The response to check.

{smpclient-4.3.0 → smpclient-4.4.2}/smpclient/mcuboot.py

@@ -1,4 +1,4 @@
-"""Tools for inspecting firmware images.
+"""Tools for inspecting MCUBoot compatible firmware images.
 
 Specification: https://docs.mcuboot.com/design.html
 """
@@ -101,6 +101,7 @@ class ImageVersion:
 
     @staticmethod
     def loads(data: bytes) -> 'ImageVersion':
+        """Load an `ImageVersion` from `bytes`."""
         return ImageVersion(*IMAGE_VERSION_STRUCT.unpack(data))
 
     def __str__(self) -> str:
@@ -148,10 +149,12 @@ class ImageHeader:
 
     @staticmethod
     def load_from(file: BytesIO | BufferedReader) -> 'ImageHeader':
+        """Load an `ImageHeader` from an open file."""
         return ImageHeader.loads(file.read(IMAGE_HEADER_STRUCT.size))
 
     @staticmethod
     def load_file(path: str) -> 'ImageHeader':
+        """Load an `ImageHeader` the file at `path`."""
         with open(path, 'rb') as f:
             return ImageHeader.load_from(f)
 
@@ -178,6 +181,7 @@ class ImageTLVInfo:
 
     @staticmethod
     def load_from(file: BytesIO | BufferedReader) -> 'ImageTLVInfo':
+        """Load an `ImageTLVInfo` from a file."""
         return ImageTLVInfo.loads(file.read(IMAGE_TLV_INFO_STRUCT.size))
 
 
@@ -191,6 +195,7 @@ class ImageTLV:
 
     @staticmethod
     def load_from(file: BytesIO | BufferedReader) -> 'ImageTLV':
+        """Load an `ImageTLV` from a file."""
         return ImageTLV(*IMAGE_TLV_STRUCT.unpack_from(file.read(IMAGE_TLV_STRUCT.size)))
 
 
@@ -225,6 +230,7 @@ class ImageInfo:
 
     @staticmethod
     def load_file(path: str) -> 'ImageInfo':
+        """Load MCUBoot `ImageInfo` from the .bin or .hex file at `path`."""
         file_path = pathlib.Path(path)
         if file_path.suffix not in {".bin", ".hex"}:
             raise MCUBootImageError(
@@ -279,7 +285,7 @@ def mcuimg() -> int:
         prog="mcuimg",
         description=(
             "Inspect an MCUBoot compatible firmware update image."
-            "\nCopyright (C) 2023 Intercreate, Inc. | github.com/intercreate/smpclient"
+            "\nCopyright (C) 2023-2024 Intercreate, Inc. | github.com/intercreate/smpclient"
         ),
         formatter_class=argparse.RawDescriptionHelpFormatter,
     )

{smpclient-4.3.0 → smpclient-4.4.2}/smpclient/transport/udp.py

@@ -99,4 +99,9 @@ class SMPUDPTransport(SMPTransport):
     @override
     @property
     def mtu(self) -> int:
-        return self._smp_server_transport_buffer_size or self._mtu
+        return self._mtu
+
+    @override
+    @property
+    def max_unencoded_size(self) -> int:
+        return self._mtu