编写干净、高效且可维护的代码 - Python 作为用例
一分耕耘,一分收获!既然都打开这篇《编写干净、高效且可维护的代码 - Python 作为用例》,就坚持看下去,学下去吧!本文主要会给大家讲到等等知识点,如果大家对本文有好的建议或者看到有不足之处,非常欢迎大家积极提出!在后续文章我会继续更新文章相关的内容,希望对大家都有所帮助!

编写干净、高效且可维护的代码 - python 作为用例。
如果您已经成为开发人员一段时间,您可能会理解正确编码的重要性,而不是急于编写有效的东西。这对您来说最大的挫折之一是,当您需要检查代码时,您很少能理解您想要做什么,而对于其他人来说,他们很难阅读您的代码。
我最近一直在审查一些代码,我认为强调干净、高效的代码的必要性很重要。
编码指南和风格的一些历史
在 1970 年代初,当 c 编程语言越来越流行时,编码风格成为了一个讨论的问题,围绕这个问题的两个著名名字是 brian kernighan 和 dennis ritchie。
有趣的是,ada 语言在 20 世纪 80 年代后期实施了严格的编码指南和标准。 1990 年中期,python 和 java 从初始阶段就带有强大的编码约定,python 增强提案 (pep 8) 被广泛采用,至今仍然是有效的编码约定。
- pep 8 代码样式指南: 我时常使用这个指南,并且我看到其他程序员也采用这个指南。
vs code 的 flake8 代码 linting 扩展是我使用的一个不错的选择。
指导方针是:
缩进:每个缩进级别使用 4 个空格。
行长度:将所有行限制为最多 79 个字符。
命名约定:函数和变量名使用蛇形命名法,类名使用驼峰命名法。
例如:
`# defining variables using snake_case
total_price = 100
customer_email = "customer@example.com"
# defining functions using snake_case
def calculate_total_price():
pass
class ordermanager:
pass`
2。有意义的注释和文档: docstrings 帮助开发人员理解函数/方法的目的、参数和返回值。一般来说,介绍它们并撰写评论来澄清复杂的逻辑或决定是一种很好的做法
例如:
def calculate_total_price(price: float, quantity: int) -> float:
"""
calculate the total price of items.
args:
price (float): the price of a single item.
quantity (int): the number of items purchased.
returns:
float: the total price.
"""
return price * quantity
**3。代码重复:**作为一个简单的经验法则,避免重复已经实现的代码,而是通过创建可重用的函数来遵循 dry 原则。需要注意的是,当新开发人员实现更改时,开发人员可能不知道有重复的代码被遗漏,并且由于此错误可能会造成很多混乱。
例如,您有一个函数,通过将价格与数量相乘来计算电子商务商店的总价。
total_price_laptops = 1000 * 2
total_price_phones = 500 * 3
this, is easily done with reusable functions like this:
def calculate_total(price, quantity):
return price * quantity
total_price_laptops = calculate_total(1000, 2)
total_price_phones = calculate_total(500, 3)
4。类型提示: python 是动态类型语言,类型提示可以提高代码的可读性并尽早捕获错误。更容易理解期望的数据类型。
例如:
def get_discounted_price(price: float, discount: float) -> float:
return price - (price * discount)
**5。编写测试: **测试验证代码的功能。像unittest或pytest这样的流行框架使编写和运行测试变得简单。测试断言您的代码行为符合预期,从而降低了在进行更改或重构时引入错误的风险。
def test_calculate_total_price():
assert calculate_total_price(100, 2) == 200
6。例外: 当生产代码向客户端用户打印出无意义的代码行,甚至更糟糕的是,输出环境变量时,可能会很尴尬。通过异常 try/ except/finally 处理来管理可预测的错误并确保您的应用程序不会意外崩溃,可以更轻松地避免这种情况。
try:
value = int(input("Enter a number: "))
except ValueError:
print("That's not a valid number!")
finally:
print('Thank you!')
7。代码模块化: 没有任何规则规定要将代码保存在一个文件中。将大块代码分解为更小的、可重用的模块,并将它们导入到需要的应用程序中。更容易测试和更新。
8。版本控制: 像 git 这样的版本控制系统是现代开发中的基本最佳实践。其他还有 beanstalk、perforce、apache subversion。版本控制可以跟踪变更,很大程度上减少协作过程中的人为错误和意外后果。
通过遵循最佳实践,例如遵守 pep 8、保持代码干燥、编写有意义的文档以及优雅地处理异常,您可以确保您的 python 项目专业、可扩展且易于维护。
从今天开始实施这些技巧,您将看到代码质量的显着提高。
本篇关于《编写干净、高效且可维护的代码 - Python 作为用例》的介绍就到此结束啦,但是学无止境,想要了解学习更多关于文章的相关知识,请关注golang学习网公众号!
使用 Java 函数式接口的常见错误和陷阱有哪些?
- 上一篇
- 使用 Java 函数式接口的常见错误和陷阱有哪些?
- 下一篇
- Golang:如何使用反射操作自定义类型?
-
- 文章 · python教程 | 2天前 | 线程池 · Python 线程池 concurrent.futures 任务取消 Future.cancel
- Python concurrent.futures.Future.cancel 怎样判断任务能否取消
- 143浏览 收藏
-
- 文章 · python教程 | 2天前 | 标准库 · HTTP服务 · 多线程 · Python教程 · Python 并发请求 http.server ThreadingHTTPServer ThreadingMixIn BaseHTTPRequestHandler
- Python http.server ThreadingHTTPServer 怎样处理并发请求
- 481浏览 收藏
-
- 文章 · python教程 | 2天前 |
- Python tarfile.TarInfo.replace 怎样复制归档成员属性
- 308浏览 收藏
-
- 文章 · python教程 | 2天前 | 并发编程 · Python教程 · Python 多进程 multiprocessing forkserver 启动上下文
- Python multiprocessing forkserver 怎样处理进程启动上下文
- 232浏览 收藏
-
- 文章 · python教程 | 2天前 | 标准库 · 异步编程 · Python教程 · Python asyncio StreamReader readexactly IncompleteReadError 异步流
- Python asyncio.StreamReader.readexactly 怎样处理不足长度的输入
- 427浏览 收藏
-
- 文章 · python教程 | 2天前 |
- Python operator.length_hint 怎样为未知长度迭代器设置估计值
- 336浏览 收藏
-
- 文章 · python教程 | 2天前 | 标准库 · Python教程 · Python warnings catch_warnings simplefilter filterwarnings 警告过滤
- Python warnings context manager 怎样临时调整警告过滤
- 255浏览 收藏
-
- 文章 · python教程 | 2天前 | 调试 · python · 异步编程 · Python asyncio introspection current_task all_tasks
- Python asyncio introspection 怎样定位当前任务
- 120浏览 收藏
-
- 文章 · python教程 | 2天前 | 标准库 · Python教程 · Python 类型注解 Python 3.14 annotationlib get_annotations ForwardRef 延迟注解
- Python 3.14 annotationlib.get_annotations 怎样读取延迟注解
- 423浏览 收藏
-
- 文章 · python教程 | 2天前 |
- Python 3.14 跨解释器 Queue.put 的阻塞与 QueueFull 处理方案
- 157浏览 收藏
-
- 文章 · python教程 | 3天前 | xml · python · Python xml xml.etree.ElementTree canonicalize C14N
- Python xml.etree.ElementTree.canonicalize 怎样生成稳定的 XML 文本
- 151浏览 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 485次学习
-
- PubMedQA
- 深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
- 1180次使用
-
- H2O EvalGPT
- H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
- 1165次使用
-
- LMArena
- LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
- 1347次使用
-
- HELM
- 深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
- 1288次使用
-
- MMBench
- MMBench是由上海人工智能实验室等机构联合推出的多模态基准测试平台,提供细粒度能力评估、大规模数据集及VLMEvalKit工具。本文详细介绍其核心功能、安装使用方法及应用场景,助力开发者全面评估多模态模型性能。
- 1147次使用
-
- Python TaskGroup 怎样让子任务失败统一收敛
- 2026-11-12 501浏览
-
- Python xml.dom.minidom.unlink 怎样释放不再使用的 DOM 树引用
- 2026-10-27 501浏览
-
- Python typing 怎样用 TypeIs 缩小类型
- 2026-10-24 501浏览
-
- Python sqlite3 Connection serialize 怎么导出数据库快照:备份窗口、内存占用与恢复校验
- 2026-08-26 501浏览
-
- Python监控网页状态:requests异常处理实战
- 2026-05-29 501浏览

