🧑‍💻 Dev. experience improvements

Author: Paillat-dev

src/__main__.py

@@ -7,40 +7,18 @@
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 # the above line allows us to import from src without any issues whilst using src/__main__.py
 import asyncio
-import importlib.util
-from glob import iglob
-
-from src.config import config
-from src.log import logger
-from src.utils.setup_func import setup_func
-
-
-async def load_and_run_patches() -> None:
-    for patch_file in iglob("src/extensions/*/patch.py"):
-        extension = os.path.basename(os.path.dirname(patch_file))
-        if (
-            config["extensions"]
-            .get(extension, config["extensions"].get(extension.replace("_", "-")))
-            .get("enabled", False)
-        ):
-            logger.info(f"Loading patch for extension {extension}")
-            spec = importlib.util.spec_from_file_location(f"src.extensions.{extension}.patch", patch_file)
-            if not spec or not spec.loader:
-                continue
-            patch_module = importlib.util.module_from_spec(spec)
-            spec.loader.exec_module(patch_module)
-            if hasattr(patch_module, "patch") and callable(patch_module.patch):
-                await setup_func(patch_module.patch, config=config["extensions"][extension])
-
-
-async def pre_main() -> None:
+
+from src.patcher import load_and_run_patches
+
+
+async def main() -> None:
     await load_and_run_patches()
-    # we import main here to apply patches before importing the most things we can
+    # we import main here to apply patches before importing as many things we can
     # and allow the patches to be applied to later imported modules
-    from src.start import main
+    from src.start import start
 
-    await main()
+    await start()
 
 
 if __name__ == "__main__":
-    asyncio.run(pre_main())
+    asyncio.run(main())

src/config/__init__.py

@@ -1,6 +1,6 @@
 # Copyright (c) NiceBots.xyz
 # SPDX-License-Identifier: MIT
 
-from .bot_config import config, store_config
+from .bot_config import config
 
-__all__ = ["config", "store_config"]
+__all__ = ["config"]

src/config/bot_config.py

@@ -66,10 +66,3 @@ def load_json_recursive(data: dict[str, Any]) -> dict[str, Any]:
         config = yaml.safe_load(f)
 else:
     config = load_from_env()
-
-
-def store_config() -> None:
-    if path:
-        # noinspection PyShadowingNames
-        with open(path, "w", encoding="utf-8") as f:
-            yaml.dump(config, f)

src/extensions/nice_errors/handlers/base.py

@@ -111,7 +111,9 @@ def add_error_handler[E: Exception](self, error: None, handler: ErrorHandlerType
     def add_error_handler[E: Exception](self, error: type[E], handler: ErrorHandlerType[E]) -> None: ...
 
     def add_error_handler[E: Exception](self, error: type[E] | None, handler: ErrorHandlerType[E | Exception]) -> None:
-        logger.info(f"Adding error handler {handler} for {error if error is not None else 'Generic'}")
+        logger.info(
+            f"Adding error handler {handler.__class__.__qualname__} for {error.__qualname__ if error is not None else 'Generic'}"  # noqa: E501
+        )
         self.error_handlers[error] = handler
 
 

src/patcher.py

@@ -0,0 +1,32 @@
+# Copyright (c) NiceBots.xyz
+# SPDX-License-Identifier: MIT
+
+import os
+import sys
+from typing import Any
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
+# the above line allows us to import from src without any issues whilst using src/__main__.py
+import importlib.util
+from glob import iglob
+
+from src.config import config
+from src.log import logger
+from src.utils.setup_func import setup_func
+
+
+async def load_and_run_patches() -> None:
+    for patch_file in iglob("src/extensions/*/patch.py"):
+        extension = os.path.basename(os.path.dirname(patch_file))
+        its_config: dict[Any, Any] = {}
+        if its_config := (
+            config["extensions"].get(extension, config["extensions"].get(extension.replace("_", "-"), {}))
+        ) and its_config.get("enabled", False):
+            logger.info(f"Loading patch for extension {extension}")
+            spec = importlib.util.spec_from_file_location(f"src.extensions.{extension}.patch", patch_file)
+            if not spec or not spec.loader:
+                continue
+            patch_module = importlib.util.module_from_spec(spec)
+            spec.loader.exec_module(patch_module)
+            if hasattr(patch_module, "patch") and callable(patch_module.patch):
+                await setup_func(patch_module.patch, config=its_config)

src/start.py

@@ -10,11 +10,12 @@
 
 import discord
 import yaml
+from discord.errors import LoginFailure
 from discord.ext import commands
 from quart import Quart
 
 from src import custom, i18n
-from src.config import config, store_config
+from src.config import config
 from src.i18n.classes import ExtensionTranslation
 from src.log import logger, patch
 from src.utils import setup_func, unzip_extensions, validate_module
@@ -31,7 +32,11 @@ class FunctionConfig(TypedDict):
 
 
 async def start_bot(bot: custom.Bot, token: str) -> None:
-    await bot.start(token)
+    try:
+        await bot.start(token)
+    except LoginFailure as e:
+        logger.critical("Failed to log in, is the bot token valid?")
+        logger.debug("", exc_info=e)
 
 
 async def start_backend(app: Quart, bot: discord.Bot, token: str) -> None:
@@ -72,6 +77,13 @@ def load_extensions() -> (
         "list[ExtensionTranslation]",
     ]
 ):
+    """Load extensions from the extensions directory.
+
+    Returns:
+        tuple[FunctionlistType, FunctionlistType, FunctionlistType, list[ExtensionTranslation]]: A tuple containing
+        the bot functions, backend functions, startup functions, and translations.
+
+    """
     bot_functions: FunctionlistType = []
     back_functions: FunctionlistType = []
     startup_functions: FunctionlistType = []
@@ -157,7 +169,7 @@ async def run_startup_functions(
     await asyncio.gather(*startup_coros)
 
 
-async def main(run_bot: bool | None = None, run_backend: bool | None = None) -> None:
+async def start(run_bot: bool | None = None, run_backend: bool | None = None) -> None:
     if not config.get("bot", {}).get("token"):
         logger.critical("No bot token provided in config, exiting...")
         return
@@ -182,5 +194,3 @@ async def main(run_bot: bool | None = None, run_backend: bool | None = None) ->
         await run_startup_functions(startup_functions, app, back_bot)
 
     await asyncio.gather(*coros)
-
-    store_config()