Skip to content

fact

Fact Plugin for Tux Bot.

This plugin provides random fact generation with configurable fact types, placeholder substitution, and automated fact posting functionality. Facts are loaded from TOML files and support various categories.

Classes:

  • Fact –

    Fact plugin for generating and posting random facts.

Functions:

  • setup –

    Set up the Fact cog.

Classes

Fact

Python
Fact(bot: Tux)

Bases: BaseCog

Fact plugin for generating and posting random facts.

Initialize the Fact plugin.

Parameters:

  • bot (Tux) –

    The bot instance to initialize the plugin with.

Methods:

  • fact_type_autocomplete –

    Provide autocomplete suggestions for fact types.

  • fact –

    Get a fun fact by category or random.

  • get_config –

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

  • __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:

  • DatabaseCoordinator –

    Coordinator providing access to all database controllers.

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

_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.

_load_facts
Python
_load_facts() -> None

Load facts from the facts.toml file.

_fetch_fact async
Python
_fetch_fact(fact_type: str) -> tuple[str, str] | None

Fetch a fact of the specified type.

Parameters:

  • fact_type (str) –

    The type of fact to fetch.

Returns:

  • tuple[str, str] | None –

    A tuple of (fact_text, fact_type) if found, None otherwise.

_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.

fact_type_autocomplete async
Python
fact_type_autocomplete(interaction: Interaction, current: str) -> list[Choice[str]]

Provide autocomplete suggestions for fact types.

Parameters:

  • interaction (Interaction) –

    The interaction object.

  • current (str) –

    The current user input for filtering.

Returns:

fact async
Python
fact(ctx: Context[Tux], fact_type: str = 'random') -> None

Get a fun fact by category or random.

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.

__repr__
Python
__repr__() -> str

Return a string representation of the cog instance.

Returns:

  • str –

    String representation in format <CogName bot=BotUser>.

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

_substitute_placeholders

Python
_substitute_placeholders(bot: Tux, text: str) -> str

Substitute placeholders in text.

Available placeholders: {member_count} -> Total member count {guild_count} -> Total guild count {bot_name} -> Bot name {bot_version} -> Bot version {prefix} -> Bot prefix

Parameters:

  • text (str) –

    Text to substitute placeholders in.

Returns:

  • str –

    Text with placeholders substituted.

setup async

Python
setup(bot: Tux) -> None

Set up the Fact cog.

Parameters:

  • bot (Tux) –

    The bot instance to add the cog to.