0

0

Python 可维护代码的表达原则

冰川箭仙

冰川箭仙

发布时间:2026-02-14 16:31:02

|

157人浏览过

|

来源于php中文网

原创

代码可维护性取决于命名准确性、参数精简(≤5个,多则封装)、控制流扁平(嵌套≤3层,用卫语句/生成器)、边界测试全覆盖(空值/零值/极值)及意图明确的布尔变量。

python 可维护代码的表达原则

函数别超过 5 个参数

参数一多,调用时容易传错顺序、漏传、搞混含义,而且加新参数会破坏所有调用点。不是不能超,而是超过就得立刻考虑拆分或封装。

  • dataclassTypedDict 封装相关参数,比如把 user_id, name, email, is_active, created_at 收进一个 UserInput 类里
  • 位置参数(*args)和关键字参数(**kwargs)看着灵活,但会隐藏接口契约,别人看调用点根本不知道该传啥
  • IDE 和类型检查器(如 mypy)对长参数列表的提示效果明显下降,def send_email(to, subject, body, cc, bcc, reply_to, timeout, retries) 这种函数,光靠签名几乎无法安全使用

避免嵌套超过 3 层的 if/for/try

嵌套深了,逻辑就藏在缩进里,读代码像下楼梯——每层都得记住上一层的条件,稍不注意就漏掉 else 分支或提前 return 的边界。

  • 用卫语句(guard clause)提前退出:把 if not valid: return 放最前面,而不是包在大 if
  • for 嵌套超过两层?大概率该抽成生成器函数,比如 for user in users:for order in get_orders_by_user(user):
  • try/except 嵌套常见于“先试 A,失败再试 B”,这时更适合用 except 后跟多个异常类型,或把重试逻辑放进单独函数,而不是层层套 try

变量名必须能回答“它现在代表什么”

不是“有没有类型注解”,而是人扫一眼就得知道这个变量在当前上下文里承担什么角色。类型注解是辅助,不是替代。

ECShop GBK
ECShop GBK

ECSHOP是一款开源免费的网上商店系统。由专业的开发团队升级维护,为您提供及时高效的技术支持,您还可以根据自己的商务特征对ECSHOP进行定制,增加自己商城的特色功能。 ECShop网店系统 V2.7.3 Release 1106正式版发布版本提高了用户体验,优化代码,提升安全性,对原有产品各功能线进行梳理合理优化。此版本后台新增云服务,方便用户查看版本和最新补丁信息,同时提供应用服务。新增 银

下载
  • 别用 datainfotemp 这类万金油名字;user_profile_jsondata 好,normalized_user_profileuser_profile_json 更准——它说明了状态和意图
  • 布尔变量必须是可读的谓词:is_expiredhas_unsaved_changes,而不是 flag1valid(valid 是谁 valid?对谁 valid?)
  • 循环变量别图省事写 ixfor config_file in config_files:for f in files: 更不容易误用,尤其当循环体里还有子循环时

测试用例必须覆盖边界值和空输入

可维护性差的代码,往往不是功能写错了,而是没处理好“没有东西”的情况——空列表、None、空字符串、零值、空字典。这些不是边缘 case,是日常输入。

立即学习Python免费学习笔记(深入)”;

  • 每个函数只要接受可为空的参数(比如 Optional[str]),测试里就得有 None 输入的用例,且明确断言行为(抛异常?返回默认值?静默跳过?)
  • 处理列表的函数,至少测三种长度:0、1、≥2;别只用 [1, 2, 3] 模拟“正常情况”
  • pytest.mark.parametrize 把边界值列清楚,比写一堆独立 test_ 函数更易维护,也更容易发现漏掉的分支

最难的不是写出能跑的代码,是让三个月后的自己或新同事,不用翻三页上下文就能看懂某行 user_map[uid].status = 'archived' 为什么在这里改、会不会影响其他地方。可维护性藏在命名选择、参数粒度、控制流扁平度这些每天敲键盘时的微小决定里。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

810

2023.08.22

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

531

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

214

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1552

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

640

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

885

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

836

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

185

2025.07.29

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

23

2026.02.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
最新Python教程 从入门到精通
最新Python教程 从入门到精通

共4课时 | 22.4万人学习

Django 教程
Django 教程

共28课时 | 4.3万人学习

SciPy 教程
SciPy 教程

共10课时 | 1.5万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号