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。

相关文章

Python将博客内容html导出为Markdown格式

Python将博客内容html导出为Markdown格式

《Python将博客内容html导出为Markdown格式》Python将博客内容html导出为Markdown格式,通过博客url地址抓取文章,分析并提取出文章标题和内容,将内容构建成html,再转... 目录一、为什么要搞？二、准备如何搞？三、说搞咱就搞！抓取文章提取内容构建html转存markdown
阅读更多...
Python获取中国节假日数据记录入JSON文件

Python获取中国节假日数据记录入JSON文件

《Python获取中国节假日数据记录入JSON文件》项目系统内置的日历应用为了提升用户体验,特别设置了在调休日期显示“休”的UI图标功能,那么问题是这些调休数据从哪里来呢？我尝试一种更为智能的方法：P... 目录节假日数据获取存入jsON文件节假日数据读取封装完整代码项目系统内置的日历应用为了提升用户体验，
阅读更多...
Java编译生成多个.class文件的原理和作用

Java编译生成多个.class文件的原理和作用

《Java编译生成多个.class文件的原理和作用》作为一名经验丰富的开发者,在Java项目中执行编译后,可能会发现一个.java源文件有时会产生多个.class文件,从技术实现层面详细剖析这一现象... 目录一、内部类机制与.class文件生成成员内部类（常规内部类）局部内部类（方法内部类）匿名内部类二、
阅读更多...
Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整
阅读更多...
Python Websockets库的使用指南

Python Websockets库的使用指南

《PythonWebsockets库的使用指南》pythonwebsockets库是一个用于创建WebSocket服务器和客户端的Python库,它提供了一种简单的方式来实现实时通信,支持异步和同步... 目录一、WebSocket 简介二、python 的 websockets 库安装三、完整代码示例1.
阅读更多...
揭秘Python Socket网络编程的7种硬核用法

揭秘Python Socket网络编程的7种硬核用法

《揭秘PythonSocket网络编程的7种硬核用法》Socket不仅能做聊天室,还能干一大堆硬核操作,这篇文章就带大家看看Python网络编程的7种超实用玩法,感兴趣的小伙伴可以跟随小编一起... 目录1.端口扫描器：探测开放端口2.简易 HTTP 服务器：10 秒搭个网页3.局域网游戏：多人联机对战4.
阅读更多...
springboot循环依赖问题案例代码及解决办法

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖（即BeanA依赖BeanB,而BeanB又依赖BeanA）,会导致Spring的... 目录1. 什么是循环依赖？2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1：使用 @La
阅读更多...
使用Python实现快速搭建本地HTTP服务器

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》：本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.
阅读更多...
Python使用自带的base64库进行base64编码和解码

Python使用自带的base64库进行base64编码和解码

《Python使用自带的base64库进行base64编码和解码》在Python中,处理数据的编码和解码是数据传输和存储中非常普遍的需求,其中,Base64是一种常用的编码方案,本文我将详细介绍如何使... 目录引言使用python的base64库进行编码和解码编码函数解码函数Base64编码的应用场景注意
阅读更多...
Python基于wxPython和FFmpeg开发一个视频标签工具

Python基于wxPython和FFmpeg开发一个视频标签工具

《Python基于wxPython和FFmpeg开发一个视频标签工具》在当今数字媒体时代,视频内容的管理和标记变得越来越重要,无论是研究人员需要对实验视频进行时间点标记,还是个人用户希望对家庭视频进行... 目录引言1. 应用概述2. 技术栈分析2.1 核心库和模块2.2 wxpython作为GUI选择的优
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2