python3logging

python3 logging

https://docs.python.org/3.5/library/logging.html&＃xff0c;先3.5是因为我当前的python 版本是3.5

之所以要来详细的写是因为之前学django时也有这个&＃xff0c;不是很理解&＃xff0c;所以这里就多了解下。

写到后面发现整个文章一点条理都没有&＃xff0c;但由于内容比较多&＃xff0c;就不重新整理了

logging框架中主要由四个部分组成&＃xff1a;

Loggers expose the interface that application code directly uses.Handlers send the log records (created by loggers) to the appropriate destination.Filters provide a finer grained facility for determining which log records to output.Formatters specify the layout of log records in the final output.

Loggers: 提供应用直接调用的接口
Handlers: 决定将日志记录发送至正确的目的地
Filters: 提供更精细的决定哪些日志输出的能力&＃xff0c;简单点说就是决定哪些输出哪些不输出
Formatters: 制定最终输出的格式。

logger对象

事实上logger是不直接实例化的&＃xff0c;但是我们可以通过模块级别的函数logging.getLogger(name)来调用。如果多次通过同一个名字调用getLogger()将只能得到对同一个对象的引用。

注意&＃xff1a; logging.getLogger(name) 中的name是一个支持通过“.”&＃xff08;点号&＃xff09;分层级的值。

例如&＃xff1a; 你定义一个logger: foo,那么foo.bar, foo.baz,就都算作它的子代&＃xff0c;就是继承&＃xff0c;有父子关系。

logger名字的层级与python中包的层级是一致的。所以为了区分它&＃xff0c;如果你基于模块来组织logger,

那么建议你使用&＃xff1a;logging.getLogger(__name__)这种形式&＃xff0c;因为对于模块而言&＃xff0c;在python

包的命名空间中__name__的值就是模块的名字。

常用方法&＃xff1a;

Logger.setLevel(lvl)&＃xff1a;

将logger的门限设置为lvl,低于此等级的信息将被忽略&＃xff0c;当一个Logger被创造出来时&＃xff0c;它的等级被设置为&＃xff1a;

NOTSET(未设置) 这样的结果就是&＃xff1a; 如果它是一个root logger,它将处理所有的信息&＃xff0c;如果没有root logger

它将继承父级的logger等级。Note: root logger可通过level waring来创建,注意这里是个坑&＃xff0c;

事实上默认root logger等级为warning&＃xff0c;不要搞错了

级别设定&＃xff1a;前面是名字&＃xff0c;后面是对应的数字值

Logger.exception(msg, *args, **kwargs)

以error级别来记录信息&＃xff0c;异常信息也会被添加到信息&＃xff08;message&＃xff09;,需要exception handler调用才行

Logger.addFilter(filt)

添加指定的过滤器

Logger.removeFilter(filt)

移除指定的过滤器

这里的方法多得让人想撞死在屏幕上&＃xff0c;以后慢慢更新吧。

Handler

Handler.setLevel(lel):指定被处理的信息级别&＃xff0c;低于lel级别的信息将被忽略
Handler.setFormatter()&＃xff1a;给这个handler选择一个格式
Handler.addFilter(filt)、Handler.removeFilter(filt)&＃xff1a;新增或删除一个filter对象

handler有多达15种&＃xff0c;这里只说下常见的几种&＃xff1a;

1.logging.StreamHandler

发送信息到流&＃xff0c;类文件对象即可&＃xff0c;如终端&＃xff0c;文件等

2.logging.FileHandler

发送信息到硬盘文件

3.logging.RotatingFileHandler
这个Handler类似于上面的FileHandler&＃xff0c;但是它可以管理文件大小&＃xff0c;轮询日志文件&＃xff08;不知道是不是检测日志文件大小&＃xff09;。

当文件达到一定大小之后&＃xff0c;它会自动将当前日志文件改名&＃xff0c;然后创建一个新的同名日志文件继续输出。

4.logging.handlers.TimedRotatingFileHandler

这个Handler和RotatingFileHandler类似,不过,它没有通过判断文件大小来决定何时重新创建日志文件&＃xff0c;

而是间隔一定时间就自动创建新的日志文件。

Formatter

Formatters 决定了记录格式。Formatter会将传递来的信息拼接成一条具体的字符串&＃xff0c;

默认情况下Format只会将信息%(message)s直接打印出来。Format中有一些自带的LogRecord属性可以使用&＃xff0c;如下表格:

其中lineno,pathname&＃xff0c;经过实测了&＃xff0c;并不是有些博客里说的什么当前日志记录的行号。后面会有实例。

这里有一个简单的应用的例子&＃xff0c;记录出错信息&＃xff1a;

#!/usr/bin/env python #coding:utf-8 # Created by Andy &＃64; 2017/6/22import logginglogging.basicConfig(level&＃61;logging.DEBUG,format&＃61;&＃39;%(asctime)s %(pathname)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s &＃39;,datefmt&＃61;&＃39;%a, %d %b %Y %H:%M:%S&＃39;,filename&＃61;r&＃39;D:\Coding\oldboy\day13 module\test.log&＃39;,filemode&＃61;&＃39;w&＃39;)def login():while True:try:name &＃61; input(&＃39;Input user name:&＃39;)password &＃61; int(input(&＃39;Input password:&＃39;)) # 这里故意转成整型&＃xff0c;触发异常if name &＃61;&＃61; &＃39;andy&＃39; and password &＃61;&＃61; &＃39;nopasswd&＃39;:print(&＃39;logging succeed!&＃39;)except ValueError as e:logging.debug(e)breakif __name__ &＃61;&＃61; &＃39;__main__&＃39;:login()

