unitlog 0.0.3__tar.gz → 0.0.6__tar.gz

{unitlog-0.0.3/unitlog.egg-info → unitlog-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: unitlog
-Version: 0.0.3
+Version: 0.0.6
 Home-page: https://github.com/yujun2647/unitlog
 Download-URL: 
 Author: walkerjun
@@ -9,6 +9,14 @@ License: Apache-2.0
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
 
 # unitlog
 

unitlog-0.0.6/unitlog/__init__.py

@@ -0,0 +1,16 @@
+__version__ = "0.0.6"
+
+
+updates = """
+### 版本说明
+
+**✨ 核心亮点**
+- **多进程支持**：我们引入了更加稳健的多进程支持，现在可以通过 spawn 方式来启动和管理多个进程，提升了应用的并行处理能力。
+- **日志系统增强**：为了确保日志记录的可靠性，我们更新了日志系统，现在会自动确保日志路径目录的存在，避免了因目录问题导致的日志记录失败。
+
+**🚀 体验优化**
+- **系统稳定性提升**：通过对多进程支持的改进和日志系统的优化，我们增强了应用的稳定性和可靠性，为用户提供了更加流畅的体验。
+
+**🐛 问题修复**
+- *（本次更新没有涉及到老功能的修复，因此此部分留空）*
+"""

{unitlog-0.0.3 → unitlog-0.0.6}/unitlog/handlers.py

@@ -13,7 +13,10 @@ class LogBox(object):
 
 class UnitHandler(logging.StreamHandler):
     LOG_TYPE = "console"
-    DEFAULT_LOG_QUEUE = mp.Queue()
+
+    def __init__(self, stream=None, bus_queue=None):
+        super().__init__(stream)
+        self.bus_queue = bus_queue
 
     def handle(self, record):
         """ without acquiring lock
@@ -39,7 +42,7 @@ class UnitHandler(logging.StreamHandler):
             msg = self.format(record)
             # issue 35046: merged two stream.writes into one.
             log_msg = msg + self.terminator
-            UnitHandler.DEFAULT_LOG_QUEUE.put(self.wrap_msg(log_msg))
+            self.bus_queue.put(self.wrap_msg(log_msg))
         except RecursionError:  # See issue 36272
             raise
         except Exception:
@@ -53,8 +56,8 @@ class UnitConsoleHandler(UnitHandler):
 class UnitFileHandler(UnitHandler):
     LOG_TYPE = "file"
 
-    def __init__(self, log_filepath, mode):
-        super().__init__()
+    def __init__(self, log_filepath, mode, bus_queue=None):
+        super().__init__(bus_queue=bus_queue)
         self.log_filepath = log_filepath
         self.mode = mode
 

unitlog-0.0.6/unitlog/unit.py

@@ -0,0 +1,299 @@
+import os
+import sys
+import inspect
+import atexit
+import logging
+import traceback
+from queue import Empty
+import multiprocessing as mp
+from multiprocessing.synchronize import Event
+
+from unitlog.handlers import LogBox, UnitFileHandler, UnitConsoleHandler
+
+
+
+def is_under_testing():
+    """
+    检查当前是否处于单元测试环境 (unittest 或 pytest)。
+    原理：向上遍历栈帧，如果发现调用链中有 unittest 或 pytest 的相关文件，则认为是测试环境。
+    """
+    # 简单的白名单检查
+    for frame_info in inspect.stack():
+        module_name = frame_info.frame.f_globals.get('__name__', '')
+        # 如果调用栈里包含 unittest 或 pytest，说明是在测试
+        if module_name and ('unittest' in module_name or 'pytest' in module_name):
+            return True
+    return False
+
+
+
+class PoxyConsoleLogWriter(object):
+
+    def __init__(self, stream=sys.stdout):
+        self.stream = stream
+
+    def emit(self, log_msg):
+        self.stream.write(log_msg)
+        self.stream.flush()
+
+    def close(self):
+        self.stream.close()
+
+
+class PoxyFileLogWriter(PoxyConsoleLogWriter):
+    def __init__(self, log_filepath, file_mode="a"):
+        super().__init__(stream=open(log_filepath, file_mode))
+
+
+class UnitLog(object):
+
+    def __init__(self):
+        self.started: Event = mp.Event()
+        self.stopped: Event = mp.Event()
+        self.log_num = mp.Value('i', 0)
+        self.worker = None
+        self.bus_queue = None
+        self._proxy_handler_map = {}
+
+    def _init_proxy_handler(self, log_box: LogBox) -> PoxyConsoleLogWriter:
+        hkey = f"{log_box.log_type}-{log_box.log_filepath}"
+        if hkey not in self._proxy_handler_map:
+            if log_box.log_type == "console":
+                self._proxy_handler_map[hkey] = PoxyConsoleLogWriter()
+            elif log_box.log_type == "file":
+                abs_log_filepath = os.path.abspath(log_box.log_filepath)
+                dir_path = os.path.dirname(abs_log_filepath)
+                if not os.path.exists(dir_path):
+                    os.makedirs(dir_path, exist_ok=True)
+
+                self._proxy_handler_map[hkey] = PoxyFileLogWriter(
+                    log_filepath=abs_log_filepath,
+                    file_mode=log_box.file_mode
+                )
+            else:
+                raise TypeError(f"Unsupported log type: {log_box.log_type}")
+        return self._proxy_handler_map[hkey]
+
+    def listening_log_msg(self, bus_queue):
+        while True:
+            self.started.set()
+            try:
+                log_box: LogBox = bus_queue.get(timeout=0.1)
+            except Empty:
+                if self.stopped.is_set():
+                    break
+                continue
+            except KeyboardInterrupt:
+                continue
+            try:
+                handler = self._init_proxy_handler(log_box)
+
+                handler.emit(log_box.log_msg)
+                if os.environ.get("ENV-TEST", "prod") == "test":
+                    self.log_num.value += 1
+            except Exception as e:
+                print(f"unexpect exception: {e}\n "
+                      f"{traceback.format_exc()}")
+        if os.environ.get("ENV-TEST", "prod") == "test":
+            print(f"all log num: {self.log_num.value}")
+
+    def register_logger(self, name, level=logging.INFO,
+                        console_log=True, file_log=False, file_log_mode="a",
+                        log_filepath=None,
+                        parent_logger_name=None,
+                        force_all_console_log_to_file=False) -> logging.Logger:
+
+        caller_frame = inspect.currentframe().f_back
+        caller_module_name = caller_frame.f_globals.get('__name__')
+        caller_func_name = caller_frame.f_code.co_name
+
+        # ---------------------------------------------------------
+        # 规则 1: 严禁全局裸奔 (必须包在函数里)
+        # ---------------------------------------------------------
+        if caller_func_name == '<module>':
+            raise RuntimeError(
+                "⛔️ [禁止全局调用] 你必须把此函数放在一个 def 函数内部调用，\n"
+                """
+                例如 
+                def main(): 
+                    register_logger()
+                    
+                if __name__ == '__main__':
+                    main()
+                """
+                "严禁在脚本顶层直接执行，否则会导致多进程 spawn 时的无限递归。"
+            )
+
+        # ---------------------------------------------------------
+        # 规则 2: 必须是 Main 入口，或者是 单元测试
+        # ---------------------------------------------------------
+        # 如果是直接运行脚本，name 是 __main__ -> 通过
+        # 如果是 unittest，name 是 文件名 -> 但 is_under_testing() 为真 -> 通过
+        # 如果是 spawn 子进程，name 是 文件名 -> 且不在测试栈中 -> 拦截
+        if caller_module_name != '__main__' and not is_under_testing():
+            raise RuntimeError(
+                f"⛔️ [禁止导入执行] 检测到当前模块名为 '{caller_module_name}'。\n"
+                "此函数只能在 'if __name__ == \"__main__\":' 入口下执行，\n"
+                "或者是通过单元测试(unittest/pytest)执行。\n"
+                "禁止在多进程 spawn 导入阶段或作为普通模块被 import 时执行。"
+            )
+
+        print(f"✅ 安全检查通过 (调用者: {caller_module_name}, 环境安全)")
+
+        if not self.started.is_set():
+            self.bus_queue = mp.Queue()
+            self.worker = mp.Process(target=self.listening_log_msg, args=(self.bus_queue, ), daemon=True)
+            self.worker.start()
+            if not self.started.wait(timeout=3):
+                raise ValueError("unit log process is not started")
+
+        logger = logging.getLogger(name)
+        logger.setLevel(level)
+        if parent_logger_name is not None:
+            parent_logger = logging.getLogger(parent_logger_name)
+            logger.parent = parent_logger
+            logger.propagate = True
+        else:
+            logger.propagate = False
+
+        simple_formatter = logging.Formatter(
+            fmt="%(asctime)s [line:%(lineno)d] %(levelname)s %(message)s",
+            datefmt="%a, %d %b %Y %H:%M:%S"
+        )
+        full_formatter = logging.Formatter(
+            fmt="%(asctime)s %(filename)s [line:%(lineno)d] %(levelname)s "
+                "%(message)s",
+            datefmt="%a, %d %b %Y %H:%M:%S"
+        )
+        if console_log:
+            console_handler = UnitConsoleHandler(bus_queue=self.bus_queue)
+            console_handler.setFormatter(simple_formatter)
+            logger.handlers.append(console_handler)
+        if file_log:
+            assert log_filepath, "log_filepath must be set"
+            os.makedirs(os.path.dirname(log_filepath), exist_ok=True)
+            file_handler = UnitFileHandler(log_filepath, mode=file_log_mode, bus_queue=self.bus_queue)
+            file_handler.setFormatter(full_formatter)
+            logger.handlers.append(file_handler)
+            logger.info("\nLog_filename: {}".format(log_filepath))
+
+            if force_all_console_log_to_file: # 强制控制所有标准输出到 文件
+                self.force_all_console_log_to_file(log_filepath)
+
+        return logger
+
+
+    @classmethod
+    def force_all_console_log_to_file(cls, log_filepath):
+        # ==========================================
+        # 新增函数：重定向底层 C/C++ 输出
+        # ==========================================
+        def _redirect_c_libraries_output(log_path):
+            """
+            使用 os.dup2 强制将底层 C/C++ 的 stdout/stderr 重定向到日志文件。
+            解决 sherpa-onnx, PyQt, OpenCV 等 C 库打印无法被 Python 捕获的问题。
+            """
+            # 1. 打开日志文件 (使用 append 模式)
+            # 这里的 buffer 设置为 0 (unbuffered) 或者 line buffered，确保 C 代码崩溃前能写入
+            try:
+                # 打开文件获取文件描述符
+                # distinct file object specifically for low-level redirection
+                log_file = open(log_path, 'a+')
+                log_fd = log_file.fileno()
+
+                # 2. 刷新 Python 的缓冲区，防止重定向导致之前的日志丢失
+                sys.stdout.flush()
+                sys.stderr.flush()
+
+                # 3. 核心：重定向 FD 1 (stdout) 和 FD 2 (stderr)
+                # 这一步之后，所有的 C printf/std::cout 都会直接写进文件
+                os.dup2(log_fd, 1)
+                os.dup2(log_fd, 2)
+
+                # 保持 log_file 对象引用，防止被垃圾回收导致 FD 关闭
+                return log_file
+            except Exception as e:
+                print(f"Failed to redirect C logs: {e}")
+                return None
+
+        class Logger(object):
+            def __init__(self, filename):
+                self.terminal = sys.stdout  # 记录原来的控制台，防止 IDE 里看不到了
+                self.log = open(filename, "a", encoding="utf-8")  # 'a' 追加模式
+
+            def write(self, message):
+                # 1. 尝试写回控制台（方便开发调试）
+                try:
+                    if self.terminal:
+                        self.terminal.write(message)
+                except:
+                    pass  # 打包成 no console 后这里可能会报错，直接忽略
+
+                # 2. 写入文件
+                try:
+                    self.log.write(message)
+                    # 【关键】立即刷新缓冲区，否则崩溃瞬间可能来不及写入文件
+                    self.log.flush()
+                except:
+                    pass
+
+            def flush(self):
+                # 兼容性函数，必须保留
+                try:
+                    if self.terminal:
+                        self.terminal.flush()
+                    self.log.flush()
+                except:
+                    pass
+
+        # 3. 【关键改动】区分环境进行重定向
+        # 判断是否是打包后的环境
+        # 逻辑：如果是 PyInstaller 打包 (frozen) 或者 环境变量 MIT_LOG=1，都视为需要重定向
+        FORCE_ALL_CONSOLE_LOG_TO_FILE = os.environ.get("FORCE_ALL_CONSOLE_LOG_TO_FILE") == "1"
+        IS_FROZEN = getattr(sys, 'frozen', False) or FORCE_ALL_CONSOLE_LOG_TO_FILE
+        print(f"FORCE_ALL_CONSOLE_LOG_TO_FILE: {FORCE_ALL_CONSOLE_LOG_TO_FILE} \t IS_FROZEN: {IS_FROZEN}")
+
+        if IS_FROZEN:
+            # --- 打包环境 (Exe) ---
+            # 1. 接管 Python 层面 (你原来的做法)
+            sys.stdout = Logger(log_filepath)
+            sys.stderr = sys.stdout
+
+            # 2. 接管 C/C++ 层面 (新增的做法)
+            # 这会让 sherpa-onnx 的报错也进文件
+            # 注意：在 Linux/Mac 上非常有效，Windows 上通常也有效
+            _c_log_ref = _redirect_c_libraries_output(log_filepath)
+
+            print(f"Native C++ stdout/stderr redirected to {log_filepath}")
+
+        else:
+            # --- 开发环境 (IDE) ---
+            # 在开发时，我们通常不希望 C++ 输出消失在控制台
+            # 所以这里我们 *只* 使用你原来的 Logger 记录 Python print
+            # 这样 IDE 控制台里既能看到 Python print，也能看到 C++ print (IDE 会自己捕获 FD)
+            # 同时 Python print 也会被写入文件
+
+            # 如果你确实希望开发时文件里也有 sherpa-onnx 的日志，
+            # 你可以把上面的 redirect_c_libraries_output 打开，
+            # 但代价是你的 PyCharm 控制台里那行红色的警告会消失。
+            sys.stdout = Logger(log_filepath)
+            sys.stderr = sys.stdout
+
+DEFAULT_LOG = UnitLog()
+
+register_logger: UnitLog.register_logger = DEFAULT_LOG.register_logger
+atexit.register(lambda: DEFAULT_LOG.stopped.set())
+
+
+
+def main():
+
+    _logger = logging.getLogger("test")
+    register_logger(name="test", level=logging.DEBUG,
+                    log_filepath="./temp/test.log")
+    _logger.info("lllll")
+
+
+
+if __name__ == "__main__":
+    main()

{unitlog-0.0.3 → unitlog-0.0.6/unitlog.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: unitlog
-Version: 0.0.3
+Version: 0.0.6
 Home-page: https://github.com/yujun2647/unitlog
 Download-URL: 
 Author: walkerjun
@@ -9,6 +9,14 @@ License: Apache-2.0
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-python
 
 # unitlog
 

unitlog-0.0.3/unitlog/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.0.3"

unitlog-0.0.3/unitlog/unit.py

@@ -1,135 +0,0 @@
-import os
-import sys
-import atexit
-import logging
-import traceback
-from queue import Empty
-import multiprocessing as mp
-from multiprocessing.synchronize import Event
-
-from unitlog.handlers import (LogBox, UnitHandler, UnitFileHandler,
-                              UnitConsoleHandler)
-
-
-class PoxyConsoleLogWriter(object):
-
-    def __init__(self, stream=sys.stdout):
-        self.stream = stream
-
-    def emit(self, log_msg):
-        self.stream.write(log_msg)
-        self.stream.flush()
-
-    def close(self):
-        self.stream.close()
-
-
-class PoxyFileLogWriter(PoxyConsoleLogWriter):
-    def __init__(self, log_filepath, file_mode="a"):
-        super().__init__(stream=open(log_filepath, file_mode))
-
-
-class UnitLog(object):
-
-    def __init__(self):
-        self.started: Event = mp.Event()
-        self.stopped: Event = mp.Event()
-        self.log_num = mp.Value('i', 0)
-        self.worker = mp.Process(target=self.listening_log_msg, daemon=True)
-        self._proxy_handler_map = {}
-
-    def _init_proxy_handler(self, log_box: LogBox) -> PoxyConsoleLogWriter:
-        hkey = f"{log_box.log_type}-{log_box.log_filepath}"
-        if hkey not in self._proxy_handler_map:
-            if log_box.log_type == "console":
-                self._proxy_handler_map[hkey] = PoxyConsoleLogWriter()
-            elif log_box.log_type == "file":
-                abs_log_filepath = os.path.abspath(log_box.log_filepath)
-                dir_path = os.path.dirname(abs_log_filepath)
-                if not os.path.exists(dir_path):
-                    os.makedirs(dir_path, exist_ok=True)
-
-                self._proxy_handler_map[hkey] = PoxyFileLogWriter(
-                    log_filepath=abs_log_filepath,
-                    file_mode=log_box.file_mode
-                )
-            else:
-                raise TypeError(f"Unsupported log type: {log_box.log_type}")
-        return self._proxy_handler_map[hkey]
-
-    def listening_log_msg(self):
-        while True:
-            self.started.set()
-            try:
-                log_box: LogBox = UnitHandler.DEFAULT_LOG_QUEUE.get(timeout=0.1)
-            except Empty:
-                if self.stopped.is_set():
-                    break
-                continue
-            except KeyboardInterrupt:
-                continue
-            try:
-                handler = self._init_proxy_handler(log_box)
-
-                handler.emit(log_box.log_msg)
-                if os.environ.get("ENV-TEST", "prod") == "test":
-                    self.log_num.value += 1
-            except Exception as e:
-                print(f"unexpect exception: {e}\n "
-                      f"{traceback.format_exc()}")
-        if os.environ.get("ENV-TEST", "prod") == "test":
-            print(f"all log num: {self.log_num.value}")
-
-    def register_logger(self, name, level=logging.INFO,
-                        console_log=True, file_log=False, file_log_mode="a",
-                        log_filepath=None,
-                        parent_logger_name=None) -> logging.Logger:
-        if not self.started.is_set():
-            self.worker.start()
-            if not self.started.wait(timeout=3):
-                raise ValueError("unit log process is not started")
-
-        logger = logging.getLogger(name)
-        logger.setLevel(level)
-        if parent_logger_name is not None:
-            parent_logger = logging.getLogger(parent_logger_name)
-            logger.parent = parent_logger
-            logger.propagate = True
-        else:
-            logger.propagate = False
-
-        simple_formatter = logging.Formatter(
-            fmt="%(asctime)s [line:%(lineno)d] %(levelname)s %(message)s",
-            datefmt="%a, %d %b %Y %H:%M:%S"
-        )
-        full_formatter = logging.Formatter(
-            fmt="%(asctime)s %(filename)s [line:%(lineno)d] %(levelname)s "
-                "%(message)s",
-            datefmt="%a, %d %b %Y %H:%M:%S"
-        )
-        if console_log:
-            console_handler = UnitConsoleHandler()
-            console_handler.setFormatter(simple_formatter)
-            logger.handlers.append(console_handler)
-        if file_log:
-            assert log_filepath, "log_filepath must be set"
-            file_handler = UnitFileHandler(log_filepath, mode=file_log_mode)
-            file_handler.setFormatter(full_formatter)
-            logger.handlers.append(file_handler)
-            logger.info("\nLog_filename: {}".format(log_filepath))
-
-        return logger
-
-
-DEFAULT_LOG = UnitLog()
-
-register_logger = DEFAULT_LOG.register_logger
-atexit.register(lambda: DEFAULT_LOG.stopped.set())
-
-if __name__ == "__main__":
-    import time
-
-    _logger = logging.getLogger("test")
-    register_logger(name="test", level=logging.DEBUG,
-                    log_filepath="./temp/test.log")
-    _logger.info("lllll")