关于python中带下划线的变量和函数的意义

发布时间:2017-09-09 10:38:23
关于python中带下划线的变量和函数的意义

关于python中带下划线的变量和函数的意义。

总结:

变量:

1. 前带_的变量: 标明是一个私有变量, 只用于标明,外部类还是可以访问到这个变量

2. 前带两个_ ,后带两个_ 的变量: 标明是内置变量,

3. 大写加下划线的变量: 标明是不会发生改变的全局变量

函数:

1. 前带_的变量: 标明是一个私有函数, 只用于标明,

2.前带两个_ ,后带两个_ 的函数: 标明是特殊函数

Python 的代码风格由 PEP 8 描述。这个文档描述了 Python 编程风格的方方面面。在遵守这个文档的条件下,不同程序员编写的 Python 代码可以保持最大程度的相似风格。这样就易于阅读,易于在程序员之间交流。

1 变量

常量: 大写加下划线

USER_CONSTANT

对于不会发生改变的全局变量,使用大写加下划线。

私有变量: 小写和一个前导下划线

_private_value

Python 中不存在私有变量一说,若是遇到需要保护的变量,使用小写和一个前导下划线。但这只是程序员之间的一个约定,用于警告说明这是一个私有变量,外部类不要去访问它。但实际上,外部类还是可以访问到这个变量。

内置变量: 小写,两个前导下划线和两个后置下划线

__class__

两个前导下划线会导致变量在解释期间被更名。这是为了避免内置变量和其他变量产生冲突。用户定义的变量要严格避免这种风格。以免导致混乱。

2函数和方法

总体而言应该使用,小写和下划线。但有些比较老的库使用的是混合大小写,即首单词小写,之后每个单词第一个字母大写,其余小写。但现在,小写和下划线已成为规范。

私有方法: 小写和一个前导下划线

def_secrete(self):

print"don'ttestme."

这里和私有变量一样,并不是真正的私有访问权限。同时也应该注意一般函数不要使用两个前导下划线(当遇到两个前导下划线时,Python 的名称改编特性将发挥作用)。特殊函数后面会提及。

特殊方法: 小写和两个前导下划线,两个后置下划线

def__add__(self,other):

returnint.__add__(other)

这种风格只应用于特殊函数,比如操作符重载等。

函数参数: 小写和下划线,缺省值等号两边无空格

defconnect(self,user=None):

self._user=user

3 类

类总是使用驼峰格式命名,即所有单词首字母大写其余字母小写。类名应该简明,精确,并足以从中理解类所完成的工作。常见的一个方法是使用表示其类型或者特性的后缀,例如:

SQLEngine

MimeTypes

对于基类而言,可以使用一个 Base 或者 Abstract 前缀

BaseCookie

AbstractGroup

classUserProfile(object):

def__init__(self,profile):

returnself._profile=profile

defprofile(self):

returnself._profile

4 模块和包

除特殊模块 __init__ 之外,模块名称都使用不带下划线的小写字母。

若是它们实现一个协议,那么通常使用lib为后缀,例如:

import smtplib

importos

importsys

5关于参数

5.1 不要用断言来实现静态类型检测

断言可以用于检查参数,但不应仅仅是进行静态类型检测。 Python 是动态类型语言,静态类型检测违背了其设计思想。断言应该用于避免函数不被毫无意义的调用。

5.2 不要滥用 *args 和 **kwargs

*args 和 **kwargs 参数可能会破坏函数的健壮性。它们使签名变得模糊,而且代码常常开始在不应该的地方构建小的参数解析器。

6 其他

6.1 使用 has 或 is 前缀命名布尔元素

is_connect=True

has_member=False

6.2 用复数形式命名序列

members=['user_1','user_2']

6.3 用显式名称命名字典

person_address={'user_1':'10roadWD','user_2':'20streethuafu'}

6.4 避免通用名称

诸如 list, dict, sequence 或者 element 这样的名称应该避免。

6.5 避免现有名称

诸如 os, sys 这种系统已经存在的名称应该避免。

7 一些数字

一行列数 : PEP 8 规定为79 列,这有些苛刻了。根据自己的情况,比如不要超过满屏时编辑器的显示列数。这样就可以在不动水平游标的情况下,方便的查看代码。

一个函数 : 不要超过30 行代码, 即可显示在一个屏幕类,可以不使用垂直游标即可看到整个函数。

一个类 : 不要超过200 行代码,不要有超过10 个方法。

一个模块 不要超过500 行。

企业建站2800元起,携手武汉肥猫科技,做一个有见地的颜值派!更多优惠请戳:荆州SEO http://jingzhou.4567w.com