Python | 解决方案 | 多个文件共用logger，重复打印问题

2024-06-07 18:48
文章标签 python 解决方案 问题 重复 多个 打印 logger 共用

本文主要是介绍Python | 解决方案 | 多个文件共用logger，重复打印问题，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

项目中封装了logging库为log.py，实现既把日志输出到控制台， 又写入日志文件文件。
环境：python3.7.3

项目中，多个文件共用logger，出现重复打印问题，解决流程记录如下：

文件和调用方式如下：
log.py v1

#encoding = utf-8
#### @ Description: 日志封装文件# @ Author: fatih# @ Date: 2020-12-30 10:48:00# @ FilePath: \mechineInfo\utils\log.py# @ LastEditors: fatih# @ LastEditTime: 2021-01-11 16:18:30
###
import logging
# 既把日志输出到控制台， 还要写入日志文件
class Logger():def __init__(self, logname="info", loglevel=logging.DEBUG, loggername=None):'''指定保存日志的文件路径，日志级别，以及调用文件将日志存入到指定的文件中'''# 创建一个loggerself.logger = logging.getLogger(loggername)self.logger.setLevel(loglevel)# 创建一个handler，用于写入日志文件fh = logging.FileHandler(logname)fh.setLevel(loglevel)# 再创建一个handler，用于输出到控制台ch = logging.StreamHandler()ch.setLevel(loglevel)# 定义handler的输出格式# formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')formatter = logging.Formatter('[%(levelname)s]%(asctime)s %(filename)s:%(lineno)d: %(message)s')fh.setFormatter(formatter)ch.setFormatter(formatter)# 给logger添加handlerself.logger.addHandler(fh)self.logger.addHandler(ch)#测试日志，正式环境可删除self.logger.fatal("set logger") def getlog(self):self.logger.fatal("get logger")return self.logger

问题一：多文件调用共用logger，重复打印

调用方式：
a.py v1

#!/usr/bin/python
# -*- coding:utf-8 -*-import logging
from log import Loggerlogger = Logger().getlog()
logger.debug("this is a")

b.py v1

#!/usr/bin/python 
# -*- coding:utf-8 -*- 
import logging 
from log import Logger 
import a
logger = Logger().getlog() 
logger.debug("this is b")

此时执行b.py的结果如下:

$ python3 b.py
[CRITICAL]2021-01-20 10:51:17,966 log.py:44: set logger
[CRITICAL]2021-01-20 10:51:17,966 log.py:47: get logger
[DEBUG]2021-01-20 10:51:17,967 a.py:7: this is a
[CRITICAL]2021-01-20 10:51:17,968 log.py:44: set logger
[CRITICAL]2021-01-20 10:51:17,968 log.py:44: set logger
[CRITICAL]2021-01-20 10:51:17,968 log.py:47: get logger
[CRITICAL]2021-01-20 10:51:17,968 log.py:47: get logger
[DEBUG]2021-01-20 10:51:17,969 b.py:8: this is b
[DEBUG]2021-01-20 10:51:17,969 b.py:8: this is b

从结果可以看出来，存在logger共用，导致重复打印。

原因分析

调用方式logger = Logger().getlog()，即self.logger = logging.getLogger(logger)
logger参数并未传递，所以得到的self.logger是RootLogger
而RootLogger是一个python程序内全局唯一的，所有Logger对象的祖先。

也就是说先打开的文件中对log的设置，后打开的文件都会受到影响,都会走一遍logger的继承关系。
b.py import a, 先执行a, 然后调用getLogger，得到RootLogger，打印一次，再执行一次在a.py中打开的RootLogger，再打印一次

解决方案

不同文件调用，使用不同的loggername
a.py v2

logger = Logger("a.log", logging.DEBUG, __name__).getlog() 
logger.debug("this is a")

b.py v2

logger = Logger("b.log", logging.DEBUG, __name__).getlog() 
logger.debug("this is b")

此时重新执行
命令行显示正常了

[CRITICAL]2021-01-20 11:02:22,763 log.py:44: set logger
[CRITICAL]2021-01-20 11:02:22,764 log.py:47: get logger
[DEBUG]2021-01-20 11:02:22,764 a.py:7: this is a
[CRITICAL]2021-01-20 11:02:22,765 log.py:44: set logger
[CRITICAL]2021-01-20 11:02:22,765 log.py:47: get logger
[DEBUG]2021-01-20 11:02:22,765 b.py:8: this is

问题二：单文件重复调用logger，重复打印

