GoldyBot.objects

View Source

 1from . import command, member, role, slash, channel, currency
 2
 3Command = command.Command
 4""""""
 5Member = member.Member
 6""""""
 7Role = role.Role
 8""""""
 9InteractionToCtx = slash.InteractionToCtx
10""""""
11Channel = channel.Channel
12""""""
13Currency = currency.Currency
14""""""
15
16"""
17class GoldyBotObjectInterfaceBaseClass():
18    '''Most GoldyBot objects inherent from this class to have similar programming interface. Don't worry about this class.
19"""

class Member(GoldyBot.database.member.Member): View Source

11class Member(database.member.Member):
12    """A class representing a discord member in Goldy Bot."""
13    def __init__(self, ctx, member_id:str|int=None, mention_str:str=None, member_object:nextcord.Member=None):
14        self.ctx = ctx
15        self.member_id_ = member_id
16        self.mention_str_ = mention_str
17        self.member_object_ = member_object
18
19        if self.member_object_ == None:
20            # Find the member.
21            self.member = self.find_member(self.member_id)
22        else:
23            self.member = self.member_object_
24
25        super().__init__(ctx, self)
26        
27    @property
28    def member_id(self) -> str:
29        """Returns id of discord member. Defaults to ctx author if ``member_id``, ``mention_str`` and ``member_user_object`` are None."""
30        if not self.member_id_ == None: return str(self.member_id_)
31        if not self.mention_str_ == None: return self.mention_str_[self.mention_str_.index("@") + 1: self.mention_str_.index(">")] # Getting id from mention (e.g. <@332592361307897856>).
32        if not self.member_object_ == None: return str(self.member_object_.id)
33        else:
34            if isinstance(self.ctx, Interaction):
35                return str(InteractionToCtx(self.ctx).author.id)
36            else:
37                return str(self.ctx.author.id)
38                
39    @property
40    def name(self):
41        """Returns the discord name of member including tag. Does not return server nickname!"""
42        return self.member.name
43
44    @property
45    def display_name(self):
46        """Returns display name of member, so server nickname."""
47        return self.member.display_name
48
49    # Roles
50    #---------
51    def has_role(self, role:role.Role):
52        """Checks if the member has a certain role."""
53        if role.role in self.member.roles:
54            return True
55        else:
56            return False
57
58    async def add_role(self, role:role.Role):
59        """This method adds the specified role to this member."""
60        if not self.has_role(role):
61            await self.member.add_roles(role)
62            return True
63        else:
64            return True
65
66    async def remove_role(self, role:role.Role):
67        """This method removes the specified role from this member."""
68        if self.has_role(role):
69            await self.member.remove_roles(role)
70            return True
71        else:
72            return None
73
74    def find_member(self, member_id:int|str) -> nextcord.Member | None:
75        """Finds the damn member!"""
76
77        if not member_id == None:
78            member = nextcord.utils.get(self.ctx.guild.members, id=int(member_id))
79            
80            if member is None: raise GoldyBot.errors.FailedToFindMember()
81
82            return member
83        else:
84            return None
85
86    # Utils
87    async def send(self, **args):
88        args.pop("ephemeral")
89        await self.member.send(**args)

A class representing a discord member in Goldy Bot.

Member( ctx, member_id: str | int = None, mention_str: str = None, member_object: nextcord.member.Member = None) View Source

13    def __init__(self, ctx, member_id:str|int=None, mention_str:str=None, member_object:nextcord.Member=None):
14        self.ctx = ctx
15        self.member_id_ = member_id
16        self.mention_str_ = mention_str
17        self.member_object_ = member_object
18
19        if self.member_object_ == None:
20            # Find the member.
21            self.member = self.find_member(self.member_id)
22        else:
23            self.member = self.member_object_
24
25        super().__init__(ctx, self)

member_id: str

Returns id of discord member. Defaults to ctx author if member_id, mention_str and member_user_object are None.

