一般的タスクの例
Tip
この章を読むタイミング:ロボットに特定の機能を追加したいときは、各節を参照してください。永続化、定期タスク、メッセージフィルタ、権限制御、一括送信など、各節は直接コピーできる完全な例です。イベント処理の書き方を体系的に学びたい場合は イベント処理入門 を先にご覧ください。必要なければ飛ばしてください。
内容リスト
- データの永続化
- 定期タスク
- メッセージフィルタ
- 多プラットフォーム対応
- メッセージ送信の高度な機能(リトライ/タイムアウト/一括送信)
- 権限制御
- メッセージの統計
- 検索機能
- 画像処理
データの永続化
簡単なカウンター
from ErisPulse import sdk
from ErisPulse.Core.Event import command
@command("count", help="コマンドの呼び出し回数を表示")
async def count_handler(event):
# カウントを取得
count = sdk.storage.get("command_count", 0)
# カウントを増やす
count += 1
sdk.storage.set("command_count", count)
await event.reply(f"このコマンドは {count} 回目の呼び出しです")
ユーザーのデータの保存
@command("profile", help="個人情報の表示")
async def profile_handler(event):
user_id = event.get_user_id()
# ユーザーのデータを取得
user_data = sdk.storage.get(f"user:{user_id}", {
"nickname": "",
"join_date": None,
"message_count": 0
})
profile_text = f"""
ニックネーム: {user_data['nickname']}
加入日: {user_data['join_date']}
メッセージ数: {user_data['message_count']}
"""
await event.reply(profile_text.strip())
@command("setnick", help="ニックネームの設定")
async def setnick_handler(event):
user_id = event.get_user_id()
args = event.get_command_args()
if not args:
await event.reply("ニックネームを入力してください")
return
# ユーザーのデータを更新
user_data = sdk.storage.get(f"user:{user_id}", {})
user_data["nickname"] = " ".join(args)
sdk.storage.set(f"user:{user_id}", user_data)
await event.reply(f"ニックネームを {' '.join(args)} に設定しました")
定期タスク
簡単なタイマー
from ErisPulse import sdk
from ErisPulse.Core.Event import command
import asyncio
class TimerModule:
def __init__(self):
self.sdk = sdk
self._tasks = []
async def on_load(self, event):
"""モジュールのロード時に定期タスクを開始"""
self._start_timers()
@command("timer", help="タイマー管理")
async def timer_handler(event):
await event.reply("タイマーが実行中です...")
def _start_timers(self):
"""定期タスクを開始"""
# 60秒ごとに実行
task = asyncio.create_task(self._every_minute())
self._tasks.append(task)
# 毎日午前0時に実行
task = asyncio.create_task(self._daily_task())
self._tasks.append(task)
async def _every_minute(self):
"""毎分実行されるタスク"""
self.sdk.logger.info("毎分のタスクを実行")
# あなたのロジック...
async def _daily_task(self):
"""毎日午前0時に実行されるタスク(注:UTC時間で計算されます。ローカル時間が必要な場合は調整してください)"""
import time
while True:
# 午前0時までの時間を計算
now = time.time()
midnight = now + (86400 - now % 86400)
await asyncio.sleep(midnight - now)
# タスクを実行
self.sdk.logger.info("毎日のタスクを実行")
# あなたのロジック...
ライフサイクルイベントの使用
@sdk.lifecycle.on("core.init.complete")
async def init_complete_handler(event_data):
"""SDKの初期化完了後に定期タスクを開始"""
import asyncio
async def daily_reminder():
"""毎日のリマインダー"""
await asyncio.sleep(86400) # 24時間
sdk.logger.info("毎日のタスクを実行")
# バックグラウンドタスクを開始
asyncio.create_task(daily_reminder())
メッセージフィルタ
キーワードフィルタ
from ErisPulse.Core.Event import message
blocked_words = ["スパム", "広告", "詐欺"]
@message.on_message()
async def filter_handler(event):
text = event.get_text()
# 敏感語を含むかチェック
for word in blocked_words:
if word in text:
sdk.logger.warning(f"フィルタされたメッセージ: {word}")
return # このメッセージを処理しない
# 通常のメッセージを処理
await event.reply(f"受信: {text}")
ブラックリストフィルタ
# 設定ファイルやストレージからブラックリストをロード
blacklist = sdk.storage.get("user_blacklist", [])
@message.on_message()
async def blacklist_handler(event):
user_id = event.get_user_id()
if user_id in blacklist:
sdk.logger.info(f"ブラックリストユーザー: {user_id}")
return # このメッセージを処理しない
# 通常のメッセージを処理
await event.reply(f"こんにちは、{user_id}")
多プラットフォーム対応
プラットフォーム固有の応答
@command("help", help="ヘルプを表示")
async def help_handler(event):
platform = event.get_platform()
if platform == "yunhu":
await event.reply("yunhuプラットフォームのヘルプ...")
elif platform == "telegram":
await event.reply("Telegram platform help...")
elif platform == "onebot11":
await event.reply("OneBot11 help...")
else:
await event.reply("一般的なヘルプ情報")
プラットフォームの機能検出
@command("rich", help="リッチテキストメッセージを送信")
async def rich_handler(event):
platform = event.get_platform()
if platform == "yunhu":
# yunhuはHTMLをサポート
yunhu = sdk.adapter.get("yunhu")
await yunhu.Send.To("user", event.get_user_id()).Html(
"<b>太字テキスト</b><i>斜体テキスト</i>"
)
elif platform == "telegram":
# TelegramはMarkdownをサポート
telegram = sdk.adapter.get("telegram")
await telegram.Send.To("user", event.get_user_id()).Markdown(
"**太字テキスト** *斜体テキスト*"
)
else:
# その他のプラットフォームはプレーンテキストを使用
await event.reply("太字テキスト 斜体テキスト")
メッセージ送信の高度な機能(リトライ/タイムアウト/一括送信)
event.reply() だけでなく、アダプタの Send DSL を使って、失敗時の自動リトライ、タイムアウト、成功後の処理、複数メッセージの一括送信などのより複雑な送信シナリオを実現できます。
以下の例では、
event.get_detail_type()とevent.get_target_id()を使用して、イベントからターゲットの種類とIDを取得しています(グループチャットの場合は group_id、プライベートチャットの場合は user_id を自動的に取得)。ハードコードを避けてください。
送信成功後に処理を実行
@command("pay", help="支払いをシミュレート")
async def pay_handler(event):
yunhu = sdk.adapter.get(event.get_platform())
user_id = event.get_user_id()
# 支払い成功後にポイントを減算
await (yunhu.Send.To(event.get_detail_type(), event.get_target_id())
.Hook(lambda r: sdk.storage.set(f"points:{user_id}", -10))
.Text("支払い成功、10ポイントを減算しました"))
失敗時のリトライ + タイムアウト
@command("notice", help="重要な通知を送信")
async def notice_handler(event):
adapter_inst = sdk.adapter.get(event.get_platform())
# 最大3回リトライ、各リトライは10秒でタイムアウト
task = (adapter_inst.Send.To(event.get_detail_type(), event.get_target_id())
.Retry(3)
.Timeout(10)
.OnError(lambda ctx: sdk.logger.error(f"通知送信失敗: {ctx.error}"))
.Text("これは重要な通知です"))
# 待たずにバックグラウンドで送信
複数メッセージの一括送信
1つのチェーンで複数のメッセージを送信し、一括で処理できます:
@command("announce", help="公告を送信")
async def announce_handler(event):
adapter_inst = sdk.adapter.get(event.get_platform())
# 複数のメッセージを作成し、一括で送信(デフォルトは並列)
results = await (adapter_inst.Send.To(event.get_detail_type(), event.get_target_id())
.Build()
.Text("📋 今日の公告")
.Image("https://example.com/banner.jpg")
.Text("詳細は上記の画像をご覧ください")
.Retry(2) # 失敗した項目はそれぞれリトライ
.send_all())
sdk.logger.info(f"一括送信完了、合計 {len(results)} 件")
より詳細なルールと一括送信の説明は プラットフォームの機能ガイド を参照してください。
権限制御
管理者チェック
# マスターのリストを設定
MASTERS = ["user123", "user456"]
def is_master(user_id):
"""フレームワークのマスターかチェック"""
return user_id in MASTERS
@command("master", help="フレームワークマスター用コマンド")
async def master_handler(event):
user_id = event.get_user_id()
if not is_master(user_id):
await event.reply("権限がありません。このコマンドはフレームワークマスターのみ使用できます")
return
await event.reply("フレームワークマスター用コマンドが正常に実行されました")
@command("addmaster", help="フレームワークマスターを追加")
async def addmaster_handler(event):
if not is_master(event.get_user_id()):
return
args = event.get("text", "").split()
if len(args) < 2:
await event.reply("使い方: /addmaster <ユーザーID>")
return
new_master = args[0]
MASTERS.append(new_master)
await event.reply(f"フレームワークマスターを追加しました: {new_master}")
グループ権限
@command("groupinfo", help="グループ情報を表示")
async def groupinfo_handler(event):
if not event.is_group_message():
await event.reply("このコマンドはグループチャットでのみ使用できます")
return
group_id = event.get_group_id()
user_id = event.get_user_id()
await event.reply(f"グループID: {group_id}, あなたのID: {user_id}")
メッセージの統計
メッセージのカウント
注意:以下の例では
sdk.storage.get/setを使用して簡単なカウントを行っています。高並行な環境では、アトミック性を保証するためにsdk.storage.transaction()を使用することを推奨します。
@message.on_message()
async def count_handler(event):
# 統計を取得
stats = sdk.storage.get("message_stats", {
"total": 0,
"by_user": {},
"by_day": {}
})
# 統計を更新
stats["total"] += 1
user_id = event.get_user_id()
stats["by_user"][user_id] = stats["by_user"].get(user_id, 0) + 1
# 保存
sdk.storage.set("message_stats", stats)
@command("stats", help="メッセージの統計を表示")
async def stats_handler(event):
stats = sdk.storage.get("message_stats", {
"total": 0,
"by_user": {},
"by_day": {}
})
top_users = sorted(
stats["by_user"].items(),
key=lambda x: x[1],
reverse=True
)[:5]
top_text = "\n".join(
f"{uid}: {count} 件のメッセージ" for uid, count in top_users
)
await event.reply(f"総メッセージ数: {stats['total']}\n\n活発なユーザー:\n{top_text}")
検索機能
簡単な検索
注意:以下の例ではメモリ内のリストにメッセージ履歴を保存しています。アプリケーションの再起動後はデータが失われます。本番環境では、
sdk.storageまたは SQLite テーブルを使用して永続化を推奨します。
from ErisPulse.Core.Event import command, message
# メッセージ履歴を保存
message_history = []
@message.on_message()
async def store_handler(event):
"""メッセージを保存して検索可能にする"""
user_id = event.get_user_id()
text = event.get_text()
message_history.append({
"user_id": user_id,
"text": text,
"time": event.get_time()
})
# 履歴の数を制限
if len(message_history) > 1000:
message_history.pop(0)
@command("search", help="メッセージを検索")
async def search_handler(event):
args = event.get_command_args()
if not args:
await event.reply("検索キーワードを入力してください")
return
keyword = " ".join(args)
results = []
# 履歴を検索
for msg in message_history:
if keyword in msg["text"]:
results.append(msg)
if not results:
await event.reply("一致するメッセージが見つかりません")
return
# 結果を表示
result_text = f"{len(results)} 件の一致するメッセージが見つかりました:\n\n"
for i, msg in enumerate(results[:10], 1): # 最大10件表示
result_text += f"{i}. {msg['text']}\n"
await event.reply(result_text)
画像処理
画像のダウンロードと保存
from ErisPulse.Core import client
@message.on_message()
async def image_handler(event):
"""画像メッセージを処理"""
message_segments = event.get_message()
for segment in message_segments:
if segment.get("type") == "image":
file_url = segment.get("data", {}).get("file")
if file_url:
# SDKの内蔵クライアントを使って画像をダウンロードすることを推奨
resp = await client.get(file_url)
if resp.status == 200:
image_data = await resp.read()
# ファイルに保存
filename = f"images/{event.get_time()}.jpg"
with open(filename, "wb") as f:
f.write(image_data)
sdk.logger.info(f"画像を保存しました: {filename}")
await event.reply("画像を保存しました")
画像認識の例
注意:以下の例ではプレースホルダAPIアドレスを使用しています。実際の使用では、独自の画像認識サービスに置き換えてください。
from ErisPulse.Core import client
@command("identify", help="画像を認識")
async def identify_handler(event):
"""メッセージ内の画像を認識"""
message_segments = event.get_message()
for segment in message_segments:
if segment.get("type") == "image":
file_url = segment.get("data", {}).get("file")
# 画像認識APIを呼び出す
result = await _identify_image(file_url)
await event.reply(f"認識結果: {result}")
return
await event.reply("画像が見つかりません")
async def _identify_image(url):
"""画像認識APIを呼び出す (例) - SDKの内蔵クライアントを使用"""
resp = await client.post(
"https://api.example.com/identify",
json={"url": url}
)
data = await resp.json()
return data.get("description", "認識失敗")