• 为了保证你在浏览本网站时有着更好的体验,建议使用类似Chrome、Firefox之类的浏览器~~
    • 如果你喜欢本站的内容何不Ctrl+D收藏一下呢,与大家一起分享各种编程知识~
    • 本网站研究机器学习、计算机视觉、模式识别~当然不局限于此,生命在于折腾,何不年轻时多折腾一下

Python学习—-logging 日志记录

Python admin 5年前 (2015-06-03) 1246次浏览 0个评论 扫描二维码

许多应用程序中都会有日志模块,用于记录系统在运行过程中的一些关键信息,以便于对系统的运行状况进行跟踪。在.NET 平台中,有非常著名的第三方开源日志组件 log4net,c++中,有人们熟悉的 log4cpp,而在 python 中,我们不需要第三方的日志组件,因为它已经为我们提供了简单易用、且功能强大的日志模块:logging。logging 模块支持将日志信息保存到不同的目标域中,如:保存到日志文件中;以邮件的形式发送日志信息;以 http get 或 post 的方式提交日志到 web 服务器;以 windows 事件的形式记录等等。这些日志保存方式可以组合使用,每种方式可以设置自己的日志级别以及日志格式。日志模块的内容比较多,今天先学习 logging 模块的基本使用,下次具体学习日志的处理。

先看一个比较简单的例子,让我们对 logging 模块有个感性的认识:

1
2
3
import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
logging.debug('this is a message')

运行上面例子的代码,将会在程序的根目录下创建一个 log.txt 文件,打开该文件,里面有一条日志记录:”DEBUG:root:this is a message”。

4 个主要的组件

logger: 日志类,应用程序往往通过调用它提供的 api 来记录日志;

handler: 对日志信息处理,可以将日志发送(保存)到不同的目标域中;

filter: 对日志信息进行过滤;

formatter:日志的格式化;

日志级别

在记录日志时, 日志消息都会关联一个级别(“级别”本质上是一个非负整数)。系统默认提供了 6 个级别,它们分别是:

级别对应的值
CRITICAL50
ERROR40
WARNING30
INFO20
DEBUG10
NOTSET0

可以给日志对象(Logger Instance)设置日志级别,低于该级别的日志消息将会被忽略,也可以给 Hanlder 设置日志级别,对于低于该级别的日志消息, Handler 也会忽略。

logging 模块中的常用函数:

logging.basicConfig([**kwargs]):

为日志模块配置基本信息。kwargs 支持如下几个关键字参数:
filename :日志文件的保存路径。如果配置了些参数,将自动创建一个 FileHandler 作为 Handler;
filemode :日志文件的打开模式。 默认值为’a’,表示日志消息以追加的形式添加到日志文件中。如果设为’w’, 那么每次程序启动的时候都会创建一个新的日志文件;
format :设置日志输出格式;
datefmt :定义日期格式;
level :设置日志的级别.对低于该级别的日志消息将被忽略;
stream :设置特定的流用于初始化 StreamHandler;

下面是一个简单的例子:

1
2
3
4
5
6
7
8
9
10
11
#coding=gbk
import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), /
    level = logging.WARN, filemode = 'w', format = '%(asctime)s - %(levelname)s: %(message)s')
