Python 命名规范与最佳实践
更新时间：2025年03月17日 09:44:39 作者：燃灯工作室
本文介绍了Python命名规范与最佳实践,包括变量名、模块名、类名、函数名和常量名的命名规则,强调了命名的清晰性、一致性、科学性和避免使用特殊符号,感兴趣的朋友一起看看吧
1. 规范
1.变量名区分大小写；
2.严禁使用关键字作为变量名；
3.确定自己的命名风格，不可随意变换；
4.命名应该科学严谨，切勿太长或者表达比较模糊；
5.命名中若使用特殊约定或缩写，则要有注释说明；
6.尽量不要使用中文字符和纯数学字符，避免编码错误；
7.名字由英文字母、数字、下划线组成，如abc，abc13和_abc等；
8.要清晰、明了，有明确含义，同时使用完整的单词或大家基本可以理解的缩写；
9.同一软件产品内，应规划好接口部分(变量、结构、函数及常量)的命名，防止编译、链接时产生冲突。
2. 参考
| 类型 | 公有/外部成员 | 私有/内部成员 |
|---|---|---|
| 模块（module） | my_naming_convention | _my_naming_convention |
| 包（package） | my_naming_convention | |
| 类（class） | MyNamingConvention | _MyNamingConvention |
| 异常（Exception） | MyNamingConvention | |
| 函数（function） | my_naming_convention() | _my_naming_convention() |
| 全局/类常量（constant） | MY_NAMING_CONVENTION | _MY_NAMING_CONVENTION |
| 全局/类变量（variable） | my_naming_convention | _my_naming_convention |
3. 缩写
命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如：
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num
4. 前导后缀下划线
- 一个前导下划线：表示非公有。
- 一个后缀下划线：避免关键字冲突。
- 两个前导下划线：当命名一个类属性引起名称冲突时使用。
- 两个前导和后缀下划线：“魔”（有特殊用图）对象或者属性，例如__init__或者__file__。绝对不要创造这样的名字，而只是使用它们。
注意：关于下划线的使用存在一些争议。
5. 应该避免的名称
- 单字母名称, 除了计数器和迭代器.
- 包/模块名中的连字符(-)
- 双下划线开头并结尾的名称(Python 保留, 例如__init__)
到此这篇关于Python 命名规范与最佳实践的文章就介绍到这了,更多相关Python 命名规范内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
本文主要介绍了jupyter-lab设置自启动及远程连接开发环境，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2023-02-02
这篇文章主要介绍了Python实现判断变量是否是函数方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2024-02-02
这篇文章主要介绍了python数字图像处理之骨架提取与分水岭算法，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧2018-04-04
在Python编程中,subprocess库是一个功能强大的工具,它允许我们创建新进程、连接到其输入/输出/错误管道,并获取其返回代码,下面就来详细的介绍一下,感兴趣的可以了解一下2025-10-10
这篇文章主要介绍了Python PO设计模式的具体使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2019-08-08
这篇文章主要为大家介绍了Python进程和守护进程，具有一定的参考价值，感兴趣的小伙伴们可以参考一下，希望能够给你带来帮助2021-12-12
当我们想要执行一个 py 文件的时候，只需要在命令行中输入 python xxx.py 即可，但你有没有想过这背后的流程是怎样的呢？本文主要贺和大家来聊聊Python中的字节码，感兴趣的可以了解一下2022-12-12
这篇文章主要介绍了python中实现php的var_dump函数功能,var_dump函数在PHP中调试时非常实用,本文介绍在Python中实现这个函数,需要的朋友可以参考下2015-01-01
这篇文章主要为大家详细介绍了python实现批量移动文件，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2021-04-04
这篇文章介绍了Django框架中表单的用法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-06-06
最新评论