Python 开发编码规范
Python开发编码规范
这篇文档所给出的编码约定适用于在主要的Python发布版本中组成标准库的Python 代码,请查阅相关的关于在Python的C实现中C代码风格指南的描述。
这篇文档改编自Guido最初的《Python风格指南》一文,并从《Barry's style guide》中添加了部分内容。在有冲突的地方,Guide的风格规则应该是符合本PEP的意图(译注:指当有冲突时,应以Guido风格为准)。这篇PEP仍然尚未完成(实际上,它可能永远都不会完成)。
在这篇风格指导中的一致性是重要的。在一个项目内的一致性更重要。在一个模块或函数内的一致性最重要。但最重要的是:知道何时会不一致——有时只是没有实施风格指导。当出现疑惑时,运用你的最佳判断,看看别的例子,然后决定怎样看起来更好。并且要不耻下问!
打破一条既定规则的两个好理由:
(1) 当应用这个规则是将导致代码可读性下降,即便对某人来说,他已经习惯于按这条
规则来阅读代码了。
(2) 为了和周围的代码保持一致而打破规则(也许是历史原因),虽然这也是个清除其它
混乱的好机会(真正的XP风格)。
代码的布局
缩进
使用Emacs的Python-mode的默认值:4个空格一个缩进层次。对于确实古老的代码,你不希望产生混乱,可以继续使用8空格的制表符(8-space tabs)。Emacs Python-mode自动发现文件中主要的缩进层次,依此设定缩进参数。
制表符还是空格
永远不要混用制表符和空格。最流行的Python缩进方式是仅使用空格,其次是仅使用制表符,混合着制表符和空格缩进的代码将被转换成仅使用空格。(在Emacs中,选中整个缓冲区,按ESC-x去除制表符。)调用Python命令行解释器时使用-t选项,可对代码中不合法得混合制表符和空格发出警告,使用-tt时警告将变成错误。这些选项是被高度推荐的。 对于新的项目,强烈推荐仅使用空格而不是制表符。许多编辑器拥有使之易于实现的功能(在Emacs中,确认indent-tabs-mode是nil)。
行的最大长度
周围仍然有许多设备被限制在每行80字符:而且,窗口限制在80个字符。使将多个窗口并排放置成为可能。在这些设备上使用默认的折叠方式看起来有点丑陋。因此,请将所有行限制在最大79字符(Emacs准确得将行限制为长80字符),对顺序排放的大块文本(文档字符串或注释),推荐将长度限制在72字符。
折叠长行的首选方法是使用Pyhon支持的圆括号,方括号和花括号内的行延续。如果需要,你可以在表达式周围增加一对额外的圆括号,但是有时使用反斜杠看起来更好,确认恰当得缩进了延续的行。
Emacs的Python-mode正确得完成了这些。一些例子:
#!Python
class Rectangle(Blob):
def __init__(self,width,height,color='black',emphasis=None,highlight=0):
Python开发编码规范_计算机软件及应用_IT/计算机_专业资料。Python开发编码规范Python 开发编码规范 目 1 录 2 3 代码的布局......
Python 开发编码规范 --- hoxide 初译 dreamingk 校对发布 040724 --- xyb 重新排版 040915 RedWolf pdf 整理 080807 PEP: 8 Title: Style Guide for Python ...
Python开发编码规范 040724 --- hoxide dreamingk 用Python进行开发时的编码风格约定 原文:epes:PEP 008《Style Guide for Python Code》 1.1. 介绍 这篇文档所...
python开发规范 33页 免费python编码规...Python 编码规范 编码所有的 Python 脚本文件都应在文件头标上 # -*- coding...
Python编码规范_计算机软件及应用_IT/计算机_专业资料。今日推荐 ... python开发规范 33页 免费 python编程规范 8页 1下载券 python编码规范_v1....
Python 2.6.2/2.7.x 1.3. 规范文档 为了方便维护、他人阅读使用,整理出该编码规范文档。请大家开发时遵循本规范进行 更开发。 本文档参考自 Guido 的《...
简明 Python 编程规范编码所有的 Python 脚本文件都应在文件头标上 # -*- ...命名可以给开发人员减少许多麻烦,而恰如其分的命名则可以大幅提高代码的可 读性...
python代码规范_计算机软件及应用_IT/计算机_专业资料 暂无评价0人阅读0次下载举报文档 python代码规范_计算机软件及应用_IT/计算机_专业资料。 ...
【0】【编码规范】Google Python Style Guide中文版_互联网_IT/计算机_专业...缺点: 对 C/C++开发人员来说, 可能看起来有点怪. 结论: ? 23 尽可能使用...
热门文档