name

Returns the discord name of member including tag. Does not return server nickname!

display_name

Returns display name of member, so server nickname.

def has_role(self, role: GoldyBot.objects.Role): View Source

51    def has_role(self, role:role.Role):
52        """Checks if the member has a certain role."""
53        if role.role in self.member.roles:
54            return True
55        else:
56            return False

Checks if the member has a certain role.

async def add_role(self, role: GoldyBot.objects.Role): View Source

58    async def add_role(self, role:role.Role):
59        """This method adds the specified role to this member."""
60        if not self.has_role(role):
61            await self.member.add_roles(role)
62            return True
63        else:
64            return True

This method adds the specified role to this member.

async def remove_role(self, role: GoldyBot.objects.Role): View Source

66    async def remove_role(self, role:role.Role):
67        """This method removes the specified role from this member."""
68        if self.has_role(role):
69            await self.member.remove_roles(role)
70            return True
71        else:
72            return None

This method removes the specified role from this member.

def find_member(self, member_id: int | str) -> nextcord.member.Member | None: View Source

74    def find_member(self, member_id:int|str) -> nextcord.Member | None:
75        """Finds the damn member!"""
76
77        if not member_id == None:
78            member = nextcord.utils.get(self.ctx.guild.members, id=int(member_id))
79            
80            if member is None: raise GoldyBot.errors.FailedToFindMember()
81
82            return member
83        else:
84            return None

Finds the damn member!

async def send(self, **args): View Source

87    async def send(self, **args):
88        args.pop("ephemeral")
89        await self.member.send(**args)

Inherited Members

GoldyBot.database.member.Member: get_member_data; edit_member_data; setup
GoldyBot.database.member.money.Money: get_money; give_money; take_money

class Role: View Source

 9class Role():
10    """
11    A class representing a discord role in Goldy Bot. Either 'role_id', 'role_name', 'mention_str' or 'role_object' has to be passed in the 'Role()'.
12    
13    Raises FailedToFindRole() when role is not found.
14    """
15    def __init__(self, ctx, role_id:str=None, role_name:str=None, role_object:nextcord.Role=None, mention_str:str=None):
16        self.ctx = ctx
17        self.role_id_ = role_id
18        self.role_name_ = role_name
19        self.mention_str_ = mention_str
20        self.role_object_ = role_object
21
22        self.role_ = None
23
24        if self.role_object_ == None:
25            self.role_ = self.find_role(self.role_id, self.role_name_)
26        else:
27            self.role_ = self.role_object_
28
29    @property
30    def role(self) -> nextcord.Role:
31        """Returns the actual representation of the role in nextcord."""
32        return self.role_
33
34    @property
35    def role_id(self) -> str|None:
36        """Returns id of discord role. Returns ``None`` if ``role_id``, ``role_name``, ``mention_str`` and ``role_object`` are left blank."""
37        if not self.role_id_ == None: return str(self.role_id_)
38        if not self.mention_str_ == None: return self.mention_str_[3:-1]
39        if not self.role_object_ == None: return str(self.role_object_.id)
40
41        return None
42
43    @property
44    def role_name(self) -> str:
45        """Returns the name of the role."""
46        return self.role.name
47
48    def find_role(self, role_id:int|str, role_name:str=None) -> nextcord.Role:
49        role:nextcord.Role
50
51        if role_name == None:
52            if not role_id == None:
53                role = self.ctx.guild.get_role(int(role_id))
54            else:
55                role = None
56
57            if role == None:
58                raise FailedToFindRole(option_used="id", option_value=role_id)
59            else:
60                GoldyBot.logging.log(f"Found the role '{role.name}' by id.")
61                return role
62            
63        else:
64            role = nextcord.utils.get(self.ctx.guild.roles, name=role_name)
65
66            if role == None: 
67                raise FailedToFindRole(option_used="role name", option_value=role_name)
68            else:
69                GoldyBot.logging.log(f"Found the role '{role.name}' by name.")
70                return role

