python風格規範 Python風格規範

2021-10-19 03:56:36 字數 1231 閱讀 1166

請務必保持**的一致性

如果你正在編輯**, 花幾分鐘看一下周邊**, 然後決定風格. 如果它們在所有的算術操作符兩邊都使用空格, 那麼你也應該這樣做. 如果它們的注釋都用標記包圍起來, 那麼你的注釋也要這樣.

制定風格指南的目的在於讓**有規可循, 這樣人們就可以專注於」你在說什麼」, 而不是」你在怎麼說」. 我們在這裡給出的是全域性的規範, 但是本地的規範同樣重要. 如果你加到乙個檔案裡的**和原有**大相徑庭, 它會讓讀者不知所措. 避免這種情況.

分號不要在行尾加分號, 也不要用分號將兩條命令放在同一行.

行長度每行不超過80個字元

括號寧缺毋濫的使用括號

縮排用4個空格來縮排**

空行頂級定義之間空兩行, 方法定義之間空一行

空格按照標準的排版規範來使用標點兩邊的空格

shebang

大部分.py檔案不必以#!作為檔案的開始. 根據 pep-394 , 程式的main檔案應該以 #!/usr/bin/python2或者 #!/usr/bin/python3開始.

注釋確保對模組, 函式, 方法和行內注釋使用正確的風格

類如果乙個類不繼承自其它類, 就顯式的從object繼承. 巢狀類也一樣.

字串即使引數都是字串, 使用%操作符或者格式化方法格式化字串. 不過也不能一概而論, 你需要在+和%之間好好判定.

檔案和sockets

在檔案和sockets結束時, 顯式的關閉它.

todo注釋

為臨時**使用todo注釋, 它是一種短期解決方案. 不算完美, 但夠好了.

匯入格式

每個匯入應該獨佔一行

語句通常每個語句應該獨佔一行

訪問控制

在python中, 對於瑣碎又不太重要的訪問函式, 你應該直接使用公有變數來取代它們, 這樣可以避免額外的函式呼叫開銷. 當新增更多功能時, 你可以用屬性(property)來保持語法的一致性.

命名module_name, package_name, classname, method_name, exceptionname, function_name, global_var_name, instance_var_name, function_parameter_name, local_var_name.

main

即使是乙個打算被用作指令碼的檔案, 也應該是可匯入的. 並且簡單的匯入不應該導致這個指令碼的主功能(main functionality)被執行, 這是一種***. 主功能應該放在乙個main()函式中.

Python編碼規範和Python風格規範

一 原因 1 長期的工作中,發現大多數程式設計師的 可讀性差 2 不同的程式設計師之間的協作很重要,可讀性必須很好 3 版本公升級時,要基於原始碼公升級 4 不友好的 會影響python的執行效率 二 基於的規範 1 pep 8 style guide for python code python的...

RESTful風格及規範

一,restful是什麼?rest與技術無關,代表的是一種軟體架構風格 rest是representational state transfer的簡稱,中文翻譯為 表徵狀態轉移 2.rest從資源的角度類審視整個網路,它將分布在網路中某個節點的資源通過url進行標識 3.所有的資料,不過是通過網路獲...

編碼風格不是編碼規範

我並不認為程式設計師是乙個情緒特別豐富的群體。但有一些事情卻能很容易刺激程式設計師的神經,那就是 格式和布局。如果看到乙個函式的括弧在同一行上沒有閉合,我的眼睛會噴血。如果看到有人沒有恰好的在兩個函式間留一空行,我的小腿會抽筋。但重點在這裡 除非是在家裡開發自己的業餘愛好軟體,我的這些個人喜好其實是...