pImpl用法在Python的示例代码

1. 简介

pImpl是C++中非常常用的一种设计方法。在《推荐学习C++的一些书籍》一文中推荐了一本书，即《Exceptional C++》，其第四章（编译器防火墙和pimpl惯用法）就专门介绍了pimpl。

在软件测试自动化方面，通常基础库是用C++/C来开发，而上面用脚本语言（如Python）封装成函数。或者基础库用脚本语言的面向对象来开发，但最终提供给用户的是pure function。为什么这样处理呢？主要是降低测试人员对脚本语言的编程技能要求，所以去掉了语言的面向对象部分，而只需要掌握简单的函数使用方法即可。那么在这个过程中，也大量贯穿着pimpl的一些思想。

本文不对pimpl做详细的理论介绍，后面有机会通过C++进行说明。本文重点在于给出python中pimpl的简单示例代码。

——在python安装目录下，可以找到FileInput.py这个文件，该文件也是一个很好的pimpl示例。本文进一步简化，没有复杂的算法，仅聚焦于pimpl的基本思想。再者，我们并没有在两个class之间阐释pimpl，而是在pure function和class之间。可以想到，python中使用pimpl并不是要缩短编译时间（C++则很看重这一点），而是简化用户层代码的调用方法。

2. 示例代码

下面的代码用到了《Head First Design Pattern》开篇的鸭子示例的想法。

"""An example program used to show the pImpl pattern in Python.

Typical use is:
    import animator

    a = create("Tom")
    fly(a)
    jump(a)
    destroy(a)
"""

def create(name):
    o = Animator(name)
    return o

def fly(animator):
    animator.fly()

def jump(animator):
    animator.jump()

def destroy(animator):
    pass

class Animator(object):
    def __init__(self, name):
        self.name = name

    def fly(self):
        print "%s is flying..." % (self.name,)

    def jump(self):
        print "%s is jumping..." % (self.name,)

def _test():
    a = create("Tom")
    b = create("Jerry")
    fly(a)
    jump(b)
    fly(a)
    jump(b)
    fly(b)
    fly(b)
    jump(a)
    destroy(a)
    destroy(b)

def _test_class():
    print
    print "test the usage of class..."

    a = Animator("Tom")
    b = Animator("Jerry")
    a.fly()
    b.jump()
    a.fly()
    b.jump()
    b.fly()
    b.fly()
    a.jump()

if __name__ == '__main__':
    _test()
    _test_class()

3. 运行结果

D:\examples\python\pimpl>python animator.py
Tom is flying...
Jerry is jumping...
Tom is flying...
Jerry is jumping...
Jerry is flying...
Jerry is flying...
Tom is jumping...

test the usage of class...
Tom is flying...
Jerry is jumping...
Tom is flying...
Jerry is jumping...
Jerry is flying...
Jerry is flying...
Tom is jumping...

D:\examples\python\pimpl>

4. 说明

在示例代码中，我们对用户提供的是4个函数：create(), fly(), jump(), destory()，而不是class Animator。——尽管用户也的确可以直接使用class Animator，如同_test_class()所示。

可以看到，这种方法首先是一个初始化的函数，返回一个对象或ID；后续的函数都会有一个对象或ID作为入参。真正的实现代码，则放在class Animator中。——可以和C语言的文件操作相关的函数进行类比。