Clarify portability and main program.
[python/dscho.git] / Doc / ref / ref8.tex
blob361884f6aee3fb9b84bcda592b4c7aad45d2c057
1 \chapter{Top-level components\label{top-level}}
3 The Python interpreter can get its input from a number of sources:
4 from a script passed to it as standard input or as program argument,
5 typed in interactively, from a module source file, etc. This chapter
6 gives the syntax used in these cases.
7 \index{interpreter}
9 \section{Complete Python programs\label{programs}}
10 \index{program}
12 While a language specification need not prescribe how the language
13 interpreter is invoked, it is useful to have a notion of a complete
14 Python program. A complete Python program is executed in a minimally
15 initialized environment: all built-in and standard modules are
16 available, but none have been initialized, except for \module{sys}
17 (various system services), \module{__builtin__} (built-in functions,
18 exceptions and \code{None}) and \module{__main__}. The latter is used
19 to provide the local and global namespace for execution of the
20 complete program.
21 \refbimodindex{sys}
22 \refbimodindex{__main__}
23 \refbimodindex{__builtin__}
25 The syntax for a complete Python program is that for file input,
26 described in the next section.
28 The interpreter may also be invoked in interactive mode; in this case,
29 it does not read and execute a complete program but reads and executes
30 one statement (possibly compound) at a time. The initial environment
31 is identical to that of a coplete program; each statement is executed
32 in the namespace of \module{__main__}.
33 \index{interactive mode}
34 \refbimodindex{__main__}
36 Under {\UNIX}, a complete program can be passed to the interpreter in
37 three forms: with the {\bf -c} {\it string} command line option, as a
38 file passed as the first command line argument, or as standard input.
39 If the file or standard input is a tty device, the interpreter enters
40 interactive mode; otherwise, it executes the file as a complete
41 program.
42 \index{UNIX}
43 \index{command line}
44 \index{standard input}
46 \section{File input\label{file-input}}
48 All input read from non-interactive files has the same form:
50 \begin{verbatim}
51 file_input: (NEWLINE | statement)*
52 \end{verbatim}
54 This syntax is used in the following situations:
56 \begin{itemize}
58 \item when parsing a complete Python program (from a file or from a string);
60 \item when parsing a module;
62 \item when parsing a string passed to the \keyword{exec} statement;
64 \end{itemize}
66 \section{Interactive input\label{interactive}}
68 Input in interactive mode is parsed using the following grammar:
70 \begin{verbatim}
71 interactive_input: [stmt_list] NEWLINE | compound_stmt NEWLINE
72 \end{verbatim}
74 Note that a (top-level) compound statement must be followed by a blank
75 line in interactive mode; this is needed to help the parser detect the
76 end of the input.
78 \section{Expression input\label{expression-input}}
79 \index{input}
81 There are two forms of expression input. Both ignore leading
82 whitespace.
83 The string argument to \function{eval()} must have the following form:
84 \bifuncindex{eval}
86 \begin{verbatim}
87 eval_input: expression_list NEWLINE*
88 \end{verbatim}
90 The input line read by \function{input()} must have the following form:
91 \bifuncindex{input}
93 \begin{verbatim}
94 input_input: expression_list NEWLINE
95 \end{verbatim}
97 Note: to read `raw' input line without interpretation, you can use the
98 built-in function \function{raw_input()} or the \method{readline()} method
99 of file objects.
100 \obindex{file}
101 \index{input!raw}
102 \index{raw input}
103 \bifuncindex{raw_input}
104 \withsubitem{(file method)}{\ttindex{readline()}}