refactor(config): update configuration access across multiple modules

kzndotsh · kzndotsh · commit 9edbd5ff216b · 2025-08-31T06:15:56.000-04:00
- Refactored the import path for CONFIG to streamline access in various modules.
- Adjusted configuration access patterns to reflect the new structure, including updates to Eval, Git, Mail, Levels, and other service files.
- Enhanced error handling and logging for better diagnostics related to configuration values.
- Ensured consistency in accessing external service configurations across the codebase.
diff --git a/src/tux/modules/admin/eval.py b/src/tux/modules/admin/eval.py
@@ -7,7 +7,7 @@
 from tux.core import checks
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.ui.embeds import EmbedCreator
 
 
@@ -71,7 +71,7 @@ async def eval(self, ctx: commands.Context[Tux], *, expression: str) -> None:
             return
 
         if ctx.author.id not in self.bot.owner_ids:
-            if not CONFIG.ALLOW_SYSADMINS_EVAL and ctx.author.id in CONFIG.SYSADMIN_IDS:
+            if not CONFIG.ALLOW_SYSADMINS_EVAL and ctx.author.id in CONFIG.USER_IDS.SYSADMINS:
                 logger.warning(
                     f"{ctx.author} tried to run eval but is not the bot owner. (User ID: {ctx.author.id})",
                 )
diff --git a/src/tux/modules/admin/git.py b/src/tux/modules/admin/git.py
@@ -5,7 +5,7 @@
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
 from tux.services.wrappers.github import GithubService
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.ui.buttons import GithubButton
 from tux.ui.embeds import EmbedCreator
 
@@ -14,7 +14,7 @@ class Git(BaseCog):
     def __init__(self, bot: Tux) -> None:
         super().__init__(bot)
         self.github = GithubService()