a.py v2

logger = Logger("a.log", logging.DEBUG, __name__).getlog() 
logger.debug("this is a")
logger = Logger("a.log", logging.DEBUG, __name__).getlog() 
logger.debug("this is a 2")

打印结果：

[CRITICAL]2021-01-20 11:39:04,312 log.py:44: set logger
[CRITICAL]2021-01-20 11:39:04,312 log.py:47: get logger
[DEBUG]2021-01-20 11:39:04,312 a.py:7: this is a
[CRITICAL]2021-01-20 11:39:04,313 log.py:44: set logger
[CRITICAL]2021-01-20 11:39:04,313 log.py:44: set logger
[CRITICAL]2021-01-20 11:39:04,313 log.py:47: get logger
[CRITICAL]2021-01-20 11:39:04,313 log.py:47: get logger
[DEBUG]2021-01-20 11:39:04,313 a.py:10: this is a 2
[DEBUG]2021-01-20 11:39:04,313 a.py:10: this is a 2

此时例如执行logger = Logger("a.log", logging.DEBUG, __name__).getlog(),并且后续日志对象的第三个传参都相同的时候，
此后多次打印日志会出现日志信息条数线性增加
例如第一次打印一条，第二条打印相同的两条日志，第三次打印相同的三条日志…

原因解析

因为logger的name被固定，
所以当你第一次为logger对象添加FileHandler对象之后，
如果没有移除上一次的FileHandler对象，第二次logger对象就会再次获得相同的FileHandler对象，即拥有两个FileHandler对象，
最终造成打印两次，
同样，如果此时没有立即移除上一次的FileHandler对象，第三次logger对象就会再次获得相同的FileHandler对象，即拥有三个FileHandler象，最终打印3次…

解决方案

  1. 每次添加日志，创建与上次日志对象的loggername属性不同的logger对象
    • 调用会导致同时存在超多logger对象
    • 不推荐
  2. 每次logger输出之后，移除FileHandler对象
    • 重写输出接口，输出后增加removeHandler操作
    • 繁琐，复杂，不推荐
  3. 通过判断logger对象的handlers属性，或者hasHandlers函数，保持同一loggername对应的FileHander唯一
    • 只需要增加一行代码，if not logger.handlers: 或if not self.logger.hasHandlers()只有不存在Handler时才设置Handler
    • 简洁，推荐

第三种方案，改写log.py v1代码如下：

log.py v2

#encoding = utf-8
#### @ Description: 日志封装文件# @ Author: fatih# @ Date: 2020-12-30 10:48:00# @ FilePath: \mechineInfo\utils\log.py# @ LastEditors: fatih# @ LastEditTime: 2021-01-11 16:18:30
###
import logging
# 既把日志输出到控制台， 还要写入日志文件
class Logger():def __init__(self, logname="info", loglevel=logging.DEBUG, loggername=None):'''指定保存日志的文件路径，日志级别，以及调用文件将日志存入到指定的文件中'''# 创建一个loggerself.logger = logging.getLogger(loggername)self.logger.setLevel(loglevel)# 创建一个handler，用于写入日志文件fh = logging.FileHandler(logname)fh.setLevel(loglevel)if not self.logger.handlers:#或者使用如下语句判断#if not self.logger.hasHandlers():# 再创建一个handler，用于输出到控制台ch = logging.StreamHandler()ch.setLevel(loglevel)# 定义handler的输出格式# formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')formatter = logging.Formatter('[%(levelname)s]%(asctime)s %(filename)s:%(lineno)d: %(message)s')fh.setFormatter(formatter)ch.setFormatter(formatter)# 给logger添加handlerself.logger.addHandler(fh)self.logger.addHandler(ch)self.logger.fatal("add handler")self.logger.fatal("set logger")def getlog(self):self.logger.fatal("get logger")return self.logger

此时调用a.py v2
结果如下：

[CRITICAL]2021-01-20 11:55:08,427 log.py:44: add handler
[CRITICAL]2021-01-20 11:55:08,427 log.py:46: set logger
[CRITICAL]2021-01-20 11:55:08,427 log.py:49: get logger
[DEBUG]2021-01-20 11:55:08,427 a.py:7: this is a
[CRITICAL]2021-01-20 11:55:08,428 log.py:46: set logger
[CRITICAL]2021-01-20 11:55:08,428 log.py:49: get logger
[DEBUG]2021-01-20 11:55:08,429 a.py:10: this is a 2

至此，问题解决

