Skip to content

tux.cogs.utility.self_timeout

Classes:

Name Description
SelfTimeout

Classes

SelfTimeout(bot: Tux)

Bases: Cog

Methods:

Name Description
self_timeout

Time yourself out for a set duration
Source code in tux/cogs/utility/self_timeout.py
Python
def __init__(self, bot: Tux) -> None:
    self.bot = bot
    self.db = DatabaseController()
    self.self_timeout.usage = generate_usage(self.self_timeout)

Functions

self_timeout(ctx: commands.Context[Tux], duration: str, *, reason: str = 'No Reason.') -> None async

Time yourself out for a set duration

Parameters:

Name Type Description Default
ctx Context[Tux]

The context of the command

 required
duration str

How long the timeout should last for

 required
reason str[optional]

The reason why you are timing yourself out

 'No Reason.'
Source code in tux/cogs/utility/self_timeout.py
Python
@commands.hybrid_command(
    name="self_timeout",
    aliases=["sto", "stimeout", "selftimeout"],
)
@commands.guild_only()
async def self_timeout(self, ctx: commands.Context[Tux], duration: str, *, reason: str = "No Reason.") -> None:
    """
    Time yourself out for a set duration

    Parameters
    ----------
    ctx : commands.Context[Tux]
        The context of the command
    duration : str
        How long the timeout should last for
    reason : str [optional]
        The reason why you are timing yourself out
    """
    if ctx.guild is None:
        await ctx.send("Command must be run in a guild!", ephemeral=True)
        return

    member = ctx.guild.get_member(ctx.author.id)
    if member is None:
        return

    duration_seconds: int = convert_to_seconds(duration)
    duration_readable = seconds_to_human_readable(duration_seconds)

    if duration_seconds == 0:
        await ctx.reply("Error! Invalid time format", ephemeral=True)
        return

    if duration_seconds > 604800:
        await ctx.reply("Error! duration cannot be longer than 7 days!", ephemeral=True)
        return

    if duration_seconds < 300:
        await ctx.reply("Error! duration cannot be less than 5 minutes!", ephemeral=True)
        return

    entry = await self.db.afk.get_afk_member(member.id, guild_id=ctx.guild.id)

    if entry is not None and reason == "No Reason.":
        # If the member is already afk and hasn't provided a reason with this command,
        # assume they want to upgrade their current AFK to a self-timeout and carry the old reason
        reason = entry.reason

    message_content = f'### WARNING\n### You are about to be timed out in the guild "{ctx.guild.name}" for {duration} with the reason "{reason}".\nas soon as you confirm this, **you cannot cancel it or remove it early**. There is *no* provision for it to be removed by server staff on request. please think very carefully and make sure you\'ve entered the correct values before you proceed with this command.'
    view = ConfirmationDanger(user=ctx.author.id)
    confirmation_message = await ctx.reply(message_content, view=view, ephemeral=True)
    await view.wait()
    await confirmation_message.delete()
    confirmed = view.value

    if confirmed:
        try:
            await ctx.author.send(
                f'You have timed yourself out in guild {ctx.guild.name} for {duration_readable} with the reason "{reason}".',
            )
        except discord.Forbidden:
            await ctx.reply(
                f'You have timed yourself out for {duration_readable} with the reason "{reason}".',
            )

        if entry is not None:
            await del_afk(self.db, member, entry.nickname)

        await member.timeout(timedelta(seconds=float(duration_seconds)), reason="self time-out")

        await add_afk(
            self.db,
            reason,
            member,
            ctx.guild.id,
            True,
            datetime.now(UTC) + timedelta(seconds=duration_seconds),
            True,
        )

Functions