| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | # Copyright (C) 2004 Python Software Foundation | 
					
						
							|  |  |  | # Author: barry@python.org (Barry Warsaw) | 
					
						
							|  |  |  | # License: http://www.opensource.org/licenses/PythonSoftFoundation.php | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | import unittest | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  | from string import Template | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | class Bag: | 
					
						
							|  |  |  |     pass | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | class Mapping: | 
					
						
							|  |  |  |     def __getitem__(self, name): | 
					
						
							|  |  |  |         obj = self | 
					
						
							|  |  |  |         for part in name.split('.'): | 
					
						
							|  |  |  |             try: | 
					
						
							|  |  |  |                 obj = getattr(obj, part) | 
					
						
							|  |  |  |             except AttributeError: | 
					
						
							|  |  |  |                 raise KeyError(name) | 
					
						
							|  |  |  |         return obj | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  | class TestTemplate(unittest.TestCase): | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |     def test_regular_templates(self): | 
					
						
							|  |  |  |         s = Template('$who likes to eat a bag of $what worth $$100') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         self.assertEqual(s.substitute(dict(who='tim', what='ham')), | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |                          'tim likes to eat a bag of ham worth $100') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         self.assertRaises(KeyError, s.substitute, dict(who='tim')) | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  |     def test_regular_templates_with_braces(self): | 
					
						
							|  |  |  |         s = Template('$who likes ${what} for ${meal}') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         d = dict(who='tim', what='ham', meal='dinner') | 
					
						
							|  |  |  |         self.assertEqual(s.substitute(d), 'tim likes ham for dinner') | 
					
						
							|  |  |  |         self.assertRaises(KeyError, s.substitute, | 
					
						
							|  |  |  |                           dict(who='tim', what='ham')) | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  |     def test_escapes(self): | 
					
						
							|  |  |  |         eq = self.assertEqual | 
					
						
							|  |  |  |         s = Template('$who likes to eat a bag of $$what worth $$100') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         eq(s.substitute(dict(who='tim', what='ham')), | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |            'tim likes to eat a bag of $what worth $100') | 
					
						
							|  |  |  |         s = Template('$who likes $$') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         eq(s.substitute(dict(who='tim', what='ham')), 'tim likes $') | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  |     def test_percents(self): | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         eq = self.assertEqual | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |         s = Template('%(foo)s $foo ${foo}') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         d = dict(foo='baz') | 
					
						
							|  |  |  |         eq(s.substitute(d), '%(foo)s baz baz') | 
					
						
							|  |  |  |         eq(s.safe_substitute(d), '%(foo)s baz baz') | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  |     def test_stringification(self): | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         eq = self.assertEqual | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |         s = Template('tim has eaten $count bags of ham today') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         d = dict(count=7) | 
					
						
							|  |  |  |         eq(s.substitute(d), 'tim has eaten 7 bags of ham today') | 
					
						
							|  |  |  |         eq(s.safe_substitute(d), 'tim has eaten 7 bags of ham today') | 
					
						
							|  |  |  |         s = Template('tim has eaten ${count} bags of ham today') | 
					
						
							|  |  |  |         eq(s.substitute(d), 'tim has eaten 7 bags of ham today') | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2006-07-05 11:03:49 +00:00
										 |  |  |     def test_tupleargs(self): | 
					
						
							|  |  |  |         eq = self.assertEqual | 
					
						
							|  |  |  |         s = Template('$who ate ${meal}') | 
					
						
							|  |  |  |         d = dict(who=('tim', 'fred'), meal=('ham', 'kung pao')) | 
					
						
							|  |  |  |         eq(s.substitute(d), "('tim', 'fred') ate ('ham', 'kung pao')") | 
					
						
							|  |  |  |         eq(s.safe_substitute(d), "('tim', 'fred') ate ('ham', 'kung pao')") | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |     def test_SafeTemplate(self): | 
					
						
							|  |  |  |         eq = self.assertEqual | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         s = Template('$who likes ${what} for ${meal}') | 
					
						
							|  |  |  |         eq(s.safe_substitute(dict(who='tim')), 'tim likes ${what} for ${meal}') | 
					
						
							|  |  |  |         eq(s.safe_substitute(dict(what='ham')), '$who likes ham for ${meal}') | 
					
						
							|  |  |  |         eq(s.safe_substitute(dict(what='ham', meal='dinner')), | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |            '$who likes ham for dinner') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         eq(s.safe_substitute(dict(who='tim', what='ham')), | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |            'tim likes ham for ${meal}') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         eq(s.safe_substitute(dict(who='tim', what='ham', meal='dinner')), | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |            'tim likes ham for dinner') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     def test_invalid_placeholders(self): | 
					
						
							|  |  |  |         raises = self.assertRaises | 
					
						
							|  |  |  |         s = Template('$who likes $') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         raises(ValueError, s.substitute, dict(who='tim')) | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |         s = Template('$who likes ${what)') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         raises(ValueError, s.substitute, dict(who='tim')) | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  |         s = Template('$who likes $100') | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |         raises(ValueError, s.substitute, dict(who='tim')) | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     def test_idpattern_override(self): | 
					
						
							|  |  |  |         class PathPattern(Template): | 
					
						
							|  |  |  |             idpattern = r'[_a-z][._a-z0-9]*' | 
					
						
							|  |  |  |         m = Mapping() | 
					
						
							|  |  |  |         m.bag = Bag() | 
					
						
							|  |  |  |         m.bag.foo = Bag() | 
					
						
							|  |  |  |         m.bag.foo.who = 'tim' | 
					
						
							|  |  |  |         m.bag.what = 'ham' | 
					
						
							|  |  |  |         s = PathPattern('$bag.foo.who likes to eat a bag of $bag.what') | 
					
						
							|  |  |  |         self.assertEqual(s.substitute(m), 'tim likes to eat a bag of ham') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     def test_pattern_override(self): | 
					
						
							|  |  |  |         class MyPattern(Template): | 
					
						
							|  |  |  |             pattern = r"""
 | 
					
						
							|  |  |  |             (?P<escaped>@{2})                   | | 
					
						
							|  |  |  |             @(?P<named>[_a-z][._a-z0-9]*)       | | 
					
						
							|  |  |  |             @{(?P<braced>[_a-z][._a-z0-9]*)}    | | 
					
						
							| 
									
										
										
										
											2004-09-13 20:53:27 +00:00
										 |  |  |             (?P<invalid>@) | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |             """
 | 
					
						
							|  |  |  |         m = Mapping() | 
					
						
							|  |  |  |         m.bag = Bag() | 
					
						
							|  |  |  |         m.bag.foo = Bag() | 
					
						
							|  |  |  |         m.bag.foo.who = 'tim' | 
					
						
							|  |  |  |         m.bag.what = 'ham' | 
					
						
							|  |  |  |         s = MyPattern('@bag.foo.who likes to eat a bag of @bag.what') | 
					
						
							|  |  |  |         self.assertEqual(s.substitute(m), 'tim likes to eat a bag of ham') | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-10-17 16:27:18 +00:00
										 |  |  |         class BadPattern(Template): | 
					
						
							|  |  |  |             pattern = r"""
 | 
					
						
							|  |  |  |             (?P<badname>.*)                     | | 
					
						
							|  |  |  |             (?P<escaped>@{2})                   | | 
					
						
							|  |  |  |             @(?P<named>[_a-z][._a-z0-9]*)       | | 
					
						
							|  |  |  |             @{(?P<braced>[_a-z][._a-z0-9]*)}    | | 
					
						
							|  |  |  |             (?P<invalid>@)                      | | 
					
						
							|  |  |  |             """
 | 
					
						
							|  |  |  |         s = BadPattern('@bag.foo.who likes to eat a bag of @bag.what') | 
					
						
							|  |  |  |         self.assertRaises(ValueError, s.substitute, {}) | 
					
						
							|  |  |  |         self.assertRaises(ValueError, s.safe_substitute, {}) | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-09-10 03:08:08 +00:00
										 |  |  |     def test_unicode_values(self): | 
					
						
							|  |  |  |         s = Template('$who likes $what') | 
					
						
							|  |  |  |         d = dict(who=u't\xffm', what=u'f\xfe\fed') | 
					
						
							|  |  |  |         self.assertEqual(s.substitute(d), u't\xffm likes f\xfe\x0ced') | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-09-13 14:35:59 +00:00
										 |  |  |     def test_keyword_arguments(self): | 
					
						
							|  |  |  |         eq = self.assertEqual | 
					
						
							|  |  |  |         s = Template('$who likes $what') | 
					
						
							|  |  |  |         eq(s.substitute(who='tim', what='ham'), 'tim likes ham') | 
					
						
							|  |  |  |         eq(s.substitute(dict(who='tim'), what='ham'), 'tim likes ham') | 
					
						
							|  |  |  |         eq(s.substitute(dict(who='fred', what='kung pao'), | 
					
						
							|  |  |  |                         who='tim', what='ham'), | 
					
						
							|  |  |  |            'tim likes ham') | 
					
						
							|  |  |  |         s = Template('the mapping is $mapping') | 
					
						
							|  |  |  |         eq(s.substitute(dict(foo='none'), mapping='bozo'), | 
					
						
							|  |  |  |            'the mapping is bozo') | 
					
						
							|  |  |  |         eq(s.substitute(dict(mapping='one'), mapping='two'), | 
					
						
							|  |  |  |            'the mapping is two') | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     def test_keyword_arguments_safe(self): | 
					
						
							|  |  |  |         eq = self.assertEqual | 
					
						
							| 
									
										
										
										
											2004-09-13 15:24:43 +00:00
										 |  |  |         raises = self.assertRaises | 
					
						
							| 
									
										
										
										
											2004-09-13 14:35:59 +00:00
										 |  |  |         s = Template('$who likes $what') | 
					
						
							|  |  |  |         eq(s.safe_substitute(who='tim', what='ham'), 'tim likes ham') | 
					
						
							|  |  |  |         eq(s.safe_substitute(dict(who='tim'), what='ham'), 'tim likes ham') | 
					
						
							|  |  |  |         eq(s.safe_substitute(dict(who='fred', what='kung pao'), | 
					
						
							|  |  |  |                         who='tim', what='ham'), | 
					
						
							|  |  |  |            'tim likes ham') | 
					
						
							|  |  |  |         s = Template('the mapping is $mapping') | 
					
						
							|  |  |  |         eq(s.safe_substitute(dict(foo='none'), mapping='bozo'), | 
					
						
							|  |  |  |            'the mapping is bozo') | 
					
						
							|  |  |  |         eq(s.safe_substitute(dict(mapping='one'), mapping='two'), | 
					
						
							|  |  |  |            'the mapping is two') | 
					
						
							| 
									
										
										
										
											2004-09-13 15:24:43 +00:00
										 |  |  |         d = dict(mapping='one') | 
					
						
							|  |  |  |         raises(TypeError, s.substitute, d, {}) | 
					
						
							|  |  |  |         raises(TypeError, s.safe_substitute, d, {}) | 
					
						
							| 
									
										
										
										
											2004-09-13 14:35:59 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-09-14 02:34:08 +00:00
										 |  |  |     def test_delimiter_override(self): | 
					
						
							| 
									
										
										
										
											2004-11-01 03:52:43 +00:00
										 |  |  |         eq = self.assertEqual | 
					
						
							|  |  |  |         raises = self.assertRaises | 
					
						
							| 
									
										
										
										
											2004-09-14 02:34:08 +00:00
										 |  |  |         class AmpersandTemplate(Template): | 
					
						
							|  |  |  |             delimiter = '&' | 
					
						
							|  |  |  |         s = AmpersandTemplate('this &gift is for &{who} &&') | 
					
						
							| 
									
										
										
										
											2004-11-01 03:52:43 +00:00
										 |  |  |         eq(s.substitute(gift='bud', who='you'), 'this bud is for you &') | 
					
						
							|  |  |  |         raises(KeyError, s.substitute) | 
					
						
							|  |  |  |         eq(s.safe_substitute(gift='bud', who='you'), 'this bud is for you &') | 
					
						
							|  |  |  |         eq(s.safe_substitute(), 'this &gift is for &{who} &') | 
					
						
							| 
									
										
										
										
											2004-09-14 02:34:08 +00:00
										 |  |  |         s = AmpersandTemplate('this &gift is for &{who} &') | 
					
						
							| 
									
										
										
										
											2004-11-01 03:52:43 +00:00
										 |  |  |         raises(ValueError, s.substitute, dict(gift='bud', who='you')) | 
					
						
							|  |  |  |         eq(s.safe_substitute(), 'this &gift is for &{who} &') | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2010-02-07 12:16:12 +00:00
										 |  |  |         class PieDelims(Template): | 
					
						
							|  |  |  |             delimiter = '@' | 
					
						
							|  |  |  |         s = PieDelims('@who likes to eat a bag of @{what} worth $100') | 
					
						
							|  |  |  |         self.assertEqual(s.substitute(dict(who='tim', what='ham')), | 
					
						
							|  |  |  |                          'tim likes to eat a bag of ham worth $100') | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | def test_main(): | 
					
						
							|  |  |  |     from test import test_support | 
					
						
							| 
									
										
										
										
											2004-09-14 02:34:08 +00:00
										 |  |  |     test_classes = [TestTemplate,] | 
					
						
							|  |  |  |     test_support.run_unittest(*test_classes) | 
					
						
							| 
									
										
										
										
											2004-08-25 02:22:30 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | if __name__ == '__main__': | 
					
						
							| 
									
										
										
										
											2004-09-14 02:34:08 +00:00
										 |  |  |     test_main() |