PEP8
《8 号 Python 增强规范》(Python Enhacement Proposal #8),简称PEP8
通俗的来讲 PEP8 是针对 python 代码格式而编订的风格指南,令代码更加易读易懂。像谷歌这样的大公司是有自己内部的风格规范Google Style,目的就是为了提高开发效率。
据传闻,Google 马桶前面的门上,都贴着 Python 编码规范。小数先生今天就分享一些常用的PEP8编码规范。
缩进
a.每一级缩进使用4个空格。
b.续行应该与其包裹元素对其。
例
# 推荐
# 与左括号对齐
fo = dict(name='小数先生', age=18,
gender='男',city='hangzhou')
# 用更多的缩进来与其他行区分
def long_function_name(
var_noe, var_two,
var_three, var_four):
print(var_one)
不推荐
# 不推荐
fo = dict(name='小数先生', age=18,
gender='男',city='hangzhou')
def long_function_name(
var_noe, var_two,
var_three, var_four):
print(var_one)
行的最大长度
a.所有行限制的最大字符串数为79。
b.没有结构化限制的大块文本(文档字符或者注释),每行最大字符数限制在72。
空行
a.顶层函数和类的定义,前后用两个空行隔开。
b.类里的方法定义用一个空行隔开。
imports导入
a.导入通常在分开的行。
# 推荐
import os
import sys
# 不推荐
import sys, os
b.导入总是位于文件的顶部,在模块注释和文档字符串之后,在模块的全局变量与常量之前。
c.导入应该按照以下顺序分组
标准库导入
相关第三方库导入
本地应用/库特定导入(应该在每一组导入之间加入空行)
d.推荐使用绝对路径导入,如果导入系统没有正确的配置,使用绝对路径会更加可读并且性能更好。
Comments注释
a.代码更改时,优先更新对应的注释。
b.注释应该是完整的句子。
c.如果注释很短,结尾的句号可以省略。
d.在句尾结束的时候应该使用两个空格
Block Comments 块注释
a.块注释通常适用于跟随它们的某些(或全部)代码,并缩进到与代码相同的级别。块注释的每一行开通使用一个 # 和一个空格(除非块注释内部缩进文本)
b.块注释内部的段落通过只有一个 # 的空行分隔
Inline Comments 行内注释
a.有节制地使用行内注释
b.行内注释是与代码语句同行的注释,行内注释和代码至少要有两个空格分隔。
Documentation Strings文档字符串
a.要为所有的公共模块,函数,类已经方法编写文档说明
b.多行文档说明使用的结尾三引号自成一行
# 推荐
"""Return a foobang
Optional plotz says to frobnicate the bizbaz first.
"""
命名规范
a.永远不要使用字母'l'(小写的L),'O'(大写的o),或者'I'(大写的i)作为单字符变量名
b.函数名要小写,如果想提高可读性可以用下划线分离
c.类名首字母要大写
更多内容
PEP 8 -- Style Guide for Python Codelegacy.python.org
b.Python PEP8 编码规范中文版blog.csdn.net
styleguidegoogle.github.io