sdev 0.4.3__tar.gz → 0.4.4__tar.gz

{sdev-0.4.3/sdev.egg-info → sdev-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdev
-Version: 0.4.3
+Version: 0.4.4
 Summary: 串口控制器工具包
 Home-page: https://github.com/klrc/sdev
 Author: klrc
@@ -62,39 +62,39 @@ sdev --no-check-alive shell "echo hello"
 
 ## 快速使用 (Python)
 
-推荐使用 `sdev()` 工厂函数或 `Demoboard` 类，它们提供了更高层、更易用的接口：
+推荐使用 `sdev()` 工厂函数或 `Demoboard` 类，它们提供了更高层、更易用的接口。`Demoboard` 在实例化时默认会自动执行 `check_alive()`。
 
 ```python
 from sdev import sdev
 
 # 使用 context manager 自动连接/断开
 with sdev("/dev/ttyUSB0", 115200) as board:
-    # connect 时默认会执行 check_alive()，确保板子已就绪
+    # 实例化时默认已执行 check_alive()，确保板子已就绪
     out = board.shell("ls")  # 执行命令并返回输出行列表
     print(out)
 ```
 
-手动控制连接与存活检测：
+使用旧版兼容接口：
 
 ```python
 from sdev import Demoboard
 
-board = Demoboard("/dev/ttyUSB0", 115200)
-board.connect()
-board.check_alive()  # 检查并确保进入 shell 提示符
-board.shell("echo hello")
-board.disconnect()
+with Demoboard("/dev/ttyUSB0", 115200) as board:
+    # execute_command 是 shell 的别名，方便旧代码迁移
+    out = board.execute_command("ls", flag=" #")
+    print(out)
 ```
 
 ## 主要接口
 
 ### Demoboard (推荐)
 
-继承自 `SerialDevice`，提供针对开发板的高层封装。
+继承自 `SerialDevice`，提供针对开发板的高层封装。实例化时会自动调用 `check_alive()`。
 
 | 方法 | 说明 |
 |------|------|
 | `shell(cmd, prompt_flag=" #", timeout=None, stream=False)` | 清缓冲 -> 发送命令 -> 等待命令回显 -> 等待提示符。返回输出列表或生成器。 |
+| `execute_command(cmd, flag, timeout=None, stream=False)` | `shell` 方法的别名，用于兼容旧版代码。 |
 | `check_alive(uboot_flag="uboot#", prompt_flag=" #", response_timeout=3)` | 存活检测：处理 U-Boot 挂起、发送 Ctrl-C 唤醒并等待提示符。 |
 
 ### SerialDevice (底层)

{sdev-0.4.3 → sdev-0.4.4}/README.md

@@ -28,39 +28,39 @@ sdev --no-check-alive shell "echo hello"
 
 ## 快速使用 (Python)
 
-推荐使用 `sdev()` 工厂函数或 `Demoboard` 类，它们提供了更高层、更易用的接口：
+推荐使用 `sdev()` 工厂函数或 `Demoboard` 类，它们提供了更高层、更易用的接口。`Demoboard` 在实例化时默认会自动执行 `check_alive()`。
 
 ```python
 from sdev import sdev
 
 # 使用 context manager 自动连接/断开
 with sdev("/dev/ttyUSB0", 115200) as board:
-    # connect 时默认会执行 check_alive()，确保板子已就绪
+    # 实例化时默认已执行 check_alive()，确保板子已就绪
     out = board.shell("ls")  # 执行命令并返回输出行列表
     print(out)
 ```
 
-手动控制连接与存活检测：
+使用旧版兼容接口：
 
 ```python
 from sdev import Demoboard
 
-board = Demoboard("/dev/ttyUSB0", 115200)
-board.connect()
-board.check_alive()  # 检查并确保进入 shell 提示符
-board.shell("echo hello")
-board.disconnect()
+with Demoboard("/dev/ttyUSB0", 115200) as board:
+    # execute_command 是 shell 的别名，方便旧代码迁移
+    out = board.execute_command("ls", flag=" #")
+    print(out)
 ```
 
 ## 主要接口
 
 ### Demoboard (推荐)
 
-继承自 `SerialDevice`，提供针对开发板的高层封装。
+继承自 `SerialDevice`，提供针对开发板的高层封装。实例化时会自动调用 `check_alive()`。
 
 | 方法 | 说明 |
 |------|------|
 | `shell(cmd, prompt_flag=" #", timeout=None, stream=False)` | 清缓冲 -> 发送命令 -> 等待命令回显 -> 等待提示符。返回输出列表或生成器。 |
+| `execute_command(cmd, flag, timeout=None, stream=False)` | `shell` 方法的别名，用于兼容旧版代码。 |
 | `check_alive(uboot_flag="uboot#", prompt_flag=" #", response_timeout=3)` | 存活检测：处理 U-Boot 挂起、发送 Ctrl-C 唤醒并等待提示符。 |
 
 ### SerialDevice (底层)

{sdev-0.4.3 → sdev-0.4.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sdev"
-version = "0.4.3"
+version = "0.4.4"
 description = "串口控制器工具包"
 readme = "README.md"
 license = {text = "MIT"}

{sdev-0.4.3 → sdev-0.4.4}/sdev/__init__.py

@@ -14,7 +14,7 @@ from typing import Literal
 from .core import SerialDevice
 from .class_wrapper import Demoboard, Relay
 
-__version__ = "0.4.3"
+__version__ = "0.4.4"
 __author__ = "klrc"
 __email__ = "1440698245@qq.com"
 
@@ -24,6 +24,7 @@ def sdev(
     baudrate: int = 115200,
     *,
     device_type: Literal["demoboard", "relay"] = "demoboard",
+    **kwargs,
 ):
     """
     构造一个设备实例。
@@ -31,9 +32,9 @@ def sdev(
     默认返回 Demoboard，后续可根据需要扩展其它类型。
     """
     if device_type == "demoboard":
-        return Demoboard(port, baudrate)
+        return Demoboard(port, baudrate, **kwargs)
     if device_type == "relay":
-        return Relay(port, baudrate)
+        return Relay(port, baudrate, **kwargs)
     raise ValueError(f"unsupported device_type: {device_type!r}")
 
 

{sdev-0.4.3 → sdev-0.4.4}/sdev/class_wrapper.py

@@ -21,11 +21,25 @@ class Demoboard(SerialDevice):
     - 提供 shell() / check_alive() 等高层方法。
     """
 
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.check_alive()
-
-    def execute_command(self, cmd, flag, timeout=None, stream=False):
+    def __init__(self, port: str, baudrate: int = 115200, check_alive: bool = True):
+        super().__init__(port, baudrate)
+        self._auto_check_alive = check_alive
+
+    def connect(self) -> None:
+        """连接并自动执行 check_alive。"""
+        if self._is_connected:
+            return
+        super().connect()
+        if self._auto_check_alive:
+            self.check_alive()
+
+    def execute_command(
+        self,
+        cmd: str,
+        flag: str = " #",
+        timeout: Optional[float] = None,
+        stream: bool = False,
+    ) -> Union[List[str], Generator[str, None, None]]:
         """alias for shell"""
         return self.shell(cmd, prompt_flag=flag, timeout=timeout, stream=stream)
 
@@ -61,8 +75,10 @@ class Relay(SerialDevice):
     - 具体继电器控制逻辑后续在 sdev.relay.functional 中补充。
     """
 
-    # 先占位，避免 API 变动；后续按需要扩展方法。
-    pass
+    def __init__(self, port: str, baudrate: int = 115200, **kwargs):
+        # 吞掉不支持的参数，确保与 sdev() 工厂兼容
+        kwargs.pop("check_alive", None)
+        super().__init__(port, baudrate)
 
 
 __all__ = ["Demoboard", "Relay"]

{sdev-0.4.3 → sdev-0.4.4}/sdev/cli_wrapper.py

@@ -27,10 +27,8 @@ def _get_default_baudrate() -> int:
 def cmd_shell(args: argparse.Namespace) -> int:
     port = args.port or _get_default_port()
     baudrate = args.baudrate or _get_default_baudrate()
-    with Demoboard(port, baudrate) as board:
+    with Demoboard(port, baudrate, check_alive=not args.no_check_alive) as board:
         try:
-            if not args.no_check_alive:
-                board.check_alive()
             board.shell(args.command, prompt_flag=args.flag, timeout=args.timeout)
         except TimeoutError as e:
             print(e, file=sys.stderr)

{sdev-0.4.3 → sdev-0.4.4/sdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sdev
-Version: 0.4.3
+Version: 0.4.4
 Summary: 串口控制器工具包
 Home-page: https://github.com/klrc/sdev
 Author: klrc
@@ -62,39 +62,39 @@ sdev --no-check-alive shell "echo hello"
 
 ## 快速使用 (Python)
 
-推荐使用 `sdev()` 工厂函数或 `Demoboard` 类，它们提供了更高层、更易用的接口：
+推荐使用 `sdev()` 工厂函数或 `Demoboard` 类，它们提供了更高层、更易用的接口。`Demoboard` 在实例化时默认会自动执行 `check_alive()`。
 
 ```python
 from sdev import sdev
 
 # 使用 context manager 自动连接/断开
 with sdev("/dev/ttyUSB0", 115200) as board:
-    # connect 时默认会执行 check_alive()，确保板子已就绪
+    # 实例化时默认已执行 check_alive()，确保板子已就绪
     out = board.shell("ls")  # 执行命令并返回输出行列表
     print(out)
 ```
 
-手动控制连接与存活检测：
+使用旧版兼容接口：
 
 ```python
 from sdev import Demoboard
 
-board = Demoboard("/dev/ttyUSB0", 115200)
-board.connect()
-board.check_alive()  # 检查并确保进入 shell 提示符
-board.shell("echo hello")
-board.disconnect()
+with Demoboard("/dev/ttyUSB0", 115200) as board:
+    # execute_command 是 shell 的别名，方便旧代码迁移
+    out = board.execute_command("ls", flag=" #")
+    print(out)
 ```
 
 ## 主要接口
 
 ### Demoboard (推荐)
 
-继承自 `SerialDevice`，提供针对开发板的高层封装。
+继承自 `SerialDevice`，提供针对开发板的高层封装。实例化时会自动调用 `check_alive()`。
 
 | 方法 | 说明 |
 |------|------|
 | `shell(cmd, prompt_flag=" #", timeout=None, stream=False)` | 清缓冲 -> 发送命令 -> 等待命令回显 -> 等待提示符。返回输出列表或生成器。 |
+| `execute_command(cmd, flag, timeout=None, stream=False)` | `shell` 方法的别名，用于兼容旧版代码。 |
 | `check_alive(uboot_flag="uboot#", prompt_flag=" #", response_timeout=3)` | 存活检测：处理 U-Boot 挂起、发送 Ctrl-C 唤醒并等待提示符。 |
 
 ### SerialDevice (底层)

{sdev-0.4.3 → sdev-0.4.4}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="sdev",
-    version="0.4.3",
+    version="0.4.4",
     author="klrc",
     author_email="144069824@qq.com",
     description="串口控制器工具包",