Python 代码风格 和 PEP8

Python 代码风格 和 PEP8 Python 的代码风格由 PEP 8 描述。这个文档描述了 Python 编程风格的方方面面。在遵照这个文档的条件下，不一样程序员编写的 Python 代码能够保持最大程度的类似风格。这样就易于阅读，易于在程序员之间交流。 1 变量 常量 : 大写加下划线 USER_CONSTANT 对于不会发生改变的全局变量，使用大写加下划线。 私有变量 : 小写和一个前导下划线 _private_value Python 中不存在私有变量一说，如果遇到须要保护的变量，使用小写和一个前导下划线。但这只是程序员之间的一个约定，用于警告说明这是一个私有变量，外部类不要去访问它。但实际上，外部类仍是能够访问到这个变量。 内置变量 : 小写，两个前导下划线和两个后置下划线 __class__ 两个前导下划线会致使变量在解释期间被改名。这是为了不内置变量和其余变量产生冲突。用户定义的变量要严格避免这种风格。以避免致使混乱。 2 函数和方法 整体而言应该使用，小写和下划线。但有些比较老的库使用的是混合大小写，即首单词小写，以后每一个单词第一个字母大写，其他小写。但如今，小写和下划线已成为规范。 私有方法 ： 小写和一个前导下划线 def _secrete(self):     print "don't test me." 这里和私有变量同样，并非真正的私有访问权限。同时也应该注意通常函数不要使用两个前导下划线(当遇到两个前导下划线时，Python 的名称改编特性将发挥做用)。特殊函数后面会说起。 特殊方法 ： 小写和两个前导下划线，两个后置下划线 def __add__(self, other):     return int.__add__(other) 这种风格只应用于特殊函数，好比操做符重载等。 函数参数 : 小写和下划线，缺省值等号两边无空格 def connect(self, user=None):     self._user = user 3 类 类老是使用驼峰格式命名，即全部单词首字母大写其他字母小写。类名应该简明，精确，并足以从中理解类所完成的工做。常见的一个方法是使用表示其类型或者特性的后缀，例如: SQLEngine MimeTypes 对于基类而言，可使用一个 Base 或者 Abstract 前缀 BaseCookie AbstractGroup class UserProfile(object):     def __init__(self, profile):         return self._profile = profile     def profile(self):         return self._profile 4 模块和包 除特殊模块 __init__ 以外，模块名称都使用不带下划线的小写字母。 如果它们实现一个协议，那么一般使用lib为后缀，例如: import smtplib import os import sys 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':'10 road WD', 'user_2' : '20 street huafu'} 6.4 避免通用名称 诸如 list, dict, sequence 或者 element 这样的名称应该避免。 6.5 避免现有名称 诸如 os, sys 这种系统已经存在的名称应该避免。 7 一些数字 一行列数 : PEP 8 规定为 79 列，这有些苛刻了。根据本身的状况，好比不要超过满屏时编辑器的显示列数。这样就能够在不动水平游标的状况下，方便的查看代码。 一个函数 : 不要超过 30 行代码, 便可显示在一个屏幕类，能够不使用垂直游标便可看到整个函数。 一个类 : 不要超过 200 行代码，不要有超过 10 个方法。 一个模块 不要超过 500 行。 8 验证脚本 能够安装一个 pep8 脚本用于验证你的代码风格是否符合 PEP8。 >>easy_install pep8 >>pep8 -r --ignoire E501 Test.py 这个命令行的意思是，重复打出错误，而且忽略 501 错误(代码超过 79 行)。