Python - PEP-8 編寫規(guī)范總結(jié)

縮進(jìn)

縮進(jìn)使用4個(gè)空格符丽涩,利用Tab

函數(shù)

設(shè)定4個(gè)參數(shù)

var_one = '1'
var_two = '2'
var_three = '3'
var_four = '4'

正確格式

# 假設(shè)函數(shù)參數(shù)
def long_name(var_one, var_two,
              var_three, var_four):
    print(var_one + var_two + var_three + var_four)
# 函數(shù)參數(shù)過(guò)多需要換行,則放在“(”后


long_name(var_one, var_two,
          var_three, var_four)
# 同理
long_name(
    var_one, var_two,
    var_three, var_four)
# 當(dāng)以'('為末尾進(jìn)行換行拄显,下一行保持前面有4個(gè)空格的縮進(jìn)即可

錯(cuò)誤格式

def long_name(
    var_one, var_two, var_three,
    var_four):
    print(var_one)
# 函數(shù)變量以'('為末尾換行時(shí)苟径,下一行還是需要對(duì)齊(,目前變量縮進(jìn)是錯(cuò)誤

long_name(var_one, var_two,
    var_three, var_four)
# 不應(yīng)該直接換行后4個(gè)縮進(jìn)躬审,要對(duì)齊(

if

可以接受以下寫法:

# 無(wú)額外縮進(jìn)棘街,且對(duì)齊美觀
if (this_is_one_thing and
    that_is_another_thing):
    do_something()


# 在條件延續(xù)行上添加一些額外的縮進(jìn)
if (this_is_one_thing
        and that_is_another_thing):
    do_something()

多行的列表括號(hào)等構(gòu)造

#多行構(gòu)造的右花括號(hào)/括號(hào)/括號(hào)可以在列表最后一行的第一個(gè)非空白字符下對(duì)齊,如下所示:
my_list = [
    1, 2, 3,
    4, 5, 6,
    ]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
    )
#或者可以將其對(duì)齊在開(kāi)始多行構(gòu)造的行的第一個(gè)字符下盒件,例如:

my_list = [
    1, 2, 3,
    4, 5, 6,
]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
)

行長(zhǎng)

限制所有行最多79個(gè)字符蹬碧。
如果超過(guò),請(qǐng)換行處理
錯(cuò)誤

one_thing = 1
two_thing = 2
three_thing = 3
four_thing = 4
if one_thing + two_thing == three_thing and one_thing + three_thing == four_thing and one_thing + four_thing != two_thing or one_thing > 0:
    print('you are right')

正確

if one_thing + two_thing == three_thing and one_thing + three_thing == four_thing \
        and one_thing + four_thing != two_thing or one_thing > 0:
    print('you are right')

或者另外例子

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())

使用反斜杠對(duì)過(guò)長(zhǎng)語(yǔ)句進(jìn)行處理

對(duì)于數(shù)字運(yùn)算過(guò)程炒刁,有時(shí)可能不確定是否換行恩沽,這兒統(tǒng)一規(guī)定

錯(cuò)誤

income = (gross_wages +
          taxable_interest +
          (dividends - qualified_dividends) -
          ira_deduction -
          student_loan_interest)

正確

income = (gross_wages
          + taxable_interest
          + (dividends - qualified_dividends)
          - ira_deduction
          - student_loan_interest)

正確寫法讓代碼增加可讀性,且遵循數(shù)學(xué)傳統(tǒng)

import的正確寫法

錯(cuò)誤

import os, sys

正確

import os
import sys

from subprocess import Popen, PIPE

擺放的位置總是在文件的頂部翔始,緊隨任何模塊注釋和文檔字符串之后罗心,以及模塊全局變量和常量之前。

導(dǎo)入模塊順序城瞎,應(yīng)遵循如下:
1渤闷、標(biāo)準(zhǔn)庫(kù)導(dǎo)入
2、相關(guān)第三方進(jìn)口
3脖镀、本地應(yīng)用程序/特定于庫(kù)的導(dǎo)入