终端验证

Input user name:andy Input password:nopasswdProcess finished with exit code 0

打开test.log:

Fri, 23 Jun 2017 09:56:40 D:/Coding/oldboy/day13 module/log.py log.py[line:24] DEBUG invalid literal for int() with base 10: &＃39;nopasswd&＃39;

注意看&＃xff0c;lineno 并不是在日志里面的行号&＃xff0c;而是你代码的行号&＃xff0c;在24行调用了logging.debug(e)

这里现定义一个一simple_logger:

#!/usr/bin/env python #coding:utf-8 # Created by Andy &＃64; 2017/6/22import logging import oslog_path &＃61; os.path.join(os.getcwd(),&＃39;test.log&＃39;)logging.basicConfig(level&＃61;logging.DEBUG,format&＃61;&＃39;%(asctime)s %(pathname)s line:%(lineno)d %(message)s &＃39;,datefmt&＃61;&＃39;%Y-%m-%d %H:%M:%S&＃39;, # 将日期格式化成正常模式filename&＃61;log_path,filemode&＃61;&＃39;a&＃39;) # 指定成追加模式,默认就是追加&＃xff0c;所以这句非必须simple_logger &＃61; logging.getLogger(&＃39;simple&＃39;) fh &＃61; logging.StreamHandler() #输出到终端 fh.setLevel(level &＃61; logging.WARNING) #等级比默认的高&＃xff0c;但调用时必须一致 formatter &＃61; logging.Formatter("%(asctime)s %(message)s %(levelname)s") fh.setFormatter(formatter) simple_logger.addHandler(fh)def login():while True:try:name &＃61; input(&＃39;Input user name:&＃39;)password &＃61; int(input(&＃39;Input password:&＃39;)) # 这里故意转成整型&＃xff0c;触发异常if name &＃61;&＃61; &＃39;andy&＃39; and password &＃61;&＃61; &＃39;nopasswd&＃39;:print(&＃39;logging succeed!&＃39;)except ValueError as e:simple_logger.warning(e)breakif __name__ &＃61;&＃61; &＃39;__main__&＃39;:login()

运行&＃xff1a;

终端输出&＃xff1a;

Input user name:andy Input password:andy 2017-06-24 09:55:57,395 invalid literal for int() with base 10: &＃39;andy&＃39; WARNING

test.log文件&＃xff1a;

2017-06-24 09:55:57 D:/Coding/oldboy/day13 module/log.py line:33 invalid literal for int() with base 10: &＃39;andy&＃39;

这晨需要注意的是&＃xff1a;因为默认的logger等级是debug,所以它什么消息都会输出&＃xff0c;而simple_logger则只输出比自身高等级的信息&＃xff0c;

并且&＃xff1a;调用simple_logger时必须比定义的等级高于或者等于定义的等级&＃xff0c;这句话什么意思呢&＃xff1f;看上面的例子&＃xff0c;simple_logger

定义时的等级为warning,那么你调用时最少得warning等级&＃xff0c;或者比它高的critical才能正常打印消息&＃xff08;它规定就是这样&＃xff09;&＃xff0c;否则你是看不到任何效果的

&＃xff08;这里坑了好久&＃xff0c;一直没消息打印而找不到原因&＃xff0c;root logger默认等级是warning,而非Noset&＃xff09;&＃xff0c;但是如果你调用的等级比较低&＃xff0c;

并不影响root 这个logger打印日志信息。

填坑来了&＃xff1a;

如果没指定默认的logger的等级&＃xff0c;那么默认的等级warning就会生效&＃xff0c;所以才出现上面的情况&＃xff0c;如果需要将debug等级的信息也输入&＃xff0c;那么&＃xff0c;这里需要加一条&＃xff1a;

simple_logger.setLevel(logging.DEBUG) # 如果不设置此logger的级别&＃xff0c;那么handler的记录是从logger传过来的&＃xff0c;也就是默认从logger的warning来的

下面是一个使用配置文件的例子&＃xff1a;

#!/usr/bin/env python #coding:utf-8 # Created by Andy &＃64; 2017/6/25import logging import logging.configlogging.config.fileConfig(&＃39;logging.conf&＃39;)# create logger logger &＃61; logging.getLogger(&＃39;simpleExample&＃39;)# &＃39;application&＃39; code logger.debug(&＃39;debug message&＃39;) logger.info(&＃39;info message&＃39;) logger.warn(&＃39;warn message&＃39;) logger.error(&＃39;error message&＃39;) logger.critical(&＃39;critical message&＃39;)

配置文件&＃xff1a;

[loggers] keys&＃61;root,simpleExample[handlers] keys&＃61;consoleHandler,simpleHandler[formatters] keys&＃61;consoleFormatter,simpleFormatter[logger_root] level&＃61;DEBUG handlers&＃61;consoleHandler[logger_simpleExample] level&＃61;INFO handlers&＃61;simpleHandler qualname&＃61;simpleExample propagate&＃61;1[handler_consoleHandler] class&＃61;StreamHandler level&＃61;DEBUG formatter&＃61;consoleFormatter args&＃61;(sys.stdout,)[handler_simpleHandler] class&＃61;FileHandler level&＃61;INFO formatter&＃61;simpleFormatter args&＃61;(&＃39;simple.log&＃39;,&＃39;w&＃39;)[formatter_consoleFormatter] format&＃61;%(levelname)s :%(message)s[formatter_simpleFormatter] format&＃61;%(asctime)s - %(name)s - %(levelname)s - %(message)s datefmt&＃61;