\documentstyle[twoside,11pt,myformat]{report}

\title{\bf Python Reference Manual}

\author{

Guido van Rossum \\

Dept. CST, CWI, Kruislaan 413 \\

1098 SJ Amsterdam, The Netherlands \\

E-mail: {\tt [email protected]}

}

% Tell \index to actually write the .idx file

\makeindex

\begin{document}

\pagenumbering{roman}

\maketitle

\begin{abstract}

\noindent

Python is a simple, yet powerful, interpreted programming language

that bridges the gap between C and shell programming, and is thus

ideally suited for ``throw-away programming'' and rapid prototyping.

Its syntax is put together from constructs borrowed from a variety of

other languages; most prominent are influences from ABC, C, Modula-3

and Icon.

The Python interpreter is easily extended with new functions and data

types implemented in C. Python is also suitable as an extension

language for highly customizable C applications such as editors or

window managers.

Python is available for various operating systems, amongst which

several flavors of {\UNIX}, Amoeba, the Apple Macintosh O.S.,

and MS-DOS.

This reference manual describes the syntax and ``core semantics'' of

the language. It is terse, but attempts to be exact and complete.

The semantics of non-essential built-in object types and of the

built-in functions and modules are described in the {\em Python

Library Reference}. For an informal introduction to the language, see

the {\em Python Tutorial}.

\end{abstract}

\pagebreak

{

\parskip = 0mm

\tableofcontents

}

\pagebreak

\pagenumbering{arabic}

\chapter{Introduction}

This reference manual describes the Python programming language.

It is not intended as a tutorial.

While I am trying to be as precise as possible, I chose to use English

rather than formal specifications for everything except syntax and

lexical analysis. This should make the document better understandable

to the average reader, but will leave room for ambiguities.

Consequently, if you were coming from Mars and tried to re-implement

Python from this document alone, you might have to guess things and in

fact you would probably end up implementing quite a different language.

On the other hand, if you are using

Python and wonder what the precise rules about a particular area of

the language are, you should definitely be able to find them here.

It is dangerous to add too many implementation details to a language

reference document --- the implementation may change, and other

implementations of the same language may work differently. On the

other hand, there is currently only one Python implementation, and

its particular quirks are sometimes worth being mentioned, especially

where the implementation imposes additional limitations. Therefore,

you'll find short ``implementation notes'' sprinkled throughout the

text.

Every Python implementation comes with a number of built-in and

standard modules. These are not documented here, but in the separate

{\em Python Library Reference} document. A few built-in modules are

mentioned when they interact in a significant way with the language

definition.

\section{Notation}

The descriptions of lexical analysis and syntax use a modified BNF

grammar notation. This uses the following style of definition:

\index{BNF}

\index{grammar}

\index{syntax}

\index{notation}

\begin{verbatim}

name: lc_letter (lc_letter | "_")*

lc_letter: "a"..."z"

\end{verbatim}

The first line says that a \verb\name\ is an \verb\lc_letter\ followed by

a sequence of zero or more \verb\lc_letter\s and underscores. An

\verb\lc_letter\ in turn is any of the single characters `a' through `z'.

(This rule is actually adhered to for the names defined in lexical and

grammar rules in this document.)

Each rule begins with a name (which is the name defined by the rule)

and a colon. A vertical bar

(\verb\|\) is used to separate alternatives; it is the least binding

operator in this notation. A star (\verb\*\) means zero or more

repetitions of the preceding item; likewise, a plus (\verb\+\) means

one or more repetitions, and a question mark (\verb\?\) zero or one

(in other words, the preceding item is optional). These three

operators bind as tightly as possible; parentheses are used for

grouping. Literal strings are enclosed in double quotes. White space

is only meaningful to separate tokens. Rules are normally contained

on a single line; rules with many alternatives may be formatted

alternatively with each line after the first beginning with a

vertical bar.

In lexical definitions (as the example above), two more conventions

are used: Two literal characters separated by three dots mean a choice

