一文轻松掌握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 3中的yield from语法详解
Jan 18 Python
Python利用ElementTree模块处理XML的方法详解
Aug 31 Python
Python 实现使用dict 创建二维数据、DataFrame
Apr 13 Python
在python win系统下 打开TXT文件的实例
Apr 29 Python
Flask核心机制之上下文源码剖析
Dec 25 Python
python中Lambda表达式详解
Nov 20 Python
python日期与时间戳的各种转换示例
Feb 12 Python
Python 实现Image和Ndarray互相转换
Feb 19 Python
Python作用域与名字空间原理详解
Mar 21 Python
python 读txt文件,按‘,’分割每行数据操作
Jul 05 Python
Pytorch之Tensor和Numpy之间的转换的实现方法
Sep 03 Python
在pycharm中无法import所安装的库解决方案
May 31 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
php的access操作类
2008/04/09 PHP
PHP获取数组中某元素的位置及array_keys函数应用
2013/01/29 PHP
2014过年倒计时示例
2014/01/31 PHP
PHP实现文件上传和多文件上传
2015/12/24 PHP
php实现博客,论坛图片防盗链的方法
2016/10/15 PHP
ThinkPHP框架表单验证操作方法
2017/07/19 PHP
Extjs TriggerField在弹出窗口显示不出问题的解决方法
2010/01/08 Javascript
js和jquery批量绑定事件传参数一(新猪猪原创)
2010/06/23 Javascript
基于jquery的合并table相同单元格的插件(精简版)
2011/04/05 Javascript
JavaScript String.replace函数参数实例说明
2013/06/06 Javascript
extjs两个tbar问题探讨
2013/08/08 Javascript
jQuery对下拉框,单选框,多选框的操作
2014/02/21 Javascript
node.js 开发指南 ? Node.js 连接 MySQL 并进行数据库操作
2014/07/29 Javascript
jQuery事件绑定用法详解(附bind和live的区别)
2016/01/19 Javascript
javascript深拷贝(deepClone)详解
2016/08/24 Javascript
JavaScript原生数组Array常用方法
2017/04/06 Javascript
windows下更新npm和node的方法
2017/11/30 Javascript
原生JS实现的自动轮播图功能详解
2018/12/28 Javascript
从零撸一个pc端vue的ui组件库( 计数器组件 )
2019/08/08 Javascript
layui操作列按钮个数和文字颜色的判断实例
2019/09/11 Javascript
vue实现把接口单独存放在一个文件方式
2020/08/13 Javascript
微信小程序中data-key属性之数据传输(经验总结)
2020/08/22 Javascript
[02:36]DOTA2亚洲邀请赛小组赛精彩集锦:EE凭借法力虚空拿下4杀
2017/03/30 DOTA
Python中绑定与未绑定的类方法用法分析
2016/04/29 Python
使用python实现生成用户信息
2017/03/20 Python
python使用pil进行图像处理(等比例压缩、裁剪)实例代码
2017/12/11 Python
python pickle存储、读取大数据量列表、字典数据的方法
2019/07/07 Python
PyTorch使用cpu加载模型运算方式
2020/01/13 Python
公司合作意向书范文
2014/07/30 职场文书
党性观念心得体会
2014/09/03 职场文书
学生偷窃检讨书
2014/09/25 职场文书
2014年信访工作总结
2014/11/17 职场文书
个人自荐书怎么写
2015/03/26 职场文书
培训感想范文
2015/08/07 职场文书
JS Canvas接口和动画效果大全
2021/04/29 Javascript
JavaScript中的LHS和RHS分析详情
2022/04/06 Javascript