1
# Backport of OrderedDict() class that runs on Python 2.4, 2.5, 2.6, 2.7 and pypy.
2
# Passes Python2.7's test suite and incorporates all the latest updates.
3
# Copyright 2009 Raymond Hettinger, released under the MIT License.
4
# http://code.activestate.com/recipes/576693/
7
from thread import get_ident as _get_ident
9
from dummy_thread import get_ident as _get_ident
12
from _abcoll import KeysView, ValuesView, ItemsView
17
class OrderedDict(dict):
18
'Dictionary that remembers insertion order'
19
# An inherited dict maps keys to values.
20
# The inherited dict provides __getitem__, __len__, __contains__, and get.
21
# The remaining methods are order-aware.
22
# Big-O running times for all methods are the same as for regular dictionaries.
24
# The internal self.__map dictionary maps keys to links in a doubly linked list.
25
# The circular doubly linked list starts and ends with a sentinel element.
26
# The sentinel element never gets deleted (this simplifies the algorithm).
27
# Each link is stored as a list of length three: [PREV, NEXT, KEY].
29
def __init__(self, *args, **kwds):
30
'''Initialize an ordered dictionary. Signature is the same as for
31
regular dictionaries, but keyword arguments are not recommended
32
because their insertion order is arbitrary.
36
raise TypeError('expected at most 1 arguments, got %d' % len(args))
39
except AttributeError:
40
self.__root = root = [] # sentinel node
41
root[:] = [root, root, None]
43
self.__update(*args, **kwds)
45
def __setitem__(self, key, value, dict_setitem=dict.__setitem__):
46
'od.__setitem__(i, y) <==> od[i]=y'
47
# Setting a new item creates a new link which goes at the end of the linked
48
# list, and the inherited dictionary is updated with the new key/value pair.
52
last[1] = root[0] = self.__map[key] = [last, root, key]
53
dict_setitem(self, key, value)
55
def __delitem__(self, key, dict_delitem=dict.__delitem__):
56
'od.__delitem__(y) <==> del od[y]'
57
# Deleting an existing item uses self.__map to find the link which is
58
# then removed by updating the links in the predecessor and successor nodes.
59
dict_delitem(self, key)
60
link_prev, link_next, key = self.__map.pop(key)
61
link_prev[1] = link_next
62
link_next[0] = link_prev
65
'od.__iter__() <==> iter(od)'
68
while curr is not root:
72
def __reversed__(self):
73
'od.__reversed__() <==> reversed(od)'
76
while curr is not root:
81
'od.clear() -> None. Remove all items from od.'
83
for node in self.__map.itervalues():
86
root[:] = [root, root, None]
88
except AttributeError:
92
def popitem(self, last=True):
93
'''od.popitem() -> (k, v), return and remove a (key, value) pair.
94
Pairs are returned in LIFO order if last is true or FIFO order if false.
98
raise KeyError('dictionary is empty')
112
value = dict.pop(self, key)
115
# -- the following methods do not depend on the internal structure --
118
'od.keys() -> list of keys in od'
122
'od.values() -> list of values in od'
123
return [self[key] for key in self]
126
'od.items() -> list of (key, value) pairs in od'
127
return [(key, self[key]) for key in self]
130
'od.iterkeys() -> an iterator over the keys in od'
133
def itervalues(self):
134
'od.itervalues -> an iterator over the values in od'
139
'od.iteritems -> an iterator over the (key, value) items in od'
143
def update(*args, **kwds):
144
'''od.update(E, **F) -> None. Update od from dict/iterable E and F.
146
If E is a dict instance, does: for k in E: od[k] = E[k]
147
If E has a .keys() method, does: for k in E.keys(): od[k] = E[k]
148
Or if E is an iterable of items, does: for k, v in E: od[k] = v
149
In either case, this is followed by: for k, v in F.items(): od[k] = v
153
raise TypeError('update() takes at most 2 positional '
154
'arguments (%d given)' % (len(args),))
156
raise TypeError('update() takes at least 1 argument (0 given)')
158
# Make progressively weaker assumptions about "other"
162
if isinstance(other, dict):
164
self[key] = other[key]
165
elif hasattr(other, 'keys'):
166
for key in other.keys():
167
self[key] = other[key]
169
for key, value in other:
171
for key, value in kwds.items():
174
__update = update # let subclasses override update without breaking __init__
178
def pop(self, key, default=__marker):
179
'''od.pop(k[,d]) -> v, remove specified key and return the corresponding value.
180
If key is not found, d is returned if given, otherwise KeyError is raised.
187
if default is self.__marker:
191
def setdefault(self, key, default=None):
192
'od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od'
198
def __repr__(self, _repr_running={}):
199
'od.__repr__() <==> repr(od)'
200
call_key = id(self), _get_ident()
201
if call_key in _repr_running:
203
_repr_running[call_key] = 1
206
return '%s()' % (self.__class__.__name__,)
207
return '%s(%r)' % (self.__class__.__name__, self.items())
209
del _repr_running[call_key]
211
def __reduce__(self):
212
'Return state information for pickling'
213
items = [[k, self[k]] for k in self]
214
inst_dict = vars(self).copy()
215
for k in vars(OrderedDict()):
216
inst_dict.pop(k, None)
218
return (self.__class__, (items,), inst_dict)
219
return self.__class__, (items,)
222
'od.copy() -> a shallow copy of od'
223
return self.__class__(self)
226
def fromkeys(cls, iterable, value=None):
227
'''OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S
228
and values equal to v (which defaults to None).
236
def __eq__(self, other):
237
'''od.__eq__(y) <==> od==y. Comparison to another OD is order-sensitive
238
while comparison to a regular mapping is order-insensitive.
241
if isinstance(other, OrderedDict):
242
return len(self)==len(other) and self.items() == other.items()
243
return dict.__eq__(self, other)
245
def __ne__(self, other):
246
return not self == other
248
# -- the following methods are only used in Python 2.7 --
251
"od.viewkeys() -> a set-like object providing a view on od's keys"
252
return KeysView(self)
254
def viewvalues(self):
255
"od.viewvalues() -> an object providing a view on od's values"
256
return ValuesView(self)
259
"od.viewitems() -> a set-like object providing a view on od's items"
260
return ItemsView(self)
added
removed
urllib3/packages/ordered_dict.py
