bot.utils.shared.TF_emoji() - Code Metrics - Inspection of "Search state fix" - Competitive-Cyber-Clubs/Discord-Bot - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#50)

by Cyb3r

created 2021-06-13 15:37 UTC

bot.utils.shared.TF_emoji() A

↳ Parent: bot.utils.shared

Complexity

Conditions

Size

Total Lines	9
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	2
nop	1
dl	0
loc	9
rs	10
c	0
b	0
f	0

"""Shared functions between cogs and main program"""
import discord

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 table

    :param ctx:
    :type ctx: discord.ext.commands.Context
    :return: Message author is in bot_admins.
    :rtype: bool
    """
    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:
    """True or False emoji

    :param status: Return the true value emoji
    :type status: bool
    :return: Check mark or X
    :rtype str:
    """
    return ":white_check_mark:" if status else ":x:"


async def check_react(
    ctx, member: discord.Member, reaction: discord.Reaction, expected_react: str
) -> bool:
    """Check reaction

    Checks if the reaction on a message is correct and send by the same member that it was needed
        from.

    :param ctx: Message context
    :param member: Member who reacted to the message
    :type member: discord.Member
    :param reaction: Reaction that was added to the message
    :type reaction: discord.Reaction
    :param expected_react: String of wanted reaction
    :type expected_react: str
    :return: Correct reaction from the correct member.
    :rtype bool:
    """
    return member == ctx.author and str(reaction.emoji) == expected_react


1			"""Shared functions between cogs and main program"""
2			import discord
3
4			from .datahandler import fetch
5
6
7			class FailedReactionCheck(Exception):
8			"""FailedReactionCheck
9			---
10			Exception if react checks fail
11			"""
12
13
14			async def check_admin(ctx) -> bool:
15			"""Check Admin
16
17			Checks to see if message author is in bot_admins table
18
19			:param ctx:
20			:type ctx: discord.ext.commands.Context
21			:return: Message author is in bot_admins.
22			:rtype: bool
23			"""
24			return ctx.message.author.id in [int(user_id) for user_id in await fetch("bot_admins", "id")]
25
26
27			async def TF_emoji(status: bool) -> str:
28			"""True or False emoji
29
30			:param status: Return the true value emoji
31			:type status: bool
32			:return: Check mark or X
33			:rtype str:
34			"""
35			return ":white_check_mark:" if status else ":x:"
36
37
38			async def check_react(
39			ctx, member: discord.Member, reaction: discord.Reaction, expected_react: str
40			) -> bool:
41			"""Check reaction
42
43			Checks if the reaction on a message is correct and send by the same member that it was needed
44			from.
45
46			:param ctx: Message context
47			:param member: Member who reacted to the message
48			:type member: discord.Member
49			:param reaction: Reaction that was added to the message
50			:type reaction: discord.Reaction
51			:param expected_react: String of wanted reaction
52			:type expected_react: str
53			:return: Correct reaction from the correct member.
54			:rtype bool:
55			"""
56			return member == ctx.author and str(reaction.emoji) == expected_react
57

Competitive-Cyber-Clubs / Discord-Bot

Pull Request — master (#50)

bot.utils.shared.TF_emoji() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like