python中的logger

logging模块简介

logging模块是Python内置的标准模块，主要用于输出运行日志，可以设置输出日志的等级、日志保存路径、日志文件回滚等；相比print，具备如下优点：

1. 可以通过设置不同的日志等级，在release版本中只输出重要信息，而不必显示大量的调试信息；
2. print将所有信息都输出到标准输出中，严重影响开发者从标准输出中查看其它数据；logging则可以由开发者决定将信息输出到什么地方，以及怎么输出；

 Logger从来不直接实例化，经常通过logging模块级方法（Module-Level  Function）logging.getLogger(name)来获得，其中如果name不给定就用root。名字是以点号分割的命名方式命名的(a.b.c)。对同一个名字的多个调用logging.getLogger()方法会返回同一个logger对象。这种命名方式里面，后面的loggers是前面logger的子logger，自动继承父loggers的log信息，正因为此,没有必要把一个应用的所有logger都配置一遍，只要把顶层的logger配置好了，然后子logger根据需要继承就行了。

   logging.Logger对象扮演了三重角色:

       首先,它暴露给应用几个方法以便应用可以在运行时写log.

       其次,Logger对象按照log信息的严重程度或者根据filter对象来决定如何处理log信息(默认的过滤功能).

       最后,logger还负责把log信息传送给相关的handlers.

2 logging模块使用

2.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 print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

　　运行时，控制台输出，

2020-11-20 10:34:02,250 - --name-- - INFO - start print log
2020-11-20 10:34:02,251 - --name-- - WARNING - something maybe fail
2020-11-20 10:34:02,251 - --name-- - INFO - Finish

　　logging中可以选择很多消息级别，如：DEBUG，INFO，WARNING，ERROR，CRITICAL，通过赋予logger或者handler不同的级别，开发者就可以只输出错误信息到特定的记录文件，或者在调试时只记录调试信息。

　　将logger的级别改为DEBUG，

logging.basicConfig(level = logging.DEBUG,format = '%(asctime)s - %(name)s - %(levelname)s - %(message)s')

　　再观察一下输出结果

　　从输出结果可以看到，输出了debug的日志记录

2020-11-20 10:35:29,566 - --name-- - INFO - start print log
2020-11-20 10:35:29,566 - --name-- - DEBUG - Do something
2020-11-20 10:35:29,567 - --name-- - WARNING - something maybe fail
2020-11-20 10:35:29,568 - --name-- - INFO - Finish

　　

2.2 将日志写入到文件

2.2.1 将日志写入到文件

logger = logging.getLogger()
logger.setLevel(level=logging.INFO)

handler = logging.FileHandler('log.txt')
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
logger.addHandler(handler)

　　

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

logger中添加StreamHandler，可以将日志输出到屏幕上

import logging
logger = logging.getLogger(__name__)
logger.setLevel(level = logging.INFO)
handler = logging.FileHandler("log.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 print log")
logger.debug("Do something")
logger.warning("Something maybe fail.")
logger.info("Finish")

　　可以在log.txt和控制台中看到

2020-11-20 10:59:29,934 - root - INFO - start print log
2020-11-20 10:59:29,934 - root - WARNING - Something maybe fail
2020-11-20 10:59:29,934 - root - INFO - finish

　　可以发现，logging有一个日志处理的主对象，其他处理方式都是通过addHandler添加进去，logging中包含的handler主要有如下几种，

　　handler名称：位置；作用

 

　　　　handler名称：位置；作用

 

　　StreamHandler：logging.StreamHandler；日志输出到流，可以是sys.stderr，sys.stdout或者文件

　　FileHandler：logging.FileHandler；日志输出到文件

　　BaseRotatingHandler：logging.handlers.BaseRotatingHandler；基本的日志回滚方式

　　RotatingHandler：logging.handlers.RotatingHandler；日志回滚方式，支持日志文件最大数量和日志文件回滚

　　TimeRotatingHandler：logging.handlers.TimeRotatingHandler；日志回滚方式，在一定时间区域内回滚日志文件

　　SocketHandler：logging.handlers.SocketHandler；远程输出日志到TCP/IP sockets

　　DatagramHandler：logging.handlers.DatagramHandler；远程输出日志到UDP sockets

　　SMTPHandler：logging.handlers.SMTPHandler；远程输出日志到邮件地址

　　SysLogHandler：logging.handlers.SysLogHandler；日志输出到syslog

　　NTEventLogHandler：logging.handlers.NTEventLogHandler；远程输出日志到Windows NT/2000/XP的事件日志

　　MemoryHandler：logging.handlers.MemoryHandler；日志输出到内存中的指定buffer

　　HTTPHandler：logging.handlers.HTTPHandler；通过"GET"或者"POST"远程输出到HTTP服务器

 

import logging
import os

# 创建自定义logger
logger = logging.getLogger("fanmao")
# 设置日志级别
logger.setLevel(logging.DEBUG)

# 设置日志格式
formatter = logging.Formatter('[%(asctime)s] [%(name)s] [%(levelname)s]: %(message)s')

#设置输出流
sh = logging.StreamHandler()
# 设置输出流的格式
sh.setFormatter(formatter)

# 设置日志文件保存  日志文件存放到 logs目录
filepath = os.path.join(os.path.dirname(__file__),"../logs") # 使用python内置模块获取logs目录绝对路径
if not os.path.exists(filepath):  # 如果不存在这个目录
    os.mkdir(filepath)    # 创建目录
logfile = os.path.join(filepath,'example.log') # 设置日志文件路径
fl = logging.FileHandler(filename=logfile,encoding='utf8')
fl.setFormatter(formatter)
# 添加自定义的日志处理。
logger.addHandler(sh)
logger.addHandler(fl)


if __name__ == '__main__':
    logger.debug("hello")