Discord.py 的简单分页包装器

在进行 Discord Bot 开发的时候，经常会需要分页展示一些数据，比如分页展示查询到的数据结果。discord.py 提供了一个很方便的分页包装器 Paginator，接下来我们就来一步步了解如何使用 discord.py 的 Paginator。

Paginator 初步

首先，我们需要导入 Paginator：

from discord.ext import commands
from discord.ext.commands import Paginator

定义一个包含多个元素的 list：

data = ["1", "2", "3", "4", "5", "6", "7", "8", "9", "10"]

初始化 Paginator：

paginator = Paginator(prefix='', suffix='', max_size=2000)

我们定义了一个长度为 0 的分页器，并设置了 prefix、suffix 和 max_size。prefix 和 suffix 用来给所有页面添加同样的首部/尾部，比如我们可以在 prefix 中添加 “这是我的查询结果：”，在 suffix 中添加 “查询完毕！”等等。max_size 表示每一页最大的字节数，这个参数可以不用填，设为 None 即可。

往 paginator 中添加元素：

for elem in data:
    paginator.add_line(elem)

通过 add_line() 方法往 paginator 中添加元素，这个元素可以是任意的类型。add_line() 方法将保证每一页的长度不超过 max_size 界限。

将 paginator 转成页码列表：

pages = []
for page in paginator.pages:
    pages.append(page)

此时，变量 pages 中存放的就是 paginator 的分页结果，每一个分页中的内容都被存储在这个列表中。

发送分页消息

最后，我们可以将分页结果发送给 Discord 服务器，使其显示为用户可翻页的消息：

for page in pages:
    await ctx.send(page)

这里，我们使用 ctx.send() 方法将分页结果发送给 Discord，通过多组数据进行分页展示，用户可以在消息上翻页查看所有数据。

到此为止，discord.py 的简单分页包装器 Paginator 就介绍完了。除了上述介绍的方法，Paginator 还有很多其他的可用方法可以帮你完成更为复杂的分页逻辑。具体可参考 discord.py 的官方文档。

参考文献：

1. discord.py 官方文档。链接：https://discordpy.readthedocs.io/en/latest/ext/commands/api.html#discord.ext.commands.Paginator