martINI: martini/odict.py annotate

author	Jeff Hammel <jhammel@mozilla.com>
date	Wed, 24 Nov 2010 11:05:40 -0800
parents
children	4faed08eb8d8

rev	line source
8 81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	1 # odict.py
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	2 # An Ordered Dictionary object
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	3 # Copyright (C) 2005 Nicola Larosa, Michael Foord
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	4 # E-mail: nico AT tekNico DOT net, fuzzyman AT voidspace DOT org DOT uk
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	5
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	6 # This software is licensed under the terms of the BSD license.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	7 # http://www.voidspace.org.uk/python/license.shtml
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	8 # Basically you're free to copy, modify, distribute and relicense it,
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	9 # So long as you keep a copy of the license with it.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	10
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	11 # Documentation at http://www.voidspace.org.uk/python/odict.html
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	12 # For information about bugfixes, updates and support, please join the
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	13 # Pythonutils mailing list:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	14 # http://groups.google.com/group/pythonutils/
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	15 # Comments, suggestions and bug reports welcome.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	16
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	17 """A dict that keeps keys in insertion order"""
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	18 from __future__ import generators
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	19
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	20 __author__ = ('Nicola Larosa <nico-NoSp@m-tekNico.net>,'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	21 'Michael Foord <fuzzyman AT voidspace DOT org DOT uk>')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	22
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	23 __docformat__ = "restructuredtext en"
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	24
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	25 __revision__ = '$Id: odict.py 129 2005-09-12 18:15:28Z teknico $'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	26
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	27 __version__ = '0.2.2'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	28
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	29 __all__ = ['OrderedDict', 'SequenceOrderedDict']
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	30
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	31 import sys
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	32 INTP_VER = sys.version_info[:2]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	33 if INTP_VER < (2, 2):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	34 raise RuntimeError("Python v.2.2 or later required")
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	35
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	36 import types, warnings
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	37
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	38 class OrderedDict(dict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	39 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	40 A class of dictionary that keeps the insertion order of keys.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	41
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	42 All appropriate methods return keys, items, or values in an ordered way.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	43
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	44 All normal dictionary methods are available. Update and comparison is
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	45 restricted to other OrderedDict objects.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	46
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	47 Various sequence methods are available, including the ability to explicitly
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	48 mutate the key ordering.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	49
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	50 __contains__ tests:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	51
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	52 >>> d = OrderedDict(((1, 3),))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	53 >>> 1 in d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	54 1
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	55 >>> 4 in d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	56 0
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	57
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	58 __getitem__ tests:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	59
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	60 >>> OrderedDict(((1, 3), (3, 2), (2, 1)))[2]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	61 1
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	62 >>> OrderedDict(((1, 3), (3, 2), (2, 1)))[4]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	63 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	64 KeyError: 4
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	65
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	66 __len__ tests:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	67
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	68 >>> len(OrderedDict())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	69 0
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	70 >>> len(OrderedDict(((1, 3), (3, 2), (2, 1))))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	71 3
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	72
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	73 get tests:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	74
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	75 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	76 >>> d.get(1)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	77 3
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	78 >>> d.get(4) is None
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	79 1
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	80 >>> d.get(4, 5)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	81 5
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	82 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	83 OrderedDict([(1, 3), (3, 2), (2, 1)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	84
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	85 has_key tests:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	86
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	87 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	88 >>> d.has_key(1)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	89 1
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	90 >>> d.has_key(4)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	91 0
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	92 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	93
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	94 def __init__(self, init_val=(), strict=False):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	95 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	96 Create a new ordered dictionary. Cannot init from a normal dict,
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	97 nor from kwargs, since items order is undefined in those cases.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	98
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	99 If the ``strict`` keyword argument is ``True`` (``False`` is the
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	100 default) then when doing slice assignment - the ``OrderedDict`` you are
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	101 assigning from must not contain any keys in the remaining dict.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	102
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	103 >>> OrderedDict()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	104 OrderedDict([])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	105 >>> OrderedDict({1: 1})
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	106 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	107 TypeError: undefined order, cannot get items from dict
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	108 >>> OrderedDict({1: 1}.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	109 OrderedDict([(1, 1)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	110 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	111 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	112 OrderedDict([(1, 3), (3, 2), (2, 1)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	113 >>> OrderedDict(d)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	114 OrderedDict([(1, 3), (3, 2), (2, 1)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	115 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	116 self.strict = strict
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	117 dict.__init__(self)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	118 if isinstance(init_val, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	119 self._sequence = init_val.keys()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	120 dict.update(self, init_val)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	121 elif isinstance(init_val, dict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	122 # we lose compatibility with other ordered dict types this way
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	123 raise TypeError('undefined order, cannot get items from dict')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	124 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	125 self._sequence = []
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	126 self.update(init_val)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	127
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	128 ### Special methods ###
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	129
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	130 def __delitem__(self, key):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	131 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	132 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	133 >>> del d[3]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	134 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	135 OrderedDict([(1, 3), (2, 1)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	136 >>> del d[3]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	137 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	138 KeyError: 3
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	139 >>> d[3] = 2
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	140 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	141 OrderedDict([(1, 3), (2, 1), (3, 2)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	142 >>> del d[0:1]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	143 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	144 OrderedDict([(2, 1), (3, 2)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	145 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	146 if isinstance(key, types.SliceType):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	147 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	148 keys = self._sequence[key]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	149 for entry in keys:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	150 dict.__delitem__(self, entry)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	151 del self._sequence[key]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	152 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	153 # do the dict.__delitem__ first as it raises
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	154 # the more appropriate error
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	155 dict.__delitem__(self, key)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	156 self._sequence.remove(key)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	157
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	158 def __eq__(self, other):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	159 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	160 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	161 >>> d == OrderedDict(d)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	162 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	163 >>> d == OrderedDict(((1, 3), (2, 1), (3, 2)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	164 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	165 >>> d == OrderedDict(((1, 0), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	166 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	167 >>> d == OrderedDict(((0, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	168 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	169 >>> d == dict(d)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	170 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	171 >>> d == False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	172 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	173 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	174 if isinstance(other, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	175 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	176 # Generate both item lists for each compare
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	177 return (self.items() == other.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	178 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	179 return False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	180
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	181 def __lt__(self, other):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	182 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	183 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	184 >>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	185 >>> c < d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	186 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	187 >>> d < c
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	188 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	189 >>> d < dict(c)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	190 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	191 TypeError: Can only compare with other OrderedDicts
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	192 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	193 if not isinstance(other, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	194 raise TypeError('Can only compare with other OrderedDicts')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	195 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	196 # Generate both item lists for each compare
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	197 return (self.items() < other.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	198
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	199 def __le__(self, other):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	200 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	201 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	202 >>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	203 >>> e = OrderedDict(d)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	204 >>> c <= d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	205 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	206 >>> d <= c
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	207 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	208 >>> d <= dict(c)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	209 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	210 TypeError: Can only compare with other OrderedDicts
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	211 >>> d <= e
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	212 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	213 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	214 if not isinstance(other, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	215 raise TypeError('Can only compare with other OrderedDicts')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	216 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	217 # Generate both item lists for each compare
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	218 return (self.items() <= other.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	219
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	220 def __ne__(self, other):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	221 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	222 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	223 >>> d != OrderedDict(d)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	224 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	225 >>> d != OrderedDict(((1, 3), (2, 1), (3, 2)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	226 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	227 >>> d != OrderedDict(((1, 0), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	228 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	229 >>> d == OrderedDict(((0, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	230 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	231 >>> d != dict(d)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	232 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	233 >>> d != False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	234 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	235 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	236 if isinstance(other, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	237 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	238 # Generate both item lists for each compare
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	239 return not (self.items() == other.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	240 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	241 return True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	242
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	243 def __gt__(self, other):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	244 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	245 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	246 >>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	247 >>> d > c
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	248 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	249 >>> c > d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	250 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	251 >>> d > dict(c)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	252 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	253 TypeError: Can only compare with other OrderedDicts
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	254 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	255 if not isinstance(other, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	256 raise TypeError('Can only compare with other OrderedDicts')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	257 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	258 # Generate both item lists for each compare
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	259 return (self.items() > other.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	260
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	261 def __ge__(self, other):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	262 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	263 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	264 >>> c = OrderedDict(((0, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	265 >>> e = OrderedDict(d)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	266 >>> c >= d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	267 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	268 >>> d >= c
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	269 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	270 >>> d >= dict(c)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	271 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	272 TypeError: Can only compare with other OrderedDicts
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	273 >>> e >= d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	274 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	275 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	276 if not isinstance(other, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	277 raise TypeError('Can only compare with other OrderedDicts')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	278 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	279 # Generate both item lists for each compare
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	280 return (self.items() >= other.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	281
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	282 def __repr__(self):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	283 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	284 Used for __repr__ and __str__
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	285
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	286 >>> r1 = repr(OrderedDict((('a', 'b'), ('c', 'd'), ('e', 'f'))))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	287 >>> r1
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	288 "OrderedDict([('a', 'b'), ('c', 'd'), ('e', 'f')])"
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	289 >>> r2 = repr(OrderedDict((('a', 'b'), ('e', 'f'), ('c', 'd'))))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	290 >>> r2
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	291 "OrderedDict([('a', 'b'), ('e', 'f'), ('c', 'd')])"
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	292 >>> r1 == str(OrderedDict((('a', 'b'), ('c', 'd'), ('e', 'f'))))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	293 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	294 >>> r2 == str(OrderedDict((('a', 'b'), ('e', 'f'), ('c', 'd'))))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	295 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	296 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	297 return '%s([%s])' % (self.__class__.__name__, ', '.join(
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	298 ['(%r, %r)' % (key, self[key]) for key in self._sequence]))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	299
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	300 def __setitem__(self, key, val):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	301 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	302 Allows slice assignment, so long as the slice is an OrderedDict
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	303 >>> d = OrderedDict()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	304 >>> d['a'] = 'b'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	305 >>> d['b'] = 'a'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	306 >>> d[3] = 12
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	307 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	308 OrderedDict([('a', 'b'), ('b', 'a'), (3, 12)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	309 >>> d[:] = OrderedDict(((1, 2), (2, 3), (3, 4)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	310 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	311 OrderedDict([(1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	312 >>> d[::2] = OrderedDict(((7, 8), (9, 10)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	313 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	314 OrderedDict([(7, 8), (2, 3), (9, 10)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	315 >>> d = OrderedDict(((0, 1), (1, 2), (2, 3), (3, 4)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	316 >>> d[1:3] = OrderedDict(((1, 2), (5, 6), (7, 8)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	317 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	318 OrderedDict([(0, 1), (1, 2), (5, 6), (7, 8), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	319 >>> d = OrderedDict(((0, 1), (1, 2), (2, 3), (3, 4)), strict=True)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	320 >>> d[1:3] = OrderedDict(((1, 2), (5, 6), (7, 8)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	321 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	322 OrderedDict([(0, 1), (1, 2), (5, 6), (7, 8), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	323
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	324 >>> a = OrderedDict(((0, 1), (1, 2), (2, 3)), strict=True)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	325 >>> a[3] = 4
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	326 >>> a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	327 OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	328 >>> a[::1] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	329 >>> a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	330 OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	331 >>> a[:2] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4), (4, 5)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	332 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	333 ValueError: slice assignment must be from unique keys
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	334 >>> a = OrderedDict(((0, 1), (1, 2), (2, 3)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	335 >>> a[3] = 4
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	336 >>> a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	337 OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	338 >>> a[::1] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	339 >>> a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	340 OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	341 >>> a[:2] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	342 >>> a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	343 OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	344 >>> a[::-1] = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	345 >>> a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	346 OrderedDict([(3, 4), (2, 3), (1, 2), (0, 1)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	347
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	348 >>> d = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	349 >>> d[:1] = 3
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	350 Traceback (most recent call last):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	351 TypeError: slice assignment requires an OrderedDict
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	352
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	353 >>> d = OrderedDict([(0, 1), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	354 >>> d[:1] = OrderedDict([(9, 8)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	355 >>> d
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	356 OrderedDict([(9, 8), (1, 2), (2, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	357 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	358 if isinstance(key, types.SliceType):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	359 if not isinstance(val, OrderedDict):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	360 # FIXME: allow a list of tuples?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	361 raise TypeError('slice assignment requires an OrderedDict')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	362 keys = self._sequence[key]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	363 # NOTE: Could use ``range(*key.indices(len(self._sequence)))``
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	364 indexes = range(len(self._sequence))[key]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	365 if key.step is None:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	366 # NOTE: new slice may not be the same size as the one being
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	367 # overwritten !
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	368 # NOTE: What is the algorithm for an impossible slice?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	369 # e.g. d[5:3]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	370 pos = key.start or 0
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	371 del self[key]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	372 newkeys = val.keys()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	373 for k in newkeys:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	374 if k in self:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	375 if self.strict:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	376 raise ValueError('slice assignment must be from '
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	377 'unique keys')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	378 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	379 # NOTE: This removes duplicate keys first
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	380 # so start position might have changed?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	381 del self[k]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	382 self._sequence = (self._sequence[:pos] + newkeys +
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	383 self._sequence[pos:])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	384 dict.update(self, val)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	385 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	386 # extended slice - length of new slice must be the same
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	387 # as the one being replaced
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	388 if len(keys) != len(val):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	389 raise ValueError('attempt to assign sequence of size %s '
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	390 'to extended slice of size %s' % (len(val), len(keys)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	391 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	392 del self[key]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	393 item_list = zip(indexes, val.items())
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	394 # smallest indexes first - higher indexes not guaranteed to
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	395 # exist
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	396 item_list.sort()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	397 for pos, (newkey, newval) in item_list:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	398 if self.strict and newkey in self:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	399 raise ValueError('slice assignment must be from unique'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	400 ' keys')
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	401 self.insert(pos, newkey, newval)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	402 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	403 if key not in self:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	404 self._sequence.append(key)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	405 dict.__setitem__(self, key, val)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	406
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	407 def __getitem__(self, key):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	408 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	409 Allows slicing. Returns an OrderedDict if you slice.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	410 >>> b = OrderedDict([(7, 0), (6, 1), (5, 2), (4, 3), (3, 4), (2, 5), (1, 6)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	411 >>> b[::-1]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	412 OrderedDict([(1, 6), (2, 5), (3, 4), (4, 3), (5, 2), (6, 1), (7, 0)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	413 >>> b[2:5]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	414 OrderedDict([(5, 2), (4, 3), (3, 4)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	415 >>> type(b[2:4])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	416 <class '__main__.OrderedDict'>
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	417 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	418 if isinstance(key, types.SliceType):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	419 # FIXME: does this raise the error we want?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	420 keys = self._sequence[key]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	421 # FIXME: efficiency?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	422 return OrderedDict([(entry, self[entry]) for entry in keys])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	423 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	424 return dict.__getitem__(self, key)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	425
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	426 __str__ = __repr__
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	427
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	428 def __setattr__(self, name, value):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	429 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	430 Implemented so that accesses to ``sequence`` raise a warning and are
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	431 diverted to the new ``setkeys`` method.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	432 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	433 if name == 'sequence':
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	434 warnings.warn('Use of the sequence attribute is deprecated.'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	435 ' Use the keys method instead.', DeprecationWarning)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	436 # NOTE: doesn't return anything
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	437 self.setkeys(value)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	438 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	439 # FIXME: do we want to allow arbitrary setting of attributes?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	440 # Or do we want to manage it?
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	441 object.__setattr__(self, name, value)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	442
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	443 def __getattr__(self, name):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	444 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	445 Implemented so that access to ``sequence`` raises a warning.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	446
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	447 >>> d = OrderedDict()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	448 >>> d.sequence
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	449 []
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	450 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	451 if name == 'sequence':
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	452 warnings.warn('Use of the sequence attribute is deprecated.'
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	453 ' Use the keys method instead.', DeprecationWarning)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	454 # NOTE: Still (currently) returns a direct reference. Need to
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	455 # because code that uses sequence will expect to be able to
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	456 # mutate it in place.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	457 return self._sequence
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	458 else:
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	459 # raise the appropriate error
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	460 raise AttributeError("OrderedDict has no '%s' attribute" % name)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	461
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	462 def __deepcopy__(self, memo):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	463 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	464 To allow deepcopy to work with OrderedDict.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	465
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	466 >>> from copy import deepcopy
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	467 >>> a = OrderedDict([(1, 1), (2, 2), (3, 3)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	468 >>> a['test'] = {}
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	469 >>> b = deepcopy(a)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	470 >>> b == a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	471 True
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	472 >>> b is a
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	473 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	474 >>> a['test'] is b['test']
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	475 False
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	476 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	477 from copy import deepcopy
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	478 return self.__class__(deepcopy(self.items(), memo), self.strict)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	479
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	480
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	481 ### Read-only methods ###
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	482
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	483 def copy(self):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	484 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	485 >>> OrderedDict(((1, 3), (3, 2), (2, 1))).copy()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	486 OrderedDict([(1, 3), (3, 2), (2, 1)])
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	487 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	488 return OrderedDict(self)
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	489
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	490 def items(self):
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	491 """
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	492 ``items`` returns a list of tuples representing all the
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	493 ``(key, value)`` pairs in the dictionary.
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	494
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	495 >>> d = OrderedDict(((1, 3), (3, 2), (2, 1)))
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	496 >>> d.items()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	497 [(1, 3), (3, 2), (2, 1)]
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	498 >>> d.clear()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	499 >>> d.items()
81aed4352851 make martini work with an ordered dictionary Jeff Hammel <jhammel@mozilla.com> parents: diff changeset	500 []

8

81aed4352851 make martini work with an ordered dictionary