Revert:

- Restore import orders
- Logging stuff is now completely handled in `core.models.configure_logging`

Author: Jerrie-Aries

bot.py

@@ -1,18 +1,6 @@
 __version__ = "4.0.2"
 
 
-# early import to initialize colorama
-from core.models import (
-    DMDisabled,
-    HostingMethod,
-    InvalidConfigError,
-    PermissionLevel,
-    SafeFormatter,
-    create_log_handler,
-    configure_logging,
-    getLogger,
-)
-
 import asyncio
 import copy
 import hashlib
@@ -37,15 +25,31 @@
 from pkg_resources import parse_version
 
 
+try:
+    # noinspection PyUnresolvedReferences
+    from colorama import init
+
+    init()
+except ImportError:
+    pass
+
 from core import checks
 from core.changelog import Changelog
 from core.clients import ApiClient, MongoDBClient, PluginDatabaseClient
 from core.config import ConfigManager
+from core.models import (
+    DMDisabled,
+    HostingMethod,
+    InvalidConfigError,
+    PermissionLevel,
+    SafeFormatter,
+    configure_logging,
+    getLogger,
+)
 from core.thread import ThreadManager
 from core.time import human_timedelta
 from core.utils import extract_block_timestamp, normalize_alias, parse_alias, truncate, tryint
 
-
 logger = getLogger(__name__)
 
 temp_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "temp")
@@ -80,7 +84,7 @@ def __init__(self):
         self.threads = ThreadManager(self)
 
         self.log_file_name = os.path.join(temp_dir, f"{self.token.split('.')[0]}.log")
-        self._configure_logging()
+        configure_logging(self, temp_dir)
 
         self.plugin_db = PluginDatabaseClient(self)  # Deprecated
         self.startup()
@@ -173,51 +177,6 @@ async def load_extensions(self):
                 logger.exception("Failed to load %s.", cog)
         logger.line("debug")
 
-    def _configure_logging(self):
-        level_text = self.config["log_level"].upper()
-        logging_levels = {
-            "CRITICAL": logging.CRITICAL,
-            "ERROR": logging.ERROR,
-            "WARNING": logging.WARNING,
-            "INFO": logging.INFO,
-            "DEBUG": logging.DEBUG,
-        }
-        logger.line()
-
-        log_level = logging_levels.get(level_text)
-        if log_level is None:
-            log_level = self.config.remove("log_level")
-            logger.warning("Invalid logging level set: %s.", level_text)
-            logger.warning("Using default logging level: INFO.")
-        else:
-            logger.info("Logging level: %s", level_text)
-
-        logger.info("Log file: %s", self.log_file_name)
-        configure_logging(self.log_file_name, log_level)
-
-        # Set up discord.py logging
-        # repeat the step
-        level_text = os.environ.get("LOG_DISCORD", "INFO").upper()
-        log_level = logging_levels.get(level_text, logging.INFO)
-        logger.info("Setting up discord logger, logging level: %s.", logging.getLevelName(log_level))
-        d_logger = logging.getLogger("discord")
-        d_logger.setLevel(log_level)
-        is_debug = not log_level > logging.DEBUG
-        stream = create_log_handler(level=log_level if not is_debug else logging.INFO)
-        d_logger.addHandler(stream)
-        file_handler = create_log_handler(
-            self.log_file_name, rotating=True, level=log_level if not is_debug else logging.INFO
-        )
-        d_logger.addHandler(file_handler)
-
-        # internal discord.py debug logging
-        if is_debug:
-            debug_handler = create_log_handler("discord.log", level=log_level, mode="w", encoding="utf-8")
-            logger.info("Discord logger DEBUG level is enabled. Log file: %s", "discord.log")
-            d_logger.addHandler(debug_handler)
-
-        logger.debug("Successfully configured logging.")
-
     @property
     def version(self):
         return parse_version(__version__)

core/config.py

@@ -178,6 +178,7 @@ class ConfigManager:
         "disable_updates": False,
         # Logging
         "log_level": "INFO",
