linkchanbot

commit 8e25e1a237e89903460af7215226c1b1b4992cea
parent 92316f0dcdeb5000c877678d101b6d681c9f7bf3
Author: Byron Torres <b@torresjrjr.com>
Date:   Wed, 31 Mar 2021 21:33:03 +0100

Improve logging with WatchedFileHandler

The default logging.FileHandler appeared to be buggy once the log file
was edited.

logging.handlers.WatchedFileHandler does not exhibit this behaviour.

@logger was renamed to @logged for clarification between namespaces.

Diffstat:
M
linkchanbot
 | 
39
++++++++++++++++++++-------------------

1 file changed, 20 insertions(+), 19 deletions(-)
diff --git a/linkchanbot b/linkchanbot
@@ -18,11 +18,11 @@ from telegram.constants import MAX_INLINE_QUERY_RESULTS as MAX_RESULTS
 from telegram import error
 
 from urllib.parse import urlparse, urlencode, parse_qs
+import logging.handlers
 import argparse
 import configparser
 import functools
 import json
-import logging
 import os
 import pathlib
 import random
@@ -133,16 +133,17 @@ def init(args):
     LOGFILE = args.logfile or os.getenv('LINKCHAN_LOGFILE') or cache_dir/'log'
 
     try:
-        logging.basicConfig(
-            filename = LOGFILE,
-            filemode = 'a',
-            format   = '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
-            level    = logging.INFO,
-        )
+        handler = logging.handlers.WatchedFileHandler(LOGFILE)
     except FileNotFoundError as e:
         stderr("Error: logfile:", e)
         exit(1)
 
+    logging.basicConfig(
+        format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+        level = logging.INFO,
+        handlers = (handler,)
+    )
+
     # Config
     TOKEN = os.getenv('LINKCHAN_TOKEN')
     ADMIN = os.getenv('LINKCHAN_ADMIN')
@@ -177,7 +178,7 @@ def init(args):
     # Validate ALTS
     for altsite, alt in ALTS.items():
         if 'service' not in alt:
-            logging.warning(
+            logging.warn(
                 f"alts.json: '{altsite}' has no 'service' value, ignored"
             )
 
@@ -193,7 +194,7 @@ def stderr(*args, **kwargs):
     """
     print(*args, **kwargs, file=sys.stderr)
 
-def logger(old_cb_func):
+def logged(old_cb_func):
     """
     Wraps callback functions, logs incomming telegram updates.
     """
@@ -223,7 +224,7 @@ def logger(old_cb_func):
 def mk_status(upd, utype, dl='::', text=None):
     """
     Prepares a standardised string for logging.
-    Called by wrapped callbacks (see logger())
+    Called by wrapped callbacks (see @logged)
     or by callbacks for terminal output.
     """
     uid       = upd.update_id
@@ -312,7 +313,7 @@ def oneline(s: str) -> str:
 
 # Callback Handlers
 
-@logger
+@logged
 def cb_start(upd, ctx):
     """
     /start callback
@@ -408,7 +409,7 @@ See /about or @linkchan\_updates.
     )
 
 
-@logger
+@logged
 def cb_about(upd, ctx):
     """
     /about callback
@@ -466,14 +467,14 @@ def examples(upd, ctx):
 
 
 
-@logger
+@logged
 def cb_link_handler(upd, ctx):
     """
     Handles messages with links (see main > MessageHandler).
     Replies with `TEMPLATE` with new links.
     """
     if not upd.message:
-        # Will have been logged as [ukn] in @logger
+        # Will have been logged as [ukn] in @logged
         return
 
     links = []
@@ -514,7 +515,7 @@ def cb_link_handler(upd, ctx):
         upd.message.reply_text(msg, parse_mode=ParseMode.HTML)
 
 
-@logger
+@logged
 def cb_inline_query(upd, ctx):
     """
     Handles inline queries. Sends back prompt menu of new links.
@@ -580,11 +581,11 @@ def cb_inline_query(upd, ctx):
     )
 
 
-@logger
+@logged
 def cb_chosen_inline_result(upd, ctx):
     """
     Callback for chosen inline query results. For logging only.
-    See logger()
+    See @logged
     """
     pass
 
@@ -675,7 +676,7 @@ def main():
             updater.stop()
             return os.execl(sys.executable, sys.executable, *sys.argv)
 
-        @logger
+        @logged
         def cb_restart(upd, ctx):
             """
             /restart callback. Restarts the bot.
@@ -688,7 +689,7 @@ def main():
 
             return threading.Thread(target=stop_and_restart).start()
 
-        @logger
+        @logged
         def cb_shutdown(upd, ctx):
             """
             /shutdown callback. Shuts down the bot.