ErisPulse ErisPulse
在互動式文檔中心打開 →
本頁章節
本文為靜態鏡像,內容以互動版為準 在互動式文檔中心打開 →

開發者指南

Tip

什麼時候需要讀這篇:準備為 ErisPulse 開發擴充——給機器人加功能(模組)或接入新平台(配接器)——時。只想使用機器人則跳過,直接看快速開始。

從這裡找到你的開發路徑:模組開發讓你用命令、訊息處理器擴充機器人功能;配接器開發讓機器人連上新的訊息平台。兩條路徑都涵蓋從建立專案到測試、發布的完整流程。

內容列表

模組開發

  1. 模組開發入門 - 建立第一個模組
  2. 模組核心概念 - 模組的核心概念和架構
  3. Event 包裝類別詳解 - Event 物件的完整說明
  4. 模組最佳實踐 - 開發高品質模組的建議
  5. 資料模型層(ORM) - 模組開發進階:宣告式模型、自動建表與增刪改查

配接器開發

  1. 配接器開發入門 - 建立第一個配接器
  2. 配接器核心概念 - 配接器的核心概念(含 start() 兩種寫法與 PollingAdapter / WebhookAdapter 連接模式基底類別)
  3. SendDSL 詳解 - Send 訊息傳送 DSL 的完整說明
  4. 事件轉換器 - 實作事件轉換器
  5. 配接器最佳實踐 - 開發高品質配接器的建議

測試與疑難排解

  1. 模組測試(ErisPulse-Testing) - TestBot、事件工廠與斷言面

通用規範

  1. 設定與 UI 中繼資料 - 宣告式設定:widget / 條件顯隱 / 值形態 / 相容性契約(配接器與模組通用)

發布指南

開發準備

在開始開發之前,請確保你:

  1. 閱讀了基礎概念
  2. 熟悉了事件處理
  3. 安裝了開發環境(Python >= 3.10)
  4. 安裝了 ErisPulse SDK

開發類型選擇

根據你的需求選擇合適的開發類型:

開發類型 適用場景 入門指南
模組開發 擴充機器人功能、實作業務邏輯、提供命令和訊息處理 模組開發入門
配接器開發 連接新的訊息平台、實作跨平台通訊、提供平台特定功能 配接器開發入門

如果你想擴充機器人的功能(如新增命令、處理訊息),選擇模組開發。如果你需要讓機器人連接到一個新的平台,選擇配接器開發。

開發工具

項目模板

ErisPulse 提供了示例項目作為參考:

開發模式

使用熱重載模式進行開發,程式碼修改後自動重載:

epsdk run main.py --reload

調試技巧

在 config/config.toml 中啟用 DEBUG 或 TRACE 級別日誌:

[ErisPulse.logger]
# DEBUG: 輸出模組載入、路由註冊等開發調試資訊
# TRACE: 最低級別,輸出事件分發、儲存寫入、懶載入等框架內部詳細流程
level = "DEBUG"

發布你的模組

完整的發布流程請參考 發布與模組商店指南,包括 PyPI 發布步驟、ErisPulse 模組商店提交流程等。

相關文件