of any single character in the given (inclusive) range of ASCII

characters. A phrase between angular brackets (\verb\<...>\) gives an

informal description of the symbol defined; e.g. this could be used

to describe the notion of `control character' if needed.

\index{lexical definitions}

\index{ASCII}

Even though the notation used is almost the same, there is a big

difference between the meaning of lexical and syntactic definitions:

a lexical definition operates on the individual characters of the

input source, while a syntax definition operates on the stream of

tokens generated by the lexical analysis. All uses of BNF in the next

chapter (``Lexical Analysis'') are lexical definitions; uses in

subsequenc chapter are syntactic definitions.

\chapter{Lexical analysis}

A Python program is read by a {\em parser}. Input to the parser is a

stream of {\em tokens}, generated by the {\em lexical analyzer}. This

chapter describes how the lexical analyzer breaks a file into tokens.

\index{lexical analysis}

\index{parser}

\index{token}

\section{Line structure}

A Python program is divided in a number of logical lines. The end of

a logical line is represented by the token NEWLINE. Statements cannot

cross logical line boundaries except where NEWLINE is allowed by the

syntax (e.g. between statements in compound statements).

\index{line structure}

\index{logical line}

\index{NEWLINE token}

\subsection{Comments}

A comment starts with a hash character (\verb\#\) that is not part of

a string literal, and ends at the end of the physical line. A comment

always signifies the end of the logical line. Comments are ignored by

the syntax.

\index{comment}

\index{logical line}

\index{physical line}

\index{hash character}

\subsection{Line joining}

Two or more physical lines may be joined into logical lines using

backslash characters (\verb/\/), as follows: when a physical line ends

in a backslash that is not part of a string literal or comment, it is

joined with the following forming a single logical line, deleting the

backslash and the following end-of-line character. For example:

\index{physical line}

\index{line joining}

\index{backslash character}

%

\begin{verbatim}

moth_names = ['Januari', 'Februari', 'Maart', \

'April', 'Mei', 'Juni', \

'Juli', 'Augustus', 'September', \

'Oktober', 'November', 'December']

\end{verbatim}

\subsection{Blank lines}

A logical line that contains only spaces, tabs, and possibly a

comment, is ignored (i.e., no NEWLINE token is generated), except that

during interactive input of statements, an entirely blank logical line

terminates a multi-line statement.

\index{blank line}

\subsection{Indentation}

Leading whitespace (spaces and tabs) at the beginning of a logical

line is used to compute the indentation level of the line, which in

turn is used to determine the grouping of statements.

\index{indentation}

\index{whitespace}

\index{leading whitespace}

\index{space}

\index{tab}

\index{grouping}

\index{statement grouping}

First, tabs are replaced (from left to right) by one to eight spaces

such that the total number of characters up to there is a multiple of

eight (this is intended to be the same rule as used by {\UNIX}). The

total number of spaces preceding the first non-blank character then

determines the line's indentation. Indentation cannot be split over

multiple physical lines using backslashes.

The indentation levels of consecutive lines are used to generate

INDENT and DEDENT tokens, using a stack, as follows.

\index{INDENT token}

\index{DEDENT token}

Before the first line of the file is read, a single zero is pushed on

the stack; this will never be popped off again. The numbers pushed on

the stack will always be strictly increasing from bottom to top. At

the beginning of each logical line, the line's indentation level is

compared to the top of the stack. If it is equal, nothing happens.

If it larger, it is pushed on the stack, and one INDENT token is

generated. If it is smaller, it {\em must} be one of the numbers

occurring on the stack; all numbers on the stack that are larger are

popped off, and for each number popped off a DEDENT token is

generated. At the end of the file, a DEDENT token is generated for

each number remaining on the stack that is larger than zero.

Here is an example of a correctly (though confusingly) indented piece

of Python code:

\begin{verbatim}

def perm(l):

# Compute the list of all permutations of l

if len(l) <= 1:

return [l]

r = []

for i in range(len(l)):

s = l[:i] + l[i+1:]

p = perm(s)

for x in p:

r.append(l[i:i+1] + x)

return r

\end{verbatim}

The following example shows various indentation errors:

\begin{verbatim}

def perm(l): # error: first line indented

for i in range(len(l)): # error: not indented

s = l[:i] + l[i+1:]

p = perm(l[:i] + l[i+1:]) # error: unexpected indent

for x in p:

r.append(l[i:i+1] + x)

return r # error: inconsistent dedent

\end{verbatim}

(Actually, the first three errors are detected by the parser; only the

last error is found by the lexical analyzer --- the indentation of

\verb\return r\ does not match a level popped off the stack.)

\section{Other tokens}

Besides NEWLINE, INDENT and DEDENT, the following categories of tokens

exist: identifiers, keywords, literals, operators, and delimiters.

Spaces and tabs are not tokens, but serve to delimit tokens. Where

ambiguity exists, a token comprises the longest possible string that

forms a legal token, when read from left to right.

\section{Identifiers}

Identifiers (also referred to as names) are described by the following

lexical definitions:

\index{identifier}

\index{name}

\begin{verbatim}

identifier: (letter|"_") (letter|digit|"_")*

letter: lowercase | uppercase

lowercase: "a"..."z"

uppercase: "A"..."Z"

digit: "0"..."9"

\end{verbatim}

Identifiers are unlimited in length. Case is significant.

\subsection{Keywords}

The following identifiers are used as reserved words, or {\em

keywords} of the language, and cannot be used as ordinary

identifiers. They must be spelled exactly as written here:

\index{keyword}

\index{reserved word}

\begin{verbatim}

and del for in print

break elif from is raise

class else global not return

continue except if or try

def finally import pass while

\end{verbatim}

% # This Python program sorts and formats the above table

% import string

% l = []

% try:

% while 1:

% l = l + string.split(raw_input())

% except EOFError:

% pass

% l.sort()

% for i in range((len(l)+4)/5):

% for j in range(i, len(l), 5):

% print string.ljust(l[j], 10),

% print

\section{Literals} \label{literals}

Literals are notations for constant values of some built-in types.

\index{literal}

\index{constant}

\subsection{String literals}

String literals are described by the following lexical definitions:

\index{string literal}

\begin{verbatim}

stringliteral: "'" stringitem* "'"

stringitem: stringchar | escapeseq

stringchar: <any ASCII character except newline or "\" or "'">

escapeseq: "'" <any ASCII character except newline>

\end{verbatim}

\index{ASCII}

String literals cannot span physical line boundaries. Escape

sequences in strings are actually interpreted according to rules

simular to those used by Standard C. The recognized escape sequences

are:

\index{physical line}

\index{escape sequence}

\index{Standard C}

\index{C}

\begin{center}

\begin{tabular}{|l|l|}

\hline

\verb/\\/ & Backslash (\verb/\/) \\

\verb/\'/ & Single quote (\verb/'/) \\

\verb/\a/ & ASCII Bell (BEL) \\

\verb/\b/ & ASCII Backspace (BS) \\

%\verb/\E/ & ASCII Escape (ESC) \\

\verb/\f/ & ASCII Formfeed (FF) \\

\verb/\n/ & ASCII Linefeed (LF) \\

\verb/\r/ & ASCII Carriage Return (CR) \\

\verb/\t/ & ASCII Horizontal Tab (TAB) \\

\verb/\v/ & ASCII Vertical Tab (VT) \\

\verb/\/{\em ooo} & ASCII character with octal value {\em ooo} \\

\verb/\x/{\em xx...} & ASCII character with hex value {\em xx...} \\

\hline

\end{tabular}

\end{center}

\index{ASCII}

In strict compatibility with in Standard C, up to three octal digits are

accepted, but an unlimited number of hex digits is taken to be part of

the hex escape (and then the lower 8 bits of the resulting hex number

are used in all current implementations...).

All unrecognized escape sequences are left in the string unchanged,

i.e., {\em the backslash is left in the string.} (This behavior is

useful when debugging: if an escape sequence is mistyped, the

resulting output is more easily recognized as broken. It also helps a

great deal for string literals used as regular expressions or

otherwise passed to other modules that do their own escape handling.)

\index{unrecognized escape sequence}

\subsection{Numeric literals}

There are three types of numeric literals: plain integers, long

integers, and floating point numbers.

\index{number}

\index{numeric literal}

\index{integer literal}

\index{plain integer literal}

\index{long integer literal}

\index{floating point literal}

\index{hexadecimal literal}

\index{octal literal}

\index{decimal literal}

Integer and long integer literals are described by the following

lexical definitions:

\begin{verbatim}

longinteger: integer ("l"|"L")

integer: decimalinteger | octinteger | hexinteger

decimalinteger: nonzerodigit digit* | "0"

octinteger: "0" octdigit+

hexinteger: "0" ("x"|"X") hexdigit+

nonzerodigit: "1"..."9"

octdigit: "0"..."7"

hexdigit: digit|"a"..."f"|"A"..."F"

\end{verbatim}

Although both lower case `l' and upper case `L' are allowed as suffix

