test_symtable.py 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257
  1. """
  2. Test the API of the symtable module.
  3. """
  4. import symtable
  5. import unittest
  6. TEST_CODE = """
  7. import sys
  8. glob = 42
  9. some_var = 12
  10. some_non_assigned_global_var = 11
  11. some_assigned_global_var = 11
  12. class Mine:
  13. instance_var = 24
  14. def a_method(p1, p2):
  15. pass
  16. def spam(a, b, *var, **kw):
  17. global bar
  18. global some_assigned_global_var
  19. some_assigned_global_var = 12
  20. bar = 47
  21. some_var = 10
  22. x = 23
  23. glob
  24. def internal():
  25. return x
  26. def other_internal():
  27. nonlocal some_var
  28. some_var = 3
  29. return some_var
  30. return internal
  31. def foo():
  32. pass
  33. def namespace_test(): pass
  34. def namespace_test(): pass
  35. """
  36. def find_block(block, name):
  37. for ch in block.get_children():
  38. if ch.get_name() == name:
  39. return ch
  40. class SymtableTest(unittest.TestCase):
  41. top = symtable.symtable(TEST_CODE, "?", "exec")
  42. # These correspond to scopes in TEST_CODE
  43. Mine = find_block(top, "Mine")
  44. a_method = find_block(Mine, "a_method")
  45. spam = find_block(top, "spam")
  46. internal = find_block(spam, "internal")
  47. other_internal = find_block(spam, "other_internal")
  48. foo = find_block(top, "foo")
  49. def test_type(self):
  50. self.assertEqual(self.top.get_type(), "module")
  51. self.assertEqual(self.Mine.get_type(), "class")
  52. self.assertEqual(self.a_method.get_type(), "function")
  53. self.assertEqual(self.spam.get_type(), "function")
  54. self.assertEqual(self.internal.get_type(), "function")
  55. def test_id(self):
  56. self.assertGreater(self.top.get_id(), 0)
  57. self.assertGreater(self.Mine.get_id(), 0)
  58. self.assertGreater(self.a_method.get_id(), 0)
  59. self.assertGreater(self.spam.get_id(), 0)
  60. self.assertGreater(self.internal.get_id(), 0)
  61. def test_optimized(self):
  62. self.assertFalse(self.top.is_optimized())
  63. self.assertTrue(self.spam.is_optimized())
  64. def test_nested(self):
  65. self.assertFalse(self.top.is_nested())
  66. self.assertFalse(self.Mine.is_nested())
  67. self.assertFalse(self.spam.is_nested())
  68. self.assertTrue(self.internal.is_nested())
  69. def test_children(self):
  70. self.assertTrue(self.top.has_children())
  71. self.assertTrue(self.Mine.has_children())
  72. self.assertFalse(self.foo.has_children())
  73. def test_lineno(self):
  74. self.assertEqual(self.top.get_lineno(), 0)
  75. self.assertEqual(self.spam.get_lineno(), 14)
  76. def test_function_info(self):
  77. func = self.spam
  78. self.assertEqual(sorted(func.get_parameters()), ["a", "b", "kw", "var"])
  79. expected = ['a', 'b', 'internal', 'kw', 'other_internal', 'some_var', 'var', 'x']
  80. self.assertEqual(sorted(func.get_locals()), expected)
  81. self.assertEqual(sorted(func.get_globals()), ["bar", "glob", "some_assigned_global_var"])
  82. self.assertEqual(self.internal.get_frees(), ("x",))
  83. def test_globals(self):
  84. self.assertTrue(self.spam.lookup("glob").is_global())
  85. self.assertFalse(self.spam.lookup("glob").is_declared_global())
  86. self.assertTrue(self.spam.lookup("bar").is_global())
  87. self.assertTrue(self.spam.lookup("bar").is_declared_global())
  88. self.assertFalse(self.internal.lookup("x").is_global())
  89. self.assertFalse(self.Mine.lookup("instance_var").is_global())
  90. self.assertTrue(self.spam.lookup("bar").is_global())
  91. # Module-scope globals are both global and local
  92. self.assertTrue(self.top.lookup("some_non_assigned_global_var").is_global())
  93. self.assertTrue(self.top.lookup("some_assigned_global_var").is_global())
  94. def test_nonlocal(self):
  95. self.assertFalse(self.spam.lookup("some_var").is_nonlocal())
  96. self.assertTrue(self.other_internal.lookup("some_var").is_nonlocal())
  97. expected = ("some_var",)
  98. self.assertEqual(self.other_internal.get_nonlocals(), expected)
  99. def test_local(self):
  100. self.assertTrue(self.spam.lookup("x").is_local())
  101. self.assertFalse(self.spam.lookup("bar").is_local())
  102. # Module-scope globals are both global and local
  103. self.assertTrue(self.top.lookup("some_non_assigned_global_var").is_local())
  104. self.assertTrue(self.top.lookup("some_assigned_global_var").is_local())
  105. def test_free(self):
  106. self.assertTrue(self.internal.lookup("x").is_free())
  107. def test_referenced(self):
  108. self.assertTrue(self.internal.lookup("x").is_referenced())
  109. self.assertTrue(self.spam.lookup("internal").is_referenced())
  110. self.assertFalse(self.spam.lookup("x").is_referenced())
  111. def test_parameters(self):
  112. for sym in ("a", "var", "kw"):
  113. self.assertTrue(self.spam.lookup(sym).is_parameter())
  114. self.assertFalse(self.spam.lookup("x").is_parameter())
  115. def test_symbol_lookup(self):
  116. self.assertEqual(len(self.top.get_identifiers()),
  117. len(self.top.get_symbols()))
  118. self.assertRaises(KeyError, self.top.lookup, "not_here")
  119. def test_namespaces(self):
  120. self.assertTrue(self.top.lookup("Mine").is_namespace())
  121. self.assertTrue(self.Mine.lookup("a_method").is_namespace())
  122. self.assertTrue(self.top.lookup("spam").is_namespace())
  123. self.assertTrue(self.spam.lookup("internal").is_namespace())
  124. self.assertTrue(self.top.lookup("namespace_test").is_namespace())
  125. self.assertFalse(self.spam.lookup("x").is_namespace())
  126. self.assertTrue(self.top.lookup("spam").get_namespace() is self.spam)
  127. ns_test = self.top.lookup("namespace_test")
  128. self.assertEqual(len(ns_test.get_namespaces()), 2)
  129. self.assertRaises(ValueError, ns_test.get_namespace)
  130. ns_test_2 = self.top.lookup("glob")
  131. self.assertEqual(len(ns_test_2.get_namespaces()), 0)
  132. self.assertRaises(ValueError, ns_test_2.get_namespace)
  133. def test_assigned(self):
  134. self.assertTrue(self.spam.lookup("x").is_assigned())
  135. self.assertTrue(self.spam.lookup("bar").is_assigned())
  136. self.assertTrue(self.top.lookup("spam").is_assigned())
  137. self.assertTrue(self.Mine.lookup("a_method").is_assigned())
  138. self.assertFalse(self.internal.lookup("x").is_assigned())
  139. def test_annotated(self):
  140. st1 = symtable.symtable('def f():\n x: int\n', 'test', 'exec')
  141. st2 = st1.get_children()[0]
  142. self.assertTrue(st2.lookup('x').is_local())
  143. self.assertTrue(st2.lookup('x').is_annotated())
  144. self.assertFalse(st2.lookup('x').is_global())
  145. st3 = symtable.symtable('def f():\n x = 1\n', 'test', 'exec')
  146. st4 = st3.get_children()[0]
  147. self.assertTrue(st4.lookup('x').is_local())
  148. self.assertFalse(st4.lookup('x').is_annotated())
  149. # Test that annotations in the global scope are valid after the
  150. # variable is declared as nonlocal.
  151. st5 = symtable.symtable('global x\nx: int', 'test', 'exec')
  152. self.assertTrue(st5.lookup("x").is_global())
  153. # Test that annotations for nonlocals are valid after the
  154. # variable is declared as nonlocal.
  155. st6 = symtable.symtable('def g():\n'
  156. ' x = 2\n'
  157. ' def f():\n'
  158. ' nonlocal x\n'
  159. ' x: int',
  160. 'test', 'exec')
  161. def test_imported(self):
  162. self.assertTrue(self.top.lookup("sys").is_imported())
  163. def test_name(self):
  164. self.assertEqual(self.top.get_name(), "top")
  165. self.assertEqual(self.spam.get_name(), "spam")
  166. self.assertEqual(self.spam.lookup("x").get_name(), "x")
  167. self.assertEqual(self.Mine.get_name(), "Mine")
  168. def test_class_info(self):
  169. self.assertEqual(self.Mine.get_methods(), ('a_method',))
  170. def test_filename_correct(self):
  171. ### Bug tickler: SyntaxError file name correct whether error raised
  172. ### while parsing or building symbol table.
  173. def checkfilename(brokencode, offset):
  174. try:
  175. symtable.symtable(brokencode, "spam", "exec")
  176. except SyntaxError as e:
  177. self.assertEqual(e.filename, "spam")
  178. self.assertEqual(e.lineno, 1)
  179. self.assertEqual(e.offset, offset)
  180. else:
  181. self.fail("no SyntaxError for %r" % (brokencode,))
  182. checkfilename("def f(x): foo)(", 14) # parse-time
  183. checkfilename("def f(x): global x", 11) # symtable-build-time
  184. symtable.symtable("pass", b"spam", "exec")
  185. with self.assertWarns(DeprecationWarning), \
  186. self.assertRaises(TypeError):
  187. symtable.symtable("pass", bytearray(b"spam"), "exec")
  188. with self.assertWarns(DeprecationWarning):
  189. symtable.symtable("pass", memoryview(b"spam"), "exec")
  190. with self.assertRaises(TypeError):
  191. symtable.symtable("pass", list(b"spam"), "exec")
  192. def test_eval(self):
  193. symbols = symtable.symtable("42", "?", "eval")
  194. def test_single(self):
  195. symbols = symtable.symtable("42", "?", "single")
  196. def test_exec(self):
  197. symbols = symtable.symtable("def f(x): return x", "?", "exec")
  198. def test_bytes(self):
  199. top = symtable.symtable(TEST_CODE.encode('utf8'), "?", "exec")
  200. self.assertIsNotNone(find_block(top, "Mine"))
  201. code = b'# -*- coding: iso8859-15 -*-\nclass \xb4: pass\n'
  202. top = symtable.symtable(code, "?", "exec")
  203. self.assertIsNotNone(find_block(top, "\u017d"))
  204. def test_symtable_repr(self):
  205. self.assertEqual(str(self.top), "<SymbolTable for module ?>")
  206. self.assertEqual(str(self.spam), "<Function SymbolTable for spam in ?>")
  207. if __name__ == '__main__':
  208. unittest.main()