读懂PEP8,让你的Python代码更加优雅

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 Code​legacy.python.org

b.Python PEP8 编码规范中文版​blog.csdn.net

styleguide​google.github.io

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,593评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,080评论 3 396
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,025评论 0 357
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,317评论 1 295
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,329评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,036评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,639评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,557评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,089评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,197评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,330评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,006评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,689评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,189评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,313评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,676评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,339评论 2 358

推荐阅读更多精彩内容

  • 一、Python简介和环境搭建以及pip的安装 4课时实验课主要内容 【Python简介】: Python 是一个...
    _小老虎_阅读 5,747评论 0 10
  • 更新时间:2016/5/13 介绍 本文档所提供的编码规范,适用于主要的Python发行版中组成标准库的Pytho...
    超net阅读 5,866评论 0 15
  • ====== 一致性考虑 ======代码更多是用来读而不是写,本指南旨在改善Python代码的可读性。风格指南强...
    marry_mei阅读 410评论 0 0
  • Introduction This document gives coding conventions for t...
    wuutiing阅读 4,570评论 0 9
  • --< > 令人讨厌的小人物身上有着愚蠢的一致性 --(A Foolish Consistency is the ...
    LittleWizard阅读 3,235评论 0 4