Python中使用logging模块打印log日志详解


Posted in Python onApril 05, 2015

学一门新技术或者新语言,我们都要首先学会如何去适应这们新技术,其中在适应过程中,我们必须得学习如何调试程序并打出相应的log信息来,正所谓“只要log打的好,没有bug解不了”,在我们熟知的一些信息技术中,log4xxx系列以及开发Android app时的android.util.Log包等等都是为了开发者更好的得到log信息服务的。在Python这门语言中,我们同样可以根据自己的程序需要打出log。

log信息不同于使用打桩法打印一定的标记信息,log可以根据程序需要而分出不同的log级别,比如info、debug、warn等等级别的信息,只要实时控制log级别开关就可以为开发人员提供更好的log信息,与log4xx类似,logger,handler和日志消息的调用可以有具体的日志级别(Level),只有在日志消息的级别大于logger和handler的设定的级别,才会显示。下面我就来谈谈我在Python中使用的logging模块一些方法。

logging模块介绍

Python的logging模块提供了通用的日志系统,熟练使用logging模块可以方便开发者开发第三方模块或者是自己的Python应用。同样这个模块提供不同的日志级别,并可以采用不同的方式记录日志,比如文件,HTTP、GET/POST,SMTP,Socket等,甚至可以自己实现具体的日志记录方式。下文我将主要介绍如何使用文件方式记录log。

logging模块包括logger,handler,filter,formatter这四个基本概念。

logger:提供日志接口,供应用代码使用。logger最长用的操作有两类:配置和发送日志消息。可以通过logging.getLogger(name)获取logger对象,如果不指定name则返回root对象,多次使用相同的name调用getLogger方法返回同一个logger对象。
handler:将日志记录(log record)发送到合适的目的地(destination),比如文件,socket等。一个logger对象可以通过addHandler方法添加0到多个handler,每个handler又可以定义不同日志级别,以实现日志分级过滤显示。
filter:提供一种优雅的方式决定一个日志记录是否发送到handler。
formatter:指定日志记录输出的具体格式。formatter的构造方法需要两个参数:消息的格式字符串和日期字符串,这两个参数都是可选的。

基本使用方法

一些小型的程序我们不需要构造太复杂的log系统,可以直接使用logging模块的basicConfig函数即可,代码如下:

'''

Created on 2012-8-12

 

@author: walfred

@module: loggingmodule.BasicLogger

'''

import logging

 

log_file = "./basic_logger.log"

 

logging.basicConfig(filename = log_file, level = logging.DEBUG)

 

logging.debug("this is a debugmsg!")

logging.info("this is a infomsg!")

logging.warn("this is a warn msg!")

logging.error("this is a error msg!")

logging.critical("this is a critical msg!")

运行程序时我们就会在该文件的当前目录下发现basic_logger.log文件,查看basic_logger.log内容如下:

INFO:root:this is a info msg!

DEBUG:root:this is a debug msg!

WARNING:root:this is a warn msg!

ERROR:root:this is a error msg!

CRITICAL:root:this is a critical msg!

需要说明的是我将level设定为DEBUG级别,所以log日志中只显示了包含该级别及该级别以上的log信息。信息级别依次是:notset、debug、info、warn、error、critical。如果在多个模块中使用这个配置的话,只需在主模块中配置即可,其他模块会有相同的使用效果。

较高级版本

上述的基础使用比较简单,没有显示出logging模块的厉害,适合小程序用,现在我介绍一个较高级版本的代码,我们需要依次设置logger、handler、formatter等配置。

'''

Created on 2012-8-12

 

@author: walfred

@module: loggingmodule.NomalLogger

'''

import logging

 

log_file = "./nomal_logger.log"

log_level = logging.DEBUG

 

logger = logging.getLogger("loggingmodule.NomalLogger")

handler = logging.FileHandler(log_file)

formatter = logging.Formatter("[%(levelname)s][%(funcName)s][%(asctime)s]%(message)s")

 

handler.setFormatter(formatter)

logger.addHandler(handler)

logger.setLevel(log_level)

 

#test

logger.debug("this is a debug msg!")

logger.info("this is a info msg!")

logger.warn("this is a warn msg!")

logger.error("this is a error msg!")

logger.critical("this is a critical msg!")

这时我们查看当前目录的nomal_logger.log日志文件,如下:

[DEBUG][][2012-08-12 17:43:59,295]this is a debug msg!

[INFO][][2012-08-12 17:43:59,295]this is a info msg!

[WARNING][][2012-08-12 17:43:59,295]this is a warn msg!

[ERROR][][2012-08-12 17:43:59,295]this is a error msg!

[CRITICAL][][2012-08-12 17:43:59,295]this is a critical msg!

这个对照前面介绍的logging模块,不难理解,下面的最终版本将会更加完整。

完善版本

这个最终版本我用singleton设计模式来写一个Logger类,代码如下:

'''

Created on 2012-8-12

 

@author: walfred

@module: loggingmodule.FinalLogger

'''

 

import logging.handlers

 

