Rename logger

le717 · Jun 8, 2024 · eba0523 · eba0523
1 parent 8c5ca1a
commit eba0523
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 19 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -8,9 +8,11 @@ _Released TDB_
 - Update minimum Python version to 3.11
 - Update to Flask v3
 - ~~Update SQLAlchemy to v2~~ _update pending_
-- Replace `requests` with `python-httpx`
+- Update Docker image to `python:3.11-slim`
 - Update all dependencies to their latest versions
-- Switch to ruff for linting and formatting
+- Replace `requests` with `python-httpx`
+- Switch to [ruff](https://docs.astral.sh/ruff/) for linting and formatting
+- Various internal tweaks and adjustments
 
 # 1.2.0
 

diff --git a/src/app_factory.py b/src/app_factory.py
@@ -28,9 +28,9 @@ def create_app() -> Flask:
 
     # Enable Discord webhook event logging, falling back to a text log
     if sys_vars.get_bool("ENABLE_DISCORD_LOGGING"):
-        logger.LINKROT.addHandler(logger.DiscordHandler())
+        logger.logger.addHandler(logger.DiscordHandler())
     else:
-        logger.LINKROT.addHandler(logger.file_handler("error-linkrot.log", linkrot=True))
+        logger.logger.addHandler(logger.file_handler("error-linkrot.log", linkrot=True))
 
     # Register the API endpoints
     api = Api(app)

diff --git a/src/core/database/linkrot.py b/src/core/database/linkrot.py
@@ -5,7 +5,7 @@
 
 from src.core.database import weblink
 from src.core.database.schema import RottedLinks, WebLink, db
-from src.core.logger import LINKROT
+from src.core.logger import logger
 
 __all__ = ["check_all", "check_one", "delete"]
 
@@ -90,7 +90,7 @@ def check_one(uuid: str) -> RotResult:
 
         # A rotten link has been revived
         if delete(uuid):
-            LINKROT.info({
+            logger.info({
                 "id": link.id,
                 "url": link.url,
                 "message": "Link has been marked to not be dead or a Web Archive reference.",
@@ -115,7 +115,7 @@ def __record_failure(data: WebLink) -> Check:
     existing = __get(data.id)
     if existing is None:
         __create(data)
-        LINKROT.error({
+        logger.error({
             "id": data.id,
             "url": data.url,
             "message": "Linkrot check failure #1.",
@@ -126,7 +126,7 @@ def __record_failure(data: WebLink) -> Check:
     # We have an existing failure record, update the failure count
     if (existing.times_failed + 1) < TIMES_FAILED_THRESHOLD:
         __update(existing)
-        LINKROT.error({
+        logger.error({
             "id": data.id,
             "url": data.url,
             "message": f"Linkrot check failure #{existing.times_failed}.",
@@ -141,7 +141,7 @@ def __record_failure(data: WebLink) -> Check:
         revised_info["url"] = wb_url
         revised_info["is_web_archive"] = 1
         result["is_web_archive"] = True
-        LINKROT.critical({
+        logger.critical({
             "id": data.id,
             "url": data.url,
             "message": "Link has been updated to indicate a Web Archive reference.",
@@ -151,7 +151,7 @@ def __record_failure(data: WebLink) -> Check:
     else:
         revised_info["is_dead"] = 1
         result["is_dead"] = True
-        LINKROT.critical({
+        logger.critical({
             "id": data.id,
             "url": data.url,
             "message": "Link has been marked as a dead link.",

diff --git a/src/core/database/weblink.py b/src/core/database/weblink.py
@@ -1,12 +1,11 @@
-from datetime import datetime, timezone
 import uuid
+from datetime import datetime, timezone
 from typing import Any, Optional, OrderedDict
 
 from markupsafe import Markup
 
-from src.core.logger import LINKROT
 from src.core.database.schema import WebLink, db
-
+from src.core.logger import logger
 
 __all__ = ["create", "delete", "exists", "get", "get_all", "update"]
 
@@ -24,7 +23,7 @@ def create(data: OrderedDict) -> dict:
     db.session.add(weblink)
     db.session.commit()
     db.session.refresh(weblink)
-    LINKROT.info({
+    logger.info({
         "id": entry_id,
         "url": weblink.url,
         "message": "Link has been added to the webring.",
@@ -39,7 +38,7 @@ def delete(uuid: str) -> bool:
 
     db.session.delete(get(uuid))
     db.session.commit()
-    LINKROT.info({
+    logger.info({
         "id": uuid,
         "url": "N/A",
         "message": "Link has been deleted from the webring.",
@@ -89,7 +88,7 @@ def update(data: OrderedDict) -> bool:
         synchronize_session="fetch",
     )
     db.session.commit()
-    LINKROT.info({
+    logger.info({
         "id": data["id"],
         "url": "N/A",
         "message": f"Link has been updated with the following info: `{data}`",

diff --git a/src/core/logger.py b/src/core/logger.py
@@ -7,11 +7,11 @@
 import sys_vars
 from flask import request
 
-__all__ = ["LINKROT", "DiscordHandler", "file_handler"]
+__all__ = ["logger", "DiscordHandler", "file_handler"]
 
 
-LINKROT = logging.getLogger("linkrot-status")
-LINKROT.setLevel(logging.DEBUG)
+logger = logging.getLogger("linkrot-status")
+logger.setLevel(logging.DEBUG)
 
 
 def _linkrot_formatter(record: logging.LogRecord) -> str: