当前位置：首页 > 科技 > 软件

为什么不推荐使用Python原生日志库？

来源：责编：时间：2023-11-06 17:19:10 371观看

导读包括我在内的大多数人，当编写小型脚本时，习惯使用print来debug，肥肠方便，这没问题，但随着代码不断完善，日志功能一定是不可或缺的，极大程度方便问题溯源以及甩锅，也是每个工程师必备技能。Python自带的logging我个人不推介使

包括我在内的大多数人，当编写小型脚本时，习惯使用print来debug，肥肠方便，这没问题，但随着代码不断完善，日志功能一定是不可或缺的，极大程度方便问题溯源以及甩锅，也是每个工程师必备技能。

Python自带的logging我个人不推介使用，不太Pythonic，而开源的Loguru库成为众多工程师及项目中首选，本期将同时对logging及Loguru进行使用对比，希望有所帮助。

快速示例

在logging中，默认的日志功能输出的信息较为有限：

import logginglogger = logging.getLogger(__name__)def main():    logger.debug("This is a debug message")    logger.info("This is an info message")    logger.warning("This is a warning message")    logger.error("This is an error message")if __name__ == "__main__":    main()

输出(logging默认日志等级为warning，故此处未输出info与debug等级的信息)：

WARNING:root:This is a warning messageERROR:root:This is an error message

再来看看loguru，默认生成的信息就较为丰富了：

from loguru import loggerdef main():    logger.debug("This is a debug message")    logger.info("This is an info message")    logger.warning("This is a warning message")    logger.error("This is an error message")if __name__ == "__main__":    main()

提供了执行时间、等级、在哪个函数调用、具体哪一行等信息。

格式化日志

格式化日志允许我们向日志添加有用的信息，例如时间戳、日志级别、模块名称、函数名称和行号。

在logging中使用%达到格式化目的：

import logging# Create a logger and set the logging levellogging.basicConfig(    level=logging.INFO,    format="%(asctime)s | %(levelname)s | %(module)s:%(funcName)s:%(lineno)d - %(message)s",    datefmt="%Y-%m-%d %H:%M:%S",)logger = logging.getLogger(__name__)def main():    logger.debug("This is a debug message")    logger.info("This is an info message")    logger.warning("This is a warning message")    logger.error("This is an error message")

输出：

2023-10-18 15:47:30 | INFO | tmp:<module>:186 - This is an info message2023-10-18 15:47:30 | WARNING | tmp:<module>:187 - This is a warning message2023-10-18 15:47:30 | ERROR | tmp:<module>:188 - This is an error message

而loguru使用和f-string相同的{}格式，更方便：

from loguru import loggerlogger.add(    sys.stdout,    level="INFO",    format="{time:YYYY-MM-DD HH:mm:ss} | {level} | {module}:{function}:{line} - {message}",)

日志保存

在logging中，实现日志保存与日志打印需要两个额外的类，FileHandler 和 StreamHandler：

import logginglogging.basicConfig(    level=logging.DEBUG,    format="%(asctime)s | %(levelname)s | %(module)s:%(funcName)s:%(lineno)d - %(message)s",    datefmt="%Y-%m-%d %H:%M:%S",    handlers=[        logging.FileHandler(filename="/your/save/path/info.log", level=logging.INFO),        logging.StreamHandler(level=logging.DEBUG),    ],)logger = logging.getLogger(__name__)def main():    logging.debug("This is a debug message")    logging.info("This is an info message")    logging.warning("This is a warning message")    logging.error("This is an error message")if __name__ == "__main__":    main()

但是在loguru中，只需要使用add方法即可达到目的：

from loguru import loggerlogger.add(    'info.log',    format="{time:YYYY-MM-DD HH:mm:ss} | {level} | {module}:{function}:{line} - {message}",    level="INFO",)def main():    logger.debug("This is a debug message")    logger.info("This is an info message")    logger.warning("This is a warning message")    logger.error("This is an error message")if __name__ == "__main__":    main()

