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


相关推荐

  • sql存储过程实例详解_sql server创建存储过程

    sql存储过程实例详解_sql server创建存储过程问题提出  我使用过几次SQLServer,但所有与数据库的交互都是通过应用程序的编码来实现的。我不知到在哪里使用存储过程,也不了解实现存储过程需要做哪些工作。希望能详细说明。  存储过程是存储于数据库中的一组T-SQL语句。有了存储过程之后,与数据库的交互就没有必要在程序中写一堆的SQL语句,而只需用一条语句调用适当的存储过程来完成就可以了。另外,由于代码是存储在数据库

    2022年9月26日
    0
  • stm32蓝牙模块控制小车_如何让电脑有蓝牙功能

    stm32蓝牙模块控制小车_如何让电脑有蓝牙功能重要声明看过我前面51小车博客的都知道我是软件工程专业的,对于硬件方面都是因为感兴趣自学的,这不,因为今年寒假放假比较早,趁这个时间学习了STM32相关知识,经过近一个月的学习对于STM32算是入门了,为了检验自己的学习效果,我决定就着51小车的架子用STM32试试,经过一个下午的忙活算是成功了!!!所以再来和大家分享一下。所需知识贮备相信看到这篇文章的小伙伴都是有相关基础的,这里只是给和我一样自学的小伙伴提个醒。动手之前你需要这些:硬件电路连接相关能力C语言基础能力STM32定时器、中断、串

    2022年10月9日
    1
  • MySQL数据库:存储过程Procedure

    MySQL数据库:存储过程Procedure

    2021年10月4日
    58
  • 利用Pycharm连接服务器[通俗易懂]

    利用Pycharm连接服务器[通俗易懂]利用Pycharm连接服务器前言当下,很多深度学习的模型需要高配置的设备来跑,本地的pc可能无法满足要求。所以就需要利用服务器来训练,但是在服务器上操作代码不是很方便。利用Pycharm可以在本地编写/修改代码,能够同步到服务器上,并且能直接在本地利用pycharm运行同步到服务器上的代码。非常的方便。-前提一台装有anaconda的服务器,本地装了专业版的pycharm。操作步骤步骤一:在pycharm上使用服务器的python环境用pycharm任意打开一个项目,从工具栏中选择Fil

    2022年8月29日
    1
  • jmeter测试服务器性能测试报告,Jmeter的性能测试

    jmeter测试服务器性能测试报告,Jmeter的性能测试需要分析的系统信息需要分析的业务信息性能需求评估确定性能测试点:关键业务:确定被测项目是否属于关键业务,有哪些主要的业务逻辑点,特别是跟交易相关的功能点。例如转账,扣款等接口。如果项目(或功能点)不属于关键业务(或关键业务点)日请求量:确定被测项目各功能点的日请求量(可以统计不同时间粒度下的请求量如:小时,日,周,月)。如果日请求量很高,系统压力很大,而且又是关键业务,该项目需要做性能测试,而且关…

    2022年6月20日
    33
  • 完全卸载mysql(亲测有效!!!)「建议收藏」

    完全卸载mysql(亲测有效!!!)「建议收藏」1.停止mysql服务。  “运行”——>“cmd”——>输入“netstopmysql;”    看链接:  https://blog.csdn.net/Ludwig_/article/details/526345872.将控制面板中的mysql正常卸载  控制面板——》“程序”,找到并卸载!3.找到安装路径,将所有关于mysql的文…

    2022年9月30日
    0

发表回复

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

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