Skip to content

Bot

DiscordBot 

DiscordBot()

Bases: Bot

Methods:

Name Description
on_connect
on_ready
on_guild_available
load_cogs
status_task

Setup the game status task of the bot.
before_status_task

Before starting the status changing task, we make sure the bot is ready
setup_hook

This will just be executed when the bot starts the first time.
on_message

The code in this event is executed every time someone sends a message, with or without the prefix
on_command_completion

The code in this event is executed every time a normal command has been successfully executed.
on_command_error

The code in this event is executed every time a normal valid command catches an error.
Source code in src/bot.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
def __init__(self) -> None:
    super().__init__(
        command_prefix=commands.when_mentioned_or("!"),
        intents=nextcord.Intents.default(),
        # intents=nextcord.Intents.all(),  # 啟用所有 Intents
        help_command=None,
        description="A Discord bot made with Nextcord.",
    )
    self.discord_config = DiscordConfig()
    self.logger = logging.getLogger("nextcord.state")
    self.logger.setLevel(logging.INFO)
    self.logger.addHandler(LogfireLoggingHandler())
    Path("./data").mkdir(parents=True, exist_ok=True)

discord_config 

discord_config = DiscordConfig()

logger 

logger = getLogger('nextcord.state')

on_connect 

on_connect() -> None
Source code in src/bot.py 
30
31
async def on_connect(self) -> None:
    logfire.info("Bot Connected", bot_name=self.user.name, bot_id=self.user.id)

on_ready 

on_ready() -> None
Source code in src/bot.py 
33
34
35
36
37
38
39
40
41
async def on_ready(self) -> None:
    app_info = await self.application_info()
    await self.setup_hook()
    invite_url = (
        f"https://discord.com/oauth2/authorize?client_id={app_info.id}&permissions=8&scope=bot"
    )

    logfire.info("Bot Started", bot_name=self.user.name, bot_id=self.user.id)
    logfire.info(f"Invite Link: {invite_url}")

on_guild_available 

on_guild_available(guild: Guild) -> None
Source code in src/bot.py 
43
44
async def on_guild_available(self, guild: nextcord.Guild) -> None:
    return await super().on_guild_available(guild)

load_cogs 

load_cogs() -> None
Source code in src/bot.py 
46
47
48
49
50
51
52
53
54
55
async def load_cogs(self) -> None:
    cog_path = Path("./src/cogs")
    cog_files = [
        f"src.cogs.{f.stem}" for f in cog_path.glob("*.py") if not f.stem.startswith("__")
    ]
    self.load_extensions(cog_files, stop_at_error=True)
    # for cog_file in cog_files:
    #     filename = f"src.cogs.{cog_file}"
    #     self.load_extension(filename)
    logfire.info("Cogs Loaded", cog_files=", ".join(cog_files))

status_task 

status_task() -> None

Setup the game status task of the bot.

Source code in src/bot.py 
57
58
59
60
61
62
63
@tasks.loop(minutes=1.0)
async def status_task(self) -> None:
    """Setup the game status task of the bot."""
    statuses = ["your mama"]
    random_status = secrets.choice(statuses)
    await self.change_presence(activity=nextcord.Game(random_status))
    logfire.info("Status Changed", new_status=self.activity.name)

before_status_task 

before_status_task() -> None

Before starting the status changing task, we make sure the bot is ready

Source code in src/bot.py 
65
66
67
68
@status_task.before_loop
async def before_status_task(self) -> None:
    """Before starting the status changing task, we make sure the bot is ready"""
    await self.wait_until_ready()

setup_hook 

setup_hook() -> None

This will just be executed when the bot starts the first time.

Source code in src/bot.py 
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
async def setup_hook(self) -> None:
    """This will just be executed when the bot starts the first time."""
    logfire.info(
        "Logged in",
        bot_name=self.user.name,
        discord_version=nextcord.__version__,
        python_version=platform.python_version(),
        system=f"{platform.system()} {platform.release()} ({os.name})",
    )
    await self.load_cogs()
    guild_id = None
    if self.discord_config.discord_test_server_id:
        guild_id = self.get_guild(self.discord_config.discord_test_server_id)
    # await self.tree.sync(guild=guild)
    await self.sync_application_commands(guild_id=guild_id)
    self.status_task.start()

