blob: d0354c634dc7fffa2fc7b8b43ef964cc855a7ee6 [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
29 9 RETURN_VALUE
Michael W. Hudson53d58bb2002-08-30 13:09:51 +000030 10 LOAD_CONST 0 (None)
31 13 RETURN_VALUE
Guido van Rossumb62b6d11997-11-18 15:10:53 +000032\end{verbatim}
33
Michael W. Hudsondd32a912002-08-15 14:59:02 +000034(The ``2'' is a line number).
35
Fred Drake2c4f5542000-10-10 22:00:03 +000036The \module{dis} module defines the following functions and constants:
Guido van Rossumb62b6d11997-11-18 15:10:53 +000037
Guido van Rossumb62b6d11997-11-18 15:10:53 +000038\begin{funcdesc}{dis}{\optional{bytesource}}
39Disassemble the \var{bytesource} object. \var{bytesource} can denote
Neal Norwitzdcd05002002-06-26 22:32:47 +000040either a module, a class, a method, a function, or a code object.
41For a module, it disassembles all functions. For a class,
Guido van Rossumb62b6d11997-11-18 15:10:53 +000042it disassembles all methods. For a single code sequence, it prints
43one line per byte code instruction. If no object is provided, it
44disassembles the last traceback.
45\end{funcdesc}
46
47\begin{funcdesc}{distb}{\optional{tb}}
48Disassembles the top-of-stack function of a traceback, using the last
49traceback if none was passed. The instruction causing the exception
50is indicated.
51\end{funcdesc}
52
Fred Drakecce10901998-03-17 06:33:25 +000053\begin{funcdesc}{disassemble}{code\optional{, lasti}}
Guido van Rossumb62b6d11997-11-18 15:10:53 +000054Disassembles a code object, indicating the last instruction if \var{lasti}
55was provided. The output is divided in the following columns:
Fred Drake810349b1998-04-07 14:16:41 +000056
Fred Drake3e7a48e1998-04-13 16:15:02 +000057\begin{enumerate}
Michael W. Hudsondd32a912002-08-15 14:59:02 +000058\item the line number, for the first instruction of each line
Fred Drakedff21a61998-04-03 05:42:10 +000059\item the current instruction, indicated as \samp{-->},
Fred Drakec054c752001-04-13 17:25:38 +000060\item a labelled instruction, indicated with \samp{>\code{>}},
Guido van Rossumb62b6d11997-11-18 15:10:53 +000061\item the address of the instruction,
62\item the operation code name,
63\item operation parameters, and
64\item interpretation of the parameters in parentheses.
Fred Drake3e7a48e1998-04-13 16:15:02 +000065\end{enumerate}
Fred Drake810349b1998-04-07 14:16:41 +000066
Guido van Rossumb62b6d11997-11-18 15:10:53 +000067The parameter interpretation recognizes local and global
68variable names, constant values, branch targets, and compare
69operators.
70\end{funcdesc}
71
Fred Drakecce10901998-03-17 06:33:25 +000072\begin{funcdesc}{disco}{code\optional{, lasti}}
Guido van Rossumb62b6d11997-11-18 15:10:53 +000073A synonym for disassemble. It is more convenient to type, and kept
74for compatibility with earlier Python releases.
75\end{funcdesc}
76
77\begin{datadesc}{opname}
Fred Drake2c4f5542000-10-10 22:00:03 +000078Sequence of operation names, indexable using the byte code.
Guido van Rossumb62b6d11997-11-18 15:10:53 +000079\end{datadesc}
80
81\begin{datadesc}{cmp_op}
82Sequence of all compare operation names.
83\end{datadesc}
84
85\begin{datadesc}{hasconst}
86Sequence of byte codes that have a constant parameter.
87\end{datadesc}
88
Fred Drake47cdf6f2002-03-28 19:34:53 +000089\begin{datadesc}{hasfree}
90Sequence of byte codes that access a free variable.
91\end{datadesc}
92
Guido van Rossumb62b6d11997-11-18 15:10:53 +000093\begin{datadesc}{hasname}
Fred Drake2c4f5542000-10-10 22:00:03 +000094Sequence of byte codes that access an attribute by name.
Guido van Rossumb62b6d11997-11-18 15:10:53 +000095\end{datadesc}
96
97\begin{datadesc}{hasjrel}
98Sequence of byte codes that have a relative jump target.
99\end{datadesc}
100
101\begin{datadesc}{hasjabs}
102Sequence of byte codes that have an absolute jump target.
103\end{datadesc}
104
105\begin{datadesc}{haslocal}
Fred Drake2c4f5542000-10-10 22:00:03 +0000106Sequence of byte codes that access a local variable.
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000107\end{datadesc}
108
109\begin{datadesc}{hascompare}
Fred Drake6c81e2a2001-10-01 17:04:10 +0000110Sequence of byte codes of Boolean operations.
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000111\end{datadesc}
112
113\subsection{Python Byte Code Instructions}
Fred Drake83efb541998-02-19 20:07:39 +0000114\label{bytecodes}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000115
116The Python compiler currently generates the following byte code
117instructions.
118
Fred Drake19479911998-02-13 06:58:54 +0000119\setindexsubitem{(byte code insns)}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000120
Fred Drake456035f1997-12-03 04:06:57 +0000121\begin{opcodedesc}{STOP_CODE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000122Indicates end-of-code to the compiler, not used by the interpreter.
Fred Drake456035f1997-12-03 04:06:57 +0000123\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000124
Fred Drake456035f1997-12-03 04:06:57 +0000125\begin{opcodedesc}{POP_TOP}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000126Removes the top-of-stack (TOS) item.
Fred Drake456035f1997-12-03 04:06:57 +0000127\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000128
Fred Drake456035f1997-12-03 04:06:57 +0000129\begin{opcodedesc}{ROT_TWO}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000130Swaps the two top-most stack items.
Fred Drake456035f1997-12-03 04:06:57 +0000131\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000132
Fred Drake456035f1997-12-03 04:06:57 +0000133\begin{opcodedesc}{ROT_THREE}{}
134Lifts second and third stack item one position up, moves top down
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000135to position three.
Fred Drake456035f1997-12-03 04:06:57 +0000136\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000137
Thomas Wouters12bba852000-08-24 20:06:04 +0000138\begin{opcodedesc}{ROT_FOUR}{}
139Lifts second, third and forth stack item one position up, moves top down to
140position four.
141\end{opcodedesc}
142
Fred Drake456035f1997-12-03 04:06:57 +0000143\begin{opcodedesc}{DUP_TOP}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000144Duplicates the reference on top of the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000145\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000146
147Unary Operations take the top of the stack, apply the operation, and
148push the result back on the stack.
149
Fred Drake456035f1997-12-03 04:06:57 +0000150\begin{opcodedesc}{UNARY_POSITIVE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000151Implements \code{TOS = +TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000152\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000153
Fred Drake4c3f7972000-08-31 16:26:35 +0000154\begin{opcodedesc}{UNARY_NEGATIVE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000155Implements \code{TOS = -TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000156\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000157
Fred Drake456035f1997-12-03 04:06:57 +0000158\begin{opcodedesc}{UNARY_NOT}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000159Implements \code{TOS = not TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000160\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000161
Fred Drake456035f1997-12-03 04:06:57 +0000162\begin{opcodedesc}{UNARY_CONVERT}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000163Implements \code{TOS = `TOS`}.
Fred Drake456035f1997-12-03 04:06:57 +0000164\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000165
Fred Drake456035f1997-12-03 04:06:57 +0000166\begin{opcodedesc}{UNARY_INVERT}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000167Implements \code{TOS = \~{}TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000168\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000169
Guido van Rossume3fdc972002-06-12 15:33:08 +0000170\begin{opcodedesc}{GET_ITER}{}
171Implements \code{TOS = iter(TOS)}.
172\end{opcodedesc}
173
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000174Binary operations remove the top of the stack (TOS) and the second top-most
175stack item (TOS1) from the stack. They perform the operation, and put the
176result back on the stack.
177
Fred Drake456035f1997-12-03 04:06:57 +0000178\begin{opcodedesc}{BINARY_POWER}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000179Implements \code{TOS = TOS1 ** TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000180\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000181
Fred Drake456035f1997-12-03 04:06:57 +0000182\begin{opcodedesc}{BINARY_MULTIPLY}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000183Implements \code{TOS = TOS1 * TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000184\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000185
Fred Drake456035f1997-12-03 04:06:57 +0000186\begin{opcodedesc}{BINARY_DIVIDE}{}
Guido van Rossume3fdc972002-06-12 15:33:08 +0000187Implements \code{TOS = TOS1 / TOS} when
188\code{from __future__ import division} is not in effect.
189\end{opcodedesc}
190
191\begin{opcodedesc}{BINARY_FLOOR_DIVIDE}{}
192Implements \code{TOS = TOS1 // TOS}.
193\end{opcodedesc}
194
195\begin{opcodedesc}{BINARY_TRUE_DIVIDE}{}
196Implements \code{TOS = TOS1 / TOS} when
197\code{from __future__ import division} is in effect.
Fred Drake456035f1997-12-03 04:06:57 +0000198\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000199
Fred Drake456035f1997-12-03 04:06:57 +0000200\begin{opcodedesc}{BINARY_MODULO}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000201Implements \code{TOS = TOS1 \%{} TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000202\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000203
Fred Drake456035f1997-12-03 04:06:57 +0000204\begin{opcodedesc}{BINARY_ADD}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000205Implements \code{TOS = TOS1 + TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000206\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000207
Fred Drake456035f1997-12-03 04:06:57 +0000208\begin{opcodedesc}{BINARY_SUBTRACT}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000209Implements \code{TOS = TOS1 - TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000210\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000211
Fred Drake456035f1997-12-03 04:06:57 +0000212\begin{opcodedesc}{BINARY_SUBSCR}{}
Fred Drake1cf87491997-12-04 04:57:56 +0000213Implements \code{TOS = TOS1[TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000214\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000215
Fred Drake456035f1997-12-03 04:06:57 +0000216\begin{opcodedesc}{BINARY_LSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000217Implements \code{TOS = TOS1 <\code{}< TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000218\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000219
Fred Drake456035f1997-12-03 04:06:57 +0000220\begin{opcodedesc}{BINARY_RSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000221Implements \code{TOS = TOS1 >\code{}> TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000222\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000223
Fred Drake456035f1997-12-03 04:06:57 +0000224\begin{opcodedesc}{BINARY_AND}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000225Implements \code{TOS = TOS1 \&\ TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000226\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000227
Fred Drake456035f1997-12-03 04:06:57 +0000228\begin{opcodedesc}{BINARY_XOR}{}
Fred Draked7feffd1997-12-29 20:02:55 +0000229Implements \code{TOS = TOS1 \^\ TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000230\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000231
Fred Drake456035f1997-12-03 04:06:57 +0000232\begin{opcodedesc}{BINARY_OR}{}
Fred Drake9e759df2000-06-15 18:44:30 +0000233Implements \code{TOS = TOS1 | TOS}.
Fred Drake456035f1997-12-03 04:06:57 +0000234\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000235
Thomas Wouters12bba852000-08-24 20:06:04 +0000236In-place operations are like binary operations, in that they remove TOS and
237TOS1, and push the result back on the stack, but the operation is done
238in-place when TOS1 supports it, and the resulting TOS may be (but does not
239have to be) the original TOS1.
240
241\begin{opcodedesc}{INPLACE_POWER}{}
242Implements in-place \code{TOS = TOS1 ** TOS}.
243\end{opcodedesc}
244
245\begin{opcodedesc}{INPLACE_MULTIPLY}{}
246Implements in-place \code{TOS = TOS1 * TOS}.
247\end{opcodedesc}
248
249\begin{opcodedesc}{INPLACE_DIVIDE}{}
Guido van Rossume3fdc972002-06-12 15:33:08 +0000250Implements in-place \code{TOS = TOS1 / TOS} when
251\code{from __future__ import division} is not in effect.
252\end{opcodedesc}
253
254\begin{opcodedesc}{INPLACE_FLOOR_DIVIDE}{}
255Implements in-place \code{TOS = TOS1 // TOS}.
256\end{opcodedesc}
257
258\begin{opcodedesc}{INPLACE_TRUE_DIVIDE}{}
259Implements in-place \code{TOS = TOS1 / TOS} when
260\code{from __future__ import division} is in effect.
Thomas Wouters12bba852000-08-24 20:06:04 +0000261\end{opcodedesc}
262
263\begin{opcodedesc}{INPLACE_MODULO}{}
264Implements in-place \code{TOS = TOS1 \%{} TOS}.
265\end{opcodedesc}
266
267\begin{opcodedesc}{INPLACE_ADD}{}
268Implements in-place \code{TOS = TOS1 + TOS}.
269\end{opcodedesc}
270
271\begin{opcodedesc}{INPLACE_SUBTRACT}{}
272Implements in-place \code{TOS = TOS1 - TOS}.
273\end{opcodedesc}
274
275\begin{opcodedesc}{INPLACE_LSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000276Implements in-place \code{TOS = TOS1 <\code{}< TOS}.
Thomas Wouters12bba852000-08-24 20:06:04 +0000277\end{opcodedesc}
278
279\begin{opcodedesc}{INPLACE_RSHIFT}{}
Fred Drake2c4f5542000-10-10 22:00:03 +0000280Implements in-place \code{TOS = TOS1 >\code{}> TOS}.
Thomas Wouters12bba852000-08-24 20:06:04 +0000281\end{opcodedesc}
282
283\begin{opcodedesc}{INPLACE_AND}{}
284Implements in-place \code{TOS = TOS1 \&\ TOS}.
285\end{opcodedesc}
286
287\begin{opcodedesc}{INPLACE_XOR}{}
288Implements in-place \code{TOS = TOS1 \^\ TOS}.
289\end{opcodedesc}
290
291\begin{opcodedesc}{INPLACE_OR}{}
292Implements in-place \code{TOS = TOS1 | TOS}.
293\end{opcodedesc}
294
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000295The slice opcodes take up to three parameters.
296
Fred Drake456035f1997-12-03 04:06:57 +0000297\begin{opcodedesc}{SLICE+0}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000298Implements \code{TOS = 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+1}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000302Implements \code{TOS = TOS1[TOS:]}.
Fred Drake456035f1997-12-03 04:06:57 +0000303\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000304
Fred Drake456035f1997-12-03 04:06:57 +0000305\begin{opcodedesc}{SLICE+2}{}
Neal Norwitze72a9a12002-08-05 23:33:54 +0000306Implements \code{TOS = TOS1[:TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000307\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000308
Fred Drake456035f1997-12-03 04:06:57 +0000309\begin{opcodedesc}{SLICE+3}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000310Implements \code{TOS = TOS2[TOS1:TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000311\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000312
313Slice assignment needs even an additional parameter. As any statement,
314they put nothing on the stack.
315
Fred Drake456035f1997-12-03 04:06:57 +0000316\begin{opcodedesc}{STORE_SLICE+0}{}
Fred Drake7381e281997-12-04 04:51:12 +0000317Implements \code{TOS[:] = TOS1}.
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+1}{}
Fred Drake7381e281997-12-04 04:51:12 +0000321Implements \code{TOS1[TOS:] = TOS2}.
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}{STORE_SLICE+2}{}
Fred Drake7381e281997-12-04 04:51:12 +0000325Implements \code{TOS1[:TOS] = TOS2}.
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}{STORE_SLICE+3}{}
Fred Drake7381e281997-12-04 04:51:12 +0000329Implements \code{TOS2[TOS1:TOS] = TOS3}.
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+0}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000333Implements \code{del 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+1}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000337Implements \code{del 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}{DELETE_SLICE+2}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000341Implements \code{del TOS1[:TOS]}.
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_SLICE+3}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000345Implements \code{del TOS2[TOS1:TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000346\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000347
Fred Drake456035f1997-12-03 04:06:57 +0000348\begin{opcodedesc}{STORE_SUBSCR}{}
Fred Drake7381e281997-12-04 04:51:12 +0000349Implements \code{TOS1[TOS] = TOS2}.
Fred Drake456035f1997-12-03 04:06:57 +0000350\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000351
Fred Drake456035f1997-12-03 04:06:57 +0000352\begin{opcodedesc}{DELETE_SUBSCR}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000353Implements \code{del TOS1[TOS]}.
Fred Drake456035f1997-12-03 04:06:57 +0000354\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000355
Guido van Rossume3fdc972002-06-12 15:33:08 +0000356Miscellaneous opcodes.
357
Fred Drake456035f1997-12-03 04:06:57 +0000358\begin{opcodedesc}{PRINT_EXPR}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000359Implements the expression statement for the interactive mode. TOS is
360removed from the stack and printed. In non-interactive mode, an
Fred Drake456035f1997-12-03 04:06:57 +0000361expression statement is terminated with \code{POP_STACK}.
362\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000363
Fred Drake456035f1997-12-03 04:06:57 +0000364\begin{opcodedesc}{PRINT_ITEM}{}
Barry Warsaw90876882000-08-21 17:19:00 +0000365Prints TOS to the file-like object bound to \code{sys.stdout}. There
366is one such instruction for each item in the \keyword{print} statement.
367\end{opcodedesc}
368
369\begin{opcodedesc}{PRINT_ITEM_TO}{}
370Like \code{PRINT_ITEM}, but prints the item second from TOS to the
371file-like object at TOS. This is used by the extended print statement.
Fred Drake456035f1997-12-03 04:06:57 +0000372\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000373
Fred Drake456035f1997-12-03 04:06:57 +0000374\begin{opcodedesc}{PRINT_NEWLINE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000375Prints a new line on \code{sys.stdout}. This is generated as the
Fred Drake304faf92000-08-18 02:15:55 +0000376last operation of a \keyword{print} statement, unless the statement
377ends with a comma.
Fred Drake456035f1997-12-03 04:06:57 +0000378\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000379
Barry Warsaw90876882000-08-21 17:19:00 +0000380\begin{opcodedesc}{PRINT_NEWLINE_TO}{}
381Like \code{PRINT_NEWLINE}, but prints the new line on the file-like
382object on the TOS. This is used by the extended print statement.
383\end{opcodedesc}
384
Fred Drake456035f1997-12-03 04:06:57 +0000385\begin{opcodedesc}{BREAK_LOOP}{}
Fred Drake304faf92000-08-18 02:15:55 +0000386Terminates a loop due to a \keyword{break} statement.
Fred Drake456035f1997-12-03 04:06:57 +0000387\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000388
Guido van Rossume3fdc972002-06-12 15:33:08 +0000389\begin{opcodedesc}{CONTINUE_LOOP}{target}
390Continues a loop due to a \keyword{continue} statement. \var{target}
391is the address to jump to (which should be a \code{FOR_ITER}
392instruction).
393\end{opcodedesc}
394
Fred Drake456035f1997-12-03 04:06:57 +0000395\begin{opcodedesc}{LOAD_LOCALS}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000396Pushes a reference to the locals of the current scope on the stack.
397This is used in the code for a class definition: After the class body
398is evaluated, the locals are passed to the class definition.
Fred Drake456035f1997-12-03 04:06:57 +0000399\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000400
Fred Drake456035f1997-12-03 04:06:57 +0000401\begin{opcodedesc}{RETURN_VALUE}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000402Returns with TOS to the caller of the function.
Fred Drake456035f1997-12-03 04:06:57 +0000403\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000404
Guido van Rossume3fdc972002-06-12 15:33:08 +0000405\begin{opcodedesc}{YIELD_VALUE}{}
406Pops \code{TOS} and yields it from a generator.
407\end{opcodedesc}
408
Thomas Wouters52152252000-08-17 22:55:00 +0000409\begin{opcodedesc}{IMPORT_STAR}{}
Fred Drake304faf92000-08-18 02:15:55 +0000410Loads all symbols not starting with \character{_} directly from the module TOS
Thomas Wouters52152252000-08-17 22:55:00 +0000411to the local namespace. The module is popped after loading all names.
Fred Drake304faf92000-08-18 02:15:55 +0000412This opcode implements \code{from module import *}.
413\end{opcodedesc}
Thomas Wouters52152252000-08-17 22:55:00 +0000414
Fred Drake456035f1997-12-03 04:06:57 +0000415\begin{opcodedesc}{EXEC_STMT}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000416Implements \code{exec TOS2,TOS1,TOS}. The compiler fills
Fred Drake304faf92000-08-18 02:15:55 +0000417missing optional parameters with \code{None}.
Fred Drake456035f1997-12-03 04:06:57 +0000418\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000419
Fred Drake456035f1997-12-03 04:06:57 +0000420\begin{opcodedesc}{POP_BLOCK}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000421Removes one block from the block stack. Per frame, there is a
422stack of blocks, denoting nested loops, try statements, and such.
Fred Drake456035f1997-12-03 04:06:57 +0000423\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000424
Fred Drake456035f1997-12-03 04:06:57 +0000425\begin{opcodedesc}{END_FINALLY}{}
Fred Drake304faf92000-08-18 02:15:55 +0000426Terminates a \keyword{finally} clause. The interpreter recalls
427whether the exception has to be re-raised, or whether the function
428returns, and continues with the outer-next block.
Fred Drake456035f1997-12-03 04:06:57 +0000429\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000430
Fred Drake456035f1997-12-03 04:06:57 +0000431\begin{opcodedesc}{BUILD_CLASS}{}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000432Creates a new class object. TOS is the methods dictionary, TOS1
433the tuple of the names of the base classes, and TOS2 the class name.
Fred Drake456035f1997-12-03 04:06:57 +0000434\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000435
436All of the following opcodes expect arguments. An argument is two
437bytes, with the more significant byte last.
438
Fred Drake456035f1997-12-03 04:06:57 +0000439\begin{opcodedesc}{STORE_NAME}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000440Implements \code{name = TOS}. \var{namei} is the index of \var{name}
Fred Drakedff21a61998-04-03 05:42:10 +0000441in the attribute \member{co_names} of the code object.
Fred Drake456035f1997-12-03 04:06:57 +0000442The compiler tries to use \code{STORE_LOCAL} or \code{STORE_GLOBAL}
443if possible.
444\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000445
Fred Drake456035f1997-12-03 04:06:57 +0000446\begin{opcodedesc}{DELETE_NAME}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000447Implements \code{del name}, where \var{namei} is the index into
Fred Drakedff21a61998-04-03 05:42:10 +0000448\member{co_names} attribute of the code object.
Fred Drake456035f1997-12-03 04:06:57 +0000449\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000450
Thomas Wouters0be5aab2000-08-11 22:15:52 +0000451\begin{opcodedesc}{UNPACK_SEQUENCE}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000452Unpacks TOS into \var{count} individual values, which are put onto
453the stack right-to-left.
Fred Drake456035f1997-12-03 04:06:57 +0000454\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000455
Thomas Wouters0be5aab2000-08-11 22:15:52 +0000456%\begin{opcodedesc}{UNPACK_LIST}{count}
457%This opcode is obsolete.
458%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000459
Fred Drake456035f1997-12-03 04:06:57 +0000460%\begin{opcodedesc}{UNPACK_ARG}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000461%This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000462%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000463
Thomas Wouters12bba852000-08-24 20:06:04 +0000464\begin{opcodedesc}{DUP_TOPX}{count}
465Duplicate \var{count} items, keeping them in the same order. Due to
466implementation limits, \var{count} should be between 1 and 5 inclusive.
467\end{opcodedesc}
468
Fred Drake456035f1997-12-03 04:06:57 +0000469\begin{opcodedesc}{STORE_ATTR}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000470Implements \code{TOS.name = TOS1}, where \var{namei} is the index
Fred Drakedff21a61998-04-03 05:42:10 +0000471of name in \member{co_names}.
Fred Drake456035f1997-12-03 04:06:57 +0000472\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000473
Fred Drake456035f1997-12-03 04:06:57 +0000474\begin{opcodedesc}{DELETE_ATTR}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000475Implements \code{del TOS.name}, using \var{namei} as index into
Fred Drakedff21a61998-04-03 05:42:10 +0000476\member{co_names}.
Fred Drake456035f1997-12-03 04:06:57 +0000477\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000478
Fred Drake456035f1997-12-03 04:06:57 +0000479\begin{opcodedesc}{STORE_GLOBAL}{namei}
480Works as \code{STORE_NAME}, but stores the name as a global.
481\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000482
Fred Drake456035f1997-12-03 04:06:57 +0000483\begin{opcodedesc}{DELETE_GLOBAL}{namei}
484Works as \code{DELETE_NAME}, but deletes a global name.
485\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000486
Fred Drake456035f1997-12-03 04:06:57 +0000487%\begin{opcodedesc}{UNPACK_VARARG}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000488%This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000489%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000490
Fred Drake456035f1997-12-03 04:06:57 +0000491\begin{opcodedesc}{LOAD_CONST}{consti}
Fred Drakedff21a61998-04-03 05:42:10 +0000492Pushes \samp{co_consts[\var{consti}]} 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}{LOAD_NAME}{namei}
Fred Drakedff21a61998-04-03 05:42:10 +0000496Pushes the value associated with \samp{co_names[\var{namei}]} onto the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000497\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000498
Fred Drake456035f1997-12-03 04:06:57 +0000499\begin{opcodedesc}{BUILD_TUPLE}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000500Creates a tuple consuming \var{count} items from the stack, and pushes
501the resulting tuple onto the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000502\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000503
Fred Drake456035f1997-12-03 04:06:57 +0000504\begin{opcodedesc}{BUILD_LIST}{count}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000505Works as \code{BUILD_TUPLE}, but creates a list.
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}{BUILD_MAP}{zero}
Fred Drake304faf92000-08-18 02:15:55 +0000509Pushes a new empty dictionary object onto the stack. The argument is
510ignored and set to zero by the compiler.
Fred Drake456035f1997-12-03 04:06:57 +0000511\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000512
Fred Drake456035f1997-12-03 04:06:57 +0000513\begin{opcodedesc}{LOAD_ATTR}{namei}
Raymond Hettingerb4c1d9b2003-05-10 08:51:28 +0000514Replaces TOS with \code{getattr(TOS, co_names[\var{namei}])}.
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}{COMPARE_OP}{opname}
Fred Drake6c81e2a2001-10-01 17:04:10 +0000518Performs a Boolean operation. The operation name can be found
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000519in \code{cmp_op[\var{opname}]}.
Fred Drake456035f1997-12-03 04:06:57 +0000520\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000521
Fred Drake456035f1997-12-03 04:06:57 +0000522\begin{opcodedesc}{IMPORT_NAME}{namei}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000523Imports the module \code{co_names[\var{namei}]}. The module object is
Fred Drake13494372000-09-12 16:23:48 +0000524pushed onto the stack. The current namespace is not affected: for a
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000525proper import statement, a subsequent \code{STORE_FAST} instruction
Fred Drake13494372000-09-12 16:23:48 +0000526modifies the namespace.
Fred Drake456035f1997-12-03 04:06:57 +0000527\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000528
Fred Drake456035f1997-12-03 04:06:57 +0000529\begin{opcodedesc}{IMPORT_FROM}{namei}
Thomas Wouters52152252000-08-17 22:55:00 +0000530Loads the attribute \code{co_names[\var{namei}]} from the module found in
531TOS. The resulting object is pushed onto the stack, to be subsequently
532stored by a \code{STORE_FAST} instruction.
Fred Drake456035f1997-12-03 04:06:57 +0000533\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000534
Fred Drake456035f1997-12-03 04:06:57 +0000535\begin{opcodedesc}{JUMP_FORWARD}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000536Increments byte code counter by \var{delta}.
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_TRUE}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000540If TOS is true, increment the byte code counter by \var{delta}. TOS is
541left on the stack.
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_IF_FALSE}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000545If TOS is false, increment the byte code counter by \var{delta}. TOS
546is not changed.
Fred Drake456035f1997-12-03 04:06:57 +0000547\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000548
Fred Drake456035f1997-12-03 04:06:57 +0000549\begin{opcodedesc}{JUMP_ABSOLUTE}{target}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000550Set byte code counter to \var{target}.
Fred Drake456035f1997-12-03 04:06:57 +0000551\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000552
Guido van Rossume3fdc972002-06-12 15:33:08 +0000553\begin{opcodedesc}{FOR_ITER}{delta}
554\code{TOS} is an iterator. Call its \method{next()} method. If this
555yields a new value, push it on the stack (leaving the iterator below
556it). If the iterator indicates it is exhausted \code{TOS} is
557popped, and the byte code counter is incremented by \var{delta}.
558\end{opcodedesc}
559
Guido van Rossumfea59e72002-06-13 17:59:51 +0000560%\begin{opcodedesc}{FOR_LOOP}{delta}
561%This opcode is obsolete.
562%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000563
Fred Drake456035f1997-12-03 04:06:57 +0000564%\begin{opcodedesc}{LOAD_LOCAL}{namei}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000565%This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000566%\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000567
Fred Drake456035f1997-12-03 04:06:57 +0000568\begin{opcodedesc}{LOAD_GLOBAL}{namei}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000569Loads the global named \code{co_names[\var{namei}]} onto the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000570\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000571
Fred Drake456035f1997-12-03 04:06:57 +0000572%\begin{opcodedesc}{SET_FUNC_ARGS}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000573%This opcode is obsolete.
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_LOOP}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000577Pushes a block for a loop onto the block stack. The block spans
578from the current instruction with a size of \var{delta} bytes.
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_EXCEPT}{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 first except 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}{SETUP_FINALLY}{delta}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000587Pushes a try block from a try-except clause onto the block stack.
588\var{delta} points to the finally block.
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}{LOAD_FAST}{var_num}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000592Pushes a reference to the local \code{co_varnames[\var{var_num}]} onto
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000593the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000594\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000595
Fred Drake456035f1997-12-03 04:06:57 +0000596\begin{opcodedesc}{STORE_FAST}{var_num}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000597Stores TOS into the local \code{co_varnames[\var{var_num}]}.
Fred Drake456035f1997-12-03 04:06:57 +0000598\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000599
Fred Drake456035f1997-12-03 04:06:57 +0000600\begin{opcodedesc}{DELETE_FAST}{var_num}
Fred Drakedd1f6cc1998-02-12 03:32:18 +0000601Deletes local \code{co_varnames[\var{var_num}]}.
Fred Drake456035f1997-12-03 04:06:57 +0000602\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000603
Jeremy Hyltonaa90adc2001-03-23 17:23:50 +0000604\begin{opcodedesc}{LOAD_CLOSURE}{i}
605Pushes a reference to the cell contained in slot \var{i} of the
606cell and free variable storage. The name of the variable is
607\code{co_cellvars[\var{i}]} if \var{i} is less than the length of
608\var{co_cellvars}. Otherwise it is
609\code{co_freevars[\var{i} - len(co_cellvars)]}.
610\end{opcodedesc}
611
612\begin{opcodedesc}{LOAD_DEREF}{i}
613Loads the cell contained in slot \var{i} of the cell and free variable
614storage. Pushes a reference to the object the cell contains on the
615stack.
616\end{opcodedesc}
617
618\begin{opcodedesc}{STORE_DEREF}{i}
619Stores TOS into the cell contained in slot \var{i} of the cell and
620free variable storage.
621\end{opcodedesc}
622
Fred Drake338da931999-05-17 20:57:07 +0000623\begin{opcodedesc}{SET_LINENO}{lineno}
Michael W. Hudsondd32a912002-08-15 14:59:02 +0000624This opcode is obsolete.
Fred Drake456035f1997-12-03 04:06:57 +0000625\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000626
Fred Drake456035f1997-12-03 04:06:57 +0000627\begin{opcodedesc}{RAISE_VARARGS}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000628Raises an exception. \var{argc} indicates the number of parameters
Fred Drake304faf92000-08-18 02:15:55 +0000629to the raise statement, ranging from 0 to 3. The handler will find
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000630the traceback as TOS2, the parameter as TOS1, and the exception
631as TOS.
Fred Drake456035f1997-12-03 04:06:57 +0000632\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000633
Fred Drake456035f1997-12-03 04:06:57 +0000634\begin{opcodedesc}{CALL_FUNCTION}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000635Calls a function. The low byte of \var{argc} indicates the number of
636positional parameters, the high byte the number of keyword parameters.
637On the stack, the opcode finds the keyword parameters first. For each
638keyword argument, the value is on top of the key. Below the keyword
639parameters, the positional parameters are on the stack, with the
640right-most parameter on top. Below the parameters, the function object
641to call is on the stack.
Fred Drake456035f1997-12-03 04:06:57 +0000642\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000643
Fred Drake456035f1997-12-03 04:06:57 +0000644\begin{opcodedesc}{MAKE_FUNCTION}{argc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000645Pushes a new function object on the stack. TOS is the code associated
646with the function. The function object is defined to have \var{argc}
647default parameters, which are found below TOS.
Fred Drake456035f1997-12-03 04:06:57 +0000648\end{opcodedesc}
Guido van Rossumb62b6d11997-11-18 15:10:53 +0000649
Jeremy Hyltonaa90adc2001-03-23 17:23:50 +0000650\begin{opcodedesc}{MAKE_CLOSURE}{argc}
651Creates a new function object, sets its \var{func_closure} slot, and
652pushes it on the stack. TOS is the code associated with the function.
653If the code object has N free variables, the next N items on the stack
654are the cells for these variables. The function also has \var{argc}
655default parameters, where are found before the cells.
656\end{opcodedesc}
657
Fred Drake456035f1997-12-03 04:06:57 +0000658\begin{opcodedesc}{BUILD_SLICE}{argc}
Guido van Rossumda623981998-02-12 03:53:02 +0000659Pushes a slice object on the stack. \var{argc} must be 2 or 3. If it
660is 2, \code{slice(TOS1, TOS)} is pushed; if it is 3,
661\code{slice(TOS2, TOS1, TOS)} is pushed.
Fred Drake304faf92000-08-18 02:15:55 +0000662See the \code{slice()}\bifuncindex{slice} built-in function for more
663information.
Fred Drake456035f1997-12-03 04:06:57 +0000664\end{opcodedesc}
Fred Drake25699f92000-08-17 22:19:26 +0000665
Fred Drake093272e2000-08-24 00:37:50 +0000666\begin{opcodedesc}{EXTENDED_ARG}{ext}
667Prefixes any opcode which has an argument too big to fit into the
668default two bytes. \var{ext} holds two additional bytes which, taken
669together with the subsequent opcode's argument, comprise a four-byte
Fred Drake4c3f7972000-08-31 16:26:35 +0000670argument, \var{ext} being the two most-significant bytes.
Fred Drake093272e2000-08-24 00:37:50 +0000671\end{opcodedesc}
672
Fred Drake25699f92000-08-17 22:19:26 +0000673\begin{opcodedesc}{CALL_FUNCTION_VAR}{argc}
674Calls a function. \var{argc} is interpreted as in \code{CALL_FUNCTION}.
675The top element on the stack contains the variable argument list, followed
676by keyword and positional arguments.
677\end{opcodedesc}
678
679\begin{opcodedesc}{CALL_FUNCTION_KW}{argc}
680Calls a function. \var{argc} is interpreted as in \code{CALL_FUNCTION}.
681The top element on the stack contains the keyword arguments dictionary,
682followed by explicit keyword and positional arguments.
683\end{opcodedesc}
684
685\begin{opcodedesc}{CALL_FUNCTION_VAR_KW}{argc}
686Calls a function. \var{argc} is interpreted as in
687\code{CALL_FUNCTION}. The top element on the stack contains the
688keyword arguments dictionary, followed by the variable-arguments
689tuple, followed by explicit keyword and positional arguments.
690\end{opcodedesc}