開發者指南
Tip
什麼時候需要讀這篇:準備為 ErisPulse 開發擴充——給機器人加功能(模組)或接入新平台(配接器)——時。只想使用機器人則跳過,直接看快速開始。
從這裡找到你的開發路徑:模組開發讓你用命令、訊息處理器擴充機器人功能;配接器開發讓機器人連上新的訊息平台。兩條路徑都涵蓋從建立專案到測試、發布的完整流程。
內容列表
模組開發
- 模組開發入門 - 建立第一個模組
- 模組核心概念 - 模組的核心概念和架構
- Event 包裝類別詳解 - Event 物件的完整說明
- 模組最佳實踐 - 開發高品質模組的建議
- 資料模型層(ORM) - 模組開發進階:宣告式模型、自動建表與增刪改查
配接器開發
- 配接器開發入門 - 建立第一個配接器
- 配接器核心概念 - 配接器的核心概念(含 start() 兩種寫法與 PollingAdapter / WebhookAdapter 連接模式基底類別)
- SendDSL 詳解 - Send 訊息傳送 DSL 的完整說明
- 事件轉換器 - 實作事件轉換器
- 配接器最佳實踐 - 開發高品質配接器的建議
測試與疑難排解
- 模組測試(ErisPulse-Testing) - TestBot、事件工廠與斷言面
通用規範
- 設定與 UI 中繼資料 - 宣告式設定:widget / 條件顯隱 / 值形態 / 相容性契約(配接器與模組通用)
發布指南
- 發布與模組商店指南 - 將你的作品發布到 PyPI 和 ErisPulse 模組商店
開發準備
在開始開發之前,請確保你:
開發類型選擇
根據你的需求選擇合適的開發類型:
如果你想擴充機器人的功能(如新增命令、處理訊息),選擇模組開發。如果你需要讓機器人連接到一個新的平台,選擇配接器開發。
開發工具
項目模板
ErisPulse 提供了示例項目作為參考:
- 模組示例 - 模組的完整專案結構(命令 / 配置 / ORM / 依賴注入)
- Web 能力示例 - 路由裝飾器 / 中間件 / WebSocket 鈎子 / router.app 逃生艙
- 互動進階示例 - 消息事務與回執 / ORM 聯合唯一與事務 / 請求審批 / 發送鏈
- 運維治理示例 - 線程任務歸屬 / 延遲任務 / 內存體檢 / 隱私開關
- 適配器示例 - 適配器的完整專案結構(另有 輪詢 / Webhook 變體)
開發模式
使用熱重載模式進行開發,程式碼修改後自動重載:
epsdk run main.py --reload
調試技巧
在 config/config.toml 中啟用 DEBUG 或 TRACE 級別日誌:
[ErisPulse.logger]
# DEBUG: 輸出模組載入、路由註冊等開發調試資訊
# TRACE: 最低級別,輸出事件分發、儲存寫入、懶載入等框架內部詳細流程
level = "DEBUG"
發布你的模組
完整的發布流程請參考 發布與模組商店指南,包括 PyPI 發布步驟、ErisPulse 模組商店提交流程等。