很多程序都有记录日志的需求,并且日志中包含的信息即有正常的程序访问日志,还可能有错误、警告等信息输出,python 的 logging 模块提供了标准的日志接口,你可以通过它存储各种格式的日志,logging 的日志可以分为
,
- debug()
,
- info()
,
- warning()
and
- error()
下面我们看一下怎么用。
- critical() 5个级别,
- import logging
- logging.debug('debug message')
- logging.info('info message')
- logging.warning('warning message')
- logging.error('error message')
- logging.critical('critical message')
输出:
WARNING:root:warning message
ERROR:root:error message
CRITICAL:root:critical message
可见,默认情况下 Python 的 logging 模块将日志打印到了标准输出中,且只显示了大于等于 WARNING 级别的日志,这说明默认的日志级别设置为 WARNING(日志级别等级 CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET),默认的日志格式为日志级别:Logger 名称:用户输出消息。
看一下这几个日志级别分别代表什么意思:
Level | When it's used |
---|---|
|
Detailed information, typically of interest only when diagnosing problems. |
|
Confirmation that things are working as expected. |
|
An indication that something unexpected happened, or indicative of some problem in the near future (e.g.'disk space low'). The software is still working as expected. |
|
Due to a more serious problem, the software has not been able to perform some function. |
|
A serious error, indicating that the program itself may be unable to continue running. |
如果想把日志写到文件里,也很简单:
- import logging
- logging.basicConfig(filename='example.log',level=logging.INFO)
- logging.debug('This message should go to the log file')
- logging.info('So should this')
- logging.warning('And this, too')
其中下面这句中的 level=loggin.INFO 意思是,把日志纪录级别设置为 INFO,也就是说,只有比日志是 INFO 或比 INFO 级别更高的日志才会被纪录到文件里,在这个例子, 第一条日志是不会被纪录的,如果希望纪录 debug 的日志,那把日志级别改成 DEBUG 就行了。
- 1 logging.basicConfig(filename = 'example.log', level = logging.INFO)
感觉上面的日志格式忘记加上时间啦,日志不知道时间怎么行呢,下面就来加上!
- import logging
- logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p')
- logging.warning('is when this event was logged.')
- #输出
- 12/12/2010 11:46:36 AM is when this event was logged.
- import logging
- logging.basicConfig(level=logging.DEBUG,
- format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
- datefmt='%a, %d %b %Y %H:%M:%S',
- filename='/tmp/test.log',
- filemode='w')
- logging.debug('debug message')
- logging.info('info message')
- logging.warning('warning message')
- logging.error('error message')
- logging.critical('critical message')
查看输出:
cat /tmp/test.log
Mon, 05 May 2014 16:29:53 test_logging.py[line:9] DEBUG debug message
Mon, 05 May 2014 16:29:53 test_logging.py[line:10] INFO info message
Mon, 05 May 2014 16:29:53 test_logging.py[line:11] WARNING warning message
Mon, 05 May 2014 16:29:53 test_logging.py[line:12] ERROR error message
Mon, 05 May 2014 16:29:53 test_logging.py[line:13] CRITICAL critical message
可见在 logging.basicConfig() 函数中可通过具体参数来更改 logging 模块默认行为,可用参数有
filename:用指定的文件名创建 FiledHandler(后边会具体讲解 handler 的概念),这样日志会被存储在指定的文件中。
filemode:文件打开方式,在指定了 filename 时使用这个参数,默认值为 "a" 还可指定为 "w"。
format:指定 handler 使用的日志显示格式。
datefmt:指定日期时间格式。
level:设置 rootlogger(后边会讲解具体概念)的日志级别
stream:用指定的 stream 创建 StreamHandler。可以指定输出到 sys.stderr,sys.stdout 或者文件 (f=open('test.log','w')),默认为 sys.stderr。若同时列出了 filename 和 stream 两个参数,则 stream 参数会被忽略。
format 参数中可能用到的格式化串:
%(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 |
用户输出的消息 |
如果想同时把 log 打印在屏幕和文件日志里,就需要了解一点复杂的知识 了
Python 使用 logging 模块记录日志涉及四个主要类,使用官方文档中的概括最为合适:
logger 提供了应用程序可以直接使用的接口;
handler 将 (logger 创建的) 日志记录发送到合适的目的输出;
filter 提供了细度设备来决定输出哪条日志记录;
formatter 决定日志记录的最终输出格式。
logger:
每个程序在输出信息之前都要获得一个 Logger。Logger 通常对应了程序的模块名,比如聊天工具的图形界面模块可以这样获得它的 Logger:
LOG=logging.getLogger("chat.gui")
而核心模块可以这样:
LOG=logging.getLogger("chat.kernel")
Logger.setLevel(lel): 指定最低的日志级别,低于 lel 的级别将被忽略。debug 是最低的内置级别,critical 为最高
Logger.addFilter(filt)、Logger.removeFilter(filt): 添加或删除指定的 filter
Logger.addHandler(hdlr)、Logger.removeHandler(hdlr):增加或删除指定的 handler
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical():可以设置的日志级别
handler:
handler 对象负责发送相关的信息到指定目的地。Python 的日志系统有多种 Handler 可以使用。有些 Handler 可以把信息输出到控制台,有些 Logger 可以把信息输出到文件,还有些 Handler 可以把信息发送到网络上。如果觉得不够用,还可以编写自己的 Handler。可以通过 addHandler() 方法添加多个多 handler
Handler.setLevel(lel): 指定被处理的信息级别,低于 lel 级别的信息将被忽略
Handler.setFormatter():给这个 handler 选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt):新增或删除一个 filter 对象
每个 Logger 可以附加多个 Handler。接下来我们就来介绍一些常用的 Handler:
使用这个 Handler 可以向类似与 sys.stdout 或者 sys.stderr 的任何文件对象 (file object) 输出信息。它的构造函数是:
StreamHandler([strm])
其中 strm 参数是一个文件对象。默认是 sys.stderr
和 StreamHandler 类似,用于向一个文件输出日志信息。不过 FileHandler 会帮你打开这个文件。它的构造函数是:
FileHandler(filename[,mode])
filename 是文件名,必须指定一个文件名。
mode 是文件的打开方式。参见 Python 内置函数 open() 的用法。默认是'a',即添加到文件末尾。
这个 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 并不会被更名,而是被删除。
这个 Handler 和 RotatingFileHandler 类似,不过,它没有通过判断文件大小来决定何时重新创建日志文件,而是间隔一定时间就 自动创建新的日志文件。重命名的过程与 RotatingFileHandler 类似,不过新的文件不是附加数字,而是当前时间。它的构造函数是:
TimedRotatingFileHandler(filename [,when [,interval [,backupCount]]])
其中 filename 参数和 backupCount 参数和 RotatingFileHandler 具有相同的意义。
interval 是时间间隔。
when 参数是一个字符串。表示时间间隔的单位,不区分大小写。它有以下取值:
S 秒
M 分
H 小时
D 天
W 每星期(interval==0 时代表星期一)
midnight 每天凌晨
- import logging
- #create logger
- logger = logging.getLogger('TEST-LOG')
- logger.setLevel(logging.DEBUG)
- # create console handler and set level to debug
- ch = logging.StreamHandler()
- ch.setLevel(logging.DEBUG)
- # create file handler and set level to warning
- fh = logging.FileHandler("access.log")
- fh.setLevel(logging.WARNING)
- # create formatter
- formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
- # add formatter to ch and fh
- ch.setFormatter(formatter)
- fh.setFormatter(formatter)
- # add ch and fh to logger
- logger.addHandler(ch)
- logger.addHandler(fh)
- # 'application' code
- logger.debug('debug message')
- logger.info('info message')
- logger.warn('warn message')
- logger.error('error message')
- logger.critical('critical message')
文件自动截断例子:
- import logging
- from logging import handlers
- logger = logging.getLogger(__name__)
- log_file = "timelog.log"
- #fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)
- fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)
- formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
- fh.setFormatter(formatter)
- logger.addHandler(fh)
- logger.warning("test1")
- logger.warning("test12")
- logger.warning("test13")
- logger.warning("test14")
来源: http://www.cnblogs.com/qiyuanchang/p/7401644.html