discord.py の Cog でコマンドをファイルごとに分ける方法
Bot の機能が増えてくると、main.py が何百行にもなって読みにくくなります。discord.py の「Cog(コグ)」を使うと、コマンドやイベントを機能ごとのファイルに分けて整理できます。このページでは、Cog の基本の書き方、読み込み方、スラッシュコマンドを Cog に書く方法、再起動せずに読み込み直す方法を説明します。
フォルダの構成
my-bot/
├── main.py
└── cogs/
├── general.py # あいさつなどの基本コマンド
├── moderation.py # 管理用コマンド
└── welcome.py # 参加時の処理
cogs フォルダの中に、機能ごとに1つずつファイルを作ります。
Cog ファイルの書き方
# cogs/general.py
import discord
from discord import app_commands
from discord.ext import commands
class General(commands.Cog):
def __init__(self, bot: commands.Bot):
self.bot = bot
@app_commands.command(name="ping", description="Bot の応答速度を表示します")
async def ping(self, interaction: discord.Interaction):
await interaction.response.send_message(f"Pong! {round(self.bot.latency * 1000)}ms")
@commands.Cog.listener()
async def on_message(self, message: discord.Message):
if message.author.bot:
return
if message.content == "おはよう":
await message.channel.send("おはようございます!")
async def setup(bot: commands.Bot):
await bot.add_cog(General(bot))
- スラッシュコマンドは
@app_commands.command、プレフィックスコマンドは@commands.command - イベントは
@bot.eventではなく@commands.Cog.listener() - 関数の最初の引数に
selfが入る - ファイルの最後に
async def setup(bot)が必須
main.py で読み込む
# main.py
import os
import discord
from discord.ext import commands
class MyBot(commands.Bot):
def __init__(self):
intents = discord.Intents.default()
intents.message_content = True
super().__init__(command_prefix="!", intents=intents)
async def setup_hook(self):
for file in os.listdir("./cogs"):
if file.endswith(".py"):
await self.load_extension(f"cogs.{file[:-3]}")
await self.tree.sync()
bot = MyBot()
bot.run(os.environ["DISCORD_TOKEN"])
setup_hook は Bot がログインする前に1回だけ呼ばれるので、Cog の読み込みとコマンドの同期をまとめて書くのに向いています。
load_extension には「ファイルのパス」ではなく「モジュール名」を渡します。cogs/general.py なら "cogs.general" です。再起動せずに読み込み直す
開発中は、Cog だけ読み込み直すと Bot を止めずに変更を反映できます。
@bot.command()
@commands.is_owner()
async def reload(ctx, name: str):
await bot.reload_extension(f"cogs.{name}")
await ctx.send(f"{name} を読み込み直しました")
!reload general のように使います。誰でも使えると危ないので、is_owner() で Bot の持ち主だけに制限しています。
よくあるエラー
ExtensionFailed / NoEntryPointError
Cog ファイルに async def setup(bot) がないか、ファイルの中でエラーが起きています。エラーの下に出る詳しいメッセージを確認しましょう。
ExtensionNotFound
モジュール名が違うか、実行している場所に cogs フォルダがありません。サーバーで動かす場合は、main.py と同じ階層に cogs フォルダがあるか確認します。
RuntimeWarning: coroutine 'Bot.load_extension' was never awaited
discord.py 2.x では load_extension と add_cog は await が必要です。1.x の古い記事のコードをそのまま使うとこのエラーになります。
まとめ
- 機能ごとに
cogs/にファイルを分け、commands.Cogを継承したクラスで書く - 各ファイルの最後に
async def setup(bot)を書く setup_hookでawait load_extension()してまとめて読み込む
Discord Bot を、月 ¥180 で24時間。
支払い後およそ2分で、日本のサーバーが自動で用意されます。 プランを見る →ほかのガイド
discord.py で定期実行する方法|tasks.loop で毎日・毎時の自動投稿discord.py の tasks.loop で、一定間隔・毎日決まった時刻(日本時間)に処理を実行する方法と、開始・停止、エラー時の対処、よくある失敗を解説します。読む →
Discord Bot でデータを保存する方法|SQLite でポイント・レベル機能を作る再起動しても消えないデータを、SQLite(aiosqlite)で Discord Bot に保存する方法を解説。ポイント機能・ランキングのサンプルコードと、サーバーでの注意点を紹介します。読む →
discord.py でチケット(お問い合わせ)機能を作る方法ボタンを押すと本人とスタッフだけが見える専用チャンネルが作られる、チケット機能の作り方を discord.py のサンプルコード付きで解説します。読む →
discord.py で NG ワード削除・スパム対策・タイムアウトを作る方法discord.py で NG ワードを含むメッセージの自動削除、連投スパムの検知、タイムアウトを作る方法と、Discord 標準の AutoMod との使い分けを解説します。読む →
Discord Bot のステータス(プレイ中・視聴中)を表示・変更する方法discord.py で Bot の「○○をプレイ中」などのステータスを設定する方法、オンライン状態の変え方、導入サーバー数を表示して定期的に切り替える方法を解説します。読む →
Discord Bot がメッセージを読めない?Message Content Intent の設定方法コマンドに反応しない・message.content が空になる原因は Message Content Intent。Discord Developer Portal とコード(discord.py)の両方で有効にする手順を解説します。読む →