Python 编程中的反模式

  • 曹知渊

2014 年 7 月 14 日

话题:Python语言 & 开发架构

Python 是时下最热门的编程语言之一了。简洁而富有表达力的语法,两三行代码往往就能解决十来行 C 代码才能解决的问题;丰富的标准库和第三方库,大大节约了开发时间,使它成为那些对性能没有严苛要求的开发任务的首选;强大而活跃的社区,齐全的文档,也使很多编程的初学者选择了它作为自己的第一门编程语言。甚至有国外的报道称,Python 已经成为了美国顶尖大学里最受欢迎的编程入门教学语言。


要学好一门编程语言实属不易,在初学阶段,就纠正一些错误的做法,对今后的深入学习至关重要。有一位叫Constantine Lignos的博主,他是宾夕法尼亚儿童医院放射研究部门的博士后研究员,他最近撰写了一篇很有意义的文章,列举了初学 Python 的学生们最常犯的错误,并对这些错误进行了分类和剖析,其内容提纲挈领,非常值得每个 Python 初学者学习。

这篇文章给出了一些在 Python 初学者中很常见的反模式,反模式通常是指那些不符合习惯或者会导致糟糕后果的用法。Lignos 把他总结的反模式分成了四大类——迭代、性能、变量的漏洞和编程风格。下面我们逐一来看一个例子,理解这些反模式到底“反”在什么地方。

迭代

当我们需要简单迭代一个数量范围的时候,Python 给了我们一个非常好用的函数:range。Lignos 观察到有些初学者喜欢用 range 来迭代列表的下表,像下面这种形式:

for i in range(len(alist)):
    print alist[i]

这代码现在还没什么问题,但已经不符合 Python 的习惯了。但下面的代码就有问题了:

alist = ['her', 'name', 'is', 'rio']
for i in range(0, len(alist) - 1): # 漏掉了最后一个 
    print i, alist[i]

我们可以看一下 Python 官方文档 range 的示例

>>> range(1, 11)
[1, 2, 3, 4, 5, 6, 7, 8, 9, 10]

range 的右区间是不包含在内的,如果受了直觉或其他编程语言的影响,再减 1 就不对了。Lignos 还列举了其他几种错误的迭代模式,我们只要记住,range 应该用在迭代一个数量范围。

性能

Lignos 给出了两段代码:

lyrics_list = ['her', 'name', 'is', 'rio']
words = make_wordlist()
for word in words:
    if word in lyrics_list: # 线性时间 
        print word, "is in the lyrics"

lyrics_set = set(lyrics_list)
words = make_wordlist()
for word in words:
    if word in lyrics_set: # 常数时间 
        print word, "is in the lyrics"

哪种模式效率更高?Lignos 注释已经给出了答案。注释的意思是,判断一个元素是否在一组元素中存在,使用 list 的算法复杂度是 O(n),而使用 set 的算法复杂度是 O(1)。那是否 set 永远是优于 list?在其他情况下,应该用哪个数据结构?Python 官方 Wiki 有一份专门各个数据结构操作的时间复杂度的文档供参考,知道参考这份文档比答案本身更重要。至于为什么,只有 Python 的源码才能告诉我们。

变量的漏洞

初学者往往会假设一些不该假设的前提,对一些异常流程考虑不周。Lignos 也给了一个例子:

for idx, value in enumerate(y):
    if value > max_value:
        break
processList(y, idx)

这里 y 如果是空的,那就出问题了,因为 idx 根本得不到定义,最终我们会得到一个 NameError 的异常。比较好的做法是给 idx 一个默认的错误值,在 C 语言里面我们经常喜欢用 -1。下面的代码就考虑得比较全面:

def find_item(item, alist):
    # 对 Python 来说 None 比 -1 可能更好点 
    result = -1
    for idx, other_item in enumerate(alist):
        if other_item == item:
            result = idx
            break
    return result

代码风格

Python 有一份代码风格指导文档PEP 8,这些规则都是有道理的。当初学者不明白为什么的时候,最好的做法就是尽量遵守它,等到有更深入的理解了就会豁然开朗,同事也会明白什么时候可以打破规则。Lignos 引用了这份文档的一些例子,比如,如何测试一个变量是否为空,如果测试一个变量是否为 None 等等。


以上分析了这篇文章中的一些例子,如果希望全面了解,请查看原文。想要学好一门编程语言,学会语法是远远不够的,必须逐步理解语言所依赖的 CPU 体系结构、编译器 / 解释器 / 虚拟机等内容。Lignos 这篇文章虽然没有深入剖析 Python 的实现,但是对于入门者的帮助是非常明显的,当初学者有了一定经验后,对一些问题都可以做深入挖掘,引出 Python 实现层面的问题。

Python语言 & 开发架构