一文轻松掌握python语言命名规范规则

和C/C++、Java等语言一样，python在命名上也有一套约定俗成的规则，符合规范的命名可以让程序的可读性大大增加，从而使得代码的逻辑性增强，易于自己和其他协作者在以后的拓展中理解代码的意义，从而提高编写代码的效率。
我们在平常编写程序的时候需要注意以下几点：

一、python变量名命名的硬性规则

1.1. 变量名大小写敏感

python变量名区分大小写，也就是Student和student在python语言中代表两个不同的名字。

1.2. python的变量名字中可以包含英文、下划线、数字，但是不能以数字开头。

也就是说，student_id、student1、student_1、student、_student、_等都是合理的命名，但是1student就是非法的命名。

二、不同风格命名的变量代表不同的类型

与java中命名习惯使用驼峰命名法不同（有可能发明java的程序猿大哥不但喜欢喝爪哇岛的咖啡，也喜欢骑爪哇岛上的骆驼，哈哈），python变量命名一般采用蛇形命名法（毕竟python的本意就是大蟒蛇），也就是如果变量名由两个单词组成，那么使用下划线来连接这两个单词，比如student_id。当然，我们也会在python中看到类似驼峰命名法的变量名，对于专业的程序猿来说，这些命名都不是随便写的，他们符合一定的标准，下面总结以下：

2.1.模块(module)命名风格

模块尽量使用小写命名，首字母保持小写，尽量不要用下划线(除非多个单词，且数量不多的情况)

# 正确的模块名
import decoder
import html_parser

# 不推荐的模块名
import Decoder

2.2.类(class)的命名

类名使用驼峰(CamelCase)命名风格，首字母大写，私有类可用一个下划线开头

class Farm():
 pass

class AnimalFarm(Farm):
 pass

class _PrivateFarm(Farm):
 pass

2.3.函数（function）的命名

函数名一律小写，如有多个单词，用下划线隔开。

def run():
 pass

def run_with_env():
 pass

2.4.变量（variable）的命名

变量名尽量小写, 如有多个单词，用下划线隔开

if __name__ == '__main__':
 count = 0
 school_name = ''

2.5.常量（constant）的命名

如果我们想用一个符号来代表常量（值是不变的量，比如光速、π等），采用全部大写，如有多个单词，使用下划线隔开。

MAX_CLIENT = 100
MAX_CONNECTION = 1000
CONNECTION_TIMEOUT = 600

三、“下划线”开头的特殊命名

很多时候，我们在python的源代码中会看到下划线开头的变量，初学者看到这些变量会感觉怪怪的。确实，这些“_”开头的命名是具有特殊含义的：

