百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

Python标识符命名最佳实践(python的标识符命名规则)

off999 2024-10-21 07:02 19 浏览 0 评论

大家好,今天我们将继续学习Python的基础知识。这篇文章将重点介绍Python中标识符的相关内容。

什么是标识符

在Python中,标识符是用来区别开每个对象的对象名称。标识符由用户定义,主要用来给变量(Varible)、函数(Function)、类(Class),模块(Module)等命名。

Python标识符的命名规则

每种语言都有自己标识符的命名规则,这些规则基本都大同小异。Python的标识符命名规则主要包括:

  • 标识符合法的字符:26个英文字母(包括大小写a-z,A-Z)、10个阿拉伯数字(0-9)以及下划线(_);
  • 标识符的第一个字符只能是字母或下划线,不能以数字开始;
  • Python标识符的长度没有限制;
  • 用户定义的标识符不能是Python的保留字或关键字,如for,if等;
  • Python是字母大小写敏感的语言,如Abc、abc、ABc是不同的标识符。

下面分别使用一些例子来说明什么是合法有效的Python标识符以及什么样的标识符是不合法的。

合法的标识符举例

name1:这个标识符是由字母和数字构成的,且开头字符是英文字母,所以其是合法有效的标识符;

student_age:这个标识符是由字母和下划线构成的,也是合法有效的标识符;

_income:该标识符以下划线开始,且有效字符满足上面的要求,因此这也是合法的标识符。

在实践中,为了增强Python程序的可读性,我们在给标识符命名时,尽量做到见名知义。否则,随着时间的流逝,在没有注释帮助下,读者很可能就不知道标识符的具体含义了。

不合法的标识符举例

为了更好地理解Python标识符的命名规则,下面给出一些不合法的标识符:

100:这个标识符只有数字构成,违反了开头字符不能是数字的法则;

3year:这个标识符也是违反了不能以数字开头的约定;

a-b:这个标识符中包含不合法的字符(-);

for:这个标识符是Python中的关键字,这是不允许的;

teacher and student:这个标识符包含非法的字符——空格或空白字符。

对于一个新手来说,可能判断一个标识符是否有效,可能存在一定的困难。幸运的是,Python中给出了标识符有效性检验的函数,来判断一个标识符是否是有效的标识符。

判断一个标识符是否是有效

对于新用户来讲,Python提供了 isidentifier() 函数来判断一个标识符是否是有效合法的标识符。

但是,这个函数不会忽略Python中的保留字或关键字。因为,这些关键字或保留字也是Python的标识符,不过其用来构成了Python的语法字,用户不能再使用它作为自己的标识符了。

那问题就来了,如果你准备使用Python中的关键字来作为自己的标识符的话,isidentifier()函数也会认为是有效的。这岂不是给新用户带来了困惑。

遇到问题,我们总要解决问题的。Python还提供了另外一个函数,帮助我们来识别一个标识符是不是Python中的关键字,这个函数就是 keyword.iskeyword(),从名字上就知道它的含义了吧。借助isidentifier()和keyword.iskeyword()这两个函数就可以完全来验证自己定义的标识符是不是有效和合法的了。

下面首先看一下isidentifier()函数的使用方法。

下面代码检测了上面有效和无效的标识符:

print("name1".isidentifier())   #True
print("100".isidentifier())        #False
print("_income".isidentifier()) #True
print("3year".isidentifier())      #False
print("a-b".isidentifier())        #False
print("for".isidentifier())        #True

从上面的代码及注释给出的结果来看,最后一个例子中for输出的为True,但它是Python的关键字,我们不能使用它来命名自己的标识符。

下面使用keword.iskeyword()函数来验证一下“for”是不是Python的关键字。具体操作过程中可以先使用下面的程序先来判断一个标识符是不是Python的关键字,如果不是的话,再进一步使用isidentifier()函数来判断是不是有效的标识符就行了。

import keyword
print(keyword.iskeyword("for"))   # True

上面的例子中,首先导入了Python的keyword模块,然后再使用keyword.iskeyword()函数来判断。上面判断“for”是不是Python的关键字,结果输出为True,则for为关键字,那么,你就不能再使用它作为自己的标识符了。

上面的程序在Python3.8.3中运行的情况如下图所示:

这似乎有些麻烦,那么,自己可以定义一个函数来实现上面的两步操作:

def isValidIdentifier(str):
    return str.isidentifier() and not keyword.iskeyword(str)

print(isValidIdentifier("for")) # False

总结

上面对Python的标识符进行了详细的介绍,下面再给出整篇文章的总结。

Python标识符最佳实践

(1)Python的类名最好以大写字母开始,如Student,Tutor,Employee,等。

(2)如果类名有多个词构成,则每个词的开头字母都要大写,如StudentClass, FileHelper等。

(3)变量的名称、函数的名称、模块的名称,要使用小写字母来命名,如 age, say()等。

(4)如果变量、函数名称、模块名称由多个词构成,则词与词间使用下划线隔开:如:student_name, print_score()等。

(5)如果变量被定义为私有变量,则命名可以使用下划线作为开始字符;

