1
# Copyright (c) 2001-2011 Python Software Foundation
2
# 2011 Raymond Hettinger
3
# License: PYTHON SOFTWARE FOUNDATION LICENSE VERSION 2
4
# See http://www.opensource.org/licenses/Python-2.0 for full terms
5
# Note: backport changes by Raymond were originally distributed under MIT
6
# license, but since the original license for Python is more
7
# restrictive than MIT, code cannot be released under its terms and
8
# still adheres to the limitations of Python license.
10
# # {{{ http://code.activestate.com/recipes/576693/ (r9)
11
# Backport of OrderedDict() class that runs on Python 2.4, 2.5, 2.6, 2.7 and pypy.
12
# Passes Python2.7's test suite and incorporates all the latest updates.
15
from thread import get_ident as _get_ident
17
from dummy_thread import get_ident as _get_ident
20
from _abcoll import KeysView, ValuesView, ItemsView
25
class OrderedDict(dict):
26
'Dictionary that remembers insertion order'
27
# An inherited dict maps keys to values.
28
# The inherited dict provides __getitem__, __len__, __contains__, and get.
29
# The remaining methods are order-aware.
30
# Big-O running times for all methods are the same as for regular dictionaries.
32
# The internal self.__map dictionary maps keys to links in a doubly linked list.
33
# The circular doubly linked list starts and ends with a sentinel element.
34
# The sentinel element never gets deleted (this simplifies the algorithm).
35
# Each link is stored as a list of length three: [PREV, NEXT, KEY].
37
def __init__(self, *args, **kwds):
38
'''Initialize an ordered dictionary. Signature is the same as for
39
regular dictionaries, but keyword arguments are not recommended
40
because their insertion order is arbitrary.
44
raise TypeError('expected at most 1 arguments, got %d' % len(args))
47
except AttributeError:
48
self.__root = root = [] # sentinel node
49
root[:] = [root, root, None]
51
self.__update(*args, **kwds)
53
def __setitem__(self, key, value, dict_setitem=dict.__setitem__):
54
'od.__setitem__(i, y) <==> od[i]=y'
55
# Setting a new item creates a new link which goes at the end of the linked
56
# list, and the inherited dictionary is updated with the new key/value pair.
60
last[1] = root[0] = self.__map[key] = [last, root, key]
61
dict_setitem(self, key, value)
63
def __delitem__(self, key, dict_delitem=dict.__delitem__):
64
'od.__delitem__(y) <==> del od[y]'
65
# Deleting an existing item uses self.__map to find the link which is
66
# then removed by updating the links in the predecessor and successor nodes.
67
dict_delitem(self, key)
68
link_prev, link_next, key = self.__map.pop(key)
69
link_prev[1] = link_next
70
link_next[0] = link_prev
73
'od.__iter__() <==> iter(od)'
76
while curr is not root:
80
def __reversed__(self):
81
'od.__reversed__() <==> reversed(od)'
84
while curr is not root:
89
'od.clear() -> None. Remove all items from od.'
91
for node in self.__map.itervalues():
94
root[:] = [root, root, None]
96
except AttributeError:
100
def popitem(self, last=True):
101
'''od.popitem() -> (k, v), return and remove a (key, value) pair.
102
Pairs are returned in LIFO order if last is true or FIFO order if false.
106
raise KeyError('dictionary is empty')
120
value = dict.pop(self, key)
123
# -- the following methods do not depend on the internal structure --
126
'od.keys() -> list of keys in od'
130
'od.values() -> list of values in od'
131
return [self[key] for key in self]
134
'od.items() -> list of (key, value) pairs in od'
135
return [(key, self[key]) for key in self]
138
'od.iterkeys() -> an iterator over the keys in od'
141
def itervalues(self):
142
'od.itervalues -> an iterator over the values in od'
147
'od.iteritems -> an iterator over the (key, value) items in od'
151
def update(*args, **kwds):
152
'''od.update(E, **F) -> None. Update od from dict/iterable E and F.
154
If E is a dict instance, does: for k in E: od[k] = E[k]
155
If E has a .keys() method, does: for k in E.keys(): od[k] = E[k]
156
Or if E is an iterable of items, does: for k, v in E: od[k] = v
157
In either case, this is followed by: for k, v in F.items(): od[k] = v
161
raise TypeError('update() takes at most 2 positional '
162
'arguments (%d given)' % (len(args),))
164
raise TypeError('update() takes at least 1 argument (0 given)')
166
# Make progressively weaker assumptions about "other"
170
if isinstance(other, dict):
172
self[key] = other[key]
173
elif hasattr(other, 'keys'):
174
for key in other.keys():
175
self[key] = other[key]
177
for key, value in other:
179
for key, value in kwds.items():
182
__update = update # let subclasses override update without breaking __init__
186
def pop(self, key, default=__marker):
187
'''od.pop(k[,d]) -> v, remove specified key and return the corresponding value.
188
If key is not found, d is returned if given, otherwise KeyError is raised.
195
if default is self.__marker:
199
def setdefault(self, key, default=None):
200
'od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od'
206
def __repr__(self, _repr_running={}):
207
'od.__repr__() <==> repr(od)'
208
call_key = id(self), _get_ident()
209
if call_key in _repr_running:
211
_repr_running[call_key] = 1
214
return '%s()' % (self.__class__.__name__,)
215
return '%s(%r)' % (self.__class__.__name__, self.items())
217
del _repr_running[call_key]
219
def __reduce__(self):
220
'Return state information for pickling'
221
items = [[k, self[k]] for k in self]
222
inst_dict = vars(self).copy()
223
for k in vars(OrderedDict()):
224
inst_dict.pop(k, None)
226
return (self.__class__, (items,), inst_dict)
227
return self.__class__, (items,)
230
'od.copy() -> a shallow copy of od'
231
return self.__class__(self)
234
def fromkeys(cls, iterable, value=None):
235
'''OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S
236
and values equal to v (which defaults to None).
244
def __eq__(self, other):
245
'''od.__eq__(y) <==> od==y. Comparison to another OD is order-sensitive
246
while comparison to a regular mapping is order-insensitive.
249
if isinstance(other, OrderedDict):
250
return len(self) == len(other) and self.items() == other.items()
251
return dict.__eq__(self, other)
253
def __ne__(self, other):
254
return not self == other
256
# -- the following methods are only used in Python 2.7 --
259
"od.viewkeys() -> a set-like object providing a view on od's keys"
260
return KeysView(self)
262
def viewvalues(self):
263
"od.viewvalues() -> an object providing a view on od's values"
264
return ValuesView(self)
267
"od.viewitems() -> a set-like object providing a view on od's items"
268
return ItemsView(self)
269
# # end of http://code.activestate.com/recipes/576693/ }}}
added
removed
openpyxl/compat/odict.py
