diff --git a/Include/dictobject.h b/Include/dictobject.h --- a/Include/dictobject.h +++ b/Include/dictobject.h @@ -47,7 +47,6 @@ # define PyDictViewSet_Check(op) \ (PyDictKeys_Check(op) || PyDictItems_Check(op)) - PyAPI_FUNC(PyObject *) PyDict_New(void); PyAPI_FUNC(PyObject *) PyDict_GetItem(PyObject *mp, PyObject *key); PyAPI_FUNC(PyObject *) PyDict_GetItemWithError(PyObject *mp, PyObject *key); @@ -114,6 +113,39 @@ PyAPI_FUNC(void) _PyDict_DebugMallocStats(FILE *out); #endif +/* OrderedDict */ + +#ifndef Py_LIMITED_API + +typedef struct _odictobject PyODictObject; + +PyAPI_DATA(PyTypeObject) PyODict_Type; +PyAPI_DATA(PyTypeObject) PyODictIterKey_Type; +PyAPI_DATA(PyTypeObject) PyODictIterItem_Type; +PyAPI_DATA(PyTypeObject) PyODictIterValue_Type; +PyAPI_DATA(PyTypeObject) PyODictKeys_Type; +PyAPI_DATA(PyTypeObject) PyODictItems_Type; +PyAPI_DATA(PyTypeObject) PyODictValues_Type; + +#endif /* Py_LIMITED_API */ + +#define PyODict_Check(op) PyObject_IsInstance(op, (PyObject *)&PyODict_Type) +#define PyODict_CheckExact(op) (Py_TYPE(op) == &PyODict_Type) +#define PyODict_SIZE(op) ((PyDictObject *)op)->ma_used +#define PyODict_HasKey(od, key) (PyMapping_HasKey(PyObject *)od, key) + +PyAPI_FUNC(PyObject *) PyODict_New(void); +PyAPI_FUNC(int) PyODict_SetItem(PyObject *od, PyObject *key, PyObject *item); +PyAPI_FUNC(int) PyODict_DelItem(PyObject *od, PyObject *key); + +/* wrappers around PyDict* functions */ +#define PyODict_GetItem(od, key) PyDict_GetItem((PyObject *)od, key) +#define PyODict_Contains(od, key) PyDict_Contains((PyObject *)od, key) +#define PyODict_Size(od) PyDict_Size((PyObject *)od) +#define PyODict_GetItemString(od, key) \ + PyDict_GetItemString((PyObject *)od, key) +#define Py_ODict_GetItemId(od, key) _PyDict_GetItemId((PyObject *)od, key) + #ifdef __cplusplus } #endif diff --git a/Lib/collections/__init__.py b/Lib/collections/__init__.py --- a/Lib/collections/__init__.py +++ b/Lib/collections/__init__.py @@ -7,7 +7,6 @@ import collections.abc __all__ += collections.abc.__all__ -from _collections import deque, defaultdict from operator import itemgetter as _itemgetter, eq as _eq from keyword import iskeyword as _iskeyword import sys as _sys @@ -16,6 +15,17 @@ from itertools import repeat as _repeat, chain as _chain, starmap as _starmap from reprlib import recursive_repr as _recursive_repr +try: + from _collections import deque +except ImportError: + pass + +try: + from _collections import defaultdict +except ImportError: + pass + + ################################################################################ ### OrderedDict ################################################################################ @@ -44,6 +54,10 @@ their insertion order is arbitrary. ''' +# import sys +# frame = sys._getframe(1) +# print("{}, line {}".format(frame.f_globals['__file__'], frame.f_lineno)) +# raise Exception if len(args) > 1: raise TypeError('expected at most 1 arguments, got %d' % len(args)) try: @@ -60,6 +74,7 @@ 'od.__setitem__(i, y) <==> od[i]=y' # Setting a new item creates a new link at the end of the linked list, # and the inherited dictionary is updated with the new key/value pair. +# raise Exception if key not in self: self.__map[key] = link = Link() root = self.__root @@ -232,6 +247,13 @@ return dict.__eq__(self, other) +try: + from _collections import OrderedDict +except ImportError: +# raise Exception(OrderedDict.__dict__) + pass + + ################################################################################ ### namedtuple ################################################################################ diff --git a/Lib/test/test_collections.py b/Lib/test/test_collections.py --- a/Lib/test/test_collections.py +++ b/Lib/test/test_collections.py @@ -1,16 +1,15 @@ """Unit tests for collections.py.""" -import unittest, doctest, operator -from test.support import TESTFN, forget, unlink -import inspect +import unittest +import operator from test import support -from collections import namedtuple, Counter, OrderedDict, _count_elements -from test import mapping_tests -import pickle, copy -from random import randrange, shuffle +import pickle +import copy +from random import randrange import keyword import re import sys +from collections import namedtuple, Counter, OrderedDict, _count_elements from collections import UserDict from collections import ChainMap from collections.abc import Hashable, Iterable, Iterator @@ -1055,288 +1054,6 @@ ################################################################################ -### OrderedDict -################################################################################ - -class TestOrderedDict(unittest.TestCase): - - def test_init(self): - with self.assertRaises(TypeError): - OrderedDict([('a', 1), ('b', 2)], None) # too many args - pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5)] - self.assertEqual(sorted(OrderedDict(dict(pairs)).items()), pairs) # dict input - self.assertEqual(sorted(OrderedDict(**dict(pairs)).items()), pairs) # kwds input - self.assertEqual(list(OrderedDict(pairs).items()), pairs) # pairs input - self.assertEqual(list(OrderedDict([('a', 1), ('b', 2), ('c', 9), ('d', 4)], - c=3, e=5).items()), pairs) # mixed input - - # make sure no positional args conflict with possible kwdargs - self.assertEqual(inspect.getargspec(OrderedDict.__dict__['__init__']).args, - ['self']) - - # Make sure that direct calls to __init__ do not clear previous contents - d = OrderedDict([('a', 1), ('b', 2), ('c', 3), ('d', 44), ('e', 55)]) - d.__init__([('e', 5), ('f', 6)], g=7, d=4) - self.assertEqual(list(d.items()), - [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5), ('f', 6), ('g', 7)]) - - def test_update(self): - with self.assertRaises(TypeError): - OrderedDict().update([('a', 1), ('b', 2)], None) # too many args - pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5)] - od = OrderedDict() - od.update(dict(pairs)) - self.assertEqual(sorted(od.items()), pairs) # dict input - od = OrderedDict() - od.update(**dict(pairs)) - self.assertEqual(sorted(od.items()), pairs) # kwds input - od = OrderedDict() - od.update(pairs) - self.assertEqual(list(od.items()), pairs) # pairs input - od = OrderedDict() - od.update([('a', 1), ('b', 2), ('c', 9), ('d', 4)], c=3, e=5) - self.assertEqual(list(od.items()), pairs) # mixed input - - # Issue 9137: Named argument called 'other' or 'self' - # shouldn't be treated specially. - od = OrderedDict() - od.update(self=23) - self.assertEqual(list(od.items()), [('self', 23)]) - od = OrderedDict() - od.update(other={}) - self.assertEqual(list(od.items()), [('other', {})]) - od = OrderedDict() - od.update(red=5, blue=6, other=7, self=8) - self.assertEqual(sorted(list(od.items())), - [('blue', 6), ('other', 7), ('red', 5), ('self', 8)]) - - # Make sure that direct calls to update do not clear previous contents - # add that updates items are not moved to the end - d = OrderedDict([('a', 1), ('b', 2), ('c', 3), ('d', 44), ('e', 55)]) - d.update([('e', 5), ('f', 6)], g=7, d=4) - self.assertEqual(list(d.items()), - [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5), ('f', 6), ('g', 7)]) - - def test_abc(self): - self.assertIsInstance(OrderedDict(), MutableMapping) - self.assertTrue(issubclass(OrderedDict, MutableMapping)) - - def test_clear(self): - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - shuffle(pairs) - od = OrderedDict(pairs) - self.assertEqual(len(od), len(pairs)) - od.clear() - self.assertEqual(len(od), 0) - - def test_delitem(self): - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) - del od['a'] - self.assertNotIn('a', od) - with self.assertRaises(KeyError): - del od['a'] - self.assertEqual(list(od.items()), pairs[:2] + pairs[3:]) - - def test_setitem(self): - od = OrderedDict([('d', 1), ('b', 2), ('c', 3), ('a', 4), ('e', 5)]) - od['c'] = 10 # existing element - od['f'] = 20 # new element - self.assertEqual(list(od.items()), - [('d', 1), ('b', 2), ('c', 10), ('a', 4), ('e', 5), ('f', 20)]) - - def test_iterators(self): - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - shuffle(pairs) - od = OrderedDict(pairs) - self.assertEqual(list(od), [t[0] for t in pairs]) - self.assertEqual(list(od.keys()), [t[0] for t in pairs]) - self.assertEqual(list(od.values()), [t[1] for t in pairs]) - self.assertEqual(list(od.items()), pairs) - self.assertEqual(list(reversed(od)), - [t[0] for t in reversed(pairs)]) - - def test_popitem(self): - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - shuffle(pairs) - od = OrderedDict(pairs) - while pairs: - self.assertEqual(od.popitem(), pairs.pop()) - with self.assertRaises(KeyError): - od.popitem() - self.assertEqual(len(od), 0) - - def test_pop(self): - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - shuffle(pairs) - od = OrderedDict(pairs) - shuffle(pairs) - while pairs: - k, v = pairs.pop() - self.assertEqual(od.pop(k), v) - with self.assertRaises(KeyError): - od.pop('xyz') - self.assertEqual(len(od), 0) - self.assertEqual(od.pop(k, 12345), 12345) - - # make sure pop still works when __missing__ is defined - class Missing(OrderedDict): - def __missing__(self, key): - return 0 - m = Missing(a=1) - self.assertEqual(m.pop('b', 5), 5) - self.assertEqual(m.pop('a', 6), 1) - self.assertEqual(m.pop('a', 6), 6) - with self.assertRaises(KeyError): - m.pop('a') - - def test_equality(self): - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - shuffle(pairs) - od1 = OrderedDict(pairs) - od2 = OrderedDict(pairs) - self.assertEqual(od1, od2) # same order implies equality - pairs = pairs[2:] + pairs[:2] - od2 = OrderedDict(pairs) - self.assertNotEqual(od1, od2) # different order implies inequality - # comparison to regular dict is not order sensitive - self.assertEqual(od1, dict(od2)) - self.assertEqual(dict(od2), od1) - # different length implied inequality - self.assertNotEqual(od1, OrderedDict(pairs[:-1])) - - def test_copying(self): - # Check that ordered dicts are copyable, deepcopyable, picklable, - # and have a repr/eval round-trip - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) - update_test = OrderedDict() - update_test.update(od) - for i, dup in enumerate([ - od.copy(), - copy.copy(od), - copy.deepcopy(od), - pickle.loads(pickle.dumps(od, 0)), - pickle.loads(pickle.dumps(od, 1)), - pickle.loads(pickle.dumps(od, 2)), - pickle.loads(pickle.dumps(od, 3)), - pickle.loads(pickle.dumps(od, -1)), - eval(repr(od)), - update_test, - OrderedDict(od), - ]): - self.assertTrue(dup is not od) - self.assertEqual(dup, od) - self.assertEqual(list(dup.items()), list(od.items())) - self.assertEqual(len(dup), len(od)) - self.assertEqual(type(dup), type(od)) - - def test_yaml_linkage(self): - # Verify that __reduce__ is setup in a way that supports PyYAML's dump() feature. - # In yaml, lists are native but tuples are not. - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) - # yaml.dump(od) --> - # '!!python/object/apply:__main__.OrderedDict\n- - [a, 1]\n - [b, 2]\n' - self.assertTrue(all(type(pair)==list for pair in od.__reduce__()[1])) - - def test_reduce_not_too_fat(self): - # do not save instance dictionary if not needed - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) - self.assertEqual(len(od.__reduce__()), 2) - od.x = 10 - self.assertEqual(len(od.__reduce__()), 3) - - def test_repr(self): - od = OrderedDict([('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)]) - self.assertEqual(repr(od), - "OrderedDict([('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)])") - self.assertEqual(eval(repr(od)), od) - self.assertEqual(repr(OrderedDict()), "OrderedDict()") - - def test_repr_recursive(self): - # See issue #9826 - od = OrderedDict.fromkeys('abc') - od['x'] = od - self.assertEqual(repr(od), - "OrderedDict([('a', None), ('b', None), ('c', None), ('x', ...)])") - - def test_setdefault(self): - pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - shuffle(pairs) - od = OrderedDict(pairs) - pair_order = list(od.items()) - self.assertEqual(od.setdefault('a', 10), 3) - # make sure order didn't change - self.assertEqual(list(od.items()), pair_order) - self.assertEqual(od.setdefault('x', 10), 10) - # make sure 'x' is added to the end - self.assertEqual(list(od.items())[-1], ('x', 10)) - - # make sure setdefault still works when __missing__ is defined - class Missing(OrderedDict): - def __missing__(self, key): - return 0 - self.assertEqual(Missing().setdefault(5, 9), 9) - - def test_reinsert(self): - # Given insert a, insert b, delete a, re-insert a, - # verify that a is now later than b. - od = OrderedDict() - od['a'] = 1 - od['b'] = 2 - del od['a'] - od['a'] = 1 - self.assertEqual(list(od.items()), [('b', 2), ('a', 1)]) - - def test_move_to_end(self): - od = OrderedDict.fromkeys('abcde') - self.assertEqual(list(od), list('abcde')) - od.move_to_end('c') - self.assertEqual(list(od), list('abdec')) - od.move_to_end('c', 0) - self.assertEqual(list(od), list('cabde')) - od.move_to_end('c', 0) - self.assertEqual(list(od), list('cabde')) - od.move_to_end('e') - self.assertEqual(list(od), list('cabde')) - with self.assertRaises(KeyError): - od.move_to_end('x') - - def test_sizeof(self): - # Wimpy test: Just verify the reported size is larger than a regular dict - d = dict(a=1) - od = OrderedDict(**d) - self.assertGreater(sys.getsizeof(od), sys.getsizeof(d)) - - def test_override_update(self): - # Verify that subclasses can override update() without breaking __init__() - class MyOD(OrderedDict): - def update(self, *args, **kwds): - raise Exception() - items = [('a', 1), ('c', 3), ('b', 2)] - self.assertEqual(list(MyOD(items).items()), items) - -class GeneralMappingTests(mapping_tests.BasicTestMappingProtocol): - type2test = OrderedDict - - def test_popitem(self): - d = self._empty_mapping() - self.assertRaises(KeyError, d.popitem) - -class MyOrderedDict(OrderedDict): - pass - -class SubclassMappingTests(mapping_tests.BasicTestMappingProtocol): - type2test = MyOrderedDict - - def test_popitem(self): - d = self._empty_mapping() - self.assertRaises(KeyError, d.popitem) - - -################################################################################ ### Run tests ################################################################################ @@ -1345,8 +1062,7 @@ def test_main(verbose=None): NamedTupleDocs = doctest.DocTestSuite(module=collections) test_classes = [TestNamedTuple, NamedTupleDocs, TestOneTrickPonyABCs, - TestCollectionABCs, TestCounter, TestChainMap, - TestOrderedDict, GeneralMappingTests, SubclassMappingTests] + TestCollectionABCs, TestCounter, TestChainMap] support.run_unittest(*test_classes) support.run_doctest(collections, verbose) diff --git a/Lib/test/test_collections.py b/Lib/test/test_ordereddict.py copy from Lib/test/test_collections.py copy to Lib/test/test_ordereddict.py --- a/Lib/test/test_collections.py +++ b/Lib/test/test_ordereddict.py @@ -1,1137 +1,129 @@ -"""Unit tests for collections.py.""" +"""Unit tests for collections.OrderedDict.""" -import unittest, doctest, operator -from test.support import TESTFN, forget, unlink +import unittest import inspect from test import support -from collections import namedtuple, Counter, OrderedDict, _count_elements from test import mapping_tests -import pickle, copy -from random import randrange, shuffle -import keyword -import re +from test.support import import_fresh_module +import pickle +import copy +from random import shuffle import sys -from collections import UserDict -from collections import ChainMap -from collections.abc import Hashable, Iterable, Iterator -from collections.abc import Sized, Container, Callable -from collections.abc import Set, MutableSet -from collections.abc import Mapping, MutableMapping, KeysView, ItemsView -from collections.abc import Sequence, MutableSequence -from collections.abc import ByteString +from collections.abc import MutableMapping +import collections -################################################################################ -### ChainMap (helper class for configparser and the string module) -################################################################################ +py_coll = import_fresh_module('collections', blocked=['_collections']) +c_coll = import_fresh_module('collections', fresh=['_collections']) -class TestChainMap(unittest.TestCase): - def test_basics(self): - c = ChainMap() - c['a'] = 1 - c['b'] = 2 - d = c.new_child() - d['b'] = 20 - d['c'] = 30 - self.assertEqual(d.maps, [{'b':20, 'c':30}, {'a':1, 'b':2}]) # check internal state - self.assertEqual(d.items(), dict(a=1, b=20, c=30).items()) # check items/iter/getitem - self.assertEqual(len(d), 3) # check len - for key in 'abc': # check contains - self.assertIn(key, d) - for k, v in dict(a=1, b=20, c=30, z=100).items(): # check get - self.assertEqual(d.get(k, 100), v) - - del d['b'] # unmask a value - self.assertEqual(d.maps, [{'c':30}, {'a':1, 'b':2}]) # check internal state - self.assertEqual(d.items(), dict(a=1, b=2, c=30).items()) # check items/iter/getitem - self.assertEqual(len(d), 3) # check len - for key in 'abc': # check contains - self.assertIn(key, d) - for k, v in dict(a=1, b=2, c=30, z=100).items(): # check get - self.assertEqual(d.get(k, 100), v) - self.assertIn(repr(d), [ # check repr - type(d).__name__ + "({'c': 30}, {'a': 1, 'b': 2})", - type(d).__name__ + "({'c': 30}, {'b': 2, 'a': 1})" - ]) - - for e in d.copy(), copy.copy(d): # check shallow copies - self.assertEqual(d, e) - self.assertEqual(d.maps, e.maps) - self.assertIsNot(d, e) - self.assertIsNot(d.maps[0], e.maps[0]) - for m1, m2 in zip(d.maps[1:], e.maps[1:]): - self.assertIs(m1, m2) - - for e in [pickle.loads(pickle.dumps(d)), - copy.deepcopy(d), - eval(repr(d)) - ]: # check deep copies - self.assertEqual(d, e) - self.assertEqual(d.maps, e.maps) - self.assertIsNot(d, e) - for m1, m2 in zip(d.maps, e.maps): - self.assertIsNot(m1, m2, e) - - f = d.new_child() - f['b'] = 5 - self.assertEqual(f.maps, [{'b': 5}, {'c':30}, {'a':1, 'b':2}]) - self.assertEqual(f.parents.maps, [{'c':30}, {'a':1, 'b':2}]) # check parents - self.assertEqual(f['b'], 5) # find first in chain - self.assertEqual(f.parents['b'], 2) # look beyond maps[0] - - def test_contructor(self): - self.assertEqual(ChainMap().maps, [{}]) # no-args --> one new dict - self.assertEqual(ChainMap({1:2}).maps, [{1:2}]) # 1 arg --> list - - def test_bool(self): - self.assertFalse(ChainMap()) - self.assertFalse(ChainMap({}, {})) - self.assertTrue(ChainMap({1:2}, {})) - self.assertTrue(ChainMap({}, {1:2})) - - def test_missing(self): - class DefaultChainMap(ChainMap): - def __missing__(self, key): - return 999 - d = DefaultChainMap(dict(a=1, b=2), dict(b=20, c=30)) - for k, v in dict(a=1, b=2, c=30, d=999).items(): - self.assertEqual(d[k], v) # check __getitem__ w/missing - for k, v in dict(a=1, b=2, c=30, d=77).items(): - self.assertEqual(d.get(k, 77), v) # check get() w/ missing - for k, v in dict(a=True, b=True, c=True, d=False).items(): - self.assertEqual(k in d, v) # check __contains__ w/missing - self.assertEqual(d.pop('a', 1001), 1, d) - self.assertEqual(d.pop('a', 1002), 1002) # check pop() w/missing - self.assertEqual(d.popitem(), ('b', 2)) # check popitem() w/missing - with self.assertRaises(KeyError): - d.popitem() - - def test_dict_coercion(self): - d = ChainMap(dict(a=1, b=2), dict(b=20, c=30)) - self.assertEqual(dict(d), dict(a=1, b=2, c=30)) - self.assertEqual(dict(d.items()), dict(a=1, b=2, c=30)) - - def test_new_child(self): - 'Tests for changes for issue #16613.' - c = ChainMap() - c['a'] = 1 - c['b'] = 2 - m = {'b':20, 'c': 30} - d = c.new_child(m) - self.assertEqual(d.maps, [{'b':20, 'c':30}, {'a':1, 'b':2}]) # check internal state - self.assertIs(m, d.maps[0]) - - # Use a different map than a dict - class lowerdict(dict): - def __getitem__(self, key): - if isinstance(key, str): - key = key.lower() - return dict.__getitem__(self, key) - def __contains__(self, key): - if isinstance(key, str): - key = key.lower() - return dict.__contains__(self, key) - - c = ChainMap() - c['a'] = 1 - c['b'] = 2 - m = lowerdict(b=20, c=30) - d = c.new_child(m) - self.assertIs(m, d.maps[0]) - for key in 'abc': # check contains - self.assertIn(key, d) - for k, v in dict(a=1, B=20, C=30, z=100).items(): # check get - self.assertEqual(d.get(k, 100), v) - - -################################################################################ -### Named Tuples -################################################################################ - -TestNT = namedtuple('TestNT', 'x y z') # type used for pickle tests - -class TestNamedTuple(unittest.TestCase): - - def test_factory(self): - Point = namedtuple('Point', 'x y') - self.assertEqual(Point.__name__, 'Point') - self.assertEqual(Point.__slots__, ()) - self.assertEqual(Point.__module__, __name__) - self.assertEqual(Point.__getitem__, tuple.__getitem__) - self.assertEqual(Point._fields, ('x', 'y')) - self.assertIn('class Point(tuple)', Point._source) - - self.assertRaises(ValueError, namedtuple, 'abc%', 'efg ghi') # type has non-alpha char - self.assertRaises(ValueError, namedtuple, 'class', 'efg ghi') # type has keyword - self.assertRaises(ValueError, namedtuple, '9abc', 'efg ghi') # type starts with digit - - self.assertRaises(ValueError, namedtuple, 'abc', 'efg g%hi') # field with non-alpha char - self.assertRaises(ValueError, namedtuple, 'abc', 'abc class') # field has keyword - self.assertRaises(ValueError, namedtuple, 'abc', '8efg 9ghi') # field starts with digit - self.assertRaises(ValueError, namedtuple, 'abc', '_efg ghi') # field with leading underscore - self.assertRaises(ValueError, namedtuple, 'abc', 'efg efg ghi') # duplicate field - - namedtuple('Point0', 'x1 y2') # Verify that numbers are allowed in names - namedtuple('_', 'a b c') # Test leading underscores in a typename - - nt = namedtuple('nt', 'the quick brown fox') # check unicode input - self.assertNotIn("u'", repr(nt._fields)) - nt = namedtuple('nt', ('the', 'quick')) # check unicode input - self.assertNotIn("u'", repr(nt._fields)) - - self.assertRaises(TypeError, Point._make, [11]) # catch too few args - self.assertRaises(TypeError, Point._make, [11, 22, 33]) # catch too many args - - @unittest.skipIf(sys.flags.optimize >= 2, - "Docstrings are omitted with -O2 and above") - def test_factory_doc_attr(self): - Point = namedtuple('Point', 'x y') - self.assertEqual(Point.__doc__, 'Point(x, y)') - - def test_name_fixer(self): - for spec, renamed in [ - [('efg', 'g%hi'), ('efg', '_1')], # field with non-alpha char - [('abc', 'class'), ('abc', '_1')], # field has keyword - [('8efg', '9ghi'), ('_0', '_1')], # field starts with digit - [('abc', '_efg'), ('abc', '_1')], # field with leading underscore - [('abc', 'efg', 'efg', 'ghi'), ('abc', 'efg', '_2', 'ghi')], # duplicate field - [('abc', '', 'x'), ('abc', '_1', 'x')], # fieldname is a space - ]: - self.assertEqual(namedtuple('NT', spec, rename=True)._fields, renamed) - - def test_instance(self): - Point = namedtuple('Point', 'x y') - p = Point(11, 22) - self.assertEqual(p, Point(x=11, y=22)) - self.assertEqual(p, Point(11, y=22)) - self.assertEqual(p, Point(y=22, x=11)) - self.assertEqual(p, Point(*(11, 22))) - self.assertEqual(p, Point(**dict(x=11, y=22))) - self.assertRaises(TypeError, Point, 1) # too few args - self.assertRaises(TypeError, Point, 1, 2, 3) # too many args - self.assertRaises(TypeError, eval, 'Point(XXX=1, y=2)', locals()) # wrong keyword argument - self.assertRaises(TypeError, eval, 'Point(x=1)', locals()) # missing keyword argument - self.assertEqual(repr(p), 'Point(x=11, y=22)') - self.assertNotIn('__weakref__', dir(p)) - self.assertEqual(p, Point._make([11, 22])) # test _make classmethod - self.assertEqual(p._fields, ('x', 'y')) # test _fields attribute - self.assertEqual(p._replace(x=1), (1, 22)) # test _replace method - self.assertEqual(p._asdict(), dict(x=11, y=22)) # test _asdict method - self.assertEqual(vars(p), p._asdict()) # verify that vars() works - - try: - p._replace(x=1, error=2) - except ValueError: - pass - else: - self._fail('Did not detect an incorrect fieldname') - - # verify that field string can have commas - Point = namedtuple('Point', 'x, y') - p = Point(x=11, y=22) - self.assertEqual(repr(p), 'Point(x=11, y=22)') - - # verify that fieldspec can be a non-string sequence - Point = namedtuple('Point', ('x', 'y')) - p = Point(x=11, y=22) - self.assertEqual(repr(p), 'Point(x=11, y=22)') - - def test_tupleness(self): - Point = namedtuple('Point', 'x y') - p = Point(11, 22) - - self.assertIsInstance(p, tuple) - self.assertEqual(p, (11, 22)) # matches a real tuple - self.assertEqual(tuple(p), (11, 22)) # coercable to a real tuple - self.assertEqual(list(p), [11, 22]) # coercable to a list - self.assertEqual(max(p), 22) # iterable - self.assertEqual(max(*p), 22) # star-able - x, y = p - self.assertEqual(p, (x, y)) # unpacks like a tuple - self.assertEqual((p[0], p[1]), (11, 22)) # indexable like a tuple - self.assertRaises(IndexError, p.__getitem__, 3) - - self.assertEqual(p.x, x) - self.assertEqual(p.y, y) - self.assertRaises(AttributeError, eval, 'p.z', locals()) - - def test_odd_sizes(self): - Zero = namedtuple('Zero', '') - self.assertEqual(Zero(), ()) - self.assertEqual(Zero._make([]), ()) - self.assertEqual(repr(Zero()), 'Zero()') - self.assertEqual(Zero()._asdict(), {}) - self.assertEqual(Zero()._fields, ()) - - Dot = namedtuple('Dot', 'd') - self.assertEqual(Dot(1), (1,)) - self.assertEqual(Dot._make([1]), (1,)) - self.assertEqual(Dot(1).d, 1) - self.assertEqual(repr(Dot(1)), 'Dot(d=1)') - self.assertEqual(Dot(1)._asdict(), {'d':1}) - self.assertEqual(Dot(1)._replace(d=999), (999,)) - self.assertEqual(Dot(1)._fields, ('d',)) - - # n = 5000 - n = 254 # SyntaxError: more than 255 arguments: - import string, random - names = list(set(''.join([random.choice(string.ascii_letters) - for j in range(10)]) for i in range(n))) - n = len(names) - Big = namedtuple('Big', names) - b = Big(*range(n)) - self.assertEqual(b, tuple(range(n))) - self.assertEqual(Big._make(range(n)), tuple(range(n))) - for pos, name in enumerate(names): - self.assertEqual(getattr(b, name), pos) - repr(b) # make sure repr() doesn't blow-up - d = b._asdict() - d_expected = dict(zip(names, range(n))) - self.assertEqual(d, d_expected) - b2 = b._replace(**dict([(names[1], 999),(names[-5], 42)])) - b2_expected = list(range(n)) - b2_expected[1] = 999 - b2_expected[-5] = 42 - self.assertEqual(b2, tuple(b2_expected)) - self.assertEqual(b._fields, tuple(names)) - - def test_pickle(self): - p = TestNT(x=10, y=20, z=30) - for module in (pickle,): - loads = getattr(module, 'loads') - dumps = getattr(module, 'dumps') - for protocol in -1, 0, 1, 2: - q = loads(dumps(p, protocol)) - self.assertEqual(p, q) - self.assertEqual(p._fields, q._fields) - - def test_copy(self): - p = TestNT(x=10, y=20, z=30) - for copier in copy.copy, copy.deepcopy: - q = copier(p) - self.assertEqual(p, q) - self.assertEqual(p._fields, q._fields) - - def test_name_conflicts(self): - # Some names like "self", "cls", "tuple", "itemgetter", and "property" - # failed when used as field names. Test to make sure these now work. - T = namedtuple('T', 'itemgetter property self cls tuple') - t = T(1, 2, 3, 4, 5) - self.assertEqual(t, (1,2,3,4,5)) - newt = t._replace(itemgetter=10, property=20, self=30, cls=40, tuple=50) - self.assertEqual(newt, (10,20,30,40,50)) - - # Broader test of all interesting names in a template - with support.captured_stdout() as template: - T = namedtuple('T', 'x', verbose=True) - words = set(re.findall('[A-Za-z]+', template.getvalue())) - words -= set(keyword.kwlist) - T = namedtuple('T', words) - # test __new__ - values = tuple(range(len(words))) - t = T(*values) - self.assertEqual(t, values) - t = T(**dict(zip(T._fields, values))) - self.assertEqual(t, values) - # test _make - t = T._make(values) - self.assertEqual(t, values) - # exercise __repr__ - repr(t) - # test _asdict - self.assertEqual(t._asdict(), dict(zip(T._fields, values))) - # test _replace - t = T._make(values) - newvalues = tuple(v*10 for v in values) - newt = t._replace(**dict(zip(T._fields, newvalues))) - self.assertEqual(newt, newvalues) - # test _fields - self.assertEqual(T._fields, tuple(words)) - # test __getnewargs__ - self.assertEqual(t.__getnewargs__(), values) - - def test_repr(self): - with support.captured_stdout() as template: - A = namedtuple('A', 'x', verbose=True) - self.assertEqual(repr(A(1)), 'A(x=1)') - # repr should show the name of the subclass - class B(A): - pass - self.assertEqual(repr(B(1)), 'B(x=1)') - - def test_source(self): - # verify that _source can be run through exec() - tmp = namedtuple('NTColor', 'red green blue') - globals().pop('NTColor', None) # remove artifacts from other tests - exec(tmp._source, globals()) - self.assertIn('NTColor', globals()) - c = NTColor(10, 20, 30) - self.assertEqual((c.red, c.green, c.blue), (10, 20, 30)) - self.assertEqual(NTColor._fields, ('red', 'green', 'blue')) - globals().pop('NTColor', None) # clean-up after this test - - -################################################################################ -### Abstract Base Classes -################################################################################ - -class ABCTestCase(unittest.TestCase): - - def validate_abstract_methods(self, abc, *names): - methodstubs = dict.fromkeys(names, lambda s, *args: 0) - - # everything should work will all required methods are present - C = type('C', (abc,), methodstubs) - C() - - # instantiation should fail if a required method is missing - for name in names: - stubs = methodstubs.copy() - del stubs[name] - C = type('C', (abc,), stubs) - self.assertRaises(TypeError, C, name) - - def validate_isinstance(self, abc, name): - stub = lambda s, *args: 0 - - C = type('C', (object,), {'__hash__': None}) - setattr(C, name, stub) - self.assertIsInstance(C(), abc) - self.assertTrue(issubclass(C, abc)) - - C = type('C', (object,), {'__hash__': None}) - self.assertNotIsInstance(C(), abc) - self.assertFalse(issubclass(C, abc)) - - def validate_comparison(self, instance): - ops = ['lt', 'gt', 'le', 'ge', 'ne', 'or', 'and', 'xor', 'sub'] - operators = {} - for op in ops: - name = '__' + op + '__' - operators[name] = getattr(operator, name) - - class Other: - def __init__(self): - self.right_side = False - def __eq__(self, other): - self.right_side = True - return True - __lt__ = __eq__ - __gt__ = __eq__ - __le__ = __eq__ - __ge__ = __eq__ - __ne__ = __eq__ - __ror__ = __eq__ - __rand__ = __eq__ - __rxor__ = __eq__ - __rsub__ = __eq__ - - for name, op in operators.items(): - if not hasattr(instance, name): - continue - other = Other() - op(instance, other) - self.assertTrue(other.right_side,'Right side not called for %s.%s' - % (type(instance), name)) - -class TestOneTrickPonyABCs(ABCTestCase): - - def test_Hashable(self): - # Check some non-hashables - non_samples = [bytearray(), list(), set(), dict()] - for x in non_samples: - self.assertNotIsInstance(x, Hashable) - self.assertFalse(issubclass(type(x), Hashable), repr(type(x))) - # Check some hashables - samples = [None, - int(), float(), complex(), - str(), - tuple(), frozenset(), - int, list, object, type, bytes() - ] - for x in samples: - self.assertIsInstance(x, Hashable) - self.assertTrue(issubclass(type(x), Hashable), repr(type(x))) - self.assertRaises(TypeError, Hashable) - # Check direct subclassing - class H(Hashable): - def __hash__(self): - return super().__hash__() - self.assertEqual(hash(H()), 0) - self.assertFalse(issubclass(int, H)) - self.validate_abstract_methods(Hashable, '__hash__') - self.validate_isinstance(Hashable, '__hash__') - - def test_Iterable(self): - # Check some non-iterables - non_samples = [None, 42, 3.14, 1j] - for x in non_samples: - self.assertNotIsInstance(x, Iterable) - self.assertFalse(issubclass(type(x), Iterable), repr(type(x))) - # Check some iterables - samples = [bytes(), str(), - tuple(), list(), set(), frozenset(), dict(), - dict().keys(), dict().items(), dict().values(), - (lambda: (yield))(), - (x for x in []), - ] - for x in samples: - self.assertIsInstance(x, Iterable) - self.assertTrue(issubclass(type(x), Iterable), repr(type(x))) - # Check direct subclassing - class I(Iterable): - def __iter__(self): - return super().__iter__() - self.assertEqual(list(I()), []) - self.assertFalse(issubclass(str, I)) - self.validate_abstract_methods(Iterable, '__iter__') - self.validate_isinstance(Iterable, '__iter__') - - def test_Iterator(self): - non_samples = [None, 42, 3.14, 1j, b"", "", (), [], {}, set()] - for x in non_samples: - self.assertNotIsInstance(x, Iterator) - self.assertFalse(issubclass(type(x), Iterator), repr(type(x))) - samples = [iter(bytes()), iter(str()), - iter(tuple()), iter(list()), iter(dict()), - iter(set()), iter(frozenset()), - iter(dict().keys()), iter(dict().items()), - iter(dict().values()), - (lambda: (yield))(), - (x for x in []), - ] - for x in samples: - self.assertIsInstance(x, Iterator) - self.assertTrue(issubclass(type(x), Iterator), repr(type(x))) - self.validate_abstract_methods(Iterator, '__next__', '__iter__') - - # Issue 10565 - class NextOnly: - def __next__(self): - yield 1 - raise StopIteration - self.assertNotIsInstance(NextOnly(), Iterator) - - def test_Sized(self): - non_samples = [None, 42, 3.14, 1j, - (lambda: (yield))(), - (x for x in []), - ] - for x in non_samples: - self.assertNotIsInstance(x, Sized) - self.assertFalse(issubclass(type(x), Sized), repr(type(x))) - samples = [bytes(), str(), - tuple(), list(), set(), frozenset(), dict(), - dict().keys(), dict().items(), dict().values(), - ] - for x in samples: - self.assertIsInstance(x, Sized) - self.assertTrue(issubclass(type(x), Sized), repr(type(x))) - self.validate_abstract_methods(Sized, '__len__') - self.validate_isinstance(Sized, '__len__') - - def test_Container(self): - non_samples = [None, 42, 3.14, 1j, - (lambda: (yield))(), - (x for x in []), - ] - for x in non_samples: - self.assertNotIsInstance(x, Container) - self.assertFalse(issubclass(type(x), Container), repr(type(x))) - samples = [bytes(), str(), - tuple(), list(), set(), frozenset(), dict(), - dict().keys(), dict().items(), - ] - for x in samples: - self.assertIsInstance(x, Container) - self.assertTrue(issubclass(type(x), Container), repr(type(x))) - self.validate_abstract_methods(Container, '__contains__') - self.validate_isinstance(Container, '__contains__') - - def test_Callable(self): - non_samples = [None, 42, 3.14, 1j, - "", b"", (), [], {}, set(), - (lambda: (yield))(), - (x for x in []), - ] - for x in non_samples: - self.assertNotIsInstance(x, Callable) - self.assertFalse(issubclass(type(x), Callable), repr(type(x))) - samples = [lambda: None, - type, int, object, - len, - list.append, [].append, - ] - for x in samples: - self.assertIsInstance(x, Callable) - self.assertTrue(issubclass(type(x), Callable), repr(type(x))) - self.validate_abstract_methods(Callable, '__call__') - self.validate_isinstance(Callable, '__call__') - - def test_direct_subclassing(self): - for B in Hashable, Iterable, Iterator, Sized, Container, Callable: - class C(B): - pass - self.assertTrue(issubclass(C, B)) - self.assertFalse(issubclass(int, C)) - - def test_registration(self): - for B in Hashable, Iterable, Iterator, Sized, Container, Callable: - class C: - __hash__ = None # Make sure it isn't hashable by default - self.assertFalse(issubclass(C, B), B.__name__) - B.register(C) - self.assertTrue(issubclass(C, B)) - -class WithSet(MutableSet): - - def __init__(self, it=()): - self.data = set(it) - - def __len__(self): - return len(self.data) - - def __iter__(self): - return iter(self.data) - - def __contains__(self, item): - return item in self.data - - def add(self, item): - self.data.add(item) - - def discard(self, item): - self.data.discard(item) - -class TestCollectionABCs(ABCTestCase): - - # XXX For now, we only test some virtual inheritance properties. - # We should also test the proper behavior of the collection ABCs - # as real base classes or mix-in classes. - - def test_Set(self): - for sample in [set, frozenset]: - self.assertIsInstance(sample(), Set) - self.assertTrue(issubclass(sample, Set)) - self.validate_abstract_methods(Set, '__contains__', '__iter__', '__len__') - class MySet(Set): - def __contains__(self, x): - return False - def __len__(self): - return 0 - def __iter__(self): - return iter([]) - self.validate_comparison(MySet()) - - def test_hash_Set(self): - class OneTwoThreeSet(Set): - def __init__(self): - self.contents = [1, 2, 3] - def __contains__(self, x): - return x in self.contents - def __len__(self): - return len(self.contents) - def __iter__(self): - return iter(self.contents) - def __hash__(self): - return self._hash() - a, b = OneTwoThreeSet(), OneTwoThreeSet() - self.assertTrue(hash(a) == hash(b)) - - def test_MutableSet(self): - self.assertIsInstance(set(), MutableSet) - self.assertTrue(issubclass(set, MutableSet)) - self.assertNotIsInstance(frozenset(), MutableSet) - self.assertFalse(issubclass(frozenset, MutableSet)) - self.validate_abstract_methods(MutableSet, '__contains__', '__iter__', '__len__', - 'add', 'discard') - - def test_issue_5647(self): - # MutableSet.__iand__ mutated the set during iteration - s = WithSet('abcd') - s &= WithSet('cdef') # This used to fail - self.assertEqual(set(s), set('cd')) - - def test_issue_4920(self): - # MutableSet.pop() method did not work - class MySet(MutableSet): - __slots__=['__s'] - def __init__(self,items=None): - if items is None: - items=[] - self.__s=set(items) - def __contains__(self,v): - return v in self.__s - def __iter__(self): - return iter(self.__s) - def __len__(self): - return len(self.__s) - def add(self,v): - result=v not in self.__s - self.__s.add(v) - return result - def discard(self,v): - result=v in self.__s - self.__s.discard(v) - return result - def __repr__(self): - return "MySet(%s)" % repr(list(self)) - s = MySet([5,43,2,1]) - self.assertEqual(s.pop(), 1) - - def test_issue8750(self): - empty = WithSet() - full = WithSet(range(10)) - s = WithSet(full) - s -= s - self.assertEqual(s, empty) - s = WithSet(full) - s ^= s - self.assertEqual(s, empty) - s = WithSet(full) - s &= s - self.assertEqual(s, full) - s |= s - self.assertEqual(s, full) - - def test_issue16373(self): - # Recursion error comparing comparable and noncomparable - # Set instances - class MyComparableSet(Set): - def __contains__(self, x): - return False - def __len__(self): - return 0 - def __iter__(self): - return iter([]) - class MyNonComparableSet(Set): - def __contains__(self, x): - return False - def __len__(self): - return 0 - def __iter__(self): - return iter([]) - def __le__(self, x): - return NotImplemented - def __lt__(self, x): - return NotImplemented - - cs = MyComparableSet() - ncs = MyNonComparableSet() - with self.assertRaises(TypeError): - ncs < cs - with self.assertRaises(TypeError): - ncs <= cs - with self.assertRaises(TypeError): - cs > ncs - with self.assertRaises(TypeError): - cs >= ncs - - def test_Mapping(self): - for sample in [dict]: - self.assertIsInstance(sample(), Mapping) - self.assertTrue(issubclass(sample, Mapping)) - self.validate_abstract_methods(Mapping, '__contains__', '__iter__', '__len__', - '__getitem__') - class MyMapping(Mapping): - def __len__(self): - return 0 - def __getitem__(self, i): - raise IndexError - def __iter__(self): - return iter(()) - self.validate_comparison(MyMapping()) - - def test_MutableMapping(self): - for sample in [dict]: - self.assertIsInstance(sample(), MutableMapping) - self.assertTrue(issubclass(sample, MutableMapping)) - self.validate_abstract_methods(MutableMapping, '__contains__', '__iter__', '__len__', - '__getitem__', '__setitem__', '__delitem__') - - def test_MutableMapping_subclass(self): - # Test issue 9214 - mymap = UserDict() - mymap['red'] = 5 - self.assertIsInstance(mymap.keys(), Set) - self.assertIsInstance(mymap.keys(), KeysView) - self.assertIsInstance(mymap.items(), Set) - self.assertIsInstance(mymap.items(), ItemsView) - - mymap = UserDict() - mymap['red'] = 5 - z = mymap.keys() | {'orange'} - self.assertIsInstance(z, set) - list(z) - mymap['blue'] = 7 # Shouldn't affect 'z' - self.assertEqual(sorted(z), ['orange', 'red']) - - mymap = UserDict() - mymap['red'] = 5 - z = mymap.items() | {('orange', 3)} - self.assertIsInstance(z, set) - list(z) - mymap['blue'] = 7 # Shouldn't affect 'z' - self.assertEqual(sorted(z), [('orange', 3), ('red', 5)]) - - def test_Sequence(self): - for sample in [tuple, list, bytes, str]: - self.assertIsInstance(sample(), Sequence) - self.assertTrue(issubclass(sample, Sequence)) - self.assertIsInstance(range(10), Sequence) - self.assertTrue(issubclass(range, Sequence)) - self.assertTrue(issubclass(str, Sequence)) - self.validate_abstract_methods(Sequence, '__contains__', '__iter__', '__len__', - '__getitem__') - - def test_ByteString(self): - for sample in [bytes, bytearray]: - self.assertIsInstance(sample(), ByteString) - self.assertTrue(issubclass(sample, ByteString)) - for sample in [str, list, tuple]: - self.assertNotIsInstance(sample(), ByteString) - self.assertFalse(issubclass(sample, ByteString)) - self.assertNotIsInstance(memoryview(b""), ByteString) - self.assertFalse(issubclass(memoryview, ByteString)) - - def test_MutableSequence(self): - for sample in [tuple, str, bytes]: - self.assertNotIsInstance(sample(), MutableSequence) - self.assertFalse(issubclass(sample, MutableSequence)) - for sample in [list, bytearray]: - self.assertIsInstance(sample(), MutableSequence) - self.assertTrue(issubclass(sample, MutableSequence)) - self.assertFalse(issubclass(str, MutableSequence)) - self.validate_abstract_methods(MutableSequence, '__contains__', '__iter__', - '__len__', '__getitem__', '__setitem__', '__delitem__', 'insert') - - def test_MutableSequence_mixins(self): - # Test the mixins of MutableSequence by creating a miminal concrete - # class inherited from it. - class MutableSequenceSubclass(MutableSequence): - def __init__(self): - self.lst = [] - - def __setitem__(self, index, value): - self.lst[index] = value - - def __getitem__(self, index): - return self.lst[index] - - def __len__(self): - return len(self.lst) - - def __delitem__(self, index): - del self.lst[index] - - def insert(self, index, value): - self.lst.insert(index, value) - - mss = MutableSequenceSubclass() - mss.append(0) - mss.extend((1, 2, 3, 4)) - self.assertEqual(len(mss), 5) - self.assertEqual(mss[3], 3) - mss.reverse() - self.assertEqual(mss[3], 1) - mss.pop() - self.assertEqual(len(mss), 4) - mss.remove(3) - self.assertEqual(len(mss), 3) - mss += (10, 20, 30) - self.assertEqual(len(mss), 6) - self.assertEqual(mss[-1], 30) - mss.clear() - self.assertEqual(len(mss), 0) - -################################################################################ -### Counter -################################################################################ - -class TestCounter(unittest.TestCase): - - def test_basics(self): - c = Counter('abcaba') - self.assertEqual(c, Counter({'a':3 , 'b': 2, 'c': 1})) - self.assertEqual(c, Counter(a=3, b=2, c=1)) - self.assertIsInstance(c, dict) - self.assertIsInstance(c, Mapping) - self.assertTrue(issubclass(Counter, dict)) - self.assertTrue(issubclass(Counter, Mapping)) - self.assertEqual(len(c), 3) - self.assertEqual(sum(c.values()), 6) - self.assertEqual(sorted(c.values()), [1, 2, 3]) - self.assertEqual(sorted(c.keys()), ['a', 'b', 'c']) - self.assertEqual(sorted(c), ['a', 'b', 'c']) - self.assertEqual(sorted(c.items()), - [('a', 3), ('b', 2), ('c', 1)]) - self.assertEqual(c['b'], 2) - self.assertEqual(c['z'], 0) - self.assertEqual(c.__contains__('c'), True) - self.assertEqual(c.__contains__('z'), False) - self.assertEqual(c.get('b', 10), 2) - self.assertEqual(c.get('z', 10), 10) - self.assertEqual(c, dict(a=3, b=2, c=1)) - self.assertEqual(repr(c), "Counter({'a': 3, 'b': 2, 'c': 1})") - self.assertEqual(c.most_common(), [('a', 3), ('b', 2), ('c', 1)]) - for i in range(5): - self.assertEqual(c.most_common(i), - [('a', 3), ('b', 2), ('c', 1)][:i]) - self.assertEqual(''.join(sorted(c.elements())), 'aaabbc') - c['a'] += 1 # increment an existing value - c['b'] -= 2 # sub existing value to zero - del c['c'] # remove an entry - del c['c'] # make sure that del doesn't raise KeyError - c['d'] -= 2 # sub from a missing value - c['e'] = -5 # directly assign a missing value - c['f'] += 4 # add to a missing value - self.assertEqual(c, dict(a=4, b=0, d=-2, e=-5, f=4)) - self.assertEqual(''.join(sorted(c.elements())), 'aaaaffff') - self.assertEqual(c.pop('f'), 4) - self.assertNotIn('f', c) - for i in range(3): - elem, cnt = c.popitem() - self.assertNotIn(elem, c) - c.clear() - self.assertEqual(c, {}) - self.assertEqual(repr(c), 'Counter()') - self.assertRaises(NotImplementedError, Counter.fromkeys, 'abc') - self.assertRaises(TypeError, hash, c) - c.update(dict(a=5, b=3)) - c.update(c=1) - c.update(Counter('a' * 50 + 'b' * 30)) - c.update() # test case with no args - c.__init__('a' * 500 + 'b' * 300) - c.__init__('cdc') - c.__init__() - self.assertEqual(c, dict(a=555, b=333, c=3, d=1)) - self.assertEqual(c.setdefault('d', 5), 1) - self.assertEqual(c['d'], 1) - self.assertEqual(c.setdefault('e', 5), 5) - self.assertEqual(c['e'], 5) - - def test_copying(self): - # Check that counters are copyable, deepcopyable, picklable, and - #have a repr/eval round-trip - words = Counter('which witch had which witches wrist watch'.split()) - update_test = Counter() - update_test.update(words) - for i, dup in enumerate([ - words.copy(), - copy.copy(words), - copy.deepcopy(words), - pickle.loads(pickle.dumps(words, 0)), - pickle.loads(pickle.dumps(words, 1)), - pickle.loads(pickle.dumps(words, 2)), - pickle.loads(pickle.dumps(words, -1)), - eval(repr(words)), - update_test, - Counter(words), - ]): - msg = (i, dup, words) - self.assertTrue(dup is not words) - self.assertEqual(dup, words) - self.assertEqual(len(dup), len(words)) - self.assertEqual(type(dup), type(words)) - - def test_copy_subclass(self): - class MyCounter(Counter): - pass - c = MyCounter('slartibartfast') - d = c.copy() - self.assertEqual(d, c) - self.assertEqual(len(d), len(c)) - self.assertEqual(type(d), type(c)) - - def test_conversions(self): - # Convert to: set, list, dict - s = 'she sells sea shells by the sea shore' - self.assertEqual(sorted(Counter(s).elements()), sorted(s)) - self.assertEqual(sorted(Counter(s)), sorted(set(s))) - self.assertEqual(dict(Counter(s)), dict(Counter(s).items())) - self.assertEqual(set(Counter(s)), set(s)) - - def test_invariant_for_the_in_operator(self): - c = Counter(a=10, b=-2, c=0) - for elem in c: - self.assertTrue(elem in c) - self.assertIn(elem, c) - - def test_multiset_operations(self): - # Verify that adding a zero counter will strip zeros and negatives - c = Counter(a=10, b=-2, c=0) + Counter() - self.assertEqual(dict(c), dict(a=10)) - - elements = 'abcd' - for i in range(1000): - # test random pairs of multisets - p = Counter(dict((elem, randrange(-2,4)) for elem in elements)) - p.update(e=1, f=-1, g=0) - q = Counter(dict((elem, randrange(-2,4)) for elem in elements)) - q.update(h=1, i=-1, j=0) - for counterop, numberop in [ - (Counter.__add__, lambda x, y: max(0, x+y)), - (Counter.__sub__, lambda x, y: max(0, x-y)), - (Counter.__or__, lambda x, y: max(0,x,y)), - (Counter.__and__, lambda x, y: max(0, min(x,y))), - ]: - result = counterop(p, q) - for x in elements: - self.assertEqual(numberop(p[x], q[x]), result[x], - (counterop, x, p, q)) - # verify that results exclude non-positive counts - self.assertTrue(x>0 for x in result.values()) - - elements = 'abcdef' - for i in range(100): - # verify that random multisets with no repeats are exactly like sets - p = Counter(dict((elem, randrange(0, 2)) for elem in elements)) - q = Counter(dict((elem, randrange(0, 2)) for elem in elements)) - for counterop, setop in [ - (Counter.__sub__, set.__sub__), - (Counter.__or__, set.__or__), - (Counter.__and__, set.__and__), - ]: - counter_result = counterop(p, q) - set_result = setop(set(p.elements()), set(q.elements())) - self.assertEqual(counter_result, dict.fromkeys(set_result, 1)) - - def test_inplace_operations(self): - elements = 'abcd' - for i in range(1000): - # test random pairs of multisets - p = Counter(dict((elem, randrange(-2,4)) for elem in elements)) - p.update(e=1, f=-1, g=0) - q = Counter(dict((elem, randrange(-2,4)) for elem in elements)) - q.update(h=1, i=-1, j=0) - for inplace_op, regular_op in [ - (Counter.__iadd__, Counter.__add__), - (Counter.__isub__, Counter.__sub__), - (Counter.__ior__, Counter.__or__), - (Counter.__iand__, Counter.__and__), - ]: - c = p.copy() - c_id = id(c) - regular_result = regular_op(c, q) - inplace_result = inplace_op(c, q) - self.assertEqual(inplace_result, regular_result) - self.assertEqual(id(inplace_result), c_id) - - def test_subtract(self): - c = Counter(a=-5, b=0, c=5, d=10, e=15,g=40) - c.subtract(a=1, b=2, c=-3, d=10, e=20, f=30, h=-50) - self.assertEqual(c, Counter(a=-6, b=-2, c=8, d=0, e=-5, f=-30, g=40, h=50)) - c = Counter(a=-5, b=0, c=5, d=10, e=15,g=40) - c.subtract(Counter(a=1, b=2, c=-3, d=10, e=20, f=30, h=-50)) - self.assertEqual(c, Counter(a=-6, b=-2, c=8, d=0, e=-5, f=-30, g=40, h=50)) - c = Counter('aaabbcd') - c.subtract('aaaabbcce') - self.assertEqual(c, Counter(a=-1, b=0, c=-1, d=1, e=-1)) - - def test_unary(self): - c = Counter(a=-5, b=0, c=5, d=10, e=15,g=40) - self.assertEqual(dict(+c), dict(c=5, d=10, e=15, g=40)) - self.assertEqual(dict(-c), dict(a=5)) - - def test_repr_nonsortable(self): - c = Counter(a=2, b=None) - r = repr(c) - self.assertIn("'a': 2", r) - self.assertIn("'b': None", r) - - def test_helper_function(self): - # two paths, one for real dicts and one for other mappings - elems = list('abracadabra') - - d = dict() - _count_elements(d, elems) - self.assertEqual(d, {'a': 5, 'r': 2, 'b': 2, 'c': 1, 'd': 1}) - - m = OrderedDict() - _count_elements(m, elems) - self.assertEqual(m, - OrderedDict([('a', 5), ('b', 2), ('r', 2), ('c', 1), ('d', 1)])) - - -################################################################################ -### OrderedDict -################################################################################ - -class TestOrderedDict(unittest.TestCase): +class OrderedDictTests: def test_init(self): + pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5)] + + # too many args with self.assertRaises(TypeError): - OrderedDict([('a', 1), ('b', 2)], None) # too many args - pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5)] - self.assertEqual(sorted(OrderedDict(dict(pairs)).items()), pairs) # dict input - self.assertEqual(sorted(OrderedDict(**dict(pairs)).items()), pairs) # kwds input - self.assertEqual(list(OrderedDict(pairs).items()), pairs) # pairs input - self.assertEqual(list(OrderedDict([('a', 1), ('b', 2), ('c', 9), ('d', 4)], - c=3, e=5).items()), pairs) # mixed input + self.module.OrderedDict([('a', 1), ('b', 2)], None) + # dict input + self.assertEqual(sorted(self.module.OrderedDict(dict(pairs)).items()), + pairs) + + # kwds input + self.assertEqual(sorted(self.module.OrderedDict(**dict(pairs)).items()), + pairs) + + # pairs input + self.assertEqual(list(self.module.OrderedDict(pairs).items()), + pairs) + + # mixed input + other = [('a', 1), ('b', 2), ('c', 9), ('d', 4)] + self.assertEqual(list(self.module.OrderedDict(other, c=3, e=5).items()), + pairs) + + # Make sure that direct calls to __init__ do not clear previous contents + first_pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 44), ('e', 55)] + d = self.module.OrderedDict(first_pairs) + d.__init__([('e', 5), ('f', 6)], g=7, d=4) + self.assertEqual(list(d.items()), + [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5), + ('f', 6), ('g', 7)]) + + def test_init_argspec(self): + if self.module == c_coll: + raise unittest.SkipTest("only valid for pure Python") # make sure no positional args conflict with possible kwdargs - self.assertEqual(inspect.getargspec(OrderedDict.__dict__['__init__']).args, + __init__ = self.module.OrderedDict.__dict__['__init__'] + self.assertEqual(inspect.getargspec(__init__).args, ['self']) - # Make sure that direct calls to __init__ do not clear previous contents - d = OrderedDict([('a', 1), ('b', 2), ('c', 3), ('d', 44), ('e', 55)]) - d.__init__([('e', 5), ('f', 6)], g=7, d=4) - self.assertEqual(list(d.items()), - [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5), ('f', 6), ('g', 7)]) + def test_update(self): + pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5)] - def test_update(self): + # too many args with self.assertRaises(TypeError): - OrderedDict().update([('a', 1), ('b', 2)], None) # too many args - pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5)] - od = OrderedDict() + self.module.OrderedDict().update([('a', 1), ('b', 2)], None) + + # dict input + od = self.module.OrderedDict() od.update(dict(pairs)) - self.assertEqual(sorted(od.items()), pairs) # dict input - od = OrderedDict() + self.assertEqual(sorted(od.items()), pairs) + + # kwds input + od = self.module.OrderedDict() od.update(**dict(pairs)) - self.assertEqual(sorted(od.items()), pairs) # kwds input - od = OrderedDict() + self.assertEqual(sorted(od.items()), pairs) + + # pairs input + od = self.module.OrderedDict() od.update(pairs) - self.assertEqual(list(od.items()), pairs) # pairs input - od = OrderedDict() + self.assertEqual(list(od.items()), pairs) + + # mixed input + od = self.module.OrderedDict() od.update([('a', 1), ('b', 2), ('c', 9), ('d', 4)], c=3, e=5) - self.assertEqual(list(od.items()), pairs) # mixed input + self.assertEqual(list(od.items()), pairs) # Issue 9137: Named argument called 'other' or 'self' # shouldn't be treated specially. - od = OrderedDict() + od = self.module.OrderedDict() od.update(self=23) self.assertEqual(list(od.items()), [('self', 23)]) - od = OrderedDict() + od = self.module.OrderedDict() od.update(other={}) self.assertEqual(list(od.items()), [('other', {})]) - od = OrderedDict() + od = self.module.OrderedDict() od.update(red=5, blue=6, other=7, self=8) self.assertEqual(sorted(list(od.items())), [('blue', 6), ('other', 7), ('red', 5), ('self', 8)]) # Make sure that direct calls to update do not clear previous contents # add that updates items are not moved to the end - d = OrderedDict([('a', 1), ('b', 2), ('c', 3), ('d', 44), ('e', 55)]) + first_pairs = [('a', 1), ('b', 2), ('c', 3), ('d', 44), ('e', 55)] + d = self.module.OrderedDict(first_pairs) d.update([('e', 5), ('f', 6)], g=7, d=4) self.assertEqual(list(d.items()), - [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5), ('f', 6), ('g', 7)]) + [('a', 1), ('b', 2), ('c', 3), ('d', 4), ('e', 5), + ('f', 6), ('g', 7)]) def test_abc(self): - self.assertIsInstance(OrderedDict(), MutableMapping) - self.assertTrue(issubclass(OrderedDict, MutableMapping)) + self.assertIsInstance(self.module.OrderedDict(), MutableMapping) + self.assertTrue(issubclass(self.module.OrderedDict, MutableMapping)) def test_clear(self): pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] shuffle(pairs) - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) self.assertEqual(len(od), len(pairs)) + od.clear() self.assertEqual(len(od), 0) def test_delitem(self): pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) del od['a'] self.assertNotIn('a', od) with self.assertRaises(KeyError): @@ -1139,16 +131,20 @@ self.assertEqual(list(od.items()), pairs[:2] + pairs[3:]) def test_setitem(self): - od = OrderedDict([('d', 1), ('b', 2), ('c', 3), ('a', 4), ('e', 5)]) - od['c'] = 10 # existing element - od['f'] = 20 # new element + pairs = [('d', 1), ('b', 2), ('c', 3), ('a', 4), ('e', 5)] + od = self.module.OrderedDict(pairs) + # existing element + od['c'] = 10 + # new element + od['f'] = 20 self.assertEqual(list(od.items()), - [('d', 1), ('b', 2), ('c', 10), ('a', 4), ('e', 5), ('f', 20)]) + [('d', 1), ('b', 2), ('c', 10), ('a', 4), ('e', 5), + ('f', 20)]) def test_iterators(self): pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] shuffle(pairs) - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) self.assertEqual(list(od), [t[0] for t in pairs]) self.assertEqual(list(od.keys()), [t[0] for t in pairs]) self.assertEqual(list(od.values()), [t[1] for t in pairs]) @@ -1159,7 +155,7 @@ def test_popitem(self): pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] shuffle(pairs) - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) while pairs: self.assertEqual(od.popitem(), pairs.pop()) with self.assertRaises(KeyError): @@ -1169,7 +165,7 @@ def test_pop(self): pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] shuffle(pairs) - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) shuffle(pairs) while pairs: k, v = pairs.pop() @@ -1180,62 +176,75 @@ self.assertEqual(od.pop(k, 12345), 12345) # make sure pop still works when __missing__ is defined - class Missing(OrderedDict): + class Missing(self.module.OrderedDict): def __missing__(self, key): return 0 - m = Missing(a=1) + m = Missing(asdf=1) self.assertEqual(m.pop('b', 5), 5) - self.assertEqual(m.pop('a', 6), 1) + self.assertEqual(m.pop('asdf', 6), 1) self.assertEqual(m.pop('a', 6), 6) with self.assertRaises(KeyError): m.pop('a') def test_equality(self): + # same order implies equality pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] shuffle(pairs) - od1 = OrderedDict(pairs) - od2 = OrderedDict(pairs) - self.assertEqual(od1, od2) # same order implies equality + od1 = self.module.OrderedDict(pairs) + od2 = self.module.OrderedDict(pairs) + self.assertEqual(od1, od2) + + # different order implies inequality pairs = pairs[2:] + pairs[:2] - od2 = OrderedDict(pairs) - self.assertNotEqual(od1, od2) # different order implies inequality + od2 = self.module.OrderedDict(pairs) + self.assertNotEqual(od1, od2) + # comparison to regular dict is not order sensitive self.assertEqual(od1, dict(od2)) self.assertEqual(dict(od2), od1) + # different length implied inequality - self.assertNotEqual(od1, OrderedDict(pairs[:-1])) + self.assertNotEqual(od1, self.module.OrderedDict(pairs[:-1])) def test_copying(self): # Check that ordered dicts are copyable, deepcopyable, picklable, # and have a repr/eval round-trip + OrderedDict = self.module.OrderedDict pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) - update_test = OrderedDict() + od = self.module.OrderedDict(pairs) + update_test = self.module.OrderedDict() update_test.update(od) - for i, dup in enumerate([ - od.copy(), - copy.copy(od), - copy.deepcopy(od), - pickle.loads(pickle.dumps(od, 0)), - pickle.loads(pickle.dumps(od, 1)), - pickle.loads(pickle.dumps(od, 2)), - pickle.loads(pickle.dumps(od, 3)), - pickle.loads(pickle.dumps(od, -1)), - eval(repr(od)), - update_test, - OrderedDict(od), - ]): - self.assertTrue(dup is not od) - self.assertEqual(dup, od) - self.assertEqual(list(dup.items()), list(od.items())) - self.assertEqual(len(dup), len(od)) - self.assertEqual(type(dup), type(od)) + + # pickle directly pulls the module, so we have to fake it + original_module = sys.modules['collections'] + sys.modules['collections'] = self.module + try: + for i, dup in enumerate([ + od.copy(), + copy.copy(od), + copy.deepcopy(od), + pickle.loads(pickle.dumps(od, 0)), + pickle.loads(pickle.dumps(od, 1)), + pickle.loads(pickle.dumps(od, 2)), + pickle.loads(pickle.dumps(od, 3)), + pickle.loads(pickle.dumps(od, -1)), + eval(repr(od)), + update_test, + self.module.OrderedDict(od), + ]): + self.assertTrue(dup is not od) + self.assertEqual(dup, od) + self.assertEqual(list(dup.items()), list(od.items())) + self.assertEqual(len(dup), len(od)) + self.assertEqual(type(dup), type(od)) + finally: + sys.modules['collections'] = original_module def test_yaml_linkage(self): - # Verify that __reduce__ is setup in a way that supports PyYAML's dump() feature. - # In yaml, lists are native but tuples are not. + # Verify that __reduce__ is setup in a way that supports PyYAML's + # dump() feature. In yaml, lists are native but tuples are not. pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) # yaml.dump(od) --> # '!!python/object/apply:__main__.OrderedDict\n- - [a, 1]\n - [b, 2]\n' self.assertTrue(all(type(pair)==list for pair in od.__reduce__()[1])) @@ -1243,29 +252,33 @@ def test_reduce_not_too_fat(self): # do not save instance dictionary if not needed pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) self.assertEqual(len(od.__reduce__()), 2) od.x = 10 self.assertEqual(len(od.__reduce__()), 3) def test_repr(self): - od = OrderedDict([('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)]) + od = self.module.OrderedDict([('c', 1), ('b', 2), ('a', 3), ('d', 4), + ('e', 5), ('f', 6)]) self.assertEqual(repr(od), - "OrderedDict([('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)])") + "OrderedDict([('c', 1), ('b', 2), ('a', 3), ('d', 4), " + "('e', 5), ('f', 6)])") + OrderedDict = self.module.OrderedDict self.assertEqual(eval(repr(od)), od) - self.assertEqual(repr(OrderedDict()), "OrderedDict()") + self.assertEqual(repr(self.module.OrderedDict()), "OrderedDict()") def test_repr_recursive(self): # See issue #9826 - od = OrderedDict.fromkeys('abc') + od = self.module.OrderedDict.fromkeys('abc') od['x'] = od self.assertEqual(repr(od), - "OrderedDict([('a', None), ('b', None), ('c', None), ('x', ...)])") + "OrderedDict([('a', None), ('b', None), ('c', None), " + "('x', ...)])") def test_setdefault(self): pairs = [('c', 1), ('b', 2), ('a', 3), ('d', 4), ('e', 5), ('f', 6)] shuffle(pairs) - od = OrderedDict(pairs) + od = self.module.OrderedDict(pairs) pair_order = list(od.items()) self.assertEqual(od.setdefault('a', 10), 3) # make sure order didn't change @@ -1275,7 +288,7 @@ self.assertEqual(list(od.items())[-1], ('x', 10)) # make sure setdefault still works when __missing__ is defined - class Missing(OrderedDict): + class Missing(self.module.OrderedDict): def __missing__(self, key): return 0 self.assertEqual(Missing().setdefault(5, 9), 9) @@ -1283,15 +296,16 @@ def test_reinsert(self): # Given insert a, insert b, delete a, re-insert a, # verify that a is now later than b. - od = OrderedDict() + od = self.module.OrderedDict() od['a'] = 1 od['b'] = 2 del od['a'] + self.assertEqual(list(od.items()), [('b', 2)]) od['a'] = 1 self.assertEqual(list(od.items()), [('b', 2), ('a', 1)]) def test_move_to_end(self): - od = OrderedDict.fromkeys('abcde') + od = self.module.OrderedDict.fromkeys('abcde') self.assertEqual(list(od), list('abcde')) od.move_to_end('c') self.assertEqual(list(od), list('abdec')) @@ -1305,50 +319,93 @@ od.move_to_end('x') def test_sizeof(self): - # Wimpy test: Just verify the reported size is larger than a regular dict + # Wimpy test: Just verify the reported size is larger than a + # regular dict d = dict(a=1) - od = OrderedDict(**d) + od = self.module.OrderedDict(**d) self.assertGreater(sys.getsizeof(od), sys.getsizeof(d)) def test_override_update(self): - # Verify that subclasses can override update() without breaking __init__() - class MyOD(OrderedDict): + # Verify that subclasses can override update() without breaking + # __init__() + class MyOD(self.module.OrderedDict): def update(self, *args, **kwds): raise Exception() items = [('a', 1), ('c', 3), ('b', 2)] self.assertEqual(list(MyOD(items).items()), items) -class GeneralMappingTests(mapping_tests.BasicTestMappingProtocol): - type2test = OrderedDict + +class PurePythonOrderedDictTests(OrderedDictTests, unittest.TestCase): + + module = py_coll + + +@unittest.skipUnless(c_coll, 'requires the C version of the collections module') +class CPythonOrderedDictTests(OrderedDictTests, unittest.TestCase): + + module = c_coll + + +class PurePythonGeneralMappingTests(mapping_tests.BasicTestMappingProtocol): + + @classmethod + def setUpClass(cls): + cls.type2test = py_coll.OrderedDict def test_popitem(self): d = self._empty_mapping() self.assertRaises(KeyError, d.popitem) -class MyOrderedDict(OrderedDict): - pass -class SubclassMappingTests(mapping_tests.BasicTestMappingProtocol): - type2test = MyOrderedDict +@unittest.skipUnless(c_coll, 'requires the C version of the collections module') +class CPythonGeneralMappingTests(mapping_tests.BasicTestMappingProtocol): + + @classmethod + def setUpClass(cls): + cls.type2test = c_coll.OrderedDict def test_popitem(self): d = self._empty_mapping() self.assertRaises(KeyError, d.popitem) +class PurePythonSubclassMappingTests(mapping_tests.BasicTestMappingProtocol): + + @classmethod + def setUpClass(cls): + class MyOrderedDict(py_coll.OrderedDict): + pass + cls.type2test = MyOrderedDict + + def test_popitem(self): + d = self._empty_mapping() + self.assertRaises(KeyError, d.popitem) + + +@unittest.skipUnless(c_coll, 'requires the C version of the collections module') +class CPythonSubclassMappingTests(mapping_tests.BasicTestMappingProtocol): + + @classmethod + def setUpClass(cls): + class MyOrderedDict(c_coll.OrderedDict): + pass + cls.type2test = MyOrderedDict + + def test_popitem(self): + d = self._empty_mapping() + self.assertRaises(KeyError, d.popitem) + + ################################################################################ ### Run tests ################################################################################ -import doctest, collections - def test_main(verbose=None): - NamedTupleDocs = doctest.DocTestSuite(module=collections) - test_classes = [TestNamedTuple, NamedTupleDocs, TestOneTrickPonyABCs, - TestCollectionABCs, TestCounter, TestChainMap, - TestOrderedDict, GeneralMappingTests, SubclassMappingTests] + test_classes = [PurePythonOrderedDictTests, CPythonOrderedDictTests, + PurePythonGeneralMappingTests, CPythonGeneralMappingTests, + PurePythonSubclassMappingTests, CPythonSubclassMappingTests, + ] support.run_unittest(*test_classes) - support.run_doctest(collections, verbose) if __name__ == "__main__": diff --git a/Modules/_collectionsmodule.c b/Modules/_collectionsmodule.c --- a/Modules/_collectionsmodule.c +++ b/Modules/_collectionsmodule.c @@ -1805,6 +1805,9 @@ Py_INCREF(&defdict_type); PyModule_AddObject(m, "defaultdict", (PyObject *)&defdict_type); + Py_INCREF(&PyODict_Type); + PyModule_AddObject(m, "OrderedDict", (PyObject *)&PyODict_Type); + if (PyType_Ready(&dequeiter_type) < 0) return NULL; Py_INCREF(&dequeiter_type); diff --git a/Objects/dictobject.c b/Objects/dictobject.c --- a/Objects/dictobject.c +++ b/Objects/dictobject.c @@ -67,7 +67,9 @@ #define PyDict_MINSIZE_COMBINED 8 #include "Python.h" +#include "structmember.h" #include "stringlib/eq.h" +#include typedef struct { /* Cached hash code of me_key. */ @@ -3009,8 +3011,8 @@ value = *value_ptr; Py_INCREF(key); Py_INCREF(value); - PyTuple_SET_ITEM(result, 0, key); - PyTuple_SET_ITEM(result, 1, value); + PyTuple_SET_ITEM(result, 0, key); /* steals reference */ + PyTuple_SET_ITEM(result, 1, value); /* steals reference */ return result; fail: @@ -3794,3 +3796,1840 @@ 2, &PyDictDummy_Type }; + +/*************************************************/ +/* A C implementation of collections.OrderedDict */ +/*************************************************/ + +/* The implementation is a relatively straight-forward linked-list + * approach, similar to the pure Python implementation. + */ + +/* Use of the C-API with this OrderedDict is problematic since the + * concrete PyDict_* API has a number of hard-coded assumptions tied to + * the dict implementation. + */ + +/* XXX Would an odict_contains be generally faster than dict's? */ + +/* XXX avoid any reference cycles */ + +typedef struct _odictnode _ODictNode; + +/* PyODictObject */ +struct _odictobject { + PyDictObject od_dict; + _ODictNode *od_keys; + _ODictNode *od_last; + PyObject *od_inst_dict; + PyObject *od_weakreflist; +}; + + +/* ---------------------------------------------- + * odict keys (a simple doubly-linked list) + */ + +/* XXX reference the hashes in the linked list rather than the keys? */ +struct _odictnode { + PyObject *key; + _ODictNode *next; + _ODictNode *prev; +}; + +/* inserts node before pos_node */ + +static void +_odict_insert_node(PyODictObject *od, _ODictNode *node, _ODictNode *pos_node) +{ + if (od->od_keys == NULL) { + /* implies that od->od_last is also NULL */ + od->od_keys = node; + od->od_last = node; + node->prev = NULL; + node->next = NULL; + } + else if (pos_node == NULL) { + /* end of list */ + od->od_last->next = node; + node->prev = od->od_last; + node->next = NULL; + od->od_last = node; + } + else { + node->prev = pos_node->prev; + if (pos_node->prev == NULL) + /* must be first */ + od->od_keys = node; + else + pos_node->prev->next = node; + node->next = pos_node; + pos_node->prev = node; + } +} + +static _ODictNode * +_odict_find_node(PyODictObject *od, PyObject *key) +{ + _ODictNode *node; + for (node = od->od_keys; node != NULL; node = node->next) + /* XXX compare the hashes instead? */ + if (PyObject_RichCompareBool(key, node->key, Py_EQ)) + return node; + return NULL; +} + +static void +_odict_remove_node(PyODictObject *od, _ODictNode *node, int dealloc) +{ + if (node == NULL) + return; + + if (node->prev == NULL) + /* must be first */ + od->od_keys = node->next; + else + node->prev->next = node->next; + if (node->next == NULL) + /* must be last */ + od->od_last = node->prev; + else + node->next->prev = node->prev; + + if (dealloc) { + Py_DECREF(node->key); +// XXX this segfaults... +// PyMem_Free((void *)node); + } +} + +static void +_odict_clear_nodes(PyODictObject *od) +{ + _ODictNode *node, *next; + + if (od->od_keys == NULL) + return; + + node = od->od_keys; + while (node != NULL) { + Py_DECREF(node->key); + next = node->next; + /* XXX explicitly clear out the node? */ + PyMem_Free((void *)node); + node = next; + } + od->od_last = NULL; + od->od_keys = NULL; +} + +/* adds the node to the end of the list */ + +static int +_odict_add_key(PyODictObject *od, PyObject *key) +{ + _ODictNode *node; + + if (_odict_find_node(od, key) != NULL) + return 0; + + node = (_ODictNode *)PyMem_Malloc(sizeof(_ODictNode)); + if (node == NULL) + return -1; + + Py_INCREF(key); + node->key = key; + node->prev = od->od_last; + node->next = NULL; + if (od->od_keys == NULL) + od->od_keys = node; + else + od->od_last->next = node; + od->od_last = node; + return 0; +} + +/* pos must be within the range of the odict. */ + +static int +_odict_move_key(PyODictObject *od, PyObject *key, Py_ssize_t pos) +{ + _ODictNode *node, *pos_node = NULL; + + /* find the node and the position */ + + if (pos == -1) { + /* end of list */ + for (node = od->od_keys; node != NULL; node = node->next) { + /* XXX compare the hashes instead? */ + if (PyObject_RichCompareBool(key, node->key, Py_EQ)) + break; + } + } + else { + /* pos_node had better get set */ + Py_ssize_t i = 0; + for (node = od->od_keys; node != NULL; node = node->next) { + if (i == pos) + pos_node = node; + ++i; + /* XXX compare the hashes instead? */ + if (PyObject_RichCompareBool(key, node->key, Py_EQ)) + break; + } + if (pos_node == NULL) { + /* found node but not pos_node...yet */ + for (node = od->od_keys; node != NULL; node = node->next) { + if (i == pos) + pos_node = node; + break; + ++i; + } + if (pos_node == NULL) { + PyErr_Format(PyExc_ValueError, + "position out of range: %i", pos); + return -1; + } + } + } + if (node == NULL) { + /* Didn't find the key. */ + PyErr_SetObject(PyExc_KeyError, key); + return -1; + } + + /* make the move */ + + if (node == pos_node) { + /* already at the right spot */ + } + else { + _odict_remove_node(od, node, 0); + _odict_insert_node(od, node, pos_node); + } + return 0; +} + +static void +_odict_remove_key(PyODictObject *od, PyObject *key) +{ + _ODictNode *node = _odict_find_node(od, key); + if (node == NULL) + return; + _odict_remove_node(od, node, 1); +} + +static int +_odict_keys_equal(PyODictObject *a, PyODictObject *b) +{ + _ODictNode *node_a, *node_b; + int count = 0; + + node_a = a->od_keys; + node_b = b->od_keys; + while (1) { + if (count++ == 10) { + PyErr_SetObject(PyExc_TypeError, (PyObject *)a); + return -1; + } + if (node_a == NULL && node_b == NULL) + /* success: hit the end of each at the same time */ + return 1; + else if (node_a == NULL || node_b == NULL) + /* unequal length */ + return 0; + else { + int res = PyObject_RichCompareBool((PyObject *)node_a->key, + (PyObject *)node_b->key, + Py_EQ); + if (res < 0) + return res; + else if (res == 0) + return 0; + + /* otherwise it must match, so move on to the next one */ + node_a = node_a->next; + node_b = node_b->next; + } + } +} + + +/* ---------------------------------------------- + * OrderedDict mapping methods + */ + +/* mp_ass_subscript: __setitem__() and __delitem__() */ + +static int +odict_mp_ass_sub(PyODictObject *od, PyObject *v, PyObject *w) +{ + if (w == NULL) + return PyODict_DelItem((PyObject *)od, v); + else + return PyODict_SetItem((PyObject *)od, v, w); +} + +/* tp_as_mapping */ + +static PyMappingMethods odict_as_mapping = { + 0, /*mp_length*/ + 0, /*mp_subscript*/ + (objobjargproc)odict_mp_ass_sub, /*mp_ass_subscript*/ +}; + + +/* ---------------------------------------------- + * OrderedDict methods + */ + +/* __delitem__() */ + +PyDoc_STRVAR(odict_delitem__doc__, "od.__delitem__(y) <==> del od[y]"); + +/* __eq__() */ + +PyDoc_STRVAR(odict_eq__doc__, +"od.__eq__(y) <==> od==y. Comparison to another OD is order-sensitive \n\ + while comparison to a regular mapping is order-insensitive.\n\ + "); + +static PyObject * odict_richcompare(PyObject *v, PyObject *w, int op); + +static PyObject * +odict_eq(PyObject *a, PyObject *b) +{ + return odict_richcompare(a, b, Py_EQ); +} + +/* __init__() */ + +PyDoc_STRVAR(odict_init__doc__, +"Initialize an ordered dictionary. The signature is the same as\n\ + regular dictionaries, but keyword arguments are not recommended because\n\ + their insertion order is arbitrary.\n\ +\n\ + "); + +/* forward */ +static int odict_init(PyObject *self, PyObject *args, PyObject *kwds); + +/* __iter__() */ + +PyDoc_STRVAR(odict_iter__doc__, "od.__iter__() <==> iter(od)"); + +static PyObject * odict_iter(PyODictObject *self); /* forward */ + +/* __ne__() */ + +/* Mapping.__ne__() does not have a docstring. */ +PyDoc_STRVAR(odict_ne__doc__, ""); + +static PyObject * +odict_ne(PyObject *a, PyObject *b) +{ + return odict_richcompare(a, b, Py_NE); +} + +/* __repr__() */ + +PyDoc_STRVAR(odict_repr__doc__, "od.__repr__() <==> repr(od)"); + +static PyObject * odict_repr(PyODictObject *self); /* forward */ + +/* __setitem__() */ + +PyDoc_STRVAR(odict_setitem__doc__, "od.__setitem__(i, y) <==> od[i]=y"); + +/* fromkeys() */ + +PyDoc_STRVAR(odict_fromkeys__doc__, +"OD.fromkeys(S[, v]) -> New ordered dictionary with keys from S.\n\ + If not specified, the value defaults to None.\n\ +\n\ + "); + +/* __sizeof__() */ + +/* OrderedDict.__sizeof__() does not have a docstring. */ +PyDoc_STRVAR(odict_sizeof__doc__, ""); + +static PyObject * +odict_sizeof(PyODictObject *od) +{ + PyObject *pylong; + Py_ssize_t res; + + pylong = dict_sizeof((PyDictObject *)od); + if (pylong == NULL) + return NULL; + res = PyLong_AsSsize_t(pylong); + Py_DECREF(pylong); + if (res == -1 && PyErr_Occurred()) + return NULL; + + res += sizeof(PyODictObject) - sizeof(PyDictObject); + + /* XXX instance dict */ + + if (od->od_keys != NULL) { + res += sizeof(_ODictNode) * PyODict_SIZE(od); + } + return PyLong_FromSsize_t(res); +} + +/* __reduce__() */ + +PyDoc_STRVAR(odict_reduce__doc__, "Return state information for pickling"); + +static PyObject * +odict_reduce(register PyODictObject *od) +{ + _Py_IDENTIFIER(__dict__); + _Py_IDENTIFIER(__class__); + PyObject *items = NULL, *args = NULL, *pair = NULL, *value = NULL; + PyObject *vars = NULL, *ns = NULL, *result = NULL, *cls = NULL; + _ODictNode *node; + Py_ssize_t i = 0; + + items = PyList_New(PyODict_SIZE(od)); + if (items == NULL) + return NULL; + + for (node = od->od_keys; node != NULL; node = node->next) { + value = PyObject_GetItem((PyObject *)od, node->key); + if (value == NULL) + goto Done; + pair = PyList_New(2); + if (pair == NULL) + goto Done; + Py_INCREF(node->key); + if (PyList_SetItem(pair, 0, node->key) != 0) { /* steals reference */ + Py_DECREF(node->key); + goto Done; + } + if (PyList_SetItem(pair, 1, value) != 0) { /* steals reference */ + Py_DECREF(value); + goto Done; + } + if (PyList_SetItem(items, i, pair) != 0) { /* steals reference */ + goto Done; + } + ++i; + } + + /* capture any instance state */ + vars = _PyObject_GetAttrId((PyObject *)od, &PyId___dict__); + if (vars != NULL) { + PyObject *empty, *od_vars, *iterator, *key; + + /* od.__dict__ isn't necessarily a dict... */ + ns = PyObject_CallMethod((PyObject *)vars, "copy", NULL); + if (ns == NULL) + goto Done; + empty = PyODict_New(); + if (empty == NULL) + goto Done; + od_vars = _PyObject_GetAttrId((PyObject *)empty, &PyId___dict__); + Py_DECREF(empty); + if (od_vars == NULL) + goto Done; + iterator = PyObject_GetIter(od_vars); + Py_DECREF(od_vars); + if (iterator == NULL) + goto Done; + + while ( (key = PyIter_Next(iterator)) ) { + /* XXX set an exception for when a key is in empty but not ns? */ + if (PyMapping_HasKey(ns, key) && PyMapping_DelItem(ns, key) != 0) { + Py_DECREF(iterator); + Py_DECREF(key); + goto Done; + } + Py_DECREF(key); + } + Py_DECREF(iterator); + if (PyErr_Occurred()) + goto Done; + + if (!PyObject_Length(ns)) { + /* nothing novel to pickle in od.__dict__ */ + Py_DECREF(ns); + ns = NULL; + } + } + + /* build the result */ + args = PyTuple_Pack(1, items); + if (args == NULL) + goto Done; + + cls = _PyObject_GetAttrId((PyObject *)od, &PyId___class__); + if (cls == NULL) { + Py_DECREF(args); + goto Done; + } + + if (ns == NULL) + result = PyTuple_Pack(2, cls, args); + else + result = PyTuple_Pack(3, cls, args, ns); + Py_DECREF(args); + Py_DECREF(cls); + +Done: + Py_DECREF(items); + Py_XDECREF(vars); + Py_XDECREF(ns); + + return result; +} + +/* setdefault() */ + +PyDoc_STRVAR(odict_setdefault__doc__, + "od.setdefault(k[,d]) -> od.get(k,d), also set od[k]=d if k not in od"); + +static PyObject * +odict_setdefault(register PyODictObject *od, PyObject *args) +{ + PyObject *key, *result = NULL; + PyObject *failobj = Py_None; + + if (!PyArg_UnpackTuple(args, "setdefault", 1, 2, &key, &failobj)) + return NULL; + Py_INCREF(key); + Py_INCREF(failobj); + + if (PyODict_CheckExact(od)) { + if (_odict_find_node(od, key) != NULL) { + result = PyODict_GetItem(od, key); /* borrowed reference */ + Py_INCREF(result); + Py_DECREF(failobj); + } + else if (PyODict_SetItem((PyObject *)od, key, failobj) >= 0) { + result = failobj; + } + } + else { + _Py_IDENTIFIER(__contains__); + PyObject *found; + + /* skirt around __missing__() call */ + found = _PyObject_CallMethodId((PyObject *)od, &PyId___contains__, "O", + key, NULL); + if (found == NULL) { + Py_DECREF(failobj); + } + else if (found == Py_True) { + result = PyObject_GetItem((PyObject *)od, key); + Py_DECREF(failobj); + } + else if (PyObject_SetItem((PyObject *)od, key, failobj) >= 0) { + result = failobj; + } + Py_XDECREF(found); + } + + Py_DECREF(key); + return result; +} + +/* pop() */ + +PyDoc_STRVAR(odict_pop__doc__, +"od.pop(k[,d]) -> v, remove specified key and return the corresponding\n\ + value. If key is not found, d is returned if given, otherwise KeyError\n\ + is raised.\n\ +\n\ + "); + +static PyObject * +odict_pop(PyODictObject *od, PyObject *args) +{ + PyObject *key, *failobj = NULL, *value = NULL; + + if (!PyArg_UnpackTuple(args, "pop", 1, 2, &key, &failobj)) + return NULL; + Py_INCREF(key); + Py_XINCREF(failobj); + + if (PyODict_CheckExact(od)) { + value = dict_pop((PyDictObject *)od, args); + } + else { + _Py_IDENTIFIER(__contains__); + PyObject *found; + + /* skirt around __missing__() call */ + found = _PyObject_CallMethodId((PyObject *)od, &PyId___contains__, + "O", key, NULL); + if (found == Py_True) { + value = PyObject_GetItem((PyObject *)od, key); + if (value != NULL) { + if (PyObject_DelItem((PyObject *)od, key) == -1) { + Py_DECREF(value); + value = NULL; + } + } + } + else if (found == Py_False) { + if (failobj) { + Py_INCREF(failobj); + value = failobj; + } + else { + PyErr_SetObject(PyExc_KeyError, key); + } + } + Py_XDECREF(found); + } + + if (value != NULL) { + _odict_remove_key(od, key); + } + + Py_DECREF(key); + Py_XDECREF(failobj); + return value; +} + +/* popitem() */ + +PyDoc_STRVAR(odict_popitem__doc__, +"od.popitem() -> (k, v), return and remove a (key, value) pair.\n\ + Pairs are returned in LIFO order if last is true or FIFO order if false.\n\ +\n\ + "); + +static PyObject * +odict_popitem(PyODictObject *od, PyObject *args) +{ + PyObject *value, *item = NULL, *last = NULL; + _ODictNode *node; + int res; + + if (od->od_keys == NULL) { + PyErr_SetString(PyExc_KeyError, "dictionary is empty"); + return NULL; + } + + /* pull the item */ + + if (!PyArg_UnpackTuple(args, "popitem", 0, 1, &last)) + return NULL; + + if (last == NULL || last == Py_True) + node = od->od_last; + else + node = od->od_keys; + Py_XDECREF(last); + + if (PyODict_CheckExact(od)) { + value = PyODict_GetItem((PyObject *)od, node->key); /* borrowed */ + Py_INCREF(value); + } + else { + value = PyObject_GetItem((PyObject *)od, node->key); + } + if (value == NULL) + return NULL; + + item = PyTuple_Pack(2, node->key, value); + Py_DECREF(value); + if (item == NULL) + return NULL; + + /* remove it from the mapping */ + if (PyODict_CheckExact(od)) + res = PyDict_DelItem((PyObject *)od, node->key); + else + res = PyMapping_DelItem((PyObject *)od, node->key); + if (res == -1) { + Py_DECREF(item); + return NULL; + } + _odict_remove_node(od, node, 1); + + return item; +} + +/* keys() */ + +/* MutableMapping.keys() does not have a docstring. */ +PyDoc_STRVAR(odict_keys__doc__, ""); + +static PyObject * odictkeys_new(PyObject *od); /* forward */ + +/* values() */ + +/* MutableMapping.values() does not have a docstring. */ +PyDoc_STRVAR(odict_values__doc__, ""); + +static PyObject * odictvalues_new(PyObject *od); /* forward */ + +/* items() */ + +/* MutableMapping.items() does not have a docstring. */ +PyDoc_STRVAR(odict_items__doc__, ""); + +static PyObject * odictitems_new(PyObject *od); /* forward */ + +/* update() */ + +/* MutableMapping.update() does not have a docstring. */ +PyDoc_STRVAR(odict_update__doc__, ""); + +/* forward */ +static PyObject * mutablemapping_update(PyObject *, PyObject *, PyObject *); + +#define odict_update mutablemapping_update + +/* clear() */ + +PyDoc_STRVAR(odict_clear__doc__, + "od.clear() -> None. Remove all items from od."); + +/* forward */ +static PyObject * mutablemapping_clear(PyObject *); + +static PyObject * +odict_clear(register PyODictObject *od) +{ + if (PyODict_CheckExact(od)) { + if (dict_clear((PyDictObject *)od) == NULL) + return NULL; + } + else if (mutablemapping_clear((PyObject *)od) == NULL) { + return NULL; + } + _odict_clear_nodes(od); + Py_RETURN_NONE; +} + +/* copy() */ + +PyDoc_STRVAR(odict_copy__doc__, "od.copy() -> a shallow copy of od"); + +static PyObject * +odict_copy(register PyODictObject *od) +{ + _ODictNode *node; + PyObject *od_copy; + + if (PyODict_CheckExact(od)) + od_copy = PyODict_New(); + else + od_copy = PyObject_CallFunctionObjArgs((PyObject *)Py_TYPE(od), NULL); + if (od_copy == NULL) + return NULL; + + if (PyODict_CheckExact(od)) { + for (node = od->od_keys; node != NULL; node = node->next) { + PyObject *value = PyODict_GetItem(od, node->key); /* borrowed */ + if (value == NULL) + goto fail; + if (PyODict_SetItem((PyObject *)od_copy, node->key, value) != 0) + goto fail; + } + } + else { + for (node = od->od_keys; node != NULL; node = node->next) { + int res; + PyObject *value = PyObject_GetItem((PyObject *)od, node->key); + if (value == NULL) + goto fail; + res = PyObject_SetItem((PyObject *)od_copy, node->key, value); + Py_DECREF(value); + if (res != 0) + goto fail; + } + } + return od_copy; + +fail: + Py_DECREF(od_copy); + return NULL; +} + +/* __reversed__() */ + +PyDoc_STRVAR(odict_reversed__doc__, "od.__reversed__() <==> reversed(od)"); + +static PyObject * +odict_reversed(register PyODictObject *od) +{ + _ODictNode *node; + Py_ssize_t index = 0; + PyObject *reversed, *iterator; + + reversed = PyList_New(PyODict_SIZE(od)); + if (reversed == NULL) + return NULL; + /* XXX not subclass-friendly? */ + for (node = od->od_last; node != NULL; node = node->prev) { + Py_INCREF(node->key); + if (PyList_SetItem(reversed, index++, node->key) == -1) { /* steals */ + Py_DECREF(reversed); + return NULL; + } + } + iterator = PyObject_GetIter(reversed); + Py_DECREF(reversed); + return iterator; +} + +/* move_to_end() */ + +PyDoc_STRVAR(odict_move_to_end__doc__, +"Move an existing element to the end (or beginning if last==False).\n\ +\n\ + Raises KeyError if the element does not exist.\n\ + When last=True, acts like a fast version of self[key]=self.pop(key).\n\ +\n\ + "); + +static PyObject * +odict_move_to_end(PyODictObject *od, PyObject *args) +{ + PyObject *key, *last = NULL; + Py_ssize_t pos = -1; + + if (!PyArg_UnpackTuple(args, "move_to_end", 1, 2, &key, &last)) + return NULL; + if (last != NULL) { + Py_INCREF(last); + pos = PyObject_IsTrue(last) ? -1 : 0; + } + Py_INCREF(key); + if (_odict_move_key(od, key, pos) < 0) + return NULL; + + Py_DECREF(key); + Py_XDECREF(last); + Py_RETURN_NONE; +} + + +/* tp_methods */ + +static PyMethodDef odict_methods[] = { + + /* explicitly defined so we can align docstrings with + * collections.OrderedDict */ + {"__delitem__", (PyCFunction)odict_mp_ass_sub, METH_NOARGS, + odict_delitem__doc__}, + {"__eq__", (PyCFunction)odict_eq, METH_NOARGS, + odict_eq__doc__}, + {"__init__", (PyCFunction)odict_init, METH_NOARGS, + odict_init__doc__}, + {"__iter__", (PyCFunction)odict_iter, METH_NOARGS, + odict_iter__doc__}, + {"__ne__", (PyCFunction)odict_ne, METH_NOARGS, + odict_ne__doc__}, + {"__repr__", (PyCFunction)odict_repr, METH_NOARGS, + odict_repr__doc__}, + {"__setitem__", (PyCFunction)odict_mp_ass_sub, METH_NOARGS, + odict_setitem__doc__}, + {"fromkeys", (PyCFunction)dict_fromkeys, METH_VARARGS | METH_CLASS, + odict_fromkeys__doc__}, + + /* overridden dict methods */ + {"__sizeof__", (PyCFunction)odict_sizeof, METH_NOARGS, + odict_sizeof__doc__}, + {"__reduce__", (PyCFunction)odict_reduce, METH_NOARGS, + odict_reduce__doc__}, + {"setdefault", (PyCFunction)odict_setdefault, METH_VARARGS, + odict_setdefault__doc__}, + {"pop", (PyCFunction)odict_pop, METH_VARARGS, + odict_pop__doc__}, + {"popitem", (PyCFunction)odict_popitem, METH_VARARGS, + odict_popitem__doc__}, + {"keys", (PyCFunction)odictkeys_new, METH_NOARGS, + odict_keys__doc__}, + {"values", (PyCFunction)odictvalues_new, METH_NOARGS, + odict_values__doc__}, + {"items", (PyCFunction)odictitems_new, METH_NOARGS, + odict_items__doc__}, + {"update", (PyCFunction)odict_update, METH_VARARGS | METH_KEYWORDS, + odict_update__doc__}, + {"clear", (PyCFunction)odict_clear, METH_NOARGS, + odict_clear__doc__}, + {"copy", (PyCFunction)odict_copy, METH_NOARGS, + odict_copy__doc__}, + + /* new methods */ + {"__reversed__", (PyCFunction)odict_reversed, METH_NOARGS, + odict_reversed__doc__}, + {"move_to_end", (PyCFunction)odict_move_to_end, METH_VARARGS, + odict_move_to_end__doc__}, + + {NULL, NULL} /* sentinel */ +}; + + +/* ---------------------------------------------- + * OrderedDict members + */ + +/* tp_members */ + +static PyMemberDef odict_members[] = { + {"__dict__", T_OBJECT, offsetof(PyODictObject, od_inst_dict), READONLY}, + {0} +}; + + +/* ---------------------------------------------- + * OrderedDict type slot methods + */ + +/* tp_dealloc */ + +static void +odict_dealloc(PyODictObject *self) +{ + /* XXX not subclass-friendly? */ + PyDict_Type.tp_dealloc((PyObject *)self); + Py_XDECREF(self->od_inst_dict); + if (self->od_weakreflist != NULL) + PyObject_ClearWeakRefs((PyObject *)self); + _odict_clear_nodes(self); +}; + +/* tp_repr */ + +static PyObject * +odict_repr(PyODictObject *self) +{ + int i; + const char *formatstr, *name; + Py_ssize_t count = -1; + PyObject *pieces = NULL, *result = NULL; + PyObject *classname = NULL, *format = NULL, *args = NULL; + _ODictNode *node; + + i = Py_ReprEnter((PyObject *)self); + if (i != 0) { + return i > 0 ? PyUnicode_FromString("...") : NULL; + } + + if (PyODict_SIZE(self) == 0) { + /* "OrderedDict()" */ + goto Finish; + } + + pieces = PyList_New(PyODict_SIZE(self)); + if (pieces == NULL) + goto Done; + + for (node = self->od_keys; node != NULL; node = node->next) { + PyObject *pair, *value; + + value = PyODict_GetItem(self, node->key); /* borrowed reference */ + + if (value == NULL) + goto Done; + pair = PyTuple_Pack(2, node->key, value); + if (pair == NULL) + goto Done; + + PyList_SET_ITEM(pieces, ++count, pair); /* steals reference */ + } + +Finish: + name = strrchr(Py_TYPE(self)->tp_name, '.'); + if (name == NULL) + name = Py_TYPE(self)->tp_name; + else + name++; + classname = PyUnicode_FromString(name); + if (classname == NULL) + goto Done; + + if (pieces == NULL) { + formatstr = "%s()"; + args = PyTuple_Pack(1, classname); + } + else { + formatstr = "%s(%r)"; + args = PyTuple_Pack(2, classname, pieces); + } + if (args == NULL) + goto Done; + + format = PyUnicode_InternFromString(formatstr); + if (format == NULL) + goto Done; + + result = PyUnicode_Format(format, args); +Done: + Py_XDECREF(pieces); + Py_XDECREF(classname); + Py_XDECREF(format); + Py_XDECREF(args); + Py_ReprLeave((PyObject *)self); + return result; +}; + +/* tp_doc */ + +PyDoc_STRVAR(odict_doc, + "Dictionary that remembers insertion order"); + +/* tp_traverse */ + +static int +odict_traverse(PyODictObject *od, visitproc visit, void *arg) +{ + Py_VISIT(od->od_inst_dict); + Py_VISIT(od->od_weakreflist); + return dict_traverse((PyObject *)od, visit, arg); +} + +/* tp_clear */ + +static int +odict_tp_clear(PyODictObject *od) +{ + Py_CLEAR(od->od_inst_dict); + Py_CLEAR(od->od_weakreflist); + return dict_tp_clear((PyObject *)od); +} + +/* tp_richcompare */ + +static PyObject * +odict_richcompare(PyObject *v, PyObject *w, int op) +{ + /* XXX allow for any mapping type? */ + if (!PyODict_Check(v) || !PyDict_Check(w)) { + Py_RETURN_NOTIMPLEMENTED; + } + else if (op == Py_EQ || op == Py_NE) { + PyObject *res, *cmp; + int eq; + + cmp = PyDict_Type.tp_richcompare(v, w, op); + + if (cmp == NULL) + eq = -1; + else if (cmp == Py_False) + eq = 0; + else if (!PyODict_Check(w)) + eq = 1; + else { + /* Try comparing odict keys. */ + eq = _odict_keys_equal((PyODictObject *)v, (PyODictObject *)w); + } + Py_DECREF(cmp); + + if (eq < 0) + res = NULL; + else { + res = (eq == (op == Py_EQ)) ? Py_True : Py_False; + Py_INCREF(res); + } + return res; + } + else { + Py_RETURN_NOTIMPLEMENTED; + } +}; + +/* tp_iter */ + +static PyObject * odictiter_new(PyODictObject *, PyTypeObject *); /* future */ + +static PyObject * +odict_iter(PyODictObject *od) +{ + return odictiter_new(od, &PyODictIterKey_Type); +}; + +/* tp_init */ + +/* XXX make __init__() reset the ODict */ +static int +odict_init(PyObject *self, PyObject *args, PyObject *kwds) +{ + Py_ssize_t len = PyObject_Length(args); + + if (len == -1) + return -1; + if (len > 1) { + char *msg = "expected at most 1 arguments, got %d"; + PyErr_Format(PyExc_TypeError, msg, len); + return -1; + } + + if (odict_update(self, args, kwds) == NULL) + return -1; + else + return 0; +}; + +/* tp_new */ + +static PyObject * +odict_new(PyTypeObject *type, PyObject *args, PyObject *kwds) +{ + PyObject *od = dict_new(type, args, kwds); + ((PyODictObject *)od)->od_inst_dict = PyDict_New(); + ((PyODictObject *)od)->od_weakreflist = NULL; + ((PyODictObject *)od)->od_keys = NULL; + ((PyODictObject *)od)->od_last = NULL; + return od; +} + +/* PyODict_Type */ + +/* XXX make sure everything is at a thread-safe state when calling into + * Python... + */ + +PyTypeObject PyODict_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "collections.OrderedDict", /* tp_name */ + sizeof(PyODictObject), /* tp_basicsize */ + 0, /* tp_itemsize */ + (destructor)odict_dealloc, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + (reprfunc)odict_repr, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + &odict_as_mapping, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HAVE_GC,/* tp_flags */ + odict_doc, /* tp_doc */ + (traverseproc)odict_traverse, /* tp_traverse */ + (inquiry)odict_tp_clear, /* tp_clear */ + (richcmpfunc)odict_richcompare, /* tp_richcompare */ + offsetof(PyODictObject, od_weakreflist), /* tp_weaklistoffset */ + (getiterfunc)odict_iter, /* tp_iter */ + 0, /* tp_iternext */ + odict_methods, /* tp_methods */ + odict_members, /* tp_members */ + 0, /* tp_getset */ + &PyDict_Type, /* tp_base */ + 0, /* tp_dict */ + 0, /* tp_descr_get */ + 0, /* tp_descr_set */ + offsetof(PyODictObject, od_inst_dict), /* tp_dictoffset */ + (initproc)odict_init, /* tp_init */ + 0, /* tp_alloc */ + (newfunc)odict_new, /* tp_new */ + 0, /* tp_free */ +}; + + +/* ---------------------------------------------- + * the public OrderedDict API + */ + +/* PyODict_New is intended as a more efficient approach than odict_new. */ +PyObject * +PyODict_New(void) { + PyODictObject *od; + + /* XXX do the whole free_list thing, a la PyDict_New? */ + od = PyObject_GC_New(PyODictObject, &PyODict_Type); + if (od == NULL) + return NULL; + ((PyDictObject *)od)->ma_keys = new_keys_object(PyDict_MINSIZE_COMBINED); + ((PyDictObject *)od)->ma_values = NULL; + ((PyDictObject *)od)->ma_used = 0; + od->od_inst_dict = PyDict_New(); + od->od_weakreflist = NULL; + od->od_keys = NULL; + od->od_last = NULL; + return (PyObject *)od; +}; + +int +PyODict_SetItem(PyObject *od, PyObject *key, PyObject *item) { + int res = PyDict_SetItem(od, key, item); + if (res == 0) { + res = _odict_add_key((PyODictObject *)od, key); + if (res != 0) + PyErr_SetNone(PyExc_MemoryError); + } + return res; +}; + +int +PyODict_DelItem(PyObject *od, PyObject *key) { + int res = PyDict_DelItem(od, key); + if (res == 0) + _odict_remove_key((PyODictObject *)od, key); + return res; +}; + + +/* ------------------------------------------- + * The OrderedDict views (keys/values/items) + */ + +typedef struct { + PyObject_HEAD + PyODictObject *di_odict; + _ODictNode *di_current; + PyObject *di_result; /* reusable result tuple for iteritems */ +} odictiterobject; + +static PyObject * +odictiter_new(PyODictObject *od, PyTypeObject *itertype) +{ + odictiterobject *di; + + di = PyObject_GC_New(odictiterobject, itertype); + if (di == NULL) + return NULL; + + Py_INCREF(od); + di->di_odict = od; + di->di_current = od->od_keys; + if (itertype == &PyODictIterItem_Type) { +// di->di_result = NULL; + di->di_result = PyTuple_Pack(2, Py_None, Py_None); + if (di->di_result == NULL) { + Py_DECREF(di); + return NULL; + } + } + else + di->di_result = NULL; +//PyErr_SetString(PyExc_RuntimeError, "made it"); +//return NULL; + _PyObject_GC_TRACK(di); + return (PyObject *)di; +} + +static void +odictiter_dealloc(odictiterobject *di) +{ + Py_XDECREF(di->di_odict); + Py_XDECREF(di->di_result); + PyObject_GC_Del(di); +} + +static int +odictiter_traverse(odictiterobject *di, visitproc visit, void *arg) +{ + Py_VISIT(di->di_odict); + Py_VISIT(di->di_result); + return 0; +} + +static PyObject * +odictiter_len(odictiterobject *di) +{ + /* return the number of remaining items */ + Py_ssize_t len = 0; + _ODictNode *current = di->di_current; + + while (current != NULL) { + len += 1; + current = current->next; + } + return PyLong_FromSize_t(len); +} + +static PyObject * odictiter_iternextkey(odictiterobject *); /* forward */ +static PyObject * odictiter_iternextitem(odictiterobject *); /* forward */ +static PyObject * odictiter_iternextvalue(odictiterobject *); /* forward */ + +static PyObject * +odictiter_reduce(odictiterobject *di) +{ + PyObject *list; + odictiterobject tmp; + + list = PyList_New(0); + if (!list) + return NULL; + + /* copy the itertor state */ + tmp = *di; + Py_XINCREF(tmp.di_odict); + + /* iterate the temporary into a list */ + for(;;) { + PyObject *element = NULL; + if (Py_TYPE(di) == &PyODictIterItem_Type) + element = odictiter_iternextitem(&tmp); + else if (Py_TYPE(di) == &PyODictIterKey_Type) + element = odictiter_iternextkey(&tmp); + else if (Py_TYPE(di) == &PyODictIterValue_Type) + element = odictiter_iternextvalue(&tmp); + else + assert(0); + if (element) { + if (PyList_Append(list, element)) { + Py_DECREF(element); + Py_DECREF(list); + Py_XDECREF(tmp.di_odict); + return NULL; + } + Py_DECREF(element); + } else + break; + } + Py_XDECREF(tmp.di_odict); + /* check for error */ + if (tmp.di_odict != NULL) { + /* we have an error */ + Py_DECREF(list); + return NULL; + } + return Py_BuildValue("N(N)", _PyObject_GetBuiltin("iter"), list); +} + +static PyMethodDef odictiter_methods[] = { + {"__length_hint__", (PyCFunction)odictiter_len, METH_NOARGS, + length_hint_doc}, + {"__reduce__", (PyCFunction)odictiter_reduce, METH_NOARGS, + reduce_doc}, + {NULL, NULL} /* sentinel */ +}; + +PyTypeObject PyODictIterView_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "odict_viewiterator", /* tp_name */ + sizeof(odictiterobject), /* tp_basicsize */ + 0, /* tp_itemsize */ + /* methods */ + (destructor)odictiter_dealloc, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + PyObject_GenericGetAttr, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + (traverseproc)odictiter_traverse, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + PyObject_SelfIter, /* tp_iter */ + 0, /* tp_iternext */ + odictiter_methods, /* tp_methods */ + 0, +}; + +/* keys() */ + +static PyObject * +odictiter_iternextkey(odictiterobject *di) +{ + /* XXX handle resized while iterating case? */ + PyObject *key; + + if (di->di_current == NULL) + return NULL; + + key = di->di_current->key; + di->di_current = di->di_current->next; + Py_INCREF(key); + return key; +} + +PyTypeObject PyODictIterKey_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "odict_keyiterator", /* tp_name */ + 0, /* tp_basicsize */ + 0, /* tp_itemsize */ + 0, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + 0, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + 0, /* tp_iter */ + (iternextfunc)odictiter_iternextkey, /* tp_iternext */ + 0, /* tp_methods */ + 0, /* tp_members */ + 0, /* tp_getset */ + &PyODictIterView_Type, /* tp_base */ + 0, +}; + +static PyObject * +odictkeys_iter(dictviewobject *dv) +{ + if (dv->dv_dict == NULL) { + Py_RETURN_NONE; + } + return odictiter_new((PyODictObject *)dv->dv_dict, &PyODictIterKey_Type); +} + +PyTypeObject PyODictKeys_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "odict_keys", /* tp_name */ + 0, /* tp_basicsize */ + 0, /* tp_itemsize */ + 0, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + 0, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + (getiterfunc)odictkeys_iter, /* tp_iter */ + 0, /* tp_iternext */ + 0, /* tp_methods */ + 0, /* tp_members */ + 0, /* tp_getset */ + &PyDictKeys_Type, /* tp_base */ +}; + +static PyObject * +odictkeys_new(PyObject *od) +{ + return dictview_new(od, &PyODictKeys_Type); +} + +/* items() */ + +static PyObject * +odictiter_iternextitem(odictiterobject *di) +{ + /* XXX handle resized while iterating case? */ + PyObject *key, *value, *result = di->di_result; + + if (di->di_current == NULL) + /* done iterating */ + return NULL; + + key = di->di_current->key; + di->di_current = di->di_current->next; + + value = PyODict_GetItem(di->di_odict, key); /* borrowed reference */ + if (value == NULL) + return NULL; + + if (result && result->ob_refcnt == 1) { + Py_INCREF(result); + Py_DECREF(PyTuple_GET_ITEM(result, 0)); + Py_DECREF(PyTuple_GET_ITEM(result, 1)); + } else { + result = PyTuple_New(2); + if (result == NULL) + return NULL; + } + + Py_INCREF(key); + Py_INCREF(value); + PyTuple_SET_ITEM(result, 0, key); /* steals reference */ + PyTuple_SET_ITEM(result, 1, value); /* steals reference */ + + return result; +} + +PyTypeObject PyODictIterItem_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "odict_itemiterator", /* tp_name */ + 0, /* tp_basicsize */ + 0, /* tp_itemsize */ + 0, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + 0, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + 0, /* tp_iter */ + (iternextfunc)odictiter_iternextitem, /* tp_iternext */ + 0, /* tp_methods */ + 0, /* tp_members */ + 0, /* tp_getset */ + &PyODictIterView_Type, /* tp_base */ + 0, +}; + +static PyObject * +odictitems_iter(dictviewobject *dv) +{ + if (dv->dv_dict == NULL) { + Py_RETURN_NONE; + } + return odictiter_new((PyODictObject *)dv->dv_dict, &PyODictIterItem_Type); +} + +PyTypeObject PyODictItems_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "odict_items", /* tp_name */ + 0, /* tp_basicsize */ + 0, /* tp_itemsize */ + 0, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + 0, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + (getiterfunc)odictitems_iter, /* tp_iter */ + 0, /* tp_iternext */ + 0, /* tp_methods */ + 0, /* tp_members */ + 0, /* tp_getset */ + &PyDictItems_Type, /* tp_base */ +}; + +static PyObject * +odictitems_new(PyObject *od) +{ +// return dictview_new(od, &PyODictItems_Type); + /* XXX cheating */ + _ODictNode *node; + PyObject *items = PyList_New(0); + + for (node = ((PyODictObject *)od)->od_keys; node != NULL; node = node->next) { + PyList_Append(items, + PyTuple_Pack(2, node->key, PyODict_GetItem(od, node->key))); + } + return PyObject_GetIter(items); +} + +/* values() */ + +static PyObject * +odictiter_iternextvalue(odictiterobject *di) +{ + /* XXX handle resized while iterating case? */ + PyObject *key, *value; + + if (di->di_current == NULL) + return NULL; + + key = di->di_current->key; + di->di_current = di->di_current->next; + value = PyODict_GetItem(di->di_odict, key); /* borrowed reference */ + Py_INCREF(value); + return value; +} + +PyTypeObject PyODictIterValue_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "odict_valueiterator", /* tp_name */ + 0, /* tp_basicsize */ + 0, /* tp_itemsize */ + 0, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + 0, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + 0, /* tp_iter */ + (iternextfunc)odictiter_iternextvalue, /* tp_iternext */ + 0, /* tp_methods */ + 0, /* tp_members */ + 0, /* tp_getset */ + &PyODictIterView_Type, /* tp_base */ + 0, +}; + +static PyObject * +odictvalues_iter(dictviewobject *dv) +{ + if (dv->dv_dict == NULL) { + Py_RETURN_NONE; + } + return odictiter_new((PyODictObject *)dv->dv_dict, &PyODictIterValue_Type); +} + +PyTypeObject PyODictValues_Type = { + PyVarObject_HEAD_INIT(&PyType_Type, 0) + "odict_values", /* tp_name */ + 0, /* tp_basicsize */ + 0, /* tp_itemsize */ + 0, /* tp_dealloc */ + 0, /* tp_print */ + 0, /* tp_getattr */ + 0, /* tp_setattr */ + 0, /* tp_reserved */ + 0, /* tp_repr */ + 0, /* tp_as_number */ + 0, /* tp_as_sequence */ + 0, /* tp_as_mapping */ + 0, /* tp_hash */ + 0, /* tp_call */ + 0, /* tp_str */ + 0, /* tp_getattro */ + 0, /* tp_setattro */ + 0, /* tp_as_buffer */ + Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, /* tp_flags */ + 0, /* tp_doc */ + 0, /* tp_traverse */ + 0, /* tp_clear */ + 0, /* tp_richcompare */ + 0, /* tp_weaklistoffset */ + (getiterfunc)odictvalues_iter, /* tp_iter */ + 0, /* tp_iternext */ + 0, /* tp_methods */ + 0, /* tp_members */ + 0, /* tp_getset */ + &PyDictValues_Type, /* tp_base */ +}; + +static PyObject * +odictvalues_new(PyObject *od) +{ + return dictview_new(od, &PyODictValues_Type); +} + + +/* ---------------------------------------------- + * MutableMappping implementations + */ +/* XXX move to abstract.c? */ + +static int +mutablemapping_add_pairs(PyObject *self, PyObject *pairs) +{ + PyObject *pair, *iterator; + int res = 0; + + iterator = PyObject_GetIter(pairs); + if (iterator == NULL) + return -1; + PyErr_Clear(); + + while ((pair = PyIter_Next(iterator)) != NULL) { + /* XXX could be more efficient (see UNPACK_SEQUENCE in ceval.c) */ + PyObject * key, *value = NULL, *pair_iterator = PyObject_GetIter(pair); + + key = PyIter_Next(pair_iterator); + if (key == NULL) { + if (!PyErr_Occurred()) + PyErr_SetString(PyExc_ValueError, + "need more than 0 values to unpack"); + goto Done; + } + + value = PyIter_Next(pair_iterator); + if (value == NULL) { + if (!PyErr_Occurred()) + PyErr_SetString(PyExc_ValueError, + "need more than 1 value to unpack"); + goto Done; + } + + if (PyIter_Next(pair_iterator) != NULL) { + PyErr_SetString(PyExc_ValueError, + "too many values to unpack (expected 2)"); + goto Done; + } + else if (PyErr_Occurred()) + goto Done; + + res = PyObject_SetItem(self, key, value); + +Done: + Py_DECREF(pair); + Py_DECREF(pair_iterator); + Py_XDECREF(key); + Py_XDECREF(value); + if (PyErr_Occurred()) + break; + } + Py_DECREF(iterator); + + if (res < 0 || PyErr_Occurred() != NULL) + return -1; + else + return 0; +} + +static PyObject * +mutablemapping_update(PyObject *self, PyObject *args, PyObject *kwargs) +{ + int res = 0; + Py_ssize_t len = (args != NULL) ? PyObject_Size(args) : 0; + + /* first handle args, if any */ + if (len < 0) + return NULL; + else if (len > 1) { + char *msg = "update() takes at most 1 positional argument (%d given)"; + PyErr_Format(PyExc_TypeError, msg, len); + return NULL; + } + else if (len == 1) { + PyObject *other = PyTuple_GET_ITEM(args, 0); /* borrowed reference */ + if (other == NULL) + return NULL; + Py_INCREF(other); + if (PyObject_HasAttrString(other, "items")) { + PyObject *items = PyMapping_Items(other); + Py_DECREF(other); + if (items == NULL) + return NULL; + res = mutablemapping_add_pairs(self, items); + Py_DECREF(items); + if (res == -1) + return NULL; + } + else if (PyObject_HasAttrString(other, "keys")) { + PyObject *keys, *iterator, *key; + keys = PyObject_CallMethod(other, "keys", NULL); + Py_DECREF(other); + if (keys == NULL) + return NULL; + iterator = PyObject_GetIter(keys); + Py_DECREF(keys); + if (iterator == NULL) + return NULL; + while ( (key = PyIter_Next(iterator)) ) { + PyObject *value = PyObject_GetItem(other, key); + if (value == NULL) { + Py_DECREF(key); + res = -1; + break; + } + res = PyObject_SetItem(self, key, value); + Py_DECREF(key); + Py_DECREF(value); + if (res == -1) + break; + } + Py_DECREF(iterator); + if (res != 0 || PyErr_Occurred()) + return NULL; + } + else { + res = mutablemapping_add_pairs(self, other); + Py_DECREF(other); + if (res != 0) + return NULL; + } + } + + /* now handle kwargs */ + len = (kwargs != NULL) ? PyObject_Size(kwargs) : 0; + if (len < 0) + return NULL; + else if (len > 0) { + PyObject *items; + if (!PyMapping_Check(kwargs)) { + PyErr_SetString(PyExc_TypeError, "expected mapping for kwargs"); + return NULL; + } + items = PyMapping_Items(kwargs); + if (items == NULL) + return NULL; + res = mutablemapping_add_pairs(self, items); + Py_DECREF(items); + if (res == -1) + return NULL; + } + + Py_RETURN_NONE; +} + +static PyObject * +mutablemapping_clear(PyObject *self) +{ + PyObject *res; + _Py_IDENTIFIER(popitem); + do { + res = _PyObject_CallMethodId(self, &PyId_popitem, NULL); + } while (res); + + if (PyErr_ExceptionMatches(PyExc_KeyError)) { + PyErr_Clear(); + Py_RETURN_NONE; + } + else { + return NULL; + } +} diff --git a/Objects/object.c b/Objects/object.c --- a/Objects/object.c +++ b/Objects/object.c @@ -1627,6 +1627,27 @@ if (PyType_Ready(&PyDict_Type) < 0) Py_FatalError("Can't initialize dict type"); + if (PyType_Ready(&PyODict_Type) < 0) + Py_FatalError("Can't initialize OrderedDict type"); + + if (PyType_Ready(&PyODictKeys_Type) < 0) + Py_FatalError("Can't initialize odict_keys type"); + + if (PyType_Ready(&PyODictItems_Type) < 0) + Py_FatalError("Can't initialize odict_items type"); + + if (PyType_Ready(&PyODictValues_Type) < 0) + Py_FatalError("Can't initialize odict_values type"); + + if (PyType_Ready(&PyODictIterKey_Type) < 0) + Py_FatalError("Can't initialize odict_keyiterator type"); + + if (PyType_Ready(&PyODictIterItem_Type) < 0) + Py_FatalError("Can't initialize odict_itemiterator type"); + + if (PyType_Ready(&PyODictIterValue_Type) < 0) + Py_FatalError("Can't initialize odict_valueiterator type"); + if (PyType_Ready(&PySet_Type) < 0) Py_FatalError("Can't initialize set type");