Python代碼編寫規范(適合于小團體,低強度)

正文之前

這篇文是我跟師兄協定以后寫代碼的一些規范,雖然麻煩,但是對于后續的復查以及代碼延續都有很大的好處的。

武漢歡樂谷自己拍的圖,后期也調了下。哈哈哈~

正文

必須統一的

文件頭

寫入作者姓名,文件作用

"""
###################### File Introduction ######################
* Author: ZZB
* Function:這個文件主要用于定義中文拆分的一些函數和文件讀寫
######################*******************######################
"""

函數規范

  • Function: 寫出該函數的作用,標準為:接受XXX的調用(可有可無,視功能而定),傳入XXX參數,返回XXX

  • Args:列出每個參數的名字, 并在名字后使用一個冒號和一個空格, 分隔對該參數的描述.如果描述太長超過了單行80字符,使用2或者4個空格的懸掛縮進(與文件其他部分保持一致). 描述應該包括所需的類型和含義. 如果一個函數接受foo(可變長度參數列表)或者bar (任意關鍵字參數), 應該詳細列出foobar.

  • Returns: (或者 Yields: 用于生成器)描述返回值的類型和語義. 如果函數返回None, 這一部分可以省略.

  • Raises:列出與接口有關的所有異常(這一部分如果有,就寫清楚,沒有就ignore).

"""
###################
# * function:這個get_radical函數用于接受中文字符串,返回拆解的偏旁數組
# * args:(Chinses_string)
#   * Chinses_string:中文字符串
# * return radicals
#   * radicals是一個偏旁組成的數組[a,b,c,d,e]
# * raise:未設置異常檢測
###################
"""

def get_radical(Chinses_string)
    ......
    return radicals

TODO注釋

TODO注釋應該在所有開頭處包含”TODO”字符串, 另外必須添加后續需要做的功能及其設想,以及可選的下列信息:

  • TODO填寫人
  • 后續工作完成者
  • email
# TODO
# Submiter:張照博
# Complete:唐訓祝
# Email:zzb@hust.edu.cn

def get_radical(Chinese_string)
    pass

代碼日志

在主運行程序下,把所有有意義的(篇幅不大,便于人閱讀的)中間結果write到一個log的日志文件里面去。同時建議以時間和當前文件名作為log日志的文件名。示例如下:

"""
# ###################在文件開頭加這些就OK了###################
import os
import time
path = os.path.basename(__file__)
time = time.strftime("%Y-%m-%d-%H-%M", time.localtime())
log = open("log/"+path[:path.find('.')]+time+".log",'w',encoding='utf8')
# ###################*************************###################
"""

ram_range=(1,1) #表示 
unigram, ngram_range=(2,2) #表示 
bigram, ngram_range=(3,3) #表示 thirgram
from sklearn.feature_extraction.text import CountVectorizer
import pandas as pd
import jieba

data = ["為了祖國,為了勝利,向我開炮!向我開炮!",
        "記者:你怎么會說出那番話",
        "我只是覺得,對準我自己打"]
data = [" ".join(jieba.lcut(e)) for e in data]         # 分詞,并用" "連接
vector = CountVectorizer(min_df=1, ngram_range=(2,2))  # bigram
X = vector.fit_transform(data)                         # 將分詞好的文本轉換為矩陣
print(vector.vocabulary_ )                             # 得到特征
###########有些變量可以print但是無法write,這時候加個類型轉換就好了###########
log.write(str(vector.vocabulary_))
###########***********************************************************###########
print(X)                                               #(句子下標, 單詞特征下標)   頻數
log.write(str(X))
df1 = pd.DataFrame(X.toarray(), columns=vector.get_feature_names()) # to DataFrame
df1.head()
###############記得最后要close日志文件###############
log.close()
###############************************###############

可改進的:

字符串

避免在循環中用+和+=操作符來累加字符串.


Yes: x = '%s, %s!' % (imperative, expletive)
       x = '{}, {}!'.format(imperative, expletive)
       x = 'name: %s; score: %d' % (name, n)
       x = 'name: {}; score: {}'.format(name, n)
     
 
No: x = imperative + ', ' + expletive + '!'
      x = 'name: ' + name + '; score: ' + str(n)

由于字符串是不可變的, 這樣做會創建不必要的臨時對象, 并且導致二次方而不是線性的運行時間. 作為替代方案, 你可以將每個子串加入列表, 然后在循環結束后用 .join 連接列表. (也可以將每個子串寫入一個 cStringIO.StringIO 緩存中.)

Yes: items = ['<table>']
     for last_name, first_name in employee_list:
         items.append('<tr><td>%s, %s</td></tr>' % (last_name, first_name))
     items.append('</table>')
     employee_table = ''.join(items)
     
No: employee_table = '<table>'
    for last_name, first_name in employee_list:
        employee_table += '<tr><td>%s, %s</td></tr>' % (last_name, first_name)
    employee_table += '</table>'

無關效率但是提高代碼可讀性的

空格

不要在逗號, 分號, 冒號前面加空格, 但應該在它們后面加(除了在行尾). 為了美觀以及IDE的規范提示

Yes: if x == 4:
           print x, y
       x, y = y, x
     
No:  if x == 4 :
           print x , y
       x , y = y , x 

在二元操作符兩邊都加上一個空格, 比如賦值(=), 比較(==, <, >, !=, <>, <=, >=, in, not in, is, is not), 布爾(and, or, not). 至于算術操作符兩邊的空格該如何使用, 需要你自己好好判斷. 不過兩側務必要保持一致.

分號

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

行長度

每行不超過80個字符

例外: 長的導入模塊語句,注釋里的URL

括號

對括號進行最佳精簡化,能少則少

空行

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

正文之后

搞掂 走起,后期看看效果哈

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,699評論 2 370

推薦閱讀更多精彩內容