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阅读 157,198评论 4 359
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,663评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,985评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,673评论 0 202
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,994评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,399评论 1 211
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,717评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,407评论 0 194
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,112评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,371评论 2 241
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,891评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,255评论 2 250
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,881评论 3 233
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,010评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,764评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,412评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,299评论 2 260

推荐阅读更多精彩内容