(6)避免命名标识符时,开头字符和结尾字符都是下划线,因为这种标识符是Python的内置类型;

(7)避免标识符的开头和结尾同时有两个下划线,这是因为这种命名方式是Python语言定义的特殊名称;

(8)尽量使标识符的命名有意义,见名知义是最好的方法,如 student_name要比sn好很多;

(9)如果一个函数返回一个逻辑类型的结果,则最好在给函数命名时以"is"开头,如:isfineshed,isateacher等。

(10)虽然在Python中,标识符的长度没有限制,但最好是使其尽可能的短,如 stu_first_name要比the_student_entity_fist_name好很多。

以上比较全面的介绍了Python中标识符的命名规则和具体实践。

如果你喜欢Python、R等相关内容,欢迎关注我。本号将持续更新相关内容。

相关推荐

如何理解python中面向对象的类属性和实例属性?

类属性和实例属性类属性就是给类对象中定义的属性通常用来记录与这个类相关的特征类属性不会用于记录具体对象的特征类属性的理解:类属性是与类自身相关联的变量,而不是与类的实例关联。它们通...

Java程序员,一周Python入门:面向对象(OOP) 对比学习

Java和Python都是**面向对象编程(OOP)**语言,无非是类、对象、继承、封装、多态。下面我们来一一对比两者的OOP特性。1.类和对象Java和Python都支持面向对象...

松勤技术精选:Python面向对象魔术方法

什么是魔术方法相信大家在使用python的过程中经常会看到一些双下划线开头,双下划线结尾的方法,我们把它统称为魔术方法魔术方法的特征魔术方法都是双下划线开头,双下划线结尾的方法魔术方法都是pytho...

[2]Python面向对象-【3】方法(python3 面向对象)

方法的概念在Python中,方法是与对象相关联的函数。方法可以访问对象的属性,并且可以通过修改对象的属性来改变对象的状态。方法定义在类中,可以被该类的所有对象共享。方法也可以被继承并重载。方法的语法如...

一文带你理解python的面向对象编程(OOP)

面向对象编程(OOP,Object-OrientedProgramming)是一个较难掌握的概念,而Python作为一门面向对象的语言,在学习其OOP特性时,许多人都会对“继承”和“多态”等...

简单学Python——面向对象1(编写一个简单的类)

Python是一种面向对象的编程语言(ObjectOrientedProgramming),在Python中所有的数据类型都是对象。在Python中,也可以自创对象。什么是类呢?类(Class)是...

python进阶突破面向对象——四大支柱

面向对象编程(OOP)有四大基本特性,通常被称为"四大支柱":封装(Encapsulation)、继承(Inheritance)、多态(Polymorphism)和抽象(Abstrac...

Python学不会来打我(51)面向对象编程“封装”思想详解

在面向对象编程(Object-OrientedProgramming,简称OOP)中,“封装(Encapsulation)”是四大核心特性之一(另外三个是继承、多态和抽象),它通过将数据(属性)和...

Python之面向对象:对象属性解析:MRO不够用,补充3个方法

引言在前面的文章中,我们谈及Python在继承关系,尤其是多继承中,一个对象的属性的查找解析顺序。由于当时的语境聚焦于继承关系,所以只是简要提及了属性解析顺序同方法的解析顺序,而方法的解析顺序,在Py...

Python之面向对象:通过property兼顾属性的动态保护与兼容性

引言前面的文章中我们简要提及过关于Python中私有属性的使用与内部“名称混淆”的实现机制,所以,访问私有属性的方法至少有3种做法:1、使用实例对象点操作符的方式,直接访问名称混淆后的真实属性名。2、...

Python之面向对象:私有属性是掩耳盗铃还是恰到好处

引言声明,今天的文章中没有一行Python代码,更多的是对编程语言设计理念的思考。上一篇文章中介绍了关于Python面向对象封装特性的私有属性的相关内容,提到了Python中关于私有属性的实现是通过“...

Python中的私有属性与方法:解锁面向对象编程的秘密

Python中的私有属性与方法:解锁面向对象编程的秘密在Python的广阔世界里,面向对象编程(OOP)是一种强大而灵活的方法论,它帮助我们更好地组织代码、管理状态,并构建可复用的软件组件。而在这个框...

Python 面向对象:掌握类的继承与组合,让你的代码更高效!

引言:构建高效代码的基石Python以其简洁强大的特性,成为众多开发者首选的编程语言。而在Python的面向对象编程(OOP)范畴中,类的继承和组合无疑是两大核心概念。它们不仅能帮助我们实现代码复用,...

python进阶-Day2: 面向对象编程 (OOP)

以下是为Python进阶Day2设计的学习任务,专注于面向对象编程(OOP)的核心概念和高阶特性。代码中包含详细注释,帮助理解每个部分的实现和目的。任务目标:复习OOP基础:类、对象、继...

外婆都能学会的Python教程(二十八):Python面向对象编程(二)

前言Python是一个非常容易上手的编程语言,它的语法简单,而且功能强大,非常适合初学者学习,它的语法规则非常简单,只要按照规则写出代码,Python解释器就可以执行。下面是Python的入门教程介绍...

取消回复欢迎 发表评论: