一、变量
常量:大写加下划线
USER_CONSTANT
对于不会发生改变的全局变量,使用大写加下划线。
私有变量:小写和一个前导下划线
_private_value
python中不存在私有变量一说,若是遇到需要保护的变量,使用小写和一个前导下划线。但这只是程序员之间的一个约定,用于警告说明这是一个私有变量,外部类不要去访问它。但实际上,外部类还是可以访问到这个变量。
内置变量:小写,两个前导下划线和两个后置下划线
__class__
两个前导下划线会导致变量在解释期间被更名。这是为了避免内置变量和其他变量产生冲突。用户定义的变量要严格避免这种风格。以免导致混乱。
二、函数和方法
总体而言应该使用,小写和下划线。但是有些比较老的库使用的是混合大小写,即首单词小写,之后每个单词第一个字母大写,其余小写。但现在,小写和下划线已成为规范。
私有方法:小写和一个前导下划线
deff _secrete(self):
print (‘don‘t test me‘)
这里和私有变量一样,并不是真正的私有访问权限。同时也应该注意一般函数不要使用两个前导下划线(当遇到两个前导下划线时,python的名称改编特性将发挥作用)。特殊函数后面会提及。
特殊方法:小写和两个前导下划线,两个后置下划线
def __add__(self,other):
return int.__add__(other)
这种风格只应用于特殊函数,比如操作符重载等。
函数参数:小写和下划线,缺省值等号两边无空格
def connect(self,user=None):
self._user = user
三、类
类总是使用驼峰格式命名,即所有单词首字母大写其余字母小写。类名应该简明,精确,并足以从中理解类所完成的工作。常见的一个方式是使用表示其类型或者特性的后缀,例如:
SQLEngine
MimeTypes
对于基类而言,可以使用一个Base或者Abstract前缀
BaseCookie
AbstractGroup
class UserProfile(object):
def __init__(self,profile):
return self._profile = profile
def profile(self):
return self._profile
四、模块和包
除特殊模块 __init__ 之外,模块名称都使用不带下划线的小写字母。
若是它们实现一个协议,那么通常使用lib为后缀,例如:
import smtplib
import os
import sys
五、关于参数
5.1 不要用断言来实现静态类型检测
断言可以用于检查参数,但不应仅仅是进行静态类型检测。 Python 是动态类型语言,静态类型检测违背了其设计思想。断言应该用于避免函数不被毫无意义的调用。
5.2 不要滥用 *args 和 **kwargs
*args 和 **kwargs 参数可能会破坏函数的健壮性。它们使签名变得模糊,而且代码常常开始在不应该的地方构建小的参数解析器。
原文地址:https://www.cnblogs.com/helloTerry1987/p/10992047.html