PEP 8 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.. 包命名尽量短小,使用全部小写的方式,不可以使用下划线。
  3. 类的命名使用CapWords的方式,模块内部使用的类采用_CapWords的方式。
  4. 异常命名使用CapWords+Error后缀的方式。
  5. 全局变量尽量只在模块内有效,类似C语言中的static。实现方法有两种,一是__all__机制;二是前缀一个下划线。
  6. 函数命名使用全部小写的方式,可以使用下划线。
  7. 常量命名使用全部大写的方式,可以使用下划线。
  8. 类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。
  9. 类的属性有3种作用域public、non-public和subclass API,可以理解成C++中的public、private、protected,non-public属性前,前缀一条下划线。
  10. 类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。
  11. 为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。比如:类Foo中声明__a,访问时,只能通过Foo._Foo__a,避免歧义。如果子类也叫Foo,那就无能为力了。
  12. 类的方法第一个参数必须是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)
  1. 使用startswith() and endswith()代替切片进行序列前缀或后缀的检查。比如:
    Yes: if foo.startswith(‘bar‘):优于
    No: if foo[:3] == ‘bar‘:
  2. 使用isinstance()比较对象的类型。比如
    Yes: if isinstance(obj, int): 优于
    No: if type(obj) is type(1):
  3. 判断序列空或不空,有如下规则
    Yes: if not seq:
    if seq:
    优于
    No: if len(seq)
    if not len(seq)
  4. 字符串不要以空格收尾。
  5. 二进制数据判断使用 if boolvalue的方式。

原文地址:https://www.cnblogs.com/shiqi17/p/9588558.html

时间: 2024-10-10 02:51:58

PEP 8 python编程规范的相关文章

Python编程规范(PEP8)

Python编程规范(PEP8) 代码布局 缩进 对于每一次缩进使用4个空格.使用括号.中括号.大括号进行垂直对齐,或者缩进对齐. 制表符还是空格? 永远不要将制表符与空格混合使用.Python最常用的缩进方式是只是用空格. 当调用Python命令行的 -t 选项时,它会检测并警告代码非法混合使用制表符和空格.当使用 -tt 选项时,警告变成了错误. 最大行长度 限制所有行最长为79个字符. 使用反斜杠来分行是一个很好的选择. 我们应当选择在二元操作符之后进行分行,而不是之前. 空行 使用两行空

简明 Python 编程规范

赖勇浩(http://laiyonghao.com) 注:之前发布一篇<简明 Python 编程规范>(见:http://blog.csdn.net/lanphaday/article/details/2834883),本是我给当时所在的公司制定的,发表到博客的时候,对齐等问题都有一些错误,还包括一些错别字.到后来,我又有做过修正.大概在 2010 年 8 年,我又由 C++ 开发转到 Python 开发,便在那之前的基础上润饰和完善,形成第二版.前段时间 simple-is-better.c

PEP8 Python编程规范

官方文档: https://www.python.org/dev/peps/pep-0008/ ------------------------------------------------------------------------ PEP8中文翻译: http://www.cnblogs.com/ajianbeyourself/p/4377933.html -----------------------------------------------------------------

Python编程规范

本节内容如下: 代码块大括号 分号 行长度 括号 缩进 空行 空格 类 导入格式 语句 命令 代码块大括号 代码使用缩进的方式,而不是大括号是Python语言规范中的一大特点,如果你有其他语言基础的话,可能需要适应一下: flag = True if flag:     print('代码块1')     print('代码块2') else:     print('代码块3')     print('代码块4') 分号 不要在行尾加分号, 也不要用分号将两条命令放在同一行.查看原文 行长度 每

python编程规范与代码优化建议

1.严格使用缩进来体现代码的逻辑从属关系. python对代码的缩进是硬性要求,这一点必须时刻注意.如果某个代码段的缩进不对,那么整个程序就是错的,要么是语法错误无法执行,要么是逻辑错误导致错误结果,而检查这样的错误会花费很多时间. 2.每个import语句只导入一个模块,最好按标准库.扩展库.自定义库的顺序依次导入. 尽量避免导入整个库,最好只导入确实需要使用的对象,这会让程序运行更快. 3.最好在每个类.函数定义和一段完整的功能代码之后增加一个空行,在运算符两侧各增加一个空格,逗号后面增加一

python 编程 规范

对于自己需要注意的: 1)不要使用反斜杠连接行. Python会将 圆括号, 中括号和花括号中的行隐式的连接起来 , 你可以利用这个特点. 如果需要, 你可以在表达式外围增加一对额外的圆括号.

【转】Python——编码规范

来自于 啄木鸟社区 Python Coding Rule --- hoxide 初译 dreamingk 校对发布 040724 --- xyb 重新排版 040915 --- ZoomQuiet MoinMoin 美化 050610 用Python进行开发时的编码风格约定 原文:PEP 008 <Style Guide for Python Code> 下载(中文pdf): PythonCodingRule.pdf 进一步的: Google Python Style Guide Python

《自拍教程》Python编程风格规范

Python编程风格规范 根据Python官方提供的Python编程风格规范: Style Guide for Python Code, 即PEP8规范, https://www.python.org/dev/peps/pep-0008/ 我通过学习并翻译总结, 总结了以下几条编程风格规范,各位同学可考虑自行参考. 良好的编程风格规范可以凸显代码编写者是否专业, 并提高其他代码阅读者的易读性. 我面试过很多测试求职候选人,做笔试题的时候. 一看代码命名规范,就知道正点不正点了, 是不是老手. 阅

【python】python编码规范

PEP介绍 PEP是 Python Enhancement Proposal 的缩写,是Python增强建议书的意思. Python的代码风格由PEP 8描述.这个文档描述了Python编程风格的方方面面.在遵守这个文档的条件下,不同程序员编写的Python代码可以保持最大程度的相似风格.这样就易于阅读,易于在程序员之间交流. 命名规则 不同的命名风格 有许多不同的命名风格.以下的有助于辨认正在使用的命名风格,这独立于它们的作用. 小写串 (lowercase) 带下划线的小写串 (lower_