logging模块是Python内置的标准模块,主要用于输出运行日志,可以设置输出日志的等级、日志保存路径、日志文件回滚等;相比print,具备如下优点:
1、可以通过设置不同的日志等级,在release版本中只输出重要信息,而不必显示大量的调试信息; 2、print将所有信息都输出到标准输出中,严重影响开发者从标准输出中查看其它数据; 3、logging则可以由开发者决定将信息输出到什么地方,以及怎么输出;
1. 基本使用
配置logging基本的设置,然后在控制台输出日志,
import logging logging.basicConfig(level = logging.INFO,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s') logger = logging.getLogger(__name__) logger.info("Start") logger.debug("cxk打篮球") logger.warning("唱跳rap") logger.info("Finish")运行时,控制台输出,
__main__ - INFO - Start __main__ - WARNING - 唱跳rap __main__ - INFO - Finishlogging中可以选择很多消息级别,如debug、info、warning、error以及critical。通过赋予logger或者handler不同的级别,开发者就可以只输出错误信息到特定的记录文件,或者在调试时只记录调试信息。
filename:指定日志文件名;
filemode:和file函数意义相同,指定日志文件的打开模式,‘w’或者’a’;
format:指定输出的格式和内容,format可以输出很多有用的信息,
参数:作用
%(levelno)s:打印日志级别的数值 %(levelname)s:打印日志级别的名称 %(pathname)s:打印当前执行程序的路径,其实就是sys.argv[0] %(filename)s:打印当前执行程序名 %(funcName)s:打印日志的当前函数 %(lineno)d:打印日志的当前行号 %(asctime)s:打印日志的时间 %(thread)d:打印线程ID %(threadName)s:打印线程名称 %(process)d:打印进程ID %(message)s:打印日志信息 datefmt:指定时间格式,同time.strftime(); level:设置日志级别,默认为logging.WARNNING; stream:指定将日志的输出流,可以指定输出到sys.stderr,sys.stdout或者文件,默认输出到sys.stderr,当 stream和filename同时指定时,stream被忽略;
2.将日志写入到文件
设置logging,创建一个FileHandler,并对输出消息的格式进行设置,将其添加到logger,然后将日志写入到指定的文件中,
import logging logger = logging.getLogger(__name__) logger.setLevel(level = logging.INFO) handler = logging.FileHandler("练习生.txt") handler.setLevel(logging.INFO) formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') handler.setFormatter(formatter) logger.addHandler(handler) logger.info("Start") logger.debug("cxk打篮球") logger.warning("唱跳rap") logger.info("Finish")log.txt中日志数据为,
__main__ - INFO - Start __main__ - WARNING - 唱跳rap __main__ - INFO - Finish3. 将日志同时输出到屏幕和日志文件
logger中添加StreamHandler,可以将日志输出到屏幕上,
import logging logger = logging.getLogger(__name__) logger.setLevel(level = logging.INFO) handler = logging.FileHandler("练习生.txt") handler.setLevel(logging.INFO) formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') handler.setFormatter(formatter) console = logging.StreamHandler() console.setLevel(logging.INFO) logger.addHandler(handler) logger.addHandler(console) logger.info("Start") logger.debug("cxk打篮球") logger.warning("唱跳rap") logger.info("Finish")logging有一个日志处理的主对象,其他处理方式都是通过addHandler添加进去,logging中包含的handler主要有如下几种,
handler名称位置作用StreamHandlerlogging.StreamHandler日志输出到流,可以是sys.stderr,sys.stdout或者文件FileHandlerlogging.FileHandler日志输出到文件BaseRotatingHandlerlogging.handlers.BaseRotatingHandler基本的日志回滚方式RotatingHandlerlogging.handlers.RotatingHandler日志回滚方式,支持日志文件最大数量和日志文件回滚TimeRotatingHandlerlogging.handlers.TimeRotatingHandler日志回滚方式,在一定时间区域内回滚日志文件SocketHandlerlogging.handlers.SocketHandler远程输出日志到TCP/IP socketsDatagramHandlerlogging.handlers.DatagramHandler远程输出日志到UDP socketsSMTPHandlerlogging.handlers.SMTPHandler远程输出日志到邮件地址SysLogHandlerlogging.handlers.SysLogHandler日志输出到syslogNTEventLogHandlerlogging.handlers.NTEventLogHandler远程输出日志到Windows NT/2000/XP的事件日志MemoryHandlerlogging.handlers.MemoryHandler日志输出到内存中的指定bufferHTTPHandlerlogging.handlers.HTTPHandler通过"GET"或者"POST"远程输出到HTTP服务器4. 日志回滚
使用RotatingFileHandler,可以实现日志回滚,
复制代码
import logging from logging.handlers import RotatingFileHandler logger = logging.getLogger(__name__) logger.setLevel(level = logging.INFO) #定义一个RotatingFileHandler,最多备份3个日志文件,每个日志文件最大1K rHandler = RotatingFileHandler("练习生.txt",maxBytes = 1*1024,backupCount = 3) rHandler.setLevel(logging.INFO) formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') rHandler.setFormatter(formatter) console = logging.StreamHandler() console.setLevel(logging.INFO) console.setFormatter(formatter) logger.addHandler(rHandler) logger.addHandler(console) logger.info("Start") logger.debug("cxk打篮球") logger.warning("唱跳rap") logger.info("Finish")复制代码 可以在工程目录中看到,备份的日志文件,
练习生.txt 练习生.txt.1 练习生.txt.2 练习生.txt.35.设置消息的等级 可以设置不同的日志等级,用于控制日志的输出,
日志等级使用范围FATAL致命错误CRITICAL特别糟糕的事情,如内存耗尽、磁盘空间为空,一般很少使用ERROR发生错误时,如IO操作失败或者连接问题WARNING发生很重要的事件,但是并不是错误时,如用户登录密码错误INFO处理请求或者状态变化等日常事务DEBUG调试过程中使用DEBUG等级,如算法中每个循环的中间状态