blob: b00d619d83f89f7ba8b7d7ea28a25d48837fa877 [file] [log] [blame]
Georg Brandl9afde1c2007-11-01 20:32:30 +00001:mod:`dis` --- Disassembler for Python bytecode
2===============================================
Georg Brandl116aa622007-08-15 14:28:22 +00003
4.. module:: dis
Georg Brandl9afde1c2007-11-01 20:32:30 +00005 :synopsis: Disassembler for Python bytecode.
Georg Brandl116aa622007-08-15 14:28:22 +00006
Raymond Hettinger10480942011-01-10 03:26:08 +00007**Source code:** :source:`Lib/dis.py`
Georg Brandl116aa622007-08-15 14:28:22 +00008
Raymond Hettinger4f707fd2011-01-10 19:54:11 +00009--------------
10
Brett Cannon8315fd12010-07-02 22:03:00 +000011The :mod:`dis` module supports the analysis of CPython :term:`bytecode` by
Benjamin Petersonbdf525b2015-03-02 09:31:40 -050012disassembling it. The CPython bytecode which this module takes as an input is
13defined in the file :file:`Include/opcode.h` and used by the compiler and the
14interpreter.
Georg Brandl116aa622007-08-15 14:28:22 +000015
Georg Brandl19b7a872010-07-03 10:21:50 +000016.. impl-detail::
17
Raymond Hettinger10480942011-01-10 03:26:08 +000018 Bytecode is an implementation detail of the CPython interpreter. No
Georg Brandl19b7a872010-07-03 10:21:50 +000019 guarantees are made that bytecode will not be added, removed, or changed
20 between versions of Python. Use of this module should not be considered to
21 work across Python VMs or Python releases.
22
Brett Cannon8315fd12010-07-02 22:03:00 +000023
Georg Brandl116aa622007-08-15 14:28:22 +000024Example: Given the function :func:`myfunc`::
25
26 def myfunc(alist):
27 return len(alist)
28
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100029the following command can be used to display the disassembly of
30:func:`myfunc`::
Georg Brandl116aa622007-08-15 14:28:22 +000031
32 >>> dis.dis(myfunc)
33 2 0 LOAD_GLOBAL 0 (len)
34 3 LOAD_FAST 0 (alist)
35 6 CALL_FUNCTION 1
36 9 RETURN_VALUE
37
38(The "2" is a line number).
39
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100040Bytecode analysis
41-----------------
Georg Brandl116aa622007-08-15 14:28:22 +000042
R David Murray0bce6e72014-01-07 14:30:17 -050043.. versionadded:: 3.4
44
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100045The bytecode analysis API allows pieces of Python code to be wrapped in a
Benjamin Petersonbdf525b2015-03-02 09:31:40 -050046:class:`Bytecode` object that provides easy access to details of the compiled
47code.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100048
Nick Coghlan50c48b82013-11-23 00:57:00 +100049.. class:: Bytecode(x, *, first_line=None, current_offset=None)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100050
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100051
Benjamin Peterson2f3d4402015-03-02 09:36:48 -050052 Analyse the bytecode corresponding to a function, generator, method, string
53 of source code, or a code object (as returned by :func:`compile`).
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100054
Benjamin Petersonbdf525b2015-03-02 09:31:40 -050055 This is a convenience wrapper around many of the functions listed below, most
56 notably :func:`get_instructions`, as iterating over a :class:`Bytecode`
57 instance yields the bytecode operations as :class:`Instruction` instances.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100058
Benjamin Petersonbdf525b2015-03-02 09:31:40 -050059 If *first_line* is not None, it indicates the line number that should be
60 reported for the first source line in the disassembled code. Otherwise, the
61 source line information (if any) is taken directly from the disassembled code
62 object.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100063
Benjamin Petersonbdf525b2015-03-02 09:31:40 -050064 If *current_offset* is not None, it refers to an instruction offset in the
65 disassembled code. Setting this means :meth:`.dis` will display a "current
66 instruction" marker against the specified opcode.
Nick Coghlan50c48b82013-11-23 00:57:00 +100067
68 .. classmethod:: from_traceback(tb)
69
Benjamin Petersonbdf525b2015-03-02 09:31:40 -050070 Construct a :class:`Bytecode` instance from the given traceback, setting
71 *current_offset* to the instruction responsible for the exception.
Nick Coghlan50c48b82013-11-23 00:57:00 +100072
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100073 .. data:: codeobj
74
75 The compiled code object.
76
Nick Coghlan90b8e7d2013-11-06 22:08:36 +100077 .. data:: first_line
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100078
Nick Coghlan90b8e7d2013-11-06 22:08:36 +100079 The first source line of the code object (if available)
80
81 .. method:: dis()
82
Benjamin Peterson29fec922015-03-02 09:27:43 -050083 Return a formatted view of the bytecode operations (the same as printed by
84 :func:`dis.dis`, but returned as a multi-line string).
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100085
86 .. method:: info()
87
88 Return a formatted multi-line string with detailed information about the
89 code object, like :func:`code_info`.
90
Nick Coghlanb39fd0c2013-05-06 23:59:20 +100091Example::
92
93 >>> bytecode = dis.Bytecode(myfunc)
94 >>> for instr in bytecode:
95 ... print(instr.opname)
96 ...
97 LOAD_GLOBAL
98 LOAD_FAST
99 CALL_FUNCTION
100 RETURN_VALUE
101
102
103Analysis functions
104------------------
105
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500106The :mod:`dis` module also defines the following analysis functions that convert
107the input directly to the desired output. They can be useful if only a single
108operation is being performed, so the intermediate analysis object isn't useful:
Georg Brandl116aa622007-08-15 14:28:22 +0000109
Nick Coghlane8814fb2010-09-10 14:08:04 +0000110.. function:: code_info(x)
Nick Coghlaneae2da12010-08-17 08:03:36 +0000111
Georg Brandl67b21b72010-08-17 15:07:14 +0000112 Return a formatted multi-line string with detailed code object information
Nick Coghlanefd5df92014-07-25 23:02:56 +1000113 for the supplied function, generator, method, source code string or code object.
Nick Coghlaneae2da12010-08-17 08:03:36 +0000114
Georg Brandl67b21b72010-08-17 15:07:14 +0000115 Note that the exact contents of code info strings are highly implementation
116 dependent and they may change arbitrarily across Python VMs or Python
117 releases.
Nick Coghlaneae2da12010-08-17 08:03:36 +0000118
119 .. versionadded:: 3.2
120
Georg Brandl67b21b72010-08-17 15:07:14 +0000121
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000122.. function:: show_code(x, *, file=None)
Nick Coghlane8814fb2010-09-10 14:08:04 +0000123
124 Print detailed code object information for the supplied function, method,
Ezio Melotti6e6c6ac2013-08-23 22:41:39 +0300125 source code string or code object to *file* (or ``sys.stdout`` if *file*
126 is not specified).
Nick Coghlane8814fb2010-09-10 14:08:04 +0000127
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000128 This is a convenient shorthand for ``print(code_info(x), file=file)``,
129 intended for interactive exploration at the interpreter prompt.
Nick Coghlane8814fb2010-09-10 14:08:04 +0000130
131 .. versionadded:: 3.2
132
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000133 .. versionchanged:: 3.4
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200134 Added *file* parameter.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000135
136
137.. function:: dis(x=None, *, file=None)
Georg Brandl116aa622007-08-15 14:28:22 +0000138
Georg Brandl67b21b72010-08-17 15:07:14 +0000139 Disassemble the *x* object. *x* can denote either a module, a class, a
Nick Coghlanefd5df92014-07-25 23:02:56 +1000140 method, a function, a generator, a code object, a string of source code or
141 a byte sequence of raw bytecode. For a module, it disassembles all functions.
142 For a class, it disassembles all methods. For a code object or sequence of
143 raw bytecode, it prints one line per bytecode instruction. Strings are first
144 compiled to code objects with the :func:`compile` built-in function before being
Georg Brandl67b21b72010-08-17 15:07:14 +0000145 disassembled. If no object is provided, this function disassembles the last
146 traceback.
Georg Brandl116aa622007-08-15 14:28:22 +0000147
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200148 The disassembly is written as text to the supplied *file* argument if
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000149 provided and to ``sys.stdout`` otherwise.
Georg Brandl116aa622007-08-15 14:28:22 +0000150
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000151 .. versionchanged:: 3.4
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200152 Added *file* parameter.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000153
154
155.. function:: distb(tb=None, *, file=None)
Georg Brandl116aa622007-08-15 14:28:22 +0000156
Georg Brandl4833e5b2010-07-03 10:41:33 +0000157 Disassemble the top-of-stack function of a traceback, using the last
158 traceback if none was passed. The instruction causing the exception is
159 indicated.
Georg Brandl116aa622007-08-15 14:28:22 +0000160
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200161 The disassembly is written as text to the supplied *file* argument if
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000162 provided and to ``sys.stdout`` otherwise.
Georg Brandl116aa622007-08-15 14:28:22 +0000163
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000164 .. versionchanged:: 3.4
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200165 Added *file* parameter.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000166
167
168.. function:: disassemble(code, lasti=-1, *, file=None)
169 disco(code, lasti=-1, *, file=None)
Georg Brandl116aa622007-08-15 14:28:22 +0000170
Georg Brandl4833e5b2010-07-03 10:41:33 +0000171 Disassemble a code object, indicating the last instruction if *lasti* was
Georg Brandl116aa622007-08-15 14:28:22 +0000172 provided. The output is divided in the following columns:
173
174 #. the line number, for the first instruction of each line
175 #. the current instruction, indicated as ``-->``,
176 #. a labelled instruction, indicated with ``>>``,
177 #. the address of the instruction,
178 #. the operation code name,
179 #. operation parameters, and
180 #. interpretation of the parameters in parentheses.
181
182 The parameter interpretation recognizes local and global variable names,
183 constant values, branch targets, and compare operators.
184
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200185 The disassembly is written as text to the supplied *file* argument if
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000186 provided and to ``sys.stdout`` otherwise.
187
188 .. versionchanged:: 3.4
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200189 Added *file* parameter.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000190
191
Nick Coghlan90b8e7d2013-11-06 22:08:36 +1000192.. function:: get_instructions(x, *, first_line=None)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000193
194 Return an iterator over the instructions in the supplied function, method,
195 source code string or code object.
196
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500197 The iterator generates a series of :class:`Instruction` named tuples giving
198 the details of each operation in the supplied code.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000199
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500200 If *first_line* is not None, it indicates the line number that should be
201 reported for the first source line in the disassembled code. Otherwise, the
202 source line information (if any) is taken directly from the disassembled code
203 object.
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000204
205 .. versionadded:: 3.4
206
Georg Brandl116aa622007-08-15 14:28:22 +0000207
Benjamin Peterson75edad02009-01-01 15:05:06 +0000208.. function:: findlinestarts(code)
209
210 This generator function uses the ``co_firstlineno`` and ``co_lnotab``
211 attributes of the code object *code* to find the offsets which are starts of
212 lines in the source code. They are generated as ``(offset, lineno)`` pairs.
213
214
215.. function:: findlabels(code)
216
217 Detect all offsets in the code object *code* which are jump targets, and
218 return a list of these offsets.
Georg Brandl48310cd2009-01-03 21:18:54 +0000219
Larry Hastings3a907972013-11-23 14:49:22 -0800220
221.. function:: stack_effect(opcode, [oparg])
222
223 Compute the stack effect of *opcode* with argument *oparg*.
224
225 .. versionadded:: 3.4
226
Georg Brandl116aa622007-08-15 14:28:22 +0000227.. _bytecodes:
228
Georg Brandl9afde1c2007-11-01 20:32:30 +0000229Python Bytecode Instructions
230----------------------------
Georg Brandl116aa622007-08-15 14:28:22 +0000231
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000232The :func:`get_instructions` function and :class:`Bytecode` class provide
233details of bytecode instructions as :class:`Instruction` instances:
234
235.. class:: Instruction
236
237 Details for a bytecode operation
238
239 .. data:: opcode
240
241 numeric code for operation, corresponding to the opcode values listed
242 below and the bytecode values in the :ref:`opcode_collections`.
243
244
245 .. data:: opname
246
247 human readable name for operation
248
249
250 .. data:: arg
251
252 numeric argument to operation (if any), otherwise None
253
254
255 .. data:: argval
256
257 resolved arg value (if known), otherwise same as arg
258
259
260 .. data:: argrepr
261
262 human readable description of operation argument
263
264
265 .. data:: offset
266
267 start index of operation within bytecode sequence
268
269
270 .. data:: starts_line
271
272 line started by this opcode (if any), otherwise None
273
274
275 .. data:: is_jump_target
276
Serhiy Storchaka0e90e992013-11-29 12:19:53 +0200277 ``True`` if other code jumps to here, otherwise ``False``
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000278
279 .. versionadded:: 3.4
280
281
Georg Brandl9afde1c2007-11-01 20:32:30 +0000282The Python compiler currently generates the following bytecode instructions.
Georg Brandl116aa622007-08-15 14:28:22 +0000283
284
Georg Brandl4833e5b2010-07-03 10:41:33 +0000285**General instructions**
286
Georg Brandl4833e5b2010-07-03 10:41:33 +0000287.. opcode:: NOP
Georg Brandl116aa622007-08-15 14:28:22 +0000288
289 Do nothing code. Used as a placeholder by the bytecode optimizer.
290
291
Georg Brandl4833e5b2010-07-03 10:41:33 +0000292.. opcode:: POP_TOP
Georg Brandl116aa622007-08-15 14:28:22 +0000293
294 Removes the top-of-stack (TOS) item.
295
296
Georg Brandl4833e5b2010-07-03 10:41:33 +0000297.. opcode:: ROT_TWO
Georg Brandl116aa622007-08-15 14:28:22 +0000298
299 Swaps the two top-most stack items.
300
301
Georg Brandl4833e5b2010-07-03 10:41:33 +0000302.. opcode:: ROT_THREE
Georg Brandl116aa622007-08-15 14:28:22 +0000303
304 Lifts second and third stack item one position up, moves top down to position
305 three.
306
307
Georg Brandl4833e5b2010-07-03 10:41:33 +0000308.. opcode:: DUP_TOP
Georg Brandl116aa622007-08-15 14:28:22 +0000309
310 Duplicates the reference on top of the stack.
311
Georg Brandl4833e5b2010-07-03 10:41:33 +0000312
Antoine Pitrou74a69fa2010-09-04 18:43:52 +0000313.. opcode:: DUP_TOP_TWO
314
315 Duplicates the two references on top of the stack, leaving them in the
316 same order.
317
318
Georg Brandl4833e5b2010-07-03 10:41:33 +0000319**Unary operations**
320
321Unary operations take the top of the stack, apply the operation, and push the
Georg Brandl116aa622007-08-15 14:28:22 +0000322result back on the stack.
323
Georg Brandl4833e5b2010-07-03 10:41:33 +0000324.. opcode:: UNARY_POSITIVE
Georg Brandl116aa622007-08-15 14:28:22 +0000325
326 Implements ``TOS = +TOS``.
327
328
Georg Brandl4833e5b2010-07-03 10:41:33 +0000329.. opcode:: UNARY_NEGATIVE
Georg Brandl116aa622007-08-15 14:28:22 +0000330
331 Implements ``TOS = -TOS``.
332
333
Georg Brandl4833e5b2010-07-03 10:41:33 +0000334.. opcode:: UNARY_NOT
Georg Brandl116aa622007-08-15 14:28:22 +0000335
336 Implements ``TOS = not TOS``.
337
338
Georg Brandl4833e5b2010-07-03 10:41:33 +0000339.. opcode:: UNARY_INVERT
Georg Brandl116aa622007-08-15 14:28:22 +0000340
341 Implements ``TOS = ~TOS``.
342
343
Georg Brandl4833e5b2010-07-03 10:41:33 +0000344.. opcode:: GET_ITER
Georg Brandl116aa622007-08-15 14:28:22 +0000345
346 Implements ``TOS = iter(TOS)``.
347
Georg Brandl4833e5b2010-07-03 10:41:33 +0000348
349**Binary operations**
350
Georg Brandl116aa622007-08-15 14:28:22 +0000351Binary operations remove the top of the stack (TOS) and the second top-most
352stack item (TOS1) from the stack. They perform the operation, and put the
353result back on the stack.
354
Georg Brandl4833e5b2010-07-03 10:41:33 +0000355.. opcode:: BINARY_POWER
Georg Brandl116aa622007-08-15 14:28:22 +0000356
357 Implements ``TOS = TOS1 ** TOS``.
358
359
Georg Brandl4833e5b2010-07-03 10:41:33 +0000360.. opcode:: BINARY_MULTIPLY
Georg Brandl116aa622007-08-15 14:28:22 +0000361
362 Implements ``TOS = TOS1 * TOS``.
363
364
Benjamin Petersond51374e2014-04-09 23:55:56 -0400365.. opcode:: BINARY_MATRIX_MULTIPLY
366
367 Implements ``TOS = TOS1 @ TOS``.
368
Berker Peksagda0870c2015-03-12 20:56:45 +0200369 .. versionadded:: 3.5
370
Benjamin Petersond51374e2014-04-09 23:55:56 -0400371
Georg Brandl4833e5b2010-07-03 10:41:33 +0000372.. opcode:: BINARY_FLOOR_DIVIDE
Georg Brandl116aa622007-08-15 14:28:22 +0000373
374 Implements ``TOS = TOS1 // TOS``.
375
376
Georg Brandl4833e5b2010-07-03 10:41:33 +0000377.. opcode:: BINARY_TRUE_DIVIDE
Georg Brandl116aa622007-08-15 14:28:22 +0000378
Ezio Melotti7de0a6e2010-01-05 08:37:27 +0000379 Implements ``TOS = TOS1 / TOS``.
Georg Brandl116aa622007-08-15 14:28:22 +0000380
381
Georg Brandl4833e5b2010-07-03 10:41:33 +0000382.. opcode:: BINARY_MODULO
Georg Brandl116aa622007-08-15 14:28:22 +0000383
384 Implements ``TOS = TOS1 % TOS``.
385
386
Georg Brandl4833e5b2010-07-03 10:41:33 +0000387.. opcode:: BINARY_ADD
Georg Brandl116aa622007-08-15 14:28:22 +0000388
389 Implements ``TOS = TOS1 + TOS``.
390
391
Georg Brandl4833e5b2010-07-03 10:41:33 +0000392.. opcode:: BINARY_SUBTRACT
Georg Brandl116aa622007-08-15 14:28:22 +0000393
394 Implements ``TOS = TOS1 - TOS``.
395
396
Georg Brandl4833e5b2010-07-03 10:41:33 +0000397.. opcode:: BINARY_SUBSCR
Georg Brandl116aa622007-08-15 14:28:22 +0000398
399 Implements ``TOS = TOS1[TOS]``.
400
401
Georg Brandl4833e5b2010-07-03 10:41:33 +0000402.. opcode:: BINARY_LSHIFT
Georg Brandl116aa622007-08-15 14:28:22 +0000403
404 Implements ``TOS = TOS1 << TOS``.
405
406
Georg Brandl4833e5b2010-07-03 10:41:33 +0000407.. opcode:: BINARY_RSHIFT
Georg Brandl116aa622007-08-15 14:28:22 +0000408
409 Implements ``TOS = TOS1 >> TOS``.
410
411
Georg Brandl4833e5b2010-07-03 10:41:33 +0000412.. opcode:: BINARY_AND
Georg Brandl116aa622007-08-15 14:28:22 +0000413
414 Implements ``TOS = TOS1 & TOS``.
415
416
Georg Brandl4833e5b2010-07-03 10:41:33 +0000417.. opcode:: BINARY_XOR
Georg Brandl116aa622007-08-15 14:28:22 +0000418
419 Implements ``TOS = TOS1 ^ TOS``.
420
421
Georg Brandl4833e5b2010-07-03 10:41:33 +0000422.. opcode:: BINARY_OR
Georg Brandl116aa622007-08-15 14:28:22 +0000423
424 Implements ``TOS = TOS1 | TOS``.
425
Georg Brandl4833e5b2010-07-03 10:41:33 +0000426
427**In-place operations**
428
Georg Brandl116aa622007-08-15 14:28:22 +0000429In-place operations are like binary operations, in that they remove TOS and
430TOS1, and push the result back on the stack, but the operation is done in-place
431when TOS1 supports it, and the resulting TOS may be (but does not have to be)
432the original TOS1.
433
Georg Brandl4833e5b2010-07-03 10:41:33 +0000434.. opcode:: INPLACE_POWER
Georg Brandl116aa622007-08-15 14:28:22 +0000435
436 Implements in-place ``TOS = TOS1 ** TOS``.
437
438
Georg Brandl4833e5b2010-07-03 10:41:33 +0000439.. opcode:: INPLACE_MULTIPLY
Georg Brandl116aa622007-08-15 14:28:22 +0000440
441 Implements in-place ``TOS = TOS1 * TOS``.
442
443
Benjamin Petersond51374e2014-04-09 23:55:56 -0400444.. opcode:: INPLACE_MATRIX_MULTIPLY
445
446 Implements in-place ``TOS = TOS1 @ TOS``.
447
Berker Peksagda0870c2015-03-12 20:56:45 +0200448 .. versionadded:: 3.5
449
Benjamin Petersond51374e2014-04-09 23:55:56 -0400450
Georg Brandl4833e5b2010-07-03 10:41:33 +0000451.. opcode:: INPLACE_FLOOR_DIVIDE
Georg Brandl116aa622007-08-15 14:28:22 +0000452
453 Implements in-place ``TOS = TOS1 // TOS``.
454
455
Georg Brandl4833e5b2010-07-03 10:41:33 +0000456.. opcode:: INPLACE_TRUE_DIVIDE
Georg Brandl116aa622007-08-15 14:28:22 +0000457
Ezio Melotti7de0a6e2010-01-05 08:37:27 +0000458 Implements in-place ``TOS = TOS1 / TOS``.
Georg Brandl116aa622007-08-15 14:28:22 +0000459
460
Georg Brandl4833e5b2010-07-03 10:41:33 +0000461.. opcode:: INPLACE_MODULO
Georg Brandl116aa622007-08-15 14:28:22 +0000462
463 Implements in-place ``TOS = TOS1 % TOS``.
464
465
Georg Brandl4833e5b2010-07-03 10:41:33 +0000466.. opcode:: INPLACE_ADD
Georg Brandl116aa622007-08-15 14:28:22 +0000467
468 Implements in-place ``TOS = TOS1 + TOS``.
469
470
Georg Brandl4833e5b2010-07-03 10:41:33 +0000471.. opcode:: INPLACE_SUBTRACT
Georg Brandl116aa622007-08-15 14:28:22 +0000472
473 Implements in-place ``TOS = TOS1 - TOS``.
474
475
Georg Brandl4833e5b2010-07-03 10:41:33 +0000476.. opcode:: INPLACE_LSHIFT
Georg Brandl116aa622007-08-15 14:28:22 +0000477
478 Implements in-place ``TOS = TOS1 << TOS``.
479
480
Georg Brandl4833e5b2010-07-03 10:41:33 +0000481.. opcode:: INPLACE_RSHIFT
Georg Brandl116aa622007-08-15 14:28:22 +0000482
483 Implements in-place ``TOS = TOS1 >> TOS``.
484
485
Georg Brandl4833e5b2010-07-03 10:41:33 +0000486.. opcode:: INPLACE_AND
Georg Brandl116aa622007-08-15 14:28:22 +0000487
488 Implements in-place ``TOS = TOS1 & TOS``.
489
490
Georg Brandl4833e5b2010-07-03 10:41:33 +0000491.. opcode:: INPLACE_XOR
Georg Brandl116aa622007-08-15 14:28:22 +0000492
493 Implements in-place ``TOS = TOS1 ^ TOS``.
494
495
Georg Brandl4833e5b2010-07-03 10:41:33 +0000496.. opcode:: INPLACE_OR
Georg Brandl116aa622007-08-15 14:28:22 +0000497
498 Implements in-place ``TOS = TOS1 | TOS``.
499
Georg Brandl116aa622007-08-15 14:28:22 +0000500
Georg Brandl4833e5b2010-07-03 10:41:33 +0000501.. opcode:: STORE_SUBSCR
Georg Brandl116aa622007-08-15 14:28:22 +0000502
503 Implements ``TOS1[TOS] = TOS2``.
504
505
Georg Brandl4833e5b2010-07-03 10:41:33 +0000506.. opcode:: DELETE_SUBSCR
Georg Brandl116aa622007-08-15 14:28:22 +0000507
508 Implements ``del TOS1[TOS]``.
509
Georg Brandl116aa622007-08-15 14:28:22 +0000510
Georg Brandl4833e5b2010-07-03 10:41:33 +0000511**Miscellaneous opcodes**
Georg Brandl116aa622007-08-15 14:28:22 +0000512
Georg Brandl4833e5b2010-07-03 10:41:33 +0000513.. opcode:: PRINT_EXPR
Georg Brandl116aa622007-08-15 14:28:22 +0000514
515 Implements the expression statement for the interactive mode. TOS is removed
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500516 from the stack and printed. In non-interactive mode, an expression statement
517 is terminated with :opcode:`POP_TOP`.
Georg Brandl116aa622007-08-15 14:28:22 +0000518
519
Georg Brandl4833e5b2010-07-03 10:41:33 +0000520.. opcode:: BREAK_LOOP
Georg Brandl116aa622007-08-15 14:28:22 +0000521
522 Terminates a loop due to a :keyword:`break` statement.
523
524
525.. opcode:: CONTINUE_LOOP (target)
526
527 Continues a loop due to a :keyword:`continue` statement. *target* is the
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200528 address to jump to (which should be a :opcode:`FOR_ITER` instruction).
Georg Brandl116aa622007-08-15 14:28:22 +0000529
530
Antoine Pitrouf289ae62008-12-18 11:06:25 +0000531.. opcode:: SET_ADD (i)
Georg Brandl116aa622007-08-15 14:28:22 +0000532
Antoine Pitrouf289ae62008-12-18 11:06:25 +0000533 Calls ``set.add(TOS1[-i], TOS)``. Used to implement set comprehensions.
Georg Brandl116aa622007-08-15 14:28:22 +0000534
535
Antoine Pitrouf289ae62008-12-18 11:06:25 +0000536.. opcode:: LIST_APPEND (i)
Georg Brandl116aa622007-08-15 14:28:22 +0000537
Antoine Pitrouf289ae62008-12-18 11:06:25 +0000538 Calls ``list.append(TOS[-i], TOS)``. Used to implement list comprehensions.
539
540
541.. opcode:: MAP_ADD (i)
542
543 Calls ``dict.setitem(TOS1[-i], TOS, TOS1)``. Used to implement dict
544 comprehensions.
545
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200546For all of the :opcode:`SET_ADD`, :opcode:`LIST_APPEND` and :opcode:`MAP_ADD`
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500547instructions, while the added value or key/value pair is popped off, the
548container object remains on the stack so that it is available for further
549iterations of the loop.
Georg Brandl116aa622007-08-15 14:28:22 +0000550
551
Georg Brandl4833e5b2010-07-03 10:41:33 +0000552.. opcode:: RETURN_VALUE
Georg Brandl116aa622007-08-15 14:28:22 +0000553
554 Returns with TOS to the caller of the function.
555
556
Georg Brandl4833e5b2010-07-03 10:41:33 +0000557.. opcode:: YIELD_VALUE
Georg Brandl116aa622007-08-15 14:28:22 +0000558
Berker Peksagab4040e2015-03-02 06:33:30 +0200559 Pops TOS and yields it from a :term:`generator`.
Georg Brandl116aa622007-08-15 14:28:22 +0000560
561
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000562.. opcode:: YIELD_FROM
563
Berker Peksagab4040e2015-03-02 06:33:30 +0200564 Pops TOS and delegates to it as a subiterator from a :term:`generator`.
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000565
566 .. versionadded:: 3.3
567
568
Georg Brandl4833e5b2010-07-03 10:41:33 +0000569.. opcode:: IMPORT_STAR
Georg Brandl116aa622007-08-15 14:28:22 +0000570
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500571 Loads all symbols not starting with ``'_'`` directly from the module TOS to
572 the local namespace. The module is popped after loading all names. This
573 opcode implements ``from module import *``.
Georg Brandl116aa622007-08-15 14:28:22 +0000574
575
Georg Brandl4833e5b2010-07-03 10:41:33 +0000576.. opcode:: POP_BLOCK
Georg Brandl116aa622007-08-15 14:28:22 +0000577
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500578 Removes one block from the block stack. Per frame, there is a stack of
579 blocks, denoting nested loops, try statements, and such.
Georg Brandl116aa622007-08-15 14:28:22 +0000580
581
Georg Brandl4833e5b2010-07-03 10:41:33 +0000582.. opcode:: POP_EXCEPT
Benjamin Petersoneec3d712008-06-11 15:59:43 +0000583
584 Removes one block from the block stack. The popped block must be an exception
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500585 handler block, as implicitly created when entering an except handler. In
586 addition to popping extraneous values from the frame stack, the last three
587 popped values are used to restore the exception state.
Benjamin Petersoneec3d712008-06-11 15:59:43 +0000588
589
Georg Brandl4833e5b2010-07-03 10:41:33 +0000590.. opcode:: END_FINALLY
Georg Brandl116aa622007-08-15 14:28:22 +0000591
592 Terminates a :keyword:`finally` clause. The interpreter recalls whether the
593 exception has to be re-raised, or whether the function returns, and continues
594 with the outer-next block.
595
596
Georg Brandl4833e5b2010-07-03 10:41:33 +0000597.. opcode:: LOAD_BUILD_CLASS
Georg Brandl116aa622007-08-15 14:28:22 +0000598
Georg Brandl5ac22302008-07-20 21:39:03 +0000599 Pushes :func:`builtins.__build_class__` onto the stack. It is later called
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200600 by :opcode:`CALL_FUNCTION` to construct a class.
Georg Brandl116aa622007-08-15 14:28:22 +0000601
Guido van Rossum04110fb2007-08-24 16:32:05 +0000602
Benjamin Peterson876b2f22009-06-28 03:18:59 +0000603.. opcode:: SETUP_WITH (delta)
604
605 This opcode performs several operations before a with block starts. First,
606 it loads :meth:`~object.__exit__` from the context manager and pushes it onto
607 the stack for later use by :opcode:`WITH_CLEANUP`. Then,
608 :meth:`~object.__enter__` is called, and a finally block pointing to *delta*
609 is pushed. Finally, the result of calling the enter method is pushed onto
610 the stack. The next opcode will either ignore it (:opcode:`POP_TOP`), or
611 store it in (a) variable(s) (:opcode:`STORE_FAST`, :opcode:`STORE_NAME`, or
612 :opcode:`UNPACK_SEQUENCE`).
613
614
Georg Brandl4833e5b2010-07-03 10:41:33 +0000615.. opcode:: WITH_CLEANUP
Guido van Rossum04110fb2007-08-24 16:32:05 +0000616
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500617 Cleans up the stack when a :keyword:`with` statement block exits. TOS is the
618 context manager's :meth:`__exit__` bound method. Below TOS are 1--3 values
619 indicating how/why the finally clause was entered:
Guido van Rossum04110fb2007-08-24 16:32:05 +0000620
Benjamin Petersoneec3d712008-06-11 15:59:43 +0000621 * SECOND = ``None``
622 * (SECOND, THIRD) = (``WHY_{RETURN,CONTINUE}``), retval
623 * SECOND = ``WHY_*``; no retval below it
624 * (SECOND, THIRD, FOURTH) = exc_info()
Guido van Rossum04110fb2007-08-24 16:32:05 +0000625
Benjamin Petersoneec3d712008-06-11 15:59:43 +0000626 In the last case, ``TOS(SECOND, THIRD, FOURTH)`` is called, otherwise
627 ``TOS(None, None, None)``. In addition, TOS is removed from the stack.
Guido van Rossum04110fb2007-08-24 16:32:05 +0000628
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500629 If the stack represents an exception, *and* the function call returns a
630 'true' value, this information is "zapped" and replaced with a single
631 ``WHY_SILENCED`` to prevent :opcode:`END_FINALLY` from re-raising the
632 exception. (But non-local gotos will still be resumed.)
Guido van Rossum04110fb2007-08-24 16:32:05 +0000633
Georg Brandl9afde1c2007-11-01 20:32:30 +0000634 .. XXX explain the WHY stuff!
635
Guido van Rossum04110fb2007-08-24 16:32:05 +0000636
Georg Brandl116aa622007-08-15 14:28:22 +0000637All of the following opcodes expect arguments. An argument is two bytes, with
638the more significant byte last.
639
Georg Brandl116aa622007-08-15 14:28:22 +0000640.. opcode:: STORE_NAME (namei)
641
642 Implements ``name = TOS``. *namei* is the index of *name* in the attribute
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500643 :attr:`co_names` of the code object. The compiler tries to use
644 :opcode:`STORE_FAST` or :opcode:`STORE_GLOBAL` if possible.
Georg Brandl116aa622007-08-15 14:28:22 +0000645
646
647.. opcode:: DELETE_NAME (namei)
648
649 Implements ``del name``, where *namei* is the index into :attr:`co_names`
650 attribute of the code object.
651
652
653.. opcode:: UNPACK_SEQUENCE (count)
654
655 Unpacks TOS into *count* individual values, which are put onto the stack
656 right-to-left.
657
Georg Brandl116aa622007-08-15 14:28:22 +0000658
Georg Brandl5ac22302008-07-20 21:39:03 +0000659.. opcode:: UNPACK_EX (counts)
660
661 Implements assignment with a starred target: Unpacks an iterable in TOS into
662 individual values, where the total number of values can be smaller than the
663 number of items in the iterable: one the new values will be a list of all
664 leftover items.
665
666 The low byte of *counts* is the number of values before the list value, the
667 high byte of *counts* the number of values after it. The resulting values
668 are put onto the stack right-to-left.
Georg Brandl48310cd2009-01-03 21:18:54 +0000669
Georg Brandl5ac22302008-07-20 21:39:03 +0000670
Georg Brandl116aa622007-08-15 14:28:22 +0000671.. opcode:: STORE_ATTR (namei)
672
673 Implements ``TOS.name = TOS1``, where *namei* is the index of name in
674 :attr:`co_names`.
675
676
677.. opcode:: DELETE_ATTR (namei)
678
679 Implements ``del TOS.name``, using *namei* as index into :attr:`co_names`.
680
681
682.. opcode:: STORE_GLOBAL (namei)
683
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200684 Works as :opcode:`STORE_NAME`, but stores the name as a global.
Georg Brandl116aa622007-08-15 14:28:22 +0000685
686
687.. opcode:: DELETE_GLOBAL (namei)
688
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200689 Works as :opcode:`DELETE_NAME`, but deletes a global name.
Georg Brandl116aa622007-08-15 14:28:22 +0000690
Georg Brandl116aa622007-08-15 14:28:22 +0000691
692.. opcode:: LOAD_CONST (consti)
693
694 Pushes ``co_consts[consti]`` onto the stack.
695
696
697.. opcode:: LOAD_NAME (namei)
698
699 Pushes the value associated with ``co_names[namei]`` onto the stack.
700
701
702.. opcode:: BUILD_TUPLE (count)
703
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500704 Creates a tuple consuming *count* items from the stack, and pushes the
705 resulting tuple onto the stack.
Georg Brandl116aa622007-08-15 14:28:22 +0000706
707
708.. opcode:: BUILD_LIST (count)
709
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200710 Works as :opcode:`BUILD_TUPLE`, but creates a list.
Georg Brandl116aa622007-08-15 14:28:22 +0000711
712
713.. opcode:: BUILD_SET (count)
714
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200715 Works as :opcode:`BUILD_TUPLE`, but creates a set.
Georg Brandl116aa622007-08-15 14:28:22 +0000716
717
Christian Heimesa62da1d2008-01-12 19:39:10 +0000718.. opcode:: BUILD_MAP (count)
Georg Brandl116aa622007-08-15 14:28:22 +0000719
Christian Heimesa62da1d2008-01-12 19:39:10 +0000720 Pushes a new dictionary object onto the stack. The dictionary is pre-sized
721 to hold *count* entries.
Georg Brandl116aa622007-08-15 14:28:22 +0000722
723
724.. opcode:: LOAD_ATTR (namei)
725
726 Replaces TOS with ``getattr(TOS, co_names[namei])``.
727
728
729.. opcode:: COMPARE_OP (opname)
730
731 Performs a Boolean operation. The operation name can be found in
732 ``cmp_op[opname]``.
733
734
735.. opcode:: IMPORT_NAME (namei)
736
Christian Heimesa342c012008-04-20 21:01:16 +0000737 Imports the module ``co_names[namei]``. TOS and TOS1 are popped and provide
738 the *fromlist* and *level* arguments of :func:`__import__`. The module
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500739 object is pushed onto the stack. The current namespace is not affected: for
740 a proper import statement, a subsequent :opcode:`STORE_FAST` instruction
Christian Heimesa342c012008-04-20 21:01:16 +0000741 modifies the namespace.
Georg Brandl116aa622007-08-15 14:28:22 +0000742
743
744.. opcode:: IMPORT_FROM (namei)
745
746 Loads the attribute ``co_names[namei]`` from the module found in TOS. The
747 resulting object is pushed onto the stack, to be subsequently stored by a
Serhiy Storchakaf751a9e2014-11-11 10:02:11 +0200748 :opcode:`STORE_FAST` instruction.
Georg Brandl116aa622007-08-15 14:28:22 +0000749
750
751.. opcode:: JUMP_FORWARD (delta)
752
Georg Brandl9afde1c2007-11-01 20:32:30 +0000753 Increments bytecode counter by *delta*.
Georg Brandl116aa622007-08-15 14:28:22 +0000754
755
Jeffrey Yasskin9de7ec72009-02-25 02:25:04 +0000756.. opcode:: POP_JUMP_IF_TRUE (target)
Georg Brandl116aa622007-08-15 14:28:22 +0000757
Jeffrey Yasskin9de7ec72009-02-25 02:25:04 +0000758 If TOS is true, sets the bytecode counter to *target*. TOS is popped.
Georg Brandl116aa622007-08-15 14:28:22 +0000759
760
Jeffrey Yasskin9de7ec72009-02-25 02:25:04 +0000761.. opcode:: POP_JUMP_IF_FALSE (target)
Georg Brandl116aa622007-08-15 14:28:22 +0000762
Jeffrey Yasskin9de7ec72009-02-25 02:25:04 +0000763 If TOS is false, sets the bytecode counter to *target*. TOS is popped.
764
765
766.. opcode:: JUMP_IF_TRUE_OR_POP (target)
767
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500768 If TOS is true, sets the bytecode counter to *target* and leaves TOS on the
769 stack. Otherwise (TOS is false), TOS is popped.
Jeffrey Yasskin9de7ec72009-02-25 02:25:04 +0000770
771
772.. opcode:: JUMP_IF_FALSE_OR_POP (target)
773
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500774 If TOS is false, sets the bytecode counter to *target* and leaves TOS on the
775 stack. Otherwise (TOS is true), TOS is popped.
Georg Brandl116aa622007-08-15 14:28:22 +0000776
777
778.. opcode:: JUMP_ABSOLUTE (target)
779
Georg Brandl9afde1c2007-11-01 20:32:30 +0000780 Set bytecode counter to *target*.
Georg Brandl116aa622007-08-15 14:28:22 +0000781
782
783.. opcode:: FOR_ITER (delta)
784
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500785 TOS is an :term:`iterator`. Call its :meth:`~iterator.__next__` method. If
786 this yields a new value, push it on the stack (leaving the iterator below
787 it). If the iterator indicates it is exhausted TOS is popped, and the byte
788 code counter is incremented by *delta*.
Georg Brandl116aa622007-08-15 14:28:22 +0000789
Georg Brandl116aa622007-08-15 14:28:22 +0000790
791.. opcode:: LOAD_GLOBAL (namei)
792
793 Loads the global named ``co_names[namei]`` onto the stack.
794
Georg Brandl116aa622007-08-15 14:28:22 +0000795
796.. opcode:: SETUP_LOOP (delta)
797
798 Pushes a block for a loop onto the block stack. The block spans from the
799 current instruction with a size of *delta* bytes.
800
801
802.. opcode:: SETUP_EXCEPT (delta)
803
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500804 Pushes a try block from a try-except clause onto the block stack. *delta*
805 points to the first except block.
Georg Brandl116aa622007-08-15 14:28:22 +0000806
807
808.. opcode:: SETUP_FINALLY (delta)
809
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500810 Pushes a try block from a try-except clause onto the block stack. *delta*
811 points to the finally block.
Georg Brandl116aa622007-08-15 14:28:22 +0000812
Georg Brandl4833e5b2010-07-03 10:41:33 +0000813.. opcode:: STORE_MAP
Christian Heimesa62da1d2008-01-12 19:39:10 +0000814
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500815 Store a key and value pair in a dictionary. Pops the key and value while
816 leaving the dictionary on the stack.
Georg Brandl116aa622007-08-15 14:28:22 +0000817
818.. opcode:: LOAD_FAST (var_num)
819
820 Pushes a reference to the local ``co_varnames[var_num]`` onto the stack.
821
822
823.. opcode:: STORE_FAST (var_num)
824
825 Stores TOS into the local ``co_varnames[var_num]``.
826
827
828.. opcode:: DELETE_FAST (var_num)
829
830 Deletes local ``co_varnames[var_num]``.
831
832
833.. opcode:: LOAD_CLOSURE (i)
834
835 Pushes a reference to the cell contained in slot *i* of the cell and free
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500836 variable storage. The name of the variable is ``co_cellvars[i]`` if *i* is
837 less than the length of *co_cellvars*. Otherwise it is ``co_freevars[i -
Georg Brandl116aa622007-08-15 14:28:22 +0000838 len(co_cellvars)]``.
839
840
841.. opcode:: LOAD_DEREF (i)
842
843 Loads the cell contained in slot *i* of the cell and free variable storage.
844 Pushes a reference to the object the cell contains on the stack.
845
846
Benjamin Peterson3b0431d2013-04-30 09:41:40 -0400847.. opcode:: LOAD_CLASSDEREF (i)
848
849 Much like :opcode:`LOAD_DEREF` but first checks the locals dictionary before
850 consulting the cell. This is used for loading free variables in class
851 bodies.
852
853
Georg Brandl116aa622007-08-15 14:28:22 +0000854.. opcode:: STORE_DEREF (i)
855
856 Stores TOS into the cell contained in slot *i* of the cell and free variable
857 storage.
858
859
Amaury Forgeot d'Arcba117ef2010-09-10 21:39:53 +0000860.. opcode:: DELETE_DEREF (i)
861
862 Empties the cell contained in slot *i* of the cell and free variable storage.
863 Used by the :keyword:`del` statement.
864
865
Georg Brandl116aa622007-08-15 14:28:22 +0000866.. opcode:: RAISE_VARARGS (argc)
867
868 Raises an exception. *argc* indicates the number of parameters to the raise
869 statement, ranging from 0 to 3. The handler will find the traceback as TOS2,
870 the parameter as TOS1, and the exception as TOS.
871
872
873.. opcode:: CALL_FUNCTION (argc)
874
875 Calls a function. The low byte of *argc* indicates the number of positional
876 parameters, the high byte the number of keyword parameters. On the stack, the
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500877 opcode finds the keyword parameters first. For each keyword argument, the
878 value is on top of the key. Below the keyword parameters, the positional
879 parameters are on the stack, with the right-most parameter on top. Below the
880 parameters, the function object to call is on the stack. Pops all function
881 arguments, and the function itself off the stack, and pushes the return
882 value.
Georg Brandl116aa622007-08-15 14:28:22 +0000883
884
885.. opcode:: MAKE_FUNCTION (argc)
886
Georg Brandlc96ef1f2013-10-12 18:41:18 +0200887 Pushes a new function object on the stack. From bottom to top, the consumed
888 stack must consist of
889
890 * ``argc & 0xFF`` default argument objects in positional order
891 * ``(argc >> 8) & 0xFF`` pairs of name and default argument, with the name
892 just below the object on the stack, for keyword-only parameters
893 * ``(argc >> 16) & 0x7FFF`` parameter annotation objects
894 * a tuple listing the parameter names for the annotations (only if there are
895 ony annotation objects)
896 * the code associated with the function (at TOS1)
897 * the :term:`qualified name` of the function (at TOS)
Georg Brandl116aa622007-08-15 14:28:22 +0000898
899
900.. opcode:: MAKE_CLOSURE (argc)
901
Guido van Rossum04110fb2007-08-24 16:32:05 +0000902 Creates a new function object, sets its *__closure__* slot, and pushes it on
Andrew Svetlova5c43092012-11-23 15:28:34 +0200903 the stack. TOS is the :term:`qualified name` of the function, TOS1 is the
904 code associated with the function, and TOS2 is the tuple containing cells for
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500905 the closure's free variables. The function also has *argc* default
906 parameters, which are found below the cells.
Georg Brandl116aa622007-08-15 14:28:22 +0000907
908
909.. opcode:: BUILD_SLICE (argc)
910
911 .. index:: builtin: slice
912
913 Pushes a slice object on the stack. *argc* must be 2 or 3. If it is 2,
914 ``slice(TOS1, TOS)`` is pushed; if it is 3, ``slice(TOS2, TOS1, TOS)`` is
Christian Heimes5b5e81c2007-12-31 16:14:33 +0000915 pushed. See the :func:`slice` built-in function for more information.
Georg Brandl116aa622007-08-15 14:28:22 +0000916
917
918.. opcode:: EXTENDED_ARG (ext)
919
920 Prefixes any opcode which has an argument too big to fit into the default two
921 bytes. *ext* holds two additional bytes which, taken together with the
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500922 subsequent opcode's argument, comprise a four-byte argument, *ext* being the
923 two most-significant bytes.
Georg Brandl116aa622007-08-15 14:28:22 +0000924
925
926.. opcode:: CALL_FUNCTION_VAR (argc)
927
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500928 Calls a function. *argc* is interpreted as in :opcode:`CALL_FUNCTION`. The
929 top element on the stack contains the variable argument list, followed by
930 keyword and positional arguments.
Georg Brandl116aa622007-08-15 14:28:22 +0000931
932
933.. opcode:: CALL_FUNCTION_KW (argc)
934
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500935 Calls a function. *argc* is interpreted as in :opcode:`CALL_FUNCTION`. The
936 top element on the stack contains the keyword arguments dictionary, followed
937 by explicit keyword and positional arguments.
Georg Brandl116aa622007-08-15 14:28:22 +0000938
939
940.. opcode:: CALL_FUNCTION_VAR_KW (argc)
941
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500942 Calls a function. *argc* is interpreted as in :opcode:`CALL_FUNCTION`. The
943 top element on the stack contains the keyword arguments dictionary, followed
944 by the variable-arguments tuple, followed by explicit keyword and positional
945 arguments.
Georg Brandl116aa622007-08-15 14:28:22 +0000946
947
Georg Brandl4833e5b2010-07-03 10:41:33 +0000948.. opcode:: HAVE_ARGUMENT
Georg Brandl116aa622007-08-15 14:28:22 +0000949
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500950 This is not really an opcode. It identifies the dividing line between
951 opcodes which don't take arguments ``< HAVE_ARGUMENT`` and those which do
952 ``>= HAVE_ARGUMENT``.
Georg Brandl116aa622007-08-15 14:28:22 +0000953
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000954.. _opcode_collections:
955
956Opcode collections
957------------------
958
959These collections are provided for automatic introspection of bytecode
960instructions:
961
962.. data:: opname
963
964 Sequence of operation names, indexable using the bytecode.
965
966
967.. data:: opmap
968
969 Dictionary mapping operation names to bytecodes.
970
971
972.. data:: cmp_op
973
974 Sequence of all compare operation names.
975
976
977.. data:: hasconst
978
979 Sequence of bytecodes that have a constant parameter.
980
981
982.. data:: hasfree
983
Benjamin Petersonbdf525b2015-03-02 09:31:40 -0500984 Sequence of bytecodes that access a free variable (note that 'free' in this
985 context refers to names in the current scope that are referenced by inner
986 scopes or names in outer scopes that are referenced from this scope. It does
987 *not* include references to global or builtin scopes).
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000988
989
990.. data:: hasname
991
992 Sequence of bytecodes that access an attribute by name.
993
994
995.. data:: hasjrel
996
997 Sequence of bytecodes that have a relative jump target.
998
999
1000.. data:: hasjabs
1001
1002 Sequence of bytecodes that have an absolute jump target.
1003
1004
1005.. data:: haslocal
1006
1007 Sequence of bytecodes that access a local variable.
1008
1009
1010.. data:: hascompare
1011
1012 Sequence of bytecodes of Boolean operations.