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)
全栈程序员-站长的头像全栈程序员-站长


相关推荐

  • CentOS7安装详解

    CentOS7安装详解本文基于vmwareworkstations进行CentOS7安装过程展示,关于vmwareworkstations安装配置本人这里不再介绍,基本过程相当于windows下安装个软件而已。1、打

    2022年8月3日
    14
  • 怎么自定义服务器的404,如何自定义404页面

    怎么自定义服务器的404,如何自定义404页面404错误页面是WWW网站访问比较经常出现的错误。大家最熟悉的也是最常见的出错提示:404notfound。404页面就是当用户输入了错误的链接时,返回的页面。而默认的404错误页面呆板麻木,让访问者感觉很挫败,可能会直接离开您的网站。自定义404页面的目的是:告诉浏览者其所请求的页面不存在或链接错误,同时引导用户使用网站其他页面而不是关闭窗口离开。是增强用户体验的很好的做法。简而言之,有两点…

    2022年7月27日
    5
  • 精进Quartz源码—Quartz中JobStore保存JonDetail和Trigger源码分析(一)

    我都是分析的jobStore 方式为jdbc的SimpleTrigger!RAM的方式类似分析方式!要使用定时器,并讲任务持久到数据库,我们一定明白JobDetail和Trigger是如何操作进入数据库,如何注册到Scheduler中!前面我分析了Scheduler的start()和QuartzSchedulerThread的run()!这些都是要在下面讲的这个流程的基础上!那么下面就开始分析源码,

    2022年2月25日
    211
  • 利用Pytorch torchvision完成Faster-rcnn目标检测demo及源码详解

    利用Pytorch torchvision完成Faster-rcnn目标检测demo及源码详解Torchvision更新到0.3.0后支持了更多的功能,其中新增模块detection中实现了整个faster-rcnn的功能。本博客主要讲述如何通过torchvision和pytorch使用faster-rcnn,并提供一个demo和对应代码及解析注释。目录如果你不想深入了解原理和训练,只想用Faster-rcnn做目标检测任务的demo,请看这里torchvision中Faste…

    2022年6月24日
    25
  • SAE J1939协议(一)

    SAE J1939协议(一)SAEJ1939是基于CAN总线的协议,波特率可达250Kbps,是一种传输速率较高的C类通信网络协议。SAEJ1939主要用于卡车、客车等的网络系统控制与通信。

    2022年5月13日
    155
  • JavaScript 字符串截取方法汇总

    JavaScript 字符串截取方法汇总可以使用的方法及选择substring:最常见substr:不建议使用slice:最灵活JS新标准ECMAscript没有对substr进行标准化,因此不建议使用。slice比substring更灵活,允许使用负数做参数slice除了截取字符串,还可以截取数组参数和用法substring语法:stringObject.substring(start,stop)start,必需,非负整数,截取的开始位置stop,可选,非负整数,截取的字符串不包含该位置

    2022年6月13日
    36

发表回复

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

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