blob: a352ee356054b5d68853024e24055928f29f4b11 [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')
Ezio Melottia40bdda2009-09-26 12:33:22 +000025 self.assertEqual(string.capwords(' aBc DeF '), 'Abc Def')
26 self.assertEqual(string.capwords('\taBc\tDeF\t'), 'Abc Def')
27 self.assertEqual(string.capwords('\taBc\tDeF\t', '\t'), '\tAbc\tDef\t')
Ezio Melotti2c6a9492009-09-26 12:19:30 +000028
Eric Smith8c663262007-08-25 02:26:07 +000029 def test_formatter(self):
30 fmt = string.Formatter()
31 self.assertEqual(fmt.format("foo"), "foo")
32
Eric Smith7ade6482007-08-26 22:27:13 +000033 self.assertEqual(fmt.format("foo{0}", "bar"), "foobar")
34 self.assertEqual(fmt.format("foo{1}{0}-{1}", "bar", 6), "foo6bar-6")
35 self.assertEqual(fmt.format("-{arg!r}-", arg='test'), "-'test'-")
36
Eric Smith81936692007-08-31 01:14:01 +000037 # override get_value ############################################
Eric Smith7ade6482007-08-26 22:27:13 +000038 class NamespaceFormatter(string.Formatter):
39 def __init__(self, namespace={}):
40 string.Formatter.__init__(self)
41 self.namespace = namespace
42
43 def get_value(self, key, args, kwds):
44 if isinstance(key, str):
45 try:
46 # Check explicitly passed arguments first
47 return kwds[key]
48 except KeyError:
49 return self.namespace[key]
50 else:
51 string.Formatter.get_value(key, args, kwds)
52
53 fmt = NamespaceFormatter({'greeting':'hello'})
54 self.assertEqual(fmt.format("{greeting}, world!"), 'hello, world!')
Eric Smith8c663262007-08-25 02:26:07 +000055
56
Eric Smith81936692007-08-31 01:14:01 +000057 # override format_field #########################################
58 class CallFormatter(string.Formatter):
59 def format_field(self, value, format_spec):
60 return format(value(), format_spec)
61
62 fmt = CallFormatter()
63 self.assertEqual(fmt.format('*{0}*', lambda : 'result'), '*result*')
64
65
66 # override convert_field ########################################
67 class XFormatter(string.Formatter):
68 def convert_field(self, value, conversion):
69 if conversion == 'x':
70 return None
71 return super(XFormatter, self).convert_field(value, conversion)
72
73 fmt = XFormatter()
74 self.assertEqual(fmt.format("{0!r}:{0!x}", 'foo', 'foo'), "'foo':None")
75
76
77 # override parse ################################################
78 class BarFormatter(string.Formatter):
79 # returns an iterable that contains tuples of the form:
80 # (literal_text, field_name, format_spec, conversion)
81 def parse(self, format_string):
82 for field in format_string.split('|'):
83 if field[0] == '+':
84 # it's markup
85 field_name, _, format_spec = field[1:].partition(':')
86 yield '', field_name, format_spec, None
87 else:
88 yield field, None, None, None
89
90 fmt = BarFormatter()
91 self.assertEqual(fmt.format('*|+0:^10s|*', 'foo'), '* foo *')
92
Eric Smith3bcc42a2007-08-31 02:26:31 +000093 # test all parameters used
94 class CheckAllUsedFormatter(string.Formatter):
95 def check_unused_args(self, used_args, args, kwargs):
Ezio Melotti42da6632011-03-15 05:18:48 +020096 # Track which arguments actually got used
Eric Smith3bcc42a2007-08-31 02:26:31 +000097 unused_args = set(kwargs.keys())
98 unused_args.update(range(0, len(args)))
99
100 for arg in used_args:
101 unused_args.remove(arg)
102
103 if unused_args:
104 raise ValueError("unused arguments")
105
106 fmt = CheckAllUsedFormatter()
107 self.assertEqual(fmt.format("{0}", 10), "10")
108 self.assertEqual(fmt.format("{0}{i}", 10, i=100), "10100")
109 self.assertEqual(fmt.format("{0}{i}{1}", 10, 20, i=100), "1010020")
110 self.assertRaises(ValueError, fmt.format, "{0}{i}{1}", 10, 20, i=100, j=0)
111 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20)
112 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20, i=100)
113 self.assertRaises(ValueError, fmt.format, "{i}", 10, 20, i=100)
114
Nick Coghland25fd4d2011-03-15 08:54:37 +1000115 def test_vformat_assert(self):
116 cls = string.Formatter()
117 kwargs = {
118 "i": 100
119 }
120 self.assertRaises(ValueError, cls._vformat,
121 cls.format, "{0}", kwargs, set(), -2)
122
123 def test_convert_field(self):
124 cls = string.Formatter()
125 self.assertEqual(cls.format("{0!s}", 'foo'), 'foo')
126 self.assertRaises(ValueError, cls.format, "{0!h}", 'foo')
127
128 def test_get_field(self):
129 cls = string.Formatter()
130 class MyClass:
131 name = 'lumberjack'
132 x = MyClass()
133 self.assertEqual(cls.format("{0.name}", x), 'lumberjack')
134
135 lookup = ["eggs", "and", "spam"]
136 self.assertEqual(cls.format("{0[2]}", lookup), 'spam')
137
138
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000139def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000140 support.run_unittest(ModuleTest)
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000141
142if __name__ == "__main__":
143 test_main()