+        "discord_log_level": "INFO",
         # data collection
         "data_collection": True,
     }

core/config_help.json

@@ -1129,6 +1129,15 @@
       "This configuration can only to be set through `.env` file or environment (config) variables."
     ]
   },
+  "discord_log_level": {
+    "default": "INFO",
+    "description": "The `discord.py` library logging level for logging to stdout.",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
   "enable_plugins": {
     "default": "Yes",
     "description": "Whether plugins should be enabled and loaded into Modmail.",

core/models.py

@@ -2,18 +2,23 @@
 import os
 import re
 import sys
+import _string
 
+from difflib import get_close_matches
+from enum import IntEnum
 from logging import FileHandler, StreamHandler
 from logging.handlers import RotatingFileHandler
+from string import Formatter
 from typing import Optional, Union
 
+import discord
+from discord.ext import commands
+
 
 try:
-    from colorama import Fore, Style, init as color_init
+    from colorama import Fore, Style
 except ImportError:
     Fore = Style = type("Dummy", (object,), {"__getattr__": lambda self, item: ""})()
-else:
-    color_init()
 
 
 if ".heroku" in os.environ.get("PYTHONHOME", ""):
@@ -162,26 +167,58 @@ def getLogger(name=None) -> ModmailLogger:
     return logger
 
 
-def configure_logging(name, level: Optional[int] = None):
+def configure_logging(bot, log_dir: str) -> None:
     global ch_debug, log_level
-    ch_debug = create_log_handler(name, rotating=True)
+    logger = getLogger(__name__)
+    level_text = bot.config["log_level"].upper()
+    logging_levels = {
+        "CRITICAL": logging.CRITICAL,
+        "ERROR": logging.ERROR,
+        "WARNING": logging.WARNING,
+        "INFO": logging.INFO,
+        "DEBUG": logging.DEBUG,
+    }
+    logger.line()
+
+    level = logging_levels.get(level_text)
+    if level is None:
+        level = bot.config.remove("log_level")
+        logger.warning("Invalid logging level set: %s.", level_text)
+        logger.warning("Using default logging level: INFO.")
+    else:
+        logger.info("Logging level: %s", level_text)
 
-    if level is not None:
-        log_level = level
+    logger.info("Log file: %s", bot.log_file_name)
 
-    ch.setLevel(log_level)
+    ch_debug = create_log_handler(bot.log_file_name, rotating=True)
 
-    for logger in loggers:
-        logger.setLevel(log_level)
-        logger.addHandler(ch_debug)
+    log_level = level
 
+    ch.setLevel(log_level)
 
-from string import Formatter
-from difflib import get_close_matches
-from enum import IntEnum
-import _string
-import discord
-from discord.ext import commands
+    for log in loggers:
+        log.setLevel(log_level)
+        log.addHandler(ch_debug)
+
+    # Set up discord.py logging
+    d_level = logging_levels.get(bot.config["discord_log_level"].upper(), logging.INFO)
+    d_logger = logging.getLogger("discord")
+    d_logger.setLevel(d_level)
+
+    non_verbose_log_level = d_level if d_level != logging.DEBUG else logging.INFO
+    stream_handler = create_log_handler(level=non_verbose_log_level)
+    file_handler = create_log_handler(bot.log_file_name, rotating=True, level=non_verbose_log_level)
+    logger.info("Discord logging level: %s.", logging.getLevelName(non_verbose_log_level))
+    d_logger.addHandler(stream_handler)
+    d_logger.addHandler(file_handler)
+
+    # file handler for discord.py debug level
+    if d_level == logging.DEBUG:
+        dlog_file = os.path.join(log_dir, "discord.log")
+        debug_handler = create_log_handler(dlog_file, level=logging.DEBUG, mode="w", encoding="utf-8")
+        logger.info("Discord logger DEBUG level is enabled. Log file: %s", dlog_file)
+        d_logger.addHandler(debug_handler)
+    logger.debug("Successfully configured logging.")
 
 
 class InvalidConfigError(commands.BadArgument):