esptool 5.1.dev1__tar.gz → 5.2.0__tar.gz

{esptool-5.1.dev1/esptool.egg-info → esptool-5.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: esptool
-Version: 5.1.dev1
+Version: 5.2.0
 Summary: A serial utility for flashing, provisioning, and interacting with Espressif SoCs.
 Author: Fredrik Ahlberg (themadinventor), Angus Gratton (projectgus), Espressif Systems
 License: GPLv2+
@@ -22,6 +22,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -31,7 +32,7 @@ Requires-Dist: pyserial>=3.3
 Requires-Dist: reedsolo<1.8,>=1.5.3
 Requires-Dist: PyYAML>=5.1
 Requires-Dist: intelhex
-Requires-Dist: rich_click
+Requires-Dist: rich_click<2
 Requires-Dist: click<9
 Provides-Extra: dev
 Requires-Dist: pyelftools; extra == "dev"
@@ -44,7 +45,7 @@ Requires-Dist: czespressif; extra == "dev"
 Provides-Extra: hsm
 Requires-Dist: python-pkcs11; extra == "hsm"
 Provides-Extra: docs
-Requires-Dist: esp-docs~=1.10; extra == "docs"
+Requires-Dist: esp-docs~=2.1; extra == "docs"
 Requires-Dist: sphinx-tabs; extra == "docs"
 Dynamic: license-file
 
@@ -53,6 +54,7 @@ Dynamic: license-file
 A Python-based, open-source, platform-independent serial utility for flashing, provisioning, and interacting with Espressif SoCs.
 
 [![Test esptool](https://github.com/espressif/esptool/actions/workflows/test_esptool.yml/badge.svg?branch=master)](https://github.com/espressif/esptool/actions/workflows/test_esptool.yml) [![Build esptool](https://github.com/espressif/esptool/actions/workflows/build_esptool.yml/badge.svg?branch=master)](https://github.com/espressif/esptool/actions/workflows/build_esptool.yml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/espressif/esptool/master.svg)](https://results.pre-commit.ci/latest/github/espressif/esptool/master)
 
 ## Documentation
 

{esptool-5.1.dev1 → esptool-5.2.0}/README.md

@@ -3,6 +3,7 @@
 A Python-based, open-source, platform-independent serial utility for flashing, provisioning, and interacting with Espressif SoCs.
 
 [![Test esptool](https://github.com/espressif/esptool/actions/workflows/test_esptool.yml/badge.svg?branch=master)](https://github.com/espressif/esptool/actions/workflows/test_esptool.yml) [![Build esptool](https://github.com/espressif/esptool/actions/workflows/build_esptool.yml/badge.svg?branch=master)](https://github.com/espressif/esptool/actions/workflows/build_esptool.yml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/espressif/esptool/master.svg)](https://results.pre-commit.ci/latest/github/espressif/esptool/master)
 
 ## Documentation
 

{esptool-5.1.dev1 → esptool-5.2.0}/esp_rfc2217_server/__init__.py

@@ -134,7 +134,7 @@ def main():
         except KeyboardInterrupt:
             print(flush=True)
             break
-        except socket.error as msg:
+        except OSError as msg:
             logging.error(str(msg))
 
     logging.info("--- exit ---")

{esptool-5.1.dev1 → esptool-5.2.0}/esp_rfc2217_server/esp_port_manager.py

@@ -38,7 +38,7 @@ class EspPortManager(serial.rfc2217.PortManager):
     def __init__(self, serial_port, connection, esp32r0_delay, logger=None):
         self.esp32r0_delay = esp32r0_delay
         self.is_download_mode = False
-        super(EspPortManager, self).__init__(serial_port, connection, logger)
+        super().__init__(serial_port, connection, logger)
 
     def _telnet_process_subnegotiation(self, suboption):
         if suboption[0:1] == COM_PORT_OPTION and suboption[1:2] == SET_CONTROL:
@@ -66,7 +66,7 @@ class EspPortManager(serial.rfc2217.PortManager):
             ]:
                 return
         # only in cases not handled above do the original implementation in PortManager
-        super(EspPortManager, self)._telnet_process_subnegotiation(suboption)
+        super()._telnet_process_subnegotiation(suboption)
 
     def _hard_reset_thread(self):
         """

{esptool-5.1.dev1 → esptool-5.2.0}/esp_rfc2217_server/redirector.py

@@ -5,12 +5,11 @@
 import threading
 import time
 import logging
-import socket
 
 from esp_rfc2217_server.esp_port_manager import EspPortManager
 
 
-class Redirector(object):
+class Redirector:
     def __init__(self, serial_instance, socket, debug=False, esp32r0delay=False):
         self.serial = serial_instance
         self.socket = socket
@@ -54,7 +53,7 @@ class Redirector(object):
                 if data:
                     # escape outgoing data when needed (Telnet IAC (0xff) character)
                     self.write(b"".join(self.rfc2217.escape(data)))
-            except socket.error as msg:
+            except OSError as msg:
                 self.log.error("{}".format(msg))
                 # probably got disconnected
                 break
@@ -74,7 +73,7 @@ class Redirector(object):
                 if not data:
                     break
                 self.serial.write(b"".join(self.rfc2217.filter(data)))
-            except socket.error as msg:
+            except OSError as msg:
                 self.log.error("{}".format(msg))
                 # probably got disconnected
                 break

{esptool-5.1.dev1 → esptool-5.2.0}/espefuse/__init__.py

@@ -7,7 +7,7 @@ import sys
 import rich_click as click
 
 import esptool
-from esptool.cli_util import ChipType, ResetModeType
+from esptool.cli_util import BaudRateType, ChipType, ResetModeType, SerialPortType
 from esptool.logger import log
 
 from espefuse.cli_util import Group
@@ -53,7 +53,7 @@ __all__ = [
 @click.option(
     "--baud",
     "-b",
-    type=int,
+    type=BaudRateType(),
     default=esptool.ESPLoader.ESP_ROM_BAUD,
     envvar="ESPTOOL_BAUD",
     help="Serial port baud rate used when flashing/reading.",
@@ -62,7 +62,7 @@ __all__ = [
     "--port",
     "-p",
     envvar="ESPTOOL_PORT",
-    type=click.Path(),
+    type=SerialPortType(),
     help="Serial port device.",
 )
 @click.option(
@@ -93,9 +93,10 @@ __all__ = [
     "Use with caution!",
 )
 @click.option(
-    "--postpone",
-    is_flag=True,
-    help="Postpone burning some eFuses from BLOCK0 at the end.",
+    "--postpone/--no-postpone",
+    default=True,
+    help="Postpone burning some eFuses from BLOCK0 at the end "
+    "(enabled by default, can be disabled with --no-postpone).",
 )
 @click.option(
     "--extend-efuse-table",

{esptool-5.1.dev1 → esptool-5.2.0}/espefuse/cli_util.py

@@ -220,7 +220,7 @@ class Group(EsptoolGroup):
             commands = init_commands(port=None, chip=ctx.obj["chip"], skip_connect=True)
             commands.add_cli_commands(self)
         elif len(used_cmds) == 0:
-            self.get_help(ctx)
+            log.print(self.get_help(ctx))
             ctx.exit()
 
         cmd_groups = self.repeat_read_commands(used_cmds, cmd_groups)

{esptool-5.1.dev1 → esptool-5.2.0}/espefuse/efuse/base_fields.py

@@ -17,7 +17,7 @@ from esptool.logger import log
 from . import util
 
 
-class CheckArgValue(object):
+class CheckArgValue:
     def __init__(self, efuses, name):
         self.efuses = efuses
         self.name = name
@@ -85,10 +85,10 @@ class CheckArgValue(object):
         return check_arg_value(efuse, new_value)
 
 
-class EfuseProtectBase(object):
+class EfuseProtectBase:
     # This class is used by EfuseBlockBase and EfuseFieldBase
     read_disable_bit: int | list[int] | None
-    write_disable_bit: int | list[int] | None
+    write_disable_bit: int | None
     parent: "EspEfusesBase"
     name: str
 
@@ -182,7 +182,7 @@ class EfuseBlockBase(EfuseProtectBase):
         self.rd_addr: int = param.rd_addr
         self.wr_addr: int = param.wr_addr
         self.write_disable_bit: int | None = param.write_disable_bit
-        self.read_disable_bit: int | None = param.read_disable_bit
+        self.read_disable_bit: int | list[int] | None = param.read_disable_bit
         self.len: int = param.len
         self.key_purpose_name: str | None = param.key_purpose
         bit_block_len: int = self.get_block_len() * 8
@@ -214,9 +214,7 @@ class EfuseBlockBase(EfuseProtectBase):
         elif coding_scheme == self.parent.REGS.CODING_SCHEME_RS:
             return self.len * 4
         else:
-            raise esptool.FatalError(
-                "Coding scheme (%d) not supported" % (coding_scheme)
-            )
+            raise esptool.FatalError(f"Coding scheme ({coding_scheme}) not supported")
 
     def get_coding_scheme(self):
         if self.id == 0:
@@ -255,7 +253,7 @@ class EfuseBlockBase(EfuseProtectBase):
         words = self.get_words()
         data = BitArray()
         for word in reversed(words):
-            data.append("uint:32=%d" % word)
+            data.append(f"uint:32={word}")
         self.bitarray.overwrite(data, pos=0)
         if print_info:
             self.print_block(self.bitarray, "read_regs")
@@ -264,13 +262,13 @@ class EfuseBlockBase(EfuseProtectBase):
         if self.parent.debug or debug:
             bit_string.pos = 0
             log.print(
-                "%-15s (%-16s) [%-2d] %s:"
-                % (self.name, " ".join(self.alias)[:16], self.id, comment),
+                f"{self.name:<15s} ({' '.join(self.alias)[:16]:<16s}) "
+                f"[{self.id:<2d}] {comment}:",
                 " ".join(
                     [
-                        "%08x" % word
+                        f"{word:08x}"
                         for word in bit_string.readlist(
-                            "%d*uint:32" % (bit_string.len / 32)
+                            f"{int(bit_string.len / 32)}*uint:32"
                         )[::-1]
                     ]
                 ),
@@ -285,8 +283,8 @@ class EfuseBlockBase(EfuseProtectBase):
             return False
         if len(wr_data.bytes) != len(self.bitarray.bytes):
             raise esptool.FatalError(
-                "Data does not fit: the block%d size is %d bytes, data is %d bytes"
-                % (self.id, len(self.bitarray.bytes), len(wr_data.bytes))
+                f"Data does not fit: block{self.id} size "
+                f"{len(self.bitarray.bytes)} bytes, data {len(wr_data.bytes)} bytes"
             )
         self.check_wr_rd_protect()
 
@@ -468,7 +466,7 @@ class EfuseBlockBase(EfuseProtectBase):
         self.wr_bitarray.set(0)
 
 
-class EspEfusesBase(object):
+class EspEfusesBase:
     """
     Wrapper object to manage the efuse fields in a connected ESP bootloader
     """
@@ -538,8 +536,14 @@ class EspEfusesBase(object):
         log.print("Re-connecting...")
         baudrate = esp._port.baudrate
         port = esp._port.port
+        connect_mode = (
+            "usb-reset"
+            if esp._get_pid() == esp.USB_JTAG_SERIAL_PID
+            else "default-reset"
+        )
+        log.print(f"Port: {port}, Baudrate: {baudrate}, Connect mode: {connect_mode}")
         esp._port.close()
-        return esptool.detect_chip(port, baudrate)
+        return esptool.detect_chip(port, baudrate, connect_mode)
 
     def get_index_block_by_name(self, name):
         for block in self.blocks:
@@ -674,8 +678,9 @@ class EspEfusesBase(object):
     @staticmethod
     def confirm(action, do_not_confirm):
         log.print(
-            "%s%s\nThis is an irreversible operation!"
-            % (action, "" if action.endswith("\n") else ". ")
+            "{}{}\nThis is an irreversible operation!".format(
+                action, "" if action.endswith("\n") else ". "
+            )
         )
         if not do_not_confirm:
             log.print("Type 'BURN' (all capitals) to continue.", flush=True)

{esptool-5.1.dev1 → esptool-5.2.0}/espefuse/efuse/base_operations.py

@@ -9,7 +9,8 @@ import io
 import os
 import json
 import sys
-from typing import Any, BinaryIO, Callable, TextIO
+from typing import Any, BinaryIO, TextIO
+from collections.abc import Callable
 
 import espsecure
 import rich_click as click
@@ -222,16 +223,21 @@ class BaseCommands:
                 f"({self.CHIP_NAME} != {self.esp.CHIP_NAME})"
             )
 
+    @classmethod
+    def _close_port(
+        cls,
+        esp: esptool.ESPLoader | EmulateEfuseControllerBase | None,
+        external_esp: bool = False,
+    ) -> None:
+        """Close the serial port if it was opened internally."""
+        if esp is not None and not external_esp and isinstance(esp, esptool.ESPLoader):
+            esp._port.close()
+
     def __enter__(self):
         return self
 
     def __exit__(self, exc_type, exc_value, traceback):
-        if (
-            self.esp is not None
-            and not self.external_esp
-            and isinstance(self.esp, esptool.ESPLoader)
-        ):
-            self.esp._port.close()
+        self._close_port(self.esp, self.external_esp)
 
     ################################# CLI definitions #################################
 
@@ -850,9 +856,9 @@ class BaseCommands:
         for block in self.efuses.blocks:
             burn_list_a_block = [e for e in burn_efuses_list if e.block == block.id]
             if len(burn_list_a_block):
-                log.print("  from BLOCK%d" % (block.id))
+                log.print(f"  from BLOCK{block.id}")
                 for field in burn_list_a_block:
-                    log.print("     - %s" % (field.name))
+                    log.print(f"     - {field.name}")
                     if (
                         self.efuses.blocks[field.block].get_coding_scheme()
                         != self.efuses.REGS.CODING_SCHEME_NONE
@@ -990,18 +996,18 @@ class BaseCommands:
                     ]
                     if error:
                         raise esptool.FatalError(
-                            "%s must be readable, stop this operation!" % efuse_name
+                            f"{efuse_name} must be readable, stop this operation!"
                         )
                 else:
-                    for block in self.efuses.Blocks.BLOCKS:
-                        block = self.efuses.Blocks.get(block)
+                    for block_tuple in self.efuses.Blocks.BLOCKS:
+                        block = self.efuses.Blocks.get(block_tuple)
                         if block.name == efuse_name and block.key_purpose is not None:
                             if not self.efuses[block.key_purpose].need_rd_protect(
                                 self.efuses[block.key_purpose].get()
                             ):
                                 raise esptool.FatalError(
-                                    "%s must be readable, stop this operation!"
-                                    % efuse_name
+                                    f"{efuse_name} must be readable, "
+                                    f"stop this operation!"
                                 )
                             break
                 # make full list of which efuses will be disabled
@@ -1013,8 +1019,8 @@ class BaseCommands:
                 ]
                 names = ", ".join(e.name for e in all_disabling)
                 log.print(
-                    "Permanently read-disabling eFuse%s %s"
-                    % ("s" if len(all_disabling) > 1 else "", names)
+                    f"Permanently read-disabling eFuse"
+                    f"{'s' if len(all_disabling) > 1 else ''} {names}"
                 )
                 efuse.disable_read()
 
@@ -1055,8 +1061,8 @@ class BaseCommands:
                 ]
                 names = ", ".join(e.name for e in all_disabling)
                 log.print(
-                    "Permanently write-disabling eFuse%s %s"
-                    % ("s" if len(all_disabling) > 1 else "", names)
+                    f"Permanently write-disabling eFuse"
+                    f"{'s' if len(all_disabling) > 1 else ''} {names}"
                 )
                 efuse.disable_write()
 
@@ -1166,11 +1172,10 @@ class BaseCommands:
             )
         data_block.reverse()
         log.print(
-            "bit_number:   "
-            "[%-03d]........................................................[0]"
-            % (data_block.len - 1)
+            f"bit_number:   [{data_block.len - 1:03d}]"
+            f"........................................................[0]"
         )
-        log.print("BLOCK%-2d   :" % block_obj.id, data_block)
+        log.print(f"BLOCK{block_obj.id:>2d}   :", data_block)
         block_obj.print_block(data_block, "regs_to_write", debug=True)
         block_obj.save(data_block.bytes[::-1])
 

{esptool-5.1.dev1 → esptool-5.2.0}/espefuse/efuse/csv_table_parser.py

@@ -180,7 +180,7 @@ class CSVFuseTable(list):
                         print_error(p, n, state)
 
 
-class FuseDefinition(object):
+class FuseDefinition:
     def __init__(self):
         self.field_name = ""
         self.group = ""
@@ -261,11 +261,9 @@ class FuseDefinition(object):
 
 class InputError(RuntimeError):
     def __init__(self, e):
-        super(InputError, self).__init__(e)
+        super().__init__(e)
 
 
 class ValidationError(InputError):
     def __init__(self, p, message):
-        super(ValidationError, self).__init__(
-            f"Entry {p.field_name} invalid: {message}"
-        )
+        super().__init__(f"Entry {p.field_name} invalid: {message}")