blob: 3e6507151e5778bbda45d26978ab4dbff97dec92 [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
Nick Coghlan62ecb6a2011-05-31 19:40:11 +100029 def test_basic_formatter(self):
Eric Smith8c663262007-08-25 02:26:07 +000030 fmt = string.Formatter()
31 self.assertEqual(fmt.format("foo"), "foo")
Eric Smith7ade6482007-08-26 22:27:13 +000032 self.assertEqual(fmt.format("foo{0}", "bar"), "foobar")
33 self.assertEqual(fmt.format("foo{1}{0}-{1}", "bar", 6), "foo6bar-6")
Eric Smith7ade6482007-08-26 22:27:13 +000034
Eric V. Smith7ce90742014-04-14 16:43:50 -040035 def test_auto_numbering(self):
36 fmt = string.Formatter()
37 self.assertEqual(fmt.format('foo{}{}', 'bar', 6),
38 'foo{}{}'.format('bar', 6))
39 self.assertEqual(fmt.format('foo{1}{num}{1}', None, 'bar', num=6),
40 'foo{1}{num}{1}'.format(None, 'bar', num=6))
41 self.assertEqual(fmt.format('{:^{}}', 'bar', 6),
42 '{:^{}}'.format('bar', 6))
43 self.assertEqual(fmt.format('{:^{pad}}{}', 'foo', 'bar', pad=6),
44 '{:^{pad}}{}'.format('foo', 'bar', pad=6))
45
46 with self.assertRaises(ValueError):
47 fmt.format('foo{1}{}', 'bar', 6)
48
49 with self.assertRaises(ValueError):
50 fmt.format('foo{}{1}', 'bar', 6)
51
Nick Coghlan62ecb6a2011-05-31 19:40:11 +100052 def test_conversion_specifiers(self):
53 fmt = string.Formatter()
54 self.assertEqual(fmt.format("-{arg!r}-", arg='test'), "-'test'-")
55 self.assertEqual(fmt.format("{0!s}", 'test'), 'test')
56 self.assertRaises(ValueError, fmt.format, "{0!h}", 'test')
R David Murraye56bf972012-08-19 17:26:34 -040057 # issue13579
58 self.assertEqual(fmt.format("{0!a}", 42), '42')
59 self.assertEqual(fmt.format("{0!a}", string.ascii_letters),
60 "'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'")
61 self.assertEqual(fmt.format("{0!a}", chr(255)), "'\\xff'")
62 self.assertEqual(fmt.format("{0!a}", chr(256)), "'\\u0100'")
Nick Coghlan62ecb6a2011-05-31 19:40:11 +100063
64 def test_name_lookup(self):
65 fmt = string.Formatter()
66 class AnyAttr:
67 def __getattr__(self, attr):
68 return attr
69 x = AnyAttr()
70 self.assertEqual(fmt.format("{0.lumber}{0.jack}", x), 'lumberjack')
71 with self.assertRaises(AttributeError):
72 fmt.format("{0.lumber}{0.jack}", '')
73
74 def test_index_lookup(self):
75 fmt = string.Formatter()
76 lookup = ["eggs", "and", "spam"]
77 self.assertEqual(fmt.format("{0[2]}{0[0]}", lookup), 'spameggs')
78 with self.assertRaises(IndexError):
79 fmt.format("{0[2]}{0[0]}", [])
80 with self.assertRaises(KeyError):
81 fmt.format("{0[2]}{0[0]}", {})
82
83 def test_override_get_value(self):
Eric Smith7ade6482007-08-26 22:27:13 +000084 class NamespaceFormatter(string.Formatter):
85 def __init__(self, namespace={}):
86 string.Formatter.__init__(self)
87 self.namespace = namespace
88
89 def get_value(self, key, args, kwds):
90 if isinstance(key, str):
91 try:
92 # Check explicitly passed arguments first
93 return kwds[key]
94 except KeyError:
95 return self.namespace[key]
96 else:
97 string.Formatter.get_value(key, args, kwds)
98
99 fmt = NamespaceFormatter({'greeting':'hello'})
100 self.assertEqual(fmt.format("{greeting}, world!"), 'hello, world!')
Eric Smith8c663262007-08-25 02:26:07 +0000101
102
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000103 def test_override_format_field(self):
Eric Smith81936692007-08-31 01:14:01 +0000104 class CallFormatter(string.Formatter):
105 def format_field(self, value, format_spec):
106 return format(value(), format_spec)
107
108 fmt = CallFormatter()
109 self.assertEqual(fmt.format('*{0}*', lambda : 'result'), '*result*')
110
111
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000112 def test_override_convert_field(self):
Eric Smith81936692007-08-31 01:14:01 +0000113 class XFormatter(string.Formatter):
114 def convert_field(self, value, conversion):
115 if conversion == 'x':
116 return None
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000117 return super().convert_field(value, conversion)
Eric Smith81936692007-08-31 01:14:01 +0000118
119 fmt = XFormatter()
120 self.assertEqual(fmt.format("{0!r}:{0!x}", 'foo', 'foo'), "'foo':None")
121
122
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000123 def test_override_parse(self):
Eric Smith81936692007-08-31 01:14:01 +0000124 class BarFormatter(string.Formatter):
125 # returns an iterable that contains tuples of the form:
126 # (literal_text, field_name, format_spec, conversion)
127 def parse(self, format_string):
128 for field in format_string.split('|'):
129 if field[0] == '+':
130 # it's markup
131 field_name, _, format_spec = field[1:].partition(':')
132 yield '', field_name, format_spec, None
133 else:
134 yield field, None, None, None
135
136 fmt = BarFormatter()
137 self.assertEqual(fmt.format('*|+0:^10s|*', 'foo'), '* foo *')
138
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000139 def test_check_unused_args(self):
Eric Smith3bcc42a2007-08-31 02:26:31 +0000140 class CheckAllUsedFormatter(string.Formatter):
141 def check_unused_args(self, used_args, args, kwargs):
Ezio Melotti42da6632011-03-15 05:18:48 +0200142 # Track which arguments actually got used
Eric Smith3bcc42a2007-08-31 02:26:31 +0000143 unused_args = set(kwargs.keys())
144 unused_args.update(range(0, len(args)))
145
146 for arg in used_args:
147 unused_args.remove(arg)
148
149 if unused_args:
150 raise ValueError("unused arguments")
151
152 fmt = CheckAllUsedFormatter()
153 self.assertEqual(fmt.format("{0}", 10), "10")
154 self.assertEqual(fmt.format("{0}{i}", 10, i=100), "10100")
155 self.assertEqual(fmt.format("{0}{i}{1}", 10, 20, i=100), "1010020")
156 self.assertRaises(ValueError, fmt.format, "{0}{i}{1}", 10, 20, i=100, j=0)
157 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20)
158 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20, i=100)
159 self.assertRaises(ValueError, fmt.format, "{i}", 10, 20, i=100)
160
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000161 def test_vformat_recursion_limit(self):
162 fmt = string.Formatter()
163 args = ()
164 kwargs = dict(i=100)
165 with self.assertRaises(ValueError) as err:
166 fmt._vformat("{i}", args, kwargs, set(), -1)
167 self.assertIn("recursion", str(err.exception))
Nick Coghland25fd4d2011-03-15 08:54:37 +1000168
169
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000170def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000171 support.run_unittest(ModuleTest)
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000172
173if __name__ == "__main__":
174 test_main()