blob: c2bdfdb0b01d61ae6358508c00989d2ce0a0c83b [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
Nick Coghlan62ecb6a2011-05-31 19:40:11 +100035 def test_conversion_specifiers(self):
36 fmt = string.Formatter()
37 self.assertEqual(fmt.format("-{arg!r}-", arg='test'), "-'test'-")
38 self.assertEqual(fmt.format("{0!s}", 'test'), 'test')
39 self.assertRaises(ValueError, fmt.format, "{0!h}", 'test')
R David Murraye56bf972012-08-19 17:26:34 -040040 # issue13579
41 self.assertEqual(fmt.format("{0!a}", 42), '42')
42 self.assertEqual(fmt.format("{0!a}", string.ascii_letters),
43 "'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'")
44 self.assertEqual(fmt.format("{0!a}", chr(255)), "'\\xff'")
45 self.assertEqual(fmt.format("{0!a}", chr(256)), "'\\u0100'")
Nick Coghlan62ecb6a2011-05-31 19:40:11 +100046
47 def test_name_lookup(self):
48 fmt = string.Formatter()
49 class AnyAttr:
50 def __getattr__(self, attr):
51 return attr
52 x = AnyAttr()
53 self.assertEqual(fmt.format("{0.lumber}{0.jack}", x), 'lumberjack')
54 with self.assertRaises(AttributeError):
55 fmt.format("{0.lumber}{0.jack}", '')
56
57 def test_index_lookup(self):
58 fmt = string.Formatter()
59 lookup = ["eggs", "and", "spam"]
60 self.assertEqual(fmt.format("{0[2]}{0[0]}", lookup), 'spameggs')
61 with self.assertRaises(IndexError):
62 fmt.format("{0[2]}{0[0]}", [])
63 with self.assertRaises(KeyError):
64 fmt.format("{0[2]}{0[0]}", {})
65
66 def test_override_get_value(self):
Eric Smith7ade6482007-08-26 22:27:13 +000067 class NamespaceFormatter(string.Formatter):
68 def __init__(self, namespace={}):
69 string.Formatter.__init__(self)
70 self.namespace = namespace
71
72 def get_value(self, key, args, kwds):
73 if isinstance(key, str):
74 try:
75 # Check explicitly passed arguments first
76 return kwds[key]
77 except KeyError:
78 return self.namespace[key]
79 else:
80 string.Formatter.get_value(key, args, kwds)
81
82 fmt = NamespaceFormatter({'greeting':'hello'})
83 self.assertEqual(fmt.format("{greeting}, world!"), 'hello, world!')
Eric Smith8c663262007-08-25 02:26:07 +000084
85
Nick Coghlan62ecb6a2011-05-31 19:40:11 +100086 def test_override_format_field(self):
Eric Smith81936692007-08-31 01:14:01 +000087 class CallFormatter(string.Formatter):
88 def format_field(self, value, format_spec):
89 return format(value(), format_spec)
90
91 fmt = CallFormatter()
92 self.assertEqual(fmt.format('*{0}*', lambda : 'result'), '*result*')
93
94
Nick Coghlan62ecb6a2011-05-31 19:40:11 +100095 def test_override_convert_field(self):
Eric Smith81936692007-08-31 01:14:01 +000096 class XFormatter(string.Formatter):
97 def convert_field(self, value, conversion):
98 if conversion == 'x':
99 return None
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000100 return super().convert_field(value, conversion)
Eric Smith81936692007-08-31 01:14:01 +0000101
102 fmt = XFormatter()
103 self.assertEqual(fmt.format("{0!r}:{0!x}", 'foo', 'foo'), "'foo':None")
104
105
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000106 def test_override_parse(self):
Eric Smith81936692007-08-31 01:14:01 +0000107 class BarFormatter(string.Formatter):
108 # returns an iterable that contains tuples of the form:
109 # (literal_text, field_name, format_spec, conversion)
110 def parse(self, format_string):
111 for field in format_string.split('|'):
112 if field[0] == '+':
113 # it's markup
114 field_name, _, format_spec = field[1:].partition(':')
115 yield '', field_name, format_spec, None
116 else:
117 yield field, None, None, None
118
119 fmt = BarFormatter()
120 self.assertEqual(fmt.format('*|+0:^10s|*', 'foo'), '* foo *')
121
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000122 def test_check_unused_args(self):
Eric Smith3bcc42a2007-08-31 02:26:31 +0000123 class CheckAllUsedFormatter(string.Formatter):
124 def check_unused_args(self, used_args, args, kwargs):
Ezio Melotti42da6632011-03-15 05:18:48 +0200125 # Track which arguments actually got used
Eric Smith3bcc42a2007-08-31 02:26:31 +0000126 unused_args = set(kwargs.keys())
127 unused_args.update(range(0, len(args)))
128
129 for arg in used_args:
130 unused_args.remove(arg)
131
132 if unused_args:
133 raise ValueError("unused arguments")
134
135 fmt = CheckAllUsedFormatter()
136 self.assertEqual(fmt.format("{0}", 10), "10")
137 self.assertEqual(fmt.format("{0}{i}", 10, i=100), "10100")
138 self.assertEqual(fmt.format("{0}{i}{1}", 10, 20, i=100), "1010020")
139 self.assertRaises(ValueError, fmt.format, "{0}{i}{1}", 10, 20, i=100, j=0)
140 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20)
141 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20, i=100)
142 self.assertRaises(ValueError, fmt.format, "{i}", 10, 20, i=100)
143
Nick Coghlan62ecb6a2011-05-31 19:40:11 +1000144 def test_vformat_recursion_limit(self):
145 fmt = string.Formatter()
146 args = ()
147 kwargs = dict(i=100)
148 with self.assertRaises(ValueError) as err:
149 fmt._vformat("{i}", args, kwargs, set(), -1)
150 self.assertIn("recursion", str(err.exception))
Nick Coghland25fd4d2011-03-15 08:54:37 +1000151
152
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000153def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000154 support.run_unittest(ModuleTest)
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000155
156if __name__ == "__main__":
157 test_main()