blob: b1f3adde65bc737b652cbb3e4f2207b3b0d99569 [file] [log] [blame]
Raymond Hettingerc37e5e02007-03-01 06:16:43 +00001import unittest
2from test import test_support
Raymond Hettingera48a2992007-10-08 21:26:58 +00003from collections import named_tuple
Raymond Hettingerc37e5e02007-03-01 06:16:43 +00004
5class TestNamedTuple(unittest.TestCase):
6
7 def test_factory(self):
Raymond Hettingera48a2992007-10-08 21:26:58 +00008 Point = named_tuple('Point', 'x y')
Raymond Hettingerc37e5e02007-03-01 06:16:43 +00009 self.assertEqual(Point.__name__, 'Point')
10 self.assertEqual(Point.__doc__, 'Point(x, y)')
11 self.assertEqual(Point.__slots__, ())
12 self.assertEqual(Point.__module__, __name__)
13 self.assertEqual(Point.__getitem__, tuple.__getitem__)
Raymond Hettingerabfd8df2007-10-16 21:28:32 +000014
15 self.assertRaises(ValueError, named_tuple, 'abc%', 'efg ghi') # type has non-alpha char
16 self.assertRaises(ValueError, named_tuple, 'class', 'efg ghi') # type has keyword
17 self.assertRaises(ValueError, named_tuple, '9abc', 'efg ghi') # type starts with digit
18
19 self.assertRaises(ValueError, named_tuple, 'abc', 'efg g%hi') # field with non-alpha char
20 self.assertRaises(ValueError, named_tuple, 'abc', 'abc class') # field has keyword
21 self.assertRaises(ValueError, named_tuple, 'abc', '8efg 9ghi') # field starts with digit
22 self.assertRaises(ValueError, named_tuple, 'abc', '__efg__ ghi') # field with double underscores
23 self.assertRaises(ValueError, named_tuple, 'abc', 'efg efg ghi') # duplicate field
24
Raymond Hettingera48a2992007-10-08 21:26:58 +000025 named_tuple('Point0', 'x1 y2') # Verify that numbers are allowed in names
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000026
27 def test_instance(self):
Raymond Hettingera48a2992007-10-08 21:26:58 +000028 Point = named_tuple('Point', 'x y')
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000029 p = Point(11, 22)
30 self.assertEqual(p, Point(x=11, y=22))
31 self.assertEqual(p, Point(11, y=22))
32 self.assertEqual(p, Point(y=22, x=11))
33 self.assertEqual(p, Point(*(11, 22)))
34 self.assertEqual(p, Point(**dict(x=11, y=22)))
35 self.assertRaises(TypeError, Point, 1) # too few args
36 self.assertRaises(TypeError, Point, 1, 2, 3) # too many args
37 self.assertRaises(TypeError, eval, 'Point(XXX=1, y=2)', locals()) # wrong keyword argument
38 self.assertRaises(TypeError, eval, 'Point(x=1)', locals()) # missing keyword argument
39 self.assertEqual(repr(p), 'Point(x=11, y=22)')
40 self.assert_('__dict__' not in dir(p)) # verify instance has no dict
41 self.assert_('__weakref__' not in dir(p))
Raymond Hettingerd36a60e2007-09-17 00:55:00 +000042 self.assertEqual(p.__fields__, ('x', 'y')) # test __fields__ attribute
43 self.assertEqual(p.__replace__('x', 1), (1, 22)) # test __replace__ method
Raymond Hettingera7fc4b12007-10-05 02:47:07 +000044 self.assertEqual(p.__asdict__(), dict(x=11, y=22)) # test __dict__ method
Raymond Hettingerd36a60e2007-09-17 00:55:00 +000045
46 # verify that field string can have commas
Raymond Hettingera48a2992007-10-08 21:26:58 +000047 Point = named_tuple('Point', 'x, y')
Raymond Hettingerd36a60e2007-09-17 00:55:00 +000048 p = Point(x=11, y=22)
49 self.assertEqual(repr(p), 'Point(x=11, y=22)')
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000050
Raymond Hettinger2115bbc2007-10-08 09:14:28 +000051 # verify that fieldspec can be a non-string sequence
Raymond Hettingera48a2992007-10-08 21:26:58 +000052 Point = named_tuple('Point', ('x', 'y'))
Raymond Hettinger2115bbc2007-10-08 09:14:28 +000053 p = Point(x=11, y=22)
54 self.assertEqual(repr(p), 'Point(x=11, y=22)')
55
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000056 def test_tupleness(self):
Raymond Hettingera48a2992007-10-08 21:26:58 +000057 Point = named_tuple('Point', 'x y')
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000058 p = Point(11, 22)
59
60 self.assert_(isinstance(p, tuple))
61 self.assertEqual(p, (11, 22)) # matches a real tuple
62 self.assertEqual(tuple(p), (11, 22)) # coercable to a real tuple
63 self.assertEqual(list(p), [11, 22]) # coercable to a list
64 self.assertEqual(max(p), 22) # iterable
65 self.assertEqual(max(*p), 22) # star-able
66 x, y = p
67 self.assertEqual(p, (x, y)) # unpacks like a tuple
68 self.assertEqual((p[0], p[1]), (11, 22)) # indexable like a tuple
69 self.assertRaises(IndexError, p.__getitem__, 3)
70
71 self.assertEqual(p.x, x)
72 self.assertEqual(p.y, y)
73 self.assertRaises(AttributeError, eval, 'p.z', locals())
74
Raymond Hettinger2b03d452007-09-18 03:33:19 +000075 def test_odd_sizes(self):
Raymond Hettingera48a2992007-10-08 21:26:58 +000076 Zero = named_tuple('Zero', '')
Raymond Hettinger2b03d452007-09-18 03:33:19 +000077 self.assertEqual(Zero(), ())
Raymond Hettingera48a2992007-10-08 21:26:58 +000078 Dot = named_tuple('Dot', 'd')
Raymond Hettinger2b03d452007-09-18 03:33:19 +000079 self.assertEqual(Dot(1), (1,))
80
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000081def test_main(verbose=None):
Raymond Hettinger5a41daf2007-05-19 01:11:16 +000082 import collections as CollectionsModule
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000083 test_classes = [TestNamedTuple]
84 test_support.run_unittest(*test_classes)
Raymond Hettinger5a41daf2007-05-19 01:11:16 +000085 test_support.run_doctest(CollectionsModule, verbose)
Raymond Hettingerc37e5e02007-03-01 06:16:43 +000086
87if __name__ == "__main__":
88 test_main(verbose=True)