Skip to content

Utility functions

ballsdex.core.utils.utils

can_mention 

can_mention(players: list[Player]) -> AllowedMentions
Source code in ballsdex/core/utils/utils.py 
104
105
106
107
108
109
async def can_mention(players: List[Player]) -> discord.AllowedMentions:
    can_mention = []
    for player in players:
        if player.can_be_mentioned:
            can_mention.append(discord.Object(id=player.discord_id))
    return discord.AllowedMentions(users=can_mention, roles=False, everyone=False)

inventory_privacy 

inventory_privacy(bot: BallsDexBot, interaction: Interaction[BallsDexBot], player: Player, user_obj: User | Member)

Check if the inventory of a user is viewable in the given context. If not, a followup response will be sent with a proper message.

Parameters:

  • bot (BallsDexBot) –

    Bot object

  • interaction (Interaction[BallsDexBot]) –

    Interaction of the command.

  • player (Player) –

    Ballsdex Player object of the user whose inventory is being inspected.

  • user_obj (User | Member) –

    Discord user object of the user whose inventory is being inspected.

Returns:

  • bool –

    True if the inventory can be viewed, else False. If this is False, you should exit the command.

Source code in ballsdex/core/utils/utils.py 
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
async def inventory_privacy(
    bot: "BallsDexBot",
    interaction: discord.Interaction["BallsDexBot"],
    player: Player,
    user_obj: Union[discord.User, discord.Member],
):
    """
    Check if the inventory of a user is viewable in the given context. If not, a followup response will be sent with a
    proper message.

    Parameters
    ----------
    bot: BallsDexBot
        Bot object
    interaction: Interaction[BallsDexBot]
        Interaction of the command.
    player: Player
        Ballsdex Player object of the user whose inventory is being inspected.
    user_obj: discord.User | discord.Member
        Discord user object of the user whose inventory is being inspected.

    Returns
    -------
    bool
        [`True`][] if the inventory can be viewed, else [`False`][].
        If this is [`False`][], you should exit the command.
    """
    privacy_policy = player.privacy_policy
    interacting_player, _ = await Player.objects.aget_or_create(discord_id=interaction.user.id)
    if interaction.user.id == player.discord_id:
        return True
    if await is_staff(interaction):
        if settings.inv_privacy_bypass_ids and interaction.channel_id in settings.inv_privacy_bypass_ids:
            return True

    if privacy_policy == PrivacyPolicy.DENY:
        await interaction.followup.send("This user has set their inventory to private.", ephemeral=True)
        return False
    elif privacy_policy == PrivacyPolicy.FRIENDS:
        if not await interacting_player.is_friend(player):
            await interaction.followup.send(
                "This users inventory can only be viewed from users they have added as friends.", ephemeral=True
            )
            return False
    elif privacy_policy == PrivacyPolicy.SAME_SERVER:
        if not bot.intents.members:
            await interaction.followup.send(
                "This user has their policy set to `Same Server`, "
                "however I do not have the `members` intent to check this.",
                ephemeral=True,
            )
            return False
        if interaction.guild is None:
            await interaction.followup.send("This user has set their inventory to private.", ephemeral=True)
            return False
        elif interaction.guild.get_member(user_obj.id) is None:
            await interaction.followup.send("This user is not in the server.", ephemeral=True)
            return False
    return True

is_staff 

is_staff(interaction: Interaction[BallsDexBot], *perms: str) -> bool

Checks if an interacting user checks one of the following conditions:

  • The user is a bot owner
  • The user has a role considered root or admin

Parameters:

  • interaction (Interaction[BallsDexBot]) –

    The interaction of the user to check.

  • perms (str, default: () ) –

    Django permissions to verify. If empty, only staff status will be checked.

Returns:

Source code in ballsdex/core/utils/utils.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
async def is_staff(interaction: discord.Interaction["BallsDexBot"], *perms: str) -> bool:
    """
    Checks if an interacting user checks one of the following conditions:

    - The user is a bot owner
    - The user has a role considered root or admin

    Parameters
    ----------
    interaction: Interaction[BallsDexBot]
        The interaction of the user to check.
    perms: *str
        Django permissions to verify. If empty, only staff status will be checked.

    Returns
    -------
    bool
        [`True`][] if the user is a staff, [`False`][] otherwise.
    """
    user = await get_user_for_check(interaction.client, interaction.user)
    if isinstance(user, bool):
        return user
    if not user.is_staff:
        return False

    return await user.ahas_perms(perms)