PyriteSDK
初步了解 PyriteSDK
PyriteSDK 是 PyriteIDE 的插件开发工具包。你使用 Python 编写插件代码,通过 SDK 暴露的 API 操控 IDE 的文件系统、编辑器、设备串口、设置项等能力,最终打包为 ZIP 分发给用户安装。
架构
插件入口由 IDE 内嵌的 Python 运行时启动,通过 Dart Bridge 传输层与 IDE 宿主通信。Bridge 层处理消息路由、回调分发和生命周期管理,插件代码无需直接操作底层协议。
插件类型
| 类型 | 基类 | 用途 | 页面 |
|---|---|---|---|
| UI | UiPlugin | 渲染自定义界面,响应用户交互 | UI 插件开发 |
| Service | ServicePlugin | 后台任务,监听文件变化或设备事件 | 服务插件开发 |
| Data | DataPlugin | 贡献主题、语言包、类型存根 | 数据插件开发 |
可用 API
| API | UI | Service | Data | 说明 |
|---|---|---|---|---|
path | ✓ | ✓ | ✓ | 插件目录路径 |
settings | ✓ | ✓ | ✓ | IDE 设置读写 |
message | ✓ | ✓ | ✓ | 消息通知 |
clipboard | ✓ | ✓ | ✓ | 剪贴板写入 |
dialog | ✓ | ✓ | ✓ | 文件夹选择对话框 |
resources | ✓ | ✓ | ✓ | 只读资源(assets/) |
events | ✓ | ✓ | ✓ | 事件订阅 |
commands | ✓ | ✓ | ✓ | 命令注册与分发 |
configuration | ✓ | ✓ | ✓ | 清单声明的配置读写 |
file | ✓ | ✓ | 本地文件操作 | |
board | ✓ | ✓ | 设备文件操作 | |
persistence | 键值存储 | ✓ | ✓ | |
serial | ✓ | ✓ | 串口通信 | |
documents | ✓ | ✓ | 编辑器文档查询与订阅 | |
runtime | ✓ | ✓ | 设备运行时检查 | |
env | ✓ | ✓ | 运行环境信息 | |
editor | ✓ | 编辑器内容与光标操作 | ||
tabs | ✓ | 创建视图标签页 | ||
views | ✓ | 原生视图模型 | ||
theme | ✓ | ✓ | ✓ | 主题贡献 |
i18n | ✓ | ✓ | ✓ | 语言包贡献 |
stubs | ✓ | ✓ | ✓ | 类型存根贡献 |