blob: e61ca36548e9af3960eaddb2078239d8933f53c9 [file] [log] [blame]
Fred Drake295da241998-08-10 19:42:37 +00001\section{\module{dis} ---
Fred Drakef8ca7d82000-10-10 17:03:45 +00002 Disassembler for Python byte code}
Fred Drakeb91e9341998-07-23 17:59:49 +00003
Fred Drakef8ca7d82000-10-10 17:03:45 +00004\declaremodule{standard}{dis}
Fred Drake2c4f5542000-10-10 22:00:03 +00005\modulesynopsis{Disassembler for Python byte code.}
Fred Drakeb91e9341998-07-23 17:59:49 +00006
Guido van Rossumb62b6d11997-11-18 15:10:53 +00007
Fred Drakedff21a61998-04-03 05:42:10 +00008The \module{dis} module supports the analysis of Python byte code by
Guido van Rossumb62b6d11997-11-18 15:10:53 +00009disassembling it. Since there is no Python assembler, this module
10defines the Python assembly language. The Python byte code which
11this module takes as an input is defined in the file
Fred Drake456035f1997-12-03 04:06:57 +000012\file{Include/opcode.h} and used by the compiler and the interpreter.
Guido van Rossumb62b6d11997-11-18 15:10:53 +000013
Fred Drakedff21a61998-04-03 05:42:10 +000014Example: Given the function \function{myfunc}:
Guido van Rossumb62b6d11997-11-18 15:10:53 +000015
Fred Drake19479911998-02-13 06:58:54 +000016\begin{verbatim}
Guido van Rossumb62b6d11997-11-18 15:10:53 +000017def myfunc(alist):
Fred Drakedff21a61998-04-03 05:42:10 +000018 return len(alist)
Fred Drake19479911998-02-13 06:58:54 +000019\end{verbatim}
Guido van Rossumb62b6d11997-11-18 15:10:53 +000020
Fred Drakedff21a61998-04-03 05:42:10 +000021the following command can be used to get the disassembly of
22\function{myfunc()}:
Guido van Rossumb62b6d11997-11-18 15:10:53 +000023
24\begin{verbatim}
25>>> dis.dis(myfunc)
Michael W. Hudsondd32a912002-08-15 14:59:02 +000026 2 0 LOAD_GLOBAL 0 (len)
27 3 LOAD_FAST 0 (alist)
28 6 CALL_FUNCTION 1
Raymond Hettingerbc2c21e2005-02-23 20:40:42 +000029 9 RETURN_VALUE
Guido van Rossumb62b6d11997-11-18 15:10:53 +000030\end{verbatim}
31
Michael W. Hudsondd32a912002-08-15 14:59:02 +000032(The ``2'' is a line number).
33
Fred Drake2c4f5542000-10-10 22:00:03 +000034The \module{dis} module defines the following functions and constants:
Guido van Rossumb62b6d11997-11-18 15:10:53 +000035
Guido van Rossumb62b6d11997-11-18 15:10:53 +000036\begin{funcdesc}{dis}{\optional{bytesource}}
37Disassemble the \var{bytesource} object. \var{bytesource} can denote
Neal Norwitzdcd05002002-06-26 22:32:47 +000038either a module, a class, a method, a function, or a code object.
39For a module, it disassembles all functions. For a class,
Guido van Rossumb62b6d11997-11-18 15:10:53 +000040it disassembles all methods. For a single code sequence, it prints
41one line per byte code instruction. If no object is provided, it
42disassembles the last traceback.
43\end{funcdesc}
44
45\begin{funcdesc}{distb}{\optional{tb}}
46Disassembles the top-of-stack function of a traceback, using the last
47traceback if none was passed. The instruction causing the exception
48is indicated.
49\end{funcdesc}
50
Fred Drakecce10901998-03-17 06:33:25 +000051\begin{funcdesc}{disassemble}{code\optional{, lasti}}
Guido van Rossumb62b6d11997-11-18 15:10:53 +000052Disassembles a code object, indicating the last instruction if \var{lasti}
53was provided. The output is divided in the following columns:
Fred Drake810349b1998-04-07 14:16:41 +000054
Fred Drake3e7a48e1998-04-13 16:15:02 +000055\begin{enumerate}
Michael W. Hudsondd32a912002-08-15 14:59:02 +000056\item the line number, for the first instruction of each line
Fred Drakedff21a61998-04-03 05:42:10 +000057\item the current instruction, indicated as \samp{-->},
Thomas Wouters477c8d52006-05-27 19:21:47 +000058\item a labelled instruction, indicated with \samp{>>},
Guido van Rossumb62b6d11997-11-18 15:10:53 +000059\item the address of the instruction,
60\item the operation code name,
61\item operation parameters, and
62\item interpretation of the parameters in parentheses.
Fred Drake3e7a48e1998-04-13 16:15:02 +000063\end{enumerate}
Fred Drake810349b1998-04-07 14:16:41 +000064
Guido van Rossumb62b6d11997-11-18 15:10:53 +000065The parameter interpretation recognizes local and global
66variable names, constant values, branch targets, and compare
67operators.
68\end{funcdesc}
69
Fred Drakecce10901998-03-17 06:33:25 +000070\begin{funcdesc}{disco}{code\optional{, lasti}}
Guido van Rossumb62b6d11997-11-18 15:10:53 +000071A synonym for disassemble. It is more convenient to type, and kept
72for compatibility with earlier Python releases.
73\end{funcdesc}
74
75\begin{datadesc}{opname}
Fred Drake2c4f5542000-10-10 22:00:03 +000076Sequence of operation names, indexable using the byte code.
Guido van Rossumb62b6d11997-11-18 15:10:53 +000077\end{datadesc}
78
Skip Montanarobecbdec2005-01-05 07:19:11 +000079\begin{datadesc}{opmap}
80Dictionary mapping byte codes to operation names.
81\end{datadesc}
82
Guido van Rossumb62b6d11997-11-18 15:10:53 +000083\begin{datadesc}{cmp_op}
84Sequence of all compare operation names.
85\end{datadesc}
86
87\begin{datadesc}{hasconst}
88Sequence of byte codes that have a constant parameter.
89\end{datadesc}
90
Fred Drake47cdf6f2002-03-28 19:34:53 +000091\begin{datadesc}{hasfree}
92Sequence of byte codes that access a free variable.
93\end{datadesc}
94
Guido van Rossumb62b6d11997-11-18 15:10:53 +000095\begin{datadesc}{hasname}
Fred Drake2c4f5542000-10-10 22:00:03 +000096Sequence of byte codes that access an attribute by name.
Guido van Rossumb62b6d11997-11-18 15:10:53 +000097\end{datadesc}
98
99\begin{datadesc}{hasjrel}
100Sequence of byte codes that have a relative jump target.
101\end{datadesc}
102
103\begin{datadesc}{hasjabs}
104Sequence of byte codes that have an absolute jump target.
105\end{datadesc}
106
107\begin{datadesc}{haslocal}
Fred Drake2c4f5542000-10-10 22:00:03 +0000108Sequence of byte codes that access a local variable.
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000109\end{datadesc}
110
111\begin{datadesc}{hascompare}
Fred Drake6c81e2a2001-10-01 17:04:10 +0000112Sequence of byte codes of Boolean operations.
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000113\end{datadesc}
114
115\subsection{Python Byte Code Instructions}
Fred Drake83efb541998-02-19 20:07:39 +0000116\label{bytecodes}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000117
118The Python compiler currently generates the following byte code
119instructions.
120
Fred Drake19479911998-02-13 06:58:54 +0000121\setindexsubitem{(byte code insns)}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000122
Fred Drake456035f1997-12-03 04:06:57 +0000123\begin{opcodedesc}{STOP_CODE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000124Indicates end-of-code to the compiler, not used by the interpreter.
Fred Drake456035f1997-12-03 04:06:57 +0000125\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000126
Raymond Hettinger2b0d0582005-02-21 20:28:07 +0000127\begin{opcodedesc}{NOP}{}
128Do nothing code. Used as a placeholder by the bytecode optimizer.
129\end{opcodedesc}
130
Fred Drake456035f1997-12-03 04:06:57 +0000131\begin{opcodedesc}{POP_TOP}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000132Removes the top-of-stack (TOS) item.
Fred Drake456035f1997-12-03 04:06:57 +0000133\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000134
Fred Drake456035f1997-12-03 04:06:57 +0000135\begin{opcodedesc}{ROT_TWO}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000136Swaps the two top-most stack items.
Fred Drake456035f1997-12-03 04:06:57 +0000137\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000138
Fred Drake456035f1997-12-03 04:06:57 +0000139\begin{opcodedesc}{ROT_THREE}{}
140Lifts second and third stack item one position up, moves top down
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000141to position three.
Fred Drake456035f1997-12-03 04:06:57 +0000142\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000143
Thomas Wouters12bba852000-08-24 20:06:04 +0000144\begin{opcodedesc}{ROT_FOUR}{}
145Lifts second, third and forth stack item one position up, moves top down to
146position four.
147\end{opcodedesc}
148
Fred Drake456035f1997-12-03 04:06:57 +0000149\begin{opcodedesc}{DUP_TOP}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000150Duplicates the reference on top of the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000151\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000152
153Unary Operations take the top of the stack, apply the operation, and
154push the result back on the stack.
155
Fred Drake456035f1997-12-03 04:06:57 +0000156\begin{opcodedesc}{UNARY_POSITIVE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000157Implements \code{TOS = +TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000158\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000159
Fred Drake4c3f7972000-08-31 16:26:35 +0000160\begin{opcodedesc}{UNARY_NEGATIVE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000161Implements \code{TOS = -TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000162\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000163
Fred Drake456035f1997-12-03 04:06:57 +0000164\begin{opcodedesc}{UNARY_NOT}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000165Implements \code{TOS = not TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000166\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000167
Fred Drake456035f1997-12-03 04:06:57 +0000168\begin{opcodedesc}{UNARY_INVERT}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000169Implements \code{TOS = \~{}TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000170\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000171
Guido van Rossume3fdc972002-06-12 15:33:08 +0000172\begin{opcodedesc}{GET_ITER}{}
173Implements \code{TOS = iter(TOS)}.
174\end{opcodedesc}
175
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000176Binary operations remove the top of the stack (TOS) and the second top-most
177stack item (TOS1) from the stack. They perform the operation, and put the
178result back on the stack.
179
Fred Drake456035f1997-12-03 04:06:57 +0000180\begin{opcodedesc}{BINARY_POWER}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000181Implements \code{TOS = TOS1 ** TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000182\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000183
Fred Drake456035f1997-12-03 04:06:57 +0000184\begin{opcodedesc}{BINARY_MULTIPLY}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000185Implements \code{TOS = TOS1 * TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000186\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000187
Guido van Rossume3fdc972002-06-12 15:33:08 +0000188\begin{opcodedesc}{BINARY_FLOOR_DIVIDE}{}
189Implements \code{TOS = TOS1 // TOS}.
190\end{opcodedesc}
191
192\begin{opcodedesc}{BINARY_TRUE_DIVIDE}{}
193Implements \code{TOS = TOS1 / TOS} when
194\code{from __future__ import division} is in effect.
Fred Drake456035f1997-12-03 04:06:57 +0000195\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000196
Fred Drake456035f1997-12-03 04:06:57 +0000197\begin{opcodedesc}{BINARY_MODULO}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000198Implements \code{TOS = TOS1 \%{} TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000199\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000200
Fred Drake456035f1997-12-03 04:06:57 +0000201\begin{opcodedesc}{BINARY_ADD}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000202Implements \code{TOS = TOS1 + TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000203\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000204
Fred Drake456035f1997-12-03 04:06:57 +0000205\begin{opcodedesc}{BINARY_SUBTRACT}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000206Implements \code{TOS = TOS1 - TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000207\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000208
Fred Drake456035f1997-12-03 04:06:57 +0000209\begin{opcodedesc}{BINARY_SUBSCR}{}
Fred Drake1cf87491997-12-04 04:57:56 +0000210Implements \code{TOS = TOS1[TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000211\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000212
Fred Drake456035f1997-12-03 04:06:57 +0000213\begin{opcodedesc}{BINARY_LSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000214Implements \code{TOS = TOS1 <\code{}< TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000215\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000216
Fred Drake456035f1997-12-03 04:06:57 +0000217\begin{opcodedesc}{BINARY_RSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000218Implements \code{TOS = TOS1 >\code{}> TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000219\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000220
Fred Drake456035f1997-12-03 04:06:57 +0000221\begin{opcodedesc}{BINARY_AND}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000222Implements \code{TOS = TOS1 \&\ TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000223\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000224
Fred Drake456035f1997-12-03 04:06:57 +0000225\begin{opcodedesc}{BINARY_XOR}{}
Fred Draked7feffd1997-12-29 20:02:55 +0000226Implements \code{TOS = TOS1 \^\ TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000227\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000228
Fred Drake456035f1997-12-03 04:06:57 +0000229\begin{opcodedesc}{BINARY_OR}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000230Implements \code{TOS = TOS1 | TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000231\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000232
Thomas Wouters12bba852000-08-24 20:06:04 +0000233In-place operations are like binary operations, in that they remove TOS and
234TOS1, and push the result back on the stack, but the operation is done
235in-place when TOS1 supports it, and the resulting TOS may be (but does not
236have to be) the original TOS1.
237
238\begin{opcodedesc}{INPLACE_POWER}{}
239Implements in-place \code{TOS = TOS1 ** TOS}.
240\end{opcodedesc}
241
242\begin{opcodedesc}{INPLACE_MULTIPLY}{}
243Implements in-place \code{TOS = TOS1 * TOS}.
244\end{opcodedesc}
245
Guido van Rossume3fdc972002-06-12 15:33:08 +0000246\begin{opcodedesc}{INPLACE_FLOOR_DIVIDE}{}
247Implements in-place \code{TOS = TOS1 // TOS}.
248\end{opcodedesc}
249
250\begin{opcodedesc}{INPLACE_TRUE_DIVIDE}{}
251Implements in-place \code{TOS = TOS1 / TOS} when
252\code{from __future__ import division} is in effect.
Thomas Wouters12bba852000-08-24 20:06:04 +0000253\end{opcodedesc}
254
255\begin{opcodedesc}{INPLACE_MODULO}{}
256Implements in-place \code{TOS = TOS1 \%{} TOS}.
257\end{opcodedesc}
258
259\begin{opcodedesc}{INPLACE_ADD}{}
260Implements in-place \code{TOS = TOS1 + TOS}.
261\end{opcodedesc}
262
263\begin{opcodedesc}{INPLACE_SUBTRACT}{}
264Implements in-place \code{TOS = TOS1 - TOS}.
265\end{opcodedesc}
266
267\begin{opcodedesc}{INPLACE_LSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000268Implements in-place \code{TOS = TOS1 <\code{}< TOS}.
Thomas Wouters12bba852000-08-24 20:06:04 +0000269\end{opcodedesc}
270
271\begin{opcodedesc}{INPLACE_RSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000272Implements in-place \code{TOS = TOS1 >\code{}> TOS}.
Thomas Wouters12bba852000-08-24 20:06:04 +0000273\end{opcodedesc}
274
275\begin{opcodedesc}{INPLACE_AND}{}
276Implements in-place \code{TOS = TOS1 \&\ TOS}.
277\end{opcodedesc}
278
279\begin{opcodedesc}{INPLACE_XOR}{}
280Implements in-place \code{TOS = TOS1 \^\ TOS}.
281\end{opcodedesc}
282
283\begin{opcodedesc}{INPLACE_OR}{}
284Implements in-place \code{TOS = TOS1 | TOS}.
285\end{opcodedesc}
286
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000287The slice opcodes take up to three parameters.
288
Fred Drake456035f1997-12-03 04:06:57 +0000289\begin{opcodedesc}{SLICE+0}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000290Implements \code{TOS = TOS[:]}.
Fred Drake456035f1997-12-03 04:06:57 +0000291\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000292
Fred Drake456035f1997-12-03 04:06:57 +0000293\begin{opcodedesc}{SLICE+1}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000294Implements \code{TOS = TOS1[TOS:]}.
Fred Drake456035f1997-12-03 04:06:57 +0000295\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000296
Fred Drake456035f1997-12-03 04:06:57 +0000297\begin{opcodedesc}{SLICE+2}{}
Neal Norwitze72a9a12002-08-05 23:33:54 +0000298Implements \code{TOS = TOS1[:TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000299\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000300
Fred Drake456035f1997-12-03 04:06:57 +0000301\begin{opcodedesc}{SLICE+3}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000302Implements \code{TOS = TOS2[TOS1:TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000303\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000304
305Slice assignment needs even an additional parameter. As any statement,
306they put nothing on the stack.
307
Fred Drake456035f1997-12-03 04:06:57 +0000308\begin{opcodedesc}{STORE_SLICE+0}{}
Fred Drake7381e281997-12-04 04:51:12 +0000309Implements \code{TOS[:] = TOS1}.
Fred Drake456035f1997-12-03 04:06:57 +0000310\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000311
Fred Drake456035f1997-12-03 04:06:57 +0000312\begin{opcodedesc}{STORE_SLICE+1}{}
Fred Drake7381e281997-12-04 04:51:12 +0000313Implements \code{TOS1[TOS:] = TOS2}.
Fred Drake456035f1997-12-03 04:06:57 +0000314\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000315
Fred Drake456035f1997-12-03 04:06:57 +0000316\begin{opcodedesc}{STORE_SLICE+2}{}
Fred Drake7381e281997-12-04 04:51:12 +0000317Implements \code{TOS1[:TOS] = TOS2}.
Fred Drake456035f1997-12-03 04:06:57 +0000318\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000319
Fred Drake456035f1997-12-03 04:06:57 +0000320\begin{opcodedesc}{STORE_SLICE+3}{}
Fred Drake7381e281997-12-04 04:51:12 +0000321Implements \code{TOS2[TOS1:TOS] = TOS3}.
Fred Drake456035f1997-12-03 04:06:57 +0000322\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000323
Fred Drake456035f1997-12-03 04:06:57 +0000324\begin{opcodedesc}{DELETE_SLICE+0}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000325Implements \code{del TOS[:]}.
Fred Drake456035f1997-12-03 04:06:57 +0000326\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000327
Fred Drake456035f1997-12-03 04:06:57 +0000328\begin{opcodedesc}{DELETE_SLICE+1}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000329Implements \code{del TOS1[TOS:]}.
Fred Drake456035f1997-12-03 04:06:57 +0000330\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000331
Fred Drake456035f1997-12-03 04:06:57 +0000332\begin{opcodedesc}{DELETE_SLICE+2}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000333Implements \code{del TOS1[:TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000334\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000335
Fred Drake456035f1997-12-03 04:06:57 +0000336\begin{opcodedesc}{DELETE_SLICE+3}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000337Implements \code{del TOS2[TOS1:TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000338\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000339
Fred Drake456035f1997-12-03 04:06:57 +0000340\begin{opcodedesc}{STORE_SUBSCR}{}
Fred Drake7381e281997-12-04 04:51:12 +0000341Implements \code{TOS1[TOS] = TOS2}.
Fred Drake456035f1997-12-03 04:06:57 +0000342\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000343
Fred Drake456035f1997-12-03 04:06:57 +0000344\begin{opcodedesc}{DELETE_SUBSCR}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000345Implements \code{del TOS1[TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000346\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000347
Guido van Rossume3fdc972002-06-12 15:33:08 +0000348Miscellaneous opcodes.
349
Fred Drake456035f1997-12-03 04:06:57 +0000350\begin{opcodedesc}{PRINT_EXPR}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000351Implements the expression statement for the interactive mode. TOS is
352removed from the stack and printed. In non-interactive mode, an
Fred Drake456035f1997-12-03 04:06:57 +0000353expression statement is terminated with \code{POP_STACK}.
354\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000355
Fred Drake456035f1997-12-03 04:06:57 +0000356\begin{opcodedesc}{PRINT_ITEM}{}
Barry Warsaw90876882000-08-21 17:19:00 +0000357Prints TOS to the file-like object bound to \code{sys.stdout}. There
358is one such instruction for each item in the \keyword{print} statement.
359\end{opcodedesc}
360
361\begin{opcodedesc}{PRINT_ITEM_TO}{}
362Like \code{PRINT_ITEM}, but prints the item second from TOS to the
363file-like object at TOS. This is used by the extended print statement.
Fred Drake456035f1997-12-03 04:06:57 +0000364\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000365
Fred Drake456035f1997-12-03 04:06:57 +0000366\begin{opcodedesc}{PRINT_NEWLINE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000367Prints a new line on \code{sys.stdout}. This is generated as the
Fred Drake304faf92000-08-18 02:15:55 +0000368last operation of a \keyword{print} statement, unless the statement
369ends with a comma.
Fred Drake456035f1997-12-03 04:06:57 +0000370\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000371
Barry Warsaw90876882000-08-21 17:19:00 +0000372\begin{opcodedesc}{PRINT_NEWLINE_TO}{}
373Like \code{PRINT_NEWLINE}, but prints the new line on the file-like
374object on the TOS. This is used by the extended print statement.
375\end{opcodedesc}
376
Fred Drake456035f1997-12-03 04:06:57 +0000377\begin{opcodedesc}{BREAK_LOOP}{}
Fred Drake304faf92000-08-18 02:15:55 +0000378Terminates a loop due to a \keyword{break} statement.
Fred Drake456035f1997-12-03 04:06:57 +0000379\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000380
Guido van Rossume3fdc972002-06-12 15:33:08 +0000381\begin{opcodedesc}{CONTINUE_LOOP}{target}
382Continues a loop due to a \keyword{continue} statement. \var{target}
383is the address to jump to (which should be a \code{FOR_ITER}
384instruction).
385\end{opcodedesc}
386
Raymond Hettinger2b0d0582005-02-21 20:28:07 +0000387\begin{opcodedesc}{LIST_APPEND}{}
388Calls \code{list.append(TOS1, TOS)}. Used to implement list comprehensions.
389\end{opcodedesc}
390
Fred Drake456035f1997-12-03 04:06:57 +0000391\begin{opcodedesc}{LOAD_LOCALS}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000392Pushes a reference to the locals of the current scope on the stack.
393This is used in the code for a class definition: After the class body
394is evaluated, the locals are passed to the class definition.
Fred Drake456035f1997-12-03 04:06:57 +0000395\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000396
Fred Drake456035f1997-12-03 04:06:57 +0000397\begin{opcodedesc}{RETURN_VALUE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000398Returns with TOS to the caller of the function.
Fred Drake456035f1997-12-03 04:06:57 +0000399\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000400
Guido van Rossume3fdc972002-06-12 15:33:08 +0000401\begin{opcodedesc}{YIELD_VALUE}{}
402Pops \code{TOS} and yields it from a generator.
403\end{opcodedesc}
404
Thomas Wouters52152252000-08-17 22:55:00 +0000405\begin{opcodedesc}{IMPORT_STAR}{}
Fred Drake304faf92000-08-18 02:15:55 +0000406Loads all symbols not starting with \character{_} directly from the module TOS
Thomas Wouters52152252000-08-17 22:55:00 +0000407to the local namespace. The module is popped after loading all names.
Fred Drake304faf92000-08-18 02:15:55 +0000408This opcode implements \code{from module import *}.
409\end{opcodedesc}
Thomas Wouters52152252000-08-17 22:55:00 +0000410
Fred Drake456035f1997-12-03 04:06:57 +0000411\begin{opcodedesc}{POP_BLOCK}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000412Removes one block from the block stack. Per frame, there is a
413stack of blocks, denoting nested loops, try statements, and such.
Fred Drake456035f1997-12-03 04:06:57 +0000414\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000415
Fred Drake456035f1997-12-03 04:06:57 +0000416\begin{opcodedesc}{END_FINALLY}{}
Fred Drake304faf92000-08-18 02:15:55 +0000417Terminates a \keyword{finally} clause. The interpreter recalls
418whether the exception has to be re-raised, or whether the function
419returns, and continues with the outer-next block.
Fred Drake456035f1997-12-03 04:06:57 +0000420\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000421
Fred Drake456035f1997-12-03 04:06:57 +0000422\begin{opcodedesc}{BUILD_CLASS}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000423Creates a new class object. TOS is the methods dictionary, TOS1
424the tuple of the names of the base classes, and TOS2 the class name.
Fred Drake456035f1997-12-03 04:06:57 +0000425\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000426
427All of the following opcodes expect arguments. An argument is two
428bytes, with the more significant byte last.
429
Fred Drake456035f1997-12-03 04:06:57 +0000430\begin{opcodedesc}{STORE_NAME}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000431Implements \code{name = TOS}. \var{namei} is the index of \var{name}
Fred Drakedff21a61998-04-03 05:42:10 +0000432in the attribute \member{co_names} of the code object.
Fred Drake456035f1997-12-03 04:06:57 +0000433The compiler tries to use \code{STORE_LOCAL} or \code{STORE_GLOBAL}
434if possible.
435\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000436
Fred Drake456035f1997-12-03 04:06:57 +0000437\begin{opcodedesc}{DELETE_NAME}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000438Implements \code{del name}, where \var{namei} is the index into
Fred Drakedff21a61998-04-03 05:42:10 +0000439\member{co_names} attribute of the code object.
Fred Drake456035f1997-12-03 04:06:57 +0000440\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000441
Thomas Wouters0be5aab2000-08-11 22:15:52 +0000442\begin{opcodedesc}{UNPACK_SEQUENCE}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000443Unpacks TOS into \var{count} individual values, which are put onto
444the stack right-to-left.
Fred Drake456035f1997-12-03 04:06:57 +0000445\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000446
Thomas Wouters0be5aab2000-08-11 22:15:52 +0000447%\begin{opcodedesc}{UNPACK_LIST}{count}
448%This opcode is obsolete.
449%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000450
Fred Drake456035f1997-12-03 04:06:57 +0000451%\begin{opcodedesc}{UNPACK_ARG}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000452%This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000453%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000454
Thomas Wouters12bba852000-08-24 20:06:04 +0000455\begin{opcodedesc}{DUP_TOPX}{count}
456Duplicate \var{count} items, keeping them in the same order. Due to
457implementation limits, \var{count} should be between 1 and 5 inclusive.
458\end{opcodedesc}
459
Fred Drake456035f1997-12-03 04:06:57 +0000460\begin{opcodedesc}{STORE_ATTR}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000461Implements \code{TOS.name = TOS1}, where \var{namei} is the index
Fred Drakedff21a61998-04-03 05:42:10 +0000462of name in \member{co_names}.
Fred Drake456035f1997-12-03 04:06:57 +0000463\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000464
Fred Drake456035f1997-12-03 04:06:57 +0000465\begin{opcodedesc}{DELETE_ATTR}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000466Implements \code{del TOS.name}, using \var{namei} as index into
Fred Drakedff21a61998-04-03 05:42:10 +0000467\member{co_names}.
Fred Drake456035f1997-12-03 04:06:57 +0000468\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000469
Fred Drake456035f1997-12-03 04:06:57 +0000470\begin{opcodedesc}{STORE_GLOBAL}{namei}
471Works as \code{STORE_NAME}, but stores the name as a global.
472\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000473
Fred Drake456035f1997-12-03 04:06:57 +0000474\begin{opcodedesc}{DELETE_GLOBAL}{namei}
475Works as \code{DELETE_NAME}, but deletes a global name.
476\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000477
Fred Drake456035f1997-12-03 04:06:57 +0000478%\begin{opcodedesc}{UNPACK_VARARG}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000479%This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000480%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000481
Fred Drake456035f1997-12-03 04:06:57 +0000482\begin{opcodedesc}{LOAD_CONST}{consti}
Fred Drakedff21a61998-04-03 05:42:10 +0000483Pushes \samp{co_consts[\var{consti}]} onto the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000484\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000485
Fred Drake456035f1997-12-03 04:06:57 +0000486\begin{opcodedesc}{LOAD_NAME}{namei}
Fred Drakedff21a61998-04-03 05:42:10 +0000487Pushes the value associated with \samp{co_names[\var{namei}]} onto the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000488\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000489
Fred Drake456035f1997-12-03 04:06:57 +0000490\begin{opcodedesc}{BUILD_TUPLE}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000491Creates a tuple consuming \var{count} items from the stack, and pushes
492the resulting tuple onto the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000493\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000494
Fred Drake456035f1997-12-03 04:06:57 +0000495\begin{opcodedesc}{BUILD_LIST}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000496Works as \code{BUILD_TUPLE}, but creates a list.
Fred Drake456035f1997-12-03 04:06:57 +0000497\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000498
Guido van Rossum86e58e22006-08-28 15:27:34 +0000499\begin{opcodedesc}{BUILD_SET}{count}
500Works as \code{BUILD_TUPLE}, but creates a set.
501\end{opcodedesc}
502
Fred Drake456035f1997-12-03 04:06:57 +0000503\begin{opcodedesc}{BUILD_MAP}{zero}
Fred Drake304faf92000-08-18 02:15:55 +0000504Pushes a new empty dictionary object onto the stack. The argument is
505ignored and set to zero by the compiler.
Fred Drake456035f1997-12-03 04:06:57 +0000506\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000507
Fred Drake456035f1997-12-03 04:06:57 +0000508\begin{opcodedesc}{LOAD_ATTR}{namei}
Raymond Hettingerb4c1d9b2003-05-10 08:51:28 +0000509Replaces TOS with \code{getattr(TOS, co_names[\var{namei}])}.
Fred Drake456035f1997-12-03 04:06:57 +0000510\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000511
Fred Drake456035f1997-12-03 04:06:57 +0000512\begin{opcodedesc}{COMPARE_OP}{opname}
Fred Drake6c81e2a2001-10-01 17:04:10 +0000513Performs a Boolean operation. The operation name can be found
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000514in \code{cmp_op[\var{opname}]}.
Fred Drake456035f1997-12-03 04:06:57 +0000515\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000516
Fred Drake456035f1997-12-03 04:06:57 +0000517\begin{opcodedesc}{IMPORT_NAME}{namei}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000518Imports the module \code{co_names[\var{namei}]}. The module object is
Fred Drake13494372000-09-12 16:23:48 +0000519pushed onto the stack. The current namespace is not affected: for a
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000520proper import statement, a subsequent \code{STORE_FAST} instruction
Fred Drake13494372000-09-12 16:23:48 +0000521modifies the namespace.
Fred Drake456035f1997-12-03 04:06:57 +0000522\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000523
Fred Drake456035f1997-12-03 04:06:57 +0000524\begin{opcodedesc}{IMPORT_FROM}{namei}
Thomas Wouters52152252000-08-17 22:55:00 +0000525Loads the attribute \code{co_names[\var{namei}]} from the module found in
526TOS. The resulting object is pushed onto the stack, to be subsequently
527stored by a \code{STORE_FAST} instruction.
Fred Drake456035f1997-12-03 04:06:57 +0000528\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000529
Fred Drake456035f1997-12-03 04:06:57 +0000530\begin{opcodedesc}{JUMP_FORWARD}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000531Increments byte code counter by \var{delta}.
Fred Drake456035f1997-12-03 04:06:57 +0000532\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000533
Fred Drake456035f1997-12-03 04:06:57 +0000534\begin{opcodedesc}{JUMP_IF_TRUE}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000535If TOS is true, increment the byte code counter by \var{delta}. TOS is
536left on the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000537\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000538
Fred Drake456035f1997-12-03 04:06:57 +0000539\begin{opcodedesc}{JUMP_IF_FALSE}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000540If TOS is false, increment the byte code counter by \var{delta}. TOS
541is not changed.
Fred Drake456035f1997-12-03 04:06:57 +0000542\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000543
Fred Drake456035f1997-12-03 04:06:57 +0000544\begin{opcodedesc}{JUMP_ABSOLUTE}{target}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000545Set byte code counter to \var{target}.
Fred Drake456035f1997-12-03 04:06:57 +0000546\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000547
Guido van Rossume3fdc972002-06-12 15:33:08 +0000548\begin{opcodedesc}{FOR_ITER}{delta}
549\code{TOS} is an iterator. Call its \method{next()} method. If this
550yields a new value, push it on the stack (leaving the iterator below
551it). If the iterator indicates it is exhausted \code{TOS} is
552popped, and the byte code counter is incremented by \var{delta}.
553\end{opcodedesc}
554
Guido van Rossumfea59e72002-06-13 17:59:51 +0000555%\begin{opcodedesc}{FOR_LOOP}{delta}
556%This opcode is obsolete.
557%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000558
Fred Drake456035f1997-12-03 04:06:57 +0000559%\begin{opcodedesc}{LOAD_LOCAL}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000560%This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000561%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000562
Fred Drake456035f1997-12-03 04:06:57 +0000563\begin{opcodedesc}{LOAD_GLOBAL}{namei}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000564Loads the global named \code{co_names[\var{namei}]} onto the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000565\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000566
Fred Drake456035f1997-12-03 04:06:57 +0000567%\begin{opcodedesc}{SET_FUNC_ARGS}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000568%This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000569%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000570
Fred Drake456035f1997-12-03 04:06:57 +0000571\begin{opcodedesc}{SETUP_LOOP}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000572Pushes a block for a loop onto the block stack. The block spans
573from the current instruction with a size of \var{delta} bytes.
Fred Drake456035f1997-12-03 04:06:57 +0000574\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000575
Fred Drake456035f1997-12-03 04:06:57 +0000576\begin{opcodedesc}{SETUP_EXCEPT}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000577Pushes a try block from a try-except clause onto the block stack.
578\var{delta} points to the first except block.
Fred Drake456035f1997-12-03 04:06:57 +0000579\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000580
Fred Drake456035f1997-12-03 04:06:57 +0000581\begin{opcodedesc}{SETUP_FINALLY}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000582Pushes a try block from a try-except clause onto the block stack.
583\var{delta} points to the finally block.
Fred Drake456035f1997-12-03 04:06:57 +0000584\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000585
Fred Drake456035f1997-12-03 04:06:57 +0000586\begin{opcodedesc}{LOAD_FAST}{var_num}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000587Pushes a reference to the local \code{co_varnames[\var{var_num}]} onto
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000588the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000589\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000590
Fred Drake456035f1997-12-03 04:06:57 +0000591\begin{opcodedesc}{STORE_FAST}{var_num}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000592Stores TOS into the local \code{co_varnames[\var{var_num}]}.
Fred Drake456035f1997-12-03 04:06:57 +0000593\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000594
Fred Drake456035f1997-12-03 04:06:57 +0000595\begin{opcodedesc}{DELETE_FAST}{var_num}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000596Deletes local \code{co_varnames[\var{var_num}]}.
Fred Drake456035f1997-12-03 04:06:57 +0000597\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000598
Jeremy Hyltonaa90adc2001-03-23 17:23:50 +0000599\begin{opcodedesc}{LOAD_CLOSURE}{i}
600Pushes a reference to the cell contained in slot \var{i} of the
601cell and free variable storage. The name of the variable is
602\code{co_cellvars[\var{i}]} if \var{i} is less than the length of
603\var{co_cellvars}. Otherwise it is
604\code{co_freevars[\var{i} - len(co_cellvars)]}.
605\end{opcodedesc}
606
607\begin{opcodedesc}{LOAD_DEREF}{i}
608Loads the cell contained in slot \var{i} of the cell and free variable
609storage. Pushes a reference to the object the cell contains on the
610stack.
611\end{opcodedesc}
612
613\begin{opcodedesc}{STORE_DEREF}{i}
614Stores TOS into the cell contained in slot \var{i} of the cell and
615free variable storage.
616\end{opcodedesc}
617
Fred Drake338da931999-05-17 20:57:07 +0000618\begin{opcodedesc}{SET_LINENO}{lineno}
Michael W. Hudsondd32a912002-08-15 14:59:02 +0000619This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000620\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000621
Fred Drake456035f1997-12-03 04:06:57 +0000622\begin{opcodedesc}{RAISE_VARARGS}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000623Raises an exception. \var{argc} indicates the number of parameters
Fred Drake304faf92000-08-18 02:15:55 +0000624to the raise statement, ranging from 0 to 3. The handler will find
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000625the traceback as TOS2, the parameter as TOS1, and the exception
626as TOS.
Fred Drake456035f1997-12-03 04:06:57 +0000627\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000628
Fred Drake456035f1997-12-03 04:06:57 +0000629\begin{opcodedesc}{CALL_FUNCTION}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000630Calls a function. The low byte of \var{argc} indicates the number of
631positional parameters, the high byte the number of keyword parameters.
632On the stack, the opcode finds the keyword parameters first. For each
633keyword argument, the value is on top of the key. Below the keyword
634parameters, the positional parameters are on the stack, with the
635right-most parameter on top. Below the parameters, the function object
636to call is on the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000637\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000638
Fred Drake456035f1997-12-03 04:06:57 +0000639\begin{opcodedesc}{MAKE_FUNCTION}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000640Pushes a new function object on the stack. TOS is the code associated
641with the function. The function object is defined to have \var{argc}
642default parameters, which are found below TOS.
Fred Drake456035f1997-12-03 04:06:57 +0000643\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000644
Jeremy Hyltonaa90adc2001-03-23 17:23:50 +0000645\begin{opcodedesc}{MAKE_CLOSURE}{argc}
646Creates a new function object, sets its \var{func_closure} slot, and
647pushes it on the stack. TOS is the code associated with the function.
648If the code object has N free variables, the next N items on the stack
649are the cells for these variables. The function also has \var{argc}
650default parameters, where are found before the cells.
651\end{opcodedesc}
652
Fred Drake456035f1997-12-03 04:06:57 +0000653\begin{opcodedesc}{BUILD_SLICE}{argc}
Guido van Rossumda623981998-02-12 03:53:02 +0000654Pushes a slice object on the stack. \var{argc} must be 2 or 3. If it
655is 2, \code{slice(TOS1, TOS)} is pushed; if it is 3,
656\code{slice(TOS2, TOS1, TOS)} is pushed.
Fred Drake304faf92000-08-18 02:15:55 +0000657See the \code{slice()}\bifuncindex{slice} built-in function for more
658information.
Fred Drake456035f1997-12-03 04:06:57 +0000659\end{opcodedesc}
Fred Drake25699f92000-08-17 22:19:26 +0000660
Fred Drake093272e2000-08-24 00:37:50 +0000661\begin{opcodedesc}{EXTENDED_ARG}{ext}
662Prefixes any opcode which has an argument too big to fit into the
663default two bytes. \var{ext} holds two additional bytes which, taken
664together with the subsequent opcode's argument, comprise a four-byte
Fred Drake4c3f7972000-08-31 16:26:35 +0000665argument, \var{ext} being the two most-significant bytes.
Fred Drake093272e2000-08-24 00:37:50 +0000666\end{opcodedesc}
667
Fred Drake25699f92000-08-17 22:19:26 +0000668\begin{opcodedesc}{CALL_FUNCTION_VAR}{argc}
669Calls a function. \var{argc} is interpreted as in \code{CALL_FUNCTION}.
670The top element on the stack contains the variable argument list, followed
671by keyword and positional arguments.
672\end{opcodedesc}
673
674\begin{opcodedesc}{CALL_FUNCTION_KW}{argc}
675Calls a function. \var{argc} is interpreted as in \code{CALL_FUNCTION}.
676The top element on the stack contains the keyword arguments dictionary,
677followed by explicit keyword and positional arguments.
678\end{opcodedesc}
679
680\begin{opcodedesc}{CALL_FUNCTION_VAR_KW}{argc}
681Calls a function. \var{argc} is interpreted as in
682\code{CALL_FUNCTION}. The top element on the stack contains the
683keyword arguments dictionary, followed by the variable-arguments
684tuple, followed by explicit keyword and positional arguments.
685\end{opcodedesc}
Skip Montanarobecbdec2005-01-05 07:19:11 +0000686
687\begin{opcodedesc}{HAVE_ARGUMENT}{}
688This is not really an opcode. It identifies the dividing line between
689opcodes which don't take arguments \code{< HAVE_ARGUMENT} and those which do
690\code{>= HAVE_ARGUMENT}.
691\end{opcodedesc}