Skip to content

afk

Away From Keyboard (AFK) status management.

This module provides comprehensive AFK functionality including automatic status setting, message notifications, and nickname management for Discord users.

Classes:

  • Afk –

    Discord cog for managing AFK status functionality.

Functions:

  • setup –

    Set up the Afk cog.

Classes

Afk

Python
Afk(bot: Tux)

Bases: BaseCog

Discord cog for managing AFK status functionality.

Initialize the AFK cog.

Parameters:

  • bot (Tux) –

    The bot instance to attach this cog to.

Methods:

  • afk –

    Set yourself as AFK.

  • permafk –

    Set yourself permanently AFK until you rerun the command.

  • remove_afk –

    Remove the AFK status of a member when they send a message.

  • check_afk –

    Check if a message mentions an AFK member.

  • get_config –

    Get a configuration value from CONFIG with support for nested keys.

  • handle_afk_expiration –

    Check AFK database at a regular interval, remove AFK from users with an entry that has expired.

  • __repr__ –

    Return a string representation of the cog instance.

  • unload_if_missing_config –

    Check if required configuration is missing and log warning.

Attributes:

Attributes

db property
Python
db: DatabaseCoordinator

Get the database coordinator for accessing database controllers.

Returns:

Examples:

Python Console Session
>>> await self.db.guild_config.get_guild_config(guild_id)
>>> await self.db.cases.create_case(...)
Notes

This property provides convenient access to database operations without needing to access self.bot.db directly.

Functions

afk async
Python
afk(ctx: Context[Tux], *, reason: str = 'No reason.') -> None

Set yourself as AFK.

Parameters:

  • ctx (Context[Tux]) –

    The context of the command.

  • reason (str, default: 'No reason.' ) –

    The reason you are AFK.

_setup_command_usage
Python
_setup_command_usage() -> None

Generate usage strings for all commands in this cog that lack explicit usage.

The generated usage follows the pattern: <qualified_name> <param tokens>

Where: - Required parameters are denoted as <name: Type> - Optional parameters are denoted as [name: Type] - The prefix is intentionally omitted (provided by ctx.prefix)

Examples:

ban <member: Member> [reason: str] config set <key: str> <value: str>

Notes

Respects explicit usage strings if already set on a command. Errors during generation are logged but don't prevent cog loading.

permafk async
Python
permafk(ctx: Context[Tux], *, reason: str = 'No reason.') -> None

Set yourself permanently AFK until you rerun the command.

Parameters:

  • ctx (Context[Tux]) –

    The context of the command.

  • reason (str, default: 'No reason.' ) –

    The reason you are AFK.

_generate_usage
Python
_generate_usage(command: Command[Any, ..., Any]) -> str

Generate a usage string with support for flags and positional parameters.

This method inspects the command's callback signature to detect: - FlagConverter parameters (e.g., --flag value) - Positional parameters (e.g., <required> or [optional])

Parameters:

  • command (Command) –

    The command to generate usage for.

Returns:

  • str –

    Generated usage string, or qualified command name as fallback.

Notes

Delegates to shared usage generator for consistency across all cogs. Falls back gracefully to command name if generation fails.

_send_afk_response async
Python
_send_afk_response(ctx: Context[Tux], content: str) -> None

Send a response for AFK commands with consistent formatting.

_get_afk_entry async
Python
_get_afk_entry(member_id: int, guild_id: int) -> AFK | None

Get an AFK entry for a member in a guild.

Returns:

  • AFK | None –

    The AFK entry if found, None otherwise.

remove_afk async
Python
remove_afk(message: Message) -> None

Remove the AFK status of a member when they send a message.

Parameters:

  • message (Message) –

    The message to check.

check_afk async
Python
check_afk(message: Message) -> None

Check if a message mentions an AFK member.

Parameters:

  • message (Message) –

    The message to check.

get_config
Python
get_config(key: str, default: Any = None) -> Any

Get a configuration value from CONFIG with support for nested keys.

Parameters:

  • key (str) –

    The configuration key to retrieve. Supports dot notation for nested values (e.g., "BOT_INFO.BOT_NAME").

  • default (Any, default: None ) –

    Default value to return if key is not found, by default None.

Returns:

  • Any –

    The configuration value or default if not found.

Examples:

Python Console Session
>>> self.get_config("BOT_INFO.BOT_NAME")
'Tux'
>>> self.get_config("MISSING_KEY", "fallback")
'fallback'
Notes

Errors during retrieval are logged but don't raise exceptions. Returns the default value on any error.

handle_afk_expiration async
Python
handle_afk_expiration()

Check AFK database at a regular interval, remove AFK from users with an entry that has expired.

__repr__
Python
__repr__() -> str

Return a string representation of the cog instance.

Returns:

  • str –

    String representation in format <CogName bot=BotUser>.

_get_expired_afk_entries async
Python
_get_expired_afk_entries(guild_id: int) -> list[AFK]

Get all expired AFK entries for a guild.

Parameters:

  • guild_id (int) –

    The ID of the guild to check.

Returns:

  • list[AFK] –

    A list of expired AFK entries.

unload_if_missing_config
Python
unload_if_missing_config(condition: bool, config_name: str) -> bool

Check if required configuration is missing and log warning.

This allows cogs to detect missing configuration at load time and return early from init to prevent partial initialization.

Parameters:

  • condition (bool) –

    True if config is missing (should unload), False otherwise.

  • config_name (str) –

    Name of the missing configuration for logging purposes.

Returns:

  • bool –

    True if config is missing (caller should return early), False if config is present.

Examples:

Python Console Session
>>> def __init__(self, bot: Tux):
...     super().__init__(bot)
...     if self.unload_if_missing_config(not CONFIG.GITHUB_TOKEN, "GITHUB_TOKEN"):
...         return  # Exit early, cog will be partially loaded but won't register commands
...     self.github_client = GitHubClient()
Notes

When this returns True, the cog's init should return early to avoid initializing services that depend on the missing config. The cog will be loaded but commands won't be registered properly, preventing runtime errors.

For complete cog unloading, the bot owner should remove the cog from the modules directory or use the reload system to unload it programmatically.

_unload_self async
Python
_unload_self(extension_name: str) -> None

Perform the actual cog unload operation.

Parameters:

  • extension_name (str) –

    Full extension name to unload.

Notes

This is called as a background task by unload_if_missing_config(). Errors during unload are logged but don't raise exceptions.

Functions

setup async

Python
setup(bot: Tux) -> None

Set up the Afk cog.

Parameters:

  • bot (Tux) –

    The bot instance to add the cog to.