Source code for jishaku.help_command

# -*- coding: utf-8 -*-

"""
jishaku.help_command
~~~~~~~~~~~~~~~~~~~~

HelpCommand subclasses with jishaku features

:copyright: (c) 2021 Devon (Gorialis) R
:license: MIT, see LICENSE for more details.

"""

import typing

from discord.ext import commands

from jishaku.paginators import PaginatorEmbedInterface, PaginatorInterface


[docs] class DefaultPaginatorHelp(commands.DefaultHelpCommand): """ A subclass of :class:`commands.DefaultHelpCommand` that uses a PaginatorInterface for pages. """ def __init__(self, **options: typing.Any): paginator = options.pop('paginator', commands.Paginator(max_size=1980)) super().__init__(paginator=paginator, **options)
[docs] async def send_pages(self): destination = self.get_destination() interface = PaginatorInterface(self.context.bot, self.paginator, owner=self.context.author) await interface.send_to(destination)
[docs] class DefaultEmbedPaginatorHelp(commands.DefaultHelpCommand): """ A subclass of :class:`commands.DefaultHelpCommand` that uses a PaginatorEmbedInterface for pages. """
[docs] async def send_pages(self): destination = self.get_destination() interface = PaginatorEmbedInterface(self.context.bot, self.paginator, owner=self.context.author) await interface.send_to(destination)
[docs] class MinimalPaginatorHelp(commands.MinimalHelpCommand): """ A subclass of :class:`commands.MinimalHelpCommand` that uses a PaginatorInterface for pages. """ def __init__(self, **options: typing.Any): paginator = options.pop('paginator', commands.Paginator(prefix=None, suffix=None, max_size=1980)) super().__init__(paginator=paginator, **options)
[docs] async def send_pages(self): destination = self.get_destination() interface = PaginatorInterface(self.context.bot, self.paginator, owner=self.context.author) await interface.send_to(destination)
[docs] class MinimalEmbedPaginatorHelp(commands.MinimalHelpCommand): """ A subclass of :class:`commands.MinimalHelpCommand` that uses a PaginatorEmbedInterface for pages. """
[docs] async def send_pages(self): destination = self.get_destination() interface = PaginatorEmbedInterface(self.context.bot, self.paginator, owner=self.context.author) await interface.send_to(destination)