3.1.单下划线开头的命名

  • 如果类变量以单下划线“_”开头，代表这个变量不能被直接访问，类似于C++中的protected型，这样的变量也不能被 import
  • module_name导入。
  • 使用单下划线(one underline）开头的方法，则表示该方法不是AP的一部分,不要直接访问(虽然语法上访问也没有什么问题)。

3.2.双下划线开头的命名

  • 以双下划线(two underlines)开头的类变量，表示为类的私有成员，不能被导入和其他类变量访问。
  • 对于类中的方法，使用双下划线开头开头表示子类不能覆写该方法。除非你真的知道你在干什么,否则不要使用这种方式。

3.3.双下划线开头并且双下划线结尾的命名

魔法方法：以双下划线开头和双下划线结尾的变量是Python的专用标识，有其特殊的身份。我们一般称这样的方法为“魔法方法”（magic method）。

  • 魔法方法是python内置方法，不需要主动调用，存在的目的是为了给python的解释器进行调用，几乎每个魔法方法都有一个对应的内置函数，或者运算符，当我们对这个对象使用这些函数或者运算符时就会调用类中的对应魔法方法，可以理解为重写这些python的内置函数。
  • 当你想让自己定义的对象也可以像Python内置的对象一样使用内置的一些函数或操作符(比如len、add、+、、==等)时,你可以定义该类方法。
  • 当然还有些属性只在末尾加了但下划线这仅仅是为了避免我们起的一些名字和Python保留关键字冲突,没有特殊含义。
  • 下划线变量（方法）的使用，往往和面向对象编程中类（class）的设计相关，更多更深入的知识，可以参考   这篇博客。当然，如果需要了解更多python编程规范，PEP8（Python Enhancement Proposal8）的官方文档是最佳的参考资料。

到此这篇关于一文轻松掌握python语言命名规范规则的文章就介绍到这了,更多相关python命名规范 内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • python标识符命名规范原理解析

    这篇文章主要介绍了python标识符命名规范原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 简单地理解,标识符就是一个名字,就好像我们每个人都有属于自己的名字,它的主要作用就是作为变量.函数.类.模块以及其他对象的名称. Python 中标识符的命名不是随意的,而是要遵守一定的命令规则,比如说: 1.标识符是由字符(A~Z 和 a~z).下划线和数字组成,但第一个字符不能是数字. 2.标识符不能和 Python 中的保留字相同.有关保留

  • 详解python里的命名规范

    文件名 全小写,可使用下划线 包 应该是简短的.小写的名字.如果下划线可以改善可读性可以加入.如mypackage. 模块 与包的规范同.如mymodule. 类 总是使用首字母大写单词串.如MyClass.内部类可以使用额外的前导下划线. 函数&方法 函数名应该为小写,可以用下划线风格单词以增加可读性.如:myfunction,my_example_function. *注意*:混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容. 函数和方法的参数 总使用"self&q

  • python 命名规范知识点汇总

    1,模块命名 (1)模块推荐使用小写命名, (2)除非有很多字母,尽量不要用下划线 因为很多模块文件存与模块名称一致的类,模块采用小写,类采用首字母大写,这样就能区分开模块和类. 2,类命名 (1)类名使用驼峰(CamelCase)命名风格,首字母大写: (2)私有类可用一个下划线开头. 3,函数命名 (1)函数名一律小写,如有多个单词,用下划线隔开 (2)类内部函数命名,用单下划线(_)开头(该函数可被继承访问) (3)类内私有函数命名,用双下划线(__)开头(该函数不可被继承访问) 4,变量

  • 一文轻松掌握python语言命名规范规则

    和C/C++.Java等语言一样,python在命名上也有一套约定俗成的规则,符合规范的命名可以让程序的可读性大大增加,从而使得代码的逻辑性增强,易于自己和其他协作者在以后的拓展中理解代码的意义,从而提高编写代码的效率. 我们在平常编写程序的时候需要注意以下几点: 一.python变量名命名的硬性规则 1.1. 变量名大小写敏感 python变量名区分大小写,也就是Student和student在python语言中代表两个不同的名字. 1.2. python的变量名字中可以包含英文.下划线.数字

  • 一文轻松了解Python中类的继承

    目录 1. 单继承 2. 继承中的方法重写 3. 多继承 总结 1. 单继承 继承的主要作用是实现代码的重用.继承使得子类拥有父类的方法和属性.直接来看一个例子吧. class animal: def eat(self): print("吃") def drink(self): print("喝") class dog(animal): def dark(self): print("汪汪叫") goudan = dog() goudan.eat(

  • Go语言学习技巧之命名规范

    前言 本篇主要讲述Go语言的命名规范.优秀的代码必须具备良好的可读性,而可读性的关键即在于命名风格. Go的函数.变量.常量.自定义类型.包(Package)的命名方式遵循以下规则: 1)首字符可以是任意的Unicode字符或者下划线 2)剩余字符可以是Unicode字符.下划线.数字 3)字符长度不限 Go只有25个关键字 break default func interface select case defer go map struct chan else goto package sw

  • Python语言规范之Pylint的详细用法

    Python语言规范之Pylint的详细用法

    1.Pylint是什么 pylint是一个Python源代码中查找bug的工具,能找出错误,和代码规范的运行.也就是你的代码有Error错误的时候能找出来错误,没有错误的时候,能根据Python代码规范给你建议修改代码,让代码变更美观. 2.安装pylint pip3 install pylint 3.查找pylint的安装地址 $ which pylint /Library/Frameworks/Python.framework/Versions/3.9/bin/pylint 4.Pychar

  • 一文带你轻松学会Go语言动态调用函数

    目录 前言 JavaScript 动态调用函数 Go 中动态调用方法 前言 经常在开发的时候会遇到这样的场景,几个模块的都有相同的方法,但会因为不同的类型的需要调用不同模块的方法.使用一个 switch 可以很方便的解决问题.但是当你遇到的场景是几个模块的方法都是需要的执行,同时它需要在不同的配置下执行相对应的方法. func m1(){} func m2(){} func m3(){} c := cron.New(cron.WithSeconds()) c.addFunc(config1,fu

  • Python开发编码规范

    这篇文档所给出的编码约定适用于在主要的Python发布版本中组成标准库的Python   代码,请查阅相关的关于在Python的C实现中C代码风格指南的描述. 这篇文档改编自Guido最初的<Python风格指南>一文,并从<Barry's style guide>中添加了部分内容.在有冲突的地方,Guide的风格规则应该是符合本PEP的意图(译注:指当有冲突时,应以Guido风格为准).这篇PEP仍然尚未完成(实际上,它可能永远都不会完成).   在这篇风格指导中的一致性是重要的

  • PHP注释语法规范与命名规范详解篇

    HP注释规范 注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范. "php是一门及其容易入门的语言,刚入门的新手不到几分钟的时间可能就会用echo打印出一个hello world !但是他是真正的程序员吗?怎么来定义程序员呢?如果想真正成为一个程序员,那么就必须遵循一套程序书写规范," 我们经常编写一些函数,但是这些函数可能也只有自己能看得懂,甚至过一段时间自己也不认识自己写的了,那么怎么办呢?最好的办法当然是给给自己的代码加上注释.

  • python语言的优势是什么

    Python是一门简单易学的编程语言.阅读好的Python程序感觉就像阅读英语,尽管是非常严格的英语.Python的这种伪代码特性是其最大强项之一,它可让你专注于解决问题的办法而不是语言本身.python的用途和优点都有什么呢? Python编程语言开发快,语言简洁,没那么多技巧,所以读起来很清楚容易! ython的用途:Python它通常应用于各种领域,是一种通用语言,无论是从网站.游戏开发.机器人,人工智能,大数据,云计算或是一些高科技的航天飞机控制都可以用到python语言. 内容扩展:

随机推荐