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')

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏Java架构

我是这样手写Spring的,麻雀虽小五脏俱全

人见人爱的Spring已然不仅仅只是一个框架了。如今,Spring已然成为了一个生态。但深入了解Spring的却寥寥无几。这里,我带大家一起来看看,我是如何手写...

631
来自专栏软件开发 -- 分享 互助 成长

linux下进程相关操作

一、定义和理解 狭义定义:进程是正在运行的程序的实例。 广义定义:进程是一个具有一定独立功能的程序关于某个数据集合的一次运行活动。 进程的概念主要有两点: 第一...

2245
来自专栏抠抠空间

logging模块

函数式简单配置 import logging logging.debug('debug message') logging.info('info mes...

28812
来自专栏企鹅号快讯

Python模块知识5:日志logging

logging模块提供了通用的日志系统,可以采用不同的方式记录日志,比如文件,HTTP、GET/POST,SMTP,Socket等,甚至可以自己实现具体的日志记...

2217
来自专栏月牙寂

docker源码分析(5)---daemon

第一时间获取文章,可以关注本人公众号 月牙寂道长 yueyajidaozhang

3248
来自专栏LinkedBear的个人空间

初试RocketMQ消息中间件 原

消息中间件利用高效可靠的消息传递机制进行平台无关的数据交流,并基于数据通信来进行分布式系统的集成。通过提供消息传递和消息排队模型,它可以在分布式环境下扩展进程间...

1384
来自专栏fixzd

redis系列:基于redis的分布式锁

这篇博文讲介绍如何一步步构建一个基于Redis的分布式锁。会从最原始的版本开始,然后根据问题进行调整,最后完成一个较为合理的分布式锁。

1052
来自专栏编程软文

快速上手友盟推送前后端

2805
来自专栏架构师之路

一分钟实现分布式锁

一、缘起 分布式环境下,多台机器上多个进程对一个数据进行操作,如果不做互斥,就有可能出现“余额扣成负数”,或者“商品超卖”的情况,如何实现简易分布式锁,对分布式...

4096
来自专栏用户2442861的专栏

tinyhttpd 剖析

http://blog.csdn.net/jcjc918/article/details/42129311

1552

扫码关注云+社区

领取腾讯云代金券