blob: e614b718ee35f09960c82257d9ba894ce82bf798 [file] [log] [blame]
Guido van Rossumd8faa362007-04-27 19:54:29 +00001# Minimal tests for dis module
2
Zachary Ware38c707e2015-04-13 15:00:43 -05003from test.support import captured_stdout
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10004from test.bytecode_helper import BytecodeTestCase
Guido van Rossumd8faa362007-04-27 19:54:29 +00005import unittest
Skip Montanaroadd0ccc2003-02-27 21:27:07 +00006import sys
7import dis
Guido van Rossum34d19282007-08-09 01:03:29 +00008import io
Zachary Waree80e8062013-12-26 09:53:49 -06009import re
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100010import types
Nick Coghlan90b8e7d2013-11-06 22:08:36 +100011import contextlib
Skip Montanaroadd0ccc2003-02-27 21:27:07 +000012
Nick Coghlan50c48b82013-11-23 00:57:00 +100013def get_tb():
14 def _error():
15 try:
16 1 / 0
17 except Exception as e:
18 tb = e.__traceback__
19 return tb
20
21 tb = _error()
22 while tb.tb_next:
23 tb = tb.tb_next
24 return tb
25
26TRACEBACK_CODE = get_tb().tb_frame.f_code
27
Benjamin Petersond6afe722011-03-15 14:44:52 -050028class _C:
29 def __init__(self, x):
30 self.x = x == 1
31
Serhiy Storchaka585c93d2016-04-23 09:23:52 +030032 @staticmethod
33 def sm(x):
34 x = x == 1
35
36 @classmethod
37 def cm(cls, x):
38 cls.x = x == 1
39
Benjamin Petersond6afe722011-03-15 14:44:52 -050040dis_c_instance_method = """\
Serhiy Storchaka247763d2016-04-12 08:46:28 +030041%3d 0 LOAD_FAST 1 (x)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +030042 2 LOAD_CONST 1 (1)
43 4 COMPARE_OP 2 (==)
44 6 LOAD_FAST 0 (self)
45 8 STORE_ATTR 0 (x)
46 10 LOAD_CONST 0 (None)
47 12 RETURN_VALUE
Benjamin Petersond6afe722011-03-15 14:44:52 -050048""" % (_C.__init__.__code__.co_firstlineno + 1,)
49
50dis_c_instance_method_bytes = """\
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100051 0 LOAD_FAST 1 (1)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +030052 2 LOAD_CONST 1 (1)
53 4 COMPARE_OP 2 (==)
54 6 LOAD_FAST 0 (0)
55 8 STORE_ATTR 0 (0)
56 10 LOAD_CONST 0 (0)
57 12 RETURN_VALUE
Benjamin Petersond6afe722011-03-15 14:44:52 -050058"""
Skip Montanaroadd0ccc2003-02-27 21:27:07 +000059
Serhiy Storchaka585c93d2016-04-23 09:23:52 +030060dis_c_class_method = """\
61%3d 0 LOAD_FAST 1 (x)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +030062 2 LOAD_CONST 1 (1)
63 4 COMPARE_OP 2 (==)
64 6 LOAD_FAST 0 (cls)
65 8 STORE_ATTR 0 (x)
66 10 LOAD_CONST 0 (None)
67 12 RETURN_VALUE
Serhiy Storchaka585c93d2016-04-23 09:23:52 +030068""" % (_C.cm.__code__.co_firstlineno + 2,)
69
70dis_c_static_method = """\
71%3d 0 LOAD_FAST 0 (x)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +030072 2 LOAD_CONST 1 (1)
73 4 COMPARE_OP 2 (==)
74 6 STORE_FAST 0 (x)
75 8 LOAD_CONST 0 (None)
76 10 RETURN_VALUE
Serhiy Storchaka585c93d2016-04-23 09:23:52 +030077""" % (_C.sm.__code__.co_firstlineno + 2,)
78
79# Class disassembling info has an extra newline at end.
80dis_c = """\
81Disassembly of %s:
82%s
83Disassembly of %s:
84%s
85Disassembly of %s:
86%s
87""" % (_C.__init__.__name__, dis_c_instance_method,
88 _C.cm.__name__, dis_c_class_method,
89 _C.sm.__name__, dis_c_static_method)
90
Skip Montanaroadd0ccc2003-02-27 21:27:07 +000091def _f(a):
Guido van Rossumbe19ed72007-02-09 05:37:30 +000092 print(a)
Tim Peterseabafeb2003-03-07 15:55:36 +000093 return 1
Skip Montanaroadd0ccc2003-02-27 21:27:07 +000094
95dis_f = """\
Serhiy Storchaka247763d2016-04-12 08:46:28 +030096%3d 0 LOAD_GLOBAL 0 (print)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +030097 2 LOAD_FAST 0 (a)
Victor Stinnerf9b760f2016-09-09 10:17:08 -070098 4 CALL_FUNCTION 1
Serhiy Storchakab0f80b02016-05-24 09:15:14 +030099 6 POP_TOP
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000100
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300101%3d 8 LOAD_CONST 1 (1)
102 10 RETURN_VALUE
Georg Brandlebbf63b2010-10-14 07:23:01 +0000103""" % (_f.__code__.co_firstlineno + 1,
104 _f.__code__.co_firstlineno + 2)
Michael W. Hudson26848a32003-04-29 17:07:36 +0000105
106
Benjamin Petersond6afe722011-03-15 14:44:52 -0500107dis_f_co_code = """\
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000108 0 LOAD_GLOBAL 0 (0)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300109 2 LOAD_FAST 0 (0)
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700110 4 CALL_FUNCTION 1
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300111 6 POP_TOP
112 8 LOAD_CONST 1 (1)
113 10 RETURN_VALUE
Benjamin Petersond6afe722011-03-15 14:44:52 -0500114"""
115
116
Michael W. Hudson26848a32003-04-29 17:07:36 +0000117def bug708901():
118 for res in range(1,
119 10):
120 pass
121
122dis_bug708901 = """\
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300123%3d 0 SETUP_LOOP 18 (to 20)
124 2 LOAD_GLOBAL 0 (range)
125 4 LOAD_CONST 1 (1)
Michael W. Hudson26848a32003-04-29 17:07:36 +0000126
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300127%3d 6 LOAD_CONST 2 (10)
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700128 8 CALL_FUNCTION 2
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300129 10 GET_ITER
130 >> 12 FOR_ITER 4 (to 18)
131 14 STORE_FAST 0 (res)
Michael W. Hudson26848a32003-04-29 17:07:36 +0000132
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300133%3d 16 JUMP_ABSOLUTE 12
134 >> 18 POP_BLOCK
135 >> 20 LOAD_CONST 0 (None)
136 22 RETURN_VALUE
Georg Brandlebbf63b2010-10-14 07:23:01 +0000137""" % (bug708901.__code__.co_firstlineno + 1,
138 bug708901.__code__.co_firstlineno + 2,
139 bug708901.__code__.co_firstlineno + 3)
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000140
Neal Norwitz51abbc72005-12-18 07:06:23 +0000141
142def bug1333982(x=[]):
143 assert 0, ([s for s in x] +
144 1)
145 pass
146
147dis_bug1333982 = """\
Zachary Warebb4b7c12013-12-26 09:55:24 -0600148%3d 0 LOAD_CONST 1 (0)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300149 2 POP_JUMP_IF_TRUE 26
150 4 LOAD_GLOBAL 0 (AssertionError)
151 6 LOAD_CONST 2 (<code object <listcomp> at 0x..., file "%s", line %d>)
152 8 LOAD_CONST 3 ('bug1333982.<locals>.<listcomp>')
153 10 MAKE_FUNCTION 0
154 12 LOAD_FAST 0 (x)
155 14 GET_ITER
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700156 16 CALL_FUNCTION 1
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300157
158%3d 18 LOAD_CONST 4 (1)
159 20 BINARY_ADD
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700160 22 CALL_FUNCTION 1
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300161 24 RAISE_VARARGS 1
Neal Norwitz51abbc72005-12-18 07:06:23 +0000162
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300163%3d >> 26 LOAD_CONST 0 (None)
164 28 RETURN_VALUE
Georg Brandlebbf63b2010-10-14 07:23:01 +0000165""" % (bug1333982.__code__.co_firstlineno + 1,
Zachary Waree80e8062013-12-26 09:53:49 -0600166 __file__,
167 bug1333982.__code__.co_firstlineno + 1,
Georg Brandlebbf63b2010-10-14 07:23:01 +0000168 bug1333982.__code__.co_firstlineno + 2,
169 bug1333982.__code__.co_firstlineno + 3)
Neal Norwitz51abbc72005-12-18 07:06:23 +0000170
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000171_BIG_LINENO_FORMAT = """\
172%3d 0 LOAD_GLOBAL 0 (spam)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300173 2 POP_TOP
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000174 4 LOAD_CONST 0 (None)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300175 6 RETURN_VALUE
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000176"""
177
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300178_BIG_LINENO_FORMAT2 = """\
179%4d 0 LOAD_GLOBAL 0 (spam)
180 2 POP_TOP
181 4 LOAD_CONST 0 (None)
182 6 RETURN_VALUE
183"""
184
Guido van Rossume7ba4952007-06-06 23:52:48 +0000185dis_module_expected_results = """\
186Disassembly of f:
187 4 0 LOAD_CONST 0 (None)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300188 2 RETURN_VALUE
Guido van Rossume7ba4952007-06-06 23:52:48 +0000189
190Disassembly of g:
191 5 0 LOAD_CONST 0 (None)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300192 2 RETURN_VALUE
Guido van Rossume7ba4952007-06-06 23:52:48 +0000193
194"""
195
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000196expr_str = "x + 1"
197
198dis_expr_str = """\
199 1 0 LOAD_NAME 0 (x)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300200 2 LOAD_CONST 0 (1)
201 4 BINARY_ADD
202 6 RETURN_VALUE
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000203"""
204
205simple_stmt_str = "x = x + 1"
206
207dis_simple_stmt_str = """\
208 1 0 LOAD_NAME 0 (x)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300209 2 LOAD_CONST 0 (1)
210 4 BINARY_ADD
211 6 STORE_NAME 0 (x)
212 8 LOAD_CONST 1 (None)
213 10 RETURN_VALUE
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000214"""
215
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700216annot_stmt_str = """\
217
218x: int = 1
219y: fun(1)
220lst[fun(0)]: int = 1
221"""
222# leading newline is for a reason (tests lineno)
223
224dis_annot_stmt_str = """\
225 2 0 SETUP_ANNOTATIONS
226 2 LOAD_CONST 0 (1)
227 4 STORE_NAME 0 (x)
228 6 LOAD_NAME 1 (int)
229 8 STORE_ANNOTATION 0 (x)
230
231 3 10 LOAD_NAME 2 (fun)
232 12 LOAD_CONST 0 (1)
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700233 14 CALL_FUNCTION 1
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700234 16 STORE_ANNOTATION 3 (y)
235
236 4 18 LOAD_CONST 0 (1)
237 20 LOAD_NAME 4 (lst)
238 22 LOAD_NAME 2 (fun)
239 24 LOAD_CONST 1 (0)
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700240 26 CALL_FUNCTION 1
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700241 28 STORE_SUBSCR
242 30 LOAD_NAME 1 (int)
243 32 POP_TOP
244 34 LOAD_CONST 2 (None)
245 36 RETURN_VALUE
246"""
247
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000248compound_stmt_str = """\
249x = 0
250while 1:
251 x += 1"""
252# Trailing newline has been deliberately omitted
253
254dis_compound_stmt_str = """\
255 1 0 LOAD_CONST 0 (0)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300256 2 STORE_NAME 0 (x)
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000257
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300258 2 4 SETUP_LOOP 12 (to 18)
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000259
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300260 3 >> 6 LOAD_NAME 0 (x)
261 8 LOAD_CONST 1 (1)
262 10 INPLACE_ADD
263 12 STORE_NAME 0 (x)
264 14 JUMP_ABSOLUTE 6
265 16 POP_BLOCK
266 >> 18 LOAD_CONST 2 (None)
267 20 RETURN_VALUE
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000268"""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000269
Nick Coghlan50c48b82013-11-23 00:57:00 +1000270dis_traceback = """\
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300271%3d 0 SETUP_EXCEPT 12 (to 14)
Nick Coghlan50c48b82013-11-23 00:57:00 +1000272
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300273%3d 2 LOAD_CONST 1 (1)
274 4 LOAD_CONST 2 (0)
275 --> 6 BINARY_TRUE_DIVIDE
276 8 POP_TOP
277 10 POP_BLOCK
278 12 JUMP_FORWARD 40 (to 54)
Nick Coghlan50c48b82013-11-23 00:57:00 +1000279
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300280%3d >> 14 DUP_TOP
Nick Coghlan50c48b82013-11-23 00:57:00 +1000281 16 LOAD_GLOBAL 0 (Exception)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300282 18 COMPARE_OP 10 (exception match)
283 20 POP_JUMP_IF_FALSE 52
284 22 POP_TOP
285 24 STORE_FAST 0 (e)
286 26 POP_TOP
287 28 SETUP_FINALLY 12 (to 42)
Nick Coghlan50c48b82013-11-23 00:57:00 +1000288
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300289%3d 30 LOAD_FAST 0 (e)
290 32 LOAD_ATTR 1 (__traceback__)
291 34 STORE_FAST 1 (tb)
292 36 POP_BLOCK
293 38 POP_EXCEPT
294 40 LOAD_CONST 0 (None)
295 >> 42 LOAD_CONST 0 (None)
296 44 STORE_FAST 0 (e)
297 46 DELETE_FAST 0 (e)
298 48 END_FINALLY
299 50 JUMP_FORWARD 2 (to 54)
300 >> 52 END_FINALLY
Nick Coghlan50c48b82013-11-23 00:57:00 +1000301
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300302%3d >> 54 LOAD_FAST 1 (tb)
303 56 RETURN_VALUE
Nick Coghlan50c48b82013-11-23 00:57:00 +1000304""" % (TRACEBACK_CODE.co_firstlineno + 1,
305 TRACEBACK_CODE.co_firstlineno + 2,
306 TRACEBACK_CODE.co_firstlineno + 3,
307 TRACEBACK_CODE.co_firstlineno + 4,
308 TRACEBACK_CODE.co_firstlineno + 5)
309
Serhiy Storchakadd102f72016-10-08 12:34:25 +0300310def _fstring(a, b, c, d):
311 return f'{a} {b:4} {c!r} {d!r:4}'
312
313dis_fstring = """\
314%3d 0 LOAD_FAST 0 (a)
315 2 FORMAT_VALUE 0
316 4 LOAD_CONST 1 (' ')
317 6 LOAD_FAST 1 (b)
318 8 LOAD_CONST 2 ('4')
319 10 FORMAT_VALUE 4 (with format)
320 12 LOAD_CONST 1 (' ')
321 14 LOAD_FAST 2 (c)
322 16 FORMAT_VALUE 2 (repr)
323 18 LOAD_CONST 1 (' ')
324 20 LOAD_FAST 3 (d)
325 22 LOAD_CONST 2 ('4')
326 24 FORMAT_VALUE 6 (repr, with format)
327 26 BUILD_STRING 7
328 28 RETURN_VALUE
329""" % (_fstring.__code__.co_firstlineno + 1,)
330
Nick Coghlanefd5df92014-07-25 23:02:56 +1000331def _g(x):
332 yield x
333
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000334class DisTests(unittest.TestCase):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500335
336 def get_disassembly(self, func, lasti=-1, wrapper=True):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000337 # We want to test the default printing behaviour, not the file arg
338 output = io.StringIO()
339 with contextlib.redirect_stdout(output):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500340 if wrapper:
341 dis.dis(func)
342 else:
343 dis.disassemble(func, lasti)
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000344 return output.getvalue()
Benjamin Petersond6afe722011-03-15 14:44:52 -0500345
346 def get_disassemble_as_string(self, func, lasti=-1):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000347 return self.get_disassembly(func, lasti, False)
Benjamin Petersond6afe722011-03-15 14:44:52 -0500348
Zachary Warebb4b7c12013-12-26 09:55:24 -0600349 def strip_addresses(self, text):
350 return re.sub(r'\b0x[0-9A-Fa-f]+\b', '0x...', text)
Benjamin Petersond6afe722011-03-15 14:44:52 -0500351
352 def do_disassembly_test(self, func, expected):
Zachary Warebb4b7c12013-12-26 09:55:24 -0600353 got = self.get_disassembly(func)
354 if got != expected:
355 got = self.strip_addresses(got)
356 self.assertEqual(got, expected)
Michael W. Hudson26848a32003-04-29 17:07:36 +0000357
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000358 def test_opmap(self):
Benjamin Peterson76f7f4d2011-07-17 22:49:50 -0500359 self.assertEqual(dis.opmap["NOP"], 9)
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000360 self.assertIn(dis.opmap["LOAD_CONST"], dis.hasconst)
361 self.assertIn(dis.opmap["STORE_NAME"], dis.hasname)
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000362
363 def test_opname(self):
364 self.assertEqual(dis.opname[dis.opmap["LOAD_FAST"]], "LOAD_FAST")
365
366 def test_boundaries(self):
367 self.assertEqual(dis.opmap["EXTENDED_ARG"], dis.EXTENDED_ARG)
368 self.assertEqual(dis.opmap["STORE_NAME"], dis.HAVE_ARGUMENT)
369
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300370 def test_widths(self):
371 for opcode, opname in enumerate(dis.opname):
372 if opname in ('BUILD_MAP_UNPACK_WITH_CALL',
373 'BUILD_TUPLE_UNPACK_WITH_CALL'):
374 continue
375 with self.subTest(opname=opname):
376 width = dis._OPNAME_WIDTH
377 if opcode < dis.HAVE_ARGUMENT:
378 width += 1 + dis._OPARG_WIDTH
379 self.assertLessEqual(len(opname), width)
380
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000381 def test_dis(self):
Michael W. Hudson26848a32003-04-29 17:07:36 +0000382 self.do_disassembly_test(_f, dis_f)
383
384 def test_bug_708901(self):
385 self.do_disassembly_test(bug708901, dis_bug708901)
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000386
Neal Norwitz51abbc72005-12-18 07:06:23 +0000387 def test_bug_1333982(self):
Tim Peters83a8c392005-12-25 22:52:32 +0000388 # This one is checking bytecodes generated for an `assert` statement,
389 # so fails if the tests are run with -O. Skip this test then.
Zachary Waree80e8062013-12-26 09:53:49 -0600390 if not __debug__:
391 self.skipTest('need asserts, run without -O')
Zachary Ware9fe6d862013-12-08 00:20:35 -0600392
Zachary Waree80e8062013-12-26 09:53:49 -0600393 self.do_disassembly_test(bug1333982, dis_bug1333982)
Neal Norwitz51abbc72005-12-18 07:06:23 +0000394
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000395 def test_big_linenos(self):
396 def func(count):
397 namespace = {}
398 func = "def foo():\n " + "".join(["\n "] * count + ["spam\n"])
Georg Brandl7cae87c2006-09-06 06:51:57 +0000399 exec(func, namespace)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000400 return namespace['foo']
401
402 # Test all small ranges
Guido van Rossum805365e2007-05-07 22:24:25 +0000403 for i in range(1, 300):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000404 expected = _BIG_LINENO_FORMAT % (i + 2)
405 self.do_disassembly_test(func(i), expected)
406
407 # Test some larger ranges too
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300408 for i in range(300, 1000, 10):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000409 expected = _BIG_LINENO_FORMAT % (i + 2)
410 self.do_disassembly_test(func(i), expected)
411
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300412 for i in range(1000, 5000, 10):
413 expected = _BIG_LINENO_FORMAT2 % (i + 2)
414 self.do_disassembly_test(func(i), expected)
415
Guido van Rossume7ba4952007-06-06 23:52:48 +0000416 from test import dis_module
417 self.do_disassembly_test(dis_module, dis_module_expected_results)
418
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300419 def test_big_offsets(self):
420 def func(count):
421 namespace = {}
422 func = "def foo(x):\n " + ";".join(["x = x + 1"] * count) + "\n return x"
423 exec(func, namespace)
424 return namespace['foo']
425
426 def expected(count, w):
427 s = ['''\
428 %*d LOAD_FAST 0 (x)
429 %*d LOAD_CONST 1 (1)
430 %*d BINARY_ADD
431 %*d STORE_FAST 0 (x)
432''' % (w, 8*i, w, 8*i + 2, w, 8*i + 4, w, 8*i + 6)
433 for i in range(count)]
434 s += ['''\
435
436 3 %*d LOAD_FAST 0 (x)
437 %*d RETURN_VALUE
438''' % (w, 8*count, w, 8*count + 2)]
439 s[0] = ' 2' + s[0][3:]
440 return ''.join(s)
441
442 for i in range(1, 5):
443 self.do_disassembly_test(func(i), expected(i, 4))
444 self.do_disassembly_test(func(1249), expected(1249, 4))
445 self.do_disassembly_test(func(1250), expected(1250, 5))
446
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000447 def test_disassemble_str(self):
448 self.do_disassembly_test(expr_str, dis_expr_str)
449 self.do_disassembly_test(simple_stmt_str, dis_simple_stmt_str)
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700450 self.do_disassembly_test(annot_stmt_str, dis_annot_stmt_str)
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000451 self.do_disassembly_test(compound_stmt_str, dis_compound_stmt_str)
452
Benjamin Petersond6afe722011-03-15 14:44:52 -0500453 def test_disassemble_bytes(self):
454 self.do_disassembly_test(_f.__code__.co_code, dis_f_co_code)
455
Serhiy Storchaka585c93d2016-04-23 09:23:52 +0300456 def test_disassemble_class(self):
457 self.do_disassembly_test(_C, dis_c)
458
459 def test_disassemble_instance_method(self):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500460 self.do_disassembly_test(_C(1).__init__, dis_c_instance_method)
461
Serhiy Storchaka585c93d2016-04-23 09:23:52 +0300462 def test_disassemble_instance_method_bytes(self):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500463 method_bytecode = _C(1).__init__.__code__.co_code
464 self.do_disassembly_test(method_bytecode, dis_c_instance_method_bytes)
465
Serhiy Storchaka585c93d2016-04-23 09:23:52 +0300466 def test_disassemble_static_method(self):
467 self.do_disassembly_test(_C.sm, dis_c_static_method)
468
469 def test_disassemble_class_method(self):
470 self.do_disassembly_test(_C.cm, dis_c_class_method)
471
Nick Coghlanefd5df92014-07-25 23:02:56 +1000472 def test_disassemble_generator(self):
473 gen_func_disas = self.get_disassembly(_g) # Disassemble generator function
474 gen_disas = self.get_disassembly(_g(1)) # Disassemble generator itself
475 self.assertEqual(gen_disas, gen_func_disas)
476
Serhiy Storchakadd102f72016-10-08 12:34:25 +0300477 def test_disassemble_fstring(self):
478 self.do_disassembly_test(_fstring, dis_fstring)
479
Benjamin Petersond6afe722011-03-15 14:44:52 -0500480 def test_dis_none(self):
Benjamin Peterson47afc2a2011-03-15 15:54:50 -0500481 try:
482 del sys.last_traceback
483 except AttributeError:
484 pass
Benjamin Petersond6afe722011-03-15 14:44:52 -0500485 self.assertRaises(RuntimeError, dis.dis, None)
486
Benjamin Petersond6afe722011-03-15 14:44:52 -0500487 def test_dis_traceback(self):
Benjamin Peterson47afc2a2011-03-15 15:54:50 -0500488 try:
489 del sys.last_traceback
490 except AttributeError:
491 pass
Benjamin Petersond6afe722011-03-15 14:44:52 -0500492
493 try:
494 1/0
495 except Exception as e:
496 tb = e.__traceback__
497 sys.last_traceback = tb
Benjamin Petersond6afe722011-03-15 14:44:52 -0500498
499 tb_dis = self.get_disassemble_as_string(tb.tb_frame.f_code, tb.tb_lasti)
500 self.do_disassembly_test(None, tb_dis)
501
502 def test_dis_object(self):
503 self.assertRaises(TypeError, dis.dis, object())
504
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000505class DisWithFileTests(DisTests):
506
507 # Run the tests again, using the file arg instead of print
508 def get_disassembly(self, func, lasti=-1, wrapper=True):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000509 output = io.StringIO()
510 if wrapper:
511 dis.dis(func, file=output)
512 else:
513 dis.disassemble(func, lasti, file=output)
514 return output.getvalue()
515
516
517
Nick Coghlaneae2da12010-08-17 08:03:36 +0000518code_info_code_info = """\
519Name: code_info
Nick Coghlan46e63802010-08-17 11:28:07 +0000520Filename: (.*)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000521Argument count: 1
522Kw-only arguments: 0
523Number of locals: 1
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000524Stack size: 3
Nick Coghlaneae2da12010-08-17 08:03:36 +0000525Flags: OPTIMIZED, NEWLOCALS, NOFREE
526Constants:
Georg Brandlebbf63b2010-10-14 07:23:01 +0000527 0: %r
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000528Names:
529 0: _format_code_info
530 1: _get_code_object
Nick Coghlaneae2da12010-08-17 08:03:36 +0000531Variable names:
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000532 0: x""" % (('Formatted details of methods, functions, or code.',)
533 if sys.flags.optimize < 2 else (None,))
Nick Coghlaneae2da12010-08-17 08:03:36 +0000534
535@staticmethod
536def tricky(x, y, z=True, *args, c, d, e=[], **kwds):
537 def f(c=c):
538 print(x, y, z, c, d, e, f)
539 yield x, y, z, c, d, e, f
540
Nick Coghlaneae2da12010-08-17 08:03:36 +0000541code_info_tricky = """\
542Name: tricky
Nick Coghlan46e63802010-08-17 11:28:07 +0000543Filename: (.*)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000544Argument count: 3
545Kw-only arguments: 3
546Number of locals: 8
547Stack size: 7
548Flags: OPTIMIZED, NEWLOCALS, VARARGS, VARKEYWORDS, GENERATOR
549Constants:
550 0: None
Nick Coghlan46e63802010-08-17 11:28:07 +0000551 1: <code object f at (.*), file "(.*)", line (.*)>
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100552 2: 'tricky.<locals>.f'
Nick Coghlaneae2da12010-08-17 08:03:36 +0000553Variable names:
554 0: x
555 1: y
556 2: z
557 3: c
558 4: d
559 5: e
560 6: args
561 7: kwds
562Cell variables:
Georg Brandla1082272012-02-20 21:41:03 +0100563 0: [edfxyz]
564 1: [edfxyz]
565 2: [edfxyz]
566 3: [edfxyz]
567 4: [edfxyz]
568 5: [edfxyz]"""
569# NOTE: the order of the cell variables above depends on dictionary order!
Nick Coghlan46e63802010-08-17 11:28:07 +0000570
571co_tricky_nested_f = tricky.__func__.__code__.co_consts[1]
Nick Coghlaneae2da12010-08-17 08:03:36 +0000572
573code_info_tricky_nested_f = """\
574Name: f
Nick Coghlan46e63802010-08-17 11:28:07 +0000575Filename: (.*)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000576Argument count: 1
577Kw-only arguments: 0
578Number of locals: 1
579Stack size: 8
580Flags: OPTIMIZED, NEWLOCALS, NESTED
581Constants:
582 0: None
583Names:
584 0: print
585Variable names:
586 0: c
587Free variables:
Georg Brandl27fe2262012-02-20 22:03:28 +0100588 0: [edfxyz]
589 1: [edfxyz]
590 2: [edfxyz]
591 3: [edfxyz]
592 4: [edfxyz]
593 5: [edfxyz]"""
Nick Coghlaneae2da12010-08-17 08:03:36 +0000594
595code_info_expr_str = """\
596Name: <module>
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000597Filename: <disassembly>
Nick Coghlaneae2da12010-08-17 08:03:36 +0000598Argument count: 0
599Kw-only arguments: 0
600Number of locals: 0
601Stack size: 2
602Flags: NOFREE
603Constants:
604 0: 1
605Names:
606 0: x"""
607
608code_info_simple_stmt_str = """\
609Name: <module>
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000610Filename: <disassembly>
Nick Coghlaneae2da12010-08-17 08:03:36 +0000611Argument count: 0
612Kw-only arguments: 0
613Number of locals: 0
614Stack size: 2
615Flags: NOFREE
616Constants:
617 0: 1
618 1: None
619Names:
620 0: x"""
621
622code_info_compound_stmt_str = """\
623Name: <module>
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000624Filename: <disassembly>
Nick Coghlaneae2da12010-08-17 08:03:36 +0000625Argument count: 0
626Kw-only arguments: 0
627Number of locals: 0
628Stack size: 2
629Flags: NOFREE
630Constants:
631 0: 0
632 1: 1
633 2: None
634Names:
635 0: x"""
636
Yury Selivanov75445082015-05-11 22:57:16 -0400637
638async def async_def():
639 await 1
640 async for a in b: pass
641 async with c as d: pass
642
643code_info_async_def = """\
644Name: async_def
645Filename: (.*)
646Argument count: 0
647Kw-only arguments: 0
648Number of locals: 2
649Stack size: 17
Yury Selivanoveb636452016-09-08 22:01:51 -0700650Flags: OPTIMIZED, NEWLOCALS, NOFREE, COROUTINE
Yury Selivanov75445082015-05-11 22:57:16 -0400651Constants:
652 0: None
653 1: 1"""
654
Nick Coghlaneae2da12010-08-17 08:03:36 +0000655class CodeInfoTests(unittest.TestCase):
656 test_pairs = [
657 (dis.code_info, code_info_code_info),
658 (tricky, code_info_tricky),
659 (co_tricky_nested_f, code_info_tricky_nested_f),
660 (expr_str, code_info_expr_str),
661 (simple_stmt_str, code_info_simple_stmt_str),
662 (compound_stmt_str, code_info_compound_stmt_str),
Yury Selivanov75445082015-05-11 22:57:16 -0400663 (async_def, code_info_async_def)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000664 ]
665
666 def test_code_info(self):
667 self.maxDiff = 1000
668 for x, expected in self.test_pairs:
Ezio Melottied3a7d22010-12-01 02:32:32 +0000669 self.assertRegex(dis.code_info(x), expected)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000670
671 def test_show_code(self):
672 self.maxDiff = 1000
673 for x, expected in self.test_pairs:
674 with captured_stdout() as output:
675 dis.show_code(x)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000676 self.assertRegex(output.getvalue(), expected+"\n")
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000677 output = io.StringIO()
678 dis.show_code(x, file=output)
679 self.assertRegex(output.getvalue(), expected)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000680
Benjamin Petersond6afe722011-03-15 14:44:52 -0500681 def test_code_info_object(self):
682 self.assertRaises(TypeError, dis.code_info, object())
683
684 def test_pretty_flags_no_flags(self):
685 self.assertEqual(dis.pretty_flags(0), '0x0')
686
687
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000688# Fodder for instruction introspection tests
689# Editing any of these may require recalculating the expected output
690def outer(a=1, b=2):
691 def f(c=3, d=4):
692 def inner(e=5, f=6):
693 print(a, b, c, d, e, f)
694 print(a, b, c, d)
695 return inner
696 print(a, b, '', 1, [], {}, "Hello world!")
697 return f
698
699def jumpy():
700 # This won't actually run (but that's OK, we only disassemble it)
701 for i in range(10):
702 print(i)
703 if i < 4:
704 continue
705 if i > 6:
706 break
707 else:
708 print("I can haz else clause?")
709 while i:
710 print(i)
711 i -= 1
712 if i > 6:
713 continue
714 if i < 4:
715 break
716 else:
717 print("Who let lolcatz into this test suite?")
718 try:
719 1 / 0
720 except ZeroDivisionError:
721 print("Here we go, here we go, here we go...")
722 else:
723 with i as dodgy:
724 print("Never reach this")
725 finally:
726 print("OK, now we're done")
727
728# End fodder for opinfo generation tests
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000729expected_outer_line = 1
730_line_offset = outer.__code__.co_firstlineno - 1
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000731code_object_f = outer.__code__.co_consts[3]
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000732expected_f_line = code_object_f.co_firstlineno - _line_offset
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000733code_object_inner = code_object_f.co_consts[3]
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000734expected_inner_line = code_object_inner.co_firstlineno - _line_offset
735expected_jumpy_line = 1
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000736
737# The following lines are useful to regenerate the expected results after
738# either the fodder is modified or the bytecode generation changes
739# After regeneration, update the references to code_object_f and
740# code_object_inner before rerunning the tests
741
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000742#_instructions = dis.get_instructions(outer, first_line=expected_outer_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000743#print('expected_opinfo_outer = [\n ',
744 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
Antoine Pitroue7811fc2014-09-18 03:06:50 +0200745#_instructions = dis.get_instructions(outer(), first_line=expected_f_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000746#print('expected_opinfo_f = [\n ',
747 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
Antoine Pitroue7811fc2014-09-18 03:06:50 +0200748#_instructions = dis.get_instructions(outer()(), first_line=expected_inner_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000749#print('expected_opinfo_inner = [\n ',
750 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000751#_instructions = dis.get_instructions(jumpy, first_line=expected_jumpy_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000752#print('expected_opinfo_jumpy = [\n ',
753 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
754
755
756Instruction = dis.Instruction
757expected_opinfo_outer = [
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300758 Instruction(opname='LOAD_CONST', opcode=100, arg=8, argval=(3, 4), argrepr='(3, 4)', offset=0, starts_line=2, is_jump_target=False),
759 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=0, argval='a', argrepr='a', offset=2, starts_line=None, is_jump_target=False),
760 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=1, argval='b', argrepr='b', offset=4, starts_line=None, is_jump_target=False),
761 Instruction(opname='BUILD_TUPLE', opcode=102, arg=2, argval=2, argrepr='', offset=6, starts_line=None, is_jump_target=False),
762 Instruction(opname='LOAD_CONST', opcode=100, arg=3, argval=code_object_f, argrepr=repr(code_object_f), offset=8, starts_line=None, is_jump_target=False),
763 Instruction(opname='LOAD_CONST', opcode=100, arg=4, argval='outer.<locals>.f', argrepr="'outer.<locals>.f'", offset=10, starts_line=None, is_jump_target=False),
764 Instruction(opname='MAKE_FUNCTION', opcode=132, arg=9, argval=9, argrepr='', offset=12, starts_line=None, is_jump_target=False),
765 Instruction(opname='STORE_FAST', opcode=125, arg=2, argval='f', argrepr='f', offset=14, starts_line=None, is_jump_target=False),
766 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=0, argval='print', argrepr='print', offset=16, starts_line=7, is_jump_target=False),
767 Instruction(opname='LOAD_DEREF', opcode=136, arg=0, argval='a', argrepr='a', offset=18, starts_line=None, is_jump_target=False),
768 Instruction(opname='LOAD_DEREF', opcode=136, arg=1, argval='b', argrepr='b', offset=20, starts_line=None, is_jump_target=False),
769 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval='', argrepr="''", offset=22, starts_line=None, is_jump_target=False),
770 Instruction(opname='LOAD_CONST', opcode=100, arg=6, argval=1, argrepr='1', offset=24, starts_line=None, is_jump_target=False),
771 Instruction(opname='BUILD_LIST', opcode=103, arg=0, argval=0, argrepr='', offset=26, starts_line=None, is_jump_target=False),
772 Instruction(opname='BUILD_MAP', opcode=105, arg=0, argval=0, argrepr='', offset=28, starts_line=None, is_jump_target=False),
773 Instruction(opname='LOAD_CONST', opcode=100, arg=7, argval='Hello world!', argrepr="'Hello world!'", offset=30, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700774 Instruction(opname='CALL_FUNCTION', opcode=131, arg=7, argval=7, argrepr='', offset=32, starts_line=None, is_jump_target=False),
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300775 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=34, starts_line=None, is_jump_target=False),
776 Instruction(opname='LOAD_FAST', opcode=124, arg=2, argval='f', argrepr='f', offset=36, starts_line=8, is_jump_target=False),
777 Instruction(opname='RETURN_VALUE', opcode=83, arg=None, argval=None, argrepr='', offset=38, starts_line=None, is_jump_target=False),
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000778]
779
780expected_opinfo_f = [
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300781 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval=(5, 6), argrepr='(5, 6)', offset=0, starts_line=3, is_jump_target=False),
782 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=2, argval='a', argrepr='a', offset=2, starts_line=None, is_jump_target=False),
783 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=3, argval='b', argrepr='b', offset=4, starts_line=None, is_jump_target=False),
784 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=0, argval='c', argrepr='c', offset=6, starts_line=None, is_jump_target=False),
785 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=1, argval='d', argrepr='d', offset=8, starts_line=None, is_jump_target=False),
786 Instruction(opname='BUILD_TUPLE', opcode=102, arg=4, argval=4, argrepr='', offset=10, starts_line=None, is_jump_target=False),
787 Instruction(opname='LOAD_CONST', opcode=100, arg=3, argval=code_object_inner, argrepr=repr(code_object_inner), offset=12, starts_line=None, is_jump_target=False),
788 Instruction(opname='LOAD_CONST', opcode=100, arg=4, argval='outer.<locals>.f.<locals>.inner', argrepr="'outer.<locals>.f.<locals>.inner'", offset=14, starts_line=None, is_jump_target=False),
789 Instruction(opname='MAKE_FUNCTION', opcode=132, arg=9, argval=9, argrepr='', offset=16, starts_line=None, is_jump_target=False),
790 Instruction(opname='STORE_FAST', opcode=125, arg=2, argval='inner', argrepr='inner', offset=18, starts_line=None, is_jump_target=False),
791 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=0, argval='print', argrepr='print', offset=20, starts_line=5, is_jump_target=False),
792 Instruction(opname='LOAD_DEREF', opcode=136, arg=2, argval='a', argrepr='a', offset=22, starts_line=None, is_jump_target=False),
793 Instruction(opname='LOAD_DEREF', opcode=136, arg=3, argval='b', argrepr='b', offset=24, starts_line=None, is_jump_target=False),
794 Instruction(opname='LOAD_DEREF', opcode=136, arg=0, argval='c', argrepr='c', offset=26, starts_line=None, is_jump_target=False),
795 Instruction(opname='LOAD_DEREF', opcode=136, arg=1, argval='d', argrepr='d', offset=28, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700796 Instruction(opname='CALL_FUNCTION', opcode=131, arg=4, argval=4, argrepr='', offset=30, starts_line=None, is_jump_target=False),
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300797 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=32, starts_line=None, is_jump_target=False),
798 Instruction(opname='LOAD_FAST', opcode=124, arg=2, argval='inner', argrepr='inner', offset=34, starts_line=6, is_jump_target=False),
799 Instruction(opname='RETURN_VALUE', opcode=83, arg=None, argval=None, argrepr='', offset=36, starts_line=None, is_jump_target=False),
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000800]
801
802expected_opinfo_inner = [
803 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=0, argval='print', argrepr='print', offset=0, starts_line=4, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300804 Instruction(opname='LOAD_DEREF', opcode=136, arg=0, argval='a', argrepr='a', offset=2, starts_line=None, is_jump_target=False),
805 Instruction(opname='LOAD_DEREF', opcode=136, arg=1, argval='b', argrepr='b', offset=4, starts_line=None, is_jump_target=False),
806 Instruction(opname='LOAD_DEREF', opcode=136, arg=2, argval='c', argrepr='c', offset=6, starts_line=None, is_jump_target=False),
807 Instruction(opname='LOAD_DEREF', opcode=136, arg=3, argval='d', argrepr='d', offset=8, starts_line=None, is_jump_target=False),
808 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='e', argrepr='e', offset=10, starts_line=None, is_jump_target=False),
809 Instruction(opname='LOAD_FAST', opcode=124, arg=1, argval='f', argrepr='f', offset=12, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700810 Instruction(opname='CALL_FUNCTION', opcode=131, arg=6, argval=6, argrepr='', offset=14, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300811 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=16, starts_line=None, is_jump_target=False),
812 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=18, starts_line=None, is_jump_target=False),
813 Instruction(opname='RETURN_VALUE', opcode=83, arg=None, argval=None, argrepr='', offset=20, starts_line=None, is_jump_target=False),
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000814]
815
816expected_opinfo_jumpy = [
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300817 Instruction(opname='SETUP_LOOP', opcode=120, arg=52, argval=54, argrepr='to 54', offset=0, starts_line=3, is_jump_target=False),
818 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=0, argval='range', argrepr='range', offset=2, starts_line=None, is_jump_target=False),
819 Instruction(opname='LOAD_CONST', opcode=100, arg=1, argval=10, argrepr='10', offset=4, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700820 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=6, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300821 Instruction(opname='GET_ITER', opcode=68, arg=None, argval=None, argrepr='', offset=8, starts_line=None, is_jump_target=False),
822 Instruction(opname='FOR_ITER', opcode=93, arg=32, argval=44, argrepr='to 44', offset=10, starts_line=None, is_jump_target=True),
823 Instruction(opname='STORE_FAST', opcode=125, arg=0, argval='i', argrepr='i', offset=12, starts_line=None, is_jump_target=False),
824 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=14, starts_line=4, is_jump_target=False),
825 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=16, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700826 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=18, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300827 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=20, starts_line=None, is_jump_target=False),
828 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=22, starts_line=5, is_jump_target=False),
829 Instruction(opname='LOAD_CONST', opcode=100, arg=2, argval=4, argrepr='4', offset=24, starts_line=None, is_jump_target=False),
830 Instruction(opname='COMPARE_OP', opcode=107, arg=0, argval='<', argrepr='<', offset=26, starts_line=None, is_jump_target=False),
831 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=32, argval=32, argrepr='', offset=28, starts_line=None, is_jump_target=False),
832 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=10, argval=10, argrepr='', offset=30, starts_line=6, is_jump_target=False),
833 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=32, starts_line=7, is_jump_target=True),
834 Instruction(opname='LOAD_CONST', opcode=100, arg=3, argval=6, argrepr='6', offset=34, starts_line=None, is_jump_target=False),
835 Instruction(opname='COMPARE_OP', opcode=107, arg=4, argval='>', argrepr='>', offset=36, starts_line=None, is_jump_target=False),
836 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=10, argval=10, argrepr='', offset=38, starts_line=None, is_jump_target=False),
837 Instruction(opname='BREAK_LOOP', opcode=80, arg=None, argval=None, argrepr='', offset=40, starts_line=8, is_jump_target=False),
838 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=10, argval=10, argrepr='', offset=42, starts_line=None, is_jump_target=False),
839 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=44, starts_line=None, is_jump_target=True),
840 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=46, starts_line=10, is_jump_target=False),
841 Instruction(opname='LOAD_CONST', opcode=100, arg=4, argval='I can haz else clause?', argrepr="'I can haz else clause?'", offset=48, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700842 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=50, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300843 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=52, starts_line=None, is_jump_target=False),
844 Instruction(opname='SETUP_LOOP', opcode=120, arg=52, argval=108, argrepr='to 108', offset=54, starts_line=11, is_jump_target=True),
845 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=56, starts_line=None, is_jump_target=True),
846 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=98, argval=98, argrepr='', offset=58, starts_line=None, is_jump_target=False),
847 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=60, starts_line=12, is_jump_target=False),
848 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=62, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700849 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=64, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300850 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=66, starts_line=None, is_jump_target=False),
851 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=68, starts_line=13, is_jump_target=False),
852 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval=1, argrepr='1', offset=70, starts_line=None, is_jump_target=False),
853 Instruction(opname='INPLACE_SUBTRACT', opcode=56, arg=None, argval=None, argrepr='', offset=72, starts_line=None, is_jump_target=False),
854 Instruction(opname='STORE_FAST', opcode=125, arg=0, argval='i', argrepr='i', offset=74, starts_line=None, is_jump_target=False),
855 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=76, starts_line=14, is_jump_target=False),
856 Instruction(opname='LOAD_CONST', opcode=100, arg=3, argval=6, argrepr='6', offset=78, starts_line=None, is_jump_target=False),
857 Instruction(opname='COMPARE_OP', opcode=107, arg=4, argval='>', argrepr='>', offset=80, starts_line=None, is_jump_target=False),
858 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=86, argval=86, argrepr='', offset=82, starts_line=None, is_jump_target=False),
859 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=56, argval=56, argrepr='', offset=84, starts_line=15, is_jump_target=False),
860 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=86, starts_line=16, is_jump_target=True),
861 Instruction(opname='LOAD_CONST', opcode=100, arg=2, argval=4, argrepr='4', offset=88, starts_line=None, is_jump_target=False),
862 Instruction(opname='COMPARE_OP', opcode=107, arg=0, argval='<', argrepr='<', offset=90, starts_line=None, is_jump_target=False),
863 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=56, argval=56, argrepr='', offset=92, starts_line=None, is_jump_target=False),
864 Instruction(opname='BREAK_LOOP', opcode=80, arg=None, argval=None, argrepr='', offset=94, starts_line=17, is_jump_target=False),
865 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=56, argval=56, argrepr='', offset=96, starts_line=None, is_jump_target=False),
866 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=98, starts_line=None, is_jump_target=True),
867 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=100, starts_line=19, is_jump_target=False),
868 Instruction(opname='LOAD_CONST', opcode=100, arg=6, argval='Who let lolcatz into this test suite?', argrepr="'Who let lolcatz into this test suite?'", offset=102, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700869 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=104, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300870 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=106, starts_line=None, is_jump_target=False),
871 Instruction(opname='SETUP_FINALLY', opcode=122, arg=70, argval=180, argrepr='to 180', offset=108, starts_line=20, is_jump_target=True),
872 Instruction(opname='SETUP_EXCEPT', opcode=121, arg=12, argval=124, argrepr='to 124', offset=110, starts_line=None, is_jump_target=False),
873 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval=1, argrepr='1', offset=112, starts_line=21, is_jump_target=False),
874 Instruction(opname='LOAD_CONST', opcode=100, arg=7, argval=0, argrepr='0', offset=114, starts_line=None, is_jump_target=False),
875 Instruction(opname='BINARY_TRUE_DIVIDE', opcode=27, arg=None, argval=None, argrepr='', offset=116, starts_line=None, is_jump_target=False),
876 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=118, starts_line=None, is_jump_target=False),
877 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=120, starts_line=None, is_jump_target=False),
878 Instruction(opname='JUMP_FORWARD', opcode=110, arg=28, argval=152, argrepr='to 152', offset=122, starts_line=None, is_jump_target=False),
879 Instruction(opname='DUP_TOP', opcode=4, arg=None, argval=None, argrepr='', offset=124, starts_line=22, is_jump_target=True),
880 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=2, argval='ZeroDivisionError', argrepr='ZeroDivisionError', offset=126, starts_line=None, is_jump_target=False),
881 Instruction(opname='COMPARE_OP', opcode=107, arg=10, argval='exception match', argrepr='exception match', offset=128, starts_line=None, is_jump_target=False),
882 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=150, argval=150, argrepr='', offset=130, starts_line=None, is_jump_target=False),
883 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=132, starts_line=None, is_jump_target=False),
884 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=134, starts_line=None, is_jump_target=False),
885 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=136, starts_line=None, is_jump_target=False),
886 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=138, starts_line=23, is_jump_target=False),
887 Instruction(opname='LOAD_CONST', opcode=100, arg=8, argval='Here we go, here we go, here we go...', argrepr="'Here we go, here we go, here we go...'", offset=140, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700888 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=142, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300889 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=144, starts_line=None, is_jump_target=False),
890 Instruction(opname='POP_EXCEPT', opcode=89, arg=None, argval=None, argrepr='', offset=146, starts_line=None, is_jump_target=False),
891 Instruction(opname='JUMP_FORWARD', opcode=110, arg=26, argval=176, argrepr='to 176', offset=148, starts_line=None, is_jump_target=False),
892 Instruction(opname='END_FINALLY', opcode=88, arg=None, argval=None, argrepr='', offset=150, starts_line=None, is_jump_target=True),
893 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=152, starts_line=25, is_jump_target=True),
894 Instruction(opname='SETUP_WITH', opcode=143, arg=14, argval=170, argrepr='to 170', offset=154, starts_line=None, is_jump_target=False),
895 Instruction(opname='STORE_FAST', opcode=125, arg=1, argval='dodgy', argrepr='dodgy', offset=156, starts_line=None, is_jump_target=False),
896 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=158, starts_line=26, is_jump_target=False),
897 Instruction(opname='LOAD_CONST', opcode=100, arg=9, argval='Never reach this', argrepr="'Never reach this'", offset=160, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700898 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=162, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300899 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=164, starts_line=None, is_jump_target=False),
900 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=166, starts_line=None, is_jump_target=False),
901 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=168, starts_line=None, is_jump_target=False),
902 Instruction(opname='WITH_CLEANUP_START', opcode=81, arg=None, argval=None, argrepr='', offset=170, starts_line=None, is_jump_target=True),
903 Instruction(opname='WITH_CLEANUP_FINISH', opcode=82, arg=None, argval=None, argrepr='', offset=172, starts_line=None, is_jump_target=False),
904 Instruction(opname='END_FINALLY', opcode=88, arg=None, argval=None, argrepr='', offset=174, starts_line=None, is_jump_target=False),
905 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=176, starts_line=None, is_jump_target=True),
906 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=178, starts_line=None, is_jump_target=False),
907 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=180, starts_line=28, is_jump_target=True),
908 Instruction(opname='LOAD_CONST', opcode=100, arg=10, argval="OK, now we're done", argrepr='"OK, now we\'re done"', offset=182, starts_line=None, is_jump_target=False),
Victor Stinnerf9b760f2016-09-09 10:17:08 -0700909 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=184, starts_line=None, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300910 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=186, starts_line=None, is_jump_target=False),
911 Instruction(opname='END_FINALLY', opcode=88, arg=None, argval=None, argrepr='', offset=188, starts_line=None, is_jump_target=False),
912 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=190, starts_line=None, is_jump_target=False),
913 Instruction(opname='RETURN_VALUE', opcode=83, arg=None, argval=None, argrepr='', offset=192, starts_line=None, is_jump_target=False),
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000914]
915
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000916# One last piece of inspect fodder to check the default line number handling
917def simple(): pass
918expected_opinfo_simple = [
919 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=0, starts_line=simple.__code__.co_firstlineno, is_jump_target=False),
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300920 Instruction(opname='RETURN_VALUE', opcode=83, arg=None, argval=None, argrepr='', offset=2, starts_line=None, is_jump_target=False)
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000921]
922
923
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000924class InstructionTests(BytecodeTestCase):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000925
926 def test_default_first_line(self):
927 actual = dis.get_instructions(simple)
928 self.assertEqual(list(actual), expected_opinfo_simple)
929
930 def test_first_line_set_to_None(self):
931 actual = dis.get_instructions(simple, first_line=None)
932 self.assertEqual(list(actual), expected_opinfo_simple)
933
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000934 def test_outer(self):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000935 actual = dis.get_instructions(outer, first_line=expected_outer_line)
936 self.assertEqual(list(actual), expected_opinfo_outer)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000937
938 def test_nested(self):
939 with captured_stdout():
940 f = outer()
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000941 actual = dis.get_instructions(f, first_line=expected_f_line)
942 self.assertEqual(list(actual), expected_opinfo_f)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000943
944 def test_doubly_nested(self):
945 with captured_stdout():
946 inner = outer()()
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000947 actual = dis.get_instructions(inner, first_line=expected_inner_line)
948 self.assertEqual(list(actual), expected_opinfo_inner)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000949
950 def test_jumpy(self):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000951 actual = dis.get_instructions(jumpy, first_line=expected_jumpy_line)
952 self.assertEqual(list(actual), expected_opinfo_jumpy)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000953
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000954# get_instructions has its own tests above, so can rely on it to validate
955# the object oriented API
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000956class BytecodeTests(unittest.TestCase):
957 def test_instantiation(self):
958 # Test with function, method, code string and code object
959 for obj in [_f, _C(1).__init__, "a=1", _f.__code__]:
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000960 with self.subTest(obj=obj):
961 b = dis.Bytecode(obj)
962 self.assertIsInstance(b.codeobj, types.CodeType)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000963
964 self.assertRaises(TypeError, dis.Bytecode, object())
965
966 def test_iteration(self):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000967 for obj in [_f, _C(1).__init__, "a=1", _f.__code__]:
968 with self.subTest(obj=obj):
969 via_object = list(dis.Bytecode(obj))
970 via_generator = list(dis.get_instructions(obj))
971 self.assertEqual(via_object, via_generator)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000972
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000973 def test_explicit_first_line(self):
974 actual = dis.Bytecode(outer, first_line=expected_outer_line)
975 self.assertEqual(list(actual), expected_opinfo_outer)
976
977 def test_source_line_in_disassembly(self):
978 # Use the line in the source code
979 actual = dis.Bytecode(simple).dis()[:3]
980 expected = "{:>3}".format(simple.__code__.co_firstlineno)
981 self.assertEqual(actual, expected)
982 # Use an explicit first line number
983 actual = dis.Bytecode(simple, first_line=350).dis()[:3]
984 self.assertEqual(actual, "350")
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000985
986 def test_info(self):
987 self.maxDiff = 1000
988 for x, expected in CodeInfoTests.test_pairs:
989 b = dis.Bytecode(x)
990 self.assertRegex(b.info(), expected)
991
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000992 def test_disassembled(self):
993 actual = dis.Bytecode(_f).dis()
994 self.assertEqual(actual, dis_f)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000995
Nick Coghlan50c48b82013-11-23 00:57:00 +1000996 def test_from_traceback(self):
997 tb = get_tb()
998 b = dis.Bytecode.from_traceback(tb)
999 while tb.tb_next: tb = tb.tb_next
1000
1001 self.assertEqual(b.current_offset, tb.tb_lasti)
1002
1003 def test_from_traceback_dis(self):
1004 tb = get_tb()
1005 b = dis.Bytecode.from_traceback(tb)
1006 self.assertEqual(b.dis(), dis_traceback)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001007
Skip Montanaroadd0ccc2003-02-27 21:27:07 +00001008if __name__ == "__main__":
Zachary Waree80e8062013-12-26 09:53:49 -06001009 unittest.main()