一文轻松掌握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中的迭代器漫谈
Feb 03 Python
Python搭建APNS苹果推送通知推送服务的相关模块使用指南
Jun 02 Python
完美解决Python2操作中文名文件乱码的问题
Jan 04 Python
python3中set(集合)的语法总结分享
Mar 24 Python
详解python 字符串和日期之间转换 StringAndDate
May 04 Python
python学生管理系统代码实现
Apr 05 Python
python logging重复记录日志问题的解决方法
Jul 12 Python
Python 实现还原已撤回的微信消息
Jun 18 Python
详解Python中正则匹配TAB及空格的小技巧
Jul 26 Python
python开发实时可视化仪表盘的示例
May 07 Python
Python排序算法之插入排序及其优化方案详解
Jun 11 Python
python 使用tkinter与messagebox写界面和弹窗
Mar 20 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中die(),exit(),return的区别
2013/06/20 PHP
thinkPHP5.0框架自动加载机制分析
2017/03/18 PHP
浅谈Laravel队列实现原理解决问题记录
2017/08/19 PHP
自动生成文章摘要的代码[JavaScript 版本]
2007/03/20 Javascript
js中访问html中iframe的文档对象的代码[IE6,IE7,IE8,FF]
2011/01/08 Javascript
自制基于jQuery的智能提示插件一枚
2011/02/18 Javascript
js中typeof的用法汇总
2013/12/12 Javascript
jquery 操作css样式、位置、尺寸方法汇总
2014/11/28 Javascript
JS实现的简单图片切换功能示例【测试可用】
2017/02/14 Javascript
几行js代码实现自适应
2017/02/24 Javascript
详解Vue中localstorage和sessionstorage的使用
2017/12/22 Javascript
JavaScript实现的简单Tab点击切换功能示例
2018/07/06 Javascript
从理论角度讨论JavaScript闭包
2019/04/03 Javascript
angular 表单验证器验证的同时限制输入的实现
2019/04/11 Javascript
vue 查看dist文件里的结构(多种方式)
2020/01/17 Javascript
微信小程序以ssm做后台开发的实现示例
2020/04/08 Javascript
js实现直播点击飘心效果
2020/08/19 Javascript
[04:04]DOTA2亚洲邀请赛比赛场馆&酒店全攻略
2017/03/23 DOTA
Python使用urllib2模块实现断点续传下载的方法
2015/06/17 Python
Python可变参数函数用法实例
2015/07/07 Python
PyTorch快速搭建神经网络及其保存提取方法详解
2018/04/28 Python
python用户评论标签匹配的解决方法
2018/05/31 Python
Windows 8.1 64bit下搭建 Scrapy 0.22 环境
2018/11/18 Python
python后端接收前端回传的文件方法
2019/01/02 Python
pytorch 查看cuda 版本方式
2020/06/23 Python
实例讲解CSS3中的border-radius属性
2015/08/18 HTML / CSS
HUGO BOSS美国官方网上商店:世界知名奢侈品牌
2017/08/04 全球购物
Tory Burch德国官网:美国时尚生活品牌
2018/01/03 全球购物
党的群众路线教育实践活动心得体会
2014/03/03 职场文书
贸易经济专业自荐书
2014/06/29 职场文书
司法局2014法制宣传日活动总结
2014/11/01 职场文书
2014年班主任德育工作总结
2014/12/05 职场文书
学校2016年全国助残日活动总结
2016/04/01 职场文书
商业计划书之服装
2019/09/09 职场文书
如何用JavaScipt测网速
2021/05/09 Javascript
Selenium浏览器自动化如何上传文件
2022/04/06 Python