一文轻松掌握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中线程问题的简单讲解
Apr 03 Python
浅谈Python生成器generator之next和send的运行流程(详解)
May 08 Python
Python抓取聚划算商品分析页面获取商品信息并以XML格式保存到本地
Feb 23 Python
小白如何入门Python? 制作一个网站为例
Mar 06 Python
Python3.5 创建文件的简单实例
Apr 26 Python
详解python多线程、锁、event事件机制的简单使用
Apr 27 Python
python实现邮件自动发送
Aug 10 Python
python字符串替换re.sub()实例解析
Feb 09 Python
Pyspark读取parquet数据过程解析
Mar 27 Python
Windows下pycharm安装第三方库失败(通用解决方案)
Sep 17 Python
python爬虫判断招聘信息是否存在的实例代码
Nov 20 Python
Matplotlib绘制混淆矩阵的实现
May 27 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输出echo、print、print_r、printf、sprintf、var_dump的区别比较
2013/06/21 PHP
php微信公众平台开发(一) 配置接口
2016/12/06 PHP
PHP+MySql实现一个简单的留言板
2020/07/19 PHP
跨浏览器的 mouseenter mouseleave 以及 compareDocumentPosition的使用说明
2010/05/04 Javascript
JS Date函数整理方便使用
2013/10/23 Javascript
用Jquery.load载入页面后样式没了页面混乱的解决方法
2014/10/20 Javascript
JS实现三级折叠菜单特效,其它级可自动收缩
2015/08/06 Javascript
Vue + Webpack + Vue-loader学习教程之功能介绍篇
2017/03/14 Javascript
Vue.js 插件开发详解
2017/03/29 Javascript
JS实现动态添加DOM节点和事件的方法示例
2017/04/28 Javascript
详解node HTTP请求客户端 - Request
2017/05/05 Javascript
webpack公共组件引用路径简化小技巧
2018/06/15 Javascript
jQuery实现的监听导航滚动置顶状态功能示例
2018/07/23 jQuery
微信小程序内拖动图片实现移动、放大、旋转的方法
2018/09/04 Javascript
jquery获取input输入框中的值
2019/11/13 jQuery
JavaScript实现Tab标签页切换的最简便方式(4种)
2020/06/28 Javascript
JS实现audio音频剪裁剪切复制播放与上传(步骤详解)
2020/07/28 Javascript
Python编程之多态用法实例详解
2015/05/19 Python
Linux系统上Nginx+Python的web.py与Django框架环境
2015/12/25 Python
python解决网站的反爬虫策略总结
2016/10/26 Python
Python字典实现简单的三级菜单(实例讲解)
2017/07/31 Python
Python分布式进程中你会遇到的问题解析
2019/05/28 Python
python学生信息管理系统实现代码
2019/12/17 Python
解决Pytorch训练过程中loss不下降的问题
2020/01/02 Python
简单介绍一下pyinstaller打包以及安全性的实现
2020/06/02 Python
如何解决cmd运行python提示不是内部命令
2020/07/01 Python
利用django创建一个简易的博客网站的示例
2020/09/29 Python
美国一家著名的手表在线折扣网站:Discount Watch Store
2020/02/24 全球购物
设计师大码女装:11 Honoré
2020/05/03 全球购物
Ajax的优点和缺点
2014/11/21 面试题
职业生涯规划书的格式
2013/12/29 职场文书
辩论赛主持词
2014/03/18 职场文书
维稳工作情况汇报
2014/10/27 职场文书
机关单位工作失职检讨书
2014/11/20 职场文书
检讨书范文2000字
2015/01/28 职场文书
Springboot配置suffix指定mvc视图的后缀方法
2021/07/03 Java/Android