logging模块

很多程序都有记录日志的需求，并且日志中包含的信息即有正常的程序访问日志，还可能有错误、警告等信息输出，python的logging模块提供了标准的日志接口，你可以通过它存储各种格式的日志，logging的日志可以分为 debug() , info() , warning() , error() and critical() 5个级别，下面我们看一下怎么用。

看一下这几个日志级别分别代表什么意思

Level	When it’s used
`DEBUG`	Detailed information, typically of interest only when diagnosing problems.
`INFO`	Confirmation that things are working as expected.
`WARNING`	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.
`ERROR`	Due to a more serious problem, the software has not been able to perform some function.
`CRITICAL`	A serious error, indicating that the program itself may be unable to continue running.

一、简单应用：

1 import logging
2 
3 logging.debug('debug message')
4 logging.info('info message')
5 logging.warning('warning message')
6 logging.error('error message')
7 logging.critical('critical message')

结果：

"D:Program Files (x86)python36python.exe" F:/python从入门到放弃/7.3/logging_module.py
WARNING:root:warning message
ERROR:root:error message
CRITICAL:root:critical message

Process finished with exit code 0

可见，默认情况下logging模块将日志打印到了标准输出中，且只显示了大于等于WARNING级别的日志，这说明默认的日志级别设置为WARNING（日志级别等级CRITICAL > ERROR > WARNING > INFO > DEBUG > NOTSET），默认的日志格式为日志级别：Logger名称：用户输出消息。

二 灵活配置日志级别，日志格式，输出位置

 1 import logging
 2 
 3 logging.basicConfig(level=logging.DEBUG,
 4                     format='%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
 5                     datefmt='%a, %d %b %Y %H:%M:%S',
 6                     filename='test.log',
 7                     filemode='w')
 8 #'%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s',
 9 #   时间变量     文件名           行号         级别名字      记录内容
10 logging.debug('debug message')
11 logging.info('info message')
12 logging.warning('warning message')
13 logging.error('error message')
14 logging.critical('critical message')

打开 test.log 信息会保存在文件，不会在后台打印出来。

Wed, 04 Jul 2018 16:34:40 logging_module.py[line:10] DEBUG debug message
Wed, 04 Jul 2018 16:34:40 logging_module.py[line:11] INFO info message
Wed, 04 Jul 2018 16:34:40 logging_module.py[line:12] WARNING warning message
Wed, 04 Jul 2018 16:34:40 logging_module.py[line:13] ERROR error message
Wed, 04 Jul 2018 16:34:40 logging_module.py[line:14] 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：
1) logging.StreamHandler
使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。它的构造函数是：
StreamHandler([strm])
其中strm参数是一个文件对象。默认是sys.stderr

2) logging.FileHandler
和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件。它的构造函数是：
FileHandler(filename[,mode])
filename是文件名，必须指定一个文件名。
mode是文件的打开方式。参见Python内置函数open()的用法。默认是’a'，即添加到文件末尾。

3) logging.handlers.RotatingFileHandler
这个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并不会被更名，而是被删除。

4) logging.handlers.TimedRotatingFileHandler
这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的构造函数是：
TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])
其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。
interval是时间间隔。
when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值：
S 秒
M 分
H 小时
D 天
W 每星期（interval==0时代表星期一）
midnight 每天凌晨

三 logger对象

上述几个例子中我们了解到了logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical()（分别用以记录不同级别的日志信息），logging.basicConfig()（用默认日志格式（Formatter）为日志系统建立一个默认的流处理器（StreamHandler），设置基础配置（如日志级别等）并加到root logger（根Logger）中）这几个logging模块级别的函数，另外还有一个模块级别的函数是logging.getLogger([name])（返回一个logger对象，如果没有指定名字将返回root logger）

先看一个最简单的过程：

 1 import logging
 2 
 3 logger = logging.getLogger()
 4 # 创建一个handler，用于写入日志文件
 5 fh = logging.FileHandler('test.log')
 6 
 7 # 再创建一个handler，用于输出到控制台
 8 ch = logging.StreamHandler()
 9 #格式可以设置多个
10 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
11 #创建对象格式
12 fh.setFormatter(formatter)
13 ch.setFormatter(formatter)
14 
15 logger.addHandler(fh) #logger对象可以添加多个fh和ch对象 addHandler增加输出对象
16 logger.addHandler(ch)
17 
18 logger.debug('logger debug message')
19 logger.info('logger info message')
20 logger.warning('logger warning message')
21 logger.error('logger error message')
22 logger.critical('logger critical message')