on_message 

on_message(message: Message) -> None

The code in this event is executed every time someone sends a message, with or without the prefix

:param message: The message that was sent.

Source code in src/bot.py 
87
88
89
90
91
92
93
94
async def on_message(self, message: nextcord.Message) -> None:
    """The code in this event is executed every time someone sends a message, with or without the prefix

    :param message: The message that was sent.
    """
    if message.author == self.user or message.author.bot:
        return
    await self.process_commands(message)

on_command_completion 

on_command_completion(context: Context) -> None

The code in this event is executed every time a normal command has been successfully executed.

:param context: The context of the command that has been executed.

Source code in src/bot.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
async def on_command_completion(self, context: commands.Context) -> None:
    """The code in this event is executed every time a normal command has been *successfully* executed.

    :param context: The context of the command that has been executed.
    """
    full_command_name = context.command.qualified_name
    split = full_command_name.split(" ")
    executed_command = str(split[0])
    logfire.info("Command Received", command=executed_command)
    if context.guild is not None:
        logfire.info(
            f"Executed {executed_command} command in {context.guild.name} (ID: {context.guild.id}) by {context.author} (ID: {context.author.id})"
        )
    else:
        logfire.info(
            f"Executed {executed_command} command by {context.author} (ID: {context.author.id}) in DMs"
        )

on_command_error 

on_command_error(
    context: Context,
    error: CommandOnCooldown
    | NotOwner
    | MissingPermissions
    | BotMissingPermissions
    | MissingRequiredArgument,
) -> None

The code in this event is executed every time a normal valid command catches an error.

:param context: The context of the normal command that failed executing. :param error: The error that has been faced.

Source code in src/bot.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
async def on_command_error(
    self,
    context: commands.Context,
    error: commands.CommandOnCooldown
    | commands.NotOwner
    | commands.MissingPermissions
    | commands.BotMissingPermissions
    | commands.MissingRequiredArgument,
) -> None:
    """The code in this event is executed every time a normal valid command catches an error.

    :param context: The context of the normal command that failed executing.
    :param error: The error that has been faced.
    """
    if isinstance(error, commands.CommandOnCooldown):
        minutes, seconds = divmod(error.retry_after, 60)
        hours, minutes = divmod(minutes, 60)
        hours = hours % 24
        embed = nextcord.Embed(
            description=f"**Please slow down** - You can use this command again in {f'{round(hours)} hours' if round(hours) > 0 else ''} {f'{round(minutes)} minutes' if round(minutes) > 0 else ''} {f'{round(seconds)} seconds' if round(seconds) > 0 else ''}.",
            color=0xE02B2B,
        )
        await context.send(embed=embed)
    elif isinstance(error, commands.NotOwner):
        embed = nextcord.Embed(description="You are not the owner of the bot!", color=0xE02B2B)
        await context.send(embed=embed)
        if context.guild:
            logfire.warn(
                f"{context.author} (ID: {context.author.id}) tried to execute an owner only command in the guild {context.guild.name} (ID: {context.guild.id}), but the user is not an owner of the bot."
            )
        else:
            logfire.warn(
                f"{context.author} (ID: {context.author.id}) tried to execute an owner only command in the bot's DMs, but the user is not an owner of the bot."
            )
    elif isinstance(error, commands.MissingPermissions):
        embed = nextcord.Embed(
            description="You are missing the permission(s) `"
            + ", ".join(error.missing_permissions)
            + "` to execute this command!",
            color=0xE02B2B,
        )
        await context.send(embed=embed)
    elif isinstance(error, commands.BotMissingPermissions):
        embed = nextcord.Embed(
            description="I am missing the permission(s) `"
            + ", ".join(error.missing_permissions)
            + "` to fully perform this command!",
            color=0xE02B2B,
        )
        await context.send(embed=embed)
    elif isinstance(error, commands.MissingRequiredArgument):
        embed = nextcord.Embed(
            title="Error!",
            # We need to capitalize because the command arguments have no capital letter in the code and they are the first word in the error message.
            description=str(error).capitalize(),
            color=0xE02B2B,
        )
        await context.send(embed=embed)
    else:
        raise error