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


Posted in Python onJune 18, 2020

和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命名规范 内容请搜索三水点靠木以前的文章或继续浏览下面的相关文章希望大家以后多多支持三水点靠木! 

Python 相关文章推荐
Python xlrd读取excel日期类型的2种方法
Apr 28 Python
深入分析python中整型不会溢出问题
Jun 18 Python
python跳过第一行快速读取文件内容的实例
Jul 12 Python
Windows下Anaconda2安装NLTK教程
Sep 19 Python
python3.4控制用户输入与输出的方法
Oct 17 Python
计算机二级python学习教程(2) python语言基本语法元素
May 16 Python
python实现在函数图像上添加文字和标注的方法
Jul 08 Python
Django 对象关系映射(ORM)源码详解
Aug 06 Python
python基础教程之while循环
Aug 14 Python
Python排序函数的使用方法详解
Dec 11 Python
Python 无限级分类树状结构生成算法的实现
Jan 21 Python
Python实现byte转integer
Jun 03 Python
Python学习之路之pycharm的第一个项目搭建过程
Jun 18 #Python
基于PyTorch的permute和reshape/view的区别介绍
Jun 18 #Python
Python Switch Case三种实现方法代码实例
Jun 18 #Python
Python3开发环境搭建详细教程
Jun 18 #Python
Python collections.defaultdict模块用法详解
Jun 18 #Python
python实现批量命名照片
Jun 18 #Python
pandas之分组groupby()的使用整理与总结
Jun 18 #Python
You might like
Classes and Objects in PHP5-面向对象编程 [1]
2006/10/09 PHP
php公用函数列表[正则]
2007/02/22 PHP
php实现微信公众平台账号自定义菜单类
2015/10/11 PHP
适用于初学者的简易PHP文件上传类
2015/10/29 PHP
zend框架实现支持sql server的操作方法
2016/12/08 PHP
jquery 实现的全选和反选
2009/04/15 Javascript
JS 操作符整理[推荐收藏]
2011/11/15 Javascript
event.currentTarget与event.target的区别介绍
2012/12/31 Javascript
javascript禁制后退键(Backspace)实例代码
2013/11/15 Javascript
父节点获取子节点的字符串示例代码
2014/02/26 Javascript
jQuery选择器之基本选择器与层次选择器
2015/03/03 Javascript
jQuery时间轴插件使用详解
2015/07/16 Javascript
JS提交form表单实例分析
2015/12/10 Javascript
js实现网页图片延时加载 提升网页打开速度
2016/01/26 Javascript
初探nodeJS
2017/01/24 NodeJs
解决vue脚手架项目打包后路由视图不显示的问题
2018/09/20 Javascript
LayUi使用switch开关,动态的去控制它是否被启用的方法
2019/09/21 Javascript
Vue中jsx不完全应用指南小结
2019/11/01 Javascript
详解如何修改 node_modules 里的文件
2020/05/22 Javascript
[35:44]2014 DOTA2华西杯精英邀请赛 5 24 iG VS VG
2014/05/26 DOTA
布同 Python中文问题解决方法(总结了多位前人经验,初学者必看)
2011/03/13 Python
python利用装饰器进行运算的实例分析
2015/08/04 Python
python3+PyQt5重新实现自定义数据拖放处理
2018/04/19 Python
Python3 导入上级目录中的模块实例
2019/02/16 Python
python实现二维数组的对角线遍历
2019/03/02 Python
使用django的ORM框架按月统计近一年内的数据方法
2019/07/18 Python
python tkinter 设置窗口大小不可缩放实例
2020/03/04 Python
Python爬虫之爬取淘女郎照片示例详解
2020/07/28 Python
日语系毕业生推荐信
2013/11/11 职场文书
职业生涯规划书基本格式
2014/01/06 职场文书
人力资源部经理助理岗位职责
2014/03/04 职场文书
初中作文评语大全
2014/04/23 职场文书
幼儿园教师节活动总结
2015/03/23 职场文书
2016公务员年度考核评语
2015/12/01 职场文书
创业计划书之酒吧
2019/12/02 职场文书
redis击穿 雪崩 穿透超详细解决方案梳理
2022/03/17 Redis