blob: 34d1dcf3fe6490e6fa3e6d7e0b5bbbde7b677342 [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 Melotti2dcd4c52009-09-26 12:27:13 +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 Melotti029625c2009-09-26 12:35:01 +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 Melotti2dcd4c52009-09-26 12:27:13 +000028
R David Murraye56bf972012-08-19 17:26:34 -040029 def test_conversion_specifiers(self):
30 fmt = string.Formatter()
31 self.assertEqual(fmt.format("-{arg!r}-", arg='test'), "-'test'-")
32 self.assertEqual(fmt.format("{0!s}", 'test'), 'test')
33 self.assertRaises(ValueError, fmt.format, "{0!h}", 'test')
34 # issue13579
35 self.assertEqual(fmt.format("{0!a}", 42), '42')
36 self.assertEqual(fmt.format("{0!a}", string.ascii_letters),
37 "'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'")
38 self.assertEqual(fmt.format("{0!a}", chr(255)), "'\\xff'")
39 self.assertEqual(fmt.format("{0!a}", chr(256)), "'\\u0100'")
40
Eric Smith8c663262007-08-25 02:26:07 +000041 def test_formatter(self):
42 fmt = string.Formatter()
43 self.assertEqual(fmt.format("foo"), "foo")
44
Eric Smith7ade6482007-08-26 22:27:13 +000045 self.assertEqual(fmt.format("foo{0}", "bar"), "foobar")
46 self.assertEqual(fmt.format("foo{1}{0}-{1}", "bar", 6), "foo6bar-6")
47 self.assertEqual(fmt.format("-{arg!r}-", arg='test'), "-'test'-")
48
Eric Smith81936692007-08-31 01:14:01 +000049 # override get_value ############################################
Eric Smith7ade6482007-08-26 22:27:13 +000050 class NamespaceFormatter(string.Formatter):
51 def __init__(self, namespace={}):
52 string.Formatter.__init__(self)
53 self.namespace = namespace
54
55 def get_value(self, key, args, kwds):
56 if isinstance(key, str):
57 try:
58 # Check explicitly passed arguments first
59 return kwds[key]
60 except KeyError:
61 return self.namespace[key]
62 else:
63 string.Formatter.get_value(key, args, kwds)
64
65 fmt = NamespaceFormatter({'greeting':'hello'})
66 self.assertEqual(fmt.format("{greeting}, world!"), 'hello, world!')
Eric Smith8c663262007-08-25 02:26:07 +000067
68
Eric Smith81936692007-08-31 01:14:01 +000069 # override format_field #########################################
70 class CallFormatter(string.Formatter):
71 def format_field(self, value, format_spec):
72 return format(value(), format_spec)
73
74 fmt = CallFormatter()
75 self.assertEqual(fmt.format('*{0}*', lambda : 'result'), '*result*')
76
77
78 # override convert_field ########################################
79 class XFormatter(string.Formatter):
80 def convert_field(self, value, conversion):
81 if conversion == 'x':
82 return None
83 return super(XFormatter, self).convert_field(value, conversion)
84
85 fmt = XFormatter()
86 self.assertEqual(fmt.format("{0!r}:{0!x}", 'foo', 'foo'), "'foo':None")
87
88
89 # override parse ################################################
90 class BarFormatter(string.Formatter):
91 # returns an iterable that contains tuples of the form:
92 # (literal_text, field_name, format_spec, conversion)
93 def parse(self, format_string):
94 for field in format_string.split('|'):
95 if field[0] == '+':
96 # it's markup
97 field_name, _, format_spec = field[1:].partition(':')
98 yield '', field_name, format_spec, None
99 else:
100 yield field, None, None, None
101
102 fmt = BarFormatter()
103 self.assertEqual(fmt.format('*|+0:^10s|*', 'foo'), '* foo *')
104
Eric Smith3bcc42a2007-08-31 02:26:31 +0000105 # test all parameters used
106 class CheckAllUsedFormatter(string.Formatter):
107 def check_unused_args(self, used_args, args, kwargs):
Ezio Melotti42da6632011-03-15 05:18:48 +0200108 # Track which arguments actually got used
Eric Smith3bcc42a2007-08-31 02:26:31 +0000109 unused_args = set(kwargs.keys())
110 unused_args.update(range(0, len(args)))
111
112 for arg in used_args:
113 unused_args.remove(arg)
114
115 if unused_args:
116 raise ValueError("unused arguments")
117
118 fmt = CheckAllUsedFormatter()
119 self.assertEqual(fmt.format("{0}", 10), "10")
120 self.assertEqual(fmt.format("{0}{i}", 10, i=100), "10100")
121 self.assertEqual(fmt.format("{0}{i}{1}", 10, 20, i=100), "1010020")
122 self.assertRaises(ValueError, fmt.format, "{0}{i}{1}", 10, 20, i=100, j=0)
123 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20)
124 self.assertRaises(ValueError, fmt.format, "{0}", 10, 20, i=100)
125 self.assertRaises(ValueError, fmt.format, "{i}", 10, 20, i=100)
126
Nick Coghlan7462fa62011-03-16 14:30:45 -0400127 def test_vformat_assert(self):
128 cls = string.Formatter()
129 kwargs = {
130 "i": 100
131 }
132 self.assertRaises(ValueError, cls._vformat,
133 cls.format, "{0}", kwargs, set(), -2)
134
135 def test_convert_field(self):
136 cls = string.Formatter()
137 self.assertEqual(cls.format("{0!s}", 'foo'), 'foo')
138 self.assertRaises(ValueError, cls.format, "{0!h}", 'foo')
139
140 def test_get_field(self):
141 cls = string.Formatter()
142 class MyClass:
143 name = 'lumberjack'
144 x = MyClass()
145 self.assertEqual(cls.format("{0.name}", x), 'lumberjack')
146
147 lookup = ["eggs", "and", "spam"]
148 self.assertEqual(cls.format("{0[2]}", lookup), 'spam')
149
150
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000151def test_main():
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000152 support.run_unittest(ModuleTest)
Walter Dörwald0fd583c2003-02-21 12:53:50 +0000153
154if __name__ == "__main__":
155 test_main()