logging.debug('debug'#被忽略
logging.info('info')    #被忽略
logging.warning('warn')
logging.error('error')
#----- 结果
#2009-07-13 21:42:15,592 - WARNING: warn
#2009-07-13 21:42:15,640 - ERROR: error

logging.getLogger([name])

  创建 Logger 对象。日志记录的工作主要由 Logger 对象来完成。在调用 getLogger 时要提供 Logger 的名称(注:多次使用相同名称来调用 getLogger,返回的是同一个对象的引用。),Logger 实例之间有层次关系,这些关系通过 Logger 名称来体现,如:

p = logging.getLogger(“root”)

c1 = logging.getLogger(“root.c1″)

c2 = logging.getLogger(“root.c2″)

例子中,p 是父 logger, c1,c2 分别是 p 的子 logger。c1, c2 将继承 p 的设置。如果省略了 name 参数, getLogger 将返回日志对象层次关系中的根 Logger。

logging.setLoggerClass(klass)

logging.getLoggerClass()

获取/设置日志类型。用户可以自定义日志类来代替系统提供的 logging.Logger 类。

logging.getLevelName(lvl)

获取日志级别对应的名称。例如:

1
2
3
4
5
6
print logging.getLevelName(logging.NOTSET)
print logging.getLevelName(10) #logging.DEBUG
print logging.getLevelName(logging.DEBUG)
print logging.getLevelName(30) #logging.WARN
print logging.getLevelName(logging.ERROR)
print logging.getLevelName(50#logging.CRITICAL

logging.shutdown()

  当不再使用日志系统的时候,调用该方法,它会将日志 flush 到对应的目标域上。一般在系统退出的时候调用。

Logger 对象 通过调用 logging.getLogger(name)来创建,它有如下常用的方法和属性:

Logger.setLevel(lvl):

设置日志的级别。对于低于该级别的日志消息将被忽略。下面一个例子演示 setLevel 方法:

1
2
3
4
5
6
7
8
9
#coding=gbk
import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
log = logging.getLogger('root.test')
log.setLevel(logging.WARN)  #日志记录级别为 WARNNING
log.info('info')    #不会被记录
log.debug('debug')  #不会被记录
log.warning('warnning')
log.error('error')

Logger.debug(msg [ ,*args [, **kwargs]])

记录 DEBUG 级别的日志信息。参数 msg 是信息的格式,args 与 kwargs 分别是格式参数。

1
2
3
4
5
import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
log = logging.getLogger('root')
log.debug('%s, %s, %s', *('error', 'debug', 'info'))
log.debug('%(module)s, %(info)s', {'module': 'log', 'info': 'error'})

Logger.info(msg[ , *args[ , **kwargs] ] )

Logger.warnning(msg[ , *args[ , **kwargs] ] )

Logger.error(msg[ , *args[ , **kwargs] ] )

Logger.critical(msg[ , *args[ , **kwargs] ] )

记录相应级别的日志信息。参数的含义与 Logger.debug 一样。

Logger.log(lvl, msg[ , *args[ , **kwargs] ] )

记录日志,参数 lvl 用户设置日志信息的级别。参数 msg, *args, **kwargs 的含义与 Logger.debug 一样。

Logger.exception(msg[, *args])

以 ERROR 级别记录日志消息,异常跟踪信息将被自动添加到日志消息里。Logger.exception 通过用在异常处理块中,如:

1
2
3
4
5
6
7
import logging
logging.basicConfig(filename = os.path.join(os.getcwd(), 'log.txt'), level = logging.DEBUG)
log = logging.getLogger('root')
try:
    raise Exception, 'this is a exception'
except:
    log.exception('exception') #异常信息被自动添加到日志消息中

Logger.addFilter(filt)

Logger.removeFilter(filt)

添加/移除日志消息过滤器。在讲述 Filter 时具体介绍。

Logger.addHandler(hdlr)

Logger.removeHandler(hdlr)

添加/移除日志消息处理器。在讲述 Handler 时具体介绍。

Logger.makeRecord(name, lvl, fn, lno, msg, args, exc_info[, func, extra])

创建 LogRecord 对象。日志消息被实例为一个 LogRecord 对象,并在日志类内处理。


Deeplearn, 版权所有丨如未注明 , 均为原创丨本网站采用BY-NC-SA协议进行授权 , 转载请注明Python 学习—-logging 日志记录
喜欢 (0)
admin
关于作者:
互联网行业码农一枚/业余铲屎官/数码影音爱好者/二次元

您必须 登录 才能发表评论!