blob: 19e5c0f6335020d9b45f851fea96be1e1f3c7d7f [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
Joannah Nanjekye92777d52019-09-12 10:02:59 +01004from test.support.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 Storchaka520b7ae2018-02-22 23:33:30 +0200123%3d 0 LOAD_GLOBAL 0 (range)
124 2 LOAD_CONST 1 (1)
Michael W. Hudson26848a32003-04-29 17:07:36 +0000125
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +0200126%3d 4 LOAD_CONST 2 (10)
Serhiy Storchakada8d72c2018-09-17 15:17:29 +0300127
128%3d 6 CALL_FUNCTION 2
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +0200129 8 GET_ITER
Mark Shannonfcb55c02021-04-01 16:00:31 +0100130 >> 10 FOR_ITER 2 (to 16)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +0200131 12 STORE_FAST 0 (res)
Michael W. Hudson26848a32003-04-29 17:07:36 +0000132
Mark Shannonfcb55c02021-04-01 16:00:31 +0100133%3d 14 JUMP_ABSOLUTE 5 (to 10)
Mark Shannon5977a792020-12-02 13:31:40 +0000134
135%3d >> 16 LOAD_CONST 0 (None)
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +0200136 18 RETURN_VALUE
Georg Brandlebbf63b2010-10-14 07:23:01 +0000137""" % (bug708901.__code__.co_firstlineno + 1,
138 bug708901.__code__.co_firstlineno + 2,
Serhiy Storchakada8d72c2018-09-17 15:17:29 +0300139 bug708901.__code__.co_firstlineno + 1,
Mark Shannon5977a792020-12-02 13:31:40 +0000140 bug708901.__code__.co_firstlineno + 3,
141 bug708901.__code__.co_firstlineno + 1)
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000142
Neal Norwitz51abbc72005-12-18 07:06:23 +0000143
144def bug1333982(x=[]):
145 assert 0, ([s for s in x] +
146 1)
147 pass
148
149dis_bug1333982 = """\
Mark Shannon266b4622020-11-17 19:30:14 +0000150%3d 0 LOAD_ASSERTION_ERROR
151 2 LOAD_CONST 2 (<code object <listcomp> at 0x..., file "%s", line %d>)
152 4 LOAD_CONST 3 ('bug1333982.<locals>.<listcomp>')
153 6 MAKE_FUNCTION 0
154 8 LOAD_FAST 0 (x)
155 10 GET_ITER
156 12 CALL_FUNCTION 1
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300157
Mark Shannon266b4622020-11-17 19:30:14 +0000158%3d 14 LOAD_CONST 4 (1)
Serhiy Storchakada8d72c2018-09-17 15:17:29 +0300159
Mark Shannon266b4622020-11-17 19:30:14 +0000160%3d 16 BINARY_ADD
161 18 CALL_FUNCTION 1
162 20 RAISE_VARARGS 1
Georg Brandlebbf63b2010-10-14 07:23:01 +0000163""" % (bug1333982.__code__.co_firstlineno + 1,
Zachary Waree80e8062013-12-26 09:53:49 -0600164 __file__,
165 bug1333982.__code__.co_firstlineno + 1,
Georg Brandlebbf63b2010-10-14 07:23:01 +0000166 bug1333982.__code__.co_firstlineno + 2,
Mark Shannon266b4622020-11-17 19:30:14 +0000167 bug1333982.__code__.co_firstlineno + 1)
Neal Norwitz51abbc72005-12-18 07:06:23 +0000168
Yurii Karabasf24b8102020-12-04 17:20:53 +0200169
170def bug42562():
171 pass
172
173
174# Set line number for 'pass' to None
175bug42562.__code__ = bug42562.__code__.replace(co_linetable=b'\x04\x80\xff\x80')
176
177
178dis_bug42562 = """\
179 0 LOAD_CONST 0 (None)
180 2 RETURN_VALUE
181"""
182
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000183_BIG_LINENO_FORMAT = """\
184%3d 0 LOAD_GLOBAL 0 (spam)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300185 2 POP_TOP
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000186 4 LOAD_CONST 0 (None)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300187 6 RETURN_VALUE
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000188"""
189
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300190_BIG_LINENO_FORMAT2 = """\
191%4d 0 LOAD_GLOBAL 0 (spam)
192 2 POP_TOP
193 4 LOAD_CONST 0 (None)
194 6 RETURN_VALUE
195"""
196
Guido van Rossume7ba4952007-06-06 23:52:48 +0000197dis_module_expected_results = """\
198Disassembly of f:
199 4 0 LOAD_CONST 0 (None)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300200 2 RETURN_VALUE
Guido van Rossume7ba4952007-06-06 23:52:48 +0000201
202Disassembly of g:
203 5 0 LOAD_CONST 0 (None)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300204 2 RETURN_VALUE
Guido van Rossume7ba4952007-06-06 23:52:48 +0000205
206"""
207
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000208expr_str = "x + 1"
209
210dis_expr_str = """\
211 1 0 LOAD_NAME 0 (x)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300212 2 LOAD_CONST 0 (1)
213 4 BINARY_ADD
214 6 RETURN_VALUE
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000215"""
216
217simple_stmt_str = "x = x + 1"
218
219dis_simple_stmt_str = """\
220 1 0 LOAD_NAME 0 (x)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300221 2 LOAD_CONST 0 (1)
222 4 BINARY_ADD
223 6 STORE_NAME 0 (x)
224 8 LOAD_CONST 1 (None)
225 10 RETURN_VALUE
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000226"""
227
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700228annot_stmt_str = """\
229
230x: int = 1
231y: fun(1)
232lst[fun(0)]: int = 1
233"""
234# leading newline is for a reason (tests lineno)
235
236dis_annot_stmt_str = """\
237 2 0 SETUP_ANNOTATIONS
238 2 LOAD_CONST 0 (1)
239 4 STORE_NAME 0 (x)
Batuhan Taskaya044a1042020-10-06 23:03:02 +0300240 6 LOAD_CONST 1 ('int')
241 8 LOAD_NAME 1 (__annotations__)
242 10 LOAD_CONST 2 ('x')
Mark Shannon332cd5e2018-01-30 00:41:04 +0000243 12 STORE_SUBSCR
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700244
Batuhan Taskaya044a1042020-10-06 23:03:02 +0300245 3 14 LOAD_CONST 3 ('fun(1)')
246 16 LOAD_NAME 1 (__annotations__)
247 18 LOAD_CONST 4 ('y')
248 20 STORE_SUBSCR
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700249
Batuhan Taskaya044a1042020-10-06 23:03:02 +0300250 4 22 LOAD_CONST 0 (1)
251 24 LOAD_NAME 2 (lst)
252 26 LOAD_NAME 3 (fun)
253 28 LOAD_CONST 5 (0)
254 30 CALL_FUNCTION 1
255 32 STORE_SUBSCR
256 34 LOAD_NAME 4 (int)
257 36 POP_TOP
258 38 LOAD_CONST 6 (None)
259 40 RETURN_VALUE
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700260"""
261
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000262compound_stmt_str = """\
263x = 0
264while 1:
265 x += 1"""
266# Trailing newline has been deliberately omitted
267
268dis_compound_stmt_str = """\
269 1 0 LOAD_CONST 0 (0)
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300270 2 STORE_NAME 0 (x)
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000271
Mark Shannon8473cf82020-12-15 11:07:50 +0000272 2 4 NOP
273
274 3 >> 6 LOAD_NAME 0 (x)
275 8 LOAD_CONST 1 (1)
276 10 INPLACE_ADD
277 12 STORE_NAME 0 (x)
278
Mark Shannonfcb55c02021-04-01 16:00:31 +0100279 2 14 JUMP_ABSOLUTE 3 (to 6)
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000280"""
Guido van Rossume7ba4952007-06-06 23:52:48 +0000281
Nick Coghlan50c48b82013-11-23 00:57:00 +1000282dis_traceback = """\
Mark Shannonfcb55c02021-04-01 16:00:31 +0100283%3d 0 SETUP_FINALLY 7 (to 16)
Nick Coghlan50c48b82013-11-23 00:57:00 +1000284
Serhiy Storchakab0f80b02016-05-24 09:15:14 +0300285%3d 2 LOAD_CONST 1 (1)
286 4 LOAD_CONST 2 (0)
287 --> 6 BINARY_TRUE_DIVIDE
288 8 POP_TOP
289 10 POP_BLOCK
Nick Coghlan50c48b82013-11-23 00:57:00 +1000290
Mark Shannoncc75ab72020-11-12 19:49:33 +0000291%3d 12 LOAD_FAST 1 (tb)
292 14 RETURN_VALUE
Nick Coghlan50c48b82013-11-23 00:57:00 +1000293
Mark Shannoncc75ab72020-11-12 19:49:33 +0000294%3d >> 16 DUP_TOP
295 18 LOAD_GLOBAL 0 (Exception)
Mark Shannonfcb55c02021-04-01 16:00:31 +0100296 20 JUMP_IF_NOT_EXC_MATCH 29 (to 58)
Mark Shannoncc75ab72020-11-12 19:49:33 +0000297 22 POP_TOP
298 24 STORE_FAST 0 (e)
299 26 POP_TOP
Mark Shannonfcb55c02021-04-01 16:00:31 +0100300 28 SETUP_FINALLY 10 (to 50)
Nick Coghlan50c48b82013-11-23 00:57:00 +1000301
Mark Shannoncc75ab72020-11-12 19:49:33 +0000302%3d 30 LOAD_FAST 0 (e)
303 32 LOAD_ATTR 1 (__traceback__)
304 34 STORE_FAST 1 (tb)
305 36 POP_BLOCK
306 38 POP_EXCEPT
307 40 LOAD_CONST 0 (None)
308 42 STORE_FAST 0 (e)
309 44 DELETE_FAST 0 (e)
310
311%3d 46 LOAD_FAST 1 (tb)
312 48 RETURN_VALUE
313 >> 50 LOAD_CONST 0 (None)
314 52 STORE_FAST 0 (e)
315 54 DELETE_FAST 0 (e)
Mark Shannonbf353f32020-12-17 13:55:28 +0000316 56 RERAISE 1
Mark Shannon5977a792020-12-02 13:31:40 +0000317
Mark Shannonbf353f32020-12-17 13:55:28 +0000318%3d >> 58 RERAISE 0
Nick Coghlan50c48b82013-11-23 00:57:00 +1000319""" % (TRACEBACK_CODE.co_firstlineno + 1,
320 TRACEBACK_CODE.co_firstlineno + 2,
Mark Shannoncc75ab72020-11-12 19:49:33 +0000321 TRACEBACK_CODE.co_firstlineno + 5,
Nick Coghlan50c48b82013-11-23 00:57:00 +1000322 TRACEBACK_CODE.co_firstlineno + 3,
323 TRACEBACK_CODE.co_firstlineno + 4,
Mark Shannon5977a792020-12-02 13:31:40 +0000324 TRACEBACK_CODE.co_firstlineno + 5,
325 TRACEBACK_CODE.co_firstlineno + 3)
Nick Coghlan50c48b82013-11-23 00:57:00 +1000326
Serhiy Storchakadd102f72016-10-08 12:34:25 +0300327def _fstring(a, b, c, d):
328 return f'{a} {b:4} {c!r} {d!r:4}'
329
330dis_fstring = """\
331%3d 0 LOAD_FAST 0 (a)
332 2 FORMAT_VALUE 0
333 4 LOAD_CONST 1 (' ')
334 6 LOAD_FAST 1 (b)
335 8 LOAD_CONST 2 ('4')
336 10 FORMAT_VALUE 4 (with format)
337 12 LOAD_CONST 1 (' ')
338 14 LOAD_FAST 2 (c)
339 16 FORMAT_VALUE 2 (repr)
340 18 LOAD_CONST 1 (' ')
341 20 LOAD_FAST 3 (d)
342 22 LOAD_CONST 2 ('4')
343 24 FORMAT_VALUE 6 (repr, with format)
344 26 BUILD_STRING 7
345 28 RETURN_VALUE
346""" % (_fstring.__code__.co_firstlineno + 1,)
347
Mark Shannon88dce262019-12-30 09:53:36 +0000348def _tryfinally(a, b):
349 try:
350 return a
351 finally:
352 b()
353
354def _tryfinallyconst(b):
355 try:
356 return 1
357 finally:
358 b()
359
360dis_tryfinally = """\
Mark Shannonfcb55c02021-04-01 16:00:31 +0100361%3d 0 SETUP_FINALLY 6 (to 14)
Mark Shannon88dce262019-12-30 09:53:36 +0000362
363%3d 2 LOAD_FAST 0 (a)
364 4 POP_BLOCK
365
366%3d 6 LOAD_FAST 1 (b)
367 8 CALL_FUNCTION 0
368 10 POP_TOP
Mark Shannon5274b682020-12-16 13:07:01 +0000369 12 RETURN_VALUE
370 >> 14 LOAD_FAST 1 (b)
Mark Shannon88dce262019-12-30 09:53:36 +0000371 16 CALL_FUNCTION 0
372 18 POP_TOP
Mark Shannonbf353f32020-12-17 13:55:28 +0000373 20 RERAISE 0
Mark Shannon88dce262019-12-30 09:53:36 +0000374""" % (_tryfinally.__code__.co_firstlineno + 1,
375 _tryfinally.__code__.co_firstlineno + 2,
376 _tryfinally.__code__.co_firstlineno + 4,
Mark Shannon88dce262019-12-30 09:53:36 +0000377 )
378
379dis_tryfinallyconst = """\
Mark Shannonfcb55c02021-04-01 16:00:31 +0100380%3d 0 SETUP_FINALLY 6 (to 14)
Mark Shannon88dce262019-12-30 09:53:36 +0000381
382%3d 2 POP_BLOCK
383
384%3d 4 LOAD_FAST 0 (b)
385 6 CALL_FUNCTION 0
386 8 POP_TOP
Mark Shannon5274b682020-12-16 13:07:01 +0000387 10 LOAD_CONST 1 (1)
Mark Shannon88dce262019-12-30 09:53:36 +0000388 12 RETURN_VALUE
Mark Shannon5274b682020-12-16 13:07:01 +0000389 >> 14 LOAD_FAST 0 (b)
Mark Shannon88dce262019-12-30 09:53:36 +0000390 16 CALL_FUNCTION 0
391 18 POP_TOP
Mark Shannonbf353f32020-12-17 13:55:28 +0000392 20 RERAISE 0
Mark Shannon88dce262019-12-30 09:53:36 +0000393""" % (_tryfinallyconst.__code__.co_firstlineno + 1,
394 _tryfinallyconst.__code__.co_firstlineno + 2,
395 _tryfinallyconst.__code__.co_firstlineno + 4,
Mark Shannon88dce262019-12-30 09:53:36 +0000396 )
397
Nick Coghlanefd5df92014-07-25 23:02:56 +1000398def _g(x):
399 yield x
400
syncosmicfe2b56a2017-08-17 19:29:21 -0700401async def _ag(x):
402 yield x
403
404async def _co(x):
405 async for item in _ag(x):
406 pass
407
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300408def _h(y):
409 def foo(x):
410 '''funcdoc'''
411 return [x + z for z in y]
412 return foo
413
414dis_nested_0 = """\
415%3d 0 LOAD_CLOSURE 0 (y)
416 2 BUILD_TUPLE 1
417 4 LOAD_CONST 1 (<code object foo at 0x..., file "%s", line %d>)
418 6 LOAD_CONST 2 ('_h.<locals>.foo')
Serhiy Storchakae2732d32018-03-11 11:07:06 +0200419 8 MAKE_FUNCTION 8 (closure)
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300420 10 STORE_FAST 1 (foo)
421
422%3d 12 LOAD_FAST 1 (foo)
423 14 RETURN_VALUE
424""" % (_h.__code__.co_firstlineno + 1,
425 __file__,
426 _h.__code__.co_firstlineno + 1,
427 _h.__code__.co_firstlineno + 4,
428)
429
430dis_nested_1 = """%s
431Disassembly of <code object foo at 0x..., file "%s", line %d>:
432%3d 0 LOAD_CLOSURE 0 (x)
433 2 BUILD_TUPLE 1
434 4 LOAD_CONST 1 (<code object <listcomp> at 0x..., file "%s", line %d>)
435 6 LOAD_CONST 2 ('_h.<locals>.foo.<locals>.<listcomp>')
Serhiy Storchakae2732d32018-03-11 11:07:06 +0200436 8 MAKE_FUNCTION 8 (closure)
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300437 10 LOAD_DEREF 1 (y)
438 12 GET_ITER
439 14 CALL_FUNCTION 1
440 16 RETURN_VALUE
441""" % (dis_nested_0,
442 __file__,
443 _h.__code__.co_firstlineno + 1,
444 _h.__code__.co_firstlineno + 3,
445 __file__,
446 _h.__code__.co_firstlineno + 3,
447)
448
449dis_nested_2 = """%s
450Disassembly of <code object <listcomp> at 0x..., file "%s", line %d>:
451%3d 0 BUILD_LIST 0
452 2 LOAD_FAST 0 (.0)
Mark Shannonfcb55c02021-04-01 16:00:31 +0100453 >> 4 FOR_ITER 6 (to 18)
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300454 6 STORE_FAST 1 (z)
455 8 LOAD_DEREF 0 (x)
456 10 LOAD_FAST 1 (z)
457 12 BINARY_ADD
458 14 LIST_APPEND 2
Mark Shannonfcb55c02021-04-01 16:00:31 +0100459 16 JUMP_ABSOLUTE 2 (to 4)
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300460 >> 18 RETURN_VALUE
461""" % (dis_nested_1,
462 __file__,
463 _h.__code__.co_firstlineno + 3,
464 _h.__code__.co_firstlineno + 3,
465)
466
syncosmicfe2b56a2017-08-17 19:29:21 -0700467
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000468class DisTests(unittest.TestCase):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500469
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300470 maxDiff = None
471
472 def get_disassembly(self, func, lasti=-1, wrapper=True, **kwargs):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000473 # We want to test the default printing behaviour, not the file arg
474 output = io.StringIO()
475 with contextlib.redirect_stdout(output):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500476 if wrapper:
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300477 dis.dis(func, **kwargs)
Benjamin Petersond6afe722011-03-15 14:44:52 -0500478 else:
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300479 dis.disassemble(func, lasti, **kwargs)
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000480 return output.getvalue()
Benjamin Petersond6afe722011-03-15 14:44:52 -0500481
482 def get_disassemble_as_string(self, func, lasti=-1):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000483 return self.get_disassembly(func, lasti, False)
Benjamin Petersond6afe722011-03-15 14:44:52 -0500484
Zachary Warebb4b7c12013-12-26 09:55:24 -0600485 def strip_addresses(self, text):
486 return re.sub(r'\b0x[0-9A-Fa-f]+\b', '0x...', text)
Benjamin Petersond6afe722011-03-15 14:44:52 -0500487
488 def do_disassembly_test(self, func, expected):
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300489 got = self.get_disassembly(func, depth=0)
Zachary Warebb4b7c12013-12-26 09:55:24 -0600490 if got != expected:
491 got = self.strip_addresses(got)
492 self.assertEqual(got, expected)
Michael W. Hudson26848a32003-04-29 17:07:36 +0000493
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000494 def test_opmap(self):
Benjamin Peterson76f7f4d2011-07-17 22:49:50 -0500495 self.assertEqual(dis.opmap["NOP"], 9)
Ezio Melottib58e0bd2010-01-23 15:40:09 +0000496 self.assertIn(dis.opmap["LOAD_CONST"], dis.hasconst)
497 self.assertIn(dis.opmap["STORE_NAME"], dis.hasname)
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000498
499 def test_opname(self):
500 self.assertEqual(dis.opname[dis.opmap["LOAD_FAST"]], "LOAD_FAST")
501
502 def test_boundaries(self):
503 self.assertEqual(dis.opmap["EXTENDED_ARG"], dis.EXTENDED_ARG)
504 self.assertEqual(dis.opmap["STORE_NAME"], dis.HAVE_ARGUMENT)
505
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300506 def test_widths(self):
507 for opcode, opname in enumerate(dis.opname):
508 if opname in ('BUILD_MAP_UNPACK_WITH_CALL',
Mark Shannon9af0e472020-01-14 10:12:45 +0000509 'BUILD_TUPLE_UNPACK_WITH_CALL',
510 'JUMP_IF_NOT_EXC_MATCH'):
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300511 continue
512 with self.subTest(opname=opname):
513 width = dis._OPNAME_WIDTH
514 if opcode < dis.HAVE_ARGUMENT:
515 width += 1 + dis._OPARG_WIDTH
516 self.assertLessEqual(len(opname), width)
517
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000518 def test_dis(self):
Michael W. Hudson26848a32003-04-29 17:07:36 +0000519 self.do_disassembly_test(_f, dis_f)
520
521 def test_bug_708901(self):
522 self.do_disassembly_test(bug708901, dis_bug708901)
Skip Montanaroadd0ccc2003-02-27 21:27:07 +0000523
Neal Norwitz51abbc72005-12-18 07:06:23 +0000524 def test_bug_1333982(self):
Tim Peters83a8c392005-12-25 22:52:32 +0000525 # This one is checking bytecodes generated for an `assert` statement,
526 # so fails if the tests are run with -O. Skip this test then.
Zachary Waree80e8062013-12-26 09:53:49 -0600527 if not __debug__:
528 self.skipTest('need asserts, run without -O')
Zachary Ware9fe6d862013-12-08 00:20:35 -0600529
Zachary Waree80e8062013-12-26 09:53:49 -0600530 self.do_disassembly_test(bug1333982, dis_bug1333982)
Neal Norwitz51abbc72005-12-18 07:06:23 +0000531
Yurii Karabasf24b8102020-12-04 17:20:53 +0200532 def test_bug_42562(self):
533 self.do_disassembly_test(bug42562, dis_bug42562)
534
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000535 def test_big_linenos(self):
536 def func(count):
537 namespace = {}
538 func = "def foo():\n " + "".join(["\n "] * count + ["spam\n"])
Georg Brandl7cae87c2006-09-06 06:51:57 +0000539 exec(func, namespace)
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000540 return namespace['foo']
541
542 # Test all small ranges
Guido van Rossum805365e2007-05-07 22:24:25 +0000543 for i in range(1, 300):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000544 expected = _BIG_LINENO_FORMAT % (i + 2)
545 self.do_disassembly_test(func(i), expected)
546
547 # Test some larger ranges too
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300548 for i in range(300, 1000, 10):
Thomas Wouters0e3f5912006-08-11 14:57:12 +0000549 expected = _BIG_LINENO_FORMAT % (i + 2)
550 self.do_disassembly_test(func(i), expected)
551
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300552 for i in range(1000, 5000, 10):
553 expected = _BIG_LINENO_FORMAT2 % (i + 2)
554 self.do_disassembly_test(func(i), expected)
555
Guido van Rossume7ba4952007-06-06 23:52:48 +0000556 from test import dis_module
557 self.do_disassembly_test(dis_module, dis_module_expected_results)
558
Serhiy Storchakad90045f2017-04-19 20:36:31 +0300559 def test_big_offsets(self):
560 def func(count):
561 namespace = {}
562 func = "def foo(x):\n " + ";".join(["x = x + 1"] * count) + "\n return x"
563 exec(func, namespace)
564 return namespace['foo']
565
566 def expected(count, w):
567 s = ['''\
568 %*d LOAD_FAST 0 (x)
569 %*d LOAD_CONST 1 (1)
570 %*d BINARY_ADD
571 %*d STORE_FAST 0 (x)
572''' % (w, 8*i, w, 8*i + 2, w, 8*i + 4, w, 8*i + 6)
573 for i in range(count)]
574 s += ['''\
575
576 3 %*d LOAD_FAST 0 (x)
577 %*d RETURN_VALUE
578''' % (w, 8*count, w, 8*count + 2)]
579 s[0] = ' 2' + s[0][3:]
580 return ''.join(s)
581
582 for i in range(1, 5):
583 self.do_disassembly_test(func(i), expected(i, 4))
584 self.do_disassembly_test(func(1249), expected(1249, 4))
585 self.do_disassembly_test(func(1250), expected(1250, 5))
586
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000587 def test_disassemble_str(self):
588 self.do_disassembly_test(expr_str, dis_expr_str)
589 self.do_disassembly_test(simple_stmt_str, dis_simple_stmt_str)
Yury Selivanovf8cb8a12016-09-08 20:50:03 -0700590 self.do_disassembly_test(annot_stmt_str, dis_annot_stmt_str)
Nick Coghlan5c8b54e2010-07-03 07:36:51 +0000591 self.do_disassembly_test(compound_stmt_str, dis_compound_stmt_str)
592
Benjamin Petersond6afe722011-03-15 14:44:52 -0500593 def test_disassemble_bytes(self):
594 self.do_disassembly_test(_f.__code__.co_code, dis_f_co_code)
595
Serhiy Storchaka585c93d2016-04-23 09:23:52 +0300596 def test_disassemble_class(self):
597 self.do_disassembly_test(_C, dis_c)
598
599 def test_disassemble_instance_method(self):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500600 self.do_disassembly_test(_C(1).__init__, dis_c_instance_method)
601
Serhiy Storchaka585c93d2016-04-23 09:23:52 +0300602 def test_disassemble_instance_method_bytes(self):
Benjamin Petersond6afe722011-03-15 14:44:52 -0500603 method_bytecode = _C(1).__init__.__code__.co_code
604 self.do_disassembly_test(method_bytecode, dis_c_instance_method_bytes)
605
Serhiy Storchaka585c93d2016-04-23 09:23:52 +0300606 def test_disassemble_static_method(self):
607 self.do_disassembly_test(_C.sm, dis_c_static_method)
608
609 def test_disassemble_class_method(self):
610 self.do_disassembly_test(_C.cm, dis_c_class_method)
611
Nick Coghlanefd5df92014-07-25 23:02:56 +1000612 def test_disassemble_generator(self):
syncosmicfe2b56a2017-08-17 19:29:21 -0700613 gen_func_disas = self.get_disassembly(_g) # Generator function
614 gen_disas = self.get_disassembly(_g(1)) # Generator iterator
Nick Coghlanefd5df92014-07-25 23:02:56 +1000615 self.assertEqual(gen_disas, gen_func_disas)
616
syncosmicfe2b56a2017-08-17 19:29:21 -0700617 def test_disassemble_async_generator(self):
618 agen_func_disas = self.get_disassembly(_ag) # Async generator function
619 agen_disas = self.get_disassembly(_ag(1)) # Async generator iterator
620 self.assertEqual(agen_disas, agen_func_disas)
621
622 def test_disassemble_coroutine(self):
623 coro_func_disas = self.get_disassembly(_co) # Coroutine function
624 coro = _co(1) # Coroutine object
625 coro.close() # Avoid a RuntimeWarning (never awaited)
626 coro_disas = self.get_disassembly(coro)
627 self.assertEqual(coro_disas, coro_func_disas)
628
Serhiy Storchakadd102f72016-10-08 12:34:25 +0300629 def test_disassemble_fstring(self):
630 self.do_disassembly_test(_fstring, dis_fstring)
631
Mark Shannon88dce262019-12-30 09:53:36 +0000632 def test_disassemble_try_finally(self):
633 self.do_disassembly_test(_tryfinally, dis_tryfinally)
634 self.do_disassembly_test(_tryfinallyconst, dis_tryfinallyconst)
635
Benjamin Petersond6afe722011-03-15 14:44:52 -0500636 def test_dis_none(self):
Benjamin Peterson47afc2a2011-03-15 15:54:50 -0500637 try:
638 del sys.last_traceback
639 except AttributeError:
640 pass
Benjamin Petersond6afe722011-03-15 14:44:52 -0500641 self.assertRaises(RuntimeError, dis.dis, None)
642
Benjamin Petersond6afe722011-03-15 14:44:52 -0500643 def test_dis_traceback(self):
Benjamin Peterson47afc2a2011-03-15 15:54:50 -0500644 try:
645 del sys.last_traceback
646 except AttributeError:
647 pass
Benjamin Petersond6afe722011-03-15 14:44:52 -0500648
649 try:
650 1/0
651 except Exception as e:
652 tb = e.__traceback__
653 sys.last_traceback = tb
Benjamin Petersond6afe722011-03-15 14:44:52 -0500654
655 tb_dis = self.get_disassemble_as_string(tb.tb_frame.f_code, tb.tb_lasti)
656 self.do_disassembly_test(None, tb_dis)
657
658 def test_dis_object(self):
659 self.assertRaises(TypeError, dis.dis, object())
660
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300661 def test_disassemble_recursive(self):
662 def check(expected, **kwargs):
663 dis = self.get_disassembly(_h, **kwargs)
664 dis = self.strip_addresses(dis)
665 self.assertEqual(dis, expected)
666
667 check(dis_nested_0, depth=0)
668 check(dis_nested_1, depth=1)
669 check(dis_nested_2, depth=2)
670 check(dis_nested_2, depth=3)
671 check(dis_nested_2, depth=None)
672 check(dis_nested_2)
673
674
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000675class DisWithFileTests(DisTests):
676
677 # Run the tests again, using the file arg instead of print
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300678 def get_disassembly(self, func, lasti=-1, wrapper=True, **kwargs):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000679 output = io.StringIO()
680 if wrapper:
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300681 dis.dis(func, file=output, **kwargs)
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000682 else:
Serhiy Storchaka1efbf922017-06-11 14:09:39 +0300683 dis.disassemble(func, lasti, file=output, **kwargs)
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000684 return output.getvalue()
685
686
Mark Shannon266b4622020-11-17 19:30:14 +0000687if sys.flags.optimize:
688 code_info_consts = "0: None"
689else:
690 code_info_consts = (
691 """0: 'Formatted details of methods, functions, or code.'
692 1: None"""
693)
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000694
Mark Shannon266b4622020-11-17 19:30:14 +0000695code_info_code_info = f"""\
Nick Coghlaneae2da12010-08-17 08:03:36 +0000696Name: code_info
Nick Coghlan46e63802010-08-17 11:28:07 +0000697Filename: (.*)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000698Argument count: 1
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100699Positional-only arguments: 0
Nick Coghlaneae2da12010-08-17 08:03:36 +0000700Kw-only arguments: 0
701Number of locals: 1
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000702Stack size: 3
Nick Coghlaneae2da12010-08-17 08:03:36 +0000703Flags: OPTIMIZED, NEWLOCALS, NOFREE
704Constants:
Mark Shannon266b4622020-11-17 19:30:14 +0000705 {code_info_consts}
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000706Names:
707 0: _format_code_info
708 1: _get_code_object
Nick Coghlaneae2da12010-08-17 08:03:36 +0000709Variable names:
Mark Shannon266b4622020-11-17 19:30:14 +0000710 0: x"""
711
Nick Coghlaneae2da12010-08-17 08:03:36 +0000712
713@staticmethod
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100714def tricky(a, b, /, x, y, z=True, *args, c, d, e=[], **kwds):
Nick Coghlaneae2da12010-08-17 08:03:36 +0000715 def f(c=c):
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100716 print(a, b, x, y, z, c, d, e, f)
717 yield a, b, x, y, z, c, d, e, f
Nick Coghlaneae2da12010-08-17 08:03:36 +0000718
Nick Coghlaneae2da12010-08-17 08:03:36 +0000719code_info_tricky = """\
720Name: tricky
Nick Coghlan46e63802010-08-17 11:28:07 +0000721Filename: (.*)
Pablo Galindocd74e662019-06-01 18:08:04 +0100722Argument count: 5
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100723Positional-only arguments: 2
Nick Coghlaneae2da12010-08-17 08:03:36 +0000724Kw-only arguments: 3
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100725Number of locals: 10
726Stack size: 9
Nick Coghlaneae2da12010-08-17 08:03:36 +0000727Flags: OPTIMIZED, NEWLOCALS, VARARGS, VARKEYWORDS, GENERATOR
728Constants:
729 0: None
Nick Coghlan46e63802010-08-17 11:28:07 +0000730 1: <code object f at (.*), file "(.*)", line (.*)>
Antoine Pitrou86a36b52011-11-25 18:56:07 +0100731 2: 'tricky.<locals>.f'
Nick Coghlaneae2da12010-08-17 08:03:36 +0000732Variable names:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100733 0: a
734 1: b
735 2: x
736 3: y
737 4: z
738 5: c
739 6: d
740 7: e
741 8: args
742 9: kwds
Nick Coghlaneae2da12010-08-17 08:03:36 +0000743Cell variables:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100744 0: [abedfxyz]
745 1: [abedfxyz]
746 2: [abedfxyz]
747 3: [abedfxyz]
748 4: [abedfxyz]
749 5: [abedfxyz]"""
Georg Brandla1082272012-02-20 21:41:03 +0100750# NOTE: the order of the cell variables above depends on dictionary order!
Nick Coghlan46e63802010-08-17 11:28:07 +0000751
752co_tricky_nested_f = tricky.__func__.__code__.co_consts[1]
Nick Coghlaneae2da12010-08-17 08:03:36 +0000753
754code_info_tricky_nested_f = """\
Nick Coghlan46e63802010-08-17 11:28:07 +0000755Filename: (.*)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000756Argument count: 1
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100757Positional-only arguments: 0
Nick Coghlaneae2da12010-08-17 08:03:36 +0000758Kw-only arguments: 0
759Number of locals: 1
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100760Stack size: 10
Nick Coghlaneae2da12010-08-17 08:03:36 +0000761Flags: OPTIMIZED, NEWLOCALS, NESTED
762Constants:
763 0: None
764Names:
765 0: print
766Variable names:
767 0: c
768Free variables:
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100769 0: [abedfxyz]
770 1: [abedfxyz]
771 2: [abedfxyz]
772 3: [abedfxyz]
773 4: [abedfxyz]
774 5: [abedfxyz]"""
Nick Coghlaneae2da12010-08-17 08:03:36 +0000775
776code_info_expr_str = """\
777Name: <module>
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000778Filename: <disassembly>
Nick Coghlaneae2da12010-08-17 08:03:36 +0000779Argument count: 0
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100780Positional-only arguments: 0
Nick Coghlaneae2da12010-08-17 08:03:36 +0000781Kw-only arguments: 0
782Number of locals: 0
783Stack size: 2
784Flags: NOFREE
785Constants:
786 0: 1
787Names:
788 0: x"""
789
790code_info_simple_stmt_str = """\
791Name: <module>
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000792Filename: <disassembly>
Nick Coghlaneae2da12010-08-17 08:03:36 +0000793Argument count: 0
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100794Positional-only arguments: 0
Nick Coghlaneae2da12010-08-17 08:03:36 +0000795Kw-only arguments: 0
796Number of locals: 0
797Stack size: 2
798Flags: NOFREE
799Constants:
800 0: 1
801 1: None
802Names:
803 0: x"""
804
805code_info_compound_stmt_str = """\
806Name: <module>
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000807Filename: <disassembly>
Nick Coghlaneae2da12010-08-17 08:03:36 +0000808Argument count: 0
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100809Positional-only arguments: 0
Nick Coghlaneae2da12010-08-17 08:03:36 +0000810Kw-only arguments: 0
811Number of locals: 0
812Stack size: 2
813Flags: NOFREE
814Constants:
815 0: 0
816 1: 1
817 2: None
818Names:
819 0: x"""
820
Yury Selivanov75445082015-05-11 22:57:16 -0400821
822async def async_def():
823 await 1
824 async for a in b: pass
825 async with c as d: pass
826
827code_info_async_def = """\
828Name: async_def
829Filename: (.*)
830Argument count: 0
Pablo Galindo8c77b8c2019-04-29 13:36:57 +0100831Positional-only arguments: 0
Yury Selivanov75445082015-05-11 22:57:16 -0400832Kw-only arguments: 0
833Number of locals: 2
Mark Shannonfee55262019-11-21 09:11:43 +0000834Stack size: 9
Yury Selivanoveb636452016-09-08 22:01:51 -0700835Flags: OPTIMIZED, NEWLOCALS, NOFREE, COROUTINE
Yury Selivanov75445082015-05-11 22:57:16 -0400836Constants:
837 0: None
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +0200838 1: 1
839Names:
840 0: b
Serhiy Storchaka702f8f32018-03-23 14:34:35 +0200841 1: c
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +0200842Variable names:
843 0: a
844 1: d"""
Yury Selivanov75445082015-05-11 22:57:16 -0400845
Nick Coghlaneae2da12010-08-17 08:03:36 +0000846class CodeInfoTests(unittest.TestCase):
847 test_pairs = [
848 (dis.code_info, code_info_code_info),
849 (tricky, code_info_tricky),
850 (co_tricky_nested_f, code_info_tricky_nested_f),
851 (expr_str, code_info_expr_str),
852 (simple_stmt_str, code_info_simple_stmt_str),
853 (compound_stmt_str, code_info_compound_stmt_str),
Yury Selivanov75445082015-05-11 22:57:16 -0400854 (async_def, code_info_async_def)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000855 ]
856
857 def test_code_info(self):
858 self.maxDiff = 1000
859 for x, expected in self.test_pairs:
Ezio Melottied3a7d22010-12-01 02:32:32 +0000860 self.assertRegex(dis.code_info(x), expected)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000861
862 def test_show_code(self):
863 self.maxDiff = 1000
864 for x, expected in self.test_pairs:
865 with captured_stdout() as output:
866 dis.show_code(x)
Ezio Melottied3a7d22010-12-01 02:32:32 +0000867 self.assertRegex(output.getvalue(), expected+"\n")
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000868 output = io.StringIO()
869 dis.show_code(x, file=output)
870 self.assertRegex(output.getvalue(), expected)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000871
Benjamin Petersond6afe722011-03-15 14:44:52 -0500872 def test_code_info_object(self):
873 self.assertRaises(TypeError, dis.code_info, object())
874
875 def test_pretty_flags_no_flags(self):
876 self.assertEqual(dis.pretty_flags(0), '0x0')
877
878
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000879# Fodder for instruction introspection tests
880# Editing any of these may require recalculating the expected output
881def outer(a=1, b=2):
882 def f(c=3, d=4):
883 def inner(e=5, f=6):
884 print(a, b, c, d, e, f)
885 print(a, b, c, d)
886 return inner
887 print(a, b, '', 1, [], {}, "Hello world!")
888 return f
889
890def jumpy():
891 # This won't actually run (but that's OK, we only disassemble it)
892 for i in range(10):
893 print(i)
894 if i < 4:
895 continue
896 if i > 6:
897 break
898 else:
899 print("I can haz else clause?")
900 while i:
901 print(i)
902 i -= 1
903 if i > 6:
904 continue
905 if i < 4:
906 break
907 else:
908 print("Who let lolcatz into this test suite?")
909 try:
910 1 / 0
911 except ZeroDivisionError:
912 print("Here we go, here we go, here we go...")
913 else:
914 with i as dodgy:
915 print("Never reach this")
916 finally:
917 print("OK, now we're done")
918
919# End fodder for opinfo generation tests
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000920expected_outer_line = 1
921_line_offset = outer.__code__.co_firstlineno - 1
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000922code_object_f = outer.__code__.co_consts[3]
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000923expected_f_line = code_object_f.co_firstlineno - _line_offset
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000924code_object_inner = code_object_f.co_consts[3]
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000925expected_inner_line = code_object_inner.co_firstlineno - _line_offset
926expected_jumpy_line = 1
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000927
928# The following lines are useful to regenerate the expected results after
929# either the fodder is modified or the bytecode generation changes
930# After regeneration, update the references to code_object_f and
931# code_object_inner before rerunning the tests
932
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000933#_instructions = dis.get_instructions(outer, first_line=expected_outer_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000934#print('expected_opinfo_outer = [\n ',
935 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
Antoine Pitroue7811fc2014-09-18 03:06:50 +0200936#_instructions = dis.get_instructions(outer(), first_line=expected_f_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000937#print('expected_opinfo_f = [\n ',
938 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
Antoine Pitroue7811fc2014-09-18 03:06:50 +0200939#_instructions = dis.get_instructions(outer()(), first_line=expected_inner_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000940#print('expected_opinfo_inner = [\n ',
941 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000942#_instructions = dis.get_instructions(jumpy, first_line=expected_jumpy_line)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000943#print('expected_opinfo_jumpy = [\n ',
944 #',\n '.join(map(str, _instructions)), ',\n]', sep='')
945
946
947Instruction = dis.Instruction
948expected_opinfo_outer = [
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300949 Instruction(opname='LOAD_CONST', opcode=100, arg=8, argval=(3, 4), argrepr='(3, 4)', offset=0, starts_line=2, is_jump_target=False),
950 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=0, argval='a', argrepr='a', offset=2, starts_line=None, is_jump_target=False),
951 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=1, argval='b', argrepr='b', offset=4, starts_line=None, is_jump_target=False),
952 Instruction(opname='BUILD_TUPLE', opcode=102, arg=2, argval=2, argrepr='', offset=6, starts_line=None, is_jump_target=False),
953 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),
954 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),
Serhiy Storchakae2732d32018-03-11 11:07:06 +0200955 Instruction(opname='MAKE_FUNCTION', opcode=132, arg=9, argval=9, argrepr='defaults, closure', offset=12, starts_line=None, is_jump_target=False),
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300956 Instruction(opname='STORE_FAST', opcode=125, arg=2, argval='f', argrepr='f', offset=14, starts_line=None, is_jump_target=False),
957 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=0, argval='print', argrepr='print', offset=16, starts_line=7, is_jump_target=False),
958 Instruction(opname='LOAD_DEREF', opcode=136, arg=0, argval='a', argrepr='a', offset=18, starts_line=None, is_jump_target=False),
959 Instruction(opname='LOAD_DEREF', opcode=136, arg=1, argval='b', argrepr='b', offset=20, starts_line=None, is_jump_target=False),
960 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval='', argrepr="''", offset=22, starts_line=None, is_jump_target=False),
961 Instruction(opname='LOAD_CONST', opcode=100, arg=6, argval=1, argrepr='1', offset=24, starts_line=None, is_jump_target=False),
962 Instruction(opname='BUILD_LIST', opcode=103, arg=0, argval=0, argrepr='', offset=26, starts_line=None, is_jump_target=False),
963 Instruction(opname='BUILD_MAP', opcode=105, arg=0, argval=0, argrepr='', offset=28, starts_line=None, is_jump_target=False),
964 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 -0700965 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 +0300966 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=34, starts_line=None, is_jump_target=False),
967 Instruction(opname='LOAD_FAST', opcode=124, arg=2, argval='f', argrepr='f', offset=36, starts_line=8, is_jump_target=False),
968 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 +1000969]
970
971expected_opinfo_f = [
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300972 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval=(5, 6), argrepr='(5, 6)', offset=0, starts_line=3, is_jump_target=False),
973 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=2, argval='a', argrepr='a', offset=2, starts_line=None, is_jump_target=False),
974 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=3, argval='b', argrepr='b', offset=4, starts_line=None, is_jump_target=False),
975 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=0, argval='c', argrepr='c', offset=6, starts_line=None, is_jump_target=False),
976 Instruction(opname='LOAD_CLOSURE', opcode=135, arg=1, argval='d', argrepr='d', offset=8, starts_line=None, is_jump_target=False),
977 Instruction(opname='BUILD_TUPLE', opcode=102, arg=4, argval=4, argrepr='', offset=10, starts_line=None, is_jump_target=False),
978 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),
979 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),
Serhiy Storchakae2732d32018-03-11 11:07:06 +0200980 Instruction(opname='MAKE_FUNCTION', opcode=132, arg=9, argval=9, argrepr='defaults, closure', offset=16, starts_line=None, is_jump_target=False),
Serhiy Storchaka64204de2016-06-12 17:36:24 +0300981 Instruction(opname='STORE_FAST', opcode=125, arg=2, argval='inner', argrepr='inner', offset=18, starts_line=None, is_jump_target=False),
982 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=0, argval='print', argrepr='print', offset=20, starts_line=5, is_jump_target=False),
983 Instruction(opname='LOAD_DEREF', opcode=136, arg=2, argval='a', argrepr='a', offset=22, starts_line=None, is_jump_target=False),
984 Instruction(opname='LOAD_DEREF', opcode=136, arg=3, argval='b', argrepr='b', offset=24, starts_line=None, is_jump_target=False),
985 Instruction(opname='LOAD_DEREF', opcode=136, arg=0, argval='c', argrepr='c', offset=26, starts_line=None, is_jump_target=False),
986 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 -0700987 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 +0300988 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=32, starts_line=None, is_jump_target=False),
989 Instruction(opname='LOAD_FAST', opcode=124, arg=2, argval='inner', argrepr='inner', offset=34, starts_line=6, is_jump_target=False),
990 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 +1000991]
992
993expected_opinfo_inner = [
994 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 +0300995 Instruction(opname='LOAD_DEREF', opcode=136, arg=0, argval='a', argrepr='a', offset=2, starts_line=None, is_jump_target=False),
996 Instruction(opname='LOAD_DEREF', opcode=136, arg=1, argval='b', argrepr='b', offset=4, starts_line=None, is_jump_target=False),
997 Instruction(opname='LOAD_DEREF', opcode=136, arg=2, argval='c', argrepr='c', offset=6, starts_line=None, is_jump_target=False),
998 Instruction(opname='LOAD_DEREF', opcode=136, arg=3, argval='d', argrepr='d', offset=8, starts_line=None, is_jump_target=False),
999 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='e', argrepr='e', offset=10, starts_line=None, is_jump_target=False),
1000 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 -07001001 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 +03001002 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=16, starts_line=None, is_jump_target=False),
1003 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=18, starts_line=None, is_jump_target=False),
1004 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 +10001005]
1006
1007expected_opinfo_jumpy = [
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001008 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=0, argval='range', argrepr='range', offset=0, starts_line=3, is_jump_target=False),
1009 Instruction(opname='LOAD_CONST', opcode=100, arg=1, argval=10, argrepr='10', offset=2, starts_line=None, is_jump_target=False),
1010 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=4, starts_line=None, is_jump_target=False),
1011 Instruction(opname='GET_ITER', opcode=68, arg=None, argval=None, argrepr='', offset=6, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001012 Instruction(opname='FOR_ITER', opcode=93, arg=17, argval=44, argrepr='to 44', offset=8, starts_line=None, is_jump_target=True),
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001013 Instruction(opname='STORE_FAST', opcode=125, arg=0, argval='i', argrepr='i', offset=10, starts_line=None, is_jump_target=False),
1014 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=12, starts_line=4, is_jump_target=False),
1015 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=14, starts_line=None, is_jump_target=False),
1016 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=16, starts_line=None, is_jump_target=False),
1017 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=18, starts_line=None, is_jump_target=False),
1018 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=20, starts_line=5, is_jump_target=False),
1019 Instruction(opname='LOAD_CONST', opcode=100, arg=2, argval=4, argrepr='4', offset=22, starts_line=None, is_jump_target=False),
1020 Instruction(opname='COMPARE_OP', opcode=107, arg=0, argval='<', argrepr='<', offset=24, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001021 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=15, argval=30, argrepr='to 30', offset=26, starts_line=None, is_jump_target=False),
1022 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=4, argval=8, argrepr='to 8', offset=28, starts_line=6, is_jump_target=False),
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001023 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=30, starts_line=7, is_jump_target=True),
1024 Instruction(opname='LOAD_CONST', opcode=100, arg=3, argval=6, argrepr='6', offset=32, starts_line=None, is_jump_target=False),
1025 Instruction(opname='COMPARE_OP', opcode=107, arg=4, argval='>', argrepr='>', offset=34, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001026 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=21, argval=42, argrepr='to 42', offset=36, starts_line=None, is_jump_target=False),
Serhiy Storchaka520b7ae2018-02-22 23:33:30 +02001027 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=38, starts_line=8, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001028 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=26, argval=52, argrepr='to 52', offset=40, starts_line=None, is_jump_target=False),
1029 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=4, argval=8, argrepr='to 8', offset=42, starts_line=7, is_jump_target=True),
Mark Shannon28b75c82020-12-23 11:43:10 +00001030 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=44, starts_line=10, is_jump_target=True),
1031 Instruction(opname='LOAD_CONST', opcode=100, arg=4, argval='I can haz else clause?', argrepr="'I can haz else clause?'", offset=46, starts_line=None, is_jump_target=False),
1032 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=48, starts_line=None, is_jump_target=False),
1033 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=50, starts_line=None, is_jump_target=False),
1034 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=52, starts_line=11, is_jump_target=True),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001035 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=48, argval=96, argrepr='to 96', offset=54, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001036 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=56, starts_line=12, is_jump_target=True),
1037 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=58, starts_line=None, is_jump_target=False),
1038 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=60, starts_line=None, is_jump_target=False),
1039 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=62, starts_line=None, is_jump_target=False),
1040 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=64, starts_line=13, is_jump_target=False),
1041 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval=1, argrepr='1', offset=66, starts_line=None, is_jump_target=False),
1042 Instruction(opname='INPLACE_SUBTRACT', opcode=56, arg=None, argval=None, argrepr='', offset=68, starts_line=None, is_jump_target=False),
1043 Instruction(opname='STORE_FAST', opcode=125, arg=0, argval='i', argrepr='i', offset=70, starts_line=None, is_jump_target=False),
1044 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=72, starts_line=14, is_jump_target=False),
1045 Instruction(opname='LOAD_CONST', opcode=100, arg=3, argval=6, argrepr='6', offset=74, starts_line=None, is_jump_target=False),
1046 Instruction(opname='COMPARE_OP', opcode=107, arg=4, argval='>', argrepr='>', offset=76, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001047 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=41, argval=82, argrepr='to 82', offset=78, starts_line=None, is_jump_target=False),
1048 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=26, argval=52, argrepr='to 52', offset=80, starts_line=15, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001049 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=82, starts_line=16, is_jump_target=True),
1050 Instruction(opname='LOAD_CONST', opcode=100, arg=2, argval=4, argrepr='4', offset=84, starts_line=None, is_jump_target=False),
1051 Instruction(opname='COMPARE_OP', opcode=107, arg=0, argval='<', argrepr='<', offset=86, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001052 Instruction(opname='POP_JUMP_IF_FALSE', opcode=114, arg=46, argval=92, argrepr='to 92', offset=88, starts_line=None, is_jump_target=False),
1053 Instruction(opname='JUMP_ABSOLUTE', opcode=113, arg=52, argval=104, argrepr='to 104', offset=90, starts_line=17, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001054 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=92, starts_line=11, is_jump_target=True),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001055 Instruction(opname='POP_JUMP_IF_TRUE', opcode=115, arg=28, argval=56, argrepr='to 56', offset=94, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001056 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=96, starts_line=19, is_jump_target=True),
1057 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=98, starts_line=None, is_jump_target=False),
1058 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=100, starts_line=None, is_jump_target=False),
1059 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=102, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001060 Instruction(opname='SETUP_FINALLY', opcode=122, arg=48, argval=202, argrepr='to 202', offset=104, starts_line=20, is_jump_target=True),
1061 Instruction(opname='SETUP_FINALLY', opcode=122, arg=6, argval=120, argrepr='to 120', offset=106, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001062 Instruction(opname='LOAD_CONST', opcode=100, arg=5, argval=1, argrepr='1', offset=108, starts_line=21, is_jump_target=False),
1063 Instruction(opname='LOAD_CONST', opcode=100, arg=7, argval=0, argrepr='0', offset=110, starts_line=None, is_jump_target=False),
1064 Instruction(opname='BINARY_TRUE_DIVIDE', opcode=27, arg=None, argval=None, argrepr='', offset=112, starts_line=None, is_jump_target=False),
1065 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=114, starts_line=None, is_jump_target=False),
1066 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=116, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001067 Instruction(opname='JUMP_FORWARD', opcode=110, arg=12, argval=144, argrepr='to 144', offset=118, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001068 Instruction(opname='DUP_TOP', opcode=4, arg=None, argval=None, argrepr='', offset=120, starts_line=22, is_jump_target=True),
1069 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=2, argval='ZeroDivisionError', argrepr='ZeroDivisionError', offset=122, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001070 Instruction(opname='JUMP_IF_NOT_EXC_MATCH', opcode=121, arg=106, argval=212, argrepr='to 212', offset=124, starts_line=None, is_jump_target=False),
Mark Shannon8473cf82020-12-15 11:07:50 +00001071 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=126, starts_line=None, is_jump_target=False),
1072 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=128, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001073 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=130, starts_line=None, is_jump_target=False),
1074 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=132, starts_line=23, is_jump_target=False),
1075 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=134, starts_line=None, is_jump_target=False),
1076 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=136, starts_line=None, is_jump_target=False),
1077 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=138, starts_line=None, is_jump_target=False),
1078 Instruction(opname='POP_EXCEPT', opcode=89, arg=None, argval=None, argrepr='', offset=140, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001079 Instruction(opname='JUMP_FORWARD', opcode=110, arg=22, argval=188, argrepr='to 188', offset=142, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001080 Instruction(opname='LOAD_FAST', opcode=124, arg=0, argval='i', argrepr='i', offset=144, starts_line=25, is_jump_target=True),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001081 Instruction(opname='SETUP_WITH', opcode=143, arg=12, argval=172, argrepr='to 172', offset=146, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001082 Instruction(opname='STORE_FAST', opcode=125, arg=1, argval='dodgy', argrepr='dodgy', offset=148, starts_line=None, is_jump_target=False),
1083 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=150, starts_line=26, is_jump_target=False),
1084 Instruction(opname='LOAD_CONST', opcode=100, arg=9, argval='Never reach this', argrepr="'Never reach this'", offset=152, starts_line=None, is_jump_target=False),
1085 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=154, starts_line=None, is_jump_target=False),
1086 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=156, starts_line=None, is_jump_target=False),
1087 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=158, starts_line=None, is_jump_target=False),
1088 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=160, starts_line=None, is_jump_target=False),
Mark Shannon8473cf82020-12-15 11:07:50 +00001089 Instruction(opname='DUP_TOP', opcode=4, arg=None, argval=None, argrepr='', offset=162, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001090 Instruction(opname='DUP_TOP', opcode=4, arg=None, argval=None, argrepr='', offset=164, starts_line=None, is_jump_target=False),
1091 Instruction(opname='CALL_FUNCTION', opcode=131, arg=3, argval=3, argrepr='', offset=166, starts_line=None, is_jump_target=False),
1092 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=168, starts_line=None, is_jump_target=False),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001093 Instruction(opname='JUMP_FORWARD', opcode=110, arg=8, argval=188, argrepr='to 188', offset=170, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001094 Instruction(opname='WITH_EXCEPT_START', opcode=49, arg=None, argval=None, argrepr='', offset=172, starts_line=None, is_jump_target=True),
Mark Shannonfcb55c02021-04-01 16:00:31 +01001095 Instruction(opname='POP_JUMP_IF_TRUE', opcode=115, arg=89, argval=178, argrepr='to 178', offset=174, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001096 Instruction(opname='RERAISE', opcode=119, arg=1, argval=1, argrepr='', offset=176, starts_line=None, is_jump_target=False),
1097 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=178, starts_line=None, is_jump_target=True),
Mark Shannon8473cf82020-12-15 11:07:50 +00001098 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=180, starts_line=None, is_jump_target=False),
Mark Shannon28b75c82020-12-23 11:43:10 +00001099 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=182, starts_line=None, is_jump_target=False),
1100 Instruction(opname='POP_EXCEPT', opcode=89, arg=None, argval=None, argrepr='', offset=184, starts_line=None, is_jump_target=False),
1101 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=186, starts_line=None, is_jump_target=False),
1102 Instruction(opname='POP_BLOCK', opcode=87, arg=None, argval=None, argrepr='', offset=188, starts_line=None, is_jump_target=True),
1103 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=190, starts_line=28, is_jump_target=False),
1104 Instruction(opname='LOAD_CONST', opcode=100, arg=10, argval="OK, now we're done", argrepr='"OK, now we\'re done"', offset=192, starts_line=None, is_jump_target=False),
1105 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=194, starts_line=None, is_jump_target=False),
1106 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=196, starts_line=None, is_jump_target=False),
1107 Instruction(opname='LOAD_CONST', opcode=100, arg=0, argval=None, argrepr='None', offset=198, starts_line=None, is_jump_target=False),
1108 Instruction(opname='RETURN_VALUE', opcode=83, arg=None, argval=None, argrepr='', offset=200, starts_line=None, is_jump_target=False),
1109 Instruction(opname='LOAD_GLOBAL', opcode=116, arg=1, argval='print', argrepr='print', offset=202, starts_line=None, is_jump_target=True),
1110 Instruction(opname='LOAD_CONST', opcode=100, arg=10, argval="OK, now we're done", argrepr='"OK, now we\'re done"', offset=204, starts_line=None, is_jump_target=False),
1111 Instruction(opname='CALL_FUNCTION', opcode=131, arg=1, argval=1, argrepr='', offset=206, starts_line=None, is_jump_target=False),
1112 Instruction(opname='POP_TOP', opcode=1, arg=None, argval=None, argrepr='', offset=208, starts_line=None, is_jump_target=False),
1113 Instruction(opname='RERAISE', opcode=119, arg=0, argval=0, argrepr='', offset=210, starts_line=None, is_jump_target=False),
1114 Instruction(opname='RERAISE', opcode=119, arg=0, argval=0, argrepr='', offset=212, starts_line=22, is_jump_target=True),
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001115]
1116
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001117# One last piece of inspect fodder to check the default line number handling
1118def simple(): pass
1119expected_opinfo_simple = [
1120 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 +03001121 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 +10001122]
1123
1124
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001125class InstructionTests(BytecodeTestCase):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001126
Mark Shannonfee55262019-11-21 09:11:43 +00001127 def __init__(self, *args):
1128 super().__init__(*args)
1129 self.maxDiff = None
1130
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001131 def test_default_first_line(self):
1132 actual = dis.get_instructions(simple)
1133 self.assertEqual(list(actual), expected_opinfo_simple)
1134
1135 def test_first_line_set_to_None(self):
1136 actual = dis.get_instructions(simple, first_line=None)
1137 self.assertEqual(list(actual), expected_opinfo_simple)
1138
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001139 def test_outer(self):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001140 actual = dis.get_instructions(outer, first_line=expected_outer_line)
1141 self.assertEqual(list(actual), expected_opinfo_outer)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001142
1143 def test_nested(self):
1144 with captured_stdout():
1145 f = outer()
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001146 actual = dis.get_instructions(f, first_line=expected_f_line)
1147 self.assertEqual(list(actual), expected_opinfo_f)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001148
1149 def test_doubly_nested(self):
1150 with captured_stdout():
1151 inner = outer()()
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001152 actual = dis.get_instructions(inner, first_line=expected_inner_line)
1153 self.assertEqual(list(actual), expected_opinfo_inner)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001154
1155 def test_jumpy(self):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001156 actual = dis.get_instructions(jumpy, first_line=expected_jumpy_line)
1157 self.assertEqual(list(actual), expected_opinfo_jumpy)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001158
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001159# get_instructions has its own tests above, so can rely on it to validate
1160# the object oriented API
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001161class BytecodeTests(unittest.TestCase):
Mark Shannonfee55262019-11-21 09:11:43 +00001162
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001163 def test_instantiation(self):
1164 # Test with function, method, code string and code object
1165 for obj in [_f, _C(1).__init__, "a=1", _f.__code__]:
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001166 with self.subTest(obj=obj):
1167 b = dis.Bytecode(obj)
1168 self.assertIsInstance(b.codeobj, types.CodeType)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001169
1170 self.assertRaises(TypeError, dis.Bytecode, object())
1171
1172 def test_iteration(self):
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001173 for obj in [_f, _C(1).__init__, "a=1", _f.__code__]:
1174 with self.subTest(obj=obj):
1175 via_object = list(dis.Bytecode(obj))
1176 via_generator = list(dis.get_instructions(obj))
1177 self.assertEqual(via_object, via_generator)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001178
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001179 def test_explicit_first_line(self):
1180 actual = dis.Bytecode(outer, first_line=expected_outer_line)
1181 self.assertEqual(list(actual), expected_opinfo_outer)
1182
1183 def test_source_line_in_disassembly(self):
1184 # Use the line in the source code
syncosmicfe2b56a2017-08-17 19:29:21 -07001185 actual = dis.Bytecode(simple).dis()
1186 actual = actual.strip().partition(" ")[0] # extract the line no
1187 expected = str(simple.__code__.co_firstlineno)
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001188 self.assertEqual(actual, expected)
1189 # Use an explicit first line number
syncosmicfe2b56a2017-08-17 19:29:21 -07001190 actual = dis.Bytecode(simple, first_line=350).dis()
1191 actual = actual.strip().partition(" ")[0] # extract the line no
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001192 self.assertEqual(actual, "350")
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001193
1194 def test_info(self):
1195 self.maxDiff = 1000
1196 for x, expected in CodeInfoTests.test_pairs:
1197 b = dis.Bytecode(x)
1198 self.assertRegex(b.info(), expected)
1199
Nick Coghlan90b8e7d2013-11-06 22:08:36 +10001200 def test_disassembled(self):
1201 actual = dis.Bytecode(_f).dis()
1202 self.assertEqual(actual, dis_f)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001203
Nick Coghlan50c48b82013-11-23 00:57:00 +10001204 def test_from_traceback(self):
1205 tb = get_tb()
1206 b = dis.Bytecode.from_traceback(tb)
1207 while tb.tb_next: tb = tb.tb_next
1208
1209 self.assertEqual(b.current_offset, tb.tb_lasti)
1210
1211 def test_from_traceback_dis(self):
1212 tb = get_tb()
1213 b = dis.Bytecode.from_traceback(tb)
1214 self.assertEqual(b.dis(), dis_traceback)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +10001215
Max Bernstein6e799be2020-12-17 16:30:29 -08001216
1217class TestBytecodeTestCase(BytecodeTestCase):
1218 def test_assert_not_in_with_op_not_in_bytecode(self):
1219 code = compile("a = 1", "<string>", "exec")
1220 self.assertInBytecode(code, "LOAD_CONST", 1)
1221 self.assertNotInBytecode(code, "LOAD_NAME")
1222 self.assertNotInBytecode(code, "LOAD_NAME", "a")
1223
1224 def test_assert_not_in_with_arg_not_in_bytecode(self):
1225 code = compile("a = 1", "<string>", "exec")
1226 self.assertInBytecode(code, "LOAD_CONST")
1227 self.assertInBytecode(code, "LOAD_CONST", 1)
1228 self.assertNotInBytecode(code, "LOAD_CONST", 2)
1229
1230 def test_assert_not_in_with_arg_in_bytecode(self):
1231 code = compile("a = 1", "<string>", "exec")
1232 with self.assertRaises(AssertionError):
1233 self.assertNotInBytecode(code, "LOAD_CONST", 1)
1234
Skip Montanaroadd0ccc2003-02-27 21:27:07 +00001235if __name__ == "__main__":
Zachary Waree80e8062013-12-26 09:53:49 -06001236 unittest.main()