for long integers, it is strongly recommended to always use `L', since

the letter `l' looks too much like the digit `1'.

Plain integer decimal literals must be at most $2^{31} - 1$ (i.e., the

largest positive integer, assuming 32-bit arithmetic). Plain octal and

hexadecimal literals may be as large as $2^{32} - 1$, but values

larger than $2^{31} - 1$ are converted to a negative value by

subtracting $2^{32}$. There is no limit for long integer literals.

Some examples of plain and long integer literals:

\begin{verbatim}

7 2147483647 0177 0x80000000

3L 79228162514264337593543950336L 0377L 0x100000000L

\end{verbatim}

Floating point literals are described by the following lexical

definitions:

\begin{verbatim}

floatnumber: pointfloat | exponentfloat

pointfloat: [intpart] fraction | intpart "."

exponentfloat: (intpart | pointfloat) exponent

intpart: digit+

fraction: "." digit+

exponent: ("e"|"E") ["+"|"-"] digit+

\end{verbatim}

The allowed range of floating point literals is

implementation-dependent.

Some examples of floating point literals:

\begin{verbatim}

3.14 10. .001 1e100 3.14e-10

\end{verbatim}

Note that numeric literals do not include a sign; a phrase like

\verb\-1\ is actually an expression composed of the operator

\verb\-\ and the literal \verb\1\.

