`

【转】PEP8 Python 编码规范整理

 
阅读更多

原文地址:http://www.douban.com/note/134971609/

 

PEP8 Python 编码规范

一 代码编排
1 缩进。4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格。
2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号。换行点要在操作符的后边敲回车。
3 类和top-level函数定义之间空两行;类中的方法定义之间空一行;函数内逻辑无关段落之间空一行;其他地方尽量不要再空行。

二 文档编排
1 模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义。其中import部分,又按标准、三方和自己编写顺序依次排放,之间空一行。
2 不要在一句import中多个库,比如import os, sys不推荐。
3 如果采用from XX import XX引用库,可以省略‘module.’,都是可能出现命名冲突,这时就要采用import XX。

三 空格的使用
        总体原则,避免不必要的空格。
1 各种右括号前不要加空格。
2 逗号、冒号、分号前不要加空格。
3 函数的左括号前不要加空格。如Func(1)。
4 序列的左括号前不要加空格。如list[2]。
5 操作符左右各加一个空格,不要为了对齐增加空格。
6 函数默认参数使用的赋值符左右省略空格。
7 不要将多句语句写在同一行,尽管使用‘;’允许。
8 if/for/while语句中,即使执行语句只有一句,也必须另起一行。

四 注释
        总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释!
        注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。
1 块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:
# Description : Module config.
#
# Input : None
#
# Output : None
2 行注释,在一句代码后加注释。比如:x = x + 1 # Increment x
但是这种方式尽量少使用。
3 避免无谓的注释。

五 文档描述
1 为所有的共有模块、函数、类、方法写docstrings;非共有的没有必要,但是可以写注释(在def的下一行)。
2 如果docstring要换行,参考如下例子,详见PEP 257
"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

六 命名规范
        总体原则,新编代码必须按下面命名风格进行,现有库的编码尽量保持风格。
1 尽量单独使用小写字母‘l’,大写字母‘O’等容易混淆的字母。
2 模块命名尽量短小,使用全部小写的方式,可以使用下划线。
3 包命名尽量短小,使用全部小写的方式,不可以使用下划线。
4 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。
5 异常命名使用CapWords+Error后缀的方式。
6 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。
7 函数命名使用全部小写的方式,可以使用下划线。
8 常量命名使用全部大写的方式,可以使用下划线。
9 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
9 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
11 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
12 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
13 类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。

七 编码建议
1 编码中考虑到其他python实现的效率等问题,比如运算符‘+’在CPython(Python)中效率很高,都是Jython中却非常低,所以应该采用.join()的方式。
2 尽可能使用‘is’‘is not’取代‘==’,比如if x is not None 要优于if x。
3 使用基于类的异常,每个模块或包都有自己的异常类,此异常类继承自Exception。
4 异常中不要使用裸露的except,except后跟具体的exceptions。
5 异常中try的代码尽可能少。比如:
try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value)
要优于
try:
# Too broad!
return handle_value(collection[key])
except KeyError:
# Will also catch KeyError raised by handle_value()
return key_not_found(key)
6 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如:
Yes: if foo.startswith('bar'):优于
No: if foo[:3] == 'bar':
7 使用isinstance()比较对象的类型。比如
Yes: if isinstance(obj, int): 优于
No: if type(obj) is type(1):
8 判断序列空或不空,有如下规则
Yes: if not seq:
if seq:
优于
No: if len(seq)
if not len(seq)
9 字符串不要以空格收尾。
10 二进制数据判断使用 if boolvalue的方式。

分享到:
评论

相关推荐

    PEP8Python 编码规范

    描述“PEP8 Python编码规范将Python的英文编码变成中文的数据规范”中提到的转变,实际上并不是PEP8规范所涵盖的内容。PEP8是关于Python编码风格的规范,而如何将英文文档转成中文应当是遵循翻译原则和文档规范的...

    PEP8Python编码规范整理.pdf

    PEP 8 Python 编码规范整理 PEP 8 是 Python 官方编码规范,旨在统一 Python 代码风格和格式,提高代码的可读性和维护性。本文将详细介绍 PEP 8 的主要内容,包括缩进、代码组织、空格使用、注释、文档描述和命名...

    Python PEP8 编码规范中文版

    Python PEP8 编码规范中文版旨在为Python编程语言提供一套统一的代码编写标准,以便提升代码的可读性和一致性。PEP是Python Enhancement Proposal的缩写,它代表了Python增强提案,而PEP8是一份专门针对Python代码...

    PEP8 Python 编码规范

    资源来自网络整理

    Python-PET8-编码规范汇编.pdf

    这份文档《Python-PET8-编码规范汇编.pdf》...以上是根据给定文件内容整理出的Python编码规范知识点。在编写Python代码时,遵循这些规范不仅可以提高代码质量,还可以增加代码的可读性和一致性,便于团队协作和维护。

    python 编码规范整理

    ### Python编码规范详解 #### 一、代码编排 **1. 缩进** - 使用4个空格作为缩进单位。 - 不要使用Tab键缩进,也不要在同一文件中混合使用Tab键和空格。 **2. 行长度** - 每行最大长度不超过79个字符。 - 需要换行...

    Python知识点整理.zip

    15. **PEP 8编码规范**:PEP 8是Python社区推荐的编码风格指南,遵循它可以使代码更易读、易维护。 这个"Python知识点整理.pdf"文档可能涵盖了这些主题,详细解析了Python语言的各个方面,无论是初学者还是经验丰富...

    autopep8:一种自动格式化Python代码以符合PEP 8样式指南的工具

    **标题解析:**"autopep8"是一个Python代码自动格式化工具,它的主要功能是将Python源代码按照PEP 8(Python Enhancement Proposal 8)的编码规范进行格式化,使得代码风格统一,更易于阅读和维护。 **描述解析:**...

    Python-100-Days.zip

    7. **PEP 8风格指南.md**:PEP 8是Python的官方编码规范,遵循它可以提高代码的一致性和可读性。这个文档详细解读了PEP 8中的各项规则,对于养成良好的编程习惯非常有帮助。 8. **常见反爬策略及应对方案.md**:...

    PythonBook开发宝典

    综上所述,《PythonBook开发宝典》集合了Python在Windows平台上的应用、标准库的深度探索、编码规范的实践指导以及个人学习心得,是Python开发者不可多得的参考资料。无论你是初学者还是经验丰富的开发者,这些资源...

    Python 面试题汇总及答案详解完整版

    8. **PEP8规范**:Python的编码风格指南,包括缩进、命名规则、注释等,旨在提高代码的可读性。 9. **进制转换**:Python中可以使用int()函数配合base参数进行进制转换,例如`int('1010', 2)`将二进制转换为十进制...

    Python库 | flake8_isort-1.3-py2-none-any.whl

    `pycodestyle` 检查PEP 8编码规范的遵循情况,`pyflakes` 查找未使用的变量、未定义的名称等问题,`mccabe` 则检测复杂度过高的函数或方法。`flake8` 的优点在于其简单易用,可以快速对整个项目进行质量评估。 **...

    创建MP3列表的小工具(Python)

    8. **代码可读性**:遵循Python的PEP 8编码规范,使代码易于阅读和理解。 9. **命令行参数**:可能使用`argparse`模块接受用户输入的目录路径作为命令行参数。 通过分析`mlist.py`,我们不仅可以学习到如何用Python...

    python实现影视作品分析

    遵循PEP8编码规范,使用版本控制工具如Git,以及模块化编程,可以使代码更易于理解和维护。 通过以上步骤,我们可以使用Python对影视作品进行深入分析,从而为制片人、市场研究人员、影评人等提供有价值的参考信息...

    python安装网址

    - **《Python 编码风格指南》**: [http://www.python.org/peps/pep-0008.html](http://www.python.org/peps/pep-0008.html) - **特点**: 规定了 Python 代码的书写规范,帮助开发者写出更易于阅读和维护的代码。 - *...

    CodingStyle:各语言编码规范

    Python的PEP 8规范是Python社区广泛接受的标准: 1. 使用四个空格进行缩进,不使用制表符。 2. 类名遵循大驼峰命名,如ClassName。 3. 函数和变量使用下划线分隔的蛇形命名,如function_name。 4. 注释以# 开头,...

    python 股票

    最后,项目的组织和版本控制可能使用了`git`,代码编写可能遵循了`PEP8`编码规范,而测试可能用到了`unittest`或`pytest`。 总的来说,这个“StockPy-master”项目涵盖了Python在股票分析中的多个核心方面,包括...

    python开发的基本流程.doc

    2. **编码规范遵循**:遵循PEP 8等Python编码规范,保证代码的整洁和一致性。 3. **版本控制**:使用Git等版本控制系统管理源代码,便于多人协作开发。 #### 四、调试与测试 **目的**:确保程序的质量和稳定性。 ...

    Atom-atom-python-isort,用于排序python导入的atom.io插件。对bh/原子的贡献.zip

    在Python开发中,保持import语句的整洁和有序是非常重要的,因为这不仅有助于提高代码的可读性,还能遵循一定的编码规范,例如PEP8。 首先,我们需要理解什么是Atom。Atom是一款由GitHub开发的免费、开源的文本编辑...

    Python库 | pretzel-1.0.2.tar.gz

    6. 友好的API:Pretzel的API设计简洁明了,遵循Python的PEP8编码规范,使得学习和使用都非常直观。 在实际应用中,Pretzel库广泛适用于数据分析、数据科学以及任何需要对数据进行处理和分析的项目。比如,它可以...

Global site tag (gtag.js) - Google Analytics