針對(duì)不同類型導(dǎo)入模塊飒箭,應(yīng)空一行處理。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末蜒灰,一起剝皮案震驚了整個(gè)濱河市弦蹂,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌强窖,老刑警劉巖凸椿,帶你破解...
    沈念sama閱讀 211,639評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異翅溺,居然都是意外死亡脑漫,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,277評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門咙崎,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)优幸,“玉大人,你說(shuō)我怎么就攤上這事褪猛⊥耍” “怎么了?”我有些...
    開(kāi)封第一講書人閱讀 157,221評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)跛璧。 經(jīng)常有香客問(wèn)我严里,道長(zhǎng),這世上最難降的妖魔是什么追城? 我笑而不...
    開(kāi)封第一講書人閱讀 56,474評(píng)論 1 283
  • 正文 為了忘掉前任刹碾,我火速辦了婚禮,結(jié)果婚禮上座柱,老公的妹妹穿的比我還像新娘迷帜。我一直安慰自己,他們只是感情好色洞,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,570評(píng)論 6 386
  • 文/花漫 我一把揭開(kāi)白布戏锹。 她就那樣靜靜地躺著,像睡著了一般火诸。 火紅的嫁衣襯著肌膚如雪十偶。 梳的紋絲不亂的頭發(fā)上玖翅,一...
    開(kāi)封第一講書人閱讀 49,816評(píng)論 1 290
  • 那天挑豌,我揣著相機(jī)與錄音姐霍,去河邊找鬼。 笑死盯荤,一個(gè)胖子當(dāng)著我的面吹牛馋吗,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播秋秤,決...
    沈念sama閱讀 38,957評(píng)論 3 408
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼宏粤,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了灼卢?” 一聲冷哼從身側(cè)響起绍哎,我...
    開(kāi)封第一講書人閱讀 37,718評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎芥玉,沒(méi)想到半個(gè)月后蛇摸,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體备图,經(jīng)...
    沈念sama閱讀 44,176評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡灿巧,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,511評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了揽涮。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片抠藕。...
    茶點(diǎn)故事閱讀 38,646評(píng)論 1 340
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖蒋困,靈堂內(nèi)的尸體忽然破棺而出盾似,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 34,322評(píng)論 4 330
  • 正文 年R本政府宣布零院,位于F島的核電站溉跃,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏告抄。R本人自食惡果不足惜撰茎,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,934評(píng)論 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望打洼。 院中可真熱鬧龄糊,春花似錦、人聲如沸募疮。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 30,755評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)阿浓。三九已至他嚷,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間芭毙,已是汗流浹背爸舒。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 31,987評(píng)論 1 266
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留稿蹲,地道東北人扭勉。 一個(gè)月前我還...
    沈念sama閱讀 46,358評(píng)論 2 360
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像苛聘,于是被迫代替她去往敵國(guó)和親涂炎。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,514評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容

  • 官網(wǎng) 中文版本 好的網(wǎng)站 Content-type: text/htmlBASH Section: User ...
    不排版閱讀 4,370評(píng)論 0 5
  • Python的初學(xué)者震缭,開(kāi)發(fā)者都應(yīng)該知道的代碼可讀性提高技巧,本篇主要介紹了如下內(nèi)容: PEP 8是什么以及它存在的...
    妄心xyx閱讀 1,776評(píng)論 0 16
  • 今天周日战虏,跟大家分享下生活方面的話題拣宰。 起因是我今天在知乎上看到一個(gè)介紹杭州互聯(lián)網(wǎng)公司的帖子: 在杭州約有1/5的...
    酷拉皮卡閱讀 4,319評(píng)論 19 22
  • 兩個(gè)月前,7月15日烦感,以一個(gè)故事為交換巡社,夢(mèng)龍給我進(jìn)行了一次占卜。 今天手趣,九月即將過(guò)半晌该,半個(gè)月的虛度讓我想起了那次占...
    花老板不吃閘機(jī)閱讀 157評(píng)論 0 0
  • 愿你三冬暖,愿你春不寒, 愿你天黑有燈,愿你下雨有傘 愿你一路有良人相伴 愿你半生仍初心不變 愿你余生皆無(wú)牽絆 愿...
    Freedom_財(cái)商教育閱讀 234評(píng)論 2 3