\section{Operators}

The following tokens are operators:

\index{operators}

\begin{verbatim}

+ - * / %

<< >> & | ^ ~

< == > <= <> != >=

\end{verbatim}

The comparison operators \verb\<>\ and \verb\!=\ are alternate

spellings of the same operator.

\section{Delimiters}

The following tokens serve as delimiters or otherwise have a special

meaning:

\index{delimiters}

\begin{verbatim}

( ) [ ] { }

; , : . ` =

\end{verbatim}

The following printing ASCII characters are not used in Python. Their

occurrence outside string literals and comments is an unconditional

error:

\index{ASCII}

\begin{verbatim}

! @ $ " ?

\end{verbatim}

They may be used by future versions of the language though!

\chapter{Data model}

\section{Objects, values and types}

{\em Objects} are Python's abstraction for data. All data in a Python

program is represented by objects or by relations between objects.

(In a sense, and in conformance to Von Neumann's model of a

``stored program computer'', code is also represented by objects.)

\index{object}

\index{data}

Every object has an identity, a type and a value. An object's {\em

identity} never changes once it has been created; you may think of it

as the object's address in memory. An object's {\em type} is also

unchangeable. It determines the operations that an object supports

(e.g. ``does it have a length?'') and also defines the possible

values for objects of that type. The {\em value} of some objects can

change. Objects whose value can change are said to be {\em mutable};

objects whose value is unchangeable once they are created are called

{\em immutable}. The type determines an object's (im)mutability.

\index{identity of an object}

\index{value of an object}

\index{type of an object}

\index{mutable object}

\index{immutable object}

Objects are never explicitly destroyed; however, when they become

unreachable they may be garbage-collected. An implementation is

allowed to delay garbage collection or omit it altogether --- it is a

matter of implementation quality how garbage collection is

implemented, as long as no objects are collected that are still

reachable. (Implementation note: the current implementation uses a

reference-counting scheme which collects most objects as soon as they

become unreachable, but never collects garbage containing circular

references.)

\index{garbage collection}

\index{reference counting}

\index{unreachable object}

Note that the use of the implementation's tracing or debugging

facilities may keep objects alive that would normally be collectable.

Some objects contain references to ``external'' resources such as open

files or windows. It is understood that these resources are freed

when the object is garbage-collected, but since garbage collection is

not guaranteed to happen, such objects also provide an explicit way to

release the external resource, usually a \verb\close\ method.

Programs are strongly recommended to always explicitly close such

objects.

Some objects contain references to other objects; these are called

{\em containers}. Examples of containers are tuples, lists and

dictionaries. The references are part of a container's value. In

most cases, when we talk about the value of a container, we imply the

values, not the identities of the contained objects; however, when we

talk about the (im)mutability of a container, only the identities of

the immediately contained objects are implied. (So, if an immutable

container contains a reference to a mutable object, its value changes

if that mutable object is changed.)

\index{container}

Types affect almost all aspects of objects' lives. Even the meaning

of object identity is affected in some sense: for immutable types,

operations that compute new values may actually return a reference to

any existing object with the same type and value, while for mutable

objects this is not allowed. E.g. after

\begin{verbatim}

a = 1; b = 1; c = []; d = []

\end{verbatim}

\verb\a\ and \verb\b\ may or may not refer to the same object with the

value one, depending on the implementation, but \verb\c\ and \verb\d\

are guaranteed to refer to two different, unique, newly created empty

lists.

\section{The standard type hierarchy} \label{types}

Below is a list of the types that are built into Python. Extension

modules written in C can define additional types. Future versions of

Python may add types to the type hierarchy (e.g. rational or complex

numbers, efficiently stored arrays of integers, etc.).

\index{type}

\indexii{data}{type}

\indexii{type}{hierarchy}

\indexii{extension}{module}

\index{C}

Some of the type descriptions below contain a paragraph listing

`special attributes'. These are attributes that provide access to the

