blob: e2bfcca62af6356158ecc2e59d52e7bc89345488 [file] [log] [blame]
Fred Drake431f0ce1999-05-13 18:38:11 +00001\chapter{Execution model \label{execmodel}}
Fred Drakef6669171998-05-06 19:52:49 +00002\index{execution model}
3
Fred Drake2829f1c2001-06-23 05:27:20 +00004
Jeremy Hyltone7d57732002-04-01 20:38:01 +00005\section{Naming and binding \label{naming}}
6\indexii{code}{block}
Guido van Rossumb18a93b1998-07-23 19:36:00 +00007\index{namespace}
Jeremy Hyltone7d57732002-04-01 20:38:01 +00008\index{scope}
Fred Drakef6669171998-05-06 19:52:49 +00009
Jeremy Hyltone7d57732002-04-01 20:38:01 +000010\dfn{Names}\index{name} refer to objects. Names are introduced by
11name binding operations. Each occurrence of a name in the program
12text refers to the \dfn{binding}\indexii{binding}{name} of that name
13established in the innermost function block containing the use.
Fred Drakef6669171998-05-06 19:52:49 +000014
Jeremy Hyltone7d57732002-04-01 20:38:01 +000015A \dfn{block}\index{block} is a piece of Python program text that is
16executed as a unit. The following are blocks: a module, a function
17body, and a class definition. Each command typed interactively is a
18block. A script file (a file given as standard input to the
19interpreter or specified on the interpreter command line the first
20argument) is a code block. A script command (a command specified on
21the interpreter command line with the `\strong{-c}' option) is a code
22block. The file read by the built-in function \function{execfile()}
23is a code block. The string argument passed to the built-in function
24\function{eval()} and to the \keyword{exec} statement is a code block.
25The expression read and evaluated by the built-in function
26\function{input()} is a code block.
Fred Drakef6669171998-05-06 19:52:49 +000027
Jeremy Hyltone7d57732002-04-01 20:38:01 +000028A \dfn{scope}\index{scope} defines the visibility of a name within a
29block. If a local variable is defined in a block, it's scope includes
30that block. If the definition occurs in a function block, the scope
31extends to any blocks contained within the defining one, unless a
32contained block introduces a different binding for the name. The
33scope of names defined in a class block is limited to the class block;
34it does not extend to the code blocks of methods.
Fred Drakef6669171998-05-06 19:52:49 +000035
Jeremy Hyltone7d57732002-04-01 20:38:01 +000036When a name is used in a code block, it is resolved using the nearest
37enclosing scope. The set of all such scopes visible to a code block
38is called the block's \dfn{environment}\index{environment}.
Fred Drakef6669171998-05-06 19:52:49 +000039
Jeremy Hyltone7d57732002-04-01 20:38:01 +000040If a name is bound in a block, it is a local variable of that block.
41If a name is bound at the module level, it is a global variable. (The
42variables of the module code block are local and global.) If a
43variable is used in a code block but not defined there, it is a
44\dfn{free variable}\indexii{free}{variable}.
Fred Drakef6669171998-05-06 19:52:49 +000045
Jeremy Hyltone7d57732002-04-01 20:38:01 +000046When a name is not found at all, a
47\exception{NameError}\withsubitem{(built-in
48exception)}{\ttindex{NameError}} exception is raised. If the name
49refers to a local variable that has not been bound, a
50\exception{UnboundLocalError}\ttindex{UnboundLocalError} exception is
51raised. \exception{UnboundLocalError} is a subclass of
52\exception{NameError}.
53
54The following constructs bind names: formal parameters to functions,
Guido van Rossumb18a93b1998-07-23 19:36:00 +000055\keyword{import} statements, class and function definitions (these
56bind the class or function name in the defining block), and targets
57that are identifiers if occurring in an assignment, \keyword{for} loop
58header, or in the second position of an \keyword{except} clause
Jeremy Hyltone7d57732002-04-01 20:38:01 +000059header. The \keyword{import} statement of the form ``\samp{from
60\ldots import *}''\stindex{from} binds all names defined in the
61imported module, except those beginning with an underscore. This form
62may only be used at the module level.
Fred Drakef6669171998-05-06 19:52:49 +000063
64A target occurring in a \keyword{del} statement is also considered bound
Jeremy Hyltone7d57732002-04-01 20:38:01 +000065for this purpose (though the actual semantics are to unbind the
66name). It is illegal to unbind a name that is referenced by an
67enclosing scope; the compiler will report a \exception{SyntaxError}.
Fred Drakef6669171998-05-06 19:52:49 +000068
Jeremy Hyltone7d57732002-04-01 20:38:01 +000069Each assignment or import statement occurs within a block defined by a
70class or function definition or at the module level (the top-level
71code block).
Fred Drakef6669171998-05-06 19:52:49 +000072
Jeremy Hyltone7d57732002-04-01 20:38:01 +000073If a name binding operation occurs anywhere within a code block, all
74uses of the name within the block are treated as references to the
75current block. This can lead to errors when a name is used within a
76block before it is bound.
Fred Drakef6669171998-05-06 19:52:49 +000077
Jeremy Hyltone7d57732002-04-01 20:38:01 +000078The previous rule is a subtle. Python lacks declarations and allows
79name binding operations to occur anywhere within a code block. The
80local variables of a code block can be determined by scanning the
81entire text of the block for name binding operations.
Jeremy Hyltone7024812001-03-23 14:05:16 +000082
Jeremy Hyltone7d57732002-04-01 20:38:01 +000083If the global statement occurs within a block, all uses of the name
84specified in the statement refer to the binding of that name in the
85top-level namespace. Names are resolved in the top-level namespace by
86searching the global namespace, i.e. the namespace of the module
87containing the code block, and the builtin namespace, the namespace of
88the module \module{__builtin__}. The global namespace is searched
89first. If the name is not found there, the builtin namespace is
90searched. The global statement must precede all uses of the name.
Jeremy Hyltone7024812001-03-23 14:05:16 +000091
Jeremy Hyltone7d57732002-04-01 20:38:01 +000092The built-in namespace associated with the execution of a code block
93is actually found by looking up the name \code{__builtins__} in its
94global namespace; this should be a dictionary or a module (in the
95latter case the module's dictionary is used). Normally, the
96\code{__builtins__} namespace is the dictionary of the built-in module
97\module{__builtin__} (note: no `s'). If it isn't, restricted
98execution\indexii{restricted}{execution} mode is in effect.
Jeremy Hyltone7024812001-03-23 14:05:16 +000099
Jeremy Hyltone7d57732002-04-01 20:38:01 +0000100The namespace for a module is automatically created the first time a
101module is imported. The main module for a script is always called
102\module{__main__}\refbimodindex{__main__}.
Jeremy Hyltone7024812001-03-23 14:05:16 +0000103
Jeremy Hyltone7d57732002-04-01 20:38:01 +0000104The global statement has the same scope as a name binding operation
105in the same block. If the nearest enclosing scope for a free variable
106contains a global statement, the free variable is treated as a global.
Jeremy Hyltone7024812001-03-23 14:05:16 +0000107
Jeremy Hyltone7d57732002-04-01 20:38:01 +0000108A class definition is an executable statement that may use and define
109names. These references follow the normal rules for name resolution.
110The namespace of the class definition becomes the attribute dictionary
111of the class. Names defined at the class scope are not visible in
112methods.
Jeremy Hyltone7024812001-03-23 14:05:16 +0000113
Jeremy Hyltone7d57732002-04-01 20:38:01 +0000114\subsection{Interaction with dynamic features \label{dynamic-features}}
115
116There are several cases where Python statements are illegal when
117used in conjunction with nested scopes that contain free
118variables.
119
120If a variable is referenced in an enclosing scope, it is illegal
121to delete the name. An error will be reported at compile time.
122
123If the wild card form of import --- \samp{import *} --- is used in a
124function and the function contains or is a nested block with free
125variables, the compiler will raise a SyntaxError.
126
127If \keyword{exec} is used in a function and the function contains or
128is a nested block with free variables, the compiler will raise a
129\exception{SyntaxError} unless the exec explicitly specifies the local
130namespace for the \keyword{exec}. (In other words, \samp{exec obj}
131would be illegal, but \samp{exec obj in ns} would be legal.)
132
133The \function{eval()}, \function{execfile()}, and \function{input()}
134functions and the \keyword{exec} statement do not have access to the
135full environment for resolving names. Names may be resolved in the
136local and global namespaces of the caller. Free variables are not
137resolved in the nearest enclosing namespace, but in the global
138namespace.\footnote{This limitation occurs because the code that is
139 executed by these operations is not available at the time the
140 module is compiled.}
141The \keyword{exec} statement and the \function{eval()} and
Guido van Rossumb18a93b1998-07-23 19:36:00 +0000142\function{execfile()} functions have optional arguments to override
143the global and local namespace. If only one namespace is specified,
144it is used for both.
Fred Drakef6669171998-05-06 19:52:49 +0000145
Fred Drake431f0ce1999-05-13 18:38:11 +0000146\section{Exceptions \label{exceptions}}
147\index{exception}
Fred Drakef6669171998-05-06 19:52:49 +0000148
149Exceptions are a means of breaking out of the normal flow of control
150of a code block in order to handle errors or other exceptional
Fred Drake431f0ce1999-05-13 18:38:11 +0000151conditions. An exception is
152\emph{raised}\index{raise an exception} at the point where the error
153is detected; it may be \emph{handled}\index{handle an exception} by
154the surrounding code block or by any code block that directly or
155indirectly invoked the code block where the error occurred.
Fred Drakef6669171998-05-06 19:52:49 +0000156\index{exception handler}
157\index{errors}
158\index{error handling}
159
Guido van Rossumb18a93b1998-07-23 19:36:00 +0000160The Python interpreter raises an exception when it detects a run-time
Fred Drakef6669171998-05-06 19:52:49 +0000161error (such as division by zero). A Python program can also
162explicitly raise an exception with the \keyword{raise} statement.
163Exception handlers are specified with the \keyword{try} ... \keyword{except}
Guido van Rossumb18a93b1998-07-23 19:36:00 +0000164statement. The \keyword{try} ... \keyword{finally} statement
165specifies cleanup code which does not handle the exception, but is
166executed whether an exception occurred or not in the preceding code.
Fred Drakef6669171998-05-06 19:52:49 +0000167
Fred Drakee15956b2000-04-03 04:51:13 +0000168Python uses the ``termination'' \index{termination model}model of
169error handling: an exception handler can find out what happened and
170continue execution at an outer level, but it cannot repair the cause
171of the error and retry the failing operation (except by re-entering
172the offending piece of code from the top).
Fred Drakef6669171998-05-06 19:52:49 +0000173
174When an exception is not handled at all, the interpreter terminates
Guido van Rossumb18a93b1998-07-23 19:36:00 +0000175execution of the program, or returns to its interactive main loop. In
176either case, it prints a stack backtrace, except when the exception is
Fred Drake431f0ce1999-05-13 18:38:11 +0000177\exception{SystemExit}\withsubitem{(built-in
178exception)}{\ttindex{SystemExit}}.
Fred Drakef6669171998-05-06 19:52:49 +0000179
Guido van Rossumb18a93b1998-07-23 19:36:00 +0000180Exceptions are identified by string objects or class instances.
181Selection of a matching except clause is based on object identity
182(i.e., two different string objects with the same value represent
183different exceptions!) For string exceptions, the \keyword{except}
184clause must reference the same string object. For class exceptions,
185the \keyword{except} clause must reference the same class or a base
186class of it.
Fred Drakef6669171998-05-06 19:52:49 +0000187
188When an exception is raised, an object (maybe \code{None}) is passed
Guido van Rossumb18a93b1998-07-23 19:36:00 +0000189as the exception's ``parameter'' or ``value''; this object does not
190affect the selection of an exception handler, but is passed to the
191selected exception handler as additional information. For class
192exceptions, this object must be an instance of the exception class
193being raised.
Fred Drakef6669171998-05-06 19:52:49 +0000194
Fred Drakee15956b2000-04-03 04:51:13 +0000195See also the description of the \keyword{try} statement in section
196\ref{try} and \keyword{raise} statement in section \ref{raise}.