Minor refactor pyproject.toml and typing fixes.

Update uv.lock to match pyproject.toml changes.

Updates to improve function type returns:
- tests/conftest.py
- tests/test_firmware.py
- typings/esptool/__init__.pyi

Author: glenn20

pyproject.toml

@@ -9,37 +9,45 @@ classifiers = [
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Topic :: Software Development :: Embedded Systems",
+    "Topic :: Software Development :: Libraries",
+    "Typing :: Typed",
 ]
 requires-python = ">=3.8"
+dynamic = ["version"]
 dependencies = [
     "esptool>=4.6.2",
     "rich>=10.12.0",
     "more-itertools>=8.8.0",
     "typing-extensions>=4.12",
 ]
-dynamic = ["version"]
+optional-dependencies.littlefs = [
+    "littlefs-python>=0.12.0",
+]
 
 [project.scripts]  # The entry points for the command line tools
 mp-image-tool-esp32 = "mp_image_tool_esp32.main:main"
 
-[project.optional-dependencies]
-littlefs = ["littlefs-python>=0.12.0"]
-
 [dependency-groups]
-typing = ["mypy>=0.910", "types-requests>=2.32.0.20240914", "types-pyserial>=3.5"]
+typing = [
+    "mypy>=0.910", "types-requests>=2.32", "types-pyserial>=3.5", "types-pyyaml>=6.0"
+]
 test = [
     {include-group = "typing"},
-    "ruff>=0.6.7", "pytest>=8.3.2", "pytest-cov>=3.0.0", "requests>=2.32.3",
-    "pyyaml>=6.0.2", "tox>=4.22.0", "tox-uv>=0.3.0",
+    "ruff>=0.6.7", "pytest>=8.3.2", "pytest-cov>=3.0.0", "pytest-sugar>=1.0.0",
+    "requests>=2.32.3", "pyyaml>=6.0.2", "tox>=4.22.0", "tox-uv>=1.13",
 ]
 dev = [
     {include-group = "test"},
-    "keyring>=25",  # For uv publish --keyring-provider=subprocess
-    # Used by .git/hooks/post-{commit,checkout} to update _version.py:
-    #   uv run --frozen hatch build --hooks-only
-    "hatch>=1.12.0",
-    "hatch-vcs>=0.3.0",  # For building and updating _version.py
+    # For building and updating _version.py
+    "hatch>=1.12.0", "hatch-vcs>=0.3.0", "pip>=25.0.1",
 ]
 
 [build-system]
@@ -48,9 +56,8 @@ build-backend = "hatchling.build"
 
 # Build python packages and update version number
 [tool.hatch]
-build.targets.wheel.packages = ["src/mp_image_tool_esp32"]
-version.source = "vcs"  # Get the version from git, eg: 0.0.6.dev0+g1234567
 build.hooks.vcs.version-file = "src/mp_image_tool_esp32/_version.py"
+version.source = "vcs"  # Get the version from git, eg: 0.0.6.dev0+g1234567
 # Drop the local version part (eg: +g1234567) or pypi will reject package
 version.raw-options.local_scheme = "no-local-version"
 # A manually triggered github release workflow may generate a new tag
@@ -64,40 +71,40 @@ version.raw-options.git_describe_command = [
     "--match", "v*.[0-9][0-9][0-9]",
 ]
 
-# https://tox.wiki/en/latest/config.html#pyproject-toml-native
-[tool.tox]
-requires = ["tox>=4.22", "tox-uv>=1.13"]
-env_list = [
-    "clean", "typing", "lint", "format",
-    "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"
-]
-env.clean.commands = [["coverage", "erase"]]  # Cleanup coverage data
-env.clean.skip_install = true
-env.typing.commands = [["mypy"]]
-env.lint.commands = [["ruff", "check"]]
-env.format.commands = [["ruff", "format", "--check"]]
-env.3.8.commands = [["pytest", "--cov=mp_image_tool_esp32"]]
-env.3.13.commands = [["pytest", "--cov=mp_image_tool_esp32"]]
-env_run_base.commands = [["pytest"]]
-env_run_base.dependency_groups = ["test"]
-env_run_base.extras = ["littlefs"]  # Include optional dependencies
-env_run_base.package = "wheel"  # Build package wheel and install into environments
-env_run_base.wheel_build_env = ".pkg"  # Re-use one wheel for each environment
-
 [tool.mypy]
-files = ["src"]
+files = ["src", "tests"]
 python_version = "3.9"
+mypy_path = "typings"
 disallow_untyped_defs = true
 warn_return_any = true
 warn_unused_ignores = true
-mypy_path = "typings"
 
 [tool.ruff]
-include = ["src/**/*.py"]
-exclude = ["_version.py"]
+exclude = ["_version.py", "tests/data"]
 lint.extend-select = ["I"]  # Enable ruffs isort rules (for compat with vscode ruff)
 
 [tool.coverage]
