代码布局

缩进

  • 每级缩进用4个空格。
  • 括号中使用垂直隐式缩进或使用悬挂缩进。

EXAMPLE:

# (垂直隐式缩进)对准左括号
foo = long_function_name(var_one, var_two,
var_three, var_four) # (悬挂缩进) 一般情况只需多一层缩进
foo = long_function_name(
var_one, var_two,
var_three, var_four) # (悬挂缩进) 但下面情况, 需再加多一层缩进, 和后续的语句块区分开来
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one) # 右括号回退
my_list = [
1, 2, 3,
4, 5, 6,
]
result = some_function_that_takes_arguments(
'a', 'b', 'c',
'd', 'e', 'f',
)

错误示范:

# 不使用垂直对齐时,第一行不能有参数。
foo = long_function_name(var_one, var_two,
var_three, var_four) # 参数的悬挂缩进和后续代码块缩进不能区别。
def long_function_name(
var_one, var_two, var_three,
var_four):
print(var_one) # 右括号不回退,不推荐
my_list = [
1, 2, 3,
4, 5, 6,
] result = some_function_that_takes_arguments(
'a', 'b', 'c',
'd', 'e', 'f',
)

最大行宽

  • 每行最大行宽不超过 79 个字符
  • 一般续行可使用反斜杠
  • 括号内续行不需要使用反斜杠

EXAMPLE:


# 无括号续行, 利用反斜杠
with open('/path/to/some/file/you/want/to/read') as file_1, \
open('/path/to/some/file/being/written', 'w') as file_2:
file_2.write(file_1.read()) # 括号内续行, 尽量在运算符后再续行
class Rectangle(Blob): def __init__(self, width, height,
color='black', emphasis=None, highlight=0):
if (width == 0 and height == 0 and
color == 'red' and emphasis == 'strong' or
highlight > 100):
raise ValueError("sorry, you lose")
if width == 0 and height == 0 and (color == 'red' or
emphasis is None):
raise ValueError("I don't think so -- values are %s, %s" %
(width, height))

空行

  • 两行空行用于分割顶层函数和类的定义
  • 单个空行用于分割类定义中的方法

EXAMPLE:

# 类的方法定义用单个空行分割,两行空行分割顶层函数和类的定义。
class A(object):
def method1():
pass def method2():
pass def method3():
pass

模块导入

  • 导入的每个模块应该单独成行
  • 导入顺序如下: (各模块类型导入之间要有空行分割,各组里面的模块的顺序按模块首字母自上而下升序排列)
    • 标准库
    • 相关的第三方库
    • 本地库

EXAMPLE:

# 按模块首字母排序导入, 依此递推
import active
import adidas
import create

错误示例:

# 一行导入多模块
import sys, os, knife # 不按首字母导入
import create
import active
import beyond

字符串

  • 单引号和双引号作用是一样的,但必须保证成对存在,不能夹杂使用.
    (建议句子使用双引号, 单词使用单引号, 但不强制.)

EXAMPLE:

# 单引号和双引号效果一样
name = 'JmilkFan'
name = "Hey Guys!"

表达式和语句中的空格

  • 括号里边避免空格

EXAMPLE:

spam(ham[1], {eggs: 2})

错误示例:

spam( ham[ 1 ], { eggs: 2 } )
  • 逗号,冒号,分号之前避免空格
    EXAMPLE:
if x == 4: print x, y; x, y = y, x

错误示例:

if x == 4 : print x , y ; x , y = y , x
  • 函数调用的左括号之前不能有空格

EXAMPLE:

spam(1)
dct['key'] = lst[index]

错误示例:

spam (1)
dct ['key'] = lst [index]
  • 赋值等操作符前后不能因为对齐而添加多个空格

EXAMPLE:

x = 1
y = 2
long_variable = 3

错误示例:

x             = 1
y = 2
long_variable = 3
  • 二元运算符两边放置一个空格

    • 涉及 = 的复合操作符 ( += , -=等)
    • 比较操作符 ( == , < , > , != , <> , <= , >= , in , not in , is , is not )
    • 逻辑操作符( and , or , not )

EXAMPLE:

a = b
a or b # 括号内的操作符不需要空格
name = get_name(age, sex=None, city=Beijing)

注释

  • 注释块
    注释块通常应用在代码前,并和代码有同样的缩进。每行以 ‘# ’ 开头, 而且#后面有单个空格。

