python中的变量命名规则

python中的变量命名规则ThereareonlytwohardthingsinComputerScience:cacheinvalidationandnamingthings.在计算机科学领域只有两件难事:缓存失效和给东西起名字变量用的好或不好,和代码质量有着非常重要的联系,合理的使用变量,可以让你的代码可读性更高并且更加简洁。python中的变量命名规则1.变量命名2.变量命名的描述性3.变量名尽量短,但是不要太短4.合理使用变量5.变量定义尽量靠近使用6.合理使用namedtuple/

大家好,又见面了,我是你们的朋友全栈君。

There are only two hard things in Computer Science: cache invalidation and naming things.
在计算机科学领域只有两件难事:缓存失效 和 给东西起名字

变量用的好或不好,和代码质量有着非常重要的联系,合理的使用变量,可以让你的代码可读性更高并且更加简洁。

1.变量命名

1)命名的规范性

变量名可以包括字母、数字、下划线,但是数字不能做为开头。

系统关键字不能做变量名使用

除了下划线之个,其它符号不能做为变量名使用 !

Python的变量名是除分大小写的

2)编程语言常用驼峰命名法

大驼峰:每一个单词的首字母都大写 FirstName LastName

小驼峰:第一个单词以小写字母开始,后续单词的首字母大写 firstName lastName

但是在python中一般使用小驼峰加下划线的方式

  • has_error
  • is_person

2. 变量命名的描述性

在接受范围内,变量名所描述的内容越精准越好。

  • BAD: day, host, cards, temp
  • GOOD: day_of_week, hosts_to_reboot, expired_cards

变量名能让人猜出类型。

例如: Bool 类型

  • is_user : 是否是用户

例如: int/float 类型

  • port:端口号
  • age:年龄

这些很直观的能让人猜出类型。

注意: 不要使用复数来表示一个 int 类型变量,比如 apples,最好用 number_of_apples来替代

3.变量名尽量短,但是不要太短

一个好的变量名,长度应该控制在两到三个单词左右

例如,person_index

同一段代码内不要使用过于相似的变量名,比如同时出现 users、users1、 user3。

不要使用带否定含义的变量名,用 is_special 代替 is_not_normal。

4.合理使用变量

同一个变量名指代的变量类型,也需要保持一致性。

在一个函数中,一个变量名叫做 photo, 那么在其他地方就不要改成image。

5. 变量定义尽量靠近使用

刚开始学习编程时,我们习惯把定义的变量放在开头,或一些函数最前面。如下

def get_name():
	students = []
	teachers = []

这样的方式虽然看起来很简洁,但是对代码可读性没有帮助,更好的做法是,让变量定义尽量靠近使用。

6. 合理使用namedtuple/dict

Python中的函数可以返回多个值,如果某一天我们想让函数再多返回一个值怎么办呢?

#之前
def get_name():
	return student, teacher
	
#现在
def get_name():
	return student, teacher, parent

namedtuple/dict 此时可以派上用场

#1. 使用dict
def get_name():
	return { 
   
	'student': student, 
	'teacher':teacher, 
	'parent' :parent
	}
names_dict = get_name()
# 2. 使用 namedtuple
from collections import namedtuple

Names = namedtuple("Names", ['student', 'teacher', 'parent'])

def get_name():
	return Names(
	student = student,
	teacher = teacher,
	parent = parent
	)

names = get_name()

但是这样不能像之前一样,每一次解包多变量接受函数返回值。

6. 控制单个函数内的变量数量

当某一函数过长时,或者包含太多变量时,请及时把它拆分成多个小函数。

7. 删除掉没用的变量

在一个函数中,如果某一个定义的变量没有被用到,请及时删除它。

8. 定义临时变量提高可读性


if student.is_active and (student.sex == 'female'):
    student.add_tolist()
    return

#把上面的例子变成如下
student_is_eligible = student.is_active and (student.sex == 'female')

if student_is_eligible:
    student.add_tolist()
    return

需要合理运用临时定义对象,把不必要的东西赋值成临时变量反而会让代码显得啰嗦!

9. The Zen of Python

最后分享一下 Zen of Python 准则。