implementation and are not intended for general use. Their definition

may change in the future. There are also some `generic' special

attributes, not listed with the individual objects: \verb\__methods__\

is a list of the method names of a built-in object, if it has any;

\verb\__members__\ is a list of the data attribute names of a built-in

object, if it has any.

\index{attribute}

\indexii{special}{attribute}

\indexiii{generic}{special}{attribute}

\ttindex{__methods__}

\ttindex{__members__}

\begin{description}

\item[None]

This type has a single value. There is a single object with this value.

This object is accessed through the built-in name \verb\None\.

It is returned from functions that don't explicitly return an object.

\ttindex{None}

\obindex{None@{\tt None}}

\item[Numbers]

These are created by numeric literals and returned as results by

arithmetic operators and arithmetic built-in functions. Numeric

objects are immutable; once created their value never changes. Python

numbers are of course strongly related to mathematical numbers, but

subject to the limitations of numerical representation in computers.

\obindex{number}

\obindex{numeric}

Python distinguishes between integers and floating point numbers:

\begin{description}

\item[Integers]

These represent elements from the mathematical set of whole numbers.

\obindex{integer}

There are two types of integers:

\begin{description}

\item[Plain integers]

These represent numbers in the range $-2^{31}$ through $2^{31}-1$.

(The range may be larger on machines with a larger natural word

size, but not smaller.)

When the result of an operation falls outside this range, the

exception \verb\OverflowError\ is raised.

For the purpose of shift and mask operations, integers are assumed to

have a binary, 2's complement notation using 32 or more bits, and

hiding no bits from the user (i.e., all $2^{32}$ different bit

patterns correspond to different values).

\obindex{plain integer}

\item[Long integers]

These represent numbers in an unlimited range, subject to avaiable

(virtual) memory only. For the purpose of shift and mask operations,

a binary representation is assumed, and negative numbers are

represented in a variant of 2's complement which gives the illusion of

an infinite string of sign bits extending to the left.

\obindex{long integer}

\end{description} % Integers

The rules for integer representation are intended to give the most

meaningful interpretation of shift and mask operations involving

negative integers and the least surprises when switching between the

plain and long integer domains. For any operation except left shift,

if it yields a result in the plain integer domain without causing

overflow, it will yield the same result in the long integer domain or

when using mixed operands.

\indexii{integer}{representation}

\item[Floating point numbers]

These represent machine-level double precision floating point numbers.

You are at the mercy of the underlying machine architecture and

C implementation for the accepted range and handling of overflow.

\obindex{floating point}

\indexii{floating point}{number}

\index{C}

\end{description} % Numbers

\item[Sequences]

These represent finite ordered sets indexed by natural numbers.

The built-in function \verb\len()\ returns the number of elements

of a sequence. When this number is $n$, the index set contains

the numbers $0, 1, \ldots, n-1$. Element \verb\i\ of sequence

\verb\a\ is selected by \verb\a[i]\.

\obindex{seqence}

\bifuncindex{len}

\index{index operation}

\index{item selection}

\index{subscription}

Sequences also support slicing: \verb\a[i:j]\ selects all elements

with index $k$ such that $i < k < j$. When used as an expression,

a slice is a sequence of the same type --- this implies that the

index set is renumbered so that it starts at 0 again.

\index{slicing}

Sequences are distinguished according to their mutability:

\begin{description}

%

\item[Immutable sequences]

An object of an immutable sequence type cannot change once it is

created. (If the object contains references to other objects,

these other objects may be mutable and may be changed; however

the collection of objects directly referenced by an immutable object

cannot change.)

\obindex{immutable sequence}

\obindex{immutable}

The following types are immutable sequences:

\begin{description}

\item[Strings]

The elements of a string are characters. There is no separate

character type; a character is represented by a string of one element.

Characters represent (at least) 8-bit bytes. The built-in

functions \verb\chr()\ and \verb\ord()\ convert between characters

and nonnegative integers representing the byte values.

Bytes with the values 0-127 represent the corresponding ASCII values.

The string data type is also used to represent arrays of bytes, e.g.

to hold data read from a file.

\obindex{string}

\index{character}

\index{byte}

\index{ASCII}

\bifuncindex{chr}

\bifuncindex{ord}

(On systems whose native character set is not ASCII, strings may use

EBCDIC in their internal representation, provided the functions

\verb\chr()\ and \verb\ord()\ implement a mapping between ASCII and

EBCDIC, and string comparison preserves the ASCII order.

Or perhaps someone can propose a better rule?)

\index{ASCII}

\index{EBCDIC}

\index{character set}

\indexii{string}{comparison}

\bifuncindex{chr}

\bifuncindex{ord}

\item[Tuples]

The elements of a tuple are arbitrary Python objects.

Tuples of two or more elements are formed by comma-separated lists

of expressions. A tuple of one element (a `singleton') can be formed

