Pythonで始める録音機能付きDiscord Bot: (3) Databaseとの連携

# はじめに

この記事は前回[Pythonで始める録音機能付きDiscord Bot: (2) 便利機能(Bot拡張,Cog,Embed)](https://qiita.com/Shirataki2/items/9bdc62548e7b24d3c803)の続きです．

本記事では，Botが大規模になるにつれて必要となるであろうデータベースとの連携を行います．データベースを利用してサーバーごとに接頭文字を変える機能`$prefix`を実装します．

全7回を予定しており現在5記事まで執筆を終えています．

1. [Pythonで始める録音機能付きDiscord Bot: (1) 入門 discord.py](https://qiita.com/Shirataki2/items/3b9f9766bc25bb204ed3)
2. [Pythonで始める録音機能付きDiscord Bot: (2) 便利機能(Bot拡張,Cog,Embed)](https://qiita.com/Shirataki2/items/9bdc62548e7b24d3c803)
3. [Pythonで始める録音機能付きDiscord Bot: (3) Databaseとの連携](https://qiita.com/Shirataki2/items/37d48868cd7b999a13b2)
4. [Pythonで始める録音機能付きDiscord Bot: (4) 音楽ファイルを再生する](https://qiita.com/Shirataki2/items/f4ea533d5baf55c4b1d3)
5. [Pythonで始める録音機能付きDiscord Bot: (5) Discord APIを直接操作する](https://qiita.com/Shirataki2/items/58480517365a46922f45)

# 環境変数を利用する

ここまで，Botのトークンはソースコード内にべた張りしていましたがこれでは，GitHub等で第三者と共有したいときにきわめて不便です．なので，Docker Composeの機能を使いこれらを環境変数としてまとめます．

まずは，プロジェクトルートに`.env`というファイルを作り，そこに環境変数を登録します．

```sh:./.env
BOT_TOKEN=NDIAHJffoaj.adwdeg....
```

ここでは`BOT_TOKEN=トークン`としています．こうして登録された環境変数をDockerコンテナ上で利用可能にするためには`docker-compose.dev.yml`を編集します．

```yml:./docker-compose.dev.yml
version: "3.8"
services: 
  dbot:
    build:
      context: ./src
      dockerfile: dev.dockerfile
    tty: true
    working_dir: /bot/app
    entrypoint: bash ./entrypoint.dev.sh
    env_file: # この行と
      - .env  # この行
    volumes:
      - ./src:/bot
```

`env_file`に先ほどのファイルへのパスを渡すことで作成した環境変数がコンテナに渡されます．

そして，いままで直打ちしていた`__main__.py`のトークン部分を以下のように変更します．

```python:./src/app/dbot/__main__.py
from dbot.core.bot import DBot
import os
DBot(os.environ["BOT_TOKEN"]).run()
```

これで知られたくない環境変数などの情報を別ファイルのまとめることで，このファイルのみ第三者に非公開の形式でアップロードすることで目的が達成されるようになりました．例えばこの`.env`をGitHubにプッシュしたくなければ新たに`.gitignore`というファイルを作成し，`.env`を追加することでGitの監視対象にならずリモートにもプッシュされません．

```:.gitignore
.env
```

コンテナを再起動し，正常に起動できていたら成功です．環境変数ファイルを編集した場合，反映されるのはコンテナの再起動後となるので注意してください．

# データベースを利用しよう

Botが複雑になるにつれてサーバーごとに何かしらのデータを保存し，それを活用できるようにしたいといった場合が出てくることでしょう．それを実現する手段として，例えばCSVファイルを用意してそれを直書きするといった方法が考えられますが，ユーザからのリクエストが非同期的に来ることを考えると色々問題があります．そこで今回はデータベースを利用してデータを保存するようにしてみましょう．

## データベースの作成

ここではMySQLを利用しますが，お気に入りのデータベースエンジンが別にあれば何でもOKです．MySQLサービスもDockerコンテナとして立ててしまいましょう．`docker-compose.dev.yml`を以下のように編集します．以下の書き方は[この記事](https://qiita.com/A-Kira/items/f401aea261693c395966#1-docker-composeyml-%E4%BD%9C%E6%88%90)に倣って書いています．`.gitignore`を作成している方は`/db`を除外するようにします．

```yml:./docker-compose.dev.yml
version: "3.8"
services: 
  dbot:
    # 略
  mysql:
    image: mysql:8.0
    restart: always
    env_file: 
      - .env
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    volumes:
      - ./db/data:/var/lib/mysql
      - ./db/my.cnf:/etc/mysql/conf.d/my.cnf
      - ./db/sql:/docker-entrypoint-initdb.d
```

先ほどの記事にあるようにMySQLのコンテナは環境変数に初めに作成するデータベースの名前や，ユーザーのパスワードを入力する必要があるためそれらをまとめて`.env`に記述します．

```sh:./.env
BOT_TOKEN=...
MYSQL_ROOT_PASSWORD=supersecret
MYSQL_USER=docker
MYSQL_DATABASE=discord
MYSQL_PASSWORD=veryverysecret
```

ここまで作成し終えたら，`./run.sh dev down`と`./run.sh dev up -d mysql`を打ってデータベースだけ起動させておくようにしましょう．

データベースを操作するためにはSQLを操らなければいけませんが，極力データベースのスキーマだけを定義しマイグレーション作業などは自動で行った方が楽でしょう．

## ORMとMigrationを使うには...

そこで今回はSQLのオブジェクト関係マッピング(**ORM**)であるSQLAlchemyを利用します．そして，SQLAlchemyを動かすにはデータベースを操作するクライアントが必要となりますが，ここでは**非同期でノンブロッキング**という要件を満たすクライアントであるaiomysqlを使用します．

そして，データベースのマイグレーションツールとしてPythonで書かれたAlembicを使用します．これら三者をまずはインストールします．

`./src/app`で

```sh
$ pipenv install sqlalchemy aiomysql
$ pipenv install alembic --dev
```

を実行します．

インストール後，`./src/app/dbot/models`フォルダを作成し以下のファイルを作成します．

- `__init__.py`
- `model.py`

`model.py`を以下のように編集します．

```python
from sqlalchemy import MetaData, Table, Column, BigInteger, String


meta = MetaData()

guild = Table(
    "guild",
    meta,
    Column("id", BigInteger(), nullable=False, primary_key=True),
    Column("prefix", String(8), server_default="$", nullable=False)
)
```

SQLAlchemy独特の文法ですがTableとColumnを組み合わせて一つのテーブルを定義しています．Tableの第一引数にはテーブル名，第三引数以降はテーブルの列情報を記しているのですが，第二引数のmetaの正体はなにかというとデータベースの定義情報がすべて格納されている変数に相当します．このmetaを外部に渡すことでSQLAlchemyで作成したデータベースの情報を利用できるようになります．

ここで作成したテーブルは，サーバーごとに接頭文字(`$`)を変えるためのテーブルです．

Alembicではこのmetaをもとにデータベースのマイグレーションを行います．すなわち，新たなテーブルを作成したい際，開発者はSQLを使って直にテーブルを作る必要がなく，スキーマの定義に専念できるようになります．

Alembicを利用するためには`alembic init`コマンドを打って初期設定を行う必要があります．`./src/app/alembic`フォルダを作成し，`alembic init .`をそのフォルダ内で実行すると様々なファイルが生成されます．

編集するファイルはその中のうち`env.py`と`alembic.ini`です．`alembic.ini`は以下のように`mysql+pymysql://ユーザー名:パスワード@データベースのコンテナ名/データベース名`という形式で指定します．


```ini:./src/app/alembic/alembic.ini
# A generic, single database configuration.

[alembic]

# 略

# the output encoding used when revision files
# are written from script.py.mako
# output_encoding = utf-8

sqlalchemy.url = mysql+pymysql://docker:veryverysecret@mysql/discord

# 略
```

`env.py`は先ほどのmetaをインポートする必要があるのですが，dbotまでのパスは親ディレクトリあるので以下のように編集します

```python:./src/app/alembic/env.py
from logging.config import fileConfig

from sqlalchemy import engine_from_config
from sqlalchemy import pool

from alembic import context

## 以下を追加 ##

import sys
import os

sys.path.append(os.pardir)

from dbot.models.model import meta

## ここまで ##

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config

# 略

## この値を変更する
target_metadata = meta

# 略
```

こうしたうえで`alembic`フォルダ上で`alembic revision -m "Init"`のように実行すると`versions`フォルダ下に，metaを読み込んだ結果生成されたスキーマファイルが作成されます．

これを既存のデータベースにマイグレーションすればよいのですがそのためのコマンドは`alembic upgrade head`です．これらのコマンドを実行するために`entrypoint.dev.sh`を編集します．

```sh:./src/app/entrypoint.dev.sh
set -eu
cd alembic
alembic upgrade head
alembic revision --autogenerate
alembic upgrade head
cd ..
nodemon --signal SIGINT -e py,ini --exec python -m dbot
```

最後に`dev.dockerfile`の最終行で`alembic`のインストールを行います．

```dockerfile:./src/dev.dockerfile
# 前略
RUN pip install alembic
```

これでようやく準備が完了です．Dockerコンテナを起動するごとに，マイグレーションが実行されるようになります．

スキーマ変更を自動感知するようにできたので，これらを今度はBotから利用できるようにしましょう．

## DBotとMySQLの橋渡し

データベースと接続するためのクラスを定義するため，`./src/app/dbot/db.py`を作成します．

```python:./src/app/dbot/db.py
import os
import asyncio
from aiomysql.sa import create_engine


class DB:
    async def __aenter__(self, loop=None):
        if loop is None:
            loop = asyncio.get_event_loop()
        engine = await create_engine(
            user=os.environ["MYSQL_USER"],
            db=os.environ["MYSQL_DATABASE"],
            host="mysql",
            password=os.environ["MYSQL_PASSWORD"],
            charset="utf8",
            autocommit=True,
            loop=loop
        )
        self._connection = await engine.acquire()
        return self

    async def __aexit__(self, *args, **kwargs):
        await self._connection.close()

    async def execute(self, query, *args, **kwargs):
        return await self._connection.execute(query, *args, **kwargs)
```

以上の実装は[こちらの記事](https://qiita.com/halhorn/items/eb2951a024ae255e6a21#aiomysql-%E3%82%A8%E3%83%B3%E3%82%B8%E3%83%B3%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E5%AE%9F%E9%9A%9B%E3%81%AB%E5%AE%9F%E8%A1%8C%E3%81%99%E3%82%8B)を参考にしています．見慣れない`__aenter__`などというコルーチンは`with`とともに利用されます．aenterは`a`(=async)+`enter`という意味になるので，このデータベースに対する接続を得るためには

```python
async with DB() as db:
    db.execute("クエリ")
```

のようにすることで利用ができるようになります．

## SQLなど触りとうない

最後に，いくらORMとはいえ極力SQLなんてものは書きたくありません．そこで，テーブルごとにデータのCRUD(作成/取得/更新/削除)ができるようなクラスを作成します．`./src/app/dbot/models/guild.py`を作り以下のように編集します．

```python:./src/app/dbot/models/guild.py
from dbot.models import model
from dbot.db import DB


class CRUDBase:
    @staticmethod
    async def execute(query, *args, **kwargs):
        async with DB() as db:
            result = await db.execute(query, *args, **kwargs)
        return result


class Guild(CRUDBase):
    def __init__(self, guild_id):
        self.guild_id = guild_id

    async def get(self):
        q = model.guild.select().where(self.guild_id == model.guild.c.id)
        result = await self.execute(q)
        return await result.fetchone()

    async def set(self, **kwargs):
        q = model.guild.update(None).where(
            self.guild_id == model.guild.c.id
        ).values(**kwargs)
        await self.execute(q)
        return self

    async def delete(self):
        q = model.guild.delete(None).where(self.guild_id == model.guild.c.id)
        await self.execute(q)
        return self

    @classmethod
    async def create(cls, guild_id):
        q = model.guild.insert(None).values(id=guild_id)
        guild = cls(guild_id)
        await cls.execute(q)
        return guild

    @staticmethod
    async def get_all(cls):
        q = model.guild.select()
        results = await cls.execute(q)
        return await results.fetchall()
```

SQLAlchemyのクエリの書き方の説明はこの記事の範疇外ですので省略しますが，SQLに似た文法でクエリを書くことができます．

これで開発中はいちいちSQLのことを気にせず`await Guild(guild.id).get()`のようにすれば，データベースから情報を取り出せるようになります．

## $prefixコマンドを実装

あらためて，接頭文字を変更するためには以下の手順を踏みます．

1. [大前提]サーバーごとに接頭文字を変えられる仕様に変更する
2. サーバーがBotを追加した際にテーブル"guild"に(サーバーID, "$")というレコードを追加する
3. `$prefix >`のようなコマンド来た際にテーブル"guild"を変更する

サーバーごとに接頭文字を変える方法ですが，これは今までBotの`__init__`内で`command_prefix`で直に"$"と渡していた部分を`None`に変更し別途`get_prefix`というコルーチンを作成します．discord.pyはメッセージが打たれるごとにこのget_prefixをチェックするのでそこでサーバーのIDを取得しデータベースから情報を取得すればよいのです．

サーバーがBotを追加したイベントを受け取るためには前回紹介したイベントハンドラ`on_guild_join`を定義すればよいのでした．これらを考慮すると`./src/app/dbot/core/bot.py`は以下のように変更できます．

```python:./src/app/dbot/core/bot.py
import discord
from discord.ext import commands
from dbot.models.guild import Guild
import traceback


class DBot(commands.Bot):
    def __init__(self, token):
        self.token = token
        super().__init__(command_prefix=None)
        self.load_cogs()

    async def get_prefix(self, message: discord.Message):
        guild = await Guild(message.guild.id).get()
        if guild:
            print("サーバー:", message.guild.name)
            print("接頭文字:", guild.prefix)
            return guild.prefix
        else:
            guild = await Guild.create(message.guild.id)
            guild = await guild.get()
            print("サーバー:", message.guild.name)
            print("接頭文字:", guild.prefix)
            return guild.prefix

    async def on_guild_join(self, guild: discord.Guild):
        guild = await Guild.create(guild.id)
        guild = await guild.get()
        print("サーバー:", guild.name)
        print("接頭文字:", guild.prefix)
   
   # 略
```

行っていることは単純で，サーバーIDをもとにレコードの取得と挿入を行っています．

あとはコマンド`$prefix`を実装するだけです．`Utils`というCogを作成しそこに`$prefix`を定義することにします．

```python:./src/app/cogs/Utils.py
import discord
from discord.ext import commands
from discord.ext.commands.errors import (
    MissingPermissions,
    MissingRequiredArgument
)
import random
from dbot.core.bot import DBot
from dbot.models.guild import Guild


class Utils(commands.Cog):
    def __init__(self, bot: DBot):
        self.bot = bot

    @commands.command(ignore_extra=False)
    @commands.has_permissions(administrator=True)
    async def prefix(self, ctx: commands.Context, *, prefix: str):
        if len(prefix) > 8:
            return await ctx.send("Prefixは8文字以内である必要があります")
        guild = await Guild(ctx.guild.id).get()
        await Guild(ctx.guild.id).set(prefix=prefix)
        await ctx.send(f"Prefixを{guild.prefix}から{prefix}に変更しました")

    @prefix.error
    async def on_prefix_error(self, ctx: commands.Context, error):
        if isinstance(error, MissingPermissions):
            return await ctx.send('管理者のみが実行可能です')
        if isinstance(error, MissingRequiredArgument):
            return await ctx.send('引数は新しいPrefixを8文字以内で渡してください')
        raise error


def setup(bot):
    return bot.add_cog(Utils(bot))
```

これでprefixが変更可能になりました:tada:

[![Image from Gyazo](https://i.gyazo.com/47cfc4232a74bb60e9ed76fba27dfc13.png)](https://gyazo.com/47cfc4232a74bb60e9ed76fba27dfc13)

prefixコマンドの引数に着目すると，第三引数にあたる位置に`*`がありますが，これも[Pythonの文法のひとつです](https://qiita.com/LouiS0616/items/1bbe0a9bb93054f6c380#%E3%82%A2%E3%82%B9%E3%82%BF%E3%83%AA%E3%82%B9%E3%82%AF--%E4%BB%AE%E5%BC%95%E6%95%B0%E5%90%8D%E3%83%8A%E3%82%B7)．discord.pyではこの`*`を利用することで以下のような振る舞いになります．

[![Image from Gyazo](https://i.gyazo.com/73a77bf86f6da4b8747095ec20ecdf93.png)](https://gyazo.com/73a77bf86f6da4b8747095ec20ecdf93)

この通り，空白が間にあろうともそれら一帯を一つの引数と見なします．

参考: https://discordpy.readthedocs.io/ja/latest/ext/commands/commands.html#keyword-only-arguments

# 終わりに

これでデータベースと接続してより複雑なコマンドが作れるようになりました．

次回は音声の**送信**機能を実装します．