ErisPulse 2.4.7__tar.gz → 2.5.0.dev0__tar.gz

{erispulse-2.4.7 → erispulse-2.5.0.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ErisPulse
-Version: 2.4.7
+Version: 2.5.0.dev0
 Summary: ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。
 Author-email: ErisDev <erisdev@88.com>
 Maintainer-email: "艾莉丝·格雷拉特(WSu2059)" <wsu2059@qq.com>

{erispulse-2.4.7 → erispulse-2.5.0.dev0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "ErisPulse"
-version = "2.4.7"
+version = "2.5.0-dev.0"
 description = "ErisPulse 是一个模块化、可扩展的异步 Python SDK 框架，主要用于构建高效、可维护的机器人应用程序。"
 readme = "README.md"
 requires-python = ">=3.10"

{erispulse-2.4.7 → erispulse-2.5.0.dev0}/src/ErisPulse/CLI/base.py

@@ -17,12 +17,14 @@ class Command(ABC):
     {!--< tips >!--}
     1. 每个命令类必须实现 add_arguments 和 execute 方法
     2. name 和 description 为类属性，必须在子类中定义
-    3. execute 方法接收解析后的 args 对象
+    3. aliases 为可选类属性，用于定义命令的简化形式
+    4. execute 方法接收解析后的 args 对象
     {!--< /tips >!--}
     """
 
     name: str = ""  # 命令名称
     description: str = ""  # 命令描述
+    aliases: list = []  # 命令别名（简化形式，如 "install" -> ["i", "add"]）
 
     @abstractmethod
     def add_arguments(self, parser: ArgumentParser):

{erispulse-2.4.7 → erispulse-2.5.0.dev0}/src/ErisPulse/CLI/base.pyi

@@ -22,11 +22,13 @@ class Command(ABC):
     {!--< tips >!--}
     1. 每个命令类必须实现 add_arguments 和 execute 方法
     2. name 和 description 为类属性，必须在子类中定义
-    3. execute 方法接收解析后的 args 对象
+    3. aliases 为可选类属性，用于定义命令的简化形式
+    4. execute 方法接收解析后的 args 对象
     {!--< /tips >!--}
     """
     name: str
     description: str
+    aliases: list
     def add_arguments(self: object, parser: ArgumentParser) -> ...:
         """
         添加命令参数

{erispulse-2.4.7 → erispulse-2.5.0.dev0}/src/ErisPulse/CLI/cli.py

@@ -16,7 +16,6 @@ from rich.text import Text
 from .console import console, print_banner
 from .registry import CommandRegistry
 from .base import Command
-from .utils.display import section_header
 
 
 class CLI:
@@ -117,9 +116,13 @@ class CLI:
         """注册所有内置命令（通过自动发现）"""
         self._auto_discover_commands()
 
-        # 添加所有命令的参数
+        # 添加所有命令的参数（同时注册命令别名）
         for command in self.registry.get_all():
-            parser = self.subparsers.add_parser(command.name, help=command.description)
+            parser = self.subparsers.add_parser(
+                command.name,
+                aliases=getattr(command, "aliases", None) or [],
+                help=command.description,
+            )
             command.add_arguments(parser)
 
     def _print_version(self):
@@ -158,16 +161,19 @@ class CLI:
             self.parser.print_help()
             return
 
-        if unknown and args.command not in ("install", "create"):
+        # 将别名解析为规范命令名
+        canonical = self.registry.resolve(args.command) or args.command
+
+        if unknown and canonical not in ("install", "create"):
             console.print(f"[warning]未识别的参数: {' '.join(unknown)}[/]")
 
         try:
             # 执行命令
-            command = self.registry.get(args.command)
+            command = self.registry.get(canonical)
             if command:
                 console.print()
                 console.print(
-                    Text(f"  ── ", style="dim"),
+                    Text("  ── ", style="dim"),
                     Text(command.description, style="bold"),
                     sep="",
                 )

{erispulse-2.4.7 → erispulse-2.5.0.dev0}/src/ErisPulse/CLI/cli.pyi

@@ -20,7 +20,6 @@ from rich.text import Text
 from .console import console, print_banner
 from .registry import CommandRegistry
 from .base import Command
-from .utils.display import section_header
 
 class CLI:
     """

{erispulse-2.4.7 → erispulse-2.5.0.dev0}/src/ErisPulse/CLI/commands/create.py

@@ -14,7 +14,7 @@ from rich.text import Text
 
 from ..console import console
 from ..base import Command
-from ..utils.display import section_header
+from ..utils.display import section_header, prompt_validated
 
 
 _LICENSE_TEMPLATE = """MIT License
@@ -474,6 +474,12 @@ token = ""
 
 
 def _camel_to_snake(name: str) -> str:
+    """
+    将 PascalCase/CamelCase 名称转换为 snake_case
+
+    :param name: [str] 原始名称
+    :return: [str] 转换后的 snake_case 名称
+    """
     import re
 
     s = re.sub(r"(?<=[a-z0-9])([A-Z])", r"_\1", name)
@@ -482,10 +488,24 @@ def _camel_to_snake(name: str) -> str:
 
 
 def _to_converter_name(name: str) -> str:
+    """
+    根据适配器名称生成转换器类名
+
+    :param name: [str] 适配器名称
+    :return: [str] 转换器类名（名称后追加 Converter）
+    """
     return f"{name}Converter"
 
 
 def _validate_name(name: str) -> bool:
+    """
+    校验项目/模块/适配器名称是否合法
+
+    名称必须以字母开头，且只能包含字母、数字和下划线。
+
+    :param name: [str] 待校验的名称
+    :return: [bool] 合法返回 True，否则 False
+    """
     if not name:
         return False
     if not name[0].isalpha():
@@ -494,8 +514,15 @@ def _validate_name(name: str) -> bool:
 
 
 class CreateCommand(Command):
+    """
+    create 命令
+
+    脚手架工具，快速创建 Module / Adapter 项目模板
+    """
+
     name = "create"
     description = "创建 Module / Adapter 项目脚手架"
+    aliases = ["c", "new"]
 
     def add_arguments(self, parser: ArgumentParser):
         parser.add_argument(
@@ -521,14 +548,16 @@ class CreateCommand(Command):
         if not create_type:
             create_type = self._interactive_select_type()
 
+        default_name = "MyModule" if create_type == "module" else "MyAdapter"
         name = args.name
-        if not name:
-            default_name = "MyModule" if create_type == "module" else "MyAdapter"
-            name = Prompt.ask("  名称 (PascalCase)", default=default_name)
-
-        if not _validate_name(name):
-            console.print("[error]  名称必须以字母开头，只能包含字母、数字和下划线")
-            sys.exit(1)
+        # 名称校验：非法时保留输入并重新提示，而非直接退出
+        if not (name and _validate_name(name)):
+            name = prompt_validated(
+                "  名称 (PascalCase)",
+                default=name or default_name,
+                validate=_validate_name,
+                error_msg="名称必须以字母开头，只能包含字母、数字和下划线",
+            )
 
         if create_type == "module":
             self._create_module(args, name)
@@ -536,6 +565,11 @@ class CreateCommand(Command):
             self._create_adapter(args, name)
 
     def _interactive_select_type(self) -> str:
+        """
+        交互式选择创建类型（Module 或 Adapter）
+
+        :return: [str] 返回 "module" 或 "adapter"
+        """
         section_header("选择创建类型")
         console.print("    [bold]1.[/] Module   [dim]— 自定义功能模块[/]")
         console.print("    [bold]2.[/] Adapter  [dim]— 平台适配器[/]")
@@ -547,12 +581,28 @@ class CreateCommand(Command):
     def _ask_missing(
         self, args, field_name: str, prompt_text: str, default: str = ""
     ) -> str:
+        """
+        获取参数值，若缺失则交互式提示输入
+
+        :param args: [Any] 解析后的命令参数对象
+        :param field_name: [str] 参数字段名
+        :param prompt_text: [str] 提示文本
+        :param default: [str] 默认值 (默认: "")
+        :return: [str] 获取到的参数值
+        """
         val = getattr(args, field_name, None) or ""
         if not val:
             val = Prompt.ask(f"  {prompt_text}", default=default)
         return val
 
     def _create_module(self, args, name: str):
+        """
+        创建 Module 项目脚手架
+
+        :param args: [Any] 解析后的命令参数对象
+        :param name: [str] 模块名称
+        :return: [None] 无返回值
+        """
         description = self._ask_missing(
             args, "description", "模块描述", f"一个非常哇塞的{name}模块"
         )
@@ -604,24 +654,31 @@ class CreateCommand(Command):
             console.print()
             console.print(Text("  项目结构:", style="bold"))
             console.print(f"    {name}/")
-            console.print(f"    ├── pyproject.toml")
-            console.print(f"    ├── LICENSE")
-            console.print(f"    ├── README.md")
+            console.print("    ├── pyproject.toml")
+            console.print("    ├── LICENSE")
+            console.print("    ├── README.md")
             console.print(f"    └── {name}/")
-            console.print(f"        ├── __init__.py")
-            console.print(f"        └── Core.py")
+            console.print("        ├── __init__.py")
+            console.print("        └── Core.py")
             console.print()
             console.print(Text("  接下来:", style="bold"))
             console.print(f"    · cd {name}")
             console.print(f"    · 编辑 {name}/Core.py 实现模块逻辑")
-            console.print(f"    · pip install -e .  (开发模式安装)")
-            console.print(f"    · epsdk run  (运行测试)")
+            console.print("    · pip install -e .  (开发模式安装)")
+            console.print("    · epsdk run  (运行测试)")
 
         except Exception as e:
             console.print(f"[error]  创建失败: {e}")
             sys.exit(1)
 
     def _create_adapter(self, args, name: str):
+        """
+        创建 Adapter 项目脚手架
+
+        :param args: [Any] 解析后的命令参数对象
+        :param name: [str] 适配器名称
+        :return: [None] 无返回值
+        """
         description = self._ask_missing(
             args, "description", "适配器描述", f"{name}平台适配器"
         )
@@ -690,20 +747,20 @@ class CreateCommand(Command):
             console.print()
             console.print(Text("  项目结构:", style="bold"))
             console.print(f"    {name}/")
-            console.print(f"    ├── pyproject.toml")
-            console.print(f"    ├── LICENSE")
-            console.print(f"    ├── README.md")
+            console.print("    ├── pyproject.toml")
+            console.print("    ├── LICENSE")
+            console.print("    ├── README.md")
             console.print(f"    └── {name}/")
-            console.print(f"        ├── __init__.py")
-            console.print(f"        ├── Core.py")
-            console.print(f"        └── Converter.py")
+            console.print("        ├── __init__.py")
+            console.print("        ├── Core.py")
+            console.print("        └── Converter.py")
             console.print()
             console.print(Text("  接下来:", style="bold"))
             console.print(f"    · cd {name}")
             console.print(f"    · 编辑 {name}/Core.py 实现适配器逻辑")
             console.print(f"    · 编辑 {name}/Converter.py 实现消息格式转换")
-            console.print(f"    · pip install -e .  (开发模式安装)")
-            console.print(f"    · epsdk run  (运行测试)")
+            console.print("    · pip install -e .  (开发模式安装)")
+            console.print("    · epsdk run  (运行测试)")
 
         except Exception as e:
             console.print(f"[error]  创建失败: {e}")

erispulse-2.5.0.dev0/src/ErisPulse/CLI/commands/create.pyi

@@ -0,0 +1,97 @@
+# type: ignore
+#
+# Auto-generated type stub for create.py
+# DO NOT EDIT MANUALLY - Generated by generate-type-stubs.py
+#
+
+"""
+Create 命令实现
+
+脚手架工具，快速创建 Module / Adapter 项目模板
+"""
+
+import sys
+import datetime
+from argparse import ArgumentParser
+from pathlib import Path
+from rich.prompt import Prompt, IntPrompt
+from rich.text import Text
+from ..console import console
+from ..base import Command
+from ..utils.display import section_header, prompt_validated
+
+def _camel_to_snake(name: str) -> str:
+    """
+    将 PascalCase/CamelCase 名称转换为 snake_case
+    
+    :param name: [str] 原始名称
+    :return: [str] 转换后的 snake_case 名称
+    """
+    ...
+
+def _to_converter_name(name: str) -> str:
+    """
+    根据适配器名称生成转换器类名
+    
+    :param name: [str] 适配器名称
+    :return: [str] 转换器类名（名称后追加 Converter）
+    """
+    ...
+
+def _validate_name(name: str) -> bool:
+    """
+    校验项目/模块/适配器名称是否合法
+    
+    名称必须以字母开头，且只能包含字母、数字和下划线。
+    
+    :param name: [str] 待校验的名称
+    :return: [bool] 合法返回 True，否则 False
+    """
+    ...
+
+class CreateCommand(Command):
+    """
+    create 命令
+    
+    脚手架工具，快速创建 Module / Adapter 项目模板
+    """
+    def add_arguments(self: object, parser: ArgumentParser) -> ...:
+        ...
+    def execute(self: object, args: ...) -> ...:
+        ...
+    def _interactive_select_type(self: object) -> str:
+        """
+        交互式选择创建类型（Module 或 Adapter）
+        
+        :return: [str] 返回 "module" 或 "adapter"
+        """
+        ...
+    def _ask_missing(self: object, args: ..., field_name: str, prompt_text: str, default: str = ...) -> str:
+        """
+        获取参数值，若缺失则交互式提示输入
+        
+        :param args: [Any] 解析后的命令参数对象
+        :param field_name: [str] 参数字段名
+        :param prompt_text: [str] 提示文本
+        :param default: [str] 默认值 (默认: "")
+        :return: [str] 获取到的参数值
+        """
+        ...
+    def _create_module(self: object, args: ..., name: str) -> ...:
+        """
+        创建 Module 项目脚手架
+        
+        :param args: [Any] 解析后的命令参数对象
+        :param name: [str] 模块名称
+        :return: [None] 无返回值
+        """
+        ...
+    def _create_adapter(self: object, args: ..., name: str) -> ...:
+        """
+        创建 Adapter 项目脚手架
+        
+        :param args: [Any] 解析后的命令参数对象
+        :param name: [str] 适配器名称
+        :return: [None] 无返回值
+        """
+        ...