blob: 743fa6b27fe8df82cbd776e6d5754243f17708cd [file] [log] [blame]
Walter Dörwald0fd583c2003-02-21 12:53:50 +00001import unittest, string
Benjamin Petersonee8712c2008-05-20 21:35:26 +00002from test import support
Walter Dörwald0fd583c2003-02-21 12:53:50 +00003
Raymond Hettinger674f2412004-08-23 23:23:54 +00004
Walter Dörwald0fd583c2003-02-21 12:53:50 +00005class ModuleTest(unittest.TestCase):
6
7 def test_attrs(self):
8 string.whitespace
Martin v. Löwis967f1e32007-08-14 09:23:10 +00009 string.ascii_lowercase
10 string.ascii_uppercase
11 string.ascii_letters
Walter Dörwald0fd583c2003-02-21 12:53:50 +000012 string.digits
13 string.hexdigits
14 string.octdigits
15 string.punctuation
16 string.printable
17
Ezio Melotti2c6a9492009-09-26 12:19:30 +000018 def test_capwords(self):
19 self.assertEqual(string.capwords('abc def ghi'), 'Abc Def Ghi')
20 self.assertEqual(string.capwords('abc\tdef\nghi'), 'Abc Def Ghi')
21 self.assertEqual(string.capwords('abc\t def \nghi'), 'Abc Def Ghi')
22 self.assertEqual(string.capwords('ABC DEF GHI'), 'Abc Def Ghi')
23 self.assertEqual(string.capwords('ABC-DEF-GHI', '-'), 'Abc-Def-Ghi')
24 self.assertEqual(string.capwords('ABC-def DEF-ghi GHI'), 'Abc-def Def-ghi Ghi')
25
Eric Smith8c663262007-08-25 02:26:07 +000026 def test_formatter(self):
27 fmt = string.Formatter()
28 self.assertEqual(fmt.format("foo"), "foo")
29
Eric Smith7ade6482007-08-26 22:27:13 +000030 self.assertEqual(fmt.format("foo{0}", "bar"), "foobar")
31 self.assertEqual(fmt.format("foo{1}{0}-{1}", "bar", 6), "foo6bar-6")
32 self.assertEqual(fmt.format("-{arg!r}-", arg='test'), "-'test'-")
33
Eric Smith81936692007-08-31 01:14:01 +000034 # override get_value ############################################
Eric Smith7ade6482007-08-26 22:27:13 +000035 class NamespaceFormatter(string.Formatter):
36 def __init__(self, namespace={}):
37 string.Formatter.__init__(self)
38 self.namespace = namespace
39
40 def get_value(self, key, args, kwds):
41 if isinstance(key, str):
42 try:
43 # Check explicitly passed arguments first
44 return kwds[key]
45 except KeyError:
46 return self.namespace[key]
47 else:
48 string.Formatter.get_value(key, args, kwds)
49
50 fmt = NamespaceFormatter({'greeting':'hello'})
51 self.assertEqual(fmt.format("{greeting}, world!"), 'hello, world!')
Eric Smith8c663262007-08-25 02:26:07 +000052
53
Eric Smith81936692007-08-31 01:14:01 +000054 # override format_field #########################################
55 class CallFormatter(string.Formatter):
56 def format_field(self, value, format_spec):
57 return format(value(), format_spec)
58
59 fmt = CallFormatter()
60 self.assertEqual(fmt.format('*{0}*', lambda : 'result'), '*result*')
61
62
63 # override convert_field ########################################
64 class XFormatter(string.Formatter):
65 def convert_field(self, value, conversion):
66 if conversion == 'x':
67 return None
68 return super(XFormatter, self).convert_field(value, conversion)
69
70 fmt = XFormatter()
71 self.assertEqual(fmt.format("{0!r}:{0!x}", 'foo', 'foo'), "'foo':None")
72
73
74 # override parse ################################################
75 class BarFormatter(string.Formatter):
76 # returns an iterable that contains tuples of the form:
77 # (literal_text, field_name, format_spec, conversion)
78 def parse(self, format_string):
79 for field in format_string.split('|'):
80 if field[0] == '+':
81 # it's markup
82 field_name, _, format_spec = field[1:].partition(':')
83 yield '', field_name, format_spec, None
84 else:
85 yield field, None, None, None
86
87 fmt = BarFormatter()
88 self.assertEqual(fmt.format('*|+0:^10s|*', 'foo'), '* foo *')
89
Eric Smith3bcc42a2007-08-31 02:26:31 +000090 # test all parameters used
91 class CheckAllUsedFormatter(string.Formatter):
92 def check_unused_args(self, used_args, args, kwargs):
93 # Track which arguments actuallly got used
94 unused_args = set(kwargs.keys())
95 unused_args.update(range(0, len(args)))
96
97 for arg in used_args:
98 unused_args.remove(arg)
99
100 if unused_args:
101 raise ValueError("unused arguments")
102
103 fmt = CheckAllUsedFormatter()
104 self.assertEqual(fmt.format("{0}", 10), "10")
105 self.assertEqual(fmt.format("{0}{i}", 10, i=100), "10100")
106 self.assertEqual(fmt.format("{0}{i}{1}", 10, 20, i=100), "1010020")
107 self.assertRaises(ValueError, fmt.format, "{0}{i}{1}", 10, 20, i=100, j=0)
108 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20)
109 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20, i=100)
110 self.assertRaises(ValueError, fmt.format, "{i}", 10, 20, i=100)
111
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000112def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000113 support.run_unittest(ModuleTest)
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000114
115if __name__ == "__main__":
116 test_main()