PEP8

《8 號(hào) Python 增強(qiáng)規(guī)范》(Python Enhacement Proposal #8)，簡(jiǎn)稱PEP8

通俗的來(lái)講 PEP8 是針對(duì) python 代碼格式而編訂的風(fēng)格指南，令代碼更加易讀易懂。像谷歌這樣的大公司是有自己內(nèi)部的風(fēng)格規(guī)范Google Style，目的就是為了提高開發(fā)效率。

據(jù)傳聞，Google 馬桶前面的門上，都貼著 Python 編碼規(guī)范。小數(shù)先生今天就分享一些常用的PEP8編碼規(guī)范。

縮進(jìn)

a.每一級(jí)縮進(jìn)使用4個(gè)空格。

b.續(xù)行應(yīng)該與其包裹元素對(duì)其。

例

# 推薦

# 與左括號(hào)對(duì)齊

fo = dict(name='小數(shù)先生', age=18,

gender='男',city='hangzhou')

# 用更多的縮進(jìn)來(lái)與其他行區(qū)分

def long_function_name(

var_noe, var_two,

var_three, var_four):

print(var_one)

不推薦

# 不推薦

fo = dict(name='小數(shù)先生', age=18,

gender='男',city='hangzhou')

def long_function_name(

var_noe, var_two,

var_three, var_four):

print(var_one)

行的最大長(zhǎng)度

a.所有行限制的最大字符串?dāng)?shù)為79。

b.沒有結(jié)構(gòu)化限制的大塊文本(文檔字符或者注釋)，每行最大字符數(shù)限制在72。

空行

a.頂層函數(shù)和類的定義，前后用兩個(gè)空行隔開。

b.類里的方法定義用一個(gè)空行隔開。

imports導(dǎo)入

a.導(dǎo)入通常在分開的行。

# 推薦

import os

import sys

# 不推薦

import sys， os

b.導(dǎo)入總是位于文件的頂部，在模塊注釋和文檔字符串之后，在模塊的全局變量與常量之前。

c.導(dǎo)入應(yīng)該按照以下順序分組標(biāo)準(zhǔn)庫(kù)導(dǎo)入

相關(guān)第三方庫(kù)導(dǎo)入

本地應(yīng)用/庫(kù)特定導(dǎo)入(應(yīng)該在每一組導(dǎo)入之間加入空行)

d.推薦使用絕對(duì)路徑導(dǎo)入，如果導(dǎo)入系統(tǒng)沒有正確的配置，使用絕對(duì)路徑會(huì)更加可讀并且性能更好。

Comments注釋

a.代碼更改時(shí)，優(yōu)先更新對(duì)應(yīng)的注釋。

b.注釋應(yīng)該是完整的句子。

c.如果注釋很短，結(jié)尾的句號(hào)可以省略。

d.在句尾結(jié)束的時(shí)候應(yīng)該使用兩個(gè)空格

Block Comments 塊注釋

a.塊注釋通常適用于跟隨它們的某些(或全部)代碼，并縮進(jìn)到與代碼相同的級(jí)別。塊注釋的每一行開通使用一個(gè) # 和一個(gè)空格(除非塊注釋內(nèi)部縮進(jìn)文本)

b.塊注釋內(nèi)部的段落通過只有一個(gè) # 的空行分隔

Inline Comments 行內(nèi)注釋

a.有節(jié)制地使用行內(nèi)注釋

b.行內(nèi)注釋是與代碼語(yǔ)句同行的注釋，行內(nèi)注釋和代碼至少要有兩個(gè)空格分隔。

Documentation Strings文檔字符串

a.要為所有的公共模塊，函數(shù)，類已經(jīng)方法編寫文檔說(shuō)明

b.多行文檔說(shuō)明使用的結(jié)尾三引號(hào)自成一行

# 推薦

"""Return a foobang

Optional plotz says to frobnicate the bizbaz first.

"""

命名規(guī)范

a.永遠(yuǎn)不要使用字母'l'(小寫的L)，'O'(大寫的o)，或者'I'(大寫的i)作為單字符變量名

b.函數(shù)名要小寫，如果想提高可讀性可以用下劃線分離

c.類名首字母要大寫

更多內(nèi)容PEP 8 -- Style Guide for Python Code?legacy.python.orgb.Python PEP8 編碼規(guī)范中文版?blog.csdn.netstyleguide?google.github.io

作者：小數(shù)先生

總結(jié)

以上是生活随笔為你收集整理的python pep8模块_读懂PEP8，让你的Python代码更加优雅的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。