A class representing a discord role in Goldy Bot. Either 'role_id', 'role_name', 'mention_str' or 'role_object' has to be passed in the 'Role()'.

Raises FailedToFindRole() when role is not found.

Role( ctx, role_id: str = None, role_name: str = None, role_object: nextcord.role.Role = None, mention_str: str = None) View Source

15    def __init__(self, ctx, role_id:str=None, role_name:str=None, role_object:nextcord.Role=None, mention_str:str=None):
16        self.ctx = ctx
17        self.role_id_ = role_id
18        self.role_name_ = role_name
19        self.mention_str_ = mention_str
20        self.role_object_ = role_object
21
22        self.role_ = None
23
24        if self.role_object_ == None:
25            self.role_ = self.find_role(self.role_id, self.role_name_)
26        else:
27            self.role_ = self.role_object_

role: nextcord.role.Role

Returns the actual representation of the role in nextcord.

role_id: str | None

Returns id of discord role. Returns None if role_id, role_name, mention_str and role_object are left blank.

role_name: str

Returns the name of the role.

def find_role(self, role_id: int | str, role_name: str = None) -> nextcord.role.Role: View Source

48    def find_role(self, role_id:int|str, role_name:str=None) -> nextcord.Role:
49        role:nextcord.Role
50
51        if role_name == None:
52            if not role_id == None:
53                role = self.ctx.guild.get_role(int(role_id))
54            else:
55                role = None
56
57            if role == None:
58                raise FailedToFindRole(option_used="id", option_value=role_id)
59            else:
60                GoldyBot.logging.log(f"Found the role '{role.name}' by id.")
61                return role
62            
63        else:
64            role = nextcord.utils.get(self.ctx.guild.roles, name=role_name)
65
66            if role == None: 
67                raise FailedToFindRole(option_used="role name", option_value=role_name)
68            else:
69                GoldyBot.logging.log(f"Found the role '{role.name}' by name.")
70                return role

class InteractionToCtx: View Source

13class InteractionToCtx():
14    """This Goldy Bot class is used to convert interactions to ctx."""
15    def __init__(self, interaction: Interaction):
16        self.interaction = interaction
17
18    @property
19    def guild(self) -> Interaction.guild:
20        return self.interaction.guild
21
22    @property
23    def author(self):
24        return self.interaction.user
25
26    @property
27    def channel(self):
28        return self.interaction.channel
29
30    @property
31    def response(self) -> InteractionResponse:
32        return self.interaction.response
33
34    async def send(self, text:str=None, **kwargs):
35        if not text == None:
36            await self.interaction.send(text)
37        else:
38            await self.interaction.send(**kwargs)
39        
40        return Message(self.interaction)
41
42    async def send_modal(self, modal:nextcord.ui.Modal):
43        """Sends modal."""
44        await self.interaction.response.send_modal(modal)
45
46        return Message(self.interaction)

This Goldy Bot class is used to convert interactions to ctx.

InteractionToCtx(interaction: nextcord.interactions.Interaction) View Source

15    def __init__(self, interaction: Interaction):
16        self.interaction = interaction

guild: <property object at 0x000001B473CA9EE0>

author

channel

response: nextcord.interactions.InteractionResponse

async def send(self, text: str = None, **kwargs): View Source

34    async def send(self, text:str=None, **kwargs):
35        if not text == None:
36            await self.interaction.send(text)
37        else:
38            await self.interaction.send(**kwargs)
39        
40        return Message(self.interaction)

async def send_modal(self, modal: nextcord.ui.modal.Modal): View Source

42    async def send_modal(self, modal:nextcord.ui.Modal):
43        """Sends modal."""
44        await self.interaction.response.send_modal(modal)
45
46        return Message(self.interaction)

Sends modal.

class Channel: View Source

