转载自http://www.blogjava.net/lincode/archive/2011/02/02/343859.html
Python 的代码风格由 PEP 8 描述。这个文档描述了 Python 编程风格的方方面面。在遵守这个文档的条件下,不同程序员编写的 Python 代码可以保持最大程度的相似风格。这样就易于阅读,易于在程序员之间交流。
1 变量
常量 : 大写加下划线
对于不会发生改变的全局变量,使用大写加下划线。
私有变量 : 小写和一个前导下划线
Python 中不存在私有变量一说,若是遇到需要保护的变量,使用小写和一个前导下划线。但这只是程序员之间的一个约定,用于警告说明这是一个私有变量,外部类不要去访问它。但实际上,外部类还是可以访问到这个变量。
内置变量 : 小写,两个前导下划线和两个后置下划线
两个前导下划线会导致变量在解释期间被更名。这是为了避免内置变量和其他变量产生冲突。用户定义的变量要严格避免这种风格。以免导致混乱。
2 函数和方法
总体而言应该使用,小写和下划线。但有些比较老的库使用的是混合大小写,即首单词小写,之后每个单词第一个字母大写,其余小写。但现在,小写和下划线已成为规范。
私有方法 : 小写和一个前导下划线
print "don't test me."
这里和私有变量一样,并不是真正的私有访问权限。同时也应该注意一般函数不要使用两个前导下划线(当遇到两个前导下划线时,Python 的名称改编特性将发挥作用)。特殊函数后面会提及。
特殊方法 : 小写和两个前导下划线,两个后置下划线
return int.__add__(other)
这种风格只应用于特殊函数,比如操作符重载等。
函数参数 : 小写和下划线,缺省值等号两边无空格
self._user = user
3 类
类总是使用驼峰格式命名,即所有单词首字母大写其余字母小写。类名应该简明,精确,并足以从中理解类所完成的工作。常见的一个方法是使用表示其类型或者特性的后缀,例如:
SQLEngine
MimeTypes
对于基类而言,可以使用一个 Base 或者 Abstract 前缀
BaseCookie
AbstractGroup
def __init__(self, profile):
return self._profile = profile
def profile(self):
return self._profile
4 模块和包
除特殊模块 __init__ 之外,模块名称都使用不带下划线的小写字母。
若是它们实现一个协议,那么通常使用lib为后缀,例如:
import smtplib
import sys
5 关于参数
5.1 不要用断言来实现静态类型检测
断言可以用于检查参数,但不应仅仅是进行静态类型检测。 Python 是动态类型语言,静态类型检测违背了其设计思想。断言应该用于避免函数不被毫无意义的调用。
5.2 不要滥用 *args 和 **kwargs
*args 和 **kwargs 参数可能会破坏函数的健壮性。它们使签名变得模糊,而且代码常常开始在不应该的地方构建小的参数解析器。
6 其他
6.1 使用 has 或 is 前缀命名布尔元素
has_member = False
6.2 用复数形式命名序列
6.3 用显式名称命名字典
6.4 避免通用名称
诸如 list, dict, sequence 或者 element 这样的名称应该避免。
6.5 避免现有名称
诸如 os, sys 这种系统已经存在的名称应该避免。
7 一些数字
一行列数 : PEP 8 规定为 79 列,这有些苛刻了。根据自己的情况,比如不要超过满屏时编辑器的显示列数。这样就可以在不动水平游标的情况下,方便的查看代码。
一个函数 : 不要超过 30 行代码, 即可显示在一个屏幕类,可以不使用垂直游标即可看到整个函数。
一个类 : 不要超过 200 行代码,不要有超过 10 个方法。
一个模块 不要超过 500 行。
8 验证脚本
可以安装一个 pep8 脚本用于验证你的代码风格是否符合 PEP8。
http://pypi.python.org/pypi/pep8/#downloads
>>easy_install pep8
>>pep8 -r --ignore E501 Test.py
这个命令行的意思是,重复打出错误,并且忽略 501 错误(代码超过 79 行)。
Ubuntu上的安装可以用命令
sudo apt-get install pep8
相关推荐
PEP8Python 编码规范 将Python 的英文编码变成中文的数据规范
pycodestyle是一个工具,检查您的Python代码对照PEP 8中的一些风格约定。
在使用pycharm编译器进行python编程时,遇到PEP8变成风格警告,该笔记是网络资源,然后进行相关整理以后得到的。
《Python PEP8编码规范》提供的Python代码编码规范基于Python主要发行版本的标准库。Python的C语言实现的C代码规范请查看相应的PEP指南。 这篇文档以及PEP 257(文档字符串的规范)改编自Guido原始的《Python Style...
# Python PEP8 代码风格指南参考:## 关注点* 代码排版
当遵守指南会与其他部分的代码风格背离时 — 当然也许这是一个修正某些混乱代码的机会。 当那些并没有遵循指南的旧代码已无法修改时。 当你的代码需要与旧版本的 Python 保持兼容,而旧版本的 Python 不支持指南...
本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Python代码。请参阅PEP关于Python的C实现的C编码风格指南的描述。 本文档和PEP257(文档字符串规范)改编自Guido的《Python Style Guide》一文,并...
一种无妥协的Python代码格式化工具。它旨在帮助开发人员...通过运行black,您可以自动格式化Python代码,使其符合PEP 8代码风格规范。black不仅是一种强大的代码格式化工具,还是一种推动Python代码规范化的社区标准
Pylint 是一个 Python 代码分析工具,它分析 Python 代码中的错误,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8,具体信息,请参阅参考资料)和有潜在问题的代码。目前 Pylint 的最新版本是 pylint-...
请查阅相关的关于在Python的C实现中C代码风格指南的描述. 这篇文档改编自Guido最初的《Python风格指南》一文. 并从《Barry's style guide》中添加了部分内容. 在有冲突的地方,Guide的风格规则应该是符合本PEP的意图...
python风格的元素:超越PEP8,讨论什么使Python代码感觉很棒。 Python的Strunk&White
这篇文档所给出的编码约定适用于在主要的Python发布版本中组成标准库的Python 代码,请查阅相关的关于在Python的C实现中C代码风格指南的描述。 这篇文档改编自Guido最初的《Python风格指南》一文,并从《Barry's ...
默认使用的代码风格是PEP8,具体信息,请参阅参考资料)和有潜在问题的代码。目前Pylint 的最新版本是pylint-0.18.1。Pylint是一个Python工具,除了平常代码分析工具的作用之外,它提供了更多的功能:如检查一行代码...
这篇文档所给出的编码约定适用于在主要的Python发布版本中组成标准库的Python 代码,请查阅相关的关于在Python的C实现中C代码风格指南的描述。 这篇文档改编自Guido最初的《Python风格指南》一文,并从《Barry's ...
随着软件项目进入“维护模式”,对可读性和编码标准的要求很容易落空(甚至从一开始就没有建立过那些标准)。...PEP 8 是 Python 代码风格规范,它规定了类似行长度、缩进、多行表达式、变量命名约定等内容。
Pylint 是一个 Python 代码分析工具,它分析 Python 代码中的错误,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8,具体信息,请参阅参考资料)和有潜在问题的代码。目前 Pylint 的最新版本是 pylint...
7. 代码风格:遵循PEP 8规范,包括使用空格而不是制表符进行缩进、每行代码不超过79个字符等。 遵循Python编程规范可以使代码更加整洁、易读和易于维护,同时也有助于提高代码的质量和可靠性。 附件为详细的规范要求
Python的代码风格也非常规范,符合PEP8规范,这使得代码易于阅读和维护。 Python编程设计的另一个重要方面是模块化编程。Python提供了很多标准库和第三方库,这些库可以帮助我们快速实现各种功能。同时,Python也...
Pylint 是一个 Python 代码分析工具,它分析 Python 代码中的错误,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8,具体信息,请参阅参考资料)和有潜在问题的代码。目前 Pylint 的最新版本是 pylint-...
在这个存储库中,我将通过python,cpp和sql记录我自己的所有问题解决方案。 我是谁? 纽约大学计算机科学与工程系学生。 即将到来的亚马逊 SDE 实习生。 电子邮件: && 仓库还在建设中,欢迎联系我,讨论这些问题...