《利用Python进行数据分析》 附录 B.4 使用IPython进行高效代码开发的技巧

附录B 更多IPython系统相关内容


B.4 使用IPython进行高效代码开发的技巧

对于很多用户来说,以易于开发、调试和最终交互使用的方式编写代码可能是一种习惯的改变。代码重新加载等程序细节可能需要一些调整以及编码风格方面的考虑。

因此,实现本节中所介绍的大多技巧更多的是艺术而不是科学,并且需要你进行一些实验来确定一种对你有效的Python代码编写方法。最终,你希望以易于迭代使用的方式构建代码,并能够尽可能轻松地探索程序或函数运行的结果。我发现使用IPython设计的软件比仅用作独立命令行应用程序的代码更易于使用。这一点变得尤为重要,特别是出现了问题使你不得不对程序中你自己或别人在数月或数年前写的代码进行检查的时候。


B.4.1 重载模块依赖项

在Python中,当你输入import some_lib时,some_lib中的代码将被执行,并且所有定义的变量、函数和导入都将存储在新创建的some_lib模块命名空间中。之后你再输入import some_lib时,你将获得对现有模块命名空间的引用。在交互式IPython代码开发中可能会遇到潜在的困难,比如当你以%run命令运行一个依赖于其他模块的脚本,而依赖的模块你可能已经做了修改的时候。假设我在test_script.py中有以下代码:

import some_lib
x = 5
y = [1, 2, 3, 4]
result = some_lib.get_answer(x, y)

如果要执行%run test_script.py,然后修改some_lib.py,则下次执行%run test_script.py时,由于Python模块系统是“一次加载”的,你仍然会得到旧版本的some_lib.py。这种行为不同于其他数据分析环境,如MATLAB,它会自动传播代码的变更。为了解决这个问题,你有几个选择。

  • 第一种方法是在标准库的importlib模块中使用reload函数:5
import some_lib
import importlib
importlib.reload(some_lib)

上面的代码保证你每次运行test_script.py时都会得到一个新的some_lib.py副本。显然,如果依赖关系变得更深,那么在整个地方插入reload的用法可能有点棘手。对于这个问题,IPython有一个特殊的dreload函数(不是一个魔术函数),用于模块的“深层”(递归)重载。如果我要运行some_lib.py然后输入dreload(some_lib),它将尝试重新加载some_lib及其所有依赖项。不幸的是,并不是所有的情况下都有效,时候不得不重新启动IPython。


B.4.2 代码设计技巧

这里并没有什么简单的方法,但是有一些高级的准则,这些准则是我在自己工作中发现的。


B.4.2.1 保持相关对象和数据的存在

看到结构有点像下面这个简单的例子的命令行代码并不罕见:

from my_functions import g
def f(x, y):
    return g(x + y)
def main():
    x = 6
    y = 7.5
    result = x + y
if __name__ == '__main__':
    main()

如果我们要在IPython中运行该程序,你觉得什么地方可能会出错?完成后,在main函数中定义的结果或对象都不会在如果我要运行some_lib.py然后输入dreload(some_lib),它将尝试重新加载some_lib及其所有依赖项。不幸的是,并不是所有的情况下都有效,时候不得不重新启动IPython。


B.4.2 代码设计技巧

这里并没有什么简单的方法,但是有一些高级的准则,这些准则是我在自己工作中发现的。


B.4.2.1 保持相关对象和数据的存在

看到结构有点像下面这个简单的例子的命令行代码并不罕见:

from my_functions import g
def f(x, y):
    return g(x + y)
def main():
    x = 6
    y = 7.5
    result = x + y
if __name__ == '__main__':
    main()

如果我们要在IPython中运行该程序,你觉得什么地方可能会出错?完成后,在main函数中定义的结果或对象都不会在IPython shell中访问。更好的方法是直接在模块的全局命名空间中,执行main中所有代码(如果你想要让模块也变得可导入的话,则在if__name__=='main':代码块中执行)。这样,当你运行代码时,你就能够看到main中定义的所有变量。这种方式和在Jupyter notebook中在代码单元内定义顶层变量的方式是等价的。


B.4.2.2 扁平优于嵌套

深度嵌套的代码让我联想到洋葱一层层的皮。在测试或调试某个功能时,为了达到感兴趣的代码,必须剥下多少层洋葱?”扁平优于嵌套“的观念是Python之禅的一部分,开发交互式代码的时候这种观念依然有用。使函数和类尽可能地解耦并模块化,可以使得它们更易于测试(如果你正在编写单元测试)、调试以及交互式使用。


B.4.2.3 克服对长文件的恐惧

如果你有Java背景(或者其他什么语言),你可能已经知道要保持文件短小。在很多语言中,这听起来只是个建议,冗长通常是一种不好的"代码味道",这表明重构和重组可能是必要的。但是,在使用IPython开发代码的同时,使用10个小但内部关联的文件(每个文件不超过100行)比两三个更长的文件可能会让你感到更加头痛。更少的文件意味着更少的模块重新加载,并且在编辑时也减少了文件之间的跳跃。我发现维护更大的模块,使每个模块都具有很高的内部凝聚力,更加有用也更加Pythonic。向解决方案进行迭代之后,有时候将较大的文件重构为较小的文件是有意义的。
显然,我不支持将这个论点推向极端,这将会把你的所有代码放在一个单一的怪异


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

推荐阅读更多精彩内容