Python 日志输出

打印日志是很多程序的重要需求,良好的日志输出可以帮我们更方便的检测程序运行状态。Python标准库提供了logging模块,让我们也可以方便的在Python中打印日志。

日志介绍

完整的使用方法可以参考标准库文档。这里做一下简单介绍。

日志级别

日志级别有如下几种。当获取根Logger的时候,默认级别为NOTSET,这样会显示所有输出。当获取非根Logger的时候,根Logger的默认级别是WARNING,非根Logger会继承这个级别,只有WARNING以上的日志才会输出。

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

日志对象

日志对象通过模块的getLogger(name)函数获得,可以向该函数传递一个名称。如果不传递名字的话,就会获取根Logger。

日志对象常用方法如下。

方法名 作用
setLevel(lvl) 设置日志级别
isEnabledFor(lvl) 检查某级别的日志是否启用
getEffectiveLevel() 获取实际的日志级别
debug/warning/info/error(msg, *args, **kwargs) 输出对应级别的日志
log(lvl, msg, *args, **kwargs) 输出指定级别的日志
addFilter(filt)/removeFilter(filt) 添加或删除指定的过滤器
addHandler(hdlr)/removeHandler(hdlr) 添加或删除指定的处理器

Handler对象

日志对象用于输出日志,而Handler对象用于指定日志向哪里输出(文件、终端等等)。Handler列表可以参考Handler类型

常用的Handler有以下几种:

  • StreamHandler, 用于向标准输入输出流等输出日志。
  • FileHandler,用于向文件输出日志。
  • NullHandler,什么也不输出。
  • RotatingFileHandler,向文件输出日志,如果文件到达指定大小,创建新文件并继续输出日志。

还有好多种Handler,可以向HTTP服务器发送日志、向系统日志管理器写入日志、向指定电子邮箱发送日志等Handler。这里就不介绍了。如果有相关需求请参考相应文档。

Formatter对象

Formatter对象用于格式化日志输出。格式化字符串使用传统的%形式来格式化日志,可以参考官方文档了解更多信息。

过滤器对象

过滤器对象用于过滤日志的输出。

LogRecord对象

LogRecord对象基本上和我们没多大关系,简单地说,我们输出的每一条日志,就是一个LogRecord对象。它有日志系统自动创建和使用。如果我们留心一下日志模块的方法,会发现有很多地方都要接受LogRecord参数。LogRecord有很多属性信息,对日志打印有帮助,可以参考16.6.6. LogRecord Objects下面的属性和格式化符的对照表。例如%(asctime)s会生成人类可读的时间戳,%(lineno)d返回当前行号等等。

模块级别函数

日志模块还包含了一些模块级别的函数。简单不完整列举如下:

函数名 作用
getLogger(name=None) 获取对应名称的Logger,如果不指定名称会返回根Logger
debug/info等函数 在根Logger上打印对应级别的日志信息
disable(lvl) 禁用某级别的日志打印
basicConfig(关键字参数) 这个函数可以快速设置日志的级别、格式、Handler、Formatter等

使用日志

前面都是纸面上的介绍,下面来真正使用日志模块来打印日志。下面的代码所用知识,前面都已介绍过。运行代码之后,可以验证日志同时在终端输出和文件中输出。

import logging

# 创建Logger
logger = logging.getLogger()
logger.setLevel(logging.DEBUG)

# 创建Handler

# 终端Handler
consoleHandler = logging.StreamHandler()
consoleHandler.setLevel(logging.DEBUG)

# 文件Handler
fileHandler = logging.FileHandler('log.log', mode='w', encoding='UTF-8')
fileHandler.setLevel(logging.NOTSET)

# Formatter
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
consoleHandler.setFormatter(formatter)
fileHandler.setFormatter(formatter)

# 添加到Logger中
logger.addHandler(consoleHandler)
logger.addHandler(fileHandler)

# 打印日志
logger.debug('debug 信息')
logger.info('info 信息')
logger.warning('warn 信息')
logger.error('error 信息')
logger.critical('critical 信息')
logger.debug('%s 是自定义信息' % '这些东西')

运行结果。

2017-04-04 21:45:16,742 - root - DEBUG - debug 信息
2017-04-04 21:45:16,742 - root - INFO - info 信息
2017-04-04 21:45:16,742 - root - WARNING - warn 信息
2017-04-04 21:45:16,742 - root - ERROR - error 信息
2017-04-04 21:45:16,742 - root - CRITICAL - critical 信息
2017-04-04 21:45:16,742 - root - DEBUG - 这些东西 是自定义信息

外部配置

前面都是在代码中配置日志的输出,我们还可以将配置写到配置文件中,然后传递给日志模块。旧式程序会使用conf格式配置文件,不过这种配置文件比较传统,所以就不介绍了。

自Python 3.2起,引入了一种新的基于键值对的配置方式。这种新方式的优点是配置文件非常灵活,我们可以使用XML、YAML、JSON等格式存储配置,也可以从网络上接收序列化的Python对象当做配置对象。总之,想怎么来就怎么来。我们下面就介绍这种新方式。

具体的键值对需要参考官方文档。例如下面就是Python官方给出的一个YAML格式的配置文件。

version: 1
formatters:
  simple:
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'
handlers:
  console:
    class: logging.StreamHandler
    level: DEBUG
    formatter: simple
    stream: ext://sys.stdout
loggers:
  main:
    level: DEBUG
    handlers: [console]
    propagate: no
root:
  level: DEBUG
  handlers: [console]

然后引入logging.config模块,并将配置文件传递给logging.config模块的dictConfig方法。这样就做好了日志打印的准备工作了。

import logging.config

logging.config.dictConfig('config.yaml')

logger = logging.getLogger('fuck')

推荐阅读更多精彩内容

  • 简单的将日志打印到屏幕 输出:WARNING:root:warning messageERROR:root:err...
    狗狗胖妞阅读 1,125评论 0 0
  • 本文翻译自logging howto 基础教程 日志是跟踪软件运行时发生事件的一种手段。Python开发者在代码中...
    大蟒传奇阅读 2,728评论 0 17
  • 本文首发于Gevin的博客 原文链接:Python 日志功能详解 未经 Gevin 授权,禁止转载 软件开发中通过...
    Gevin阅读 2,677评论 1 23
  • logging模块介绍: logging是python内置的标准库模块,模块提供不同的日志级别,并可以采用不同的方...
    有点d伤阅读 1,790评论 0 1
  • 请让时间倒退回到2011年,刚刚脱离3年漫漫学习苦海的我欢欣雀跃地奔向了大学校门,兴奋、激动、忐忑、好奇、不安种种...
    盟盟zm阅读 581评论 9 19