日志轮换

日志轮换指通过定期创建新的日志文件并归档或删除旧的日志来防止日志变得过大。

在logging中，需要一个名为 TimedRotatingFileHandler 的附加类，以下代码示例代表每周切换到一个新的日志文件 ( when=“WO”, interval=1 )，并保留最多 4 周的日志文件 ( backupCount=4 )：

import loggingfrom logging.handlers import TimedRotatingFileHandlerlogger = logging.getLogger(__name__)logger.setLevel(logging.DEBUG)# Create a formatter with the desired log formatformatter = logging.Formatter(    "%(asctime)s | %(levelname)-8s | %(module)s:%(funcName)s:%(lineno)d - %(message)s",    datefmt="%Y-%m-%d %H:%M:%S",)file_handler = TimedRotatingFileHandler(    filename="debug2.log", when="WO", interval=1, backupCount=4)file_handler.setLevel(logging.INFO)file_handler.setFormatter(formatter)logger.addHandler(file_handler)def main():    logger.debug("This is a debug message")    logger.info("This is an info message")    logger.warning("This is a warning message")    logger.error("This is an error message")if __name__ == "__main__":    main()

在loguru中，可以通过将 rotation 和 retention 参数添加到 add 方法来达到目的，如下示例，同样肥肠方便：

from loguru import loggerlogger.add("debug.log", level="INFO", rotation="1 week", retention="4 weeks")def main():    logger.debug("This is a debug message")    logger.info("This is an info message")    logger.warning("This is a warning message")    logger.error("This is an error message")if __name__ == "__main__":    main()

日志筛选

日志筛选指根据特定条件有选择的控制应输出与保存哪些日志信息。

在logging中，实现该功能需要创建自定义日志过滤器类：

import logginglogging.basicConfig(    filename="test.log",    format="%(asctime)s | %(levelname)-8s | %(module)s:%(funcName)s:%(lineno)d - %(message)s",    level=logging.INFO,)class CustomFilter(logging.Filter):    def filter(self, record):        return "Cai Xukong" in record.msg# Create a custom logging filtercustom_filter = CustomFilter()# Get the root logger and add the custom filter to itlogger = logging.getLogger()logger.addFilter(custom_filter)def main():    logger.info("Hello Cai Xukong")    logger.info("Bye Cai Xukong")if __name__ == "__main__":    main()

在loguru中，可以简单地使用lambda函数来过滤日志：

from loguru import loggerlogger.add("test.log", filter=lambda x: "Cai Xukong" in x["message"], level="INFO")def main():    logger.info("Hello Cai Xukong")    logger.info("Bye Cai Xukong")if __name__ == "__main__":    main()

捕获异常

在logging中捕获异常较为不便且难以调试，如：

import logginglogging.basicConfig(    level=logging.DEBUG,    format="%(asctime)s | %(levelname)s | %(module)s:%(funcName)s:%(lineno)d - %(message)s",    datefmt="%Y-%m-%d %H:%M:%S",)def division(a, b):    return a / bdef nested(c):    try:        division(1, c)    except ZeroDivisionError:        logging.exception("ZeroDivisionError")if __name__ == "__main__":    nested(0)

Traceback (most recent call last):  File "logging_example.py", line 16, in nested    division(1, c)  File "logging_example.py", line 11, in division    return a / bZeroDivisionError: division by zero

上面输出的信息未提供触发异常的c值信息，而在loguru中，通过显示包含变量值的完整堆栈跟踪来方便用户识别：

Traceback (most recent call last):  File "logging_example.py", line 16, in nested    division(1, c)  File "logging_example.py", line 11, in division    return a / bZeroDivisionError: division by zero

值得一提的是，loguru中的catch装饰器允许用户捕获函数内任何错误，且还会标识发生错误的线程：

from loguru import loggerdef division(a, b):    return a / b@logger.catchdef nested(c):    division(1, c)if __name__ == "__main__":    nested(0)