EXAMPLE:

# Have to define the param `args(List)`,
# otherwise will be capture the CLI option when execute `python manage.py server`.
# oslo_config: (args if args is not None else sys.argv[1:])
CONF(args=[], default_config_files=[CONFIG_FILE])
  • 单行注释(应避免无谓的注释)

EXAMPLE:

x = x + 1 # Compensate for border
  • 文档字符串

EXAMPLE:

# 多行文档, 首行首字母大写,结尾的 """ 应该单独成行
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
""" # 单行的文档, 结尾的 """ 在同一行。
"""Return a foobang"""

命名规则

  • 包和模块名:
    包和模块名应该简短,全部用小写字母, 多字母之间可以使用单下划线连接。

  • 类名:
    遵循驼峰命名

class MyClass(object):
pass
  • 全局变量名:
    全局变量名应尽量只在模块内部使用, 对可能使用语句 from moduleName import variableName 而被导入的模块,应采用 __all__ 机制来防止全局变量被别的模块导入, 或者在全局变量名开头加一个前置下划线.

EXAMPLE:

_name = 'name'
  • 函数名
    函数名应该为全部小写的凹驼峰规则。

EXAMPLE:

vcenter_connection = ''
  • 常量名
    常量全部使用大写字母的凹驼峰规则来表示, 通常在模块顶格定义

EXAMPLE:

MAX_OVERFLOW = ''
TOTAL = 1
  • 方法名和实例变量

    • 非公开方法和实例变量开头使用前置下划线
    • 有时候可能会为了避免与子类命名冲突,采用两个前置下划线
      需要注意的是: 若 class Foo 的属性名为 __a, 该属性是不能以 Foo.__a 的方式访问的(执著的用户还是可以通过Foo._Foo__a 来访问), 所以通常双前置下划线仅被用来避免与基类的属性发生命名冲突。

编程建议

  • None 的比较用 isis not,而不要用 ==

  • is not 代替 not … is, 前者的可读性更好

EXAMPLE:

# Yes
if foo is not None # No
if not foo is None
  • 使用函数定义关键字 def 代替 lambda 赋值给标识符, 这样更适合于回调和字符串表示
# Yes
def f(x):
return 2*x # No
f = lambda x: 2*x
  • 异常类应该继承自Exception,而不是 BaseException

  • Python 2 中用raise ValueError('message') 代替 raise ValueError, 'message'

  • (考虑兼容python3和续行的方便性)

  • 捕获异常时尽量指明具体异常, 尽量不用 except Exception, 应该捕获 出了什么问题,而不是 问题发生

EXAMPLE:

# Yes (捕获具体异常)
try:
import platform_specific_module
except ImportError:
platform_specific_module = None # No (不要全局捕获)
try:
import platform_specific_module
except:
platform_specific_module = None
  • try/except 子句中的代码要尽可能的少, 以免屏蔽掉其他的错误

EXAMPLE:

# Yes
try:
value = collection[key]
except KeyError:
return key_not_found(key)
else:
return handle_value(value) # No
try:
return handle_value(collection[key])
except KeyError:
# 可能会捕捉到 handle_value()中的 KeyError, 而不是 collection 的
return key_not_found(key)
  • 函数或者方法在没有返回值时要明确返回 None
# Yes
def foo():
return None # No
def foo():
return
  • 使用字符串方法而不是 string 模块
    python 2.0 以后字符串方法总是更快,而且与 Unicode 字符串使用了相同的 API

  • 使用使用 .startswith().endswith() 代替字符串切片来检查前缀和后缀
    startswith()endswith 更简洁,利于减少错误

EXAMPLE:

# Yes
if foo.startswith('bar'): # No
if foo[:3] == 'bar':
  • 使用 isinstance() 代替对象类型的比较

EXAMPLE:

# Yes
if isinstance(obj, int): # No
if type(obj) is type(1):
  • 空序列类型对象的 bool 为 False:
# Yes
if not seq:
pass
if seq:
pass # No
if len(seq):
pass
if not len(seq):
pass
  • 不要用 == 进行 bool 比较
# Yes
if greeting:
pass # No
if greeting == True
pass
if greeting is True: # Worse
pass
版权声明:转载请注明出处 JmilkFan_范桂飓:http://blog.csdn.net/jmilk https://blog.csdn.net/Jmilk/article/details/53996580