参考：
python的logging模块浅析

这篇关于Python | 解决方案 | 多个文件共用logger，重复打印问题的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1040000。

相关文章

Oracle修改端口号之后无法启动的解决方案

Oracle修改端口号之后无法启动的解决方案

《Oracle修改端口号之后无法启动的解决方案》Oracle数据库更改端口后出现监听器无法启动的问题确实较为常见,但并非必然发生,这一问题通常源于​​配置错误或环境冲突​​,而非端口修改本身,以下是系... 目录一、问题根源分析​​​二、保姆级解决方案​​​​步骤1：修正监听器配置文件 (listener.
阅读更多...
MySQL版本问题导致项目无法启动问题的解决方案

MySQL版本问题导致项目无法启动问题的解决方案

《MySQL版本问题导致项目无法启动问题的解决方案》本文记录了一次因MySQL版本不一致导致项目启动失败的经历,详细解析了连接错误的原因,并提供了两种解决方案：调整连接字符串禁用SSL或统一MySQL... 目录本地项目启动报错报错原因：解决方案第一个：第二种：容器启动mysql的坑两种修改时区的方法：本地
阅读更多...
springboot加载不到nacos配置中心的配置问题处理

springboot加载不到nacos配置中心的配置问题处理

《springboot加载不到nacos配置中心的配置问题处理》：本文主要介绍springboot加载不到nacos配置中心的配置问题处理,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑... 目录springboot加载不到nacos配置中心的配置两种可能Spring Boot 版本Nacos
阅读更多...
安装centos8设置基础软件仓库时出错的解决方案

安装centos8设置基础软件仓库时出错的解决方案

《安装centos8设置基础软件仓库时出错的解决方案》：本文主要介绍安装centos8设置基础软件仓库时出错的解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录安装Centos8设置基础软件仓库时出错版本 8版本 8.2.200android4版本 javas
阅读更多...
Python远程控制MySQL的完整指南

Python远程控制MySQL的完整指南

《Python远程控制MySQL的完整指南》MySQL是最流行的关系型数据库之一,Python通过多种方式可以与MySQL进行交互,下面小编就为大家详细介绍一下Python操作MySQL的常用方法和最... 目录1. 准备工作2. 连接mysql数据库使用mysql-connector使用PyMySQL3.
阅读更多...
使用Python实现base64字符串与图片互转的详细步骤

使用Python实现base64字符串与图片互转的详细步骤

《使用Python实现base64字符串与图片互转的详细步骤》要将一个Base64编码的字符串转换为图片文件并保存下来,可以使用Python的base64模块来实现,这一过程包括解码Base64字符串... 目录1. 图片编码为 Base64 字符串2. Base64 字符串解码为图片文件3. 示例使用注意
阅读更多...
使用Python实现获取屏幕像素颜色值

使用Python实现获取屏幕像素颜色值

《使用Python实现获取屏幕像素颜色值》这篇文章主要为大家详细介绍了如何使用Python实现获取屏幕像素颜色值,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 一、一个小工具，按住F10键，颜色值会跟着显示。完整代码import tkinter as tkimport pyau
阅读更多...
python编写朋克风格的天气查询程序

python编写朋克风格的天气查询程序

《python编写朋克风格的天气查询程序》这篇文章主要为大家详细介绍了一个基于Python的桌面应用程序,使用了tkinter库来创建图形用户界面并通过requests库调用Open-MeteoAPI... 目录工具介绍工具使用说明python脚本内容如何运行脚本工具介绍这个天气查询工具是一个基于 Pyt
阅读更多...
Java中JSON格式反序列化为Map且保证存取顺序一致的问题

Java中JSON格式反序列化为Map且保证存取顺序一致的问题

《Java中JSON格式反序列化为Map且保证存取顺序一致的问题》：本文主要介绍Java中JSON格式反序列化为Map且保证存取顺序一致的问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未... 目录背景问题解决方法总结背景做项目涉及两个微服务之间传数据时，需要提供方将Map类型的数据序列化为co
阅读更多...
Python FastMCP构建MCP服务端与客户端的详细步骤

Python FastMCP构建MCP服务端与客户端的详细步骤

《PythonFastMCP构建MCP服务端与客户端的详细步骤》MCP（Multi-ClientProtocol）是一种用于构建可扩展服务的通信协议框架,本文将使用FastMCP搭建一个支持St... 目录简介环境准备服务端实现（server.py）客户端实现（client.py）运行效果扩展方向常见问题结
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2