Use separate unique logging object for config logging

Author: CarrotManMatt

cogs/startup.py

@@ -40,10 +40,6 @@ async def on_ready(self) -> None:
         Shortcut accessors should only be populated once TeX-Bot is ready to make API requests.
         """
         if settings["DISCORD_LOG_CHANNEL_WEBHOOK_URL"]:
-            for handler in logger.handlers:
-                if isinstance(handler, DiscordHandler):
-                    logger.removeHandler(handler)
-
             discord_logging_handler: logging.Handler = DiscordHandler(
                 service_name=self.bot.user.name if self.bot.user else "TeX-Bot",
                 webhook_url=settings["DISCORD_LOG_CHANNEL_WEBHOOK_URL"],

config.py

@@ -134,8 +134,47 @@ def __getitem__(self, item: str) -> "Any":  # type: ignore[explicit-any]  # noqa
 
             raise KeyError(key_error_message) from None
 
-    @staticmethod
-    def _setup_logging() -> None:
+    @classmethod
+    def _setup_discord_log_channel_webhook(cls) -> "Logger":
+        raw_discord_log_channel_webhook_url: str = os.getenv(
+            "DISCORD_LOG_CHANNEL_WEBHOOK_URL",
+            "",
+        )
+
+        if raw_discord_log_channel_webhook_url and (
+            not validators.url(raw_discord_log_channel_webhook_url)
+            or not raw_discord_log_channel_webhook_url.startswith(
+                "https://discord.com/api/webhooks/"
+            )
+        ):
+            INVALID_DISCORD_LOG_CHANNEL_WEBHOOK_URL_MESSAGE: Final[str] = (
+                "DISCORD_LOG_CHANNEL_WEBHOOK_URL must be a valid webhook URL "
+                "that points to a discord channel where logs should be displayed."
+            )
+            raise ImproperlyConfiguredError(INVALID_DISCORD_LOG_CHANNEL_WEBHOOK_URL_MESSAGE)
+
+        webhook_config_logger: Logger = logging.getLogger("_temp_webhook_config")
+
+        if raw_discord_log_channel_webhook_url:
+            discord_logging_handler: logging.Handler = DiscordHandler(
+                service_name="TeX-Bot",
+                webhook_url=raw_discord_log_channel_webhook_url,
+            )
+
+            discord_logging_handler.setLevel(logging.WARNING)
+
+            discord_logging_handler.setFormatter(
+                logging.Formatter("{levelname} | {message}", style="{"),
+            )
+
+            webhook_config_logger.addHandler(discord_logging_handler)
+
+        cls._settings["DISCORD_LOG_CHANNEL_WEBHOOK_URL"] = raw_discord_log_channel_webhook_url
+
+        return webhook_config_logger
+
+    @classmethod
+    def _setup_logging(cls) -> None:
         raw_console_log_level: str = str(os.getenv("CONSOLE_LOG_LEVEL", "INFO")).upper()
 
         if raw_console_log_level not in LOG_LEVEL_CHOICES:
@@ -177,47 +216,6 @@ def _setup_discord_bot_token(cls) -> None:
 
         cls._settings["DISCORD_BOT_TOKEN"] = raw_discord_bot_token
 
-    @classmethod
-    def _setup_discord_log_channel_webhook_url(cls) -> None:
-        raw_discord_log_channel_webhook_url: str = os.getenv(
-            "DISCORD_LOG_CHANNEL_WEBHOOK_URL",
-            "",
-        )
-
-        DISCORD_LOG_CHANNEL_WEBHOOK_URL_IS_VALID: Final[bool] = bool(
-            not raw_discord_log_channel_webhook_url
-            or (
-                validators.url(raw_discord_log_channel_webhook_url)
-                and raw_discord_log_channel_webhook_url.startswith(
-                    "https://discord.com/api/webhooks/",
-                )
-            ),
-        )
-        if not DISCORD_LOG_CHANNEL_WEBHOOK_URL_IS_VALID:
-            INVALID_DISCORD_LOG_CHANNEL_WEBHOOK_URL_MESSAGE: Final[str] = (
-                "DISCORD_LOG_CHANNEL_WEBHOOK_URL must be a valid webhook URL "
-                "that points to a discord channel where logs should be displayed."
-            )
-            raise ImproperlyConfiguredError(INVALID_DISCORD_LOG_CHANNEL_WEBHOOK_URL_MESSAGE)
-
-        cls._settings["DISCORD_LOG_CHANNEL_WEBHOOK_URL"] = raw_discord_log_channel_webhook_url
-
-    @classmethod
-    def _setup_discord_logging_channel(cls) -> None:
-        if cls._settings["DISCORD_LOG_CHANNEL_WEBHOOK_URL"]:
-            discord_logging_handler: logging.Handler = DiscordHandler(
-                service_name="TeX-Bot",
-                webhook_url=cls._settings["DISCORD_LOG_CHANNEL_WEBHOOK_URL"],
-            )
-
-            discord_logging_handler.setLevel(logging.WARNING)
-
-            discord_logging_handler.setFormatter(
-                logging.Formatter("{levelname} | {message}", style="{"),
-            )
-
-            logger.addHandler(discord_logging_handler)
-
     @classmethod
     def _setup_discord_guild_id(cls) -> None:
         raw_discord_guild_id: str | None = os.getenv("DISCORD_GUILD_ID")
@@ -230,7 +228,6 @@ def _setup_discord_guild_id(cls) -> None:
                 "DISCORD_GUILD_ID must be a valid Discord guild ID "
                 "(see https://docs.pycord.dev/en/stable/api/abcs.html#discord.abc.Snowflake.id)."
             )
-            logger.error(INVALID_DISCORD_GUILD_ID_MESSAGE)
             raise ImproperlyConfiguredError(INVALID_DISCORD_GUILD_ID_MESSAGE)
 
         cls._settings["_DISCORD_MAIN_GUILD_ID"] = int(raw_discord_guild_id)  # type: ignore[arg-type]
@@ -247,8 +244,8 @@ def _setup_group_full_name(cls) -> None:
             INVALID_GROUP_FULL_NAME: Final[str] = (
                 "GROUP_NAME must not contain any invalid characters."
             )
-            logger.error(INVALID_GROUP_FULL_NAME)
             raise ImproperlyConfiguredError(INVALID_GROUP_FULL_NAME)
+
         cls._settings["_GROUP_FULL_NAME"] = raw_group_full_name
 
     @classmethod
@@ -263,8 +260,8 @@ def _setup_group_short_name(cls) -> None:
             INVALID_GROUP_SHORT_NAME: Final[str] = (
                 "GROUP_SHORT_NAME must not contain any invalid characters."
             )
-            logger.error(INVALID_GROUP_SHORT_NAME)
             raise ImproperlyConfiguredError(INVALID_GROUP_SHORT_NAME)
+
         cls._settings["_GROUP_SHORT_NAME"] = raw_group_short_name
 
     @classmethod
@@ -278,7 +275,6 @@ def _setup_purchase_membership_url(cls) -> None:
             INVALID_PURCHASE_MEMBERSHIP_URL_MESSAGE: Final[str] = (
                 "PURCHASE_MEMBERSHIP_URL must be a valid URL."
             )
-            logger.error(INVALID_PURCHASE_MEMBERSHIP_URL_MESSAGE)
             raise ImproperlyConfiguredError(INVALID_PURCHASE_MEMBERSHIP_URL_MESSAGE)
 
         cls._settings["PURCHASE_MEMBERSHIP_URL"] = raw_purchase_membership_url
@@ -294,7 +290,6 @@ def _setup_membership_perks_url(cls) -> None:
             INVALID_MEMBERSHIP_PERKS_URL_MESSAGE: Final[str] = (
                 "MEMBERSHIP_PERKS_URL must be a valid URL."
             )
-            logger.error(INVALID_MEMBERSHIP_PERKS_URL_MESSAGE)
             raise ImproperlyConfiguredError(INVALID_MEMBERSHIP_PERKS_URL_MESSAGE)
 
         cls._settings["MEMBERSHIP_PERKS_URL"] = raw_membership_perks_url
@@ -311,7 +306,6 @@ def _setup_ping_command_easter_egg_probability(cls) -> None:
                 os.getenv("PING_COMMAND_EASTER_EGG_PROBABILITY", "0.01"),
             )
         except ValueError as e:
-            logger.error(INVALID_PING_COMMAND_EASTER_EGG_PROBABILITY_MESSAGE)  # noqa: TRY400
             raise (
                 ImproperlyConfiguredError(INVALID_PING_COMMAND_EASTER_EGG_PROBABILITY_MESSAGE)
             ) from e
@@ -343,7 +337,6 @@ def _get_messages_dict(cls, raw_messages_file_path: str | None) -> Mapping[str,
             MESSAGES_FILE_PATH_DOES_NOT_EXIST_MESSAGE: Final[str] = (
                 "MESSAGES_FILE_PATH must be a path to a file that exists."
             )
-            logger.error(MESSAGES_FILE_PATH_DOES_NOT_EXIST_MESSAGE)
             raise ImproperlyConfiguredError(MESSAGES_FILE_PATH_DOES_NOT_EXIST_MESSAGE)
 
         messages_file: IO[str]
@@ -352,11 +345,9 @@ def _get_messages_dict(cls, raw_messages_file_path: str | None) -> Mapping[str,
             try:
                 messages_dict: object = json.load(messages_file)
             except json.JSONDecodeError as e:
-                logger.error(JSON_DECODING_ERROR_MESSAGE)  # noqa: TRY400
                 raise ImproperlyConfiguredError(JSON_DECODING_ERROR_MESSAGE) from e
 
         if not isinstance(messages_dict, Mapping):
-            logger.error(JSON_DECODING_ERROR_MESSAGE)
             raise ImproperlyConfiguredError(JSON_DECODING_ERROR_MESSAGE)
 
         return messages_dict
@@ -375,7 +366,6 @@ def _setup_welcome_messages(cls) -> None:
             and messages_dict["welcome_messages"],
         )
         if not WELCOME_MESSAGES_KEY_IS_VALID:
-            logger.error("Unable to locate welcome messages.")
             raise MessagesJSONFileValueError(
                 dict_key="welcome_messages",
                 invalid_value=messages_dict["welcome_messages"],
@@ -396,11 +386,11 @@ def _setup_roles_messages(cls) -> None:
             messages_dict["roles_messages"], Iterable
         ) and bool(messages_dict["roles_messages"])
         if not ROLES_MESSAGES_KEY_IS_VALID:
-            logger.error("Unable to locate role messages.")
             raise MessagesJSONFileValueError(
                 dict_key="roles_messages",
                 invalid_value=messages_dict["roles_messages"],
             )
+
         cls._settings["ROLES_MESSAGES"] = set(messages_dict["roles_messages"])  # type: ignore[call-overload]
 
     @classmethod
@@ -415,7 +405,6 @@ def _setup_organisation_id(cls) -> None:
             INVALID_ORGANISATION_ID_MESSAGE: Final[str] = (
                 "ORGANISATION_ID must be an integer 4 to 5 digits long."
             )
-            logger.error(INVALID_ORGANISATION_ID_MESSAGE)
             raise ImproperlyConfiguredError(message=INVALID_ORGANISATION_ID_MESSAGE)
 
         cls._settings["ORGANISATION_ID"] = raw_organisation_id
@@ -434,7 +423,6 @@ def _setup_members_list_auth_session_cookie(cls) -> None:
             INVALID_MEMBERS_LIST_AUTH_SESSION_COOKIE_MESSAGE: Final[str] = (
                 "MEMBERS_LIST_URL_SESSION_COOKIE must be a valid .ASPXAUTH cookie."
             )
-            logger.error(INVALID_MEMBERS_LIST_AUTH_SESSION_COOKIE_MESSAGE)
             raise ImproperlyConfiguredError(INVALID_MEMBERS_LIST_AUTH_SESSION_COOKIE_MESSAGE)
 
         cls._settings["MEMBERS_LIST_AUTH_SESSION_COOKIE"] = (
@@ -451,7 +439,6 @@ def _setup_send_introduction_reminders(cls) -> None:
             INVALID_SEND_INTRODUCTION_REMINDERS_MESSAGE: Final[str] = (
                 'SEND_INTRODUCTION_REMINDERS must be one of: "Once", "Interval" or "False".'
             )
-            logger.error(INVALID_SEND_INTRODUCTION_REMINDERS_MESSAGE)
             raise ImproperlyConfiguredError(INVALID_SEND_INTRODUCTION_REMINDERS_MESSAGE)
 
         if raw_send_introduction_reminders in TRUE_VALUES:
@@ -484,7 +471,6 @@ def _setup_send_introduction_reminders_delay(cls) -> None:
                     "SEND_INTRODUCTION_REMINDERS_DELAY must contain the delay "
                     "in any combination of seconds, minutes, hours, days or weeks."
                 )
-                logger.error(INVALID_SEND_INTRODUCTION_REMINDERS_DELAY_MESSAGE)
                 raise ImproperlyConfiguredError(
                     INVALID_SEND_INTRODUCTION_REMINDERS_DELAY_MESSAGE,
                 )
@@ -502,7 +488,6 @@ def _setup_send_introduction_reminders_delay(cls) -> None:
                     "SEND_INTRODUCTION_REMINDERS_DELAY must be longer than or equal to 1 day "
                     "(in any allowed format)."
                 )
-                logger.error(TOO_SMALL_SEND_INTRODUCTION_REMINDERS_DELAY_MESSAGE)
                 raise ImproperlyConfiguredError(
                     TOO_SMALL_SEND_INTRODUCTION_REMINDERS_DELAY_MESSAGE,
                 )
@@ -518,7 +503,6 @@ def _setup_send_introduction_reminders_interval(cls) -> None:
                 "Invalid setup order: SEND_INTRODUCTION_REMINDERS must be set up "
                 "before SEND_INTRODUCTION_REMINDERS_INTERVAL can be set up."
             )
-            logger.error(INVALID_SETUP_ORDER_MESSAGE)
             raise RuntimeError(INVALID_SETUP_ORDER_MESSAGE)
 
         raw_send_introduction_reminders_interval: re.Match[str] | None = re.fullmatch(
@@ -536,7 +520,6 @@ def _setup_send_introduction_reminders_interval(cls) -> None:
                     "SEND_INTRODUCTION_REMINDERS_INTERVAL must contain the interval "
                     "in any combination of seconds, minutes or hours."
                 )
-                logger.error(INVALID_SEND_INTRODUCTION_REMINDERS_INTERVAL_MESSAGE)
                 raise ImproperlyConfiguredError(
                     INVALID_SEND_INTRODUCTION_REMINDERS_INTERVAL_MESSAGE,
                 )
@@ -561,7 +544,6 @@ def _setup_send_get_roles_reminders(cls) -> None:
             INVALID_SEND_GET_ROLES_REMINDERS_MESSAGE: Final[str] = (
                 "SEND_GET_ROLES_REMINDERS must be a boolean value."
             )
-            logger.error(INVALID_SEND_GET_ROLES_REMINDERS_MESSAGE)
             raise ImproperlyConfiguredError(INVALID_SEND_GET_ROLES_REMINDERS_MESSAGE)
 
         cls._settings["SEND_GET_ROLES_REMINDERS"] = raw_send_get_roles_reminders in TRUE_VALUES
@@ -588,7 +570,6 @@ def _setup_send_get_roles_reminders_delay(cls) -> None:
                     "SEND_GET_ROLES_REMINDERS_DELAY must contain the delay "
                     "in any combination of seconds, minutes, hours, days or weeks."
                 )
-                logger.error(INVALID_SEND_GET_ROLES_REMINDERS_DELAY_MESSAGE)
                 raise ImproperlyConfiguredError(
                     INVALID_SEND_GET_ROLES_REMINDERS_DELAY_MESSAGE,
                 )
@@ -606,7 +587,6 @@ def _setup_send_get_roles_reminders_delay(cls) -> None:
                     "SEND_SEND_GET_ROLES_REMINDERS_DELAY "
                     "must be longer than or equal to 1 day (in any allowed format)."
                 )
-                logger.error(TOO_SMALL_SEND_GET_ROLES_REMINDERS_DELAY_MESSAGE)
                 raise ImproperlyConfiguredError(
                     TOO_SMALL_SEND_GET_ROLES_REMINDERS_DELAY_MESSAGE,
                 )
@@ -622,7 +602,6 @@ def _setup_advanced_send_get_roles_reminders_interval(cls) -> None:
                 "Invalid setup order: SEND_GET_ROLES_REMINDERS must be set up "
                 "before ADVANCED_SEND_GET_ROLES_REMINDERS_INTERVAL can be set up."
             )
-            logger.error(INVALID_SETUP_ORDER_MESSAGE)
             raise RuntimeError(INVALID_SETUP_ORDER_MESSAGE)
 
         raw_advanced_send_get_roles_reminders_interval: re.Match[str] | None = re.fullmatch(
@@ -642,7 +621,6 @@ def _setup_advanced_send_get_roles_reminders_interval(cls) -> None:
                     "ADVANCED_SEND_GET_ROLES_REMINDERS_INTERVAL must contain the interval "
                     "in any combination of seconds, minutes or hours."
                 )
-                logger.error(INVALID_ADVANCED_SEND_GET_ROLES_REMINDERS_INTERVAL_MESSAGE)
                 raise ImproperlyConfiguredError(
                     INVALID_ADVANCED_SEND_GET_ROLES_REMINDERS_INTERVAL_MESSAGE,
                 )
@@ -668,7 +646,6 @@ def _setup_statistics_days(cls) -> None:
             INVALID_STATISTICS_DAYS_MESSAGE: Final[str] = (
                 "STATISTICS_DAYS must contain the statistics period in days."
             )
-            logger.error(INVALID_STATISTICS_DAYS_MESSAGE)  # noqa: TRY400
             raise ImproperlyConfiguredError(INVALID_STATISTICS_DAYS_MESSAGE) from e
 
         cls._settings["STATISTICS_DAYS"] = timedelta(days=raw_statistics_days)
@@ -698,7 +675,6 @@ def _setup_moderation_document_url(cls) -> None:
             MODERATION_DOCUMENT_URL_MESSAGE: Final[str] = (
                 "MODERATION_DOCUMENT_URL must be a valid URL."
             )
-            logger.error(MODERATION_DOCUMENT_URL_MESSAGE)
             raise ImproperlyConfiguredError(MODERATION_DOCUMENT_URL_MESSAGE)
 
         cls._settings["MODERATION_DOCUMENT_URL"] = raw_moderation_document_url
@@ -714,7 +690,6 @@ def _setup_strike_performed_manually_warning_location(cls) -> None:
                 "MANUAL_MODERATION_WARNING_MESSAGE_LOCATION must be a valid name "
                 "of a channel in your group's Discord guild."
             )
-            logger.error(STRIKE_PERFORMED_MANUALLY_WARNING_LOCATION_MESSAGE)
             raise ImproperlyConfiguredError(STRIKE_PERFORMED_MANUALLY_WARNING_LOCATION_MESSAGE)
 
         cls._settings["STRIKE_PERFORMED_MANUALLY_WARNING_LOCATION"] = (
@@ -751,31 +726,35 @@ def _setup_env_variables(cls) -> None:
 
         dotenv.load_dotenv()
 
-        cls._setup_logging()
-        cls._setup_discord_bot_token()
-        cls._setup_discord_log_channel_webhook_url()
-        cls._setup_discord_logging_channel()
-        cls._setup_discord_guild_id()
-        cls._setup_group_full_name()
-        cls._setup_group_short_name()
-        cls._setup_ping_command_easter_egg_probability()
-        cls._setup_welcome_messages()
-        cls._setup_roles_messages()
-        cls._setup_organisation_id()
-        cls._setup_members_list_auth_session_cookie()
-        cls._setup_membership_perks_url()
-        cls._setup_purchase_membership_url()
-        cls._setup_send_introduction_reminders()
-        cls._setup_send_introduction_reminders_delay()
-        cls._setup_send_introduction_reminders_interval()
-        cls._setup_send_get_roles_reminders()
-        cls._setup_send_get_roles_reminders_delay()
-        cls._setup_advanced_send_get_roles_reminders_interval()
-        cls._setup_statistics_days()
-        cls._setup_statistics_roles()
-        cls._setup_moderation_document_url()
-        cls._setup_strike_performed_manually_warning_location()
-        cls._setup_auto_add_committee_to_threads()
+        webhook_config_logger: Logger = cls._setup_discord_log_channel_webhook()
+
+        try:
+            cls._setup_logging()
+            cls._setup_discord_bot_token()
+            cls._setup_discord_guild_id()
+            cls._setup_group_full_name()
+            cls._setup_group_short_name()
+            cls._setup_ping_command_easter_egg_probability()
+            cls._setup_welcome_messages()
+            cls._setup_roles_messages()
+            cls._setup_organisation_id()
+            cls._setup_members_list_auth_session_cookie()
+            cls._setup_membership_perks_url()
+            cls._setup_purchase_membership_url()
+            cls._setup_send_introduction_reminders()
+            cls._setup_send_introduction_reminders_delay()
+            cls._setup_send_introduction_reminders_interval()
+            cls._setup_send_get_roles_reminders()
+            cls._setup_send_get_roles_reminders_delay()
+            cls._setup_advanced_send_get_roles_reminders_interval()
+            cls._setup_statistics_days()
+            cls._setup_statistics_roles()
+            cls._setup_moderation_document_url()
+            cls._setup_strike_performed_manually_warning_location()
+            cls._setup_auto_add_committee_to_threads()
+        except ImproperlyConfiguredError as e:
+            webhook_config_logger.error(e.message)  # noqa: TRY400
+            raise e from e
 
         cls._is_env_variables_setup = True
 
@@ -799,8 +778,7 @@ class RuntimeSettings(Settings):
 
 
 def run_setup() -> None:
-    """Execute the setup functions required, before other modules can be run."""
-    # noinspection PyProtectedMember
+    """Execute the required setup functions."""
     settings._setup_env_variables()  # noqa: SLF001
 
     logger.debug("Begin database setup")