utils.shared.check_react() - Code Metrics - Inspection of "v0.1.1 Update (#5)" - Competitive-Cyber-Clubs/Discord-Bot - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e17e00...ecdb37 )

by Cyb3r

created 2020-06-28 20:06 UTC

utils.shared.check_react() A

↳ Parent: utils.shared

Complexity

Conditions

Size

Total Lines	18
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

"""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.
    """
    returned = [int(user_id) for user_id in await fetch("bot_admins", "id")]
    return ctx.message.author.id in returned


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 -- String value of emoji


    Returns:
        str -- either a check mark or x emoji
    """
    if status:
        return ":white_check_mark:"
    return ":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


1			"""Shared functions between cogs and main program"""
2			from .datahandler import fetch
3
4
5			class FailedReactionCheck(Exception):
6			"""FailedReactionCheck
7			---
8			Exception if react checks fail
9			"""
10
11
12			async def check_admin(ctx) -> bool:
13			"""check_admin
14			---
15			Checks to see if message author is in bot_admins
16
17			Arguments:
18			---
19			ctx {discord.ext.commands.Context} -- Context of which the check was called.
20
21			Returns:
22			---
23			bool -- Returns 'TRUE' if the message author is in bot_admins.
24			"""
25			returned = [int(user_id) for user_id in await fetch("bot_admins", "id")]
26			return ctx.message.author.id in returned
27
28
29			async def TF_emoji(status: bool) -> str:
30			"""TF_emoji
31
32			Returns string for emoji for true false.
33
34			Arguments:
35			---
36			status {bool} -- If the value is true
37			Returns
38			---
39			str -- String value of emoji
40
41
42			Returns:
43			str -- either a check mark or x emoji
44			"""
45			if status:
46			return ":white_check_mark:"
47			return ":x:"
48
49
50			async def check_react(ctx, user, reaction, expected_react: str):
51			"""check_reach
52			---
53			Checks if the reaction on a message is correct and send by the same user that it was needed
54			from.
55
56			Arguments:
57			---
58			ctx {discord.ext.commands.Context} -- Context of which the check was called.
59			user {discord.User} -- User the reacted to the message
60			reaction {discord.Reaction} -- The reaction that was added to the message
61			expected_react {str} -- The desired reaction.
62
63			Returns:
64			---
65			bool -- Return 'TRUE' if it was the correct reaction from the correct user.
66			"""
67			return user == ctx.author and str(reaction.emoji) == expected_react
68

Competitive-Cyber-Clubs / Discord-Bot

Push — master ( e17e00...ecdb37 )

utils.shared.check_react() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like