👉 项目官网:https://www.python-office.com/ 👈

👉 本开源项目的交流群 👈

github star gitee star atomgit star PyPI Downloads AI编程 AI交流群

大家好,这里是程序员晚枫,正在all in AI编程实战,全网同名。

最近,我在优化自己的开源项目:poocr,这个项目底层调用的是腾讯的文字识别功能,帮助小白用户轻松实现1行代码,批量识别。

在调用腾讯云 SDK 的源码时,发现了一个可以优化的地方。这个优化虽然看似微小,但却能提升代码的可读性和性能。我决定动手修改,并提交了一个 PR,希望为腾讯云的开源项目贡献一份力量。

上次提交并且被合并的PR:一不小心,给腾讯云提了一个Bug

发现问题

在阅读腾讯云 SDK 的源码时,我注意到一段代码中使用了 % 格式化来构造报错信息。代码如下:

1
2
# GitHub:tencentcloud-sdk-python/tencentcloud/common/exception/tencent_cloud_sdk_exception.py - Line 14
s = "[TencentCloudSDKException] code:%s message:%s requestId:%s" % (self.code, self.message, self.requestId)

这段代码的功能是生成一个包含错误代码、错误消息和请求 ID 的字符串。虽然代码本身没有问题,但我意识到,使用 % 格式化的方式在现代 Python 中已经显得有些过时。Python 3.6 引入了 f-string(格式化字符串字面量),它不仅更简洁,而且在性能上也更优。

提出优化

我决定将这段代码改为使用 f-string 的方式,以提高代码的可读性和性能。

请在此添加图片描述

修改后的代码如下:

1
2
# GitHub:tencentcloud-sdk-python/tencentcloud/common/exception/tencent_cloud_sdk_exception.py - Line 14
s = f"[TencentCloudSDKException] code:{self.code} message:{self.message} requestId:{self.requestId}"

f-string 的优势在于:

  1. 简洁性:直接在字符串中嵌入变量,无需额外的格式化操作。
  2. 性能:f-string 的性能优于 % 格式化和 str.format() 方法。
  3. 可读性:代码更直观,易于理解。

提交 PR

完成代码修改后,我仔细检查了改动的正确性,并确保没有引入新的问题。随后,我向腾讯云的开源项目提交了一个 PR(Pull Request),详细描述了我的改动内容和原因。

请在此添加图片描述

在 PR 中,我提到:

  • 修改的背景:发现 % 格式化可以替换为更现代的 f-string。
  • 修改的好处:提升代码的可读性和性能。
  • 修改的范围:仅涉及报错信息的构造部分,未影响其他功能。

提交 PR 后,我感到非常期待腾讯团队的反馈。希望我的小小改动能得到认可,并最终被合并到主分支中。

总结

这次的经历让我深刻体会到开源社区的力量。每个人都可以通过自己的努力为开源项目贡献价值。虽然这次的改动很小,但它代表了我对代码质量的关注和对开源精神的支持。

我获得了1k star的开源项目:https://github.com/CoderWanFeng/python-office

如果你也发现了一些可以改进的地方,不妨动手尝试一下。提交 PR 不仅能帮助项目变得更好,也能让你在过程中学到更多。

希望腾讯的小伙伴们能尽快回复我的 PR,让我们一起让腾讯云的 SDK 更加优秀!

加入开源

如果你喜欢这个开源项目,欢迎加入我们的开源小组,一起交流学习,一起进步。

加我的微信:aiwf365,备注:开源

关于项目的介绍:



另外,大家去给小明的小红书👇账号点点赞吧~!我不想努力了,想吃软饭了。

小红书:爱吃火锅的小明

扫一扫,领红包

美团红包

滴滴红包

程序员晚枫专注AI编程培训,小白看完他和图灵社区合作的教程《30讲 · AI编程训练营》就能上手做AI项目。

🎓 AI 编程实战课程

想系统学习 AI 编程?程序员晚枫的 AI 编程实战课 帮你从零上手!