从这个输出可以看出logger = logging.getLogger()返回的Logger名为root。这里没有用logger.setLevel(logging.Debug)显示的为logger设置日志级别，所以使用默认的日志级别WARNIING，故结果只输出了大于等于WARNIING级别的信息。

(2) 如果我们再创建两个logger对象：

 1 import logging
 2 
 3 # from logging import handlers
 4 #
 5 # logger = logging.getLogger(__name__)
 6 #
 7 # log_file = "timelog.log"
 8 # #fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)
 9 # fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)
10 #
11 #
12 # formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
13 #
14 # fh.setFormatter(formatter)
15 #
16 # logger.addHandler(fh)
17 #
18 #
19 # logger.warning("test1")
20 # logger.warning("test12")
21 # logger.warning("test13")
22 # logger.warning("test14")
23 logger = logging.getLogger()
24 logger.setLevel(logging.DEBUG)
25 # 创建一个handler，用于写入日志文件
26 fh = logging.FileHandler('test.log')
27 
28 # 再创建一个handler，用于输出到控制台
29 ch = logging.StreamHandler()
30 
31 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
32 
33 fh.setFormatter(formatter)
34 ch.setFormatter(formatter)
35 
36 logger.addHandler(fh) #logger对象可以添加多个fh和ch对象
37 logger.addHandler(ch)
38 
39 logger.debug('logger debug message')
40 logger.info('logger info message')
41 logger.warning('logger warning message')
42 logger.error('logger error message')
43 logger.critical('logger critical message')
44 ##################################################
45 logger1 = logging.getLogger('mylogger')
46 logger1.setLevel(logging.DEBUG)
47 logger2 = logging.getLogger('mylogger')
48 logger2.setLevel(logging.INFO)
49 
50 fh = logging.FileHandler('test.log')
51 
52 # 再创建一个handler，用于输出到控制台
53 ch = logging.StreamHandler()
54 
55 logger1.addHandler(fh)
56 logger1.addHandler(ch)
57 
58 logger2.addHandler(fh)
59 logger2.addHandler(ch)
60 
61 logger1.debug('logger1 debug message')
62 logger1.info('logger1 info message')
63 logger1.warning('logger1 warning message')
64 logger1.error('logger1 error message')
65 logger1.critical('logger1 critical message')
66 
67 logger2.debug('logger2 debug message')
68 logger2.info('logger2 info message')
69 logger2.warning('logger2 warning message')
70 logger2.error('logger2 error message')
71 logger2.critical('logger2 critical message')

结果：：

"D:Program Files (x86)python36python.exe" F:/python从入门到放弃/7.3/logging_module.py
2018-07-05 10:49:43,598 - root - DEBUG - logger debug message
2018-07-05 10:49:43,598 - root - INFO - logger info message
2018-07-05 10:49:43,598 - root - WARNING - logger warning message
2018-07-05 10:49:43,598 - root - ERROR - logger error message
2018-07-05 10:49:43,598 - root - CRITICAL - logger critical message
logger1 info message
2018-07-05 10:49:43,598 - mylogger - INFO - logger1 info message
logger1 warning message
2018-07-05 10:49:43,598 - mylogger - WARNING - logger1 warning message
logger1 error message
2018-07-05 10:49:43,598 - mylogger - ERROR - logger1 error message
logger1 critical message
2018-07-05 10:49:43,598 - mylogger - CRITICAL - logger1 critical message
logger2 info message
2018-07-05 10:49:43,598 - mylogger - INFO - logger2 info message
logger2 warning message
2018-07-05 10:49:43,598 - mylogger - WARNING - logger2 warning message
logger2 error message
2018-07-05 10:49:43,598 - mylogger - ERROR - logger2 error message
logger2 critical message
2018-07-05 10:49:43,598 - mylogger - CRITICAL - logger2 critical message

Process finished with exit code 0

结果：

这里有两个个问题：

<1>我们明明通过logger1.setLevel(logging.DEBUG)将logger1的日志级别设置为了DEBUG，为何显示的时候没有显示出DEBUG级别的日志信息，而是从INFO级别的日志开始显示呢？

原来logger1和logger2对应的是同一个Logger实例，只要logging.getLogger（name）中名称参数name相同则返回的Logger实例就是同一个，且仅有一个，也即name与Logger实例一一对应。在logger2实例中通过logger2.setLevel(logging.INFO)设置mylogger的日志级别为logging.INFO，所以最后logger1的输出遵从了后来设置的日志级别。

<2>为什么logger1、logger2对应的每个输出分别显示两次?
这是因为我们通过logger = logging.getLogger()显示的创建了root Logger，而logger1 = logging.getLogger('mylogger')创建了root Logger的孩子(root.)mylogger,logger2同样。而孩子,孙子，重孙……既会将消息分发给他的handler进行处理也会传递给所有的祖先Logger处理。

ok,那么现在我们把

# logger.addHandler(fh)

# logger.addHandler(ch) 注释掉，我们再来看效果：

为我们注释了logger对象显示的位置，所以才用了默认方式，即标准输出方式。因为它的父级没有设置文件显示方式，所以在这里只打印了一次。

孩子,孙子，重孙……可逐层继承来自祖先的日志级别、Handler、Filter设置，也可以通过Logger.setLevel(lel)、Logger.addHandler(hdlr)、Logger.removeHandler(hdlr)、Logger.addFilter(filt)、Logger.removeFilter(filt)。设置自己特别的日志级别、Handler、Filter。若不设置则使用继承来的值。

<3>Filter
限制只有满足过滤规则的日志才会输出。
比如我们定义了filter = logging.Filter('a.b.c'),并将这个Filter添加到了一个Handler上，则使用该Handler的Logger中只有名字带 a.b.c前缀的Logger才能输出其日志。

filter = logging.Filter('mylogger')

logger.addFilter(filter)

这是只对logger这个对象进行筛选

如果想对所有的对象进行筛选，则：

filter = logging.Filter('mylogger')

fh.addFilter(filter)

ch.addFilter(filter)

这样，所有添加fh或者ch的logger对象都会进行筛选。

完成代码：

 1  1 import logging
 2  2 
 3  3 # from logging import handlers
 4  4 #
 5  5 # logger = logging.getLogger(__name__)
 6  6 #
 7  7 # log_file = "timelog.log"
 8  8 # #fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)
 9  9 # fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)
10 10 #
11 11 #
12 12 # formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
13 13 #
14 14 # fh.setFormatter(formatter)
15 15 #
16 16 # logger.addHandler(fh)
17 17 #
18 18 #
19 19 # logger.warning("test1")
20 20 # logger.warning("test12")
21 21 # logger.warning("test13")
22 22 # logger.warning("test14")
23 23 logger = logging.getLogger()
24 24 logger.setLevel(logging.DEBUG)
25 25 # 创建一个handler，用于写入日志文件
26 26 fh = logging.FileHandler('test.log')
27 27 
28 28 # 再创建一个handler，用于输出到控制台
29 29 ch = logging.StreamHandler()
30 30 
31 31 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
32 32 
33 33 fh.setFormatter(formatter)
34 34 ch.setFormatter(formatter)
35 35 
36 36 # logger.addHandler(fh) #logger对象可以添加多个fh和ch对象
37 37 # logger.addHandler(ch)
38 38 
39 39 # 定义一个filter
40 40 filter = logging.Filter('mylogger')
41 41 fh.addFilter(filter)
42 42 ch.addFilter(filter)
43 43 
44 44 # logger.addFilter(filter)
45 45 logger.addHandler(fh) #logger对象可以添加多个fh和ch对象
46 46 logger.addHandler(ch)
47 47 #
48 48 
49 49 logger.debug('logger debug message')
50 50 logger.info('logger info message')
51 51 logger.warning('logger warning message')
52 52 logger.error('logger error message')
53 53 logger.critical('logger critical message')
54 54 
55 55 
56 56 ##################################################
57 57 logger1 = logging.getLogger('mylogger')
58 58 logger1.setLevel(logging.DEBUG)
59 59 logger2 = logging.getLogger('mylogger')
60 60 logger2.setLevel(logging.INFO)
61 61 #
62 62 
63 63 
64 64 logger1.addHandler(fh)
65 65 logger1.addHandler(ch)
66 66 
67 67 logger2.addHandler(fh)
68 68 logger2.addHandler(ch)
69 69 
70 70 logger1.debug('logger1 debug message')
71 71 logger1.info('logger1 info message')
72 72 logger1.warning('logger1 warning message')
73 73 logger1.error('logger1 error message')
74 74 logger1.critical('logger1 critical message')
75 75 
76 76 logger2.debug('logger2 debug message')
77 77 logger2.info('logger2 info message')
78 78 logger2.warning('logger2 warning message')
79 79 logger2.error('logger2 error message')
80 80 logger2.critical('logger2 critical message')

完整代码1

完整代码二:

 1 #coding:utf-8  
 2 import logging  
 3   
 4 # 创建一个logger    
 5 logger = logging.getLogger()  
 6   
 7 logger1 = logging.getLogger('mylogger')  
 8 logger1.setLevel(logging.DEBUG)  
 9   
10 logger2 = logging.getLogger('mylogger')  
11 logger2.setLevel(logging.INFO)  
12   
13 logger3 = logging.getLogger('mylogger.child1')  
14 logger3.setLevel(logging.WARNING)  
15   
16 logger4 = logging.getLogger('mylogger.child1.child2')  
17 logger4.setLevel(logging.DEBUG)  
18   
19 logger5 = logging.getLogger('mylogger.child1.child2.child3')  
20 logger5.setLevel(logging.DEBUG)  
21   
22 # 创建一个handler，用于写入日志文件    
23 fh = logging.FileHandler('/tmp/test.log')  
24   
25 # 再创建一个handler，用于输出到控制台    
26 ch = logging.StreamHandler()  
27   
28 # 定义handler的输出格式formatter    
29 formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')  
30 fh.setFormatter(formatter)  
31 ch.setFormatter(formatter)  
32   
33 #定义一个filter  
34 #filter = logging.Filter('mylogger.child1.child2')  
35 #fh.addFilter(filter)    
36   
37 # 给logger添加handler    
38 #logger.addFilter(filter)  
39 logger.addHandler(fh)  
40 logger.addHandler(ch)  
41   
42 #logger1.addFilter(filter)  
43 logger1.addHandler(fh)  
44 logger1.addHandler(ch)  
45   
46 logger2.addHandler(fh)  
47 logger2.addHandler(ch)  
48   
49 #logger3.addFilter(filter)  
50 logger3.addHandler(fh)  
51 logger3.addHandler(ch)  
52   
53 #logger4.addFilter(filter)  
54 logger4.addHandler(fh)  
55 logger4.addHandler(ch)  
56   
57 logger5.addHandler(fh)  
58 logger5.addHandler(ch)  
59   
60 # 记录一条日志    
61 logger.debug('logger debug message')  
62 logger.info('logger info message')  
63 logger.warning('logger warning message')  
64 logger.error('logger error message')  
65 logger.critical('logger critical message')  
66   
67 logger1.debug('logger1 debug message')  
68 logger1.info('logger1 info message')  
69 logger1.warning('logger1 warning message')  
70 logger1.error('logger1 error message')  
71 logger1.critical('logger1 critical message')  
72   
73 logger2.debug('logger2 debug message')  
74 logger2.info('logger2 info message')  
75 logger2.warning('logger2 warning message')  
76 logger2.error('logger2 error message')  
77 logger2.critical('logger2 critical message')  
78   
79 logger3.debug('logger3 debug message')  
80 logger3.info('logger3 info message')  
81 logger3.warning('logger3 warning message')  
82 logger3.error('logger3 error message')  
83 logger3.critical('logger3 critical message')  
84   
85 logger4.debug('logger4 debug message')  
86 logger4.info('logger4 info message')  
87 logger4.warning('logger4 warning message')  
88 logger4.error('logger4 error message')  
89 logger4.critical('logger4 critical message')  
90   
91 logger5.debug('logger5 debug message')  
92 logger5.info('logger5 info message')  
93 logger5.warning('logger5 warning message')  
94 logger5.error('logger5 error message')  
95 logger5.critical('logger5 critical message')

完整代码

应用：

 1 import os
 2 import time
 3 import logging
 4 from config import settings
 5 
 6 
 7 def get_logger(card_num, struct_time):
 8 
 9     if struct_time.tm_mday < 23:
10         file_name = "%s_%s_%d" %(struct_time.tm_year, struct_time.tm_mon, 22)
11     else:
12         file_name = "%s_%s_%d" %(struct_time.tm_year, struct_time.tm_mon+1, 22)
13 
14     file_handler = logging.FileHandler(
15         os.path.join(settings.USER_DIR_FOLDER, card_num, 'record', file_name),
16         encoding='utf-8'
17     )
18     fmt = logging.Formatter(fmt="%(asctime)s :  %(message)s")
19     file_handler.setFormatter(fmt)
20 
21     logger1 = logging.Logger('user_logger', level=logging.INFO)
22     logger1.addHandler(file_handler)
23     return logger1

银行卡消费记录

文件自动截断例子：

例子

 1 import logging
 2 
 3 from logging import handlers
 4 
 5 logger = logging.getLogger(__name__)
 6 
 7 log_file = "timelog.log"
 8 #fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3)
 9 fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3)
10 
11 
12 formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s')
13 
14 fh.setFormatter(formatter)
15 
16 logger.addHandler(fh)
17 
18 
19 logger.warning("test1")
20 logger.warning("test12")
21 logger.warning("test13")
22 logger.warning("test14")

例子