python使用logging打印信息到日志文件中

参考

• Python输出日志信息

• Python + logging 输出到屏幕，将log日志写入文件

使用logging打印日志到文件中的目的是：

• 解决控制台输出内容过多，无法追溯有用信息的问题。
• 解决云端服务器运行结果的可视化问题。
• 为信息分级别，可以让开发者专注解决某些不起眼的bug。
• 方便后期在有需要的情况下，对日志文件进行数据处理和分析

1、logging打印属性值

1）log打印级别

logging函数根据它们用来跟踪的事件的级别或严重程度来命名。标准级别及其适用性描述如下（以严重程度递增排序）：

级别	何时使用
DEBUG	详细信息，一般只在调试问题时使用。
INFO	证明事情按预期工作。
WARNING	某些没有预料到的事件的提示，或者在将来可能会出现的问题提示。例如：磁盘空间不足。但是软件还是会照常运行。
ERROR	由于更严重的问题，软件已不能执行一些功能了。
CRITICAL	严重错误，表明软件已不能继续运行了。

级别数字值

级别	数字值
CRITICAL	50
ERROR	40
WARNING	30
INFO	20
DEBUG	10
NOTSET	0

默认等级是WARNING，这意味着仅仅这个等级及以上的才会反馈信息，除非logging模块被用来做其它事情。

被跟踪的事件能以不同的方式被处理。最简单的处理方法就是把它们在控制台上打印出来。另一种常见的方法就是写入磁盘文件。

2）Formatters日志信息封装对象

Formatter对象设置日志信息最后的规则、结构和内容，默认的时间格式为%Y-%m-%d %H:%M:%S，下面是Formatter常用的一些信息

%(name)s	Logger的名字
%(levelno)s	数字形式的日志级别
%(levelname)s	文本形式的日志级别
%(pathname)s	调用日志输出函数的模块的完整路径名，可能没有
%(filename)s	调用日志输出函数的模块的文件名
%(module)s	调用日志输出函数的模块名
%(funcName)s	调用日志输出函数的函数名
%(lineno)d	调用日志输出函数的语句所在的代码行
%(created)f	当前时间，用UNIX标准的表示时间的浮 点数表示
%(relativeCreated)d	输出日志信息时的，自Logger创建以 来的毫秒数
%(asctime)s	字符串形式的当前时间。默认格式是 “2003-07-08 16:49:45,896”。逗号后面的是毫秒
%(thread)d	线程ID。可能没有
%(threadName)s	线程名。可能没有
%(process)d	进程ID。可能没有
%(message)s	用户输出的消息

3）关于logging的模块设计

logging库采取了模块化的设计，提供了许多组件：记录器、处理器、过滤器和格式化器。

• Logger 暴露了应用程序代码能直接使用的接口。
• Handler将（记录器产生的）日志记录发送至合适的目的地。
• Filter提供了更好的粒度控制，它可以决定输出哪些日志记录。
• Formatter 指明了最终输出中日志记录的布局。

a）Loggers

Logger 对象要做三件事情。首先，它们向应用代码暴露了许多方法，这样应用可以在运行时记录消息。其次，记录器对象通过严重程度（默认的过滤设施）或者过滤器对象来决定哪些日志消息需要记录下来。第三，记录器对象将相关的日志消息传递给所有感兴趣的日志处理器。

常用的记录器对象的方法分为两类：配置和发送消息。

这些是最常用的配置方法：

• Logger.setLevel()指定logger将会处理的最低的安全等级日志信息, debug是最低的内置安全等级，critical是最高的内建安全等级。例如，如果严重程度为INFO，记录器将只处理INFO，WARNING，ERROR和CRITICAL消息，DEBUG消息被忽略。
• Logger.addHandler()和Logger.removeHandler()从记录器对象中添加和删除处理程序对象。处理器详见Handlers。
• Logger.addFilter()和Logger.removeFilter()从记录器对象添加和删除过滤器对象。

b）Handlers

处理程序对象负责将适当的日志消息（基于日志消息的严重性）分派到处理程序的指定目标。Logger 对象可以通过addHandler()方法增加零个或多个handler对象。举个例子，一个应用可以将所有的日志消息发送至日志文件，所有的错误级别（error）及以上的日志消息发送至标准输出，所有的严重级别（critical）日志消息发送至某个电子邮箱。在这个例子中需要三个独立的处理器，每一个负责将特定级别的消息发送至特定的位置。

常用的有4种：

1) logging.StreamHandler -> 控制台输出
使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。

它的构造函数是：StreamHandler([strm])

• 其中strm参数是一个文件对象。默认是sys.stderr

2) logging.FileHandler -> 文件输出
和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是：FileHandler(filename[,mode])

• filename是文件名，必须指定一个文件名。
• mode是文件的打开方式。默认是’a’，即添加到文件末尾。

3) logging.handlers.RotatingFileHandler -> 按照大小自动分割日志文件，一旦达到指定的大小重新生成文件
这个Handler类似于上面的FileHandler，但是它可以管理文件大小。当文件达到一定大小之后，它会自动将当前日志文件改名，然后创建 一个新的同名日志文件继续输出。比如日志文件是chat.log。当chat.log达到指定的大小之后，RotatingFileHandler自动把文件改名为chat.log.1。不过，如果chat.log.1已经存在，会先把chat.log.1重命名为chat.log.2。。。最后重新创建 chat.log，继续输出日志信息。

