Discord.pyのダイナミックアイテムでロールパネルを作る
discord.pyにv2.4で追加されたdiscord.ui.DynamicItemは便利ですよ、ということをボタン一つの簡易的なロールパネルを作ることで紹介します。
公式の使用例
概要
discord.pyにおいてcustom_idで処理を分岐しようと考えた場合、BOTが起動してから送信したviewに含まれるcustom_id(ランダムか自分で設定したか)か、BOTの起動時に登録された永続化してあるViewに含まれるcustom_idかを利用するしかありませんでした。
つまり、custom_idに情報を保存しようとした場合には、永続化したい場合を利用して、過去に送信したcustom_idを全て永続化したものとして登録する必要がありました。
DynamicItemは、これを処理したいcustom_idを正規表現で表すことで便利に使えるようにしました。
具体的には、ボタンなどを継承して処理を記述するのではなく、DynamicItemを正規表現を設定して継承し処理を記述するようにすることで、一つの正規表現とcustom_idで扱える情報であればまとめて扱うことができるようになっています。
実装
ここにある実装はgithubにもあります。
ダイナミックなボタン
ダイナミックなボタンは、DynamicItemを継承しつつ同時にtemplate="..."というように正規表現を与える必要があります。
また、__init__でsuper().__init__を呼び出す時には、ボタンのようなダイナミックにしたいアイテムを与える必要があります。
この場合であれば、custom_idをダイナミックアイテムの識別のためのプレフィックスにロールIDを16進数に直した文字列を付けたものとしたいので、templateをそれにマッチするように設定し、__init__ではそうなるようにButtonのcustom_idを作っています。
使いやすく渡されるのはマッチオブジェクトのため、templateには(?P<id>[0-9a-f]+)のようにIDの部分をグループにしています。
クラスメソッドとしてfrom_custom_idを実装する必要があります。
このクラスメソッドは、ボタンなどが押されたときに、そのcustom_idがtemplateにfullmatchを実行しマッチオブジェクトが帰ってきたときに、そのInteraction、押されたアイテム自体、そのマッチオブジェクトの三つが渡され、処理した後に自身を返す必要があります。
この場合であれば、__init__はラベルとロールidを要求しているので、itemのラベルとマッチオブジェクトからidの部分を抜き取って使っています。
ダイナミックなボタンが押されたりしたときには、そのcallbackまたは、__init__で与えたアイテムのcallbackが呼ばれます。
ダイナミックなボタンを使う
このダイナミックなボタンを使うには、まず、botにadd_dynamic_itemsを使って登録する必要があります。
登録されていれば、次のように普通のアイテムのように扱うことができます。
動作
この例の実装は、次のように使えます。
まずは、コマンドを実行してロールパネルを設定します。
例えば、次のようなコマンドは、
次のように表示され、
実際に使うと、このようになります。
終わりに
割と雑めではありますが、DynamicItemを使うと便利だよと言うのが伝わっていると嬉しいです。
なお、この記事のコードのライセンスは0BSDとします。
Discussion