summaryrefslogtreecommitdiff
path: root/collect/bidict.py
blob: 1fa66dc81fe6bd64e16b80a8fa49bea7502c46db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
#!/usr/bin/env python3

class bidict(dict):
    def __init__(self, *args, **kwargs):
        """
        A class that stores both a Mapping between keys and values and
        also the inverse mapping between values and their keys to
        allow for efficient lookups in either direction.  Because it
        is possible to have several keys with the same value, using
        the inverse map returns a sequence of keys.

        >>> d = bidict()
        >>> d['a'] = 1
        >>> d['b'] = 2
        >>> d['c'] = 2
        >>> d['a']
        1
        >>> d.inverse[1]
        ['a']
        >>> d.inverse[2]
        ['b', 'c']
        >>> len(d)
        3
        >>> del d['c']
        >>> len(d)
        2
        >>> d.inverse[2]
        ['b']

        """
        super().__init__(*args, **kwargs)
        self.inverse = {}
        for key, value in self.items():
            self.inverse.setdefault(value, []).append(key)

    def __setitem__(self, key, value):
        if key in self:
            old_value = self[key]
            self.inverse[old_value].remove(key)
        super().__setitem__(key, value)
        self.inverse.setdefault(value, []).append(key)

    def __delitem__(self, key):
        value = self[key]
        self.inverse.setdefault(value, []).remove(key)
        if value in self.inverse and not self.inverse[value]:
            del self.inverse[value]
        super().__delitem__(key)


if __name__ == '__main__':
    import doctest
    doctest.testmod()