6. add queue arg to morebuiltins.logs.LogHelper.bind_handler, to enable async logging with AsyncQueueListener. (like loguru's queue=True)

Author: ClericPy

CHANGELOG.md

@@ -10,6 +10,7 @@
 4. **Compatibility Warnings**:
    1. move `async_logger`, `AsyncQueueListener`, `LogHelper`, `RotatingFileWriter`, and `SizedTimedRotatingFileHandler` from `morebuiltins.funcs` to `morebuiltins.logs`.
 5. add `ContextFilter` for logging, to add context variables to log records.
+6. add `queue` arg to `morebuiltins.logs.LogHelper.bind_handler`, to enable async logging with `AsyncQueueListener`. (like loguru's queue=True)
 
 ### 1.3.1 (2025-06-19)
 1. add `check_recursion` to `morebuiltins.funcs`, to check if a function is recursive.

morebuiltins/logs.py

@@ -1,4 +1,5 @@
 import asyncio
+import atexit
 import logging
 import re
 import sys
@@ -60,7 +61,7 @@ class LogHelper:
     FILENAME_HANDLER_MAP: Dict[str, logging.Handler] = {}
 
     @classmethod
-    def close_all_handlers(cls):
+    def close_all_handlers(cls) -> List[Tuple[str, bool, Optional[Exception]]]:
         """Close all handlers in the FILENAME_HANDLER_MAP."""
         result: List[Tuple[str, bool, Optional[Exception]]] = []
         for key, handler in list(cls.FILENAME_HANDLER_MAP.items()):
@@ -75,7 +76,7 @@ def close_all_handlers(cls):
     @classmethod
     def bind_handler(
         cls,
-        name="main",
+        name: Optional[str] = "main",
         filename: Union[
             TextIO, TextIOBase, None, logging.Handler, str, Path
         ] = sys.stderr,
@@ -90,6 +91,7 @@ def bind_handler(
         formatter: Union[str, logging.Formatter, None] = DEFAULT_FORMAT,
         handler_level: Union[None, str, int] = "INFO",
         logger_level: Union[None, str, int] = "INFO",
+        queue: Union[bool, None, Queue, ProcessQueue] = False,
     ):
         """Bind a logging handler to the specified logger name, with support for file, stream, or custom handler.
         This sets up the logger with the desired handler, formatter, and log levels.
@@ -127,6 +129,12 @@ def bind_handler(
             2
             >>> bool(LogHelper.close_all_handlers() or True)
             True
+            >>> logger = LogHelper.bind_handler(name="mylogger1", queue=True)
+            >>> logger.handlers[0]
+            <QueueHandler (NOTSET)>
+            >>> logger = LogHelper.bind_handler(name="mylogger2", queue=False)
+            >>> logger.handlers[0]
+            <StreamHandler <stderr> (INFO)>
         """
         logger = logging.getLogger(name)
         if filename is None:
@@ -183,6 +191,14 @@ def bind_handler(
         handler.setFormatter(formatter)
         # Add the handler to the logger
         logger.addHandler(handler)
+        if queue:
+            if queue is True:
+                queue = Queue()
+            elif not isinstance(queue, (Queue, ProcessQueue)):
+                raise TypeError("queue must be a Queue, ProcessQueue, True, or False")
+            async_listener = AsyncQueueListener(logger, queue=queue)
+            async_listener.start()
+            atexit.register(async_listener.stop)
         return logger
 
     @classmethod