Python 常用 PEP8 编码规范和建议的更多相关文章

  1. Python 常用 PEP8 编码规范

    Python 常用 PEP8 编码规范 代码布局 缩进 每级缩进用4个空格. 括号中使用垂直隐式缩进或使用悬挂缩进. EXAMPLE: ? 1 2 3 4 5 6 7 8 9 10 11 12 13 ...

  2. 【翻译】Python PEP8编码规范(中文版)

    原文链接:http://legacy.python.org/dev/peps/pep-0008/ item detail PEP 8 Title Style Guide for Python Code ...

  3. Python PEP 8 编码规范中文版

    原文链接:http://legacy.python.org/dev/peps/pep-0008/ 转发链接:https://blog.csdn.net/ratsniper/article/detail ...

  4. 16 pep8 编码规范

    pep8 编码规范 Python Enhancement Proposals :python改进方案 https://www.python.org/dev/peps/ 1. 每级缩进用4个空格. 括号 ...

  5. PHP编码规范及建议

    <h3 align="center">PHP编码规范及建议</h3>### 编码规范- PHP代码文件必须以 <?php 标签开始.```<?p ...

  6. Python常用字符编码(转)

    Python常用字符编码   字符编码的常用种类介绍 第一种:ASCII码 ASCII(American Standard Code for Information Interchange,美国信息交 ...

  7. 学习笔记之Python最简编码规范

    Python最简编码规范 - 机器学习算法与Python学习 https://mp.weixin.qq.com/s/i6MwvC4jYTE6D1KHFgBeoQ https://www.cnblogs ...

  8. python 编码规范起源:PEP8 编码规范中文版

    PEP: 8 标题: Python代码的样式指南 版: c451868df657 最后修改: 2016-06-08 10:43:53 -0400(2016年6月8日星期三) 作者: Guido van ...

  9. Python第一章-编码规范

    Python的基础知识 一.编码规范 PEP8[^ 注] 编码规范 Guido的关键点之一是:代码更多是用来读而不是写.编码规范旨在改善Python代码的可读性. 风格指南强调一致性.项目.模块或函数 ...

随机推荐

  1. Linux 常用环境搭建

    已有环境 python 2.6.6 jdk 1.7 —tomcat— —jenkins— —jq— —Python 2.7— —pip— —PIL— —Android SDK— —yum or apt ...

  2. 查找一个Class到底在那一个jar文件里

    整理自己的一些笔记,发觉这个命令 ,看起来是用来找一个Class到底在那一个jar文件里的. 虽然没有再测一下,估计是好使的. 先在博客园里记下来,防止自己忘掉. findstr /S /M org. ...

  3. 不能访问虚拟机上的nginx网站

    VMware虚拟机上配置nginx后,本机无法访问问题 转自:http://www.server110.com/nginx/201407/10794.html 把nginx装在CentOS上,用本机访 ...

  4. 雷林鹏分享:JSP 简介

    JSP 简介 什么是Java Server Pages? JSP全称Java Server Pages,是一种动态网页开发技术.它使用JSP标签在HTML网页中插入Java代码.标签通常以<%开 ...

  5. vue.js-列表分页

    <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8&quo ...

  6. 【LeetCode 38_字符串_算术运算】Count and Say

    string countAndSay(int n) { string res; ) return res; res = "; ) { int len = res.size(); int i, ...

  7. ajax下载,前端js下载(转)

    前面一直做过下载的功能.就是后台将文件流写入response里面,然后就好了.前台会自动弹出下载提示等. 今天打算做一个ajax下载.想当然的结果死活浏览器没反应.我擦. 然后浏览器调试,发现resp ...

  8. Sublime text代码补全插件(支持Javascript、JQuery、Bootstrap框架)

    Sublime text代码补全插件(支持Javascript.JQuery.Bootstrap框架)   插件名称:javascript-API-Completions 支持Javascript.J ...

  9. Swift 标签控制器(tabbar添加提醒和控制器)

    // Override point for customization after application launch. //初始化window, 大小为设备物理大小 self.window = U ...

  10. 量化分析:把Tushare数据源,规整成PyalgoTrade所需格式

    量化分析:把Tushare数据源,规整成PyalgoTrade所需格式 分析A股历史数据,首先需要确定数据来源.如果只想做日k线.周k线的技术分析,可以用PyalgoTrade直接从yahoo.goo ...