blob: f447ed4dc0e9e4c156bce3d039129e4c064f02b3 [file] [log] [blame]
Fred Drake03e10312002-03-26 19:17:43 +00001\documentclass{howto}
Fred Drake693aea22003-02-07 14:52:18 +00002\usepackage{distutils}
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00003% $Id$
4
5\title{What's New in Python 2.3}
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00006\release{0.10}
Fred Drakeaac8c582003-01-17 22:50:10 +00007\author{A.M.\ Kuchling}
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00008\authoraddress{\email{amk@amk.ca}}
Fred Drake03e10312002-03-26 19:17:43 +00009
10\begin{document}
11\maketitle
12\tableofcontents
13
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +000014% To do:
Andrew M. Kuchlingc61ec522002-08-04 01:20:05 +000015% MacOS framework-related changes (section of its own, probably)
Andrew M. Kuchlingf70a0a82002-06-10 13:22:46 +000016
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000017%\section{Introduction \label{intro}}
18
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +000019{\large This article is a draft, and is currently up to date for
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +000020Python 2.3alpha2. Please send any additions, comments or errata to
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +000021the author.}
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000022
23This article explains the new features in Python 2.3. The tentative
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +000024release date of Python 2.3 is currently scheduled for mid-2003.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000025
26This article doesn't attempt to provide a complete specification of
27the new features, but instead provides a convenient overview. For
28full details, you should refer to the documentation for Python 2.3,
Fred Drake693aea22003-02-07 14:52:18 +000029such as the \citetitle[../lib/lib.html]{Python Library Reference} and
30the \citetitle[../ref/ref.html]{Python Reference Manual}. If you want
31to understand the complete implementation and design rationale for a
32change, refer to the PEP for a particular new feature.
Fred Drake03e10312002-03-26 19:17:43 +000033
34
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000035%======================================================================
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000036\section{PEP 218: A Standard Set Datatype}
37
38The new \module{sets} module contains an implementation of a set
39datatype. The \class{Set} class is for mutable sets, sets that can
40have members added and removed. The \class{ImmutableSet} class is for
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +000041sets that can't be modified, and instances of \class{ImmutableSet} can
42therefore be used as dictionary keys. Sets are built on top of
43dictionaries, so the elements within a set must be hashable.
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000044
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +000045Here's a simple example:
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000046
47\begin{verbatim}
48>>> import sets
49>>> S = sets.Set([1,2,3])
50>>> S
51Set([1, 2, 3])
52>>> 1 in S
53True
54>>> 0 in S
55False
56>>> S.add(5)
57>>> S.remove(3)
58>>> S
59Set([1, 2, 5])
Fred Drake5c4cf152002-11-13 14:59:06 +000060>>>
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000061\end{verbatim}
62
63The union and intersection of sets can be computed with the
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +000064\method{union()} and \method{intersection()} methods or
65alternatively using the bitwise operators \code{\&} and \code{|}.
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000066Mutable sets also have in-place versions of these methods,
67\method{union_update()} and \method{intersection_update()}.
68
69\begin{verbatim}
70>>> S1 = sets.Set([1,2,3])
71>>> S2 = sets.Set([4,5,6])
72>>> S1.union(S2)
73Set([1, 2, 3, 4, 5, 6])
74>>> S1 | S2 # Alternative notation
75Set([1, 2, 3, 4, 5, 6])
Fred Drake5c4cf152002-11-13 14:59:06 +000076>>> S1.intersection(S2)
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000077Set([])
78>>> S1 & S2 # Alternative notation
79Set([])
80>>> S1.union_update(S2)
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000081>>> S1
82Set([1, 2, 3, 4, 5, 6])
Fred Drake5c4cf152002-11-13 14:59:06 +000083>>>
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000084\end{verbatim}
85
86It's also possible to take the symmetric difference of two sets. This
87is the set of all elements in the union that aren't in the
88intersection. An alternative way of expressing the symmetric
89difference is that it contains all elements that are in exactly one
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +000090set. Again, there's an alternative notation (\code{\^}), and an
91in-place version with the ungainly name
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000092\method{symmetric_difference_update()}.
93
94\begin{verbatim}
95>>> S1 = sets.Set([1,2,3,4])
96>>> S2 = sets.Set([3,4,5,6])
97>>> S1.symmetric_difference(S2)
98Set([1, 2, 5, 6])
99>>> S1 ^ S2
100Set([1, 2, 5, 6])
101>>>
102\end{verbatim}
103
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000104There are also \method{issubset()} and \method{issuperset()} methods
Michael W. Hudson065f5fa2003-02-10 19:24:50 +0000105for checking whether one set is a subset or superset of another:
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +0000106
107\begin{verbatim}
108>>> S1 = sets.Set([1,2,3])
109>>> S2 = sets.Set([2,3])
110>>> S2.issubset(S1)
111True
112>>> S1.issubset(S2)
113False
114>>> S1.issuperset(S2)
115True
116>>>
117\end{verbatim}
118
119
120\begin{seealso}
121
122\seepep{218}{Adding a Built-In Set Object Type}{PEP written by Greg V. Wilson.
123Implemented by Greg V. Wilson, Alex Martelli, and GvR.}
124
125\end{seealso}
126
127
128
129%======================================================================
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000130\section{PEP 255: Simple Generators\label{section-generators}}
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000131
132In Python 2.2, generators were added as an optional feature, to be
133enabled by a \code{from __future__ import generators} directive. In
1342.3 generators no longer need to be specially enabled, and are now
135always present; this means that \keyword{yield} is now always a
136keyword. The rest of this section is a copy of the description of
137generators from the ``What's New in Python 2.2'' document; if you read
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000138it back when Python 2.2 came out, you can skip the rest of this section.
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000139
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000140You're doubtless familiar with how function calls work in Python or C.
141When you call a function, it gets a private namespace where its local
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000142variables are created. When the function reaches a \keyword{return}
143statement, the local variables are destroyed and the resulting value
144is returned to the caller. A later call to the same function will get
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000145a fresh new set of local variables. But, what if the local variables
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000146weren't thrown away on exiting a function? What if you could later
147resume the function where it left off? This is what generators
148provide; they can be thought of as resumable functions.
149
150Here's the simplest example of a generator function:
151
152\begin{verbatim}
153def generate_ints(N):
154 for i in range(N):
155 yield i
156\end{verbatim}
157
158A new keyword, \keyword{yield}, was introduced for generators. Any
159function containing a \keyword{yield} statement is a generator
160function; this is detected by Python's bytecode compiler which
Fred Drake5c4cf152002-11-13 14:59:06 +0000161compiles the function specially as a result.
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000162
163When you call a generator function, it doesn't return a single value;
164instead it returns a generator object that supports the iterator
165protocol. On executing the \keyword{yield} statement, the generator
166outputs the value of \code{i}, similar to a \keyword{return}
167statement. The big difference between \keyword{yield} and a
168\keyword{return} statement is that on reaching a \keyword{yield} the
169generator's state of execution is suspended and local variables are
170preserved. On the next call to the generator's \code{.next()} method,
171the function will resume executing immediately after the
172\keyword{yield} statement. (For complicated reasons, the
173\keyword{yield} statement isn't allowed inside the \keyword{try} block
Fred Drakeaac8c582003-01-17 22:50:10 +0000174of a \keyword{try}...\keyword{finally} statement; read \pep{255} for a full
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000175explanation of the interaction between \keyword{yield} and
176exceptions.)
177
Fred Drakeaac8c582003-01-17 22:50:10 +0000178Here's a sample usage of the \function{generate_ints()} generator:
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000179
180\begin{verbatim}
181>>> gen = generate_ints(3)
182>>> gen
183<generator object at 0x8117f90>
184>>> gen.next()
1850
186>>> gen.next()
1871
188>>> gen.next()
1892
190>>> gen.next()
191Traceback (most recent call last):
Andrew M. Kuchling9f6e1042002-06-17 13:40:04 +0000192 File "stdin", line 1, in ?
193 File "stdin", line 2, in generate_ints
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000194StopIteration
195\end{verbatim}
196
197You could equally write \code{for i in generate_ints(5)}, or
198\code{a,b,c = generate_ints(3)}.
199
200Inside a generator function, the \keyword{return} statement can only
201be used without a value, and signals the end of the procession of
202values; afterwards the generator cannot return any further values.
203\keyword{return} with a value, such as \code{return 5}, is a syntax
204error inside a generator function. The end of the generator's results
205can also be indicated by raising \exception{StopIteration} manually,
206or by just letting the flow of execution fall off the bottom of the
207function.
208
209You could achieve the effect of generators manually by writing your
210own class and storing all the local variables of the generator as
211instance variables. For example, returning a list of integers could
212be done by setting \code{self.count} to 0, and having the
213\method{next()} method increment \code{self.count} and return it.
214However, for a moderately complicated generator, writing a
215corresponding class would be much messier.
216\file{Lib/test/test_generators.py} contains a number of more
217interesting examples. The simplest one implements an in-order
218traversal of a tree using generators recursively.
219
220\begin{verbatim}
221# A recursive generator that generates Tree leaves in in-order.
222def inorder(t):
223 if t:
224 for x in inorder(t.left):
225 yield x
226 yield t.label
227 for x in inorder(t.right):
228 yield x
229\end{verbatim}
230
231Two other examples in \file{Lib/test/test_generators.py} produce
232solutions for the N-Queens problem (placing $N$ queens on an $NxN$
233chess board so that no queen threatens another) and the Knight's Tour
234(a route that takes a knight to every square of an $NxN$ chessboard
Fred Drake5c4cf152002-11-13 14:59:06 +0000235without visiting any square twice).
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000236
237The idea of generators comes from other programming languages,
238especially Icon (\url{http://www.cs.arizona.edu/icon/}), where the
239idea of generators is central. In Icon, every
240expression and function call behaves like a generator. One example
241from ``An Overview of the Icon Programming Language'' at
242\url{http://www.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of
243what this looks like:
244
245\begin{verbatim}
246sentence := "Store it in the neighboring harbor"
247if (i := find("or", sentence)) > 5 then write(i)
248\end{verbatim}
249
250In Icon the \function{find()} function returns the indexes at which the
251substring ``or'' is found: 3, 23, 33. In the \keyword{if} statement,
252\code{i} is first assigned a value of 3, but 3 is less than 5, so the
253comparison fails, and Icon retries it with the second value of 23. 23
254is greater than 5, so the comparison now succeeds, and the code prints
255the value 23 to the screen.
256
257Python doesn't go nearly as far as Icon in adopting generators as a
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000258central concept. Generators are considered part of the core
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000259Python language, but learning or using them isn't compulsory; if they
260don't solve any problems that you have, feel free to ignore them.
261One novel feature of Python's interface as compared to
262Icon's is that a generator's state is represented as a concrete object
263(the iterator) that can be passed around to other functions or stored
264in a data structure.
265
266\begin{seealso}
267
268\seepep{255}{Simple Generators}{Written by Neil Schemenauer, Tim
269Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
270and Tim Peters, with other fixes from the Python Labs crew.}
271
272\end{seealso}
273
274
275%======================================================================
Fred Drake13090e12002-08-22 16:51:08 +0000276\section{PEP 263: Source Code Encodings \label{section-encodings}}
Andrew M. Kuchling950725f2002-08-06 01:40:48 +0000277
278Python source files can now be declared as being in different
279character set encodings. Encodings are declared by including a
280specially formatted comment in the first or second line of the source
281file. For example, a UTF-8 file can be declared with:
282
283\begin{verbatim}
284#!/usr/bin/env python
285# -*- coding: UTF-8 -*-
286\end{verbatim}
287
288Without such an encoding declaration, the default encoding used is
Andrew M. Kuchlingacddabc2003-02-18 00:43:24 +00002897-bit ASCII. Executing or importing modules containing string
290literals with 8-bit characters and no encoding declaration will result
291in a \exception{DeprecationWarning} being signalled by Python 2.3; in
2922.4 this will be a syntax error.
Andrew M. Kuchling950725f2002-08-06 01:40:48 +0000293
Andrew M. Kuchlingacddabc2003-02-18 00:43:24 +0000294The encoding declaration only affects Unicode string literals, which
295will be converted to Unicode using the specified encoding. Note that
296Python identifiers are still restricted to ASCII characters, so you
297can't have variable names that use characters outside of the usual
298alphanumerics.
Andrew M. Kuchling950725f2002-08-06 01:40:48 +0000299
300\begin{seealso}
301
302\seepep{263}{Defining Python Source Code Encodings}{Written by
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000303Marc-Andr\'e Lemburg and Martin von L\"owis; implemented by SUZUKI
304Hisao and Martin von L\"owis.}
Andrew M. Kuchling950725f2002-08-06 01:40:48 +0000305
306\end{seealso}
307
308
309%======================================================================
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000310\section{PEP 277: Unicode file name support for Windows NT}
Andrew M. Kuchling0f345562002-10-04 22:34:11 +0000311
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000312On Windows NT, 2000, and XP, the system stores file names as Unicode
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000313strings. Traditionally, Python has represented file names as byte
314strings, which is inadequate because it renders some file names
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000315inaccessible.
316
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000317Python now allows using arbitrary Unicode strings (within the
318limitations of the file system) for all functions that expect file
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000319names, most notably the \function{open()} built-in function. If a Unicode
320string is passed to \function{os.listdir()}, Python now returns a list
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000321of Unicode strings. A new function, \function{os.getcwdu()}, returns
322the current directory as a Unicode string.
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000323
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000324Byte strings still work as file names, and on Windows Python will
325transparently convert them to Unicode using the \code{mbcs} encoding.
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000326
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000327Other systems also allow Unicode strings as file names but convert
328them to byte strings before passing them to the system, which can
329cause a \exception{UnicodeError} to be raised. Applications can test
330whether arbitrary Unicode strings are supported as file names by
Andrew M. Kuchlingb9ba4e62003-02-03 15:16:15 +0000331checking \member{os.path.supports_unicode_filenames}, a Boolean value.
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000332
Andrew M. Kuchling563389f2003-03-02 02:31:58 +0000333Under MacOS, \function{os.listdir()} may now return Unicode filenames.
334
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000335\begin{seealso}
336
337\seepep{277}{Unicode file name support for Windows NT}{Written by Neil
338Hodgson; implemented by Neil Hodgson, Martin von L\"owis, and Mark
339Hammond.}
340
341\end{seealso}
Andrew M. Kuchling0f345562002-10-04 22:34:11 +0000342
343
344%======================================================================
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000345\section{PEP 278: Universal Newline Support}
346
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000347The three major operating systems used today are Microsoft Windows,
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000348Apple's Macintosh OS, and the various \UNIX\ derivatives. A minor
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000349irritation is that these three platforms all use different characters
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000350to mark the ends of lines in text files. \UNIX\ uses the linefeed
351(ASCII character 10), while MacOS uses the carriage return (ASCII
352character 13), and Windows uses a two-character sequence containing a
353carriage return plus a newline.
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000354
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000355Python's file objects can now support end of line conventions other
356than the one followed by the platform on which Python is running.
Fred Drake5c4cf152002-11-13 14:59:06 +0000357Opening a file with the mode \code{'U'} or \code{'rU'} will open a file
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000358for reading in universal newline mode. All three line ending
Fred Drake5c4cf152002-11-13 14:59:06 +0000359conventions will be translated to a \character{\e n} in the strings
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000360returned by the various file methods such as \method{read()} and
Fred Drake5c4cf152002-11-13 14:59:06 +0000361\method{readline()}.
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000362
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000363Universal newline support is also used when importing modules and when
364executing a file with the \function{execfile()} function. This means
365that Python modules can be shared between all three operating systems
366without needing to convert the line-endings.
367
Fred Drake5c4cf152002-11-13 14:59:06 +0000368This feature can be disabled at compile-time by specifying
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000369\longprogramopt{without-universal-newlines} when running Python's
Fred Drake5c4cf152002-11-13 14:59:06 +0000370\program{configure} script.
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000371
372\begin{seealso}
373
Fred Drake5c4cf152002-11-13 14:59:06 +0000374\seepep{278}{Universal Newline Support}{Written
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000375and implemented by Jack Jansen.}
376
377\end{seealso}
378
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +0000379
380%======================================================================
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000381\section{PEP 279: The \function{enumerate()} Built-in Function\label{section-enumerate}}
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +0000382
383A new built-in function, \function{enumerate()}, will make
384certain loops a bit clearer. \code{enumerate(thing)}, where
385\var{thing} is either an iterator or a sequence, returns a iterator
386that will return \code{(0, \var{thing[0]})}, \code{(1,
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000387\var{thing[1]})}, \code{(2, \var{thing[2]})}, and so forth.
388
389Fairly often you'll see code to change every element of a list that
390looks like this:
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +0000391
392\begin{verbatim}
393for i in range(len(L)):
394 item = L[i]
395 # ... compute some result based on item ...
396 L[i] = result
397\end{verbatim}
398
399This can be rewritten using \function{enumerate()} as:
400
401\begin{verbatim}
402for i, item in enumerate(L):
403 # ... compute some result based on item ...
404 L[i] = result
405\end{verbatim}
406
407
408\begin{seealso}
409
Fred Drake5c4cf152002-11-13 14:59:06 +0000410\seepep{279}{The enumerate() built-in function}{Written
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000411and implemented by Raymond D. Hettinger.}
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +0000412
413\end{seealso}
414
415
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000416%======================================================================
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000417\section{PEP 282: The \module{logging} Package}
418
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000419A standard package for writing logs, \module{logging}, has been added
420to Python 2.3. It provides a powerful and flexible mechanism for
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000421components to generate logging output which can then be filtered and
422processed in various ways. A standard configuration file format can
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000423be used to control the logging behavior of a program. Python's
424standard library includes handlers that will write log records to
425standard error or to a file or socket, send them to the system log, or
426even e-mail them to a particular address, and of course it's also
427possible to write your own handler classes.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000428
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000429The \class{Logger} class is the primary class.
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000430Most application code will deal with one or more \class{Logger}
431objects, each one used by a particular subsystem of the application.
432Each \class{Logger} is identified by a name, and names are organized
433into a hierarchy using \samp{.} as the component separator. For
434example, you might have \class{Logger} instances named \samp{server},
435\samp{server.auth} and \samp{server.network}. The latter two
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000436instances are below \samp{server} in the hierarchy. This means that
437if you turn up the verbosity for \samp{server} or direct \samp{server}
438messages to a different handler, the changes will also apply to
439records logged to \samp{server.auth} and \samp{server.network}.
440There's also a root \class{Logger} that's the parent of all other
441loggers.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000442
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000443For simple uses, the \module{logging} package contains some
444convenience functions that always use the root log:
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000445
446\begin{verbatim}
447import logging
448
449logging.debug('Debugging information')
450logging.info('Informational message')
Andrew M. Kuchling37495072003-02-19 13:46:18 +0000451logging.warning('Warning:config file %s not found', 'server.conf')
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000452logging.error('Error occurred')
453logging.critical('Critical error -- shutting down')
454\end{verbatim}
455
456This produces the following output:
457
458\begin{verbatim}
Andrew M. Kuchling37495072003-02-19 13:46:18 +0000459WARNING:root:Warning:config file server.conf not found
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000460ERROR:root:Error occurred
461CRITICAL:root:Critical error -- shutting down
462\end{verbatim}
463
464In the default configuration, informational and debugging messages are
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000465suppressed and the output is sent to standard error. You can enable
466the display of information and debugging messages by calling the
467\method{setLevel()} method on the root logger.
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000468
Andrew M. Kuchling37495072003-02-19 13:46:18 +0000469Notice the \function{warning()} call's use of string formatting
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000470operators; all of the functions for logging messages take the
471arguments \code{(\var{msg}, \var{arg1}, \var{arg2}, ...)} and log the
472string resulting from \code{\var{msg} \% (\var{arg1}, \var{arg2},
473...)}.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000474
475There's also an \function{exception()} function that records the most
476recent traceback. Any of the other functions will also record the
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000477traceback if you specify a true value for the keyword argument
Fred Drakeaac8c582003-01-17 22:50:10 +0000478\var{exc_info}.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000479
480\begin{verbatim}
481def f():
482 try: 1/0
483 except: logging.exception('Problem recorded')
484
485f()
486\end{verbatim}
487
488This produces the following output:
489
490\begin{verbatim}
491ERROR:root:Problem recorded
492Traceback (most recent call last):
493 File "t.py", line 6, in f
494 1/0
495ZeroDivisionError: integer division or modulo by zero
496\end{verbatim}
497
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000498Slightly more advanced programs will use a logger other than the root
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000499logger. The \function{getLogger(\var{name})} function is used to get
500a particular log, creating it if it doesn't exist yet.
Andrew M. Kuchlingb1e4bf92002-12-03 13:35:17 +0000501\function{getLogger(None)} returns the root logger.
502
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000503
504\begin{verbatim}
505log = logging.getLogger('server')
506 ...
507log.info('Listening on port %i', port)
508 ...
509log.critical('Disk full')
510 ...
511\end{verbatim}
512
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000513Log records are usually propagated up the hierarchy, so a message
514logged to \samp{server.auth} is also seen by \samp{server} and
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +0000515\samp{root}, but a \class{Logger} can prevent this by setting its
Fred Drakeaac8c582003-01-17 22:50:10 +0000516\member{propagate} attribute to \constant{False}.
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000517
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000518There are more classes provided by the \module{logging} package that
519can be customized. When a \class{Logger} instance is told to log a
520message, it creates a \class{LogRecord} instance that is sent to any
521number of different \class{Handler} instances. Loggers and handlers
522can also have an attached list of filters, and each filter can cause
523the \class{LogRecord} to be ignored or can modify the record before
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +0000524passing it along. When they're finally output, \class{LogRecord}
525instances are converted to text by a \class{Formatter} class. All of
526these classes can be replaced by your own specially-written classes.
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000527
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000528With all of these features the \module{logging} package should provide
529enough flexibility for even the most complicated applications. This
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +0000530is only an incomplete overview of its features, so please see the
531\ulink{package's reference documentation}{../lib/module-logging.html}
532for all of the details. Reading \pep{282} will also be helpful.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000533
534
535\begin{seealso}
536
537\seepep{282}{A Logging System}{Written by Vinay Sajip and Trent Mick;
538implemented by Vinay Sajip.}
539
540\end{seealso}
541
542
543%======================================================================
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000544\section{PEP 285: The \class{bool} Type\label{section-bool}}
545
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000546A Boolean type was added to Python 2.3. Two new constants were added
547to the \module{__builtin__} module, \constant{True} and
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000548\constant{False}. (\constant{True} and
549\constant{False} constants were added to the built-ins
Michael W. Hudson065f5fa2003-02-10 19:24:50 +0000550in Python 2.2.1, but the 2.2.1 versions simply have integer values of
Andrew M. Kuchling5a224532003-01-03 16:52:27 +00005511 and 0 and aren't a different type.)
552
553The type object for this new type is named
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000554\class{bool}; the constructor for it takes any Python value and
555converts it to \constant{True} or \constant{False}.
556
557\begin{verbatim}
558>>> bool(1)
559True
560>>> bool(0)
561False
562>>> bool([])
563False
564>>> bool( (1,) )
565True
566\end{verbatim}
567
568Most of the standard library modules and built-in functions have been
569changed to return Booleans.
570
571\begin{verbatim}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000572>>> obj = []
573>>> hasattr(obj, 'append')
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000574True
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000575>>> isinstance(obj, list)
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000576True
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000577>>> isinstance(obj, tuple)
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000578False
579\end{verbatim}
580
581Python's Booleans were added with the primary goal of making code
582clearer. For example, if you're reading a function and encounter the
Fred Drake5c4cf152002-11-13 14:59:06 +0000583statement \code{return 1}, you might wonder whether the \code{1}
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000584represents a Boolean truth value, an index, or a
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000585coefficient that multiplies some other quantity. If the statement is
586\code{return True}, however, the meaning of the return value is quite
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000587clear.
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000588
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000589Python's Booleans were \emph{not} added for the sake of strict
590type-checking. A very strict language such as Pascal would also
591prevent you performing arithmetic with Booleans, and would require
592that the expression in an \keyword{if} statement always evaluate to a
593Boolean. Python is not this strict, and it never will be, as
594\pep{285} explicitly says. This means you can still use any
595expression in an \keyword{if} statement, even ones that evaluate to a
596list or tuple or some random object, and the Boolean type is a
597subclass of the \class{int} class so that arithmetic using a Boolean
598still works.
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000599
600\begin{verbatim}
601>>> True + 1
6022
603>>> False + 1
6041
605>>> False * 75
6060
607>>> True * 75
60875
609\end{verbatim}
610
611To sum up \constant{True} and \constant{False} in a sentence: they're
612alternative ways to spell the integer values 1 and 0, with the single
613difference that \function{str()} and \function{repr()} return the
Fred Drake5c4cf152002-11-13 14:59:06 +0000614strings \code{'True'} and \code{'False'} instead of \code{'1'} and
615\code{'0'}.
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000616
617\begin{seealso}
618
619\seepep{285}{Adding a bool type}{Written and implemented by GvR.}
620
621\end{seealso}
622
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000623
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000624%======================================================================
625\section{PEP 293: Codec Error Handling Callbacks}
626
Martin v. Löwis20eae692002-10-07 19:01:07 +0000627When encoding a Unicode string into a byte string, unencodable
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000628characters may be encountered. So far, Python has allowed specifying
629the error processing as either ``strict'' (raising
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000630\exception{UnicodeError}), ``ignore'' (skipping the character), or
631``replace'' (using a question mark in the output string), with
632``strict'' being the default behavior. It may be desirable to specify
633alternative processing of such errors, such as inserting an XML
634character reference or HTML entity reference into the converted
635string.
Martin v. Löwis20eae692002-10-07 19:01:07 +0000636
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +0000637Python now has a flexible framework to add different processing
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000638strategies. New error handlers can be added with
Martin v. Löwis20eae692002-10-07 19:01:07 +0000639\function{codecs.register_error}. Codecs then can access the error
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000640handler with \function{codecs.lookup_error}. An equivalent C API has
641been added for codecs written in C. The error handler gets the
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000642necessary state information such as the string being converted, the
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000643position in the string where the error was detected, and the target
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000644encoding. The handler can then either raise an exception or return a
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000645replacement string.
Martin v. Löwis20eae692002-10-07 19:01:07 +0000646
647Two additional error handlers have been implemented using this
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000648framework: ``backslashreplace'' uses Python backslash quoting to
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +0000649represent unencodable characters and ``xmlcharrefreplace'' emits
Martin v. Löwis20eae692002-10-07 19:01:07 +0000650XML character references.
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000651
652\begin{seealso}
653
Fred Drake5c4cf152002-11-13 14:59:06 +0000654\seepep{293}{Codec Error Handling Callbacks}{Written and implemented by
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000655Walter D\"orwald.}
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000656
657\end{seealso}
658
659
660%======================================================================
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000661\section{PEP 273: Importing Modules from Zip Archives}
662
663The new \module{zipimport} module adds support for importing
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000664modules from a ZIP-format archive. You don't need to import the
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000665module explicitly; it will be automatically imported if a ZIP
666archive's filename is added to \code{sys.path}. For example:
667
668\begin{verbatim}
669amk@nyman:~/src/python$ unzip -l /tmp/example.zip
670Archive: /tmp/example.zip
671 Length Date Time Name
672 -------- ---- ---- ----
673 8467 11-26-02 22:30 jwzthreading.py
674 -------- -------
675 8467 1 file
676amk@nyman:~/src/python$ ./python
677Python 2.3a0 (#1, Dec 30 2002, 19:54:32)
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000678>>> import sys
679>>> sys.path.insert(0, '/tmp/example.zip') # Add .zip file to front of path
680>>> import jwzthreading
681>>> jwzthreading.__file__
682'/tmp/example.zip/jwzthreading.py'
683>>>
684\end{verbatim}
685
686An entry in \code{sys.path} can now be the filename of a ZIP archive.
687The ZIP archive can contain any kind of files, but only files named
Fred Drakeaac8c582003-01-17 22:50:10 +0000688\file{*.py}, \file{*.pyc}, or \file{*.pyo} can be imported. If an
689archive only contains \file{*.py} files, Python will not attempt to
690modify the archive by adding the corresponding \file{*.pyc} file, meaning
691that if a ZIP archive doesn't contain \file{*.pyc} files, importing may be
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000692rather slow.
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000693
694A path within the archive can also be specified to only import from a
695subdirectory; for example, the path \file{/tmp/example.zip/lib/}
696would only import from the \file{lib/} subdirectory within the
697archive.
698
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000699\begin{seealso}
700
701\seepep{273}{Import Modules from Zip Archives}{Written by James C. Ahlstrom,
702who also provided an implementation.
703Python 2.3 follows the specification in \pep{273},
Andrew M. Kuchlingae3bbf52002-12-31 14:03:45 +0000704but uses an implementation written by Just van~Rossum
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000705that uses the import hooks described in \pep{302}.
706See section~\ref{section-pep302} for a description of the new import hooks.
707}
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000708
709\end{seealso}
710
711%======================================================================
Fred Drake693aea22003-02-07 14:52:18 +0000712\section{PEP 301: Package Index and Metadata for
713Distutils\label{section-pep301}}
Andrew M. Kuchling87cebbf2003-01-03 16:24:28 +0000714
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000715Support for the long-requested Python catalog makes its first
716appearance in 2.3.
717
Fred Drake693aea22003-02-07 14:52:18 +0000718The core component is the new Distutils \command{register} command.
719Running \code{python setup.py register} will collect the metadata
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000720describing a package, such as its name, version, maintainer,
Andrew M. Kuchlingc61402b2003-02-26 19:00:52 +0000721description, \&c., and send it to a central catalog server. The
722catalog is available from \url{http://www.python.org/pypi}.
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000723
724To make the catalog a bit more useful, a new optional
Fred Drake693aea22003-02-07 14:52:18 +0000725\var{classifiers} keyword argument has been added to the Distutils
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000726\function{setup()} function. A list of
Fred Drake693aea22003-02-07 14:52:18 +0000727\ulink{Trove}{http://catb.org/\textasciitilde esr/trove/}-style
728strings can be supplied to help classify the software.
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000729
Andrew M. Kuchlinga31bb372003-01-27 16:36:34 +0000730Here's an example \file{setup.py} with classifiers, written to be compatible
731with older versions of the Distutils:
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000732
733\begin{verbatim}
Andrew M. Kuchlinga31bb372003-01-27 16:36:34 +0000734from distutils import core
Fred Drake693aea22003-02-07 14:52:18 +0000735kw = {'name': "Quixote",
Andrew M. Kuchlinga31bb372003-01-27 16:36:34 +0000736 'version': "0.5.1",
737 'description': "A highly Pythonic Web application framework",
Fred Drake693aea22003-02-07 14:52:18 +0000738 # ...
739 }
Andrew M. Kuchlinga31bb372003-01-27 16:36:34 +0000740
Andrew M. Kuchlinga6b1c752003-04-09 17:26:38 +0000741if (hasattr(core, 'setup_keywords') and
742 'classifiers' in core.setup_keywords):
Fred Drake693aea22003-02-07 14:52:18 +0000743 kw['classifiers'] = \
744 ['Topic :: Internet :: WWW/HTTP :: Dynamic Content',
745 'Environment :: No Input/Output (Daemon)',
746 'Intended Audience :: Developers'],
Andrew M. Kuchlinga31bb372003-01-27 16:36:34 +0000747
Fred Drake693aea22003-02-07 14:52:18 +0000748core.setup(**kw)
Andrew M. Kuchling5a224532003-01-03 16:52:27 +0000749\end{verbatim}
750
751The full list of classifiers can be obtained by running
752\code{python setup.py register --list-classifiers}.
Andrew M. Kuchling87cebbf2003-01-03 16:24:28 +0000753
754\begin{seealso}
755
Fred Drake693aea22003-02-07 14:52:18 +0000756\seepep{301}{Package Index and Metadata for Distutils}{Written and
757implemented by Richard Jones.}
Andrew M. Kuchling87cebbf2003-01-03 16:24:28 +0000758
759\end{seealso}
760
761
762%======================================================================
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000763\section{PEP 302: New Import Hooks \label{section-pep302}}
764
765While it's been possible to write custom import hooks ever since the
766\module{ihooks} module was introduced in Python 1.3, no one has ever
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000767been really happy with it because writing new import hooks is
768difficult and messy. There have been various proposed alternatives
769such as the \module{imputil} and \module{iu} modules, but none of them
770has ever gained much acceptance, and none of them were easily usable
771from \C{} code.
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000772
773\pep{302} borrows ideas from its predecessors, especially from
774Gordon McMillan's \module{iu} module. Three new items
775are added to the \module{sys} module:
776
777\begin{itemize}
Andrew M. Kuchlingd5ac8d02003-01-02 21:33:15 +0000778 \item \code{sys.path_hooks} is a list of callable objects; most
Fred Drakeaac8c582003-01-17 22:50:10 +0000779 often they'll be classes. Each callable takes a string containing a
780 path and either returns an importer object that will handle imports
781 from this path or raises an \exception{ImportError} exception if it
782 can't handle this path.
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000783
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000784 \item \code{sys.path_importer_cache} caches importer objects for
Fred Drakeaac8c582003-01-17 22:50:10 +0000785 each path, so \code{sys.path_hooks} will only need to be traversed
786 once for each path.
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000787
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000788 \item \code{sys.meta_path} is a list of importer objects that will
789 be traversed before \code{sys.path} is checked. This list is
790 initially empty, but user code can add objects to it. Additional
791 built-in and frozen modules can be imported by an object added to
792 this list.
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000793
794\end{itemize}
795
796Importer objects must have a single method,
797\method{find_module(\var{fullname}, \var{path}=None)}. \var{fullname}
798will be a module or package name, e.g. \samp{string} or
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000799\samp{distutils.core}. \method{find_module()} must return a loader object
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000800that has a single method, \method{load_module(\var{fullname})}, that
801creates and returns the corresponding module object.
802
803Pseudo-code for Python's new import logic, therefore, looks something
804like this (simplified a bit; see \pep{302} for the full details):
805
806\begin{verbatim}
807for mp in sys.meta_path:
808 loader = mp(fullname)
809 if loader is not None:
Andrew M. Kuchlingd5ac8d02003-01-02 21:33:15 +0000810 <module> = loader.load_module(fullname)
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000811
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000812for path in sys.path:
813 for hook in sys.path_hooks:
Andrew M. Kuchlingd5ac8d02003-01-02 21:33:15 +0000814 try:
815 importer = hook(path)
816 except ImportError:
817 # ImportError, so try the other path hooks
818 pass
819 else:
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000820 loader = importer.find_module(fullname)
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000821 <module> = loader.load_module(fullname)
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000822
823# Not found!
824raise ImportError
825\end{verbatim}
826
827\begin{seealso}
828
829\seepep{302}{New Import Hooks}{Written by Just van~Rossum and Paul Moore.
Andrew M. Kuchlingae3bbf52002-12-31 14:03:45 +0000830Implemented by Just van~Rossum.
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +0000831}
832
833\end{seealso}
834
835
836%======================================================================
Andrew M. Kuchlinga978e102003-03-21 18:10:12 +0000837\section{PEP 305: Comma-separated Files \label{section-pep305}}
838
839Comma-separated files are a format frequently used for exporting data
840from databases and spreadsheets. Python 2.3 adds a parser for
841comma-separated files.
842The format is deceptively simple at first glance:
843
844\begin{verbatim}
845Costs,150,200,3.95
846\end{verbatim}
847
848Read a line and call \code{line.split(',')}: what could be simpler?
849But toss in string data that can contain commas, and things get more
850complicated:
851
852\begin{verbatim}
853"Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"
854\end{verbatim}
855
856A big ugly regular expression can parse this, but using the new
857\module{csv} package is much simpler:
858
859\begin{verbatim}
Andrew M. Kuchlingba887bb2003-04-13 21:13:02 +0000860import csv
Andrew M. Kuchlinga978e102003-03-21 18:10:12 +0000861
862input = open('datafile', 'rb')
863reader = csv.reader(input)
864for line in reader:
865 print line
866\end{verbatim}
867
868The \function{reader} function takes a number of different options.
869The field separator isn't limited to the comma and can be changed to
870any character, and so can the quoting and line-ending characters.
871
872Different dialects of comma-separated files can be defined and
873registered; currently there are two, both for Microsoft Excel.
874A separate \class{csv.writer} class will generate comma-separated files
875from a succession of tuples or lists, quoting strings that contain the
876delimiter.
877
878\begin{seealso}
879
880\seepep{305}{CSV File API}{Written and implemented
881by Kevin Altis, Dave Cole, Andrew McNamara, Skip Montanaro, Cliff Wells.
882}
883
884\end{seealso}
885
886%======================================================================
Andrew M. Kuchlinga092ba12003-03-21 18:32:43 +0000887\section{PEP 307: Pickle Enhancements \label{section-pep305}}
888
889The \module{pickle} and \module{cPickle} modules received some
890attention during the 2.3 development cycle. In 2.2, new-style classes
Andrew M. Kuchlinga6b1c752003-04-09 17:26:38 +0000891could be pickled without difficulty, but they weren't pickled very
Andrew M. Kuchlinga092ba12003-03-21 18:32:43 +0000892compactly; \pep{307} quotes a trivial example where a new-style class
893results in a pickled string three times longer than that for a classic
894class.
895
896The solution was to invent a new pickle protocol. The
897\function{pickle.dumps()} function has supported a text-or-binary flag
898for a long time. In 2.3, this flag is redefined from a Boolean to an
899integer; 0 is the old text-mode pickle format, 1 is the old binary
900format, and now 2 is a new 2.3-specific format. (A new constant,
901\constant{pickle.HIGHEST_PROTOCOL}, can be used to select the fanciest
902protocol available.)
903
904Unpickling is no longer considered a safe operation. 2.2's
905\module{pickle} provided hooks for trying to prevent unsafe classes
906from being unpickled (specifically, a
907\member{__safe_for_unpickling__} attribute), but none of this code
908was ever audited and therefore it's all been ripped out in 2.3. You
909should not unpickle untrusted data in any version of Python.
910
911To reduce the pickling overhead for new-style classes, a new interface
912for customizing pickling was added using three special methods:
913\method{__getstate__}, \method{__setstate__}, and
914\method{__getnewargs__}. Consult \pep{307} for the full semantics
915of these methods.
916
917As a way to compress pickles yet further, it's now possible to use
918integer codes instead of long strings to identify pickled classes.
919The Python Software Foundation will maintain a list of standardized
920codes; there's also a range of codes for private use. Currently no
921codes have been specified.
922
923\begin{seealso}
924
925\seepep{307}{Extensions to the pickle protocol}{Written and implemented
926by Guido van Rossum and Tim Peters.}
927
928\end{seealso}
929
930%======================================================================
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000931\section{Extended Slices\label{section-slices}}
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000932
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000933Ever since Python 1.4, the slicing syntax has supported an optional
934third ``step'' or ``stride'' argument. For example, these are all
935legal Python syntax: \code{L[1:10:2]}, \code{L[:-1:1]},
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000936\code{L[::-1]}. This was added to Python at the request of
937the developers of Numerical Python, which uses the third argument
938extensively. However, Python's built-in list, tuple, and string
939sequence types have never supported this feature, and you got a
940\exception{TypeError} if you tried it. Michael Hudson contributed a
941patch to fix this shortcoming.
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000942
943For example, you can now easily extract the elements of a list that
944have even indexes:
Fred Drakedf872a22002-07-03 12:02:01 +0000945
946\begin{verbatim}
947>>> L = range(10)
948>>> L[::2]
949[0, 2, 4, 6, 8]
950\end{verbatim}
951
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000952Negative values also work to make a copy of the same list in reverse
953order:
Fred Drakedf872a22002-07-03 12:02:01 +0000954
955\begin{verbatim}
956>>> L[::-1]
957[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
958\end{verbatim}
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000959
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000960This also works for tuples, arrays, and strings:
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000961
962\begin{verbatim}
963>>> s='abcd'
964>>> s[::2]
965'ac'
966>>> s[::-1]
967'dcba'
968\end{verbatim}
969
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000970If you have a mutable sequence such as a list or an array you can
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000971assign to or delete an extended slice, but there are some differences
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000972between assignment to extended and regular slices. Assignment to a
973regular slice can be used to change the length of the sequence:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000974
975\begin{verbatim}
976>>> a = range(3)
977>>> a
978[0, 1, 2]
979>>> a[1:3] = [4, 5, 6]
980>>> a
981[0, 4, 5, 6]
982\end{verbatim}
983
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000984Extended slices aren't this flexible. When assigning to an extended
985slice the list on the right hand side of the statement must contain
986the same number of items as the slice it is replacing:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000987
988\begin{verbatim}
989>>> a = range(4)
990>>> a
991[0, 1, 2, 3]
992>>> a[::2]
993[0, 2]
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000994>>> a[::2] = [0, -1]
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000995>>> a
996[0, 1, -1, 3]
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +0000997>>> a[::2] = [0,1,2]
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000998Traceback (most recent call last):
999 File "<stdin>", line 1, in ?
Raymond Hettingeree1bded2003-01-17 16:20:23 +00001000ValueError: attempt to assign sequence of size 3 to extended slice of size 2
Michael W. Hudson4da01ed2002-07-19 15:48:56 +00001001\end{verbatim}
1002
1003Deletion is more straightforward:
1004
1005\begin{verbatim}
1006>>> a = range(4)
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001007>>> a
1008[0, 1, 2, 3]
Michael W. Hudson4da01ed2002-07-19 15:48:56 +00001009>>> a[::2]
1010[0, 2]
1011>>> del a[::2]
1012>>> a
1013[1, 3]
1014\end{verbatim}
1015
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001016One can also now pass slice objects to the
1017\method{__getitem__} methods of the built-in sequences:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +00001018
1019\begin{verbatim}
1020>>> range(10).__getitem__(slice(0, 5, 2))
1021[0, 2, 4]
1022\end{verbatim}
1023
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001024Or use slice objects directly in subscripts:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +00001025
1026\begin{verbatim}
1027>>> range(10)[slice(0, 5, 2)]
1028[0, 2, 4]
1029\end{verbatim}
1030
Andrew M. Kuchlingb6f79592002-11-29 19:43:45 +00001031To simplify implementing sequences that support extended slicing,
1032slice objects now have a method \method{indices(\var{length})} which,
Fred Drakeaac8c582003-01-17 22:50:10 +00001033given the length of a sequence, returns a \code{(\var{start},
1034\var{stop}, \var{step})} tuple that can be passed directly to
1035\function{range()}.
Andrew M. Kuchlingb6f79592002-11-29 19:43:45 +00001036\method{indices()} handles omitted and out-of-bounds indices in a
1037manner consistent with regular slices (and this innocuous phrase hides
1038a welter of confusing details!). The method is intended to be used
1039like this:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +00001040
1041\begin{verbatim}
1042class FakeSeq:
1043 ...
1044 def calc_item(self, i):
1045 ...
1046 def __getitem__(self, item):
1047 if isinstance(item, slice):
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001048 indices = item.indices(len(self))
1049 return FakeSeq([self.calc_item(i) in range(*indices)])
Fred Drake5c4cf152002-11-13 14:59:06 +00001050 else:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +00001051 return self.calc_item(i)
1052\end{verbatim}
1053
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001054From this example you can also see that the built-in \class{slice}
Andrew M. Kuchling90e9a792002-08-15 00:40:21 +00001055object is now the type object for the slice type, and is no longer a
1056function. This is consistent with Python 2.2, where \class{int},
1057\class{str}, etc., underwent the same change.
1058
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001059
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +00001060%======================================================================
Fred Drakedf872a22002-07-03 12:02:01 +00001061\section{Other Language Changes}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001062
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001063Here are all of the changes that Python 2.3 makes to the core Python
1064language.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001065
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001066\begin{itemize}
1067\item The \keyword{yield} statement is now always a keyword, as
1068described in section~\ref{section-generators} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001069
Fred Drake5c4cf152002-11-13 14:59:06 +00001070\item A new built-in function \function{enumerate()}
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001071was added, as described in section~\ref{section-enumerate} of this
1072document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001073
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001074\item Two new constants, \constant{True} and \constant{False} were
1075added along with the built-in \class{bool} type, as described in
1076section~\ref{section-bool} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001077
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00001078\item The \function{int()} type constructor will now return a long
1079integer instead of raising an \exception{OverflowError} when a string
1080or floating-point number is too large to fit into an integer. This
1081can lead to the paradoxical result that
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001082\code{isinstance(int(\var{expression}), int)} is false, but that seems
1083unlikely to cause problems in practice.
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00001084
Fred Drake5c4cf152002-11-13 14:59:06 +00001085\item Built-in types now support the extended slicing syntax,
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001086as described in section~\ref{section-slices} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001087
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00001088\item Dictionaries have a new method, \method{pop(\var{key}\optional{,
1089\var{default}})}, that returns the value corresponding to \var{key}
1090and removes that key/value pair from the dictionary. If the requested
1091key isn't present in the dictionary, \var{default} is returned if
1092it's specified and \exception{KeyError} raised if it isn't.
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001093
1094\begin{verbatim}
1095>>> d = {1:2}
1096>>> d
1097{1: 2}
1098>>> d.pop(4)
1099Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +00001100 File "stdin", line 1, in ?
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001101KeyError: 4
1102>>> d.pop(1)
11032
1104>>> d.pop(1)
1105Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +00001106 File "stdin", line 1, in ?
Raymond Hettingeree1bded2003-01-17 16:20:23 +00001107KeyError: 'pop(): dictionary is empty'
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001108>>> d
1109{}
1110>>>
1111\end{verbatim}
1112
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001113There's also a new class method,
1114\method{dict.fromkeys(\var{iterable}, \var{value})}, that
1115creates a dictionary with keys taken from the supplied iterator
1116\var{iterable} and all values set to \var{value}, defaulting to
1117\code{None}.
1118
1119(Patches contributed by Raymond Hettinger.)
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001120
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001121Also, the \function{dict()} constructor now accepts keyword arguments to
Raymond Hettinger45bda572002-12-14 20:20:45 +00001122simplify creating small dictionaries:
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001123
1124\begin{verbatim}
1125>>> dict(red=1, blue=2, green=3, black=4)
1126{'blue': 2, 'black': 4, 'green': 3, 'red': 1}
1127\end{verbatim}
1128
Andrew M. Kuchlingae3bbf52002-12-31 14:03:45 +00001129(Contributed by Just van~Rossum.)
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001130
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00001131\item The \keyword{assert} statement no longer checks the \code{__debug__}
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001132flag, so you can no longer disable assertions by assigning to \code{__debug__}.
Fred Drake5c4cf152002-11-13 14:59:06 +00001133Running Python with the \programopt{-O} switch will still generate
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001134code that doesn't execute any assertions.
1135
1136\item Most type objects are now callable, so you can use them
1137to create new objects such as functions, classes, and modules. (This
1138means that the \module{new} module can be deprecated in a future
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001139Python version, because you can now use the type objects available in
1140the \module{types} module.)
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001141% XXX should new.py use PendingDeprecationWarning?
1142For example, you can create a new module object with the following code:
1143
1144\begin{verbatim}
1145>>> import types
1146>>> m = types.ModuleType('abc','docstring')
1147>>> m
1148<module 'abc' (built-in)>
1149>>> m.__doc__
1150'docstring'
1151\end{verbatim}
1152
Fred Drake5c4cf152002-11-13 14:59:06 +00001153\item
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001154A new warning, \exception{PendingDeprecationWarning} was added to
1155indicate features which are in the process of being
1156deprecated. The warning will \emph{not} be printed by default. To
1157check for use of features that will be deprecated in the future,
1158supply \programopt{-Walways::PendingDeprecationWarning::} on the
1159command line or use \function{warnings.filterwarnings()}.
1160
Andrew M. Kuchlingc1dd1742003-01-13 13:59:22 +00001161\item The process of deprecating string-based exceptions, as
1162in \code{raise "Error occurred"}, has begun. Raising a string will
1163now trigger \exception{PendingDeprecationWarning}.
1164
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001165\item Using \code{None} as a variable name will now result in a
1166\exception{SyntaxWarning} warning. In a future version of Python,
1167\code{None} may finally become a keyword.
1168
Andrew M. Kuchlingb60ea3f2002-11-15 14:37:10 +00001169\item The method resolution order used by new-style classes has
1170changed, though you'll only notice the difference if you have a really
1171complicated inheritance hierarchy. (Classic classes are unaffected by
1172this change.) Python 2.2 originally used a topological sort of a
1173class's ancestors, but 2.3 now uses the C3 algorithm as described in
Andrew M. Kuchling6f429c32002-11-19 13:09:00 +00001174the paper \ulink{``A Monotonic Superclass Linearization for
1175Dylan''}{http://www.webcom.com/haahr/dylan/linearization-oopsla96.html}.
Andrew M. Kuchlingc1dd1742003-01-13 13:59:22 +00001176To understand the motivation for this change,
1177read Michele Simionato's article
Fred Drake693aea22003-02-07 14:52:18 +00001178\ulink{``Python 2.3 Method Resolution Order''}
Andrew M. Kuchlingb8a39052003-02-07 20:22:33 +00001179 {http://www.python.org/2.3/mro.html}, or
Andrew M. Kuchlingc1dd1742003-01-13 13:59:22 +00001180read the thread on python-dev starting with the message at
Andrew M. Kuchlingb60ea3f2002-11-15 14:37:10 +00001181\url{http://mail.python.org/pipermail/python-dev/2002-October/029035.html}.
1182Samuele Pedroni first pointed out the problem and also implemented the
1183fix by coding the C3 algorithm.
1184
Andrew M. Kuchlingdcfd8252002-09-13 22:21:42 +00001185\item Python runs multithreaded programs by switching between threads
1186after executing N bytecodes. The default value for N has been
1187increased from 10 to 100 bytecodes, speeding up single-threaded
1188applications by reducing the switching overhead. Some multithreaded
1189applications may suffer slower response time, but that's easily fixed
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001190by setting the limit back to a lower number using
Andrew M. Kuchlingdcfd8252002-09-13 22:21:42 +00001191\function{sys.setcheckinterval(\var{N})}.
1192
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001193\item One minor but far-reaching change is that the names of extension
1194types defined by the modules included with Python now contain the
Fred Drake5c4cf152002-11-13 14:59:06 +00001195module and a \character{.} in front of the type name. For example, in
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001196Python 2.2, if you created a socket and printed its
1197\member{__class__}, you'd get this output:
1198
1199\begin{verbatim}
1200>>> s = socket.socket()
1201>>> s.__class__
1202<type 'socket'>
1203\end{verbatim}
1204
1205In 2.3, you get this:
1206\begin{verbatim}
1207>>> s.__class__
1208<type '_socket.socket'>
1209\end{verbatim}
1210
Michael W. Hudson96bc3b42002-11-26 14:48:23 +00001211\item One of the noted incompatibilities between old- and new-style
1212 classes has been removed: you can now assign to the
1213 \member{__name__} and \member{__bases__} attributes of new-style
1214 classes. There are some restrictions on what can be assigned to
1215 \member{__bases__} along the lines of those relating to assigning to
1216 an instance's \member{__class__} attribute.
1217
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001218\end{itemize}
1219
1220
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001221%======================================================================
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001222\subsection{String Changes}
1223
1224\begin{itemize}
1225
Fred Drakeaac8c582003-01-17 22:50:10 +00001226\item The \keyword{in} operator now works differently for strings.
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001227Previously, when evaluating \code{\var{X} in \var{Y}} where \var{X}
1228and \var{Y} are strings, \var{X} could only be a single character.
1229That's now changed; \var{X} can be a string of any length, and
1230\code{\var{X} in \var{Y}} will return \constant{True} if \var{X} is a
1231substring of \var{Y}. If \var{X} is the empty string, the result is
1232always \constant{True}.
1233
1234\begin{verbatim}
1235>>> 'ab' in 'abcd'
1236True
1237>>> 'ad' in 'abcd'
1238False
1239>>> '' in 'abcd'
1240True
1241\end{verbatim}
1242
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001243Note that this doesn't tell you where the substring starts; if you
1244need that information, you must use the \method{find()} method
1245instead.
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001246
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001247\item The \method{strip()}, \method{lstrip()}, and \method{rstrip()}
1248string methods now have an optional argument for specifying the
1249characters to strip. The default is still to remove all whitespace
1250characters:
1251
1252\begin{verbatim}
1253>>> ' abc '.strip()
1254'abc'
1255>>> '><><abc<><><>'.strip('<>')
1256'abc'
1257>>> '><><abc<><><>\n'.strip('<>')
1258'abc<><><>\n'
1259>>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
1260u'\u4001abc'
1261>>>
1262\end{verbatim}
1263
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001264(Suggested by Simon Brunning and implemented by Walter D\"orwald.)
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00001265
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001266\item The \method{startswith()} and \method{endswith()}
1267string methods now accept negative numbers for the start and end
1268parameters.
1269
1270\item Another new string method is \method{zfill()}, originally a
1271function in the \module{string} module. \method{zfill()} pads a
1272numeric string with zeros on the left until it's the specified width.
1273Note that the \code{\%} operator is still more flexible and powerful
1274than \method{zfill()}.
1275
1276\begin{verbatim}
1277>>> '45'.zfill(4)
1278'0045'
1279>>> '12345'.zfill(4)
1280'12345'
1281>>> 'goofy'.zfill(6)
1282'0goofy'
1283\end{verbatim}
1284
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00001285(Contributed by Walter D\"orwald.)
1286
Fred Drake5c4cf152002-11-13 14:59:06 +00001287\item A new type object, \class{basestring}, has been added.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001288 Both 8-bit strings and Unicode strings inherit from this type, so
1289 \code{isinstance(obj, basestring)} will return \constant{True} for
1290 either kind of string. It's a completely abstract type, so you
1291 can't create \class{basestring} instances.
1292
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001293\item Interned strings are no longer immortal, and will now be
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001294garbage-collected in the usual way when the only reference to them is
1295from the internal dictionary of interned strings. (Implemented by
1296Oren Tirosh.)
1297
1298\end{itemize}
1299
1300
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001301%======================================================================
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001302\subsection{Optimizations}
1303
1304\begin{itemize}
1305
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001306\item The creation of new-style class instances has been made much
1307faster; they're now faster than classic classes!
1308
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001309\item The \method{sort()} method of list objects has been extensively
1310rewritten by Tim Peters, and the implementation is significantly
1311faster.
1312
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001313\item Multiplication of large long integers is now much faster thanks
1314to an implementation of Karatsuba multiplication, an algorithm that
1315scales better than the O(n*n) required for the grade-school
1316multiplication algorithm. (Original patch by Christopher A. Craig,
1317and significantly reworked by Tim Peters.)
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001318
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001319\item The \code{SET_LINENO} opcode is now gone. This may provide a
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001320small speed increase, depending on your compiler's idiosyncrasies.
1321See section~\ref{section-other} for a longer explanation.
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001322(Removed by Michael Hudson.)
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001323
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001324\item \function{xrange()} objects now have their own iterator, making
1325\code{for i in xrange(n)} slightly faster than
1326\code{for i in range(n)}. (Patch by Raymond Hettinger.)
1327
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001328\item A number of small rearrangements have been made in various
1329hotspots to improve performance, inlining a function here, removing
1330some code there. (Implemented mostly by GvR, but lots of people have
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001331contributed single changes.)
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001332
1333\end{itemize}
Neal Norwitzd68f5172002-05-29 15:54:55 +00001334
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001335
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001336%======================================================================
Andrew M. Kuchlingef893fe2003-01-06 20:04:17 +00001337\section{New, Improved, and Deprecated Modules}
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001338
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001339As usual, Python's standard library received a number of enhancements and
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001340bug fixes. Here's a partial list of the most notable changes, sorted
1341alphabetically by module name. Consult the
1342\file{Misc/NEWS} file in the source tree for a more
1343complete list of changes, or look through the CVS logs for all the
1344details.
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001345
1346\begin{itemize}
1347
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001348\item The \module{array} module now supports arrays of Unicode
Fred Drake5c4cf152002-11-13 14:59:06 +00001349characters using the \character{u} format character. Arrays also now
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001350support using the \code{+=} assignment operator to add another array's
1351contents, and the \code{*=} assignment operator to repeat an array.
1352(Contributed by Jason Orendorff.)
1353
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001354\item The \module{bsddb} module has been replaced by version 4.1.1
Andrew M. Kuchling669249e2002-11-19 13:05:33 +00001355of the \ulink{PyBSDDB}{http://pybsddb.sourceforge.net} package,
1356providing a more complete interface to the transactional features of
1357the BerkeleyDB library.
1358The old version of the module has been renamed to
1359\module{bsddb185} and is no longer built automatically; you'll
1360have to edit \file{Modules/Setup} to enable it. Note that the new
1361\module{bsddb} package is intended to be compatible with the
1362old module, so be sure to file bugs if you discover any
Skip Montanaro959c7722003-03-07 15:45:15 +00001363incompatibilities. When upgrading to Python 2.3, if you also change
1364the underlying BerkeleyDB library, you will almost certainly have to
1365convert your database files to the new version. You can do this
1366fairly easily with the new scripts \file{db2pickle.py} and
1367\file{pickle2db.py} which you will find in the distribution's
1368Tools/scripts directory. If you've already been using the PyBSDDB
1369package, importing it as \module{bsddb3}, you will have to change your
1370\code{import} statements.
Andrew M. Kuchling669249e2002-11-19 13:05:33 +00001371
Fred Drake5c4cf152002-11-13 14:59:06 +00001372\item The Distutils \class{Extension} class now supports
1373an extra constructor argument named \var{depends} for listing
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001374additional source files that an extension depends on. This lets
1375Distutils recompile the module if any of the dependency files are
Fred Drake5c4cf152002-11-13 14:59:06 +00001376modified. For example, if \file{sampmodule.c} includes the header
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001377file \file{sample.h}, you would create the \class{Extension} object like
1378this:
1379
1380\begin{verbatim}
1381ext = Extension("samp",
1382 sources=["sampmodule.c"],
1383 depends=["sample.h"])
1384\end{verbatim}
1385
1386Modifying \file{sample.h} would then cause the module to be recompiled.
1387(Contributed by Jeremy Hylton.)
1388
Andrew M. Kuchlingdc3f7e12002-11-04 20:05:10 +00001389\item Other minor changes to Distutils:
1390it now checks for the \envvar{CC}, \envvar{CFLAGS}, \envvar{CPP},
1391\envvar{LDFLAGS}, and \envvar{CPPFLAGS} environment variables, using
1392them to override the settings in Python's configuration (contributed
Andrew M. Kuchlinga31bb372003-01-27 16:36:34 +00001393by Robert Weber).
Andrew M. Kuchlingdc3f7e12002-11-04 20:05:10 +00001394
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001395\item The \module{getopt} module gained a new function,
1396\function{gnu_getopt()}, that supports the same arguments as the existing
Fred Drake5c4cf152002-11-13 14:59:06 +00001397\function{getopt()} function but uses GNU-style scanning mode.
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001398The existing \function{getopt()} stops processing options as soon as a
1399non-option argument is encountered, but in GNU-style mode processing
1400continues, meaning that options and arguments can be mixed. For
1401example:
1402
1403\begin{verbatim}
1404>>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1405([('-f', 'filename')], ['output', '-v'])
1406>>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1407([('-f', 'filename'), ('-v', '')], ['output'])
1408\end{verbatim}
1409
1410(Contributed by Peter \AA{strand}.)
1411
1412\item The \module{grp}, \module{pwd}, and \module{resource} modules
Fred Drake5c4cf152002-11-13 14:59:06 +00001413now return enhanced tuples:
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001414
1415\begin{verbatim}
1416>>> import grp
1417>>> g = grp.getgrnam('amk')
1418>>> g.gr_name, g.gr_gid
1419('amk', 500)
1420\end{verbatim}
1421
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001422\item The \module{gzip} module can now handle files exceeding 2~Gb.
1423
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001424\item The new \module{heapq} module contains an implementation of a
1425heap queue algorithm. A heap is an array-like data structure that
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001426keeps items in a partially sorted order such that, for every index
1427\var{k}, \code{heap[\var{k}] <= heap[2*\var{k}+1]} and
1428\code{heap[\var{k}] <= heap[2*\var{k}+2]}. This makes it quick to
1429remove the smallest item, and inserting a new item while maintaining
1430the heap property is O(lg~n). (See
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001431\url{http://www.nist.gov/dads/HTML/priorityque.html} for more
1432information about the priority queue data structure.)
1433
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001434The \module{heapq} module provides \function{heappush()} and
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001435\function{heappop()} functions for adding and removing items while
1436maintaining the heap property on top of some other mutable Python
1437sequence type. For example:
1438
1439\begin{verbatim}
1440>>> import heapq
1441>>> heap = []
1442>>> for item in [3, 7, 5, 11, 1]:
1443... heapq.heappush(heap, item)
1444...
1445>>> heap
1446[1, 3, 5, 11, 7]
1447>>> heapq.heappop(heap)
14481
1449>>> heapq.heappop(heap)
14503
1451>>> heap
1452[5, 7, 11]
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001453\end{verbatim}
1454
1455(Contributed by Kevin O'Connor.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001456
Andrew M. Kuchling87cebbf2003-01-03 16:24:28 +00001457\item The \module{imaplib} module now supports IMAP over SSL.
1458(Contributed by Piers Lauder and Tino Lange.)
1459
Andrew M. Kuchling41c3e002003-03-02 02:13:52 +00001460\item The \module{itertools} contains a number of useful functions for
1461use with iterators, inspired by various functions provided by the ML
1462and Haskell languages. For example,
1463\code{itertools.ifilter(predicate, iterator)} returns all elements in
1464the iterator for which the function \function{predicate()} returns
Andrew M. Kuchling563389f2003-03-02 02:31:58 +00001465\constant{True}, and \code{itertools.repeat(obj, \var{N})} returns
Andrew M. Kuchling41c3e002003-03-02 02:13:52 +00001466\code{obj} \var{N} times. There are a number of other functions in
1467the module; see the \ulink{package's reference
1468documentation}{../lib/module-itertools.html} for details.
Raymond Hettinger5284b442003-03-09 07:19:38 +00001469(Contributed by Raymond Hettinger.)
Fred Drakecade7132003-02-19 16:08:08 +00001470
Fred Drake5c4cf152002-11-13 14:59:06 +00001471\item Two new functions in the \module{math} module,
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001472\function{degrees(\var{rads})} and \function{radians(\var{degs})},
Fred Drake5c4cf152002-11-13 14:59:06 +00001473convert between radians and degrees. Other functions in the
Andrew M. Kuchling8e5b53b2002-12-15 20:17:38 +00001474\module{math} module such as \function{math.sin()} and
1475\function{math.cos()} have always required input values measured in
1476radians. Also, an optional \var{base} argument was added to
1477\function{math.log()} to make it easier to compute logarithms for
1478bases other than \code{e} and \code{10}. (Contributed by Raymond
1479Hettinger.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001480
Andrew M. Kuchlingae3bbf52002-12-31 14:03:45 +00001481\item Several new functions (\function{getpgid()}, \function{killpg()},
1482\function{lchown()}, \function{loadavg()}, \function{major()}, \function{makedev()},
1483\function{minor()}, and \function{mknod()}) were added to the
Andrew M. Kuchlingc309cca2002-10-10 16:04:08 +00001484\module{posix} module that underlies the \module{os} module.
Andrew M. Kuchlingae3bbf52002-12-31 14:03:45 +00001485(Contributed by Gustavo Niemeyer, Geert Jansen, and Denis S. Otkidach.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001486
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001487\item In the \module{os} module, the \function{*stat()} family of functions can now report
1488fractions of a second in a timestamp. Such time stamps are
1489represented as floats, similar to \function{time.time()}.
1490
1491During testing, it was found that some applications will break if time
1492stamps are floats. For compatibility, when using the tuple interface
1493of the \class{stat_result} time stamps will be represented as integers.
1494When using named fields (a feature first introduced in Python 2.2),
1495time stamps are still represented as integers, unless
1496\function{os.stat_float_times()} is invoked to enable float return
1497values:
1498
1499\begin{verbatim}
1500>>> os.stat("/tmp").st_mtime
15011034791200
1502>>> os.stat_float_times(True)
1503>>> os.stat("/tmp").st_mtime
15041034791200.6335014
1505\end{verbatim}
1506
1507In Python 2.4, the default will change to always returning floats.
1508
1509Application developers should enable this feature only if all their
1510libraries work properly when confronted with floating point time
1511stamps, or if they use the tuple API. If used, the feature should be
1512activated on an application level instead of trying to enable it on a
1513per-use basis.
1514
Andrew M. Kuchling53262572002-12-01 14:00:21 +00001515\item The old and never-documented \module{linuxaudiodev} module has
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001516been deprecated, and a new version named \module{ossaudiodev} has been
1517added. The module was renamed because the OSS sound drivers can be
1518used on platforms other than Linux, and the interface has also been
1519tidied and brought up to date in various ways. (Contributed by Greg
Greg Wardaa1d3aa2003-01-03 18:03:21 +00001520Ward and Nicholas FitzRoy-Dale.)
Andrew M. Kuchling53262572002-12-01 14:00:21 +00001521
Fred Drake5c4cf152002-11-13 14:59:06 +00001522\item The parser objects provided by the \module{pyexpat} module
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001523can now optionally buffer character data, resulting in fewer calls to
1524your character data handler and therefore faster performance. Setting
Fred Drake5c4cf152002-11-13 14:59:06 +00001525the parser object's \member{buffer_text} attribute to \constant{True}
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001526will enable buffering.
1527
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001528\item The \function{sample(\var{population}, \var{k})} function was
1529added to the \module{random} module. \var{population} is a sequence
Fred Drakeaac8c582003-01-17 22:50:10 +00001530or \class{xrange} object containing the elements of a population, and
1531\function{sample()}
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001532chooses \var{k} elements from the population without replacing chosen
1533elements. \var{k} can be any value up to \code{len(\var{population})}.
1534For example:
1535
1536\begin{verbatim}
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001537>>> days = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'St', 'Sn']
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001538>>> random.sample(days, 3) # Choose 3 elements
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001539['St', 'Sn', 'Th']
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001540>>> random.sample(days, 7) # Choose 7 elements
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001541['Tu', 'Th', 'Mo', 'We', 'St', 'Fr', 'Sn']
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001542>>> random.sample(days, 7) # Choose 7 again
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001543['We', 'Mo', 'Sn', 'Fr', 'Tu', 'St', 'Th']
Michael W. Hudsoncfd38842002-12-17 16:15:34 +00001544>>> random.sample(days, 8) # Can't choose eight
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001545Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +00001546 File "<stdin>", line 1, in ?
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001547 File "random.py", line 414, in sample
1548 raise ValueError, "sample larger than population"
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001549ValueError: sample larger than population
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001550>>> random.sample(xrange(1,10000,2), 10) # Choose ten odd nos. under 10000
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001551[3407, 3805, 1505, 7023, 2401, 2267, 9733, 3151, 8083, 9195]
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001552\end{verbatim}
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001553
1554The \module{random} module now uses a new algorithm, the Mersenne
1555Twister, implemented in C. It's faster and more extensively studied
1556than the previous algorithm.
1557
1558(All changes contributed by Raymond Hettinger.)
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001559
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001560\item The \module{readline} module also gained a number of new
1561functions: \function{get_history_item()},
1562\function{get_current_history_length()}, and \function{redisplay()}.
1563
Andrew M. Kuchlingef893fe2003-01-06 20:04:17 +00001564\item The \module{rexec} and \module{Bastion} modules have been
1565declared dead, and attempts to import them will fail with a
1566\exception{RuntimeError}. New-style classes provide new ways to break
1567out of the restricted execution environment provided by
1568\module{rexec}, and no one has interest in fixing them or time to do
1569so. If you have applications using \module{rexec}, rewrite them to
1570use something else.
1571
1572(Sticking with Python 2.2 or 2.1 will not make your applications any
1573safer, because there are known bugs in the \module{rexec} module in
1574those versions. I repeat, if you're using \module{rexec}, stop using
1575it immediately.)
1576
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001577\item The \module{shutil} module gained a \function{move(\var{src},
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001578\var{dest})} function that recursively moves a file or directory to a new
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001579location.
1580
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001581\item Support for more advanced POSIX signal handling was added
Michael W. Hudson43ed43b2003-03-13 13:56:53 +00001582to the \module{signal} but then removed again as it proved impossible
1583to make it work reliably across platforms.
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001584
1585\item The \module{socket} module now supports timeouts. You
1586can call the \method{settimeout(\var{t})} method on a socket object to
1587set a timeout of \var{t} seconds. Subsequent socket operations that
1588take longer than \var{t} seconds to complete will abort and raise a
Fred Drake5c4cf152002-11-13 14:59:06 +00001589\exception{socket.error} exception.
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001590
1591The original timeout implementation was by Tim O'Malley. Michael
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001592Gilfix integrated it into the Python \module{socket} module and
1593shepherded it through a lengthy review. After the code was checked
1594in, Guido van~Rossum rewrote parts of it. (This is a good example of
1595a collaborative development process in action.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001596
Mark Hammond8af50bc2002-12-03 06:13:35 +00001597\item On Windows, the \module{socket} module now ships with Secure
Michael W. Hudson065f5fa2003-02-10 19:24:50 +00001598Sockets Layer (SSL) support.
Mark Hammond8af50bc2002-12-03 06:13:35 +00001599
Andrew M. Kuchling563389f2003-03-02 02:31:58 +00001600\item The value of the C \constant{PYTHON_API_VERSION} macro is now
1601exposed at the Python level as \code{sys.api_version}. The current
1602exception can be cleared by calling the new \function{sys.exc_clear()}
1603function.
Andrew M. Kuchlingdcfd8252002-09-13 22:21:42 +00001604
Andrew M. Kuchling674b0bf2003-01-07 00:07:19 +00001605\item The new \module{tarfile} module
Neal Norwitz55d555f2003-01-08 05:27:42 +00001606allows reading from and writing to \program{tar}-format archive files.
Andrew M. Kuchling674b0bf2003-01-07 00:07:19 +00001607(Contributed by Lars Gust\"abel.)
1608
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001609\item The new \module{textwrap} module contains functions for wrapping
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001610strings containing paragraphs of text. The \function{wrap(\var{text},
1611\var{width})} function takes a string and returns a list containing
1612the text split into lines of no more than the chosen width. The
1613\function{fill(\var{text}, \var{width})} function returns a single
1614string, reformatted to fit into lines no longer than the chosen width.
1615(As you can guess, \function{fill()} is built on top of
1616\function{wrap()}. For example:
1617
1618\begin{verbatim}
1619>>> import textwrap
1620>>> paragraph = "Not a whit, we defy augury: ... more text ..."
1621>>> textwrap.wrap(paragraph, 60)
Fred Drake5c4cf152002-11-13 14:59:06 +00001622["Not a whit, we defy augury: there's a special providence in",
1623 "the fall of a sparrow. If it be now, 'tis not to come; if it",
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001624 ...]
1625>>> print textwrap.fill(paragraph, 35)
1626Not a whit, we defy augury: there's
1627a special providence in the fall of
1628a sparrow. If it be now, 'tis not
1629to come; if it be not to come, it
1630will be now; if it be not now, yet
1631it will come: the readiness is all.
Fred Drake5c4cf152002-11-13 14:59:06 +00001632>>>
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001633\end{verbatim}
1634
1635The module also contains a \class{TextWrapper} class that actually
Fred Drake5c4cf152002-11-13 14:59:06 +00001636implements the text wrapping strategy. Both the
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001637\class{TextWrapper} class and the \function{wrap()} and
1638\function{fill()} functions support a number of additional keyword
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00001639arguments for fine-tuning the formatting; consult the \ulink{module's
1640documentation}{../lib/module-textwrap.html} for details.
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001641(Contributed by Greg Ward.)
1642
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001643\item The \module{thread} and \module{threading} modules now have
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001644companion modules, \module{dummy_thread} and \module{dummy_threading},
1645that provide a do-nothing implementation of the \module{thread}
1646module's interface for platforms where threads are not supported. The
1647intention is to simplify thread-aware modules (ones that \emph{don't}
1648rely on threads to run) by putting the following code at the top:
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001649
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001650\begin{verbatim}
1651try:
1652 import threading as _threading
1653except ImportError:
1654 import dummy_threading as _threading
1655\end{verbatim}
1656
1657Code can then call functions and use classes in \module{_threading}
1658whether or not threads are supported, avoiding an \keyword{if}
1659statement and making the code slightly clearer. This module will not
1660magically make multithreaded code run without threads; code that waits
1661for another thread to return or to do something will simply hang
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00001662forever. (In this example, \module{_threading} is used as the module
1663name to make it clear that the module being used is not necessarily
1664the actual \module{threading} module.)
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00001665
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001666\item The \module{time} module's \function{strptime()} function has
Fred Drake5c4cf152002-11-13 14:59:06 +00001667long been an annoyance because it uses the platform C library's
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001668\function{strptime()} implementation, and different platforms
1669sometimes have odd bugs. Brett Cannon contributed a portable
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001670implementation that's written in pure Python and should behave
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001671identically on all platforms.
1672
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00001673\item The new \module{timeit} module helps measure how long snippets
1674of Python code take to execute. The \file{timeit.py} file can be run
1675directly from the command line, or the module's \class{Timer} class
1676can be imported and used directly. Here's a short example that
1677figures out whether it's faster to convert an 8-bit string to Unicode
1678by appending an empty Unicode string to it or by using the
1679\function{unicode()} function:
1680
1681\begin{verbatim}
1682import timeit
1683
1684timer1 = timeit.Timer('unicode("abc")')
1685timer2 = timeit.Timer('"abc" + u""')
1686
1687# Run three trials
1688print timer1.repeat(repeat=3, number=100000)
1689print timer2.repeat(repeat=3, number=100000)
1690
1691# On my laptop this outputs:
1692# [0.36831796169281006, 0.37441694736480713, 0.35304892063140869]
1693# [0.17574405670166016, 0.18193507194519043, 0.17565798759460449]
1694\end{verbatim}
1695
1696
Andrew M. Kuchling6c50df22002-12-13 12:53:16 +00001697\item The \module{UserDict} module has a new \class{DictMixin} class which
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001698defines all dictionary methods for classes that already have a minimum
1699mapping interface. This greatly simplifies writing classes that need
1700to be substitutable for dictionaries, such as the classes in
1701the \module{shelve} module.
1702
1703Adding the mixin as a superclass provides the full dictionary
1704interface whenever the class defines \method{__getitem__},
Andrew M. Kuchling6c50df22002-12-13 12:53:16 +00001705\method{__setitem__}, \method{__delitem__}, and \method{keys}.
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001706For example:
1707
1708\begin{verbatim}
1709>>> import UserDict
1710>>> class SeqDict(UserDict.DictMixin):
1711 """Dictionary lookalike implemented with lists."""
1712 def __init__(self):
1713 self.keylist = []
1714 self.valuelist = []
1715 def __getitem__(self, key):
1716 try:
1717 i = self.keylist.index(key)
1718 except ValueError:
1719 raise KeyError
1720 return self.valuelist[i]
1721 def __setitem__(self, key, value):
1722 try:
1723 i = self.keylist.index(key)
1724 self.valuelist[i] = value
1725 except ValueError:
1726 self.keylist.append(key)
1727 self.valuelist.append(value)
1728 def __delitem__(self, key):
1729 try:
1730 i = self.keylist.index(key)
1731 except ValueError:
1732 raise KeyError
1733 self.keylist.pop(i)
1734 self.valuelist.pop(i)
1735 def keys(self):
1736 return list(self.keylist)
1737
1738>>> s = SeqDict()
1739>>> dir(s) # See that other dictionary methods are implemented
1740['__cmp__', '__contains__', '__delitem__', '__doc__', '__getitem__',
1741 '__init__', '__iter__', '__len__', '__module__', '__repr__',
1742 '__setitem__', 'clear', 'get', 'has_key', 'items', 'iteritems',
1743 'iterkeys', 'itervalues', 'keylist', 'keys', 'pop', 'popitem',
1744 'setdefault', 'update', 'valuelist', 'values']
Neal Norwitzc7d8c682002-12-24 14:51:43 +00001745\end{verbatim}
Andrew M. Kuchling449a87d2002-12-11 15:03:51 +00001746
1747(Contributed by Raymond Hettinger.)
1748
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001749\item The DOM implementation
1750in \module{xml.dom.minidom} can now generate XML output in a
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001751particular encoding by providing an optional encoding argument to
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001752the \method{toxml()} and \method{toprettyxml()} methods of DOM nodes.
1753
Andrew M. Kuchlingef893fe2003-01-06 20:04:17 +00001754item The \module{Tix} module has received various bug fixes and
1755updates for the current version of the Tix package.
1756
Andrew M. Kuchling6c50df22002-12-13 12:53:16 +00001757\item The \module{Tkinter} module now works with a thread-enabled
1758version of Tcl. Tcl's threading model requires that widgets only be
1759accessed from the thread in which they're created; accesses from
1760another thread can cause Tcl to panic. For certain Tcl interfaces,
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001761\module{Tkinter} will now automatically avoid this
1762when a widget is accessed from a different thread by marshalling a
1763command, passing it to the correct thread, and waiting for the
1764results. Other interfaces can't be handled automatically but
1765\module{Tkinter} will now raise an exception on such an access so that
1766at least you can find out about the problem. See
Andrew M. Kuchling6c50df22002-12-13 12:53:16 +00001767\url{http://mail.python.org/pipermail/python-dev/2002-December/031107.html}
1768for a more detailed explanation of this change. (Implemented by
1769Martin von L\"owis.)
1770
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001771\item Calling Tcl methods through \module{_tkinter} no longer
1772returns only strings. Instead, if Tcl returns other objects those
1773objects are converted to their Python equivalent, if one exists, or
1774wrapped with a \class{_tkinter.Tcl_Obj} object if no Python equivalent
Raymond Hettinger45bda572002-12-14 20:20:45 +00001775exists. This behavior can be controlled through the
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001776\method{wantobjects()} method of \class{tkapp} objects.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001777
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001778When using \module{_tkinter} through the \module{Tkinter} module (as
1779most Tkinter applications will), this feature is always activated. It
1780should not cause compatibility problems, since Tkinter would always
1781convert string results to Python types where possible.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001782
Raymond Hettinger45bda572002-12-14 20:20:45 +00001783If any incompatibilities are found, the old behavior can be restored
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001784by setting the \member{wantobjects} variable in the \module{Tkinter}
1785module to false before creating the first \class{tkapp} object.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001786
1787\begin{verbatim}
1788import Tkinter
Martin v. Löwis8c8aa5d2002-11-26 21:39:48 +00001789Tkinter.wantobjects = 0
Martin v. Löwis39b48522002-11-26 09:47:25 +00001790\end{verbatim}
1791
Andrew M. Kuchling6c50df22002-12-13 12:53:16 +00001792Any breakage caused by this change should be reported as a bug.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001793
Martin v. Löwis2548c732003-04-18 10:39:54 +00001794\item Support for internationalized domain names (RFCs 3454, 3490,
17953491, and 3492) has been added. The ``idna'' encoding can be used
1796to convert between a Unicode domain name and the ASCII-compatible
1797encoding (ACE).
1798
1799\begin{verbatim}
1800>>> u"www.Alliancefran\,caise.nu".encode("idna")
1801'www.xn--alliancefranaise-npb.nu'
1802\end{verbatim}
1803
1804In addition, the \module{socket} has been extended to transparently
1805convert Unicode hostnames to the ACE before passing them to the C
1806library. In turn, modules that pass hostnames ``through'' (such as
1807\module{httplib}, \module{ftplib}) also support Unicode host names
1808(httplib also sends ACE Host: headers). \module{urllib} supports
1809Unicode URLs with non-ASCII host names as long as the \code{path} part
1810of the URL is ASCII only.
1811
1812To implement this change, the module \module{stringprep}, the tool
1813\code{mkstringprep} and the \code{punycode} encoding have been added.
1814
Martin v. Löwis281b2c62003-04-18 21:04:39 +00001815\item The new \module{DocXMLRPCServer} allows to write
1816self-documenting XML-RPC servers. Run it in demo mode (as a program)
1817to see it in action: Pointing the Web browser to the RPC server
1818produces pydoc-style documentation; pointing xmlrpclib to the
1819server allows to invoke the actual methods.
1820
1821Contributed by Brian Quinlan.
1822
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001823\end{itemize}
1824
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001825
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001826%======================================================================
Andrew M. Kuchlinga974b392003-01-13 19:09:03 +00001827\subsection{Date/Time Type}
1828
1829Date and time types suitable for expressing timestamps were added as
1830the \module{datetime} module. The types don't support different
1831calendars or many fancy features, and just stick to the basics of
1832representing time.
1833
1834The three primary types are: \class{date}, representing a day, month,
1835and year; \class{time}, consisting of hour, minute, and second; and
1836\class{datetime}, which contains all the attributes of both
Andrew M. Kuchlingc71bb972003-03-21 17:23:07 +00001837\class{date} and \class{time}. There's also a
1838\class{timedelta} class representing differences between two points
Andrew M. Kuchlinga974b392003-01-13 19:09:03 +00001839in time, and time zone logic is implemented by classes inheriting from
1840the abstract \class{tzinfo} class.
1841
1842You can create instances of \class{date} and \class{time} by either
1843supplying keyword arguments to the appropriate constructor,
1844e.g. \code{datetime.date(year=1972, month=10, day=15)}, or by using
Andrew M. Kuchlingc71bb972003-03-21 17:23:07 +00001845one of a number of class methods. For example, the \method{date.today()}
Andrew M. Kuchlinga974b392003-01-13 19:09:03 +00001846class method returns the current local date.
1847
1848Once created, instances of the date/time classes are all immutable.
1849There are a number of methods for producing formatted strings from
1850objects:
1851
1852\begin{verbatim}
1853>>> import datetime
1854>>> now = datetime.datetime.now()
1855>>> now.isoformat()
1856'2002-12-30T21:27:03.994956'
1857>>> now.ctime() # Only available on date, datetime
1858'Mon Dec 30 21:27:03 2002'
Raymond Hettingeree1bded2003-01-17 16:20:23 +00001859>>> now.strftime('%Y %d %b')
Andrew M. Kuchlinga974b392003-01-13 19:09:03 +00001860'2002 30 Dec'
1861\end{verbatim}
1862
1863The \method{replace()} method allows modifying one or more fields
1864of a \class{date} or \class{datetime} instance:
1865
1866\begin{verbatim}
1867>>> d = datetime.datetime.now()
1868>>> d
1869datetime.datetime(2002, 12, 30, 22, 15, 38, 827738)
1870>>> d.replace(year=2001, hour = 12)
1871datetime.datetime(2001, 12, 30, 12, 15, 38, 827738)
1872>>>
1873\end{verbatim}
1874
1875Instances can be compared, hashed, and converted to strings (the
1876result is the same as that of \method{isoformat()}). \class{date} and
1877\class{datetime} instances can be subtracted from each other, and
Andrew M. Kuchlingc71bb972003-03-21 17:23:07 +00001878added to \class{timedelta} instances. The largest missing feature is
1879that there's no support for parsing strings and getting back a
1880\class{date} or \class{datetime}.
Andrew M. Kuchlinga974b392003-01-13 19:09:03 +00001881
1882For more information, refer to the \ulink{module's reference
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00001883documentation}{../lib/module-datetime.html}.
Andrew M. Kuchlinga974b392003-01-13 19:09:03 +00001884(Contributed by Tim Peters.)
1885
1886
1887%======================================================================
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001888\subsection{The \module{optparse} Module}
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001889
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001890The \module{getopt} module provides simple parsing of command-line
1891arguments. The new \module{optparse} module (originally named Optik)
1892provides more elaborate command-line parsing that follows the Unix
1893conventions, automatically creates the output for \longprogramopt{help},
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001894and can perform different actions for different options.
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001895
1896You start by creating an instance of \class{OptionParser} and telling
1897it what your program's options are.
1898
1899\begin{verbatim}
Andrew M. Kuchling7ee9b512003-02-18 00:48:23 +00001900import sys
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001901from optparse import OptionParser
1902
1903op = OptionParser()
1904op.add_option('-i', '--input',
1905 action='store', type='string', dest='input',
1906 help='set input filename')
1907op.add_option('-l', '--length',
1908 action='store', type='int', dest='length',
1909 help='set maximum length of output')
1910\end{verbatim}
1911
1912Parsing a command line is then done by calling the \method{parse_args()}
1913method.
1914
1915\begin{verbatim}
Andrew M. Kuchling7ee9b512003-02-18 00:48:23 +00001916import optparse
1917
1918options, args = optparse.parse_args(sys.argv[1:])
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001919print options
1920print args
1921\end{verbatim}
1922
1923This returns an object containing all of the option values,
1924and a list of strings containing the remaining arguments.
1925
1926Invoking the script with the various arguments now works as you'd
1927expect it to. Note that the length argument is automatically
1928converted to an integer.
1929
1930\begin{verbatim}
1931$ ./python opt.py -i data arg1
1932<Values at 0x400cad4c: {'input': 'data', 'length': None}>
1933['arg1']
1934$ ./python opt.py --input=data --length=4
1935<Values at 0x400cad2c: {'input': 'data', 'length': 4}>
Andrew M. Kuchling7ee9b512003-02-18 00:48:23 +00001936[]
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001937$
1938\end{verbatim}
1939
1940The help message is automatically generated for you:
1941
1942\begin{verbatim}
1943$ ./python opt.py --help
1944usage: opt.py [options]
1945
1946options:
1947 -h, --help show this help message and exit
1948 -iINPUT, --input=INPUT
1949 set input filename
1950 -lLENGTH, --length=LENGTH
1951 set maximum length of output
1952$
1953\end{verbatim}
Andrew M. Kuchling669249e2002-11-19 13:05:33 +00001954% $ prevent Emacs tex-mode from getting confused
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001955
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00001956See the \ulink{module's documentation}{../lib/module-optparse.html}
1957for more details.
1958
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001959Optik was written by Greg Ward, with suggestions from the readers of
1960the Getopt SIG.
1961
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001962
1963%======================================================================
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001964\section{Specialized Object Allocator (pymalloc)\label{section-pymalloc}}
1965
Andrew M. Kuchlingc71bb972003-03-21 17:23:07 +00001966Pymalloc, a specialized object allocator written by Vladimir
1967Marangozov, was a feature added to Python 2.1. Pymalloc is intended
1968to be faster than the system \cfunction{malloc()} and to have less
1969memory overhead for allocation patterns typical of Python programs.
1970The allocator uses C's \cfunction{malloc()} function to get large
1971pools of memory and then fulfills smaller memory requests from these
1972pools.
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001973
1974In 2.1 and 2.2, pymalloc was an experimental feature and wasn't
Andrew M. Kuchlingc71bb972003-03-21 17:23:07 +00001975enabled by default; you had to explicitly enable it when compiling
1976Python by providing the
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001977\longprogramopt{with-pymalloc} option to the \program{configure}
1978script. In 2.3, pymalloc has had further enhancements and is now
1979enabled by default; you'll have to supply
1980\longprogramopt{without-pymalloc} to disable it.
1981
1982This change is transparent to code written in Python; however,
1983pymalloc may expose bugs in C extensions. Authors of C extension
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001984modules should test their code with pymalloc enabled,
1985because some incorrect code may cause core dumps at runtime.
1986
1987There's one particularly common error that causes problems. There are
1988a number of memory allocation functions in Python's C API that have
1989previously just been aliases for the C library's \cfunction{malloc()}
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001990and \cfunction{free()}, meaning that if you accidentally called
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00001991mismatched functions the error wouldn't be noticeable. When the
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001992object allocator is enabled, these functions aren't aliases of
1993\cfunction{malloc()} and \cfunction{free()} any more, and calling the
1994wrong function to free memory may get you a core dump. For example,
1995if memory was allocated using \cfunction{PyObject_Malloc()}, it has to
1996be freed using \cfunction{PyObject_Free()}, not \cfunction{free()}. A
1997few modules included with Python fell afoul of this and had to be
1998fixed; doubtless there are more third-party modules that will have the
1999same problem.
2000
2001As part of this change, the confusing multiple interfaces for
2002allocating memory have been consolidated down into two API families.
2003Memory allocated with one family must not be manipulated with
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002004functions from the other family. There is one family for allocating
2005chunks of memory, and another family of functions specifically for
2006allocating Python objects.
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00002007
2008\begin{itemize}
2009 \item To allocate and free an undistinguished chunk of memory use
2010 the ``raw memory'' family: \cfunction{PyMem_Malloc()},
2011 \cfunction{PyMem_Realloc()}, and \cfunction{PyMem_Free()}.
2012
2013 \item The ``object memory'' family is the interface to the pymalloc
2014 facility described above and is biased towards a large number of
2015 ``small'' allocations: \cfunction{PyObject_Malloc},
2016 \cfunction{PyObject_Realloc}, and \cfunction{PyObject_Free}.
2017
2018 \item To allocate and free Python objects, use the ``object'' family
2019 \cfunction{PyObject_New()}, \cfunction{PyObject_NewVar()}, and
2020 \cfunction{PyObject_Del()}.
2021\end{itemize}
2022
2023Thanks to lots of work by Tim Peters, pymalloc in 2.3 also provides
2024debugging features to catch memory overwrites and doubled frees in
2025both extension modules and in the interpreter itself. To enable this
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002026support, compile a debugging version of the Python interpreter by
2027running \program{configure} with \longprogramopt{with-pydebug}.
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00002028
2029To aid extension writers, a header file \file{Misc/pymemcompat.h} is
2030distributed with the source to Python 2.3 that allows Python
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002031extensions to use the 2.3 interfaces to memory allocation while
2032compiling against any version of Python since 1.5.2. You would copy
2033the file from Python's source distribution and bundle it with the
2034source of your extension.
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00002035
2036\begin{seealso}
2037
2038\seeurl{http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/python/python/dist/src/Objects/obmalloc.c}
2039{For the full details of the pymalloc implementation, see
2040the comments at the top of the file \file{Objects/obmalloc.c} in the
2041Python source code. The above link points to the file within the
2042SourceForge CVS browser.}
2043
2044\end{seealso}
2045
2046
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00002047% ======================================================================
2048\section{Build and C API Changes}
2049
Andrew M. Kuchling3c305d92002-07-22 18:50:11 +00002050Changes to Python's build process and to the C API include:
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00002051
2052\begin{itemize}
2053
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00002054\item The C-level interface to the garbage collector has been changed,
2055to make it easier to write extension types that support garbage
2056collection, and to make it easier to debug misuses of the functions.
2057Various functions have slightly different semantics, so a bunch of
2058functions had to be renamed. Extensions that use the old API will
2059still compile but will \emph{not} participate in garbage collection,
2060so updating them for 2.3 should be considered fairly high priority.
2061
2062To upgrade an extension module to the new API, perform the following
2063steps:
2064
2065\begin{itemize}
2066
2067\item Rename \cfunction{Py_TPFLAGS_GC} to \cfunction{PyTPFLAGS_HAVE_GC}.
2068
2069\item Use \cfunction{PyObject_GC_New} or \cfunction{PyObject_GC_NewVar} to
2070allocate objects, and \cfunction{PyObject_GC_Del} to deallocate them.
2071
2072\item Rename \cfunction{PyObject_GC_Init} to \cfunction{PyObject_GC_Track} and
2073\cfunction{PyObject_GC_Fini} to \cfunction{PyObject_GC_UnTrack}.
2074
2075\item Remove \cfunction{PyGC_HEAD_SIZE} from object size calculations.
2076
2077\item Remove calls to \cfunction{PyObject_AS_GC} and \cfunction{PyObject_FROM_GC}.
2078
2079\end{itemize}
2080
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002081\item The cycle detection implementation used by the garbage collection
2082has proven to be stable, so it's now being made mandatory; you can no
2083longer compile Python without it, and the
2084\longprogramopt{with-cycle-gc} switch to \program{configure} has been removed.
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00002085
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002086\item Python can now optionally be built as a shared library
2087(\file{libpython2.3.so}) by supplying \longprogramopt{enable-shared}
Fred Drake5c4cf152002-11-13 14:59:06 +00002088when running Python's \program{configure} script. (Contributed by Ondrej
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +00002089Palkovsky.)
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +00002090
Michael W. Hudsondd32a912002-08-15 14:59:02 +00002091\item The \csimplemacro{DL_EXPORT} and \csimplemacro{DL_IMPORT} macros
2092are now deprecated. Initialization functions for Python extension
2093modules should now be declared using the new macro
Andrew M. Kuchling3c305d92002-07-22 18:50:11 +00002094\csimplemacro{PyMODINIT_FUNC}, while the Python core will generally
2095use the \csimplemacro{PyAPI_FUNC} and \csimplemacro{PyAPI_DATA}
2096macros.
Neal Norwitzbba23a82002-07-22 13:18:59 +00002097
Fred Drake5c4cf152002-11-13 14:59:06 +00002098\item The interpreter can be compiled without any docstrings for
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00002099the built-in functions and modules by supplying
Fred Drake5c4cf152002-11-13 14:59:06 +00002100\longprogramopt{without-doc-strings} to the \program{configure} script.
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00002101This makes the Python executable about 10\% smaller, but will also
2102mean that you can't get help for Python's built-ins. (Contributed by
2103Gustavo Niemeyer.)
2104
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002105\item The \cfunction{PyArg_NoArgs()} macro is now deprecated, and code
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00002106that uses it should be changed. For Python 2.2 and later, the method
2107definition table can specify the
Fred Drake5c4cf152002-11-13 14:59:06 +00002108\constant{METH_NOARGS} flag, signalling that there are no arguments, and
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00002109the argument checking can then be removed. If compatibility with
2110pre-2.2 versions of Python is important, the code could use
Fred Drakeaac8c582003-01-17 22:50:10 +00002111\code{PyArg_ParseTuple(\var{args}, "")} instead, but this will be slower
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00002112than using \constant{METH_NOARGS}.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00002113
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002114\item A new function, \cfunction{PyObject_DelItemString(\var{mapping},
2115char *\var{key})} was added
Fred Drake5c4cf152002-11-13 14:59:06 +00002116as shorthand for
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002117\code{PyObject_DelItem(\var{mapping}, PyString_New(\var{key})}.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00002118
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00002119\item The \method{xreadlines()} method of file objects, introduced in
2120Python 2.1, is no longer necessary because files now behave as their
2121own iterator. \method{xreadlines()} was originally introduced as a
2122faster way to loop over all the lines in a file, but now you can
2123simply write \code{for line in file_obj}.
2124
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002125\item File objects now manage their internal string buffer
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002126differently, increasing it exponentially when needed. This results in
2127the benchmark tests in \file{Lib/test/test_bufio.py} speeding up
2128considerably (from 57 seconds to 1.7 seconds, according to one
2129measurement).
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002130
Andrew M. Kuchling72b58e02002-05-29 17:30:34 +00002131\item It's now possible to define class and static methods for a C
2132extension type by setting either the \constant{METH_CLASS} or
2133\constant{METH_STATIC} flags in a method's \ctype{PyMethodDef}
2134structure.
Andrew M. Kuchling45afd542002-04-02 14:25:25 +00002135
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00002136\item Python now includes a copy of the Expat XML parser's source code,
2137removing any dependence on a system version or local installation of
Fred Drake5c4cf152002-11-13 14:59:06 +00002138Expat.
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00002139
Michael W. Hudson3e245d82003-02-11 14:19:56 +00002140\item If you dynamically allocate type objects in your extension, you
Neal Norwitzada859c2003-02-11 14:30:39 +00002141should be aware of a change in the rules relating to the
Michael W. Hudson3e245d82003-02-11 14:19:56 +00002142\member{__module__} and \member{__name__} attributes. In summary,
2143you will want to ensure the type's dictionary contains a
2144\code{'__module__'} key; making the module name the part of the type
2145name leading up to the final period will no longer have the desired
2146effect. For more detail, read the API reference documentation or the
2147source.
2148
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00002149\end{itemize}
2150
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00002151
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00002152%======================================================================
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00002153\subsection{Port-Specific Changes}
2154
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00002155Support for a port to IBM's OS/2 using the EMX runtime environment was
2156merged into the main Python source tree. EMX is a POSIX emulation
2157layer over the OS/2 system APIs. The Python port for EMX tries to
2158support all the POSIX-like capability exposed by the EMX runtime, and
2159mostly succeeds; \function{fork()} and \function{fcntl()} are
2160restricted by the limitations of the underlying emulation layer. The
2161standard OS/2 port, which uses IBM's Visual Age compiler, also gained
2162support for case-sensitive import semantics as part of the integration
2163of the EMX port into CVS. (Contributed by Andrew MacIntyre.)
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00002164
Andrew M. Kuchling72b58e02002-05-29 17:30:34 +00002165On MacOS, most toolbox modules have been weaklinked to improve
2166backward compatibility. This means that modules will no longer fail
2167to load if a single routine is missing on the curent OS version.
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00002168Instead calling the missing routine will raise an exception.
2169(Contributed by Jack Jansen.)
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00002170
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00002171The RPM spec files, found in the \file{Misc/RPM/} directory in the
2172Python source distribution, were updated for 2.3. (Contributed by
2173Sean Reifschneider.)
Fred Drake03e10312002-03-26 19:17:43 +00002174
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002175Other new platforms now supported by Python include AtheOS
Fred Drake693aea22003-02-07 14:52:18 +00002176(\url{http://www.atheos.cx/}), GNU/Hurd, and OpenVMS.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00002177
Fred Drake03e10312002-03-26 19:17:43 +00002178
2179%======================================================================
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002180\section{Other Changes and Fixes \label{section-other}}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002181
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00002182As usual, there were a bunch of other improvements and bugfixes
2183scattered throughout the source tree. A search through the CVS change
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002184logs finds there were 121 patches applied and 103 bugs fixed between
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00002185Python 2.2 and 2.3. Both figures are likely to be underestimates.
2186
2187Some of the more notable changes are:
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002188
2189\begin{itemize}
2190
Fred Drake54fe3fd2002-11-26 22:07:35 +00002191\item The \file{regrtest.py} script now provides a way to allow ``all
2192resources except \var{foo}.'' A resource name passed to the
2193\programopt{-u} option can now be prefixed with a hyphen
2194(\character{-}) to mean ``remove this resource.'' For example, the
2195option `\code{\programopt{-u}all,-bsddb}' could be used to enable the
2196use of all resources except \code{bsddb}.
2197
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002198\item The tools used to build the documentation now work under Cygwin
2199as well as \UNIX.
2200
Michael W. Hudsondd32a912002-08-15 14:59:02 +00002201\item The \code{SET_LINENO} opcode has been removed. Back in the
2202mists of time, this opcode was needed to produce line numbers in
2203tracebacks and support trace functions (for, e.g., \module{pdb}).
2204Since Python 1.5, the line numbers in tracebacks have been computed
2205using a different mechanism that works with ``python -O''. For Python
22062.3 Michael Hudson implemented a similar scheme to determine when to
2207call the trace function, removing the need for \code{SET_LINENO}
2208entirely.
2209
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00002210It would be difficult to detect any resulting difference from Python
2211code, apart from a slight speed up when Python is run without
Michael W. Hudsondd32a912002-08-15 14:59:02 +00002212\programopt{-O}.
2213
2214C extensions that access the \member{f_lineno} field of frame objects
2215should instead call \code{PyCode_Addr2Line(f->f_code, f->f_lasti)}.
2216This will have the added effect of making the code work as desired
2217under ``python -O'' in earlier versions of Python.
2218
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002219A nifty new feature is that trace functions can now assign to the
2220\member{f_lineno} attribute of frame objects, changing the line that
2221will be executed next. A \samp{jump} command has been added to the
2222\module{pdb} debugger taking advantage of this new feature.
2223(Implemented by Richie Hindle.)
Andrew M. Kuchling974ab9d2002-12-31 01:20:30 +00002224
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002225\end{itemize}
2226
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00002227
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00002228%======================================================================
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00002229\section{Porting to Python 2.3}
2230
Andrew M. Kuchlingf15fb292002-12-31 18:34:54 +00002231This section lists previously described changes that may require
2232changes to your code:
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00002233
2234\begin{itemize}
2235
2236\item \keyword{yield} is now always a keyword; if it's used as a
2237variable name in your code, a different name must be chosen.
2238
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00002239\item For strings \var{X} and \var{Y}, \code{\var{X} in \var{Y}} now works
2240if \var{X} is more than one character long.
2241
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00002242\item The \function{int()} type constructor will now return a long
2243integer instead of raising an \exception{OverflowError} when a string
2244or floating-point number is too large to fit into an integer.
2245
Andrew M. Kuchlingacddabc2003-02-18 00:43:24 +00002246\item If you have Unicode strings that contain 8-bit characters, you
2247must declare the file's encoding (UTF-8, Latin-1, or whatever) by
2248adding a comment to the top of the file. See
2249section~\ref{section-encodings} for more information.
2250
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00002251\item Calling Tcl methods through \module{_tkinter} no longer
2252returns only strings. Instead, if Tcl returns other objects those
2253objects are converted to their Python equivalent, if one exists, or
2254wrapped with a \class{_tkinter.Tcl_Obj} object if no Python equivalent
2255exists.
2256
Andrew M. Kuchling80fd7852003-02-06 15:14:04 +00002257\item Large octal and hex literals such as
Andrew M. Kuchling72df65a2003-02-10 15:08:16 +00002258\code{0xffffffff} now trigger a \exception{FutureWarning}. Currently
Andrew M. Kuchling80fd7852003-02-06 15:14:04 +00002259they're stored as 32-bit numbers and result in a negative value, but
Andrew M. Kuchling72df65a2003-02-10 15:08:16 +00002260in Python 2.4 they'll become positive long integers.
2261
2262There are a few ways to fix this warning. If you really need a
2263positive number, just add an \samp{L} to the end of the literal. If
2264you're trying to get a 32-bit integer with low bits set and have
2265previously used an expression such as \code{~(1 << 31)}, it's probably
2266clearest to start with all bits set and clear the desired upper bits.
2267For example, to clear just the top bit (bit 31), you could write
2268\code{0xffffffffL {\&}{\textasciitilde}(1L<<31)}.
Andrew M. Kuchling80fd7852003-02-06 15:14:04 +00002269
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00002270\item You can no longer disable assertions by assigning to \code{__debug__}.
2271
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00002272\item The Distutils \function{setup()} function has gained various new
Fred Drake5c4cf152002-11-13 14:59:06 +00002273keyword arguments such as \var{depends}. Old versions of the
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00002274Distutils will abort if passed unknown keywords. The fix is to check
2275for the presence of the new \function{get_distutil_options()} function
2276in your \file{setup.py} if you want to only support the new keywords
2277with a version of the Distutils that supports them:
2278
2279\begin{verbatim}
2280from distutils import core
2281
2282kw = {'sources': 'foo.c', ...}
2283if hasattr(core, 'get_distutil_options'):
2284 kw['depends'] = ['foo.h']
Fred Drake5c4cf152002-11-13 14:59:06 +00002285ext = Extension(**kw)
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00002286\end{verbatim}
2287
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00002288\item Using \code{None} as a variable name will now result in a
2289\exception{SyntaxWarning} warning.
2290
2291\item Names of extension types defined by the modules included with
2292Python now contain the module and a \character{.} in front of the type
2293name.
2294
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00002295\end{itemize}
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00002296
2297
2298%======================================================================
Fred Drake03e10312002-03-26 19:17:43 +00002299\section{Acknowledgements \label{acks}}
2300
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00002301The author would like to thank the following people for offering
2302suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00002303article: Jeff Bauer, Simon Brunning, Brett Cannon, Michael Chermside,
2304Andrew Dalke, Scott David Daniels, Fred~L. Drake, Jr., Kelly Gerber,
2305Raymond Hettinger, Michael Hudson, Chris Lambert, Detlef Lannert,
2306Martin von L\"owis, Andrew MacIntyre, Lalo Martins, Gustavo Niemeyer,
Andrew M. Kuchlingb43f15e2003-04-14 18:47:28 +00002307Neal Norwitz, Hans Nowak, Chris Reedy, Francesco Ricciardi,
2308Vinay Sajip, Neil Schemenauer,
Andrew M. Kuchlingd39078b2003-04-13 21:44:28 +00002309Roman Suzi, Jason Tishler, Just van~Rossum.
Fred Drake03e10312002-03-26 19:17:43 +00002310
2311\end{document}