>>>logging模块

logging模块是日志模块,根据记录的日志排错,查找原因,logging有两种模式:

logging.basicConfig()
logging.getLogger()

首先我们来看下简单的屏幕打印:

1 import logging
2 
3 logging.debug("This msg is debug")
4 logging.info("This msg is infog")
5 logging.warning("This msg is warning")
6 logging.error("This msg is error")
7 logging.critical("This msg is critical")

简单的屏幕打印

打印结果为:

1 WARNING:root:This msg is warning
2 ERROR:root:This msg is error
3 CRITICAL:root:This msg is critical

打印结果

由此可见打印的默认结果是:从warning开始打印

为了灵活设置,我们采用logging.basicConfiG()模式:

 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='%Y/%m/%D %H:%M:%S',
 6                     filename='test.log',
 7                     filemode='a')
 8 
 9 logging.debug("This msg is debug")
10 logging.info("This msg is infog")
11 logging.warning("This msg is warning")
12 logging.error("This msg is error")
13 logging.critical("This msg is critical")

logging.basicConfig()

日志记录结果是:

1 2018/07/07/12/18 16:44:54 logging_module.py[line:96] DEBUG This msg is debug
2 2018/07/07/12/18 16:44:54 logging_module.py[line:97] INFO This msg is infog
3 2018/07/07/12/18 16:44:54 logging_module.py[line:98] WARNING This msg is warning
4 2018/07/07/12/18 16:44:54 logging_module.py[line:99] ERROR This msg is error
5 2018/07/07/12/18 16:44:54 logging_module.py[line:100] CRITICAL This msg is critical

日志记录结果

可见在logging.basicConfig()函数中可通过具体参数来更改logging模块默认行为，可用参数有
filename：用指定的文件名创建FiledHandler（后边会具体讲解handler的概念），这样日志会被存储在指定的文件中。
filemode：文件打开方式，在指定了filename时使用这个参数，默认值为“a”还可指定为“w”。
format：指定handler使用的日志显示格式。
datefmt：指定日期时间格式。
level：设置rootlogger（后边会讲解具体概念）的日志级别
stream：用指定的stream创建StreamHandler。可以指定输出到sys.stderr,sys.stdout或者文件，默认为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用户输出的消息

这个功能还满足不了需求的话,这能使用为所欲为的骚操作:

logging.getLogger():

用带吗实现你的需求:

 1 import logging
 2 
 3 logger = logging.getLogger()    # 实例化对象,在这边设置名称后不在是root,默认是root
 4 fh = logging.FileHandler('test.log', encoding='utf-8')      # 创建一个handler，用于写入日志文件
 5 sh = logging.StreamHandler()        # 再创建一个handler，用于输出到控制台
 6 formatter = logging.Formatter("%(asctime)s %(filename)s[line:%(lineno)d] %(levelname)s %(message)s")
 7 # 定义handler的输出格式formatter
 8 logger.setLevel(logging.DEBUG)      # 设置总开关
 9 
10 logger.addHandler(fh)       # 给logger加载文件句柄
11 logger.addHandler(sh)       # 给logger加载屏幕句柄
12 fh.setFormatter(formatter)      # 给fh设置格式
13 sh.setFormatter(formatter)      # 给sh设置格式
14 sh.setLevel(logging.INFO)       # 给各自设置开关
15 fh.setLevel(logging.WARNING)
16 
17 
18 logging.debug("This msg is debug")
19 logging.info("This msg is infog")
20 logging.warning("This msg is warning")
21 logging.error("This msg is error")
22 logging.critical("This msg is critical")

logging.getLogger

屏幕打印结果是:

1 2018-07-12 17:07:08,710 logging_module.py[line:118] INFO This msg is infog
2 2018-07-12 17:07:08,710 logging_module.py[line:119] WARNING This msg is warning
3 2018-07-12 17:07:08,710 logging_module.py[line:120] ERROR This msg is error
4 2018-07-12 17:07:08,710 logging_module.py[line:121] CRITICAL This msg is critical

屏幕打印结果

日志记录结果:

1 2018-07-12 17:07:08,710 logging_module.py[line:119] WARNING This msg is warning
2 2018-07-12 17:07:08,710 logging_module.py[line:120] ERROR This msg is error
3 2018-07-12 17:07:08,710 logging_module.py[line:121] CRITICAL This msg is critical

日志记录结果:

Logger

Logger是一个树形层级结构，输出信息之前都要获得一个Logger（如果没有显示的获取则自动创建并使用root Logger，如第一个例子所示）。
logger = logging.getLogger()返回一个默认的Logger也即root Logger，并应用默认的日志级别、Handler和Formatter设置。
当然也可以通过Logger.setLevel(lel)指定最低的日志级别，可用的日志级别有logging.DEBUG、logging.INFO、logging.WARNING、logging.ERROR、logging.CRITICAL。
Logger.debug()、Logger.info()、Logger.warning()、Logger.error()、Logger.critical()输出不同级别的日志，只有日志等级大于或等于设置的日志级别的日志才会被输出。

Handler

Handler对象负责发送相关的信息到指定目的地，有几个常用的Handler方法：
Handler.setLevel(lel):指定日志级别，低于lel级别的日志将被忽略
Handler.setFormatter()：给这个handler选择一个Formatter
Handler.addFilter(filt)、Handler.removeFilter(filt)：新增或删除一个filter对象

Formatter

Formatter对象设置日志信息最后的规则、结构和内容，默认的时间格式为%Y-%m-%d %H:%M:%S。

Formatter参数中可能用到的格式化串参见上文（logging.basicConfig()函数format参数中可能用到的格式化串：）

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

除了直接在程序中设置Logger，Handler,Filter,Formatter外还可以将这些信息写进配置文件中。

例如典型的logging.conf:

 1 [loggers]
 2 keys=root,simpleExample
 3  
 4 [handlers]
 5 keys=consoleHandler
 6  
 7 [formatters]
 8 keys=simpleFormatter
 9  
10 [logger_root]
11 level=DEBUG
12 handlers=consoleHandler
13  
14 [logger_simpleExample]
15 level=DEBUG
16 handlers=consoleHandler
17 qualname=simpleExample
18 propagate=0
19  
20 [handler_consoleHandler]
21 class=StreamHandler
22 level=DEBUG
23 formatter=simpleFormatter
24 args=(sys.stdout,)
25  
26 [formatter_simpleFormatter]
27 format=%(asctime)s - %(name)s - %(levelname)s - %(message)s
28 datefmt=

logger.config

程序可以这么写:

 1 import logging  
 2 import logging.config  
 3   
 4 logging.config.fileConfig("logging.conf")    # 采用配置文件   
 5   
 6 # create logger   
 7 logger = logging.getLogger("simpleExample")  
 8   
 9 # "application" code   
10 logger.debug("debug message")  
11 logger.info("info message")  
12 logger.warn("warn message")  
13 logger.error("error message")  
14 logger.critical("critical message")

logging.config

多模块使用logging
logging模块保证在同一个python解释器内，多次调用logging.getLogger('log_name')都会返回同一个logger实例，即使是在多个模块的情况下。所以典型的多模块场景下使用logging的方式是在main模块中配置logging，这个配置会作用于多个的子模块，然后在其他模块中直接通过getLogger获取Logger对象即可。

 1 import logging  
 2 import logging.config  
 3   
 4 logging.config.fileConfig('logging.conf')  
 5 root_logger = logging.getLogger('root')  
 6 root_logger.debug('test root logger...')  
 7   
 8 logger = logging.getLogger('main')  
 9 logger.info('test main logger')  
10 logger.info('start import module \'mod\'...')  
11 import mod  
12   
13 logger.debug('let\'s test mod.testLogger()')  
14 mod.testLogger()  
15   
16 root_logger.info('finish test...')

main

子模块:

1 import logging  
2 import submod  
3   
4 logger = logging.getLogger('main.mod')  
5 logger.info('logger of mod say something...')  
6   
7 def testLogger():  
8     logger.debug('this is mod.testLogger...')  
9     submod.tst()

子模块

子子模块:

1 import logging  
2   
3 logger = logging.getLogger('main.mod.submod')  
4 logger.info('logger of submod say something...')  
5   
6 def tst():  
7     logger.info('this is submod.tst()...')