OK，作为普通玩家以上功能足以满足日常日志需求，通过对比logging与loguru应该让大家有了直观感受，哦对了，loguru如何安装？

pip install loguru

以上就是本期的全部内容，期待点赞在看，我是啥都生，下次再见。

本文链接：http://www.28at.com/showinfo-26-17257-0.html为什么不推荐使用Python原生日志库？

声明：本网页内容旨在传播知识，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。邮件：2376512515@qq.com

上一篇：如何将Docker的构建时间减少40%

下一篇： Gorm 中的迁移指南

标签：

热门焦点

红魔电竞平板评测：大屏幕硬实力

前言：三年的疫情因为要上网课的原因激活了平板市场，如今网课的时代已经过去，大家的生活都恢复到了正轨，这也就意味着，真正考验平板电脑生存的环境来了。也就是面对着这种残酷的
石头智能洗地机A10 Plus体验：双向自清洁治好了我的懒癌

一、前言和介绍专为家庭请假懒人而生的石头科技在近日又带来了自己的全新旗舰新品，石头智能洗地机A10 Plus。从这个产品名上就不难看出，这次石头推出的并不是常见的扫地机器
得物效率前端微应用推进过程与思考

一、背景效率工程随着业务的发展，组织规模的扩大，越来越多的企业开始意识到协作效率对于企业团队的重要性，甚至是决定其在某个行业竞争中突围的关键，是企业长久生存的根本。得物
自律，给不了Keep自由！

来源 | 互联网品牌官作者 | 李大为编排 | 又耳审核 | 谷晓辉自律能不能给用户自由暂时不好说，但大概率不能给Keep自由。近日，全球最大的在线健身平台Keep正式登陆港交所，努力
猿辅导与新东方的两种“归途”

作者｜卓心月出品｜零态LT（ID：LingTai_LT）如何成为一家伟大企业？答案一定是对“势”的把握，这其中最关键的当属对企业战略的制定，且能够站在未来看现在，即使这其中的
品牌洞察丨服务本地，美团直播成效几何？

来源：17PR7月11日，美团App首页推荐位出现“美团直播”的固定入口。在直播聚合页面，外卖“神枪手”直播间、美团旅行直播间、美团买菜直播间等均已上线，同时
大厂卷向扁平化

来源：新熵作者丨南枝编辑丨月见大厂职级不香了。俗话说，兵无常势，水无常形，互联网企业调整职级体系并不稀奇。7月13日，淘宝天猫集团启动了近年来最大的人力制度改革，目前已形成一
自研Exynos回归！三星Galaxy S24系列将提供Exynos和骁龙双版本

年初，全新的三星Galaxy S23系列发布，包含Galaxy S23、Galaxy S23+和Galaxy S23 Ultra三个版本，全系搭载超频版骁龙8 Gen 2，虽同样采用台积电4nm工艺制
onebot M24巧系列一体机采用轻薄机身设计，现已在各平台开售

onebot M24 巧系列一体机目前已在线上线下各平台同步开售。onebot M24 巧系列采用一体化轻薄机身设计，最薄处为 10.15mm，拥有宝石红、午夜蓝、石墨绿、雅致

为什么不推荐使用Python原生日志库？

快速示例

格式化日志

日志保存

日志轮换

日志筛选

捕获异常

红魔电竞平板评测：大屏幕硬实力

石头智能洗地机A10 Plus体验：双向自清洁治好了我的懒癌

得物效率前端微应用推进过程与思考

自律，给不了Keep自由！

猿辅导与新东方的两种“归途”

品牌洞察丨服务本地，美团直播成效几何？

大厂卷向扁平化

自研Exynos回归！三星Galaxy S24系列将提供Exynos和骁龙双版本

onebot M24巧系列一体机采用轻薄机身设计，现已在各平台开售

最新推荐

猜你喜欢

热门推荐

相关资讯