Commit 2412299b authored by Raymond Hettinger's avatar Raymond Hettinger

* Add clearer comment to initialization code.

* Add optional argument to popitem() -- modeled
  after Anthon van der Neut's C version.
* Fix method markup in docs.
parent a0b8d9ad
...@@ -858,8 +858,11 @@ the items are returned in the order their keys were first added. ...@@ -858,8 +858,11 @@ the items are returned in the order their keys were first added.
.. versionadded:: 2.7 .. versionadded:: 2.7
The :meth:`popitem` method for ordered dictionaries returns and removes the .. method:: OrderedDict.popitem(last=True)
last added entry. The key/value pairs are returned in LIFO order.
The :meth:`popitem` method for ordered dictionaries returns and removes
a (key, value) pair. The pairs are returned in LIFO order if *last* is
true or FIFO order if false.
Equality tests between :class:`OrderedDict` objects are order-sensitive Equality tests between :class:`OrderedDict` objects are order-sensitive
and are implemented as ``list(od1.items())==list(od2.items())``. and are implemented as ``list(od1.items())==list(od2.items())``.
...@@ -867,3 +870,8 @@ Equality tests between :class:`OrderedDict` objects and other ...@@ -867,3 +870,8 @@ Equality tests between :class:`OrderedDict` objects and other
:class:`Mapping` objects are order-insensitive like regular dictionaries. :class:`Mapping` objects are order-insensitive like regular dictionaries.
This allows :class:`OrderedDict` objects to be substituted anywhere a This allows :class:`OrderedDict` objects to be substituted anywhere a
regular dictionary is used. regular dictionary is used.
.. seealso::
`Equivalent OrderedDict recipe <http://code.activestate.com/recipes/576693/>`_
that runs on Python 2.4 or later.
...@@ -30,7 +30,7 @@ class OrderedDict(dict, MutableMapping): ...@@ -30,7 +30,7 @@ class OrderedDict(dict, MutableMapping):
def clear(self): def clear(self):
self.__end = end = [] self.__end = end = []
end += [None, end, end] # null entry end += [None, end, end] # sentinel node for doubly linked list
self.__map = {} # key --> [key, prev, next] self.__map = {} # key --> [key, prev, next]
dict.clear(self) dict.clear(self)
...@@ -61,10 +61,10 @@ class OrderedDict(dict, MutableMapping): ...@@ -61,10 +61,10 @@ class OrderedDict(dict, MutableMapping):
yield curr[0] yield curr[0]
curr = curr[1] curr = curr[1]
def popitem(self): def popitem(self, last=True):
if not self: if not self:
raise KeyError('dictionary is empty') raise KeyError('dictionary is empty')
key = next(reversed(self)) key = next(reversed(self)) if last else next(iter(self))
value = self.pop(key) value = self.pop(key)
return key, value return key, value
......
...@@ -768,12 +768,19 @@ class TestOrderedDict(unittest.TestCase): ...@@ -768,12 +768,19 @@ class TestOrderedDict(unittest.TestCase):
class GeneralMappingTests(mapping_tests.BasicTestMappingProtocol): class GeneralMappingTests(mapping_tests.BasicTestMappingProtocol):
type2test = OrderedDict type2test = OrderedDict
def test_popitem(self):
d = self._empty_mapping()
self.assertRaises(KeyError, d.popitem)
class MyOrderedDict(OrderedDict): class MyOrderedDict(OrderedDict):
pass pass
class SubclassMappingTests(mapping_tests.BasicTestMappingProtocol): class SubclassMappingTests(mapping_tests.BasicTestMappingProtocol):
type2test = MyOrderedDict type2test = MyOrderedDict
def test_popitem(self):
d = self._empty_mapping()
self.assertRaises(KeyError, d.popitem)
import doctest, collections import doctest, collections
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment