python模块化编程的小练习

有关模块化编程的资料

看到Clarmy写的模块化编程的文章(http://www.clarmy.net/2018/09/09/briefly-discuss-pythons-modular-programming/),很受启发。文中提到作者写python的三个阶段:(1)所有代码都堆叠在一起;(2)一个project创建一个文件,适当使用函数,但某些常用函数要从别的文件复制粘贴;(3)将常用函数封装在一个tools.py文件里,之后import进来,缺点是这个文件会越来越大。如果熟练使用模块化编程,能大大提高函数复用率,代码也会更简洁清晰。

和做编程工作的朋友讨论,又了解了“高内聚、低耦合”的概念。先用伪代码分割好流程,再一个个写功能的function。这样代码的复用性会提高,整体更清爽。另外要养成好的命名习惯、精炼地加注释等等。科研中常用的代码分割方式就是【读文件】【分析处理数据】和【输出】,如果要修改分析方法的话,改动其中第二部分的函数就好。

有关高内聚低耦合High cohesion & Low coupling基本知识的博客:https://blog.csdn.net/fangkang7/article/details/82684819

规范写法范例

这里是朋友发给我的一个优秀规范写法示例:https://github.com/leekeiling/Cluster/blob/master/Kmeans.py

函数封装练习

正好今天一个朋友找我写一个简单的小程序,就以此为契机,练习一下函数封装。

问题描述

数据存在四个文件夹里,每个文件夹下有100~200个数据文件, 后缀名为.xl

folders.png

原始数据是逗号分割的文本文件,共三列,有标题行:
data structure.png

对每个文件夹里的所有文件,需要只取中间的若干行:

NSBA2ppm:取180行至3060行
NSBA20ppm:取190行至1130行
NSBAcontrolbottom:取190至1600行
NSBAcontroltoplie:取180至1200行

求出Se/C, 并将每个文件夹下的结果输出到一个xlsx文档即可。

代码

修改前

最开始没有打草稿,写成了这个样子:

import os
import pandas as pd
import numpy as np
paths = [r'./NSBA2ppm',
        r'./NSBA20ppm',
        r'./NSBAcontrolbottom',
        r'./NSBAcontroltoplie']

bounds = [[180, 3060], [190, 1130], [190, 1600], [180, 1200]]

outfiles = ['NSBA2ppm_ratio.xlsx',
            'NSBA20ppm_ratio.xlsx',
            'NSBAcontrolbottom_ratio.xlsx',
            'NSBAcontroltoplie_ratio.xlsx']

for ipath in range(len(path)):
    files = os.listdir(paths[ipath]) # sort according to numbers
    files.sort(key=lambda x: int(x[:-3]))

    ratio = pd.DataFrame(np.zeros((bounds[ipath][1]-bounds[ipath][0]+1, len(files))))
    for ifile in range(len(files)):
        data = pd.read_csv(paths[ipath]+'/'+files[ifile], header=None, names=['time', 'C', 'Se'], skiprows=2)
        data_trimmed = data[bounds[ipath][0]-1:bounds[ipath][1]]
        ratio.loc[:, ifile] = data_trimmed['Se'].values/data_trimmed['C'].values

    ratio.to_excel(outfiles[ipath], header=False, index=False)

简单是挺简单的,但是缺点不少。循环都只是用数字实现的,代码里有很多的循环变量,不易读。整体复用性也不高,难以修改。后续如果还要进行相同的数据处理就很麻烦。

修改后

参考上面的范例修改之后:

import os
import pandas as pd
import numpy as np
# 这部分是全局变量
paths = [r'./NSBA2ppm',
       r'./NSBA20ppm',
       r'./NSBAcontrolbottom',
       r'./NSBAcontroltoplie']

bounds = [[180, 3060], [190, 1130], [190, 1600], [180, 1200]]

outfiles = ['NSBA2ppm_ratio.xlsx',
           'NSBA20ppm_ratio.xlsx',
           'NSBAcontrolbottom_ratio.xlsx',
           'NSBAcontroltoplie_ratio.xlsx']

def get_files(path):
   '''
   get all filenames under path 
   sort according to numbers
   '''  
   files = os.listdir(path) 
   files.sort(key=lambda x: int(x[:-3]))  # ignore ".xl"
   return files

def read_data(path, file):
   '''
   read data from path/file
   '''
   data = pd.read_csv(path+'/'+file, header=None, names=['time', 'C', 'Se'], skiprows=2)
   return data   

def cal_ratio(data, bound):
   '''
   trim data according to bound, and calculate ratio of Se to C
   '''
   data_trimmed = data[bound[0]-1:bound[1]]
   ratio = data_trimmed['Se'].values/data_trimmed['C'].values
   return ratio

def print_ratio(ratio, outfile):
   '''print results'''
   ratio.to_excel(outfile, header=False, index=False)
   return()

def main():
   for path, bound, outfile in zip(paths, bounds, outfiles):
       files = get_files(path)
       ratio = pd.DataFrame(np.zeros((bound[1]-bound[0]+1, len(files))), columns=files)
       for file in files:
           data = read_data(path, file)
           ratio.loc[:, file] = cal_ratio(data, bound)
       print_ratio(ratio, outfile)

if __name__ == '__main__':
   main()

输出的文档:


output.png

虽然变长了很多,但各个模块功能一目了然。深刻地感受到模块化编程的优势~

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容