Python 代码命名规范详解（python的命名规范）
off999 2024-11-01 12:48 15 浏览 0 评论
代码命名规范。不是必须的，但是十分、非常必要的！！！
这边做一下介绍。
1. 拒绝通用词
1、写代码的时候，不管是全局变量还是局部变量，都应该避免使用 ‘list’、‘dict’、‘elements’ 等词作为变量名，它们会使代码变的难以阅读、理解。
2、像 ‘abs’、‘str’、‘eval’ 等内置函数也应该避免使用，防止出现在当前命名空间中被屏蔽的尴尬情况。
3、一些列的前缀和后缀。虽然在编程中非常常见，但事实上应该避免出现在函数和类名称中，比如 ‘object’、‘handle’、‘do’ 等词，这样做的原因是它们的含义模糊，摸棱两可，并且没有向实际名称中添加任何信息。
4、许多包的名称都应该被避免，诸如 ‘tools’、‘utils’、‘core’ 的名称很大可能会变成一大堆不相关的、质量非常差的代码片段，虽然它们在名称上并没有本质的错误，但为了防止问题的出现，还是直接将其作为自己自定义包的命名扼杀在萌芽状态为好。
2. 使用专业术语
这个算是 1 部分的延申，拒绝通用词，相反的使用特定领域特定的专业术语，比如下面的代码：
def calculation(datas): for data in datas: yield data ** 2
这部分代码的命名就有些问题，比如函数名 calculation 是计算的意思，计算分很多种，到底计算什么呢？这样很不直观，如果是换成下面这样：
def squares(numbers): for number in numbers yield number ** 2
这种的命名就比第一种清晰明了很多。
3. 用 ‘has’ 或 ‘is’ 前缀命名 bool 元素
对于保存布尔值的变量，对其命名的时候将 ‘has’ 或 ‘is’ 作为其前缀，可以使它们在代码中的可读性更强：
is_succeed = True has_cache = False
4. 避免出现上下文中已存在的名称
不要在代码中继续使用已经存在的名称，这会在阅读代码的时候非常令人疑惑，尤其是在出现 bug 进行单步调试的时候，更是令人抓狂！比如像下面这样：
import os def squares(numbers): for os in numbers: yield os ** 2
上面这个例子中，如果你再使用 os 模块做其它事情，可能会没什么效果。还是那句话，内置函数名和标准库的模块名都应该被避免
5. 集合变量用复数形式命名
如果一个元素是集合变量，那么使用复数形式是一个很好的办法，比如像下面这样：
users = ['Rocky', 'leey']
6. 以 key - value 命名字典名
对于字典来说，它保存的是一个映射关系的数据，那我们命名就尽量以映射的双方来命名，也就是 key 含义 - value 含义，比如：一个字典保存的是学生的成绩，那么可以将它命名为 ‘students_scores’：
students_scores = {
'Rocky': 100,
'leey': 60
}
7. 模块和包的命名
模块和包的命名应该体现其表达的内容，它们的名称应该简短，应该使用小写字母并且不带下划线，同样还要始终避免与标准库模块相同的名称。
8. 代码风格
Python 官方给出了一种编码规范 PEP 8，当然这个只是个标准而已，并没有强制要求大家都要去遵守，但又好像大多数人都使用了 PEP 8 编码风格，使它已经成为了事实上的代码风格标准。
1 回帖
相关推荐
- 推荐一款Python的GUI可视化工具（python 可视化工具）
-
在Python基础语法学习完成后，进一步开发应用界面时，就需要涉及到GUI了，GUI全称是图形用户界面（GraphicalUserInterface，又称图形用户接口），采用图形方式显示的计算机操...
- 教你用Python绘制谷歌浏览器的3种图标
-
前两天在浏览matplotlib官方网站时，笔者无意中看到一个挺有意思的图片，就是用matplotlib制作的火狐浏览器的logo，也就是下面这个东东（网页地址是https://matplotlib....
- 小白学Python笔记:第二章 Python安装
-
Windows操作系统的python安装：Python提供Windows、Linux/UNIX、macOS及其他操作系统的安装包版本，结合自己的使用情况，此处仅记录windows操作系统的python...
- Python程序开发之简单小程序实例(9)利用Canvas绘制图形和文字
-
Python程序开发之简单小程序实例（9）利用Canvas绘制图形和文字一、项目功能利用Tkinter组件中的Canvas绘制图形和文字。二、项目分析要在窗体中绘制图形和文字，需先导入Tkinter组...
- 一文吃透Python虚拟环境（python虚拟环境安装和配置）
-
摘要在Python开发中，虚拟环境是一种重要的工具，用于隔离不同项目的依赖关系和环境配置。本文将基于windows平台介绍四种常用的Python虚拟环境创建工具：venv、virtualenv、pip...
- 小白也可以玩的Python爬虫库，收藏一下
-
最近，微软开源了一个项目叫「playwright-python」，作为一个兴起项目，出现后受到了大家热烈的欢迎，那它到底是什么样的存在呢？今天为你介绍一下这个传说中的小白神器。Playwright是...
- python环境安装+配置教程（python安装后怎么配置环境变量）
-
安装python双击以下软件：弹出一下窗口需选择一些特定的选项默认选项不需要更改，点击next勾选以上选项，点击install进度条安装完毕即可。到以下界面，证明安装成功。接下来安装库文件返回电脑桌面...
- colorama，一个超好用的 Python 库!
-
大家好，今天为大家分享一个超好用的Python库-colorama。Github地址：https://github.com/tartley/coloramaPythoncolorama库是一...
- python制作仪表盘图（python绘制仪表盘）
-
今天教大家用pyecharts画仪表盘仪表盘(Gauge)是一种拟物化的图表，刻度表示度量，指针表示维度，指针角度表示数值。仪表盘图表就像汽车的速度表一样，有一个圆形的表盘及相应的刻度，有一个指针...
- 总结90条写Python程序的建议（python写作）
-
1.首先 建议1、理解Pythonic概念—-详见Python中的《Python之禅》 建议2、编写Pythonic代码 （1）避免不规范代码，比如只用大小写区分变量、使用容易...
- [oeasy]python0137_相加运算_python之禅_import_this_显式转化
-
变量类型相加运算回忆上次内容上次讲了是从键盘输入变量input函数可以有提示字符串需要有具体的变量接收输入的字符串输入单个变量没有问题但是输入两个变量之后一相加就非常离谱添加图片注释，不超过1...
- Python入门学习记录之一:变量（python中变量的规则）
-
写这个，主要是对自己学习python知识的一个总结，也是加深自己的印象。变量（英文：variable），也叫标识符。在python中，变量的命名规则有以下三点：>变量名只能包含字母、数字和下划线...
- 掌握Python的"魔法":特殊方法与属性完全指南
-
在Python的世界里，以双下划线开头和结尾的"魔法成员"（如__init__、__str__）是面向对象编程的核心。它们赋予开发者定制类行为的超能力，让自定义对象像内置类型一样优雅工...
- 11个Python技巧 不Pythonic 实用大于纯粹
-
虽然Python有一套强大的设计哲学（体现在“Python之禅”中），但总有一些情况需要我们“打破规则”来解决特定问题。这触及了Python哲学中一个非常核心的理念：“实用主义胜于纯粹主义”...
- Python 从入门到精通 第三课 诗意的Python之禅
-
导言：Python之禅，英文名是TheZenOfPython。最早由TimPeters在Python邮件列表中发表，它包含了影响Python编程语言设计的20条软件编写原则。它作为复活节彩蛋...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python字典遍历 (54)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (60)
- python读取文件夹下所有文件 (59)
- java调用python脚本 (56)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)