by affixing a comma to an expression (an expression by itself does

not create a tuple, since parentheses must be usable for grouping of

expressions). An empty tuple can be formed by enclosing `nothing' in

parentheses.

\obindex{tuple}

\indexii{singleton}{tuple}

\indexii{empty}{tuple}

\end{description} % Immutable sequences

\item[Mutable sequences]

Mutable sequences can be changed after they are created. The

subscription and slicing notations can be used as the target of

assignment and \verb\del\ (delete) statements.

\obindex{mutable sequece}

\obindex{mutable}

\indexii{assignment}{statement}

\index{delete}

\stindex{del}

\index{subscription}

\index{slicing}

There is currently a single mutable sequence type:

\begin{description}

\item[Lists]

The elements of a list are arbitrary Python objects. Lists are formed

by placing a comma-separated list of expressions in square brackets.

(Note that there are no special cases needed to form lists of length 0

or 1.)

\obindex{list}

\end{description} % Mutable sequences

\end{description} % Sequences

\item[Mapping types]

These represent finite sets of objects indexed by arbitrary index sets.

The subscript notation \verb\a[k]\ selects the element indexed

by \verb\k\ from the mapping \verb\a\; this can be used in

expressions and as the target of assignments or \verb\del\ statements.

The built-in function \verb\len()\ returns the number of elements

in a mapping.

\bifuncindex{len}

\index{subscription}

\obindex{mapping}

There is currently a single mapping type:

\begin{description}

\item[Dictionaries]

These represent finite sets of objects indexed by strings.

Dictionaries are mutable; they are created by the \verb\{...}\

notation (see section \ref{dict}). (Implementation note: the strings

used for indexing must not contain null bytes.)

\obindex{dictionary}

\obindex{mutable}

\end{description} % Mapping types

\item[Callable types]

These are the types to which the function call (invocation) operation,

written as \verb\function(argument, argument, ...)\, can be applied:

\indexii{function}{call}

\index{invocation}

\indexii{function}{argument}

\obindex{callable}

\begin{description}

\item[User-defined functions]

A user-defined function object is created by a function definition

(see section \ref{function}). It should be called with an argument

list containing the same number of items as the function's formal

parameter list.

\indexii{user-defined}{function}

\obindex{function}

\obindex{user-defined function}

Special read-only attributes: \verb\func_code\ is the code object

representing the compiled function body, and \verb\func_globals\ is (a

reference to) the dictionary that holds the function's global

variables --- it implements the global name space of the module in

which the function was defined.

\ttindex{func_code}

\ttindex{func_globals}

\indexii{global}{name space}

\item[User-defined methods]

A user-defined method (a.k.a. {\em object closure}) is a pair of a

class instance object and a user-defined function. It should be

called with an argument list containing one item less than the number

of items in the function's formal parameter list. When called, the

class instance becomes the first argument, and the call arguments are

shifted one to the right.

\obindex{method}

\obindex{user-defined method}

indexii{user-defined}{method}

\index{object closure}

Special read-only attributes: \verb\im_self\ is the class instance

object, \verb\im_func\ is the function object.

\ttindex{im_func}

\ttindex{im_self}

\item[Built-in functions]

A built-in function object is a wrapper around a C function. Examples

of built-in functions are \verb\len\ and \verb\math.sin\. There

are no special attributes. The number and type of the arguments are

determined by the C function.

\obindex{built-in function}

\obindex{function}

\index{C}

\item[Built-in methods]

This is really a different disguise of a built-in function, this time

containing an object passed to the C function as an implicit extra

argument. An example of a built-in method is \verb\list.append\ if

\verb\list\ is a list object.

\obindex{built-in method}

\obindex{method}

\indexii{built-in}{method}

\item[Classes]

Class objects are described below. When a class object is called as a

parameterless function, a new class instance (also described below) is

created and returned. The class's initialization function is not

called --- this is the responsibility of the caller. It is illegal to

call a class object with one or more arguments.

\obindex{class}

\obindex{class instance}

\obindex{instance}

\indexii{class object}{call}

\end{description}

\item[Modules]

Modules are imported by the \verb\import\ statement (see section

\ref{import}). A module object is a container for a module's name

space, which is a dictionary (the same dictionary as referenced by the

\verb\func_globals\ attribute of functions defined in the module).

Module attribute references are translated to lookups in this

dictionary. A module object does not contain the code object used to

initialize the module (since it isn't needed once the initialization

is done).

\stindex{import}

\obindex{module}

Attribute assignment update the module's name space dictionary.

Special read-only attributes: \verb\__dict__\ yields the module's name

space as a dictionary object; \verb\__name__\ yields the module's name

as a string object.

\ttindex{__dict__}

\ttindex{__name__}

\indexii{module}{name space}

\item[Classes]

Class objects are created by class definitions (see section

\ref{class}). A class is a container for a dictionary containing the

class's name space. Class attribute references are translated to

lookups in this dictionary. When an attribute name is not found

there, the attribute search continues in the base classes. The search

is depth-first, left-to-right in the order of their occurrence in the

base class list.

\obindex{class}

\obindex{class instance}

\obindex{instance}

\indexii{class object}{call}

\index{container}

\index{dictionary}

\indexii{class}{attribute}

Class attribute assignments update the class's dictionary, never the

dictionary of a base class.

\indexiii{class}{attribute}{assignment}

A class can be called as a parameterless function to yield a class

instance (see above).

\indexii{class object}{call}

Special read-only attributes: \verb\__dict__\ yields te dictionary

containing the class's name space; \verb\__bases__\ yields a tuple

(possibly empty or a singleton) containing the base classes, in the

order of their occurrence in the base class list.

\ttindex{__dict__}

\ttindex{__bases__}

\item[Class instances]

A class instance is created by calling a class object as a

parameterless function. A class instance has a dictionary in which

attribute references are searched. When an attribute is not found

there, and the instance's class has an attribute by that name, and

that class attribute is a user-defined function (and in no other

cases), the instance attribute reference yields a user-defined method

object (see above) constructed from the instance and the function.

\obindex{class instance}

\obindex{instance}

\indexii{class}{instance}

\indexii{class instance}{attribute}

Attribute assignments update the instance's dictionary.

\indexiii{class instance}{attribute}{assignment}

Special read-only attributes: \verb\__dict__\ yields the attribute

dictionary; \verb\__class__\ yields the instance's class.

\ttindex{__dict__}

\ttindex{__class__}

\item[Files]

A file object represents an open file. (It is a wrapper around a C

{\tt stdio} file pointer.) File objects are created by the

\verb\open()\ built-in function, and also by \verb\posix.popen()\ and

the \verb\makefile\ method of socket objects. \verb\sys.stdin\,

\verb\sys.stdout\ and \verb\sys.stderr\ are file objects corresponding

the the interpreter's standard input, output and error streams.

See the Python Library Reference for methods of file objects and other

details.

\obindex{file}

\index{C}

\index{stdio}

\bifuncindex{open}

\bifuncindex{popen}

\bifuncindex{makefile}

\ttindex{stdin}

\ttindex{stdout}

\ttindex{stderr}

\ttindex{sys.stdin}

\ttindex{sys.stdout}

\ttindex{sys.stderr}

\item[Internal types]

A few types used internally by the interpreter are exposed to the user.

Their definition may change with future versions of the interpreter,

but they are mentioned here for completeness.

\index{internal type}

\begin{description}

\item[Code objects]

Code objects represent executable code. The difference between a code

object and a function object is that the function object contains an

explicit reference to the function's context (the module in which it

was defined) which a code object contains no context. There is no way

to execute a bare code object.

\obindex{code}

Special read-only attributes: \verb\co_code\ is a string representing

the sequence of instructions; \verb\co_consts\ is a list of literals

used by the code; \verb\co_names\ is a list of names (strings) used by

the code; \verb\co_filename\ is the filename from which the code was

compiled. (To find out the line numbers, you would have to decode the

instructions; the standard library module \verb\dis\ contains an

example of how to do this.)

\ttindex{co_code}

\ttindex{co_consts}

\ttindex{co_names}

\ttindex{co_filename}

\item[Frame objects]

Frame objects represent execution frames. They may occur in traceback

objects (see below).

\obindex{frame}

Special read-only attributes: \verb\f_back\ is to the previous

stack frame (towards the caller), or \verb\None\ if this is the bottom

stack frame; \verb\f_code\ is the code object being executed in this

frame; \verb\f_globals\ is the dictionary used to look up global