ErisPulse ErisPulse
Open in interactive docs →
On this page
Static mirror — the interactive version is canonical Open in interactive docs →

ErisPulse.CLI.commands.create 模块


模块概述

Create 命令实现

脚手架工具,快速创建 Module / Adapter 项目模板


函数列表

_camel_to_snake(name: str) -> str

将 PascalCase/CamelCase 名称转换为 snake_case

  • name (str): 原始名称

返回值 (str): 转换后的 snake_case 名称


_to_converter_name(name: str) -> str

根据适配器名称生成转换器类名

  • name (str): 适配器名称

返回值 (str): 转换器类名(名称后追加 Converter)


_validate_name(name: str) -> bool

校验项目/模块/适配器名称是否合法

名称必须以字母开头,且只能包含字母、数字和下划线。

  • name (str): 待校验的名称

返回值 (bool): 合法返回 True,否则 False


_copy_erispulse_logo(project_dir: Path) -> None

将 ErisPulseLogo.png 拷贝到项目的 .github/assets/ 目录

  • project_dir (Path): 项目根目录

_write_project_gitignore(project_dir: Path) -> None

为可发布项目写入 .gitignore(已存在则跳过)

排除运行时产物(config/data/logs)、lockfile 与缓存; config.example.toml 等模板文件不在排除范围。

  • project_dir (Path): 项目根目录

_scaffold_text(name: str) -> dict

构建当前语言的脚手架文案映射,并预填充 {name} 占位符

  • name (str): 模块/适配器名称

返回值 (dict): ScaffoldText.all() 的文案字典(含占位符替换)


类列表

class CreateCommand(Command)

create 命令

脚手架工具,快速创建 Module / Adapter 项目模板

方法列表

_interactive_select_type() -> str

交互式选择创建类型(Module 或 Adapter)

返回值 (str): 返回 "module" 或 "adapter"


_ask_missing(args, field_name: str, prompt_text: str, default: str = '') -> str

获取参数值,若缺失则交互式提示输入

  • args (Any): 解析后的命令参数对象
  • field_name (str): 参数字段名
  • prompt_text (str): 提示文本
  • default (str): 默认值 (默认: "")

返回值 (str): 获取到的参数值


_create_pack(args)

将本地插件(plugins/ 目录)转换为可发布的标准项目结构

交互式选择插件目录中的插件,识别类型(模块/适配器)后输入包元信息, 输出含 pyproject.toml(entry-point 按插件类型生成)与插件源码的完整 项目目录,可直接 pip install -e . 或打包发布。

  • args (Any): 解析后的命令参数对象

返回值 (None): 无返回值


_create_module(args, name: str)

创建 Module 项目脚手架

  • args (Any): 解析后的命令参数对象
  • name (str): 模块名称

返回值 (None): 无返回值


_create_module_local(args, name: str)

创建本地插件(--local):生成 plugins/ 目录结构,免打包安装

  • args (Any): 解析后的命令参数对象
  • name (str): 模块名称

返回值 (None): 无返回值


_create_adapter_local(args, name: str)

创建本地适配器插件(--local):生成 plugins/ 目录结构,免打包安装

  • args (Any): 解析后的命令参数对象
  • name (str): 适配器名称

返回值 (None): 无返回值


_create_adapter(args, name: str)

创建 Adapter 项目脚手架

  • args (Any): 解析后的命令参数对象
  • name (str): 适配器名称

返回值 (None): 无返回值