logging模块简介

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

基础用法

import logging logging.warning("user [alex] attempted wrong password more than 3 times") logging.critical("server is down") WARNING:root:user [alex] attempted wrong password more than 3 times CRITICAL:root:server is down

logging的日志级别

debug是最低的内置级别，critical为最高

FATAL： 致命错误CRITICAL： 特别糟糕的事情，如内存耗尽、磁盘空间为空，一般很少使用ERROR： 发生错误时，如IO操作失败或者连接问题WARNING： 发生很重要的事件，但是并不是错误时，如用户登录密码错误INFO： 处理请求或者状态变化等日常事务DEBUG： 调试过程中使用DEBUG等级，如算法中每个循环的中间状态

把日志写到文件

import logging logging.basicConfig(filename='example.log',level=logging.INFO) logging.debug('This message should go to the log file') logging.info('So should this') logging.warning('And this, too')

其中下面这句中的level=loggin.INFO意思是，把日志纪录级别设置为INFO，也就是说，只有比日志是INFO或比INFO级别更高的日志才会被纪录到文件里，在这个例子， 第一条日志是不会被纪录的，如果希望纪录debug的日志，那把日志级别改成DEBUG就行了。

自定义日志格式

感觉上面的日志格式忘记加上时间啦，日志不知道时间怎么行呢，下面就来加上!

import logging logging.basicConfig(format='%(asctime)s %(message)s', datefmt='%m/%d/%Y %I:%M:%S %p') logging.warning('is when this event was logged.') # 输出 12/12/2010 11:46:36 AM is when this event was logged.

日志输出格式参数

%(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： 打印日志信息

logging.basicConfig函数各参数

filename： 指定日志文件名filemode： 和file函数意义相同，指定日志文件的打开模式，'w'或者'a'format： 指定输出的格式和内容，format可以输出很多有用的信息datefmt： 指定时间格式，同time.strftime()level： 设置日志级别，默认为logging.WARNNINGstream： 指定将日志的输出流，可以指定输出到sys.stderr，sys.stdout或者文件，默认输出到sys.stderr，当stream和filename同时指定时，stream被忽略

日志同时输出到屏幕和文件

想同时把log打印在屏幕和文件日志里，就需要了解一点复杂的知识。Python 使用logging模块记录日志涉及四个主要类

logger 提供了应用程序可以直接使用的接口；handler 将(logger创建的)日志记录发送到合适的目的输出；filter提供了细度设备来决定输出哪条日志记录；formatter决定日志记录的最终输出格式。

每个组件的主要功能

logger

每个程序在输出信息之前都要获得一个Logger。Logger通常对应了程序的模块名，比如聊天工具的图形界面模块可以这样获得它的Logger：

LOG=logging.getLogger(”chat.gui”) # 而核心模块可以这样： LOG=logging.getLogger(”chat.kernel”) # 还可以绑定handler和filters Logger.setLevel(lel) # 指定最低的日志级别，低于level的级别将被忽略。 Logger.addFilter(filt) # 添加指定的filter Logger.removeFilter(filt) # 删除指定的filter Logger.addHandler(hdlr) # 增加指定的handler Logger.removeHandler(hdlr) # 删除指定的handler Logger.debug() # 可以设置的日志级别 Logger.info() # 可以设置的日志级别 Logger.warning() # 可以设置的日志级别 Logger.error() # 可以设置的日志级别 Logger.critical() # 可以设置的日志级别

handler

handler对象负责发送相关的信息到指定目的地。Python的日志系统有多种Handler可以使用。有些Handler可以把信息输出到控制台，有些Handler可以把信息输出到文件，还有些 Handler可以把信息发送到网络上。如果觉得不够用，还可以编写自己的Handler。可以通过addHandler()方法添加多个多handler

Handler.setLevel(lel) # 低于lel级别的信息将被忽略 Handler.setFormatter() # 给这个handler选择一个格式 Handler.addFilter(filt) # 新增一个filter对象 Handler.removeFilter(filt) # 删除一个filter对象

每个Logger可以附加多个Handler。接下来我们就来介绍一些常用的Handler：

logging.StreamHandler 使用这个Handler可以向类似与sys.stdout或者sys.stderr的任何文件对象(file object)输出信息。 logging.FileHandler 和StreamHandler类似，用于向一个文件输出日志信息。不过FileHandler会帮你打开这个文件

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并不会被更名，而是被删除。

logging.handlers.TimedRotatingFileHandler

这个Handler和RotatingFileHandler类似，不过，它没有通过判断文件大小来决定何时重新创建日志文件，而是间隔一定时间就 自动创建新的日志文件。重命名的过程与RotatingFileHandler类似，不过新的文件不是附加数字，而是当前时间。它的函数是：TimedRotatingFileHandler( filename [,when [,interval [,backupCount]]])

其中filename参数和backupCount参数和RotatingFileHandler具有相同的意义。interval是时间间隔。when参数是一个字符串。表示时间间隔的单位，不区分大小写。它有以下取值： S 秒 M 分 H 小时 D 天 W 每星期（interval==0时代表星期一） midnight 每天凌晨

formatter 组件

日志的formatter是个独立的组件，可以跟handler组合

fh = logging.FileHandler("access.log") formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') fh.setFormatter(formatter) #把formmater绑定到fh上

filter 组件

如果你想对日志内容进行过滤，就可自定义一个filter

class IgnoreBackupLogFilter(logging.Filter): """忽略带db backup 的日志""" def filter(self, record): #固定写法 return "db backup" not in record.getMessage() # 注意filter函数会返加True or False，logger根据此值决定是否输出此日志

然后把这个filter添加到logger中

logger.addFilter(IgnoreBackupLogFilter()) # 下面的日志就会把符合filter条件的过滤掉 logger.debug("test ....") logger.info("test info ....") logger.warning("start to run db backup job ....") logger.error("test error ....")

一个同时输出到屏幕、文件、带filter的完成例子

import logging class IgnoreBackupLogFilter(logging.Filter): """忽略带db backup 的日志""" def filter(self, record): # 固定写法 return "db backup" not in record.getMessage() # console handler ch = logging.StreamHandler() ch.setLevel(logging.INFO) # file handler fh = logging.FileHandler('mysql.log') # fh.setLevel(logging.WARNING) # formatter formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') #bind formatter to ch ch.setFormatter(formatter) fh.setFormatter(formatter) logger = logging.getLogger("Mysql") logger.setLevel(logging.DEBUG) #logger 优先级高于其它输出途径的 # add handler to logger instance logger.addHandler(ch) logger.addHandler(fh) # add filter logger.addFilter(IgnoreBackupLogFilter()) logger.debug("test ....") logger.info("test info ....") logger.warning("start to run db backup job ....") logger.error("test error ....")

文件自动截断例子

import logging from logging import handlers logger = logging.getLogger(__name__) log_file = "timelog.log" # fh = handlers.RotatingFileHandler(filename=log_file,maxBytes=10,backupCount=3) fh = handlers.TimedRotatingFileHandler(filename=log_file,when="S",interval=5,backupCount=3) formatter = logging.Formatter('%(asctime)s %(module)s:%(lineno)d %(message)s') fh.setFormatter(formatter) logger.addHandler(fh) logger.warning("test1") logger.warning("test12") logger.warning("test13") logger.warning("test14")

转载于:https://www.cnblogs.com/chacecai/p/8979377.html