10class Channel():
11    """A class representing a discord channel in Goldy Bot."""
12    def __init__(self, ctx, channel_id:str|int=None, mention_str:str=None, channel_object:nextcord.abc.GuildChannel=None):
13
14        self.ctx = ctx
15        self.channel_id_ = channel_id
16        self.mention_str_ = mention_str
17        self.channel_object_ = channel_object
18
19        self.channel:nextcord.abc.GuildChannel|None
20
21        if self.channel_object_ == None:
22            # Find the channel.
23            self.channel = self.find_channel(self.channel_id)
24        else:
25            self.channel = self.channel_object_
26        
27    @property
28    def channel_id(self) -> str:
29        """Returns id of discord channel. Defaults to ctx channel if ``channel_id``, ``mention_str`` and ``channel_object`` are None."""
30        if not self.channel_id_ == None: return str(self.channel_id_)
31        if not self.mention_str_ == None: return self.mention_str_[3:-1]
32        if not self.channel_object_ == None: return str(self.channel_object_.id)
33        else:
34            if isinstance(self.ctx, Interaction):
35                return str(InteractionToCtx(self.ctx).channel.id)
36            else:
37                return str(self.ctx.channel.id)
38                
39    @property
40    def name(self):
41        """Returns the discord channel name."""
42        return self.channel.name
43
44    @property
45    def display_name(self):
46        """Alias of ``Channel().name``"""
47        return self.name
48
49    async def purge(self, amount:int|None):
50        """Deletes specified number of messages in this channel. (Only works if this channel is a text channel.)"""
51        if isinstance(self.channel, nextcord.TextChannel):
52            channel:nextcord.TextChannel = self.channel
53
54            deleted = None
55            try:
56                deleted = await channel.purge(limit=amount)
57                GoldyBot.logging.log("info_5", f"[{MODULE_NAME}] Deleted '{len(deleted)}' messages from the channel '{self.name}'.")
58            except Exception as e:
59                GoldyBot.logging.log("warn", f"[{MODULE_NAME}] Couldn't delete from '{self.name}' because '{e}'.")
60                
61            return deleted
62        else:
63            GoldyBot.logging.log("warn", f"[{MODULE_NAME}] Can't purge messages because this channel isn't a text channel!")
64
65
66    def find_channel(self, channel_id:int|str) -> nextcord.abc.GuildChannel | None:
67        """Finds the damn channel!"""
68
69        if not channel_id == None:
70            return nextcord.utils.get(self.ctx.guild.channels, id=int(channel_id))
71        else:
72            return None

A class representing a discord channel in Goldy Bot.

Channel( ctx, channel_id: str | int = None, mention_str: str = None, channel_object: nextcord.abc.GuildChannel = None) View Source

12    def __init__(self, ctx, channel_id:str|int=None, mention_str:str=None, channel_object:nextcord.abc.GuildChannel=None):
13
14        self.ctx = ctx
15        self.channel_id_ = channel_id
16        self.mention_str_ = mention_str
17        self.channel_object_ = channel_object
18
19        self.channel:nextcord.abc.GuildChannel|None
20
21        if self.channel_object_ == None:
22            # Find the channel.
23            self.channel = self.find_channel(self.channel_id)
24        else:
25            self.channel = self.channel_object_

channel_id: str

Returns id of discord channel. Defaults to ctx channel if channel_id, mention_str and channel_object are None.

name

Returns the discord channel name.

display_name

Alias of Channel().name

async def purge(self, amount: int | None): View Source

49    async def purge(self, amount:int|None):
50        """Deletes specified number of messages in this channel. (Only works if this channel is a text channel.)"""
51        if isinstance(self.channel, nextcord.TextChannel):
52            channel:nextcord.TextChannel = self.channel
53
54            deleted = None
55            try:
56                deleted = await channel.purge(limit=amount)
57                GoldyBot.logging.log("info_5", f"[{MODULE_NAME}] Deleted '{len(deleted)}' messages from the channel '{self.name}'.")
58            except Exception as e:
59                GoldyBot.logging.log("warn", f"[{MODULE_NAME}] Couldn't delete from '{self.name}' because '{e}'.")
60                
61            return deleted
62        else:
63            GoldyBot.logging.log("warn", f"[{MODULE_NAME}] Can't purge messages because this channel isn't a text channel!")

