Python 将控制台输出另存为日志文件

小鱼儿 2023-01-01 14:51 435阅读 0赞

### 文章目录 ###

*  Python 将控制台输出另存为日志文件
 *   *  需求
     *  方法一：使用 Logger 类（推荐）
     *  方法二：仅使用 sys
     *  方法三：使用 logging 模块
     *  参考文献

# Python 将控制台输出另存为日志文件 #

## 需求 ##

在 PyCharm 中或者说运行 python 程序时会使用 print 输出些过程信息、 traceback 异常信息 到控制台，但是程序运行结束后记录就没有了，所以想着每次运行将信息显示在控制台的同时记录到文件中。

## 方法一：使用 Logger 类（推荐） ##

自定义创建 Logger 类，结合 sys 进行记录控制台输出信息

demo.py

import sys
    import os
    import time
    
    
    # 控制台输出记录到文件
    class Logger(object):
        def __init__(self, file_name="Default.log", stream=sys.stdout):
            self.terminal = stream
            self.log = open(file_name, "a")
    
        def write(self, message):
            self.terminal.write(message)
            self.log.write(message)
    
        def flush(self):
            pass
    
    
    if __name__ == '__main__':
        # 自定义目录存放日志文件
        log_path = './Logs/'
        if not os.path.exists(log_path):
            os.makedirs(log_path)
        # 日志文件名按照程序运行时间设置
        log_file_name = log_path + 'log-' + time.strftime("%Y%m%d-%H%M%S", time.localtime()) + '.log'
        # 记录正常的 print 信息
        sys.stdout = Logger(log_file_name)
        # 记录 traceback 异常信息
        sys.stderr = Logger(log_file_name)
    
        print(5555)
        print(2/0)

./Logs/log-20210103-140231.log

5555
    Traceback (most recent call last):
      File "G:\Codes\demo.py", line 33, in <module>
        print(2/0)
    ZeroDivisionError: division by zero

## 方法二：仅使用 sys ##

将所有输出全部直接保存到文件中，不再显示到控制台

demo.py

import sys
    
    log_print = open('Defalust.log', 'w')
    sys.stdout = log_print
    sys.stderr = log_print
    
    if __name__ == '__main__':
        print(555)
        print(2/0)

Default.log

555
    Traceback (most recent call last):
      File "G:\Codes\demo.py", line 9, in <module>
        print(2/0)
    ZeroDivisionError: division by zero

## 方法三：使用 logging 模块 ##

功能更加全面，主要用于输出运行日志、设置输出日志的等级、日志保存路径等等

必须放到 try……catch…… 里面才能保存 traceback 的错误的信息，然后不能保存 print （如果要保存可以参考方法二，但是这样控制台就没有 print 了）

demo.py

import logging
    import os
    import time
    import traceback
    import sys
    
    # 创建一个 logger
    logger = logging.getLogger(__name__)
    # logger 的等级
    logger.setLevel(level=logging.INFO)
    # 创建一个 handler，写入日志文件
    log_path = './Logs/'
    if not os.path.exists(log_path):
        os.makedirs(log_path)
    log_file_name = log_path + 'log-' + time.strftime("%Y%m%d-%H%M%S", time.localtime()) + '.log'
    logfile = log_file_name
    handler = logging.FileHandler(logfile, mode='a+')
    # 输入到日志文件中的日志等级
    handler.setLevel(logging.DEBUG)
    # 设置 handler 中日志记录格式
    formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
    handler.setFormatter(formatter)
    # 将 handler 添加到 logger 里面
    logger.addHandler(handler)
    
    # 将日志输出到控制台，默认 sys.stderr
    logger.addHandler(logging.StreamHandler(sys.stdout))
    
    logger.info("Start print log")
    
    if __name__ == '__main__':
        try:
            print(5555555555)
            print(5/0)
        except Exception as e:
            logger.error(str(traceback.format_exc()))

log-20210103-151751.log

2021-01-03 15:17:51,597 - __main__ - INFO - Start print log
    2021-01-03 15:17:51,597 - __main__ - ERROR - Traceback (most recent call last):
      File "G:\Codes\demo.py", line 34, in <module>
        print(5/0)
    ZeroDivisionError: division by zero

## 参考文献 ##

【1】[16.6. logging — Logging facility for Python — Python 3.6.12 documentation][16.6. logging _ Logging facility for Python _ Python 3.6.12 documentation]

【2】[Overview — loguru documentation][Overview _ loguru documentation]

[16.6. logging _ Logging facility for Python _ Python 3.6.12 documentation]: https://docs.python.org/3.6/library/logging.html
[Overview _ loguru documentation]: https://loguru.readthedocs.io/en/stable/overview.html