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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
# -*- coding: utf-8 -*-
# -----------------------------------------------------------------------------
# Gettings Things Gnome! - a personal organizer for the GNOME desktop
# Copyright (c) 2008-2009 - Lionel Dricot & Bertrand Rousseau
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, see <http://www.gnu.org/licenses/>.
# -----------------------------------------------------------------------------
'''
Contains TwoKeyDict, a Dictionary which also has a secondary key
'''
from GTG.tools.bidict import BiDict
class TwoKeyDict(object):
'''
It's a standard Dictionary with a secondary key.
For example, you can add an element ('2', 'II', two'), where the
first two arguments are keys and the third is the stored object, and access
it as:
twokey['2'] ==> 'two'
twokey['II'] ==> 'two'
You can also request the other key, given one.
Function calls start with _ because you'll probably want to rename them when
you use this dictionary, for the sake of clarity.
'''
def __init__(self, *triplets):
'''
Creates the TwoKeyDict and optionally populates it with some data
@oaram triplets: tuples for populating the TwoKeyDict. Format:
((key1, key2, data_to_store), ...)
'''
super(TwoKeyDict, self).__init__()
self._key_to_key_bidict = BiDict()
self._primary_to_value = {}
for triplet in triplets:
self.add(triplet)
def add(self, triplet):
'''
Adds a new triplet to the TwoKeyDict
@param triplet: a tuple formatted like this:
(key1, key2, data_to_store)
'''
self._key_to_key_bidict.add((triplet[0], triplet[1]))
self._primary_to_value[triplet[0]] = triplet[2]
def _get_by_primary(self, primary):
'''
Gets the stored data given the primary key
@param primary: the primary key
@returns object: the stored object
'''
return self._primary_to_value[primary]
def _get_by_secondary(self, secondary):
'''
Gets the stored data given the secondary key
@param secondary: the primary key
@returns object: the stored object
'''
primary = self._key_to_key_bidict._get_by_second(secondary)
return self._get_by_primary(primary)
def _remove_by_primary(self, primary):
'''
Removes a triplet given the rpimary key.
@param primary: the primary key
'''
del self._primary_to_value[primary]
self._key_to_key_bidict._remove_by_first(primary)
def _remove_by_secondary(self, secondary):
'''
Removes a triplet given the rpimary key.
@param secondary: the primary key
'''
primary = self._key_to_key_bidict._get_by_second(secondary)
self._remove_by_primary(primary)
def _get_secondary_key(self, primary):
'''
Gets the secondary key given the primary
@param primary: the primary key
@returns object: the secondary key
'''
return self._key_to_key_bidict._get_by_first(primary)
def _get_primary_key(self, secondary):
'''
Gets the primary key given the secondary
@param secondary: the secondary key
@returns object: the primary key
'''
return self._key_to_key_bidict._get_by_second(secondary)
def _get_all_primary_keys(self):
'''
Returns all primary keys
@returns list: list of all primary keys
'''
return self._key_to_key_bidict._get_all_first()
def _get_all_secondary_keys(self):
'''
Returns all secondary keys
@returns list: list of all secondary keys
'''
return self._key_to_key_bidict._get_all_second()
|