Deletes specified number of messages in this channel. (Only works if this channel is a text channel.)

def find_channel(self, channel_id: int | str) -> nextcord.abc.GuildChannel | None: View Source

66    def find_channel(self, channel_id:int|str) -> nextcord.abc.GuildChannel | None:
67        """Finds the damn channel!"""
68
69        if not channel_id == None:
70            return nextcord.utils.get(self.ctx.guild.channels, id=int(channel_id))
71        else:
72            return None

Finds the damn channel!

class Currency: View Source

 2class Currency():
 3    """
 4    Base class for a currency in Goldy Bot. Use this to create you own custom currency.
 5        
 6    ---------------
 7    ### ***``Example:``***
 8
 9    Hello, want to make your own custom currency? Well anyways you came to the right place.
10    Below I show you an example on how to create your very own currency in Goldy Bot using the currency base class.
11
12    ```python
13    class GBP(GoldyBot.Currency):
14        def __init__(self):
15            super().__init__("GBP", "British Pounds", "💷", 600)
16    ```
17    - This is how a custom currency is implemented. The code name is ``GBP``, the display name is ``British Pounds``, the currency icon/emoji is a ``pound banknote`` (💷) emoji and the default balance for this currency is 600.
18
19    ```python
20    class UwUCoin(GoldyBot.Currency):
21        def __init__(self):
22            super().__init__("uwu_coin", "UwU Coin", "🟡", 0)
23    ```
24    - Here's another example for fun. 😁
25    """
26
27    def __init__(self, code_name:str, display_name:str, display_emoji:str="💷", default_bal:int=600):
28        self.code_name_ = code_name
29        self.display_name_ = display_name
30        self.display_emoji_ = display_emoji
31        self.default_bal_ = default_bal
32
33    @property
34    def code_name(self):
35        """Returns code name of currency."""
36        return self.code_name_
37
38    @property
39    def display_name(self):
40        """Returns display name of currency."""
41        return self.display_name_
42
43    @property
44    def display_emoji(self):
45        """Returns some sort of emoji or icon that is used to identify this currency."""
46        return self.display_emoji_
47
48    @property
49    def default_bal(self):
50        """Returns the default balance for this currency."""
51        return self.default_bal_

Base class for a currency in Goldy Bot. Use this to create you own custom currency.

`Example:`

Hello, want to make your own custom currency? Well anyways you came to the right place. Below I show you an example on how to create your very own currency in Goldy Bot using the currency base class.

class GBP(GoldyBot.Currency):
    def __init__(self):
        super().__init__("GBP", "British Pounds", "💷", 600)

This is how a custom currency is implemented. The code name is GBP, the display name is British Pounds, the currency icon/emoji is a pound banknote (💷) emoji and the default balance for this currency is 600.

class UwUCoin(GoldyBot.Currency):
    def __init__(self):
        super().__init__("uwu_coin", "UwU Coin", "🟡", 0)

Here's another example for fun. 😁

Currency( code_name: str, display_name: str, display_emoji: str = '💷', default_bal: int = 600) View Source

27    def __init__(self, code_name:str, display_name:str, display_emoji:str="💷", default_bal:int=600):
28        self.code_name_ = code_name
29        self.display_name_ = display_name
30        self.display_emoji_ = display_emoji
31        self.default_bal_ = default_bal

code_name

Returns code name of currency.

display_name

Returns display name of currency.

display_emoji

Returns some sort of emoji or icon that is used to identify this currency.

default_bal

Returns the default balance for this currency.