Skip to content

Logging

ballsdex.core.utils.logging

log_action 

log_action(message: str, bot: BallsDexBot, console_log: bool = False)

Log an action to be sent in the channel configured by log-channel in config.yml. If no channel was configured, this does nothing.

Parameters:

  • message (str) –

    The message to log.

  • bot (BallsDexBot) –

    The bot class, needed to send the message.

  • console_log (bool, default: False ) –

    Whether to also log the message in the console. Defaults to False.

Source code in ballsdex/core/utils/logging.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
async def log_action(message: str, bot: BallsDexBot, console_log: bool = False):
    """
    Log an action to be sent in the channel configured by `log-channel` in `config.yml`.
    If no channel was configured, this does nothing.

    Parameters
    ----------
    message: str
        The message to log.
    bot: BallsDexBot
        The bot class, needed to send the message.
    console_log: bool
        Whether to also log the message in the console. Defaults to `False`.
    """
    if settings.log_channel:
        channel = bot.get_channel(settings.log_channel)
        if not channel:
            log.warning(f"Channel {settings.log_channel} not found")
            return
        if not isinstance(channel, discord.TextChannel):
            log.warning(f"Channel {channel.name} is not a text channel")  # type: ignore
            return
        await channel.send(message)
    if console_log:
        log.info(message)