它的构造函数是：
RotatingFileHandler( filename[, mode[, maxBytes[, backupCount]]])

• 其中filename和mode两个参数和FileHandler一样。
• maxBytes用于指定日志文件的最大文件大小。如果maxBytes为0，意味着日志文件可以无限大，这时上面描述的重命名过程就不会发生。
• backupCount用于指定保留的备份文件的个数。比如，如果指定为2，当上面描述的重命名过程发生时，原有的chat.log.2并不会被更名，而是被删除。

4. logging.handlers.TimedRotatingFileHandler -> 按照时间自动分割日志文件
   这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。

它的构造函数是：
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

• 其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。

• interval是时间间隔。

• when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：

  • S 秒
  • M 分
  • H 小时
  • D 天
  • W 每星期（interval==0时代表星期一）
  • midnight 每天凌晨

配置方法：

• setLevel()方法和日志对象的一样，指明了将会分发日志的最低级别。为什么会有两个setLevel()方法？记录器的级别决定了消息是否要传递给处理器。每个处理器的级别决定了消息是否要分发。
• setFormatter()为该处理器选择一个格式化器。
• addFilter()和removeFilter()分别配置和取消配置处理程序上的过滤器对象。

2、打印到控制台

1）默认打印

默认打印warning级别及以上的信息（debug，info级别比warning小，不会输出）

import logging
if __name__ == '__main__':
    # 默认打印warning级别及以上的信息（debug，info级别比warning小不会输出）
    logging.debug('debug 信息')
    logging.warning('只有这个会输出。。。')
    logging.info('info 信息')
---
WARNING:root:只有这个会输出。。。

2）设置打印级别

利用logging.basicConfig()设置打印级别

import logging
if __name__ == '__main__':
    # 利用logging.basicConfig()打印信息到控制台
    logging.basicConfig(format='%(asctime)s - %(pathname)s[line:%(lineno)d] - %(levelname)s: %(message)s',
                        level=logging.DEBUG)
    logging.debug('debug级别，最低级别，一般开发人员用来打印一些调试信息')
    logging.info('info级别，正常输出信息，一般用来打印一些正常的操作')
    logging.warning('waring级别，一般用来打印警告信息')
    logging.error('error级别，一般用来打印一些错误信息')
    logging.critical('critical 级别，一般用来打印一些致命的错误信息,等级最高')

控制台输出信息：

2022-04-24 17:04:50,820 - E:/研究生任务/fatigue_package/logging_test/code001_logger_test.py[line:52] - DEBUG: debug级别，最低级别，一般开发人员用来打印一些调试信息
2022-04-24 17:04:50,821 - E:/研究生任务/fatigue_package/logging_test/code001_logger_test.py[line:53] - INFO: info级别，正常输出信息，一般用来打印一些正常的操作
2022-04-24 17:04:50,821 - E:/研究生任务/fatigue_package/logging_test/code001_logger_test.py[line:54] - WARNING: waring级别，一般用来打印警告信息
2022-04-24 17:04:50,821 - E:/研究生任务/fatigue_package/logging_test/code001_logger_test.py[line:55] - ERROR: error级别，一般用来打印一些错误信息
2022-04-24 17:04:50,821 - E:/研究生任务/fatigue_package/logging_test/code001_logger_test.py[line:56] - CRITICAL: critical 级别，一般用来打印一些致命的错误信息,等级最高

3、打印到文件（★★★）

将输出信息打印到日志文件中，主要解决控制台输出内容过多，无法追溯有用信息的问题。而且方便后期在有需要的情况下，对日志文件进行数据处理和分析。

# -*- coding: utf-8 -*-

# 参考 <https://www.cnblogs.com/nuccch/p/16014069.html>
import sys
import logging
from logging import handlers

# 日志级别关系映射
level_relations = {
    'debug': logging.DEBUG,
    'info': logging.INFO,
    'warning': logging.WARNING,
    'error': logging.ERROR,
    'crit': logging.CRITICAL
}

def _get_logger(filename, level='info'):
    # 创建日志对象
    log = logging.getLogger(filename)
    # 设置日志级别
    log.setLevel(level_relations.get(level))
    # 日志输出格式
    fmt = logging.Formatter('%(asctime)s %(thread)d %(filename)s[line:%(lineno)d] - %(levelname)s: %(message)s')
    # 输出到控制台
    console_handler = logging.StreamHandler(sys.stdout)
    console_handler.setFormatter(fmt)
    # 输出到文件
    # 日志文件按天进行保存，每天一个日志文件
    file_handler = handlers.TimedRotatingFileHandler(filename=filename, when='D', backupCount=1, encoding='utf-8')
    # 按照大小自动分割日志文件，一旦达到指定的大小重新生成文件
    # file_handler = handlers.RotatingFileHandler(filename=filename, maxBytes=1*1024*1024*1024, backupCount=1, encoding='utf-8')
    file_handler.setFormatter(fmt)

    log.addHandler(console_handler)
    log.addHandler(file_handler)
    return log

if __name__ == '__main__':
    # 明确指定日志输出的文件路径和日志级别
    logger = _get_logger('./logs/test.log', 'info')
    logger.info('日志输出测试')

日志输出内容：

2022-04-24 12:34:18,813 2200 code001_logger_test.py[line:42] - INFO: 日志输出测试