python代码规范中⽂翻译整合版
最近写python对于⼀些代码规范问题感觉有些地⽅⾃⼰还需要加强,翻阅很多⽂章,特此奉上官⽅中⽂翻译版以便⽇后查看和养成良好的代码习惯和处⼥座⼀样的代码洁癖(笑)。⽂末附上django项⽬规范,⽇后还会继续向上添加。
Introduction 介绍
本⽂提供的Python代码编码规范基于Python主要发⾏版本的标准库。Python的C语⾔实现的C代码规范请查看相应的PEP指南。
这篇⽂档以及PEP 257(⽂档字符串的规范)改编⾃Guido原始的《Python Style Guide》⼀⽂,同时添加了⼀些来⾃Barry的风格指南。
这篇规范指南随着时间的推移⽽逐渐演变,随着语⾔本⾝的变化,过去的约定也被淘汰了。
许多项⽬有⾃⼰的编码规范,在出现规范冲突时,项⽬⾃⾝的规范优先。
A Foolish Consistency is the Hobgoblin of Little Minds 尽信书,则不如⽆书
Guido的⼀条重要的见解是代码阅读⽐写更加频繁。这⾥提供的指导原则主要⽤于提升代码的可读性,使得在⼤量的Python代码中保持⼀致。就像PEP 20提到的,“Readability counts”。
这是⼀份关于⼀致性的风格指南。这份风格指南的风格⼀致性是⾮常重要的。更重要的是项⽬的风格⼀致性。在⼀个模块或函数的风格⼀致性是最重要的。
然⽽,应该知道什么时候应该不⼀致,有时候编码规范的建议并不适⽤。当存在模棱两可的情况时,使⽤⾃⼰的判断。看看其他的⽰例再决定哪⼀种是最好的,不要羞于发问。
特别是不要为了遵守PEP约定⽽破坏兼容性!
⼏个很好的理由去忽略特定的规则:
1. 当遵循这份指南之后代码的可读性变差,甚⾄是遵循PEP规范的⼈也觉得可读性差。
2. 与周围的代码保持⼀致(也可能出于历史原因),尽管这也是清理他⼈混乱(真正的Xtreme Programming风格)的⼀个机会。
3. 有问题的代码出现在发现编码规范之前,⽽且也没有充⾜的理由去修改他们。
python官方文档中文版4. 当代码需要兼容不⽀持编码规范建议的⽼版本Python。
Code lay-out 代码布局
Indentation 缩进
每⼀级缩进使⽤4个空格。
续⾏应该与其包裹元素对齐,要么使⽤圆括号、⽅括号和花括号内的隐式⾏连接来垂直对齐,要么使⽤挂⾏缩进对齐。当使⽤挂⾏缩进时,应该考虑到第⼀⾏不应该有参数,以及使⽤缩进以区分⾃⼰是续⾏。
推荐:
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论