class FinalLogger:

 

 logger = None

 

 levels = {"n" : logging.NOTSET,

  "d" : logging.DEBUG,

  "i" : logging.INFO,

  "w" : logging.WARN,

  "e" : logging.ERROR,

  "c" : logging.CRITICAL}

 

 log_level = "d"

 log_file = "final_logger.log"

 log_max_byte = 10 * 1024 * 1024;

 log_backup_count = 5

 

 @staticmethod

 def getLogger():

  if FinalLogger.logger is not None:

   return FinalLogger.logger

 

  FinalLogger.logger = logging.Logger("oggingmodule.FinalLogger")

  log_handler = logging.handlers.RotatingFileHandler(filename = FinalLogger.log_file,\

  maxBytes = FinalLogger.log_max_byte,\

  backupCount = FinalLogger.log_backup_count)

  log_fmt = logging.Formatter("[%(levelname)s][%(funcName)s][%(asctime)s]%(message)s")

  log_handler.setFormatter(log_fmt)

  FinalLogger.logger.addHandler(log_handler)

  FinalLogger.logger.setLevel(FinalLogger.levels.get(FinalLogger.log_level))

  return FinalLogger.logger

 

if __name__ == "__main__":

 logger = FinalLogger.getLogger()

 logger.debug("this is a debug msg!")

 logger.info("this is a info msg!")

 logger.warn("this is a warn msg!")

 logger.error("this is a error msg!")

 logger.critical("this is a critical msg!")

当前目录下的 final_logger.log内容如下:

[DEBUG][][2012-08-12 18:12:23,029]this is a debug msg!

[INFO][][2012-08-12 18:12:23,029]this is a info msg!

[WARNING][][2012-08-12 18:12:23,029]this is a warn msg!

[ERROR][][2012-08-12 18:12:23,029]this is a error msg!

[CRITICAL][][2012-08-12 18:12:23,029]this is a critical msg!

这个final版本,也是我一直用的,读者朋友也可以再加上其他的一些Handler,比如StreamHandler等等来获取更多的log信息,当然也可以将你的log信息通过配置文件来完成。
Python 相关文章推荐
Python中replace方法实例分析
Aug 20 Python
举例讲解Python程序与系统shell交互的方式
Apr 09 Python
深入理解NumPy简明教程---数组3(组合)
Dec 17 Python
Django实现的自定义访问日志模块示例
Jun 23 Python
Python中数组,列表:冒号的灵活用法介绍(np数组,列表倒序)
Apr 18 Python
python 日期操作类代码
May 05 Python
python redis 删除key脚本的实例
Feb 19 Python
python3实现elasticsearch批量更新数据
Dec 03 Python
Python Socketserver实现FTP文件上传下载代码实例
Mar 27 Python
Linux安装Python3如何和系统自带的Python2并存
Jul 23 Python
python Matplotlib模块的使用
Sep 16 Python
python爬取天气数据的实例详解
Nov 20 Python
Python中的两个内置模块介绍
Apr 05 #Python
Python中不同进制互相转换(二进制、八进制、十进制和十六进制)
Apr 05 #Python
Python中使用第三方库xlrd来写入Excel文件示例
Apr 05 #Python
Python中使用第三方库xlrd来读取Excel示例
Apr 05 #Python
Python中使用第三方库xlutils来追加写入Excel文件示例
Apr 05 #Python
Python下使用Psyco模块优化运行速度
Apr 05 #Python
Python中使用tarfile压缩、解压tar归档文件示例
Apr 05 #Python
You might like
php模拟js函数unescape的函数代码
2012/10/20 PHP
PHP防盗链代码实例
2014/08/27 PHP
php获取文章上一页与下一页的方法
2014/12/01 PHP
php获取四位字母和数字的随机数的实现方法
2015/01/09 PHP
php函数连续调用实例分析
2015/07/30 PHP
php文件上传后端处理小技巧
2016/05/22 PHP
PHP使用递归算法无限遍历数组示例
2017/01/13 PHP
PhpStorm 如何优雅的调试Hyperf的方法步骤
2019/11/24 PHP
IE 当eval遇上function的处理
2011/08/09 Javascript
jQuery中[attribute]选择器用法实例
2014/12/31 Javascript
常用的JavaScript WEB操作方法分享
2015/02/28 Javascript
jQuery实现表格文本框淡入更改值后淡出效果
2016/09/27 Javascript
javascript淘宝主图放大镜功能
2016/10/20 Javascript
简单实现jQuery级联菜单
2017/01/09 Javascript
在React中如何优雅的处理事件响应详解
2017/07/24 Javascript
vue项目常用组件和框架结构介绍
2017/12/24 Javascript
微信小程序表单弹窗实例
2018/07/19 Javascript
JavaScript代码调试方法实例小结
2019/01/05 Javascript
JS尾递归的实现方法及代码优化技巧
2019/01/19 Javascript
JS面向对象编程——ES6 中class的继承用法详解
2020/03/03 Javascript
一个计算身份证号码校验位的Python小程序
2014/08/15 Python
使用Python的Flask框架实现视频的流媒体传输
2015/03/31 Python
Python遍历文件夹和读写文件的实现方法
2017/05/10 Python
Python unittest 自动识别并执行测试用例方式
2020/03/09 Python
python中什么是面向对象
2020/06/11 Python
基于python和flask实现http接口过程解析
2020/06/15 Python
学python爬虫能做什么
2020/07/29 Python
职业教育毕业生求职信
2013/11/09 职场文书
体育教师自荐信范文
2013/12/16 职场文书
我的老师教学反思
2014/05/01 职场文书
学校标语大全
2014/06/19 职场文书
土地租赁意向书
2014/07/30 职场文书
在宿舍喝酒的检讨书
2014/09/28 职场文书
新闻稿件写作范文
2015/07/18 职场文书
Golang二维切片初始化的实现
2021/04/08 Golang
go 实现简易端口扫描的示例
2021/05/22 Golang