help.py

""""
Samuro Bot

Автор: *fennr*
github: https://github.com/fennr/Samuro-HotsBot

Бот для сообществ по игре Heroes of the Storm

"""

import discord
from discord.ext import commands
from discord.errors import Forbidden
from utils import library
from utils.classes.Const import config

"""This custom help command is a perfect replacement for the default one on any Discord Bot written in Discord.py!
However, you must put "bot.remove_command('help')" in your bot, and the command must be in a cog for it to work.
Original concept by Jared Newsom (AKA Jared M.F.)
[Deleted] https://gist.github.com/StudioMFTechnologies/ad41bfd32b2379ccffe90b0e34128b8b
Rewritten and optimized by github.com/nonchris
https://gist.github.com/nonchris/1c7060a14a9d94e7929aa2ef14c41bc2
You need to set three variables to make that cog run.
Have a look at line 51 to 57
"""

async def send_embed(ctx, embed):
    """
    Function that handles the sending of embeds
    -> Takes context and embed to send
    - tries to send embed in channel
    - tries to send normal message when that fails
    - tries to send embed private with information abot missing permissions
    If this all fails: https://youtu.be/dQw4w9WgXcQ
    """
    try:
        await ctx.send(embed=embed)
    except Forbidden:
        try:
            await ctx.send("Hey, seems like I can't send embeds. Please check my permissions :)")
        except Forbidden:
            await ctx.author.send(
                f"Hey, seems like I can't send any message in {ctx.channel.name} on {ctx.guild.name}\n"
                f"May you inform the server team about this issue? :slight_smile: ", embed=embed)


def white_list(ctx) -> list:
        admin_list = [
            'Team',
            'News',
        ]
        white_list = [
            'Help',
            'Hots',
            'Heroes',
            'Profile',
            'Stats',
            'Voice'
        ]
        if library.get.author_id(ctx) in config.owners:
            return white_list + admin_list
        else:
            return white_list


class Help(commands.Cog):
    """
    — Выдаст текущую справку
    """

    def __init__(self, bot):
        self.bot = bot

    @commands.command()
    # @commands.bot_has_permissions(add_reactions=True,embed_links=True)
    async def help(self, ctx, *input):
        """Shows all modules of that bot"""

        # !SET THOSE VARIABLES TO MAKE THE COG FUNCTIONAL!
        prefix = config.bot_prefix  # ENTER YOUR PREFIX - loaded from config, as string or how ever you want!
        version = config.version  # enter version of your code

        # setting owner name - if you don't wanna be mentioned remove line 49-60 and adjust help text (line 88)
        owner = config.owners[0]  # ENTER YOU DISCORD-ID
        owner_name = "fenrir#5455"  # ENTER YOUR USERNAME#1234

        # checks if cog parameter was given
        # if not: sending all modules and commands not associated with a cog
        if not input:
            # checks if owner is on this server - used to 'tag' owner
            try:
                owner = ctx.guild.get_member(owner).mention

            except AttributeError as e:
                owner = owner_name

            # starting to build embed
            emb = discord.Embed(title='Команды и модули', color=discord.Color.blue(),
                                description=f'Используй `{prefix}help <модуль>` чтобы получить больше информации '
                                            f'об этом модуле\n')


            # iterating trough cogs, gathering descriptions
            cogs_desc = ''
            for cog in self.bot.cogs:
                if cog in white_list(ctx):
                    if self.bot.cogs[cog].__doc__ is not None:
                        cogs_desc += f'`{cog}` {self.bot.cogs[cog].__doc__[2:]}\n'

            # adding 'list' of cogs to embed
            emb.add_field(name='Модули', value=cogs_desc, inline=False)

            # integrating trough uncategorized commands
            commands_desc = ''
            for command in self.bot.walk_commands():
                # if cog not in a cog
                # listing command if cog name is None and command isn't hidden
                if not command.cog_name and not command.hidden:
                    commands_desc += f'{command.name} - {command.help}\n'
                    print(commands_desc)

            # adding those commands to embed
            if commands_desc:
                emb.add_field(name='Не пренадлежит модулю', value=commands_desc, inline=False)

            # setting information about author
            emb.add_field(name="About",
                          value=f"Самуро разработан __{owner}__\n"
                                f"Добавить к себе на сервер можно кликнув по аватарке и нажав 'Добавить на сервер'")
            emb.set_footer(text=f"Текущая версия: {version}")

        # block called when one cog-name is given
        # trying to find matching cog and it's commands
        elif len(input) == 1:

            # iterating trough cogs
            for cog in self.bot.cogs:
                # check if cog is the matching one
                if cog.lower() == input[0].lower():

                    # making title - getting description from doc-string below class
                    emb = discord.Embed(title=f'{cog} - Команды', description=self.bot.cogs[cog].__doc__,
                                        color=discord.Color.green())

                    # getting commands from cog
                    for command in self.bot.get_cog(cog).walk_commands():
                        # if cog is not hidden
                        if not command.hidden and command.help is not None:
                            emb.add_field(name=f"`{prefix}{command.qualified_name} {command.signature}`", value=command.help, inline=False)
                    # found cog - breaking loop
                    break

            # if input not found
            # yes, for-loops have an else statement, it's called when no 'break' was issued
            else:
                emb = discord.Embed(title="Это что такое?!",
                                    description=f"Я никогда раньше не слышал о модуле `{input[0]}` :scream:",
                                    color=discord.Color.orange())

        # too many cogs requested - only one at a time allowed
        elif len(input) > 1:
            emb = discord.Embed(title="Это слишком",
                                description="Пожалуйста, запросите только один модуль",
                                color=discord.Color.orange())

        else:
            emb = discord.Embed(title="Магическое сообщение.",
                                description="Я не знаю как вы здесь оказались, но я этого не ожидал\n"
                                            "Пожалуйста свяжитесь со мной и опишите ошибку\n"
                                            "Discord: _fenrir#5455_\n"
                                            "Спасибо!",
                                color=discord.Color.red())

        # sending reply embed using our own function defined above
        await send_embed(ctx, emb)


def setup(bot):
    bot.add_cog(Help(bot))