bot.utils.shared

Complexity

Total Complexity

4

Size/Duplication

Total Lines	61
Duplicated Lines	0 %

Importance

Changes

0

3 Functions

Rating	Name	Duplication	Size	Complexity
A	TF_emoji()	0	13	2
A	check_react()	0	18	1
A	check_admin()	0	14	1

"""Shared functions between cogs and main program"""
from .datahandler import fetch


class FailedReactionCheck(Exception):
    """FailedReactionCheck
    ---
    Exception if react checks fail
    """


async def check_admin(ctx) -> bool:
    """check_admin
    ---
    Checks to see if message author is in bot_admins

    Arguments:
    ---
        ctx {discord.ext.commands.Context} -- Context of which the check was called.

    Returns:
    ---
        bool -- Returns 'TRUE' if the message author is in bot_admins.
    """
    return ctx.message.author.id in [int(user_id) for user_id in await fetch("bot_admins", "id")]


async def TF_emoji(status: bool) -> str:
    """TF_emoji

    Returns string for emoji for true false.

    Arguments:
    ---
        status {bool} -- If the value is true

    Returns:
        str -- either a check mark or x emoji
    """
    return ":white_check_mark:" if status else ":x:"


async def check_react(ctx, user, reaction, expected_react: str):
    """check_reach
    ---
    Checks if the reaction on a message is correct and send by the same user that it was needed
        from.

    Arguments:
    ---
        ctx {discord.ext.commands.Context} -- Context of which the check was called.
        user {discord.User} -- User the reacted to the message
        reaction {discord.Reaction} -- The reaction that was added to the message
        expected_react {str} -- The desired reaction.

    Returns:
    ---
        bool -- Return 'TRUE' if it was the correct reaction from the correct user.
    """
    return user == ctx.author and str(reaction.emoji) == expected_react