轉(zhuǎn)自：https://blog.csdn.net/warm77/article/details/78353632
前言
Python 學(xué)習(xí)之旅亮蒋，先來(lái)看看 Python 的代碼規(guī)范忌愚，讓自己先有個(gè)意識(shí)喷斋，而且在往后的學(xué)習(xí)中慢慢養(yǎng)成習(xí)慣
目錄
一、簡(jiǎn)明概述****1术幔、編碼
- 如無(wú)特殊情況, 文件一律使用 UTF-8 編碼
- 如無(wú)特殊情況, 文件頭部必須加入
#-*-coding:utf-8-*-標(biāo)識(shí)
2椅寺、代碼格式
2.1示启、縮進(jìn)
- 統(tǒng)一使用 4 個(gè)空格進(jìn)行縮進(jìn)
2.2兢哭、行寬
每行代碼盡量不超過 80 個(gè)字符(在特殊情況下可以略微超過 80 ，但最長(zhǎng)不得超過 120)
理由：
- 這在查看 side-by-side 的 diff 時(shí)很有幫助
- 方便在控制臺(tái)下查看代碼
- 太長(zhǎng)可能是設(shè)計(jì)有缺陷
2.3夫嗓、引號(hào)
簡(jiǎn)單說迟螺，自然語(yǔ)言使用雙引號(hào)，機(jī)器標(biāo)示使用單引號(hào)舍咖，因此 代碼里 多數(shù)應(yīng)該使用 單引號(hào)
-
自然語(yǔ)言 使用雙引號(hào)
"..."
例如錯(cuò)誤信息矩父；很多情況還是 unicode，使用u"你好世界" -
機(jī)器標(biāo)識(shí) 使用單引號(hào)
'...'
例如 dict 里的 key -
正則表達(dá)式 使用原生的雙引號(hào)
r"..." -
文檔字符串 (docstring) 使用三個(gè)雙引號(hào)
"""......"""
2.4排霉、空行
- 模塊級(jí)函數(shù)和類定義之間空兩行窍株；
- 類成員函數(shù)之間空一行；
class A: def __init__(self): pass def hello(self): pass def main(): pass
- 可以使用多個(gè)空行分隔多組相關(guān)的函數(shù)
- 函數(shù)中可以使用空行分隔出邏輯相關(guān)的代碼
2.5攻柠、編碼
- 文件使用 UTF-8 編碼
- 文件頭部加入
#-*-conding:utf-8-*-標(biāo)識(shí)
3球订、import 語(yǔ)句
- import 語(yǔ)句應(yīng)該分行書寫
# 正確的寫法import osimport sys # 不推薦的寫法import sys,os # 正確的寫法from subprocess import Popen, PIPE
- import語(yǔ)句應(yīng)該使用 absolute import
# 正確的寫法from foo.bar import Bar # 不推薦的寫法from ..bar import Bar
- import語(yǔ)句應(yīng)該放在文件頭部，置于模塊說明及docstring之后辙诞，于全局變量之前辙售；
- import語(yǔ)句應(yīng)該按照順序排列轻抱，每組之間用一個(gè)空行分隔
import osimport sys import msgpackimport zmq import foo
- 導(dǎo)入其他模塊的類定義時(shí)飞涂，可以使用相對(duì)導(dǎo)入
from myclass import MyClass
- 如果發(fā)生命名沖突，則可使用命名空間
import barimport foo.bar bar.Bar()foo.bar.Bar()
4、空格
- 在二元運(yùn)算符兩邊各空一格
[=,-,+=,==,>,in,is not, and]:
# 正確的寫法i = i + 1submitted += 1x = x * 2 - 1hypot2 = x * x + y * yc = (a + b) * (a - b) # 不推薦的寫法i=i+1submitted +=1x = x*2 - 1hypot2 = x*x + y*yc = (a+b) * (a-b)
- 函數(shù)的參數(shù)列表中较店，
,之后要有空格
# 正確的寫法def complex(real, imag): pass # 不推薦的寫法def complex(real,imag): pass
- 函數(shù)的參數(shù)列表中士八，默認(rèn)值等號(hào)兩邊不要添加空格
# 正確的寫法def complex(real, imag=0.0): pass # 不推薦的寫法def complex(real, imag = 0.0): pass
- 左括號(hào)之后，右括號(hào)之前不要加多余的空格
# 正確的寫法spam(ham[1], {eggs: 2}) # 不推薦的寫法spam( ham[1], { eggs : 2 } )
- 字典對(duì)象的左括號(hào)之前不要多余的空格
# 正確的寫法dict['key'] = list[index] # 不推薦的寫法dict ['key'] = list [index]
- 不要為對(duì)齊賦值語(yǔ)句而使用的額外空格
# 正確的寫法x = 1y = 2long_variable = 3 # 不推薦的寫法x = 1y = 2long_variable = 3
5梁呈、換行
Python 支持括號(hào)內(nèi)的換行婚度。這時(shí)有兩種情況。
- 第二行縮進(jìn)到括號(hào)的起始處
foo = long_function_name(var_one, var_two, var_three, var_four)
- 第二行縮進(jìn) 4 個(gè)空格官卡，適用于起始括號(hào)就換行的情形
def long_function_name( var_one, var_two, var_three, var_four): print(var_one)
使用反斜杠\換行蝗茁，二元運(yùn)算符+ .等應(yīng)出現(xiàn)在行末；長(zhǎng)字符串也可以用此法換行
session.query(MyTable).\ filter_by(id=1).\ one() print 'Hello, '\ '%s %s!' %\ ('Harry', 'Potter')
禁止復(fù)合語(yǔ)句寻咒，即一行中包含多個(gè)語(yǔ)句：
# 正確的寫法do_first()do_second()do_third() # 不推薦的寫法do_first();do_second();do_third();
if/for/while一定要換行：
# 正確的寫法if foo == 'blah': do_blah_thing() # 不推薦的寫法if foo == 'blah': do_blash_thing()
6哮翘、docstring
docstring 的規(guī)范中最其本的兩點(diǎn)：
- 所有的公共模塊、函數(shù)毛秘、類饭寺、方法，都應(yīng)該寫 docstring 叫挟。私有方法不一定需要艰匙，但應(yīng)該在 def 后提供一個(gè)塊注釋來(lái)說明。
- docstring 的結(jié)束"""應(yīng)該獨(dú)占一行抹恳，除非此 docstring 只有一行员凝。
"""Return a foobarOptional plotz says to frobnicate the bizbaz first.""" """Oneline docstring"""
二、注釋****1奋献、注釋
1.1绊序、塊注釋
“#”號(hào)后空一格，段落件用空行分開（同樣需要“#”號(hào)）
# 塊注釋# 塊注釋## 塊注釋# 塊注釋
1.2秽荞、行注釋
至少使用兩個(gè)空格和語(yǔ)句分開骤公，注意不要使用無(wú)意義的注釋
# 正確的寫法x = x + 1 # 邊框加粗一個(gè)像素 # 不推薦的寫法(無(wú)意義的注釋)x = x + 1 # x加1
1.3、建議
在代碼的關(guān)鍵部分(或比較復(fù)雜的地方), 能寫注釋的要盡量寫注釋
比較重要的注釋段, 使用多個(gè)等號(hào)隔開, 可以更加醒目, 突出重要性
app = create_app(name, options) # =====================================# 請(qǐng)勿在此處添加 get post等app路由行為 !!!# ===================================== if __name__ == '__main__': app.run()
2扬跋、文檔注釋（Docstring）
作為文檔的Docstring一般出現(xiàn)在模塊頭部阶捆、函數(shù)和類的頭部，這樣在python中可以通過對(duì)象的doc對(duì)象獲取文檔.
編輯器和IDE也可以根據(jù)Docstring給出自動(dòng)提示.
- 文檔注釋以 """ 開頭和結(jié)尾, 首行不換行, 如有多行, 末行必需換行, 以下是Google的docstring風(fēng)格示例
# -*- coding: utf-8 -*-"""Example docstrings.This module demonstrates documentation as specified by the `Google PythonStyle Guide`_. Docstrings may extend over multiple lines. Sections are createdwith a section header and a colon followed by a block of indented text.Example: Examples can be given using either the ``Example`` or ``Examples`` sections. Sections support any reStructuredText formatting, including literal blocks:: $ python example_google.pySection breaks are created by resuming unindented text. Section breaksare also implicitly created anytime a new section starts."""
- 不要在文檔注釋復(fù)制函數(shù)定義原型, 而是具體描述其具體內(nèi)容, 解釋具體參數(shù)和返回值等
# 不推薦的寫法(不要寫函數(shù)原型等廢話)def function(a, b): """function(a, b) -> list""" ... ... # 正確的寫法def function(a, b): """計(jì)算并返回a到b范圍內(nèi)數(shù)據(jù)的平均值""" ... ...
- 對(duì)函數(shù)參數(shù)钦听、返回值等的說明采用numpy標(biāo)準(zhǔn), 如下所示
def func(arg1, arg2): """在這里寫函數(shù)的一句話總結(jié)(如: 計(jì)算平均值). 這里是具體描述. 參數(shù) ---------- arg1 : int arg1的具體描述 arg2 : int arg2的具體描述 返回值 ------- int 返回值的具體描述 參看 -------- otherfunc : 其它關(guān)聯(lián)函數(shù)等... 示例 -------- 示例使用doctest格式, 在`>>>`后的代碼可以被文檔測(cè)試工具作為測(cè)試用例自動(dòng)運(yùn)行 >>> a=[1,2,3] >>> print [x + 3 for x in a] [4, 5, 6] """
文檔注釋不限于中英文, 但不要中英文混用
文檔注釋不是越長(zhǎng)越好, 通常一兩句話能把情況說清楚即可
模塊洒试、公有類、公有方法, 能寫文檔注釋的, 應(yīng)該盡量寫文檔注釋
三朴上、命名規(guī)范****1垒棋、模塊
- 模塊盡量使用小寫命名，首字母保持小寫痪宰，盡量不要用下劃線(除非多個(gè)單詞叼架，且數(shù)量不多的情況)
# 正確的模塊名import decoderimport html_parser # 不推薦的模塊名import Decoder
2畔裕、類名
- 類名使用駝峰(CamelCase)命名風(fēng)格，首字母大寫乖订，私有類可用一個(gè)下劃線開頭
class Farm(): pass class AnimalFarm(Farm): pass class _PrivateFarm(Farm): pass
- 將相關(guān)的類和頂級(jí)函數(shù)放在同一個(gè)模塊里. 不像Java, 沒必要限制一個(gè)類一個(gè)模塊.
3扮饶、函數(shù)
- 函數(shù)名一律小寫，如有多個(gè)單詞乍构，用下劃線隔開
def run(): pass def run_with_env(): pass
- 私有函數(shù)在函數(shù)前加一個(gè)下劃線_
class Person(): def _private_func(): pass
4甜无、變量名
- 變量名盡量小寫, 如有多個(gè)單詞，用下劃線隔開
if __name__ == '__main__': count = 0 school_name = ''
- 常量采用全大寫哥遮，如有多個(gè)單詞岂丘，使用下劃線隔開
MAX_CLIENT = 100MAX_CONNECTION = 1000CONNECTION_TIMEOUT = 600
5、常量
- 常量使用以下劃線分隔的大寫命名
MAX_OVERFLOW = 100 Class FooBar: def foo_bar(self, print_): print(print_)
