rolecount ¶

All Things Linux Discord Server - Role Count Plugin.

This plugin is specifically designed for the All Things Linux Discord server and contains hardcoded role IDs that are specific to that server.

DO NOT USE this plugin on other Discord servers - it will not work correctly and may cause errors due to missing roles.

This serves as an example of server-specific functionality that should be implemented as a plugin rather than core bot functionality.

Classes:

RoleCount –

Role count plugin for ATL Discord server.

Functions:

setup –

Set up the rolecount plugin.

Classes¶

RoleCount ¶

Python

RoleCount(bot: Tux)

Bases: BaseCog

Role count plugin for ATL Discord server.

Initialize the RoleCount plugin.

Parameters:

bot (Tux) –

The bot instance to initialize the plugin with.

Methods:

get_config –

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

Show the number of users in each role.
__repr__ –

Return a string representation of the cog instance.
unload_if_missing_config –

Check if required configuration is missing and log warning.

Attributes:

db (DatabaseCoordinator) –

Get the database coordinator for accessing database controllers.

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.

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

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.

rolecount `async` ¶

Python

rolecount(interaction: Interaction, which: Choice[str]) -> None

Show the number of users in each role.

Parameters:

interaction (Interaction) –

The interaction object.
which (Choice[str]) –

The role type to list.

_process_roles `async` ¶

Python

_process_roles(
    interaction: Interaction, roles_emojis: list[list[int | str]], which: Choice[str]
) -> None

Process the roles and emojis for the selected option.

Parameters:

interaction (Interaction) –

The interaction object.
roles_emojis (list[list[int | str]]) –

The list of roles and emojis.
which (Choice[str]) –

The selected option.

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.

_format_embed ¶

Python

_format_embed(
    embed: Embed,
    interaction: Interaction,
    role: Role,
    role_count: int,
    role_emoji: tuple[str, str],
    which: Choice[str],
    pages: list[Embed],
) -> tuple[int, Embed]

Format the embed with the role data.

Parameters:

embed (Embed) –

The embed to format.
interaction (Interaction) –

The interaction object.
role (Role) –

The role to format.
role_count (int) –

The current role count.
role_emoji (tuple[str, str]) –

The role emoji. The first element is the role ID and the second is the emoji name.
which (Choice[str]) –

The selected option.
pages (list[Embed]) –

The list of embeds to send.

Returns:

tuple[int, Embed] –

The updated role count and embed.

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

_create_embed ¶

Python

_create_embed(interaction: Interaction, which: Choice[str]) -> Embed

Create an embed for the role data.

Parameters:

interaction (Interaction) –

The interaction object.
which (Choice[str]) –

The selected option.

Returns:

Embed –

The created embed.

_send_response `async` ¶

Python

_send_response(interaction: Interaction, pages: list[Embed]) -> None

Send the response to the interaction.

Parameters:

interaction (Interaction) –

The interaction object.
pages (list[Embed]) –

The list of embeds to send.

Functions¶

setup `async` ¶

Python

setup(bot: Tux)

Set up the rolecount plugin.

Parameters:

bot (Tux) –

The bot instance to add the cog to.

rolecount ¶

Classes¶

RoleCount ¶

Attributes¶

db property ¶

Functions¶

_setup_command_usage ¶

_generate_usage ¶

get_config ¶

rolecount async ¶

_process_roles async ¶

__repr__ ¶

unload_if_missing_config ¶

_format_embed ¶

_unload_self async ¶

_create_embed ¶

_send_response async ¶

Functions¶

setup async ¶

db `property` ¶

rolecount `async` ¶

_process_roles `async` ¶

repr ¶

_unload_self `async` ¶

_send_response `async` ¶

setup `async` ¶