-        self.repo_url = CONFIG.GITHUB_REPO_URL
+        self.repo_url = CONFIG.EXTERNAL_SERVICES.GITHUB_REPO_URL
         # Usage is auto-generated by BaseCog
 
     @commands.hybrid_group(
diff --git a/src/tux/modules/admin/mail.py b/src/tux/modules/admin/mail.py
@@ -8,20 +8,20 @@
 from tux.core import checks
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 
 MailboxData = dict[str, str | list[str]]
 
 
 class Mail(BaseCog):
     def __init__(self, bot: Tux) -> None:
         super().__init__(bot)
-        self.api_url = CONFIG.MAILCOW_API_URL
+        self.api_url = CONFIG.EXTERNAL_SERVICES.MAILCOW_API_URL
         self.headers = {
             "Content-Type": "application/json",
             "Accept": "application/json",
-            "X-API-Key": CONFIG.MAILCOW_API_KEY,
-            "Authorization": f"Bearer {CONFIG.MAILCOW_API_KEY}",
+            "X-API-Key": CONFIG.EXTERNAL_SERVICES.MAILCOW_API_KEY,
+            "Authorization": f"Bearer {CONFIG.EXTERNAL_SERVICES.MAILCOW_API_KEY}",
         }
         self.default_options: dict[str, str | list[str]] = {
             "active": "1",
diff --git a/src/tux/modules/fun/fact.py b/src/tux/modules/fun/fact.py
@@ -1,5 +1,6 @@
 import random
 import tomllib
+from pathlib import Path
 from typing import Any
 
 import discord
@@ -10,10 +11,12 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import workspace_root
 from tux.shared.substitutions import handle_substitution
 from tux.ui.embeds import EmbedCreator
 
+# Define workspace root relative to the project root
+workspace_root = Path(__file__).parent.parent.parent.parent.parent
+
 
 class Fact(BaseCog):
     def __init__(self, bot: Tux) -> None:
diff --git a/src/tux/modules/guild/config.py b/src/tux/modules/guild/config.py
@@ -6,7 +6,7 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.ui.embeds import EmbedCreator, EmbedType
 from tux.ui.views.config import ConfigSetChannels, ConfigSetPrivateLogs, ConfigSetPublicLogs
 
@@ -387,7 +387,7 @@ async def config_clear_prefix(
                 user_display_avatar=interaction.user.display_avatar.url,
                 embed_type=EmbedCreator.SUCCESS,
                 title="Guild Config",
-                description=f"The prefix was reset to `{CONFIG.DEFAULT_PREFIX}`",
+                description=f"The prefix was reset to `{CONFIG.BOT_INFO.PREFIX}`",
             ),
         )
 
diff --git a/src/tux/modules/levels/level.py b/src/tux/modules/levels/level.py
@@ -4,7 +4,7 @@
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
 from tux.modules.services.levels import LevelsService
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.ui.embeds import EmbedCreator, EmbedType
 
 
@@ -52,7 +52,7 @@ async def level(self, ctx: commands.Context[Tux], member: discord.User | discord
             level_display = level
             xp_display = f"{round(xp)}"
 
-        if CONFIG.SHOW_XP_PROGRESS:
+        if CONFIG.XP_CONFIG.SHOW_XP_PROGRESS:
             xp_progress: int
             xp_required: int
             xp_progress, xp_required = self.levels_service.get_level_progress(xp, level)
diff --git a/src/tux/modules/services/gif_limiter.py b/src/tux/modules/services/gif_limiter.py
@@ -7,7 +7,7 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 
 
 class GifLimiter(BaseCog):
@@ -21,15 +21,15 @@ def __init__(self, bot: Tux) -> None:
         super().__init__(bot)
 
         # Max age for a GIF to be considered a recent post
-        self.recent_gif_age: int = CONFIG.RECENT_GIF_AGE
+        self.recent_gif_age: int = CONFIG.GIF_LIMITER.RECENT_GIF_AGE
 
         # Max number of GIFs sent recently in a channel
-        self.channelwide_gif_limits: dict[int, int] = CONFIG.GIF_LIMITS_CHANNEL
+        self.channelwide_gif_limits: dict[int, int] = CONFIG.GIF_LIMITER.GIF_LIMITS_CHANNEL
         # Max number of GIFs sent recently by a user to be able to post one in specified channels
-        self.user_gif_limits: dict[int, int] = CONFIG.GIF_LIMITS
+        self.user_gif_limits: dict[int, int] = CONFIG.GIF_LIMITER.GIF_LIMITS_USER
 
         # list of channels in which not to count GIFs
-        self.gif_limit_exclude: list[int] = CONFIG.GIF_LIMIT_EXCLUDE
+        self.gif_limit_exclude: list[int] = CONFIG.GIF_LIMITER.GIF_LIMIT_EXCLUDE
 
         # Timestamps for recently-sent GIFs for the server, and channels
 
diff --git a/src/tux/modules/services/influxdblogger.py b/src/tux/modules/services/influxdblogger.py
@@ -8,7 +8,7 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 
 
 class InfluxLogger(BaseCog):
@@ -31,9 +31,9 @@ def init_influx(self) -> bool:
         bool
             True if initialization was successful, False otherwise
         """
-        influx_token: str = CONFIG.INFLUXDB_TOKEN
-        influx_url: str = CONFIG.INFLUXDB_URL
-        self.influx_org = CONFIG.INFLUXDB_ORG
+        influx_token: str = CONFIG.EXTERNAL_SERVICES.INFLUXDB_TOKEN
+        influx_url: str = CONFIG.EXTERNAL_SERVICES.INFLUXDB_URL
+        self.influx_org = CONFIG.EXTERNAL_SERVICES.INFLUXDB_ORG
 
         if (influx_token != "") and (influx_url != "") and (self.influx_org != ""):
             write_client = InfluxDBClient(url=influx_url, token=influx_token, org=self.influx_org)
diff --git a/src/tux/modules/services/levels.py b/src/tux/modules/services/levels.py
@@ -8,19 +8,25 @@
 from tux.core.app import get_prefix
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.ui.embeds import EmbedCreator
 
 
 class LevelsService(BaseCog):
     def __init__(self, bot: Tux) -> None:
         super().__init__(bot)
-        self.xp_cooldown = CONFIG.XP_COOLDOWN
-        self.levels_exponent = CONFIG.LEVELS_EXPONENT
-        self.xp_roles = {role["level"]: role["role_id"] for role in CONFIG.XP_ROLES}
-        self.xp_multipliers = {role["role_id"]: role["multiplier"] for role in CONFIG.XP_MULTIPLIERS}
-        self.max_level = max(item["level"] for item in CONFIG.XP_ROLES)
-        self.enable_xp_cap = CONFIG.ENABLE_XP_CAP
+
+        # Check if XP roles are configured
+        if not CONFIG.XP_CONFIG.XP_ROLES:
+            msg = "XP_ROLES configuration is empty. Please configure XP roles in your .env file."
+            raise ValueError(msg)
+
+        self.xp_cooldown = CONFIG.XP_CONFIG.XP_COOLDOWN
+        self.levels_exponent = CONFIG.XP_CONFIG.LEVELS_EXPONENT
+        self.xp_roles = {role["level"]: role["role_id"] for role in CONFIG.XP_CONFIG.XP_ROLES}
+        self.xp_multipliers = {role["role_id"]: role["multiplier"] for role in CONFIG.XP_CONFIG.XP_MULTIPLIERS}
+        self.max_level = max(item["level"] for item in CONFIG.XP_CONFIG.XP_ROLES)
+        self.enable_xp_cap = CONFIG.XP_CONFIG.ENABLE_XP_CAP
 
     @commands.Cog.listener("on_message")
     async def xp_listener(self, message: discord.Message) -> None:
@@ -32,7 +38,7 @@ async def xp_listener(self, message: discord.Message) -> None:
         message : discord.Message
             The message object.
         """
-        if message.author.bot or message.guild is None or message.channel.id in CONFIG.XP_BLACKLIST_CHANNELS:
+        if message.author.bot or message.guild is None or message.channel.id in CONFIG.XP_CONFIG.XP_BLACKLIST_CHANNELS:
             return
 
         prefixes = await get_prefix(self.bot, message)
diff --git a/src/tux/modules/services/status_roles.py b/src/tux/modules/services/status_roles.py
@@ -6,24 +6,23 @@
 from loguru import logger
 
 from tux.core.base_cog import BaseCog
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 
 
 class StatusRoles(BaseCog):
     """Assign roles to users based on their status."""
 
     def __init__(self, bot: commands.Bot):
         self.bot = bot
-        self.status_roles = CONFIG.STATUS_ROLES
         self._unload_task = None  # Store task reference here
 
-        # Check if config exists and is valid
-        if not self.status_roles:
-            logger.warning("No status roles configurations found. Unloading StatusRoles cog.")
+        # Check if mappings exist and are valid
+        if not CONFIG.STATUS_ROLES.MAPPINGS:
+            logger.warning("No status role mappings found. Unloading StatusRoles cog.")
             # Store the task reference
             self._unload_task = asyncio.create_task(self._unload_self())
         else:
-            logger.info(f"StatusRoles cog initialized with {len(self.status_roles)} role configurations")
+            logger.info(f"StatusRoles cog initialized with {len(CONFIG.STATUS_ROLES.MAPPINGS)} mappings")
 
     async def _unload_self(self):
         """Unload this cog if configuration is missing."""
@@ -86,17 +85,17 @@ async def check_and_update_roles(self, member: discord.Member):
         if status_text is None:
             status_text = ""  # Use empty string for regex matching if no status
 
-        for config in self.status_roles:
-            # Skip if the config is for a different server
-            if int(config.get("server_id", 0)) != member.guild.id:
+        for mapping in CONFIG.STATUS_ROLES.MAPPINGS:
+            # Skip if the mapping is for a different server
+            if int(mapping.get("server_id", 0)) != member.guild.id:
                 continue
 
-            role_id = int(config.get("role_id", 0))
-            pattern = str(config.get("status_regex", ".*"))
+            role_id = int(mapping.get("role_id", 0))
+            pattern = str(mapping.get("status_regex", ".*"))
 
             role = member.guild.get_role(role_id)
             if not role:
-                logger.warning(f"Role {role_id} configured in STATUS_ROLES not found in guild {member.guild.name}")
+                logger.warning(f"Role {role_id} configured in status roles not found in guild {member.guild.name}")
                 continue
 
             try:
diff --git a/src/tux/modules/services/temp_vc.py b/src/tux/modules/services/temp_vc.py
@@ -3,7 +3,7 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 
 
 class TempVc(BaseCog):
@@ -33,8 +33,8 @@ async def on_voice_state_update(
         """
 
         # Ensure CONFIGants are set correctly
-        temp_channel_id = int(CONFIG.TEMPVC_CHANNEL_ID or "0")
-        temp_category_id = int(CONFIG.TEMPVC_CATEGORY_ID or "0")
+        temp_channel_id = int(CONFIG.TEMPVC.TEMPVC_CHANNEL_ID or "0")
+        temp_category_id = int(CONFIG.TEMPVC.TEMPVC_CATEGORY_ID or "0")
         if temp_channel_id == 0 or temp_category_id == 0:
             return
 
diff --git a/src/tux/modules/snippets/__init__.py b/src/tux/modules/snippets/__init__.py
@@ -7,7 +7,7 @@
 from tux.core.types import Tux
 from tux.database.models import CaseType as DBCaseType
 from tux.database.models import Snippet
-from tux.shared.config.settings import Config
+from tux.shared.config import CONFIG
 from tux.shared.constants import CONST
 from tux.shared.exceptions import PermissionLevelError
 from tux.ui.embeds import EmbedCreator, EmbedType
@@ -152,11 +152,11 @@ async def snippet_check(
             return False, "You are banned from using snippets."
 
         if (
-            Config.LIMIT_TO_ROLE_IDS
+            CONFIG.SNIPPETS.LIMIT_TO_ROLE_IDS
             and isinstance(ctx.author, discord.Member)
-            and all(role.id not in Config.ACCESS_ROLE_IDS for role in ctx.author.roles)
+            and all(role.id not in CONFIG.SNIPPETS.ACCESS_ROLE_IDS for role in ctx.author.roles)
         ):
-            roles_str = ", ".join([f"<@&{role_id}>" for role_id in Config.ACCESS_ROLE_IDS])
+            roles_str = ", ".join([f"<@&{role_id}>" for role_id in CONFIG.SNIPPETS.ACCESS_ROLE_IDS])
             return (
                 False,
                 f"You do not have a role that allows you to manage snippets. Accepted roles: {roles_str}",
diff --git a/src/tux/modules/tools/wolfram.py b/src/tux/modules/tools/wolfram.py
@@ -11,7 +11,7 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.settings import CONFIG
+from tux.shared.config import CONFIG
 from tux.ui.embeds import EmbedCreator
 
 
@@ -20,7 +20,7 @@ def __init__(self, bot: Tux) -> None:
         super().__init__(bot)
 
         # Verify AppID configuration; unload cog if missing
-        if not CONFIG.WOLFRAM_APP_ID:
+        if not CONFIG.EXTERNAL_SERVICES.WOLFRAM_APP_ID:
             logger.warning("Wolfram Alpha API ID is not set. Some Science/Math commands will not work.")
             # Store the task reference
             self._unload_task = asyncio.create_task(self._unload_self())
@@ -55,7 +55,7 @@ async def wolfram(self, ctx: commands.Context[Tux], *, query: str) -> None:
 
         # Build the Simple API endpoint URL with URL-encoded query
         encoded = quote_plus(query)
-        url = f"https://api.wolframalpha.com/v1/simple?appid={CONFIG.WOLFRAM_APP_ID}&i={encoded}"
+        url = f"https://api.wolframalpha.com/v1/simple?appid={CONFIG.EXTERNAL_SERVICES.WOLFRAM_APP_ID}&i={encoded}"
 
         try:
             # Perform async HTTP GET with a 10-second timeout
diff --git a/src/tux/modules/utility/__init__.py b/src/tux/modules/utility/__init__.py
@@ -4,7 +4,7 @@
 
 import discord
 
-from tux.database.service import DatabaseService
+from tux.database.controllers import DatabaseCoordinator
 from tux.shared.constants import CONST
 
 __all__ = ("add_afk", "del_afk")
@@ -25,7 +25,7 @@ def _generate_afk_nickname(display_name: str) -> str:
 
 
 async def add_afk(
-    db: DatabaseService,
+    db: DatabaseCoordinator,
     reason: str,
     target: discord.Member,
     guild_id: int,
@@ -43,7 +43,7 @@ async def add_afk(
         await target.edit(nick=new_name)
 
 
-async def del_afk(db: DatabaseService, target: discord.Member, nickname: str) -> None:
+async def del_afk(db: DatabaseCoordinator, target: discord.Member, nickname: str) -> None:
     """Removes a member's AFK status, restores their nickname, and updates the database."""
     await db.afk.remove_afk(target.id, target.guild.id)
 
diff --git a/src/tux/modules/utility/ping.py b/src/tux/modules/utility/ping.py
@@ -5,7 +5,6 @@
 
 from tux.core.base_cog import BaseCog
 from tux.core.types import Tux
-from tux.shared.config.env import get_current_env
 from tux.ui.embeds import EmbedCreator
 
 
@@ -31,8 +30,6 @@ async def ping(self, ctx: commands.Context[Tux]) -> None:
         # Get the latency of the bot in milliseconds
         discord_ping = round(self.bot.latency * 1000)
 
-        environment = get_current_env()
-
         # Handles Time (turning POSIX time datetime)
         bot_start_time = datetime.fromtimestamp(self.bot.uptime, UTC)
         current_time = datetime.now(UTC)  # Get current time
@@ -77,7 +74,6 @@ async def ping(self, ctx: commands.Context[Tux]) -> None:
         embed.add_field(name="Uptime", value=f"{bot_uptime_readable}", inline=True)
         embed.add_field(name="CPU Usage", value=f"{cpu_usage}%", inline=True)
         embed.add_field(name="RAM Usage", value=f"{ram_amount_formatted}", inline=True)
-        embed.add_field(name="Prod/Dev", value=f"`{environment}`", inline=True)
 
         await ctx.send(embed=embed)
 