The Zen of Python

漂亮总比难看好。
显性比隐性好。
简单比复杂好。
复杂比复杂好。
平的比嵌套的好。
疏比密好。
可读性。
特殊情况并不特别到足以打破规则。
尽管实用性胜过纯洁。
错误不应该悄无声息地过去。
除非显式地沉默。
面对模棱两可,拒绝猜测的诱惑。
应该有一种——最好只有一种——明显的方法来做这件事。
除非你是荷兰人,否则这种方式一开始可能并不明显。
现在做总比不做好。
虽然永远不做总是比现在好。
如果实现很难解释,那就不是一个好主意。
如果实现易于解释,那么它可能是个好主意。
名称空间是一个很棒的主意——让我们做更多这样的事情吧!

reference: python工匠

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/138509.html原文链接:https://javaforall.net

(0)
上一篇 2022年5月31日 上午11:20
下一篇 2022年5月31日 上午11:20


相关推荐

  • VScode 格式化代码快捷键、修改快捷键

    VScode 格式化代码快捷键、修改快捷键1 请看仔细快捷键是 shift alt F 我是从 eclipse 转的 idea 现在再用 vscode 一直条件反射的按的 ctrl shift F 一直不行 还各种查 改配置 原来从一开始就按错了 至于汉化方法可见另一文 VSCode 汉化 设置为中文语言显示 中文界面 2 如果你和我一样用习惯了 ctrl s

    2026年3月19日
    3
  • cannot open image file 1:-1_linux C

    cannot open image file 1:-1_linux C关于使用《FirstOrderMotionModelforImageAnimation》Github项目中所遇到的OSError:Failedtoopenfileb’C:\\Users\\\xe6\x96\x87…\\AppData\\Local\\Temp\\scipy-xxxxx报错原因:路径中包含中文解决方案:修改计算机环境变量中的Temp文件夹路径OSError:Failedtoopenfileb’C:\Users\\xe6\x96\x87…\AppDa

    2025年11月6日
    4
  • ajax 长轮询_js 轮询

    ajax 长轮询_js 轮询1.三者介绍【1】http协议介绍1)介绍:http协议是请求/响应范式的,每个http响应都对应一个http请求,http协议是无状态的,多个http请求之间是没有关系的;2)http协议的被动性:在标准的HTTP请求响应语义中,浏览器发起请求,服务器发送一个响应,这意味着在浏览器发起新请求前,服务器不能发送新信息给客户端浏览器;【2】htt

    2022年10月14日
    4
  • intellij idea激活码【中文破解版】

    (intellij idea激活码)JetBrains旗下有多款编译器工具(如:IntelliJ、WebStorm、PyCharm等)在各编程领域几乎都占据了垄断地位。建立在开源IntelliJ平台之上,过去15年以来,JetBrains一直在不断发展和完善这个平台。这个平台可以针对您的开发工作流进行微调并且能够提供…

    2022年3月28日
    81
  • Java基础入门笔记04——方法调用,方法重载,命令行参数,可变参数,多维数组,Arrays类,冒泡排序,矩阵的压缩存储

    Java基础入门笔记04——方法调用,方法重载,命令行参数,可变参数,多维数组,Arrays类,冒泡排序,矩阵的压缩存储JAVA基础04方法System.out.println()——类.对象.方法out是标准输出对象方法是语句的集合,用于执行一个功能——类似C语言中的函数public class Demo01 { public static void main(String[] args) { //main就是一个方法————由java虚拟机调用 //void 是返回类型 int sum = add(1, 2); System.out.pri

    2022年8月8日
    8
  • Windows 0x80190001错误解决

    Windows 0x80190001错误解决解决 Windows0x 错误本人系统版本为 winwindows 出现这样的错误 初步判断为 windows 的网络连接问题引起的 一般这个错误会导致用户账户无法登陆 windows 商店无法显示内容 个人账户无法同步或验证等相关问题 下面我们来看看具体的修复方法 修复 1 使用 windows 的搜索功能 或直接使用快捷键 win s 输入 cmd 会出现命令行提示符 右键选择管理员身份运行

    2025年8月3日
    6

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号