python标准日志模块logging及日志系统设计

Posted 2020-10-05

转载：http://www.cnblogs.com/goodhacker/p/3355660.html

python的标准库里的日志系统从Python2.3开始支持。只要import logging这个模块即可使用。如果你想开发一个日志系统， 既要把日志输出到控制台， 还要写入日志文件，只要这样使用：

 1 import logging
 2 
 3 # 创建一个logger
 4 logger = logging.getLogger(‘mylogger‘)
 5 logger.setLevel(logging.DEBUG)
 6 
 7 # 创建一个handler，用于写入日志文件
 8 fh = logging.FileHandler(‘test.log‘)
 9 fh.setLevel(logging.DEBUG)
10 
11 # 再创建一个handler，用于输出到控制台
12 ch = logging.StreamHandler()
13 ch.setLevel(logging.DEBUG)
14 
15 # 定义handler的输出格式
16 formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
17 fh.setFormatter(formatter)
18 ch.setFormatter(formatter)
19 
20 # 给logger添加handler
21 logger.addHandler(fh)
22 logger.addHandler(ch)
23 
24 # 记录一条日志
25 logger.info(‘foorbar‘)

　　结合上面的例子，我们说下几个最常使用的API：

　　logging.getLogger([name])

　　返回一个logger实例，如果没有指定name，返回root logger。只要name相同，返回的logger实例都是同一个而且只有一个，即name和logger实例是一一对应的。这意味着，无需把logger实例在各个模块中传递。只要知道name，就能得到同一个logger实例。

　　Logger.setLevel(lvl)

　　设置logger的level， level有以下几个级别：

　　　　

　　级别高低顺序：NOTSET < DEBUG < INFO < WARNING < ERROR < CRITICAL

　　如果把looger的级别设置为INFO， 那么小于INFO级别的日志都不输出， 大于等于INFO级别的日志都输出　　

1     logger.debug("foobar")    # 不输出   
2     logger.info("foobar")        # 输出  
3     logger.warning("foobar")  # 输出  
4     logger.error("foobar")      # 输出  
5     logger.critical("foobar")    # 输出  

　　Logger.addHandler(hdlr)

　　通过handler对象可以把日志内容写到不同的地方。比如简单的StreamHandler就是把日志写到类似文件的地方。python提供了十几种实用handler，比较常用有：

1 StreamHandler: 输出到控制台
2 FileHandler:   输出到文件
3 BaseRotatingHandler 可以按时间写入到不同的日志中。比如将日志按天写入不同的日期结尾的文件文件。
4 SocketHandler 用TCP网络连接写LOG
5 DatagramHandler 用UDP网络连接写LOG
6 SMTPHandler 把LOG写成EMAIL邮寄出去

　　logging.basicConfig([**kwargs])* 这个函数用来配置root logger， 为root logger创建一个StreamHandler，设置默认的格式。* 这些函数： logging.debug()、logging.info()、logging.warning()、logging.error()、logging.critical() 如果调用的时候发现root logger没有任何handler，会自动调用basicConfig添加一个handler* 如果root logger已有handler，这个函数不做任何事情使用basicConfig来配置root logger的输出格式和level：

1 import logging
2 logging.basicConfig(format=‘%(levelname)s:%(message)s‘, level=logging.DEBUG)
3 logging.debug(‘This message should appear on the console‘)

 

　　logger对象直接提供日志接口。formatter描述日志的格式。handler把日志写到不同的地方，你可以把日志保存成本地文件，也可以每个小时写一个日志文件，还可以把日志通过socket传到别的机器上。

　　从最简单的formatter对象来看。formatter指定的是每一条日志记录的抬头信息，也就是你可以指定日志记录的时间格式、进程号、文件名、函数名等信息。可以用这个方法来创建一个formatter对象：

logging.Formatter.__init__( fmt=None, datefmt=None)

　　fmt参数指定进程号、文件名、函数名等信息是否出现以及格式， datefmt为日期时间格式，默认的日期格式精确到微秒，例如‘2003-07-08 16:49:45,896’。fmt中可以指定多个字段，每个字段的格式为“%(<dictionary key>)s”， 例如你想打印时间、日志级别、日志信息可以用下面的format:

‘%(asctime)s - %(levelname)s - %(message)s‘

　　所有的可以使用的字段如下表：

　　在记录爬虫系统日志的时候需要定义记录日志的级别，级别越高表示打出来的日志越详细。我们可以用一个字典来设置不同级别对应的不同日志信息：

1 #用字典保存日志级别
2 format_dict = {
3    1 : logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘),
4    2 : logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘),
5    3 : logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘),
6    4 : logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘),
7    5 : logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
8 }

　　将本文开始的代码封装在一个类中

 1 #开发一个日志系统， 既要把日志输出到控制台， 还要写入日志文件   
 2 class Logger():
 3     def __init__(self, logname, loglevel, logger):
 4         ‘‘‘
 5            指定保存日志的文件路径，日志级别，以及调用文件
 6            将日志存入到指定的文件中
 7         ‘‘‘
 8         
 9         # 创建一个logger
10         self.logger = logging.getLogger(logger)
11         self.logger.setLevel(logging.DEBUG)
12         
13         # 创建一个handler，用于写入日志文件
14         fh = logging.FileHandler(logname)
15         fh.setLevel(logging.DEBUG)
16         
17         # 再创建一个handler，用于输出到控制台
18         ch = logging.StreamHandler()
19         ch.setLevel(logging.DEBUG)
20         
21         # 定义handler的输出格式
22         #formatter = logging.Formatter(‘%(asctime)s - %(name)s - %(levelname)s - %(message)s‘)
23         formatter = format_dict[int(loglevel)]
24         fh.setFormatter(formatter)
25         ch.setFormatter(formatter)
26         
27         # 给logger添加handler
28         self.logger.addHandler(fh)
29         self.logger.addHandler(ch)
30         
31     
32     def getlog(self):
33         return self.logger

再通过以下方式调用，便是一个简单的日志系统了

logger = Logger(logname=‘log.txt‘, loglevel=1, logger="fox").getlog()

以上是关于python标准日志模块logging及日志系统设计的主要内容，如果未能解决你的问题，请参考以下文章

python标准日志模块logging使用

flask日志

python-日志模块

python常用模块——logging

在 python 项目中如何记录日志

Python的日志系统