+run.source = ["src", "tests"]
 run.omit = ["_version.py"]
 report.skip_covered = true
 append = true
+
+# https://tox.wiki/en/latest/config.html#pyproject-toml-native
+[tool.tox]
+env_list = [
+    "clean", "typing", "lint", "format",
+    "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"
+]
+labels.static = ["clean", "typing", "lint", "format"]
+env.clean.commands = [["coverage", "erase"]]  # Cleanup coverage data
+env.clean.skip_install = true
+env.typing.commands = [["mypy"]]
+env.lint.commands = [["ruff", "check"]]
+env.format.commands = [["ruff", "format", "--check"]]
+env_run_base.commands = [["pytest", {replace = "posargs", extend = true}]]
+env_run_base.dependency_groups = ["test"]
+env_run_base.extras = ["littlefs"]  # Include optional dependencies
+env_run_base.package = "editable"  # Build package wheel and install into environments
+env_run_base.runner = "uv-venv-runner"  # We love uv
+env.3.13.commands = [["pytest", "--cov", {replace = "posargs", extend = true}]]
+env.3.13.labels = ["coverage", "latest"]

src/mp_image_tool_esp32/logger.py

@@ -47,7 +47,7 @@ def render_message(
     console=console,
     highlighter=NullHighlighter(),
     markup=True,
-    show_time=False,  # Don't show the timem level or path in log messages
+    show_time=False,  # Don't show the time, level or path in log messages
     show_level=False,
     show_path=False,
     rich_tracebacks=True,

tests/conftest.py

@@ -75,7 +75,7 @@ class Options(Namespace):
 options: Options = Options()
 
 
-def pytest_addoption(parser: Namespace):
+def pytest_addoption(parser: Namespace) -> None:
     parser.addoption(
         "--port",
         dest="port",
@@ -88,7 +88,7 @@ def pytest_addoption(parser: Namespace):
         dest="firmware",
         action="store",
         default="",
-        help="Nmae of the firmware file to use",
+        help="Name of the firmware file to use",
     )
     parser.addoption(
         "--args",
@@ -106,7 +106,7 @@ def pytest_addoption(parser: Namespace):
     )
 
 
-def download_firmware_files():
+def download_firmware_files() -> None:
     """Download the firmware files if they are not present in 'datadir'."""
     if not datadir.exists():
         datadir.mkdir()
@@ -120,7 +120,7 @@ def download_firmware_files():
 
 
 ## pytest_configure is called after command line options have been parsed
-def pytest_configure(config: Config):
+def pytest_configure(config: Config) -> None:
     global options
     global firmware_file
     download_firmware_files()  # Download firmware files if needed
@@ -140,7 +140,7 @@ def pytest_configure(config: Config):
 def my_setup(
     capsys: pytest.CaptureFixture[str],
     caplog: pytest.LogCaptureFixture,
-):
+) -> None:
     global capsys_, caplog_
     capsys_ = capsys
     caplog_ = caplog
@@ -207,7 +207,7 @@ def testdir(tmp_path_factory: Any) -> Path:
     """A fixture to create a temporary directory for testing (session scope).
     Will set the current working directory to the temporary directory
     and return the directory as a Path object."""
-    path: Path = tmp_path_factory.mktemp("test_dir")  # type: ignore
+    path: Path = tmp_path_factory.mktemp("test_dir")
     assert isinstance(path, Path)
     os.chdir(path)
     return path

tests/test_firmware.py

@@ -26,39 +26,31 @@ def mpi_check_output(firmware: Path, args: str) -> None:
     assert_output(OUTPUTS[args], output)
 
 
-# Unnecessary if running mp_image_tool_esp32 as a module rather than a script
-# def test_python_version(firmware: Path):
-#     mpi_run(firmware)
-#     match = re.search(r"Running pytest .*Python ([0-9.]+)", log_messages())
-#     assert match is not None
-#     assert match.group(1) == platform.python_version()
-
-
-def test_firmware_file_valid(firmware: Path):
+def test_firmware_file_valid(firmware: Path) -> None:
     mpi_check(firmware, "")
 
 
-def test_table_ota(firmware: Path):
+def test_table_ota(firmware: Path) -> None:
     mpi_check_output(firmware, "--table ota --app-size 0x1f0B")
 
 
-def test_table_default(firmware: Path):
+def test_table_default(firmware: Path) -> None:
     mpi_check_output(firmware, "--table default")
 
 
-def test_table_custom(firmware: Path):
+def test_table_custom(firmware: Path) -> None:
     mpi_check_output(firmware, "--table nvs=7B,factory=2M,vfs=1M,vfs2=fat:0")
 
 
-def test_delete(firmware: Path):
+def test_delete(firmware: Path) -> None:
     mpi_check_output(firmware, "--delete phy_init")
 
 
-def test_resize(firmware: Path):
+def test_resize(firmware: Path) -> None:
     mpi_check_output(firmware, "--resize vfs=1M")
 
 
-def test_add(firmware: Path):
+def test_add(firmware: Path) -> None:
     mpi_check_output(firmware, "--resize vfs=1M --add data=fat:50B")
 
 
@@ -71,19 +63,19 @@ def mpi_check_output_flash_size(firmware: Path, args: str) -> bool:
     return True
 
 
-def test_flash_size(firmware: Path):
+def test_flash_size(firmware: Path) -> None:
     if not mpi_check_output_flash_size(firmware, "--flash-size 8M"):
         pytest.skip("Skipping test_flash_size because device flash size is too small")
 
 
-def test_flash_size_vfs(firmware: Path):
+def test_flash_size_vfs(firmware: Path) -> None:
     if not mpi_check_output_flash_size(firmware, "--flash-size 8M --resize vfs=0"):
         pytest.skip(
             "Skipping test_flash_size_vfs because device flash size is too small"
         )
 
 
-def test_read(firmware: Path, bootloader: bytes):
+def test_read(firmware: Path, bootloader: bytes) -> None:
     out = Path("out.bin")
     mpi_run(firmware, f"--read bootloader={out.name}")
     output = out.read_bytes()
@@ -95,20 +87,20 @@ def test_read(firmware: Path, bootloader: bytes):
     assert output == bootloader
 
 
-def test_write(firmware: Path):
+def test_write(firmware: Path) -> None:
     input = bytes(range(32)) * 8  # 256 data bytes to write
     infile, outfile = Path("input.bin"), Path("out2.bin")
     infile.write_bytes(bytes(range(32)) * 8)
     mpi_run(firmware, f"--write phy_init={infile}")
     mpi_run(firmware, f"--read phy_init={outfile}")
     output = outfile.read_bytes()
     assert len(output) == 4096
-    output = output.rstrip(b"\xFF")
+    output = output.rstrip(b"\xff")
     assert len(output) == len(input)
     assert output == input
 
 
-def test_erase(firmware: Path):
+def test_erase(firmware: Path) -> None:
     Path("input.bin").write_bytes(bytes(range(32)) * 8)
     mpi_run(firmware, "--write phy_init=input.bin")
     mpi_run(firmware, "--read phy_init=output1.bin")
@@ -117,20 +109,20 @@ def test_erase(firmware: Path):
     input = Path("input.bin").read_bytes()
     output1 = Path("output1.bin").read_bytes()
     output2 = Path("output2.bin").read_bytes()
-    assert output1.rstrip(b"\xFF") == input
+    assert output1.rstrip(b"\xff") == input
     assert len(output2) == 4096
     assert output2.count(0xFF) == len(output2)
 
 
-def test_extract_app(firmware: Path, app_image: bytes):
+def test_extract_app(firmware: Path, app_image: bytes) -> None:
     app = Path("app.bin")
     mpi_run(firmware, "--extract-app", output=app)
     output = app.read_bytes()
     assert len(output) == len(app_image)
     assert output == app_image
 
 
-def test_check_app(firmware: Path, app_image: bytes, bootloader: bytes):
+def test_check_app(firmware: Path, app_image: bytes, bootloader: bytes) -> None:
     mpi_run(firmware, "--check-app")
     output = log_messages()
     for line in (
@@ -142,7 +134,7 @@ def test_check_app(firmware: Path, app_image: bytes, bootloader: bytes):
         assert line in output
 
 
-def test_file_integrity(firmware: Path):
+def test_file_integrity(firmware: Path) -> None:
     if options.port:
         pytest.skip("Skipping test_file_integrity because --port is set")
     sha1 = hashlib.sha256(firmware.read_bytes()).hexdigest()
@@ -154,7 +146,7 @@ def test_file_integrity(firmware: Path):
     assert sha1 == sha3
 
 
-def test_read_write(firmware: Path):
+def test_read_write(firmware: Path) -> None:
     if options.port:
         pytest.skip("Skipping test_read_write because --port is set")
     sha1 = hashlib.sha256(firmware.read_bytes()).hexdigest()

typings/esptool/__init__.pyi

@@ -2,10 +2,8 @@ from typing import Callable, Sequence
 
 import serial
 
-
 class StubFlasher: ...
 
-
 class ESPLoader:
     CHIP_NAME: str
     _port: serial.Serial
@@ -20,5 +18,4 @@ class ESPLoader:
     def run_stub(self, stub: StubFlasher | None = None) -> "ESPLoader": ...
     def hard_reset(self) -> None: ...
 
-
 def main(argv: Sequence[str], esp: ESPLoader | None) -> None: ...