小编这次要给大家分享的是如何使用Python日志logging模块,文章内容丰富,感兴趣的小伙伴可以来了解一下,希望大家阅读完这篇文章之后能够有所收获。
logging模块的介绍:
基本 | 中文意义 | 触发情况 |
DEBUG | 调试 | 调试时期 |
INFO | 提示 | 正常运行时 |
WARINING | 警告 | 现在可运行,但未来可能发生错误时(例如未来存储空间可能不足) |
ERROR | 错误 | 当程序发生错误,无法执行某些功能时 |
CRITICAL | 严重的、致命的 | 当程序发生严重错误,无法继续运行时 |
默认是WARNING。
这个表述可能不是很清晰,但意义类似程序报错信息,(假如)普通的异常信息只有一个报错原因,(那么为了方便观看)可能还需要一些如错误地点,错误事件等信息,而这些附加的统一的时间不应该由生产错误信息的部分来添加(可能有很多个模块),而应该将这个信息给专门做这事的部分来处理(交个formatter来处理)。
1.支持普通字符串%格式化,例如:
logging.info('Started %s'%tag)
2.支持普通字符串format格式化,例如:
logging.info('{} started '.format(tag))
3.logging自带的,例如:
logging.info('%s start in', tag) logging.info('%s start in %s',tag,address)
根据不同的style,可以使用%(message)s或{message}或$message类似的格式来标注指定位置使用指定信息来取代。
%(asctime)s
%(funcName)s
%(levelname)s
%(message)s
%(lineno)d
%(module)s
%(name)s
官方文档:
https://docs.python.org/3.6/library/logging.html
设置format中特殊字符asctime(日期时间)的输出格式
使用自己想要的分隔符和顺序来定义日期时间的格式,例如:
datefmt='%m/%d/%Y %I:%M:%S %p'
不使用format的:
import logging def show(): print("wechat running...") return "wechat" def main(): logging.basicConfig(filename='myapp.log', level=logging.INFO) tag=show() logging.info('Started %s'%tag) logging.info('Finished %s'%tag) if __name__ == '__main__' : main()
使用format和datefmt的:
import logging def show(): print("wechat running...") return "wechat" def main(): logging.basicConfig(filename='myapp.log', format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p',level=logging.INFO) tag=show() logging.info('%s start in', tag) logging.info('%s Finished',tag) if __name__ == '__main__' : main()
PS:虽然上面没有说到logger对象,handler对象(默认方向是标准输出流),formatter对象,但实际上,它是有默认的。不要因为默认值而搞错。所以不建议混杂基础版的和扩展版的使用。
import logging
logger = logging.getLogger("AppName")
【这里根据不同的名字定义不同的logger对象,默认为root。】
在模块中使用时,官方文档中有一个这样的代码,有点意思:
logger = logging.getLogger(__name__)
logger.setlevel()
例如:
logger.setLevel(logging.INFO)
handler用于处理日志信息的输出方向,可以添加多个handler,代表同时向多个方向输出信息
输出方向为文件,使用FileHandler,例如:
logging.FileHandler("test.log")
输出方向为流,使用StreamHandler,例如:
logging.StreamHandler(sys.stdout)
PS:想了解更多Handler,可以自己查看官方文档https://docs.python.org/3.6/howto/logging.html
例如:
logger.addHandler(handler)
例如:
logger.removeHandler(handler)
5.定义handler的输出格式formatter并绑定到handler上,formatter的设置方法类似上面基础使用中的format:
例如:
formatter = logging.Formatter('%(asctime)s %(levelname)s: %(message)s')
handler.setFormatter(formatter) 或handler.formatter=formatter
6.将handle绑定到logger对象上。
logger.addHandler(file_handler) logger.addHandler(console_handler)
7.输出日志:
调试级别: logger.debug(信息)
提示级别: logger.info(信息)
警告级别: logger.warn(信息)
错误级别:
logger.error(信息)
logger.exception(信息)【与error不同的是,还附带堆栈信息,一般用在发生异常时】
严重级别:
logger.fatal(信息) 【fatal是critical的别名】
logger.critical(信息)
import logging def demo(): #获取logger对象 logger=logging.getLogger("WeChat") #设置日志等级 logger.setLevel(logging.DEBUG) #创建绑定handler handler=logging.FileHandler('wechat.log') logger.addHandler(handler) # 创建绑定formatter formatter = logging.Formatter('%(asctime)s %(levelname)s: %(message)s') formatter.datefmt = '%m/%d/%Y %I:%M:%S %p' #可选的 handler.setFormatter(formatter) #尝试输出错误信息 logger.debug("debug message") logger.info("info message") logger.warning("warining message") logger.error("error message") logger.critical("critical message") if __name__=="__main__" : demo()
使用方法1:建立子类
下面的例子可能不是很符合应用,仅用于举例:
过滤非允许用户的日志信息:
import logging import sys class ContextFilter(logging.Filter): def filter(self, record): if record.role=="admin" : return True else: return False if __name__ == '__main__': logger=logging.getLogger("Wechat") logger.setLevel(logging.DEBUG) handler=logging.StreamHandler(sys.stdout) formatter=logging.Formatter('%(asctime)s %(levelname)s: %(message)s Role: %(role)s') handler.setFormatter(formatter) logger.addHandler(handler) #创建绑定fiter f = ContextFilter() logger.addFilter(f) logger.info('An info message with %s', 'some parameters',extra={"role":"admin"}) logger.info('An info message with %s', 'some parameters',extra={"role":"hacker"})#hacker的被过滤掉了
官网版的加信息版本:
import logging from random import choice class ContextFilter(logging.Filter): """ This is a filter which injects contextual information into the log. Rather than use actual contextual information, we just use random data in this demo. """ USERS = ['jim', 'fred', 'sheila'] IPS = ['123.231.231.123', '127.0.0.1', '192.168.0.1'] def filter(self, record): record.ip = choice(ContextFilter.IPS) record.user = choice(ContextFilter.USERS) return True if __name__ == '__main__': levels = (logging.DEBUG, logging.INFO, logging.WARNING, logging.ERROR, logging.CRITICAL) logging.basicConfig(level=logging.DEBUG, format='%(asctime)-15s %(name)-5s %(levelname)-8s IP: %(ip)-15s User: %(user)-8s %(message)s') a1 = logging.getLogger('a.b.c') a2 = logging.getLogger('d.e.f') f = ContextFilter() a1.addFilter(f) a2.addFilter(f) a1.debug('A debug message') a1.info('An info message with %s', 'some parameters') for x in range(10): lvl = choice(levels) lvlname = logging.getLevelName(lvl) a2.log(lvl, 'A message at %s level with %d %s', lvlname, 2, 'parameters')
使用方法2:使用filter函数
python3.2后,可以使用filter函数来做到上面方法1的效果
例子1:
import logging import sys def myfilter(record): if record.role == "admin": return True else: return False if __name__ == '__main__': logger=logging.getLogger("Wechat") logger.setLevel(logging.DEBUG) handler=logging.StreamHandler(sys.stdout) formatter=logging.Formatter('%(asctime)s %(levelname)s: %(message)s Role: %(role)s') handler.setFormatter(formatter) logger.addHandler(handler) #创建绑定fiter f = logging.Filter() f.filter=myfilter logger.addFilter(f) logger.info('An info message with %s', 'some parameters',extra={"role":"admin"}) logger.info('An info message with %s', 'some parameters',extra={"role":"hacker"})#hacker的被过滤掉了
例子2,利用lambda:
logger=logging.getLogger("Wechat") logger.setLevel(logging.DEBUG) handler=logging.StreamHandler(sys.stdout) formatter=logging.Formatter('%(asctime)s %(levelname)s: %(message)s Role: %(role)s') handler.setFormatter(formatter) logger.addHandler(handler) #创建绑定fiter # f = ContextFilter() f = logging.Filter() f.filter=lambda record: record.role=="admin" logger.addFilter(f) logger.info( 'An info message with %s', 'some parameters',extra={"role":"admin"}) logger.info('An info message with %s', 'some parameters',extra={"role":"hacker"})#hacker的被过滤掉了
注意:logging默认使用的logger对象叫做root
config文件配置方式:
import logging import logging.config logging.config.fileConfig('logging.conf') # create logger logger = logging.getLogger('simpleExample') # 'application' code logger.debug('debug message') logger.info('info message') logger.warn('warn message') logger.error('error message') logger.critical('critical message')
文件内容:
[loggers] keys=root,simpleExample [handlers] keys=consoleHandler [formatters] keys=simpleFormatter [logger_root] level=DEBUG handlers=consoleHandler [logger_simpleExample] level=DEBUG handlers=consoleHandler qualname=simpleExample propagate=0 [handler_consoleHandler] class=StreamHandler level=DEBUG formatter=simpleFormatter args=(sys.stdout,) [formatter_simpleFormatter] format=%(asctime)s - %(name)s - %(levelname)s - %(message)s datefmt=
PS:也支持YAML方式,这里不讲述
如果留意到过滤器例子的话,你可以发现
输出信息时,附加一个参数extra,附加的参数可以被formatter使用
import logging import sys class ContextFilter(logging.Filter): def filter(self, record): if record.role=="admin" : return True else: return False if __name__ == '__main__': logger=logging.getLogger("Wechat") logger.setLevel(logging.DEBUG) handler=logging.StreamHandler(sys.stdout) formatter=logging.Formatter('%(asctime)s %(levelname)s: %(message)s Role: %(role)s') handler.setFormatter(formatter) logger.addHandler(handler) #创建绑定fiter f = ContextFilter() logger.addFilter(f) logger.info('An info message with %s', 'some parameters',extra={"role":"admin"}) logger.info('An info message with %s', 'some parameters',extra={"role":"hacker"})#hacker的被过滤掉了
看完这篇关于如何使用Python日志logging模块的文章,如果觉得文章内容写得不错的话,可以把它分享出去给更多人看到。
免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。