一文轻松掌握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解析json之ValueError: Expecting property name enclosed in double quotes: line 1 column 2(char 1)
Jul 06 Python
Python2实现的LED大数字显示效果示例
Sep 04 Python
如何安装并使用conda指令管理python环境
Jul 10 Python
python实现桌面托盘气泡提示
Jul 29 Python
Django 对象关系映射(ORM)源码详解
Aug 06 Python
Django Serializer HiddenField隐藏字段实例
Mar 31 Python
python随机模块random的22种函数(小结)
May 15 Python
Python爬虫爬取新闻资讯案例详解
Jul 14 Python
关于Python3的import问题(pycharm可以运行命令行import错误)
Nov 18 Python
python实现网络五子棋
Apr 11 Python
Python 循环读取数据内存不足的解决方案
May 25 Python
python 详解turtle画爱心代码
Feb 15 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
Terran剧情介绍
2020/03/14 星际争霸
PHP4实际应用经验篇(5)
2006/10/09 PHP
解决phpmyadmin中文乱码问题。。。
2007/01/18 PHP
如何使用PHP计算上一个月的今天
2013/05/23 PHP
学习php设计模式 php实现访问者模式(Visitor)
2015/12/07 PHP
php计算给定日期所在周的开始日期和结束日期示例
2017/02/06 PHP
jQuery 使用个人心得
2009/02/26 Javascript
javascript自动给文本url地址增加链接的方法分享
2014/01/20 Javascript
jquery+javascript编写国籍控件
2015/02/12 Javascript
jQuery实现的产品自动360度旋转展示特效源码分享
2015/08/21 Javascript
node.js使用cluster实现多进程
2016/03/17 Javascript
关于在Servelet中如何获取当前时间的操作方法
2016/06/28 Javascript
详解基于Koa2开发微信二维码扫码支付相关流程
2018/05/16 Javascript
微信小程序修改swiper默认指示器样式的实例代码
2018/07/18 Javascript
解决vue打包后vendor.js文件过大问题
2019/07/03 Javascript
详解Vue2.5+迁移至Typescript指南
2019/08/01 Javascript
JavaScript 斐波那契数列 倒序输出 输出100以内的质数代码实例
2019/09/11 Javascript
python动态监控日志内容的示例
2014/02/16 Python
django中的setting最佳配置小结
2017/11/21 Python
Python数据处理篇之Sympy系列(五)---解方程
2019/10/12 Python
Python requests模块基础使用方法实例及高级应用(自动登陆,抓取网页源码)实例详解
2020/02/14 Python
Python3.x+pyqtgraph实现数据可视化教程
2020/03/14 Python
python让函数不返回结果的方法
2020/06/22 Python
Python高阶函数与装饰器函数的深入讲解
2020/11/10 Python
.NET现在共支持多少种语言
2014/02/26 面试题
Discard Protocol抛弃协议的作用是什么
2015/10/10 面试题
Shell如何接收变量输入
2012/09/24 面试题
GWT都有什么特性
2016/12/02 面试题
腾讯公司的一个sql题
2013/01/22 面试题
优秀员工表扬信
2014/01/17 职场文书
设计顾问服务计划书
2014/05/04 职场文书
中秋节国旗下演讲稿
2014/09/05 职场文书
假期安全教育广播稿
2014/10/04 职场文书
优秀班组事迹材料
2014/12/24 职场文书
乡镇保密工作承诺书
2015/05/04 职场文书
详解Redis集群搭建的三种方式
2021/05/31 Redis