開発者ガイド
Tip
このドキュメントをいつ読むべきか:ErisPulse 向けの拡張機能——ボットに機能(モジュール)を追加する、または新しいプラットフォーム(アダプター)に接続する——を開発する準備をしている時に読んでください。ボットを利用するだけなら読み飛ばして、クイックスタートを直接ご覧ください。
ここからあなたの開発パスを見つけましょう:モジュール開発ではコマンドやメッセージハンドラーでボットの機能を拡張でき、アダプター開発ではボットを新しいメッセージプラットフォームに接続できます。どちらのパスも、プロジェクトの作成からテスト、公開までの完全な流れを網羅しています。
目次
モジュール開発
- モジュール開発入門 - 最初のモジュールを作成する
- モジュールのコア概念 - モジュールの核心的な概念とアーキテクチャ
- Event ラッパークラス詳解 - Event オブジェクトの完全な説明
- モジュールのベストプラクティス - 高品質なモジュールを開発するための提案
- データモデル層(ORM) - モジュール開発の応用編:宣言的モデル、自動テーブル作成と CRUD
アダプター開発
- アダプター開発入門 - 最初のアダプターを作成する
- アダプターのコア概念 - アダプターの核心的な概念(start() の2つの書き方と 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 モジュールストアへの提出フローなどが含まれます。
関連ドキュメント
- 標準規格 - 互換性を確保するための技術標準
- プラットフォーム特性ガイド - 各プラットフォームアダプターの特性を理解する