python转行系列9：优先队列与__repr__方法

背景

         相比较于普通队列，优先队列赋予每个元素（节点）一个不同的优先级Priotity，优先级值越小，优先级越大。每次出列操作pop都会弹出优先级最高的元素。类似的C语句结构可能定义如下：

typedef struct _Item
{
    int data; //数据
    int prio; //优先级，值越小，优先级越高
}Item;
typedef struct _PNode
{
    Item item;
    struct _PNode *next;
}PNode, *PQueue;

其中：

1. 结构体Item表示具体元素，包括一个数据域和一个优先级域；
2. 结构体PNode表示对接节点，通过指针next相互链接
3. 现在，我们的需求是用python实现优先队列。

解决方案

         我们使用python自带的heapq模块（堆队列算法）。有关heapq的描述如下：

Heaps are arrays for which a[k] <= a[2*k+1] and a[k] <= a[2*k+2] for all k, counting elements from 0.  For the sake of comparison, non-existing elements are considered to be infinite. The interesting property of a heap is that a[0] is always its smallest element.

意思是说：堆是一种数组，对所有元素k（0 ~ N-1）都满足a[k] <= a[2*k+1]和 a[k] <= a[2*k+2]。这是一种小项堆的描述。数组的第一个元素a[0]永远是最小的。

源码

import heapq

class PriorityQueue:
    def __init__(self):
        self._queue=[]
        self._index=0
    def pop(self):
        return heapq.heappop(self._queue)[-1]

    def push(self, item, priotity):
        heapq.heappush(self._queue, (-priotity, self._index, item))
        self._index += 1
class Item:
    def __init__(self, name):
        self.name = name

    # 返回一个可以用来表示对象的可打印字符串
    def __repr__(self):
        return 'Item({!r})'.format(self.name)

def PriorityQueue_test():
    Que = PriorityQueue()
    Que.push(Item('aaa'), 1)
    Que.push(Item('bbb'), 2)
    Que.push(Item('ccc'), 5)
    Que.push(Item('ddd'), 4)
    print(Que._queue)
    first = Que.pop()
    print(first)
    second = Que.pop()
    print(second)
    print(Que._queue)

if __name__ == "__main__":
    PriorityQueue_test()

源码解释

1. 类PriorityQueue定义了变量_queue（列表）和_index，_queue用于保存队列元素；
2. pop方法调用heapq模块的heappop方法返回列表的第一个元素（最小的元组），加[-1]表示获取元组的最后一项；
3. push方法需要两个参数，一个是元素，一个是元素的优先级。实现内部将元素拼装成元组heappush进列表，然后将索引加1；
4. push中将原始优先级取负号，用于将值最大的元素方法堆的最前面。（之前说过，值越大，优先级越小）；
5. 元素的比较是对元组的各个成员的比较，加入索引也是为了比较。
6. 类Item重载了__repr__方法，用于返回一个可以用于打印的字符串，也就是'Item(XXX)'。其中{!r}类似于c语言中的%s，将使用.format()替换；

测试

写一个测试方法，PriorityQueue_test，push了四个元素。尔后又pop了两次。为了查看列表内部布局，笔者还直接打印了类的私有变量。测试输出如下：

[(-5, 2, Item('ccc')), (-4, 3, Item('ddd')), (-2, 1, Item('bbb')), (-1, 0, Item('aaa'))]
Item('ccc')
Item('ddd')
[(-2, 1, Item('bbb')), (-1, 0, Item('aaa'))]

有此可以看出，低优先级最先出列，高优先级的元素aaa放在List的最后一个（相对于heapq来说，它是最大的）最后弹出。

总结

1. 学会使用heapq---堆算法；
2. 学会使用_repr__方法；
3. 学会元组的比较。

参考

         《python cookbook》1.6 “实现优先队列”