Rework clear_status status to support newer STM32 devices, drop Python 3.7 and 3.8 support (#10)

* Add `_dfuse_download_with_retry` to only clear status on retry
* Update CI workflows to test against Python 3.9, 3.11, and 3.12
* Update minimum required version of Python to 3.9
* Switch from `pkg_resources` to `importlib_metadata` for reading package version

Author: bbrown1867

.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         os: [ ubuntu-latest, macos-latest ]
-        python-version: [ 3.7, 3.8, 3.9 ]
+        python-version: [ 3.9, 3.11, 3.12 ]
     steps:
       - uses: actions/checkout@v2
       - name: Setup Python ${{ matrix.python-version }}

.python-version

@@ -1 +1 @@
-3.7.13
+3.12.2

CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2024-10-21
+
+- Drop support for Python 3.7 and 3.8.
+- Migrate from `pkg_resources` to `importlib_metadata`.
+- Rework `_dfuse_download` slightly: Instead of always clearing the status
+  before starting the download, only do it if a pipe error is detected. In newer
+  STM32 devices, clearing the status seems to make the first download fail.
+
 ## [1.0.2] - 2022-08-15
 
 - Ignore all `USBError` exceptions when exiting DFU mode.

Makefile

@@ -4,8 +4,8 @@ VENV_PYTHON := $(VENV_DIR)/bin/python
 $(VENV_DIR):
 	@echo "Setting up virtual environment and pre-commit hooks..."
 	@python -m venv $@
-	@$(VENV_PYTHON) -m pip install --upgrade --quiet pip -i https://pypi.python.org/simple
-	@$(VENV_PYTHON) -m pip install --upgrade --quiet --editable ".[dev]" -i https://pypi.python.org/simple
+	@$(VENV_PYTHON) -m pip install --upgrade --quiet pip setuptools
+	@$(VENV_PYTHON) -m pip install --upgrade --quiet --editable ".[dev]"
 	@$(VENV_PYTHON) -m pre_commit install --install-hooks
 	@echo "Setup complete."
 

pyfu_usb/__init__.py

@@ -89,9 +89,6 @@ def _dfuse_download(
         xfer_size: Transfer size to use when downloading.
         start_address: Start address of data in device memory.
     """
-    # Clear status, possibly leftover from previous transaction
-    dfu.clear_status(dev, interface)
-
     for segment_num, segment in enumerate(
         descriptor.get_memory_layout(dev, interface)
     ):
@@ -108,7 +105,8 @@ def _dfuse_download(
                 dfuse.page_erase(dev, interface, page_addr)
 
     # Download data
-    with Progress() as progress:
+    progress = Progress()
+    with progress:
         task = _make_progress_bar(progress, len(data))
 
         bytes_downloaded = 0
@@ -141,6 +139,33 @@ def _dfuse_download(
         logger.warning("Ignoring USB error when exiting DFU: %s", err)
 
 
+def _dfuse_download_with_retry(
+    dev: usb.core.Device,
+    interface: int,
+    data: bytes,
+    xfer_size: int,
+    start_address: int,
+) -> None:
+    """Download data to DfuSe device, with a retry to clear any leftover status.
+
+    Args:
+        dev: USB device in DFU mode.
+        interface: USB device interface.
+        data: Binary data to download.
+        xfer_size: Transfer size to use when downloading.
+        start_address: Start address of data in device memory.
+    """
+    try:
+        _dfuse_download(dev, interface, data, xfer_size, start_address)
+    except usb.core.USBError as err:
+        if "pipe error" in str(err).lower():
+            logger.debug("Clearing status before DfuSe download")
+            dfu.clear_status(dev, interface)
+            _dfuse_download(dev, interface, data, xfer_size, start_address)
+        else:
+            raise err
+
+
 def _dfu_download(
     dev: usb.core.Device, interface: int, data: bytes, xfer_size: int
 ) -> None:
@@ -153,7 +178,8 @@ def _dfu_download(
         xfer_size: Transfer size to use when downloading.
     """
     # Download data
-    with Progress() as progress:
+    progress = Progress()
+    with progress:
         task = _make_progress_bar(progress, len(data))
 
         transaction = 0
@@ -270,7 +296,7 @@ def download(
         if dfu_desc.bcdDFUVersion == dfuse.DFUSE_VERSION_NUMBER:
             if address is None:
                 raise ValueError("Must provide address for DfuSe")
-            _dfuse_download(
+            _dfuse_download_with_retry(
                 dev, interface, data, dfu_desc.wTransferSize, address
             )
         else:

pyfu_usb/__main__.py

@@ -5,7 +5,7 @@
 import logging
 import sys
 
-import pkg_resources
+import importlib_metadata
 import usb
 from rich.logging import RichHandler
 
@@ -99,7 +99,7 @@ def cli(args: argparse.Namespace) -> int:
 
     # Get pyfu-usb verion
     if args.version:
-        logger.info(pkg_resources.require("pyfu_usb")[0].version)
+        logger.info(importlib_metadata.version("pyfu_usb"))
         return 0
 
     # Parse VID/PID if provided

pyproject.toml

@@ -6,7 +6,7 @@ strict = true
 ignore_missing_imports = true
 
 [tool.pylint.MASTER]
-disable = "W0511"
+disable = "W0511,R0917,C0209"
 
 [tool.pylint.FORMAT]
 max-line-length = 80

setup.py

@@ -18,17 +18,18 @@ def long_description():
     name="pyfu-usb",
     author="Block, Inc.",
     license="MIT",
-    version="1.0.2",
+    version="2.0.0",
     description="Python USB firmware update library.",
     long_description=long_description(),
     long_description_content_type="text/markdown",
     url="https://github.com/square/pyfu-usb",
     packages=setuptools.find_packages(),
-    python_requires=">=3.7",
+    python_requires=">=3.9",
     package_data={
         "pyfu_usb": ["py.typed"],
     },
     install_requires=[
+        "importlib-metadata",
         "pyusb>=1.0.2",
         "rich>=12.2",
     ],
@@ -37,7 +38,7 @@ def long_description():
             "black~=22.3.0",
             "mypy==0.942",
             "types-setuptools~=57.4.14",
-            "pylint~=2.7.0",
+            "pylint~=3.3.1",
             "pre-commit~=2.18.1",
             "wheel~=0.37.1",
             "twine~=4.0.0",