python中使用自定义类实例作为字典的key

python中dict类型的key值要求是不可变类型，通常来说，我们一般采用int或者str类型来作为字典的key，但是在某些场景中，会造成一定的麻烦。

如我们有一个处理http Request的规则类名为Rule，其定义如下，它由一个Request path和其支持的Request methods数组组成：

class Rule(object):

    def __init__(self, path, methods):
        assert(isinstance(path, str))
        assert(isinstance(methods, list))
        self.path = path
        self.methods = [method.upper() for method in methods]

现在我们想为每一种Rule（非每一个Rule实例）关联一个对应的Handler对象，使用一个dict来保存对应关系。

r1 = Rule("/index", ["GET"])
r2 = Rule("/index", ["GET"])
d = {r1: handler}
print d[r2]
# 两个不同的对象，打印出None

r1和r2虽然是两个不同的对象实例，但是在业务逻辑上是一致的，因此如果我们想让两个在逻辑上一致的对象被认为是同一个key，可以通过一些手段达到这个效果。

为Rule添加两个方法__hash__和__eq__，其意义可以查看python官方文档。

class Rule(object):

    def __init__(self, path, methods):
        assert(isinstance(path, str))
        assert(isinstance(methods, list))
        self.path = path
        self.methods = [method.upper() for method in methods]

    def __hash__(self):
        return hash((self.path, str(self.methods)))

    def __eq__(self, other):
        return (self.path, self.methods) == (other.path, other.methods)

然后再执行一下上面的测试代码，发现可以顺利取到handler了：

r1 = Rule("/index", ["GET"])
r2 = Rule("/index", ["GET"])
d = {r1: handler}
print d[r2] == handler# 打印出True