blob: 177225605cd6bf479b54ea7ced1d6695324d021e [file] [log] [blame]
Fred Drake03e10312002-03-26 19:17:43 +00001\documentclass{howto}
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00002% $Id$
3
4\title{What's New in Python 2.3}
Andrew M. Kuchling6f429c32002-11-19 13:09:00 +00005\release{0.04}
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00006\author{A.M. Kuchling}
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00007\authoraddress{\email{amk@amk.ca}}
Fred Drake03e10312002-03-26 19:17:43 +00008
9\begin{document}
10\maketitle
11\tableofcontents
12
Andrew M. Kuchlingc61ec522002-08-04 01:20:05 +000013% MacOS framework-related changes (section of its own, probably)
Andrew M. Kuchlingf70a0a82002-06-10 13:22:46 +000014
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000015%\section{Introduction \label{intro}}
16
17{\large This article is a draft, and is currently up to date for some
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +000018random version of the CVS tree from early November 2002. Please send any
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000019additions, comments or errata to the author.}
20
21This article explains the new features in Python 2.3. The tentative
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +000022release date of Python 2.3 is currently scheduled for some undefined
23time before the end of 2002.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000024
25This article doesn't attempt to provide a complete specification of
26the new features, but instead provides a convenient overview. For
27full details, you should refer to the documentation for Python 2.3,
28such as the
29\citetitle[http://www.python.org/doc/2.3/lib/lib.html]{Python Library
30Reference} and the
31\citetitle[http://www.python.org/doc/2.3/ref/ref.html]{Python
32Reference Manual}. If you want to understand the complete
33implementation and design rationale for a change, refer to the PEP for
34a particular new feature.
Fred Drake03e10312002-03-26 19:17:43 +000035
36
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +000037%======================================================================
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000038\section{PEP 218: A Standard Set Datatype}
39
40The new \module{sets} module contains an implementation of a set
41datatype. The \class{Set} class is for mutable sets, sets that can
42have members added and removed. The \class{ImmutableSet} class is for
43sets that can't be modified, and can be used as dictionary keys. Sets
44are built on top of dictionaries, so the elements within a set must be
45hashable.
46
Fred Drake5c4cf152002-11-13 14:59:06 +000047As a simple example,
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000048
49\begin{verbatim}
50>>> import sets
51>>> S = sets.Set([1,2,3])
52>>> S
53Set([1, 2, 3])
54>>> 1 in S
55True
56>>> 0 in S
57False
58>>> S.add(5)
59>>> S.remove(3)
60>>> S
61Set([1, 2, 5])
Fred Drake5c4cf152002-11-13 14:59:06 +000062>>>
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000063\end{verbatim}
64
65The union and intersection of sets can be computed with the
66\method{union()} and \method{intersection()} methods, or,
Fred Drake5c4cf152002-11-13 14:59:06 +000067alternatively, using the bitwise operators \code{\&} and \code{|}.
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000068Mutable sets also have in-place versions of these methods,
69\method{union_update()} and \method{intersection_update()}.
70
71\begin{verbatim}
72>>> S1 = sets.Set([1,2,3])
73>>> S2 = sets.Set([4,5,6])
74>>> S1.union(S2)
75Set([1, 2, 3, 4, 5, 6])
76>>> S1 | S2 # Alternative notation
77Set([1, 2, 3, 4, 5, 6])
Fred Drake5c4cf152002-11-13 14:59:06 +000078>>> S1.intersection(S2)
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000079Set([])
80>>> S1 & S2 # Alternative notation
81Set([])
82>>> S1.union_update(S2)
83Set([1, 2, 3, 4, 5, 6])
84>>> S1
85Set([1, 2, 3, 4, 5, 6])
Fred Drake5c4cf152002-11-13 14:59:06 +000086>>>
Andrew M. Kuchlingbc465102002-08-20 01:34:06 +000087\end{verbatim}
88
89It's also possible to take the symmetric difference of two sets. This
90is the set of all elements in the union that aren't in the
91intersection. An alternative way of expressing the symmetric
92difference is that it contains all elements that are in exactly one
93set. Again, there's an in-place version, with the ungainly name
94\method{symmetric_difference_update()}.
95
96\begin{verbatim}
97>>> S1 = sets.Set([1,2,3,4])
98>>> S2 = sets.Set([3,4,5,6])
99>>> S1.symmetric_difference(S2)
100Set([1, 2, 5, 6])
101>>> S1 ^ S2
102Set([1, 2, 5, 6])
103>>>
104\end{verbatim}
105
106There are also methods, \method{issubset()} and \method{issuperset()},
107for checking whether one set is a strict subset or superset of
108another:
109
110\begin{verbatim}
111>>> S1 = sets.Set([1,2,3])
112>>> S2 = sets.Set([2,3])
113>>> S2.issubset(S1)
114True
115>>> S1.issubset(S2)
116False
117>>> S1.issuperset(S2)
118True
119>>>
120\end{verbatim}
121
122
123\begin{seealso}
124
125\seepep{218}{Adding a Built-In Set Object Type}{PEP written by Greg V. Wilson.
126Implemented by Greg V. Wilson, Alex Martelli, and GvR.}
127
128\end{seealso}
129
130
131
132%======================================================================
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000133\section{PEP 255: Simple Generators\label{section-generators}}
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000134
135In Python 2.2, generators were added as an optional feature, to be
136enabled by a \code{from __future__ import generators} directive. In
1372.3 generators no longer need to be specially enabled, and are now
138always present; this means that \keyword{yield} is now always a
139keyword. The rest of this section is a copy of the description of
140generators from the ``What's New in Python 2.2'' document; if you read
141it when 2.2 came out, you can skip the rest of this section.
142
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000143You're doubtless familiar with how function calls work in Python or C.
144When you call a function, it gets a private namespace where its local
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000145variables are created. When the function reaches a \keyword{return}
146statement, the local variables are destroyed and the resulting value
147is returned to the caller. A later call to the same function will get
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000148a fresh new set of local variables. But, what if the local variables
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000149weren't thrown away on exiting a function? What if you could later
150resume the function where it left off? This is what generators
151provide; they can be thought of as resumable functions.
152
153Here's the simplest example of a generator function:
154
155\begin{verbatim}
156def generate_ints(N):
157 for i in range(N):
158 yield i
159\end{verbatim}
160
161A new keyword, \keyword{yield}, was introduced for generators. Any
162function containing a \keyword{yield} statement is a generator
163function; this is detected by Python's bytecode compiler which
Fred Drake5c4cf152002-11-13 14:59:06 +0000164compiles the function specially as a result.
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000165
166When you call a generator function, it doesn't return a single value;
167instead it returns a generator object that supports the iterator
168protocol. On executing the \keyword{yield} statement, the generator
169outputs the value of \code{i}, similar to a \keyword{return}
170statement. The big difference between \keyword{yield} and a
171\keyword{return} statement is that on reaching a \keyword{yield} the
172generator's state of execution is suspended and local variables are
173preserved. On the next call to the generator's \code{.next()} method,
174the function will resume executing immediately after the
175\keyword{yield} statement. (For complicated reasons, the
176\keyword{yield} statement isn't allowed inside the \keyword{try} block
177of a \code{try...finally} statement; read \pep{255} for a full
178explanation of the interaction between \keyword{yield} and
179exceptions.)
180
181Here's a sample usage of the \function{generate_ints} generator:
182
183\begin{verbatim}
184>>> gen = generate_ints(3)
185>>> gen
186<generator object at 0x8117f90>
187>>> gen.next()
1880
189>>> gen.next()
1901
191>>> gen.next()
1922
193>>> gen.next()
194Traceback (most recent call last):
Andrew M. Kuchling9f6e1042002-06-17 13:40:04 +0000195 File "stdin", line 1, in ?
196 File "stdin", line 2, in generate_ints
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000197StopIteration
198\end{verbatim}
199
200You could equally write \code{for i in generate_ints(5)}, or
201\code{a,b,c = generate_ints(3)}.
202
203Inside a generator function, the \keyword{return} statement can only
204be used without a value, and signals the end of the procession of
205values; afterwards the generator cannot return any further values.
206\keyword{return} with a value, such as \code{return 5}, is a syntax
207error inside a generator function. The end of the generator's results
208can also be indicated by raising \exception{StopIteration} manually,
209or by just letting the flow of execution fall off the bottom of the
210function.
211
212You could achieve the effect of generators manually by writing your
213own class and storing all the local variables of the generator as
214instance variables. For example, returning a list of integers could
215be done by setting \code{self.count} to 0, and having the
216\method{next()} method increment \code{self.count} and return it.
217However, for a moderately complicated generator, writing a
218corresponding class would be much messier.
219\file{Lib/test/test_generators.py} contains a number of more
220interesting examples. The simplest one implements an in-order
221traversal of a tree using generators recursively.
222
223\begin{verbatim}
224# A recursive generator that generates Tree leaves in in-order.
225def inorder(t):
226 if t:
227 for x in inorder(t.left):
228 yield x
229 yield t.label
230 for x in inorder(t.right):
231 yield x
232\end{verbatim}
233
234Two other examples in \file{Lib/test/test_generators.py} produce
235solutions for the N-Queens problem (placing $N$ queens on an $NxN$
236chess board so that no queen threatens another) and the Knight's Tour
237(a route that takes a knight to every square of an $NxN$ chessboard
Fred Drake5c4cf152002-11-13 14:59:06 +0000238without visiting any square twice).
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +0000239
240The idea of generators comes from other programming languages,
241especially Icon (\url{http://www.cs.arizona.edu/icon/}), where the
242idea of generators is central. In Icon, every
243expression and function call behaves like a generator. One example
244from ``An Overview of the Icon Programming Language'' at
245\url{http://www.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of
246what this looks like:
247
248\begin{verbatim}
249sentence := "Store it in the neighboring harbor"
250if (i := find("or", sentence)) > 5 then write(i)
251\end{verbatim}
252
253In Icon the \function{find()} function returns the indexes at which the
254substring ``or'' is found: 3, 23, 33. In the \keyword{if} statement,
255\code{i} is first assigned a value of 3, but 3 is less than 5, so the
256comparison fails, and Icon retries it with the second value of 23. 23
257is greater than 5, so the comparison now succeeds, and the code prints
258the value 23 to the screen.
259
260Python doesn't go nearly as far as Icon in adopting generators as a
261central concept. Generators are considered a new part of the core
262Python language, but learning or using them isn't compulsory; if they
263don't solve any problems that you have, feel free to ignore them.
264One novel feature of Python's interface as compared to
265Icon's is that a generator's state is represented as a concrete object
266(the iterator) that can be passed around to other functions or stored
267in a data structure.
268
269\begin{seealso}
270
271\seepep{255}{Simple Generators}{Written by Neil Schemenauer, Tim
272Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
273and Tim Peters, with other fixes from the Python Labs crew.}
274
275\end{seealso}
276
277
278%======================================================================
Fred Drake13090e12002-08-22 16:51:08 +0000279\section{PEP 263: Source Code Encodings \label{section-encodings}}
Andrew M. Kuchling950725f2002-08-06 01:40:48 +0000280
281Python source files can now be declared as being in different
282character set encodings. Encodings are declared by including a
283specially formatted comment in the first or second line of the source
284file. For example, a UTF-8 file can be declared with:
285
286\begin{verbatim}
287#!/usr/bin/env python
288# -*- coding: UTF-8 -*-
289\end{verbatim}
290
291Without such an encoding declaration, the default encoding used is
Fred Drake5c4cf152002-11-13 14:59:06 +0000292ISO-8859-1, also known as Latin1.
Andrew M. Kuchling950725f2002-08-06 01:40:48 +0000293
294The encoding declaration only affects Unicode string literals; the
295text in the source code will be converted to Unicode using the
296specified encoding. Note that Python identifiers are still restricted
297to ASCII characters, so you can't have variable names that use
298characters outside of the usual alphanumerics.
299
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
319names, in particular the \function{open()} built-in. If a Unicode
320string is passed to \function{os.listdir}, Python now returns a list
321of 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. Kuchling0a6fa962002-10-09 12:11:10 +0000324Byte strings still work as file names, and Python will transparently
325convert them to Unicode using the \code{mbcs} encoding.
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000326
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000327Other systems also allow Unicode strings as file names, but convert
328them to byte strings before passing them to the system which may cause
329a \exception{UnicodeError} to be raised. Applications can test whether
330arbitrary Unicode strings are supported as file names by checking
331\member{os.path.unicode_file_names}, a Boolean value.
Martin v. Löwisbd5e38d2002-10-07 18:52:29 +0000332
333\begin{seealso}
334
335\seepep{277}{Unicode file name support for Windows NT}{Written by Neil
336Hodgson; implemented by Neil Hodgson, Martin von L\"owis, and Mark
337Hammond.}
338
339\end{seealso}
Andrew M. Kuchling0f345562002-10-04 22:34:11 +0000340
341
342%======================================================================
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000343\section{PEP 278: Universal Newline Support}
344
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000345The three major operating systems used today are Microsoft Windows,
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000346Apple's Macintosh OS, and the various \UNIX\ derivatives. A minor
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000347irritation is that these three platforms all use different characters
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000348to mark the ends of lines in text files. \UNIX\ uses character 10,
349the ASCII linefeed, while MacOS uses character 13, the ASCII carriage
350return, and Windows uses a two-character sequence of a carriage return
351plus a newline.
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000352
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000353Python's file objects can now support end of line conventions other
354than the one followed by the platform on which Python is running.
Fred Drake5c4cf152002-11-13 14:59:06 +0000355Opening a file with the mode \code{'U'} or \code{'rU'} will open a file
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000356for reading in universal newline mode. All three line ending
Fred Drake5c4cf152002-11-13 14:59:06 +0000357conventions will be translated to a \character{\e n} in the strings
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000358returned by the various file methods such as \method{read()} and
Fred Drake5c4cf152002-11-13 14:59:06 +0000359\method{readline()}.
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000360
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000361Universal newline support is also used when importing modules and when
362executing a file with the \function{execfile()} function. This means
363that Python modules can be shared between all three operating systems
364without needing to convert the line-endings.
365
Fred Drake5c4cf152002-11-13 14:59:06 +0000366This feature can be disabled at compile-time by specifying
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000367\longprogramopt{without-universal-newlines} when running Python's
Fred Drake5c4cf152002-11-13 14:59:06 +0000368\program{configure} script.
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000369
370\begin{seealso}
371
Fred Drake5c4cf152002-11-13 14:59:06 +0000372\seepep{278}{Universal Newline Support}{Written
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000373and implemented by Jack Jansen.}
374
375\end{seealso}
376
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +0000377
378%======================================================================
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000379\section{PEP 279: The \function{enumerate()} Built-in Function\label{section-enumerate}}
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +0000380
381A new built-in function, \function{enumerate()}, will make
382certain loops a bit clearer. \code{enumerate(thing)}, where
383\var{thing} is either an iterator or a sequence, returns a iterator
384that will return \code{(0, \var{thing[0]})}, \code{(1,
385\var{thing[1]})}, \code{(2, \var{thing[2]})}, and so forth. Fairly
386often you'll see code to change every element of a list that looks
387like this:
388
389\begin{verbatim}
390for i in range(len(L)):
391 item = L[i]
392 # ... compute some result based on item ...
393 L[i] = result
394\end{verbatim}
395
396This can be rewritten using \function{enumerate()} as:
397
398\begin{verbatim}
399for i, item in enumerate(L):
400 # ... compute some result based on item ...
401 L[i] = result
402\end{verbatim}
403
404
405\begin{seealso}
406
Fred Drake5c4cf152002-11-13 14:59:06 +0000407\seepep{279}{The enumerate() built-in function}{Written
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +0000408by Raymond D. Hettinger.}
409
410\end{seealso}
411
412
Andrew M. Kuchlingf3676512002-04-15 02:27:55 +0000413%======================================================================
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000414\section{PEP 282: The \module{logging} Package}
415
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000416A standard package for writing logs called \module{logging} has been
417added to Python 2.3. It provides a powerful and flexible way for
418components to generate logging output which can then be filtered and
419processed in various ways. A standard configuration file format can
420be used to control the logging behaviour of a program. Python comes
421with handlers that will write log records to standard error or to a
422file or socket, send them to the system log, or even e-mail them to a
423particular address, and of course it's also possible to write your own
424handler classes.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000425
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000426Most application code will deal with one or more \class{Logger}
427objects, each one used by a particular subsystem of the application.
428Each \class{Logger} is identified by a name, and names are organized
429into a hierarchy using \samp{.} as the component separator. For
430example, you might have \class{Logger} instances named \samp{server},
431\samp{server.auth} and \samp{server.network}. The latter two
432instances fall under the \samp{server} \class{Logger} in the
433hierarchy. This means that if you turn up the verbosity for
434\samp{server} or direct \samp{server} messages to a different handler,
435the changes will also apply to records logged to \samp{server.auth}
436and \samp{server.network}. There's also a root \class{Logger} with
437the name \samp{root} that's the parent of all other loggers.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000438
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000439For simple uses, the \module{logging} package contains some
440convenience functions that always use the root log:
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000441
442\begin{verbatim}
443import logging
444
445logging.debug('Debugging information')
446logging.info('Informational message')
447logging.warn('Warning: config file %s not found', 'server.conf')
448logging.error('Error occurred')
449logging.critical('Critical error -- shutting down')
450\end{verbatim}
451
452This produces the following output:
453
454\begin{verbatim}
455WARN:root:Warning: config file not found
456ERROR:root:Error occurred
457CRITICAL:root:Critical error -- shutting down
458\end{verbatim}
459
460In the default configuration, informational and debugging messages are
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000461suppressed and the output is sent to standard error; you can change
462this by calling the \method{setLevel()} method on the root logger.
463
464Notice the \function{warn()} call's use of string formatting
465operators; all of the functions for logging messages take the
466arguments \code{(\var{msg}, \var{arg1}, \var{arg2}, ...)} and log the
467string resulting from \code{\var{msg} \% (\var{arg1}, \var{arg2},
468...)}.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000469
470There's also an \function{exception()} function that records the most
471recent traceback. Any of the other functions will also record the
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000472traceback if you specify a true value for the keyword argument
473\code{exc_info}.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000474
475\begin{verbatim}
476def f():
477 try: 1/0
478 except: logging.exception('Problem recorded')
479
480f()
481\end{verbatim}
482
483This produces the following output:
484
485\begin{verbatim}
486ERROR:root:Problem recorded
487Traceback (most recent call last):
488 File "t.py", line 6, in f
489 1/0
490ZeroDivisionError: integer division or modulo by zero
491\end{verbatim}
492
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000493Slightly more advanced programs will use a logger other than the root
494logger. The \function{getLogger(\var{name})} is used to get a
495particular log, creating it if it doesn't exist yet.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000496
497\begin{verbatim}
498log = logging.getLogger('server')
499 ...
500log.info('Listening on port %i', port)
501 ...
502log.critical('Disk full')
503 ...
504\end{verbatim}
505
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000506There are more classes that can be customized. When a \class{Logger}
507instance is told to log a message, it creates a \class{LogRecord}
508instance that is sent to any number of different \class{Handler}
509instances. Loggers and handlers can also have an attached list of
510filters, and each filter can cause the \class{LogRecord} to be ignored
511or can modify the record before passing it along. \class{LogRecord}
512instances are converted to text by a \class{Formatter} class.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000513
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000514Log records are usually propagated up the hierarchy, so a message
515logged to \samp{server.auth} is also seen by \samp{server} and
516\samp{root}, but a handler can prevent this by setting its
Andrew M. Kuchlingb6f79592002-11-29 19:43:45 +0000517\member{propagate} attribute to \code{False}.
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000518
519With all of these features the \module{logging} package should provide
520enough flexibility for even the most complicated applications. This
521is only a partial overview of the \module{logging} package's features,
522so please see the
Andrew M. Kuchling9e7453d2002-11-25 16:02:13 +0000523\ulink{package's reference documentation}{http://www.python.org/dev/doc/devel/lib/module-logging.html}
524for all of the details. Reading \pep{282} will also be helpful.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000525
526
527\begin{seealso}
528
529\seepep{282}{A Logging System}{Written by Vinay Sajip and Trent Mick;
530implemented by Vinay Sajip.}
531
532\end{seealso}
533
534
535%======================================================================
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000536\section{PEP 285: The \class{bool} Type\label{section-bool}}
537
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000538A Boolean type was added to Python 2.3. Two new constants were added
539to the \module{__builtin__} module, \constant{True} and
540\constant{False}. The type object for this new type is named
541\class{bool}; the constructor for it takes any Python value and
542converts it to \constant{True} or \constant{False}.
543
544\begin{verbatim}
545>>> bool(1)
546True
547>>> bool(0)
548False
549>>> bool([])
550False
551>>> bool( (1,) )
552True
553\end{verbatim}
554
555Most of the standard library modules and built-in functions have been
556changed to return Booleans.
557
558\begin{verbatim}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000559>>> obj = []
560>>> hasattr(obj, 'append')
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000561True
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000562>>> isinstance(obj, list)
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000563True
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000564>>> isinstance(obj, tuple)
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000565False
566\end{verbatim}
567
568Python's Booleans were added with the primary goal of making code
569clearer. For example, if you're reading a function and encounter the
Fred Drake5c4cf152002-11-13 14:59:06 +0000570statement \code{return 1}, you might wonder whether the \code{1}
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000571represents a truth value, or whether it's an index, or whether it's a
572coefficient that multiplies some other quantity. If the statement is
573\code{return True}, however, the meaning of the return value is quite
574clearly a truth value.
575
576Python's Booleans were not added for the sake of strict type-checking.
Andrew M. Kuchlinga2a206b2002-05-24 21:08:58 +0000577A very strict language such as Pascal would also prevent you
578performing arithmetic with Booleans, and would require that the
579expression in an \keyword{if} statement always evaluate to a Boolean.
580Python is not this strict, and it never will be. (\pep{285}
581explicitly says so.) So you can still use any expression in an
582\keyword{if}, even ones that evaluate to a list or tuple or some
583random object, and the Boolean type is a subclass of the
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000584\class{int} class, so arithmetic using a Boolean still works.
585
586\begin{verbatim}
587>>> True + 1
5882
589>>> False + 1
5901
591>>> False * 75
5920
593>>> True * 75
59475
595\end{verbatim}
596
597To sum up \constant{True} and \constant{False} in a sentence: they're
598alternative ways to spell the integer values 1 and 0, with the single
599difference that \function{str()} and \function{repr()} return the
Fred Drake5c4cf152002-11-13 14:59:06 +0000600strings \code{'True'} and \code{'False'} instead of \code{'1'} and
601\code{'0'}.
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000602
603\begin{seealso}
604
605\seepep{285}{Adding a bool type}{Written and implemented by GvR.}
606
607\end{seealso}
608
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000609
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000610%======================================================================
611\section{PEP 293: Codec Error Handling Callbacks}
612
Martin v. Löwis20eae692002-10-07 19:01:07 +0000613When encoding a Unicode string into a byte string, unencodable
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000614characters may be encountered. So far, Python has allowed specifying
615the error processing as either ``strict'' (raising
616\exception{UnicodeError}), ``ignore'' (skip the character), or
617``replace'' (with question mark), defaulting to ``strict''. It may be
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +0000618desirable to specify an alternative processing of the error, such as
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000619inserting an XML character reference or HTML entity reference into the
620converted string.
Martin v. Löwis20eae692002-10-07 19:01:07 +0000621
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +0000622Python now has a flexible framework to add different processing
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000623strategies. New error handlers can be added with
Martin v. Löwis20eae692002-10-07 19:01:07 +0000624\function{codecs.register_error}. Codecs then can access the error
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000625handler with \function{codecs.lookup_error}. An equivalent C API has
626been added for codecs written in C. The error handler gets the
627necessary state information, such as the string being converted, the
628position in the string where the error was detected, and the target
629encoding. The handler can then either raise an exception, or return a
630replacement string.
Martin v. Löwis20eae692002-10-07 19:01:07 +0000631
632Two additional error handlers have been implemented using this
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000633framework: ``backslashreplace'' uses Python backslash quoting to
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +0000634represent unencodable characters and ``xmlcharrefreplace'' emits
Martin v. Löwis20eae692002-10-07 19:01:07 +0000635XML character references.
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000636
637\begin{seealso}
638
Fred Drake5c4cf152002-11-13 14:59:06 +0000639\seepep{293}{Codec Error Handling Callbacks}{Written and implemented by
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000640Walter D\"orwald.}
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000641
642\end{seealso}
643
644
645%======================================================================
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000646\section{Extended Slices\label{section-slices}}
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000647
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000648Ever since Python 1.4, the slicing syntax has supported an optional
649third ``step'' or ``stride'' argument. For example, these are all
650legal Python syntax: \code{L[1:10:2]}, \code{L[:-1:1]},
651\code{L[::-1]}. This was added to Python included at the request of
652the developers of Numerical Python. However, the built-in sequence
653types of lists, tuples, and strings have never supported this feature,
654and you got a \exception{TypeError} if you tried it. Michael Hudson
Fred Drake5c4cf152002-11-13 14:59:06 +0000655contributed a patch that was applied to Python 2.3 and fixed this
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000656shortcoming.
657
658For example, you can now easily extract the elements of a list that
659have even indexes:
Fred Drakedf872a22002-07-03 12:02:01 +0000660
661\begin{verbatim}
662>>> L = range(10)
663>>> L[::2]
664[0, 2, 4, 6, 8]
665\end{verbatim}
666
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000667Negative values also work, so you can make a copy of the same list in
668reverse order:
Fred Drakedf872a22002-07-03 12:02:01 +0000669
670\begin{verbatim}
671>>> L[::-1]
672[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
673\end{verbatim}
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000674
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000675This also works for strings:
676
677\begin{verbatim}
678>>> s='abcd'
679>>> s[::2]
680'ac'
681>>> s[::-1]
682'dcba'
683\end{verbatim}
684
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000685as well as tuples and arrays.
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000686
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000687If you have a mutable sequence (i.e. a list or an array) you can
688assign to or delete an extended slice, but there are some differences
689in assignment to extended and regular slices. Assignment to a regular
690slice can be used to change the length of the sequence:
691
692\begin{verbatim}
693>>> a = range(3)
694>>> a
695[0, 1, 2]
696>>> a[1:3] = [4, 5, 6]
697>>> a
698[0, 4, 5, 6]
699\end{verbatim}
700
701but when assigning to an extended slice the list on the right hand
702side of the statement must contain the same number of items as the
703slice it is replacing:
704
705\begin{verbatim}
706>>> a = range(4)
707>>> a
708[0, 1, 2, 3]
709>>> a[::2]
710[0, 2]
711>>> a[::2] = range(0, -2, -1)
712>>> a
713[0, 1, -1, 3]
714>>> a[::2] = range(3)
715Traceback (most recent call last):
716 File "<stdin>", line 1, in ?
717ValueError: attempt to assign list of size 3 to extended slice of size 2
718\end{verbatim}
719
720Deletion is more straightforward:
721
722\begin{verbatim}
723>>> a = range(4)
724>>> a[::2]
725[0, 2]
726>>> del a[::2]
727>>> a
728[1, 3]
729\end{verbatim}
730
731One can also now pass slice objects to builtin sequences
732\method{__getitem__} methods:
733
734\begin{verbatim}
735>>> range(10).__getitem__(slice(0, 5, 2))
736[0, 2, 4]
737\end{verbatim}
738
739or use them directly in subscripts:
740
741\begin{verbatim}
742>>> range(10)[slice(0, 5, 2)]
743[0, 2, 4]
744\end{verbatim}
745
Andrew M. Kuchlingb6f79592002-11-29 19:43:45 +0000746To simplify implementing sequences that support extended slicing,
747slice objects now have a method \method{indices(\var{length})} which,
748given the length of a sequence, returns a \code{(start, stop, step)}
749tuple that can be passed directly to \function{range()}.
750\method{indices()} handles omitted and out-of-bounds indices in a
751manner consistent with regular slices (and this innocuous phrase hides
752a welter of confusing details!). The method is intended to be used
753like this:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000754
755\begin{verbatim}
756class FakeSeq:
757 ...
758 def calc_item(self, i):
759 ...
760 def __getitem__(self, item):
761 if isinstance(item, slice):
Fred Drake5c4cf152002-11-13 14:59:06 +0000762 return FakeSeq([self.calc_item(i)
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000763 in range(*item.indices(len(self)))])
Fred Drake5c4cf152002-11-13 14:59:06 +0000764 else:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000765 return self.calc_item(i)
766\end{verbatim}
767
Andrew M. Kuchling90e9a792002-08-15 00:40:21 +0000768From this example you can also see that the builtin ``\class{slice}''
769object is now the type object for the slice type, and is no longer a
770function. This is consistent with Python 2.2, where \class{int},
771\class{str}, etc., underwent the same change.
772
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000773
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000774%======================================================================
Fred Drakedf872a22002-07-03 12:02:01 +0000775\section{Other Language Changes}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000776
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000777Here are all of the changes that Python 2.3 makes to the core Python
778language.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000779
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000780\begin{itemize}
781\item The \keyword{yield} statement is now always a keyword, as
782described in section~\ref{section-generators} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000783
Fred Drake5c4cf152002-11-13 14:59:06 +0000784\item A new built-in function \function{enumerate()}
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000785was added, as described in section~\ref{section-enumerate} of this
786document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000787
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000788\item Two new constants, \constant{True} and \constant{False} were
789added along with the built-in \class{bool} type, as described in
790section~\ref{section-bool} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000791
Andrew M. Kuchling495172c2002-11-20 13:50:15 +0000792\item The \function{int()} type constructor will now return a long
793integer instead of raising an \exception{OverflowError} when a string
794or floating-point number is too large to fit into an integer. This
795can lead to the paradoxical result that
796\code{isinstance(int(\var{expression}), int)} is false, but that seems unlikely to cause problems in practice.
797
Fred Drake5c4cf152002-11-13 14:59:06 +0000798\item Built-in types now support the extended slicing syntax,
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000799as described in section~\ref{section-slices} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000800
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000801\item Dictionaries have a new method, \method{pop(\var{key})}, that
802returns the value corresponding to \var{key} and removes that
803key/value pair from the dictionary. \method{pop()} will raise a
804\exception{KeyError} if the requested key isn't present in the
805dictionary:
806
807\begin{verbatim}
808>>> d = {1:2}
809>>> d
810{1: 2}
811>>> d.pop(4)
812Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000813 File "stdin", line 1, in ?
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000814KeyError: 4
815>>> d.pop(1)
8162
817>>> d.pop(1)
818Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000819 File "stdin", line 1, in ?
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000820KeyError: pop(): dictionary is empty
821>>> d
822{}
823>>>
824\end{verbatim}
825
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +0000826There's also a new class method,
827\method{dict.fromkeys(\var{iterable}, \var{value})}, that
828creates a dictionary with keys taken from the supplied iterator
829\var{iterable} and all values set to \var{value}, defaulting to
830\code{None}.
831
832(Patches contributed by Raymond Hettinger.)
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000833
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +0000834\item The \keyword{assert} statement no longer checks the \code{__debug__}
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000835flag, so you can no longer disable assertions by assigning to \code{__debug__}.
Fred Drake5c4cf152002-11-13 14:59:06 +0000836Running Python with the \programopt{-O} switch will still generate
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000837code that doesn't execute any assertions.
838
839\item Most type objects are now callable, so you can use them
840to create new objects such as functions, classes, and modules. (This
841means that the \module{new} module can be deprecated in a future
842Python version, because you can now use the type objects available
843in the \module{types} module.)
844% XXX should new.py use PendingDeprecationWarning?
845For example, you can create a new module object with the following code:
846
847\begin{verbatim}
848>>> import types
849>>> m = types.ModuleType('abc','docstring')
850>>> m
851<module 'abc' (built-in)>
852>>> m.__doc__
853'docstring'
854\end{verbatim}
855
Fred Drake5c4cf152002-11-13 14:59:06 +0000856\item
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000857A new warning, \exception{PendingDeprecationWarning} was added to
858indicate features which are in the process of being
859deprecated. The warning will \emph{not} be printed by default. To
860check for use of features that will be deprecated in the future,
861supply \programopt{-Walways::PendingDeprecationWarning::} on the
862command line or use \function{warnings.filterwarnings()}.
863
864\item Using \code{None} as a variable name will now result in a
865\exception{SyntaxWarning} warning. In a future version of Python,
866\code{None} may finally become a keyword.
867
Andrew M. Kuchlingb60ea3f2002-11-15 14:37:10 +0000868\item The method resolution order used by new-style classes has
869changed, though you'll only notice the difference if you have a really
870complicated inheritance hierarchy. (Classic classes are unaffected by
871this change.) Python 2.2 originally used a topological sort of a
872class's ancestors, but 2.3 now uses the C3 algorithm as described in
Andrew M. Kuchling6f429c32002-11-19 13:09:00 +0000873the paper \ulink{``A Monotonic Superclass Linearization for
874Dylan''}{http://www.webcom.com/haahr/dylan/linearization-oopsla96.html}.
875To understand the motivation for this change, read the thread on
876python-dev starting with the message at
Andrew M. Kuchlingb60ea3f2002-11-15 14:37:10 +0000877\url{http://mail.python.org/pipermail/python-dev/2002-October/029035.html}.
878Samuele Pedroni first pointed out the problem and also implemented the
879fix by coding the C3 algorithm.
880
Andrew M. Kuchlingdcfd8252002-09-13 22:21:42 +0000881\item Python runs multithreaded programs by switching between threads
882after executing N bytecodes. The default value for N has been
883increased from 10 to 100 bytecodes, speeding up single-threaded
884applications by reducing the switching overhead. Some multithreaded
885applications may suffer slower response time, but that's easily fixed
886by setting the limit back to a lower number by calling
887\function{sys.setcheckinterval(\var{N})}.
888
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000889\item One minor but far-reaching change is that the names of extension
890types defined by the modules included with Python now contain the
Fred Drake5c4cf152002-11-13 14:59:06 +0000891module and a \character{.} in front of the type name. For example, in
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000892Python 2.2, if you created a socket and printed its
893\member{__class__}, you'd get this output:
894
895\begin{verbatim}
896>>> s = socket.socket()
897>>> s.__class__
898<type 'socket'>
899\end{verbatim}
900
901In 2.3, you get this:
902\begin{verbatim}
903>>> s.__class__
904<type '_socket.socket'>
905\end{verbatim}
906
Michael W. Hudson96bc3b42002-11-26 14:48:23 +0000907\item One of the noted incompatibilities between old- and new-style
908 classes has been removed: you can now assign to the
909 \member{__name__} and \member{__bases__} attributes of new-style
910 classes. There are some restrictions on what can be assigned to
911 \member{__bases__} along the lines of those relating to assigning to
912 an instance's \member{__class__} attribute.
913
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000914\end{itemize}
915
916
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000917%======================================================================
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000918\subsection{String Changes}
919
920\begin{itemize}
921
922\item The \code{in} operator now works differently for strings.
923Previously, when evaluating \code{\var{X} in \var{Y}} where \var{X}
924and \var{Y} are strings, \var{X} could only be a single character.
925That's now changed; \var{X} can be a string of any length, and
926\code{\var{X} in \var{Y}} will return \constant{True} if \var{X} is a
927substring of \var{Y}. If \var{X} is the empty string, the result is
928always \constant{True}.
929
930\begin{verbatim}
931>>> 'ab' in 'abcd'
932True
933>>> 'ad' in 'abcd'
934False
935>>> '' in 'abcd'
936True
937\end{verbatim}
938
939Note that this doesn't tell you where the substring starts; the
940\method{find()} method is still necessary to figure that out.
941
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000942\item The \method{strip()}, \method{lstrip()}, and \method{rstrip()}
943string methods now have an optional argument for specifying the
944characters to strip. The default is still to remove all whitespace
945characters:
946
947\begin{verbatim}
948>>> ' abc '.strip()
949'abc'
950>>> '><><abc<><><>'.strip('<>')
951'abc'
952>>> '><><abc<><><>\n'.strip('<>')
953'abc<><><>\n'
954>>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
955u'\u4001abc'
956>>>
957\end{verbatim}
958
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +0000959(Suggested by Simon Brunning, and implemented by Walter D\"orwald.)
Andrew M. Kuchling346386f2002-07-12 20:24:42 +0000960
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000961\item The \method{startswith()} and \method{endswith()}
962string methods now accept negative numbers for the start and end
963parameters.
964
965\item Another new string method is \method{zfill()}, originally a
966function in the \module{string} module. \method{zfill()} pads a
967numeric string with zeros on the left until it's the specified width.
968Note that the \code{\%} operator is still more flexible and powerful
969than \method{zfill()}.
970
971\begin{verbatim}
972>>> '45'.zfill(4)
973'0045'
974>>> '12345'.zfill(4)
975'12345'
976>>> 'goofy'.zfill(6)
977'0goofy'
978\end{verbatim}
979
Andrew M. Kuchling346386f2002-07-12 20:24:42 +0000980(Contributed by Walter D\"orwald.)
981
Fred Drake5c4cf152002-11-13 14:59:06 +0000982\item A new type object, \class{basestring}, has been added.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +0000983 Both 8-bit strings and Unicode strings inherit from this type, so
984 \code{isinstance(obj, basestring)} will return \constant{True} for
985 either kind of string. It's a completely abstract type, so you
986 can't create \class{basestring} instances.
987
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000988\item Interned strings are no longer immortal. Interned will now be
989garbage-collected in the usual way when the only reference to them is
990from the internal dictionary of interned strings. (Implemented by
991Oren Tirosh.)
992
993\end{itemize}
994
995
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000996%======================================================================
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000997\subsection{Optimizations}
998
999\begin{itemize}
1000
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001001\item The \method{sort()} method of list objects has been extensively
1002rewritten by Tim Peters, and the implementation is significantly
1003faster.
1004
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001005\item Multiplication of large long integers is now much faster thanks
1006to an implementation of Karatsuba multiplication, an algorithm that
1007scales better than the O(n*n) required for the grade-school
1008multiplication algorithm. (Original patch by Christopher A. Craig,
1009and significantly reworked by Tim Peters.)
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001010
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001011\item The \code{SET_LINENO} opcode is now gone. This may provide a
1012small speed increase, subject to your compiler's idiosyncrasies.
1013(Removed by Michael Hudson.)
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001014
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001015\item A number of small rearrangements have been made in various
1016hotspots to improve performance, inlining a function here, removing
1017some code there. (Implemented mostly by GvR, but lots of people have
1018contributed to one change or another.)
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001019
1020\end{itemize}
Neal Norwitzd68f5172002-05-29 15:54:55 +00001021
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001022
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001023%======================================================================
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001024\section{New and Improved Modules}
1025
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001026As usual, Python's standard modules had a number of enhancements and
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001027bug fixes. Here's a partial list of the most notable changes, sorted
1028alphabetically by module name. Consult the
1029\file{Misc/NEWS} file in the source tree for a more
1030complete list of changes, or look through the CVS logs for all the
1031details.
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001032
1033\begin{itemize}
1034
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001035\item The \module{array} module now supports arrays of Unicode
Fred Drake5c4cf152002-11-13 14:59:06 +00001036characters using the \character{u} format character. Arrays also now
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001037support using the \code{+=} assignment operator to add another array's
1038contents, and the \code{*=} assignment operator to repeat an array.
1039(Contributed by Jason Orendorff.)
1040
Andrew M. Kuchling669249e2002-11-19 13:05:33 +00001041\item The \module{bsddb} module has been updated to version 3.4.0
1042of the \ulink{PyBSDDB}{http://pybsddb.sourceforge.net} package,
1043providing a more complete interface to the transactional features of
1044the BerkeleyDB library.
1045The old version of the module has been renamed to
1046\module{bsddb185} and is no longer built automatically; you'll
1047have to edit \file{Modules/Setup} to enable it. Note that the new
1048\module{bsddb} package is intended to be compatible with the
1049old module, so be sure to file bugs if you discover any
1050incompatibilities.
1051
Fred Drake5c4cf152002-11-13 14:59:06 +00001052\item The Distutils \class{Extension} class now supports
1053an extra constructor argument named \var{depends} for listing
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001054additional source files that an extension depends on. This lets
1055Distutils recompile the module if any of the dependency files are
Fred Drake5c4cf152002-11-13 14:59:06 +00001056modified. For example, if \file{sampmodule.c} includes the header
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001057file \file{sample.h}, you would create the \class{Extension} object like
1058this:
1059
1060\begin{verbatim}
1061ext = Extension("samp",
1062 sources=["sampmodule.c"],
1063 depends=["sample.h"])
1064\end{verbatim}
1065
1066Modifying \file{sample.h} would then cause the module to be recompiled.
1067(Contributed by Jeremy Hylton.)
1068
Andrew M. Kuchlingdc3f7e12002-11-04 20:05:10 +00001069\item Other minor changes to Distutils:
1070it now checks for the \envvar{CC}, \envvar{CFLAGS}, \envvar{CPP},
1071\envvar{LDFLAGS}, and \envvar{CPPFLAGS} environment variables, using
1072them to override the settings in Python's configuration (contributed
Andrew M. Kuchling53262572002-12-01 14:00:21 +00001073by Robert Weber); the \function{get_distutils_options()} method lists
Andrew M. Kuchlingdc3f7e12002-11-04 20:05:10 +00001074recently-added extensions to Distutils.
1075
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001076\item The \module{getopt} module gained a new function,
1077\function{gnu_getopt()}, that supports the same arguments as the existing
Fred Drake5c4cf152002-11-13 14:59:06 +00001078\function{getopt()} function but uses GNU-style scanning mode.
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001079The existing \function{getopt()} stops processing options as soon as a
1080non-option argument is encountered, but in GNU-style mode processing
1081continues, meaning that options and arguments can be mixed. For
1082example:
1083
1084\begin{verbatim}
1085>>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1086([('-f', 'filename')], ['output', '-v'])
1087>>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1088([('-f', 'filename'), ('-v', '')], ['output'])
1089\end{verbatim}
1090
1091(Contributed by Peter \AA{strand}.)
1092
1093\item The \module{grp}, \module{pwd}, and \module{resource} modules
Fred Drake5c4cf152002-11-13 14:59:06 +00001094now return enhanced tuples:
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001095
1096\begin{verbatim}
1097>>> import grp
1098>>> g = grp.getgrnam('amk')
1099>>> g.gr_name, g.gr_gid
1100('amk', 500)
1101\end{verbatim}
1102
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001103\item The new \module{heapq} module contains an implementation of a
1104heap queue algorithm. A heap is an array-like data structure that
1105keeps items in a sorted order such that, for every index k, heap[k] <=
1106heap[2*k+1] and heap[k] <= heap[2*k+2]. This makes it quick to remove
1107the smallest item, and inserting a new item while maintaining the heap
1108property is O(lg~n). (See
1109\url{http://www.nist.gov/dads/HTML/priorityque.html} for more
1110information about the priority queue data structure.)
1111
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001112The \module{heapq} module provides \function{heappush()} and
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001113\function{heappop()} functions for adding and removing items while
1114maintaining the heap property on top of some other mutable Python
1115sequence type. For example:
1116
1117\begin{verbatim}
1118>>> import heapq
1119>>> heap = []
1120>>> for item in [3, 7, 5, 11, 1]:
1121... heapq.heappush(heap, item)
1122...
1123>>> heap
1124[1, 3, 5, 11, 7]
1125>>> heapq.heappop(heap)
11261
1127>>> heapq.heappop(heap)
11283
1129>>> heap
1130[5, 7, 11]
1131>>>
1132>>> heapq.heappush(heap, 5)
1133>>> heap = []
1134>>> for item in [3, 7, 5, 11, 1]:
1135... heapq.heappush(heap, item)
1136...
1137>>> heap
1138[1, 3, 5, 11, 7]
1139>>> heapq.heappop(heap)
11401
1141>>> heapq.heappop(heap)
11423
1143>>> heap
1144[5, 7, 11]
1145>>>
1146\end{verbatim}
1147
1148(Contributed by Kevin O'Connor.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001149
Fred Drake5c4cf152002-11-13 14:59:06 +00001150\item Two new functions in the \module{math} module,
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001151\function{degrees(\var{rads})} and \function{radians(\var{degs})},
Fred Drake5c4cf152002-11-13 14:59:06 +00001152convert between radians and degrees. Other functions in the
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001153\module{math} module such as
1154\function{math.sin()} and \function{math.cos()} have always required
1155input values measured in radians. (Contributed by Raymond Hettinger.)
1156
Andrew M. Kuchlingc309cca2002-10-10 16:04:08 +00001157\item Seven new functions, \function{getpgid()}, \function{killpg()},
1158\function{lchown()}, \function{major()}, \function{makedev()},
1159\function{minor()}, and \function{mknod()}, were added to the
1160\module{posix} module that underlies the \module{os} module.
1161(Contributed by Gustavo Niemeyer and Geert Jansen.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001162
Andrew M. Kuchling53262572002-12-01 14:00:21 +00001163\item The old and never-documented \module{linuxaudiodev} module has
1164been renamed to \module{ossaudiodev}, because the OSS sound drivers
1165can be used on platforms other than Linux. The interface has also
1166been tidied and brought up to date in various ways. (Contributed by
1167Greg Ward.)
1168
Fred Drake5c4cf152002-11-13 14:59:06 +00001169\item The parser objects provided by the \module{pyexpat} module
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001170can now optionally buffer character data, resulting in fewer calls to
1171your character data handler and therefore faster performance. Setting
Fred Drake5c4cf152002-11-13 14:59:06 +00001172the parser object's \member{buffer_text} attribute to \constant{True}
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001173will enable buffering.
1174
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001175\item The \function{sample(\var{population}, \var{k})} function was
1176added to the \module{random} module. \var{population} is a sequence
1177containing the elements of a population, and \function{sample()}
1178chooses \var{k} elements from the population without replacing chosen
1179elements. \var{k} can be any value up to \code{len(\var{population})}.
1180For example:
1181
1182\begin{verbatim}
1183>>> pop = range(6) ; pop
1184[0, 1, 2, 3, 4, 5]
1185>>> random.sample(pop, 3) # Choose three elements
1186[0, 4, 3]
1187>>> random.sample(pop, 6) # Choose all six elements
1188[4, 5, 0, 3, 2, 1]
1189>>> random.sample(pop, 6) # Choose six again
1190[4, 2, 3, 0, 5, 1]
1191>>> random.sample(pop, 7) # Can't choose more than six
1192Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +00001193 File "<stdin>", line 1, in ?
1194 File "random.py", line 396, in sample
1195 raise ValueError, "sample larger than population"
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001196ValueError: sample larger than population
1197>>>
1198\end{verbatim}
1199
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001200\item The \module{readline} module also gained a number of new
1201functions: \function{get_history_item()},
1202\function{get_current_history_length()}, and \function{redisplay()}.
1203
1204\item Support for more advanced POSIX signal handling was added
1205to the \module{signal} module by adding the \function{sigpending},
1206\function{sigprocmask} and \function{sigsuspend} functions, where supported
1207by the platform. These functions make it possible to avoid some previously
1208unavoidable race conditions.
1209
1210\item The \module{socket} module now supports timeouts. You
1211can call the \method{settimeout(\var{t})} method on a socket object to
1212set a timeout of \var{t} seconds. Subsequent socket operations that
1213take longer than \var{t} seconds to complete will abort and raise a
Fred Drake5c4cf152002-11-13 14:59:06 +00001214\exception{socket.error} exception.
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001215
1216The original timeout implementation was by Tim O'Malley. Michael
1217Gilfix integrated it into the Python \module{socket} module, after the
1218patch had undergone a lengthy review. After it was checked in, Guido
1219van~Rossum rewrote parts of it. This is a good example of the free
1220software development process in action.
1221
Fred Drake5c4cf152002-11-13 14:59:06 +00001222\item The value of the C \constant{PYTHON_API_VERSION} macro is now exposed
Fred Drake583db0d2002-09-14 02:03:25 +00001223at the Python level as \code{sys.api_version}.
Andrew M. Kuchlingdcfd8252002-09-13 22:21:42 +00001224
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001225\item The new \module{textwrap} module contains functions for wrapping
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001226strings containing paragraphs of text. The \function{wrap(\var{text},
1227\var{width})} function takes a string and returns a list containing
1228the text split into lines of no more than the chosen width. The
1229\function{fill(\var{text}, \var{width})} function returns a single
1230string, reformatted to fit into lines no longer than the chosen width.
1231(As you can guess, \function{fill()} is built on top of
1232\function{wrap()}. For example:
1233
1234\begin{verbatim}
1235>>> import textwrap
1236>>> paragraph = "Not a whit, we defy augury: ... more text ..."
1237>>> textwrap.wrap(paragraph, 60)
Fred Drake5c4cf152002-11-13 14:59:06 +00001238["Not a whit, we defy augury: there's a special providence in",
1239 "the fall of a sparrow. If it be now, 'tis not to come; if it",
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001240 ...]
1241>>> print textwrap.fill(paragraph, 35)
1242Not a whit, we defy augury: there's
1243a special providence in the fall of
1244a sparrow. If it be now, 'tis not
1245to come; if it be not to come, it
1246will be now; if it be not now, yet
1247it will come: the readiness is all.
Fred Drake5c4cf152002-11-13 14:59:06 +00001248>>>
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001249\end{verbatim}
1250
1251The module also contains a \class{TextWrapper} class that actually
Fred Drake5c4cf152002-11-13 14:59:06 +00001252implements the text wrapping strategy. Both the
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001253\class{TextWrapper} class and the \function{wrap()} and
1254\function{fill()} functions support a number of additional keyword
1255arguments for fine-tuning the formatting; consult the module's
Fred Drake5c4cf152002-11-13 14:59:06 +00001256documentation for details.
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001257%XXX add a link to the module docs?
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001258(Contributed by Greg Ward.)
1259
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001260\item The \module{time} module's \function{strptime()} function has
Fred Drake5c4cf152002-11-13 14:59:06 +00001261long been an annoyance because it uses the platform C library's
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001262\function{strptime()} implementation, and different platforms
1263sometimes have odd bugs. Brett Cannon contributed a portable
1264implementation that's written in pure Python, which should behave
1265identically on all platforms.
1266
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001267\item The DOM implementation
1268in \module{xml.dom.minidom} can now generate XML output in a
1269particular encoding, by specifying an optional encoding argument to
1270the \method{toxml()} and \method{toprettyxml()} methods of DOM nodes.
1271
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001272\item The \function{*stat()} family of functions can now report
1273fractions of a second in a timestamp. Such time stamps are
1274represented as floats, similar to \function{time.time()}.
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001275
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001276During testing, it was found that some applications will break if time
1277stamps are floats. For compatibility, when using the tuple interface
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001278of the \class{stat_result}, time stamps are represented as integers.
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001279When using named fields (a feature first introduced in Python 2.2),
1280time stamps are still represented as ints, unless
1281\function{os.stat_float_times()} is invoked to enable float return
1282values:
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001283
1284\begin{verbatim}
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001285>>> os.stat("/tmp").st_mtime
12861034791200
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001287>>> os.stat_float_times(True)
1288>>> os.stat("/tmp").st_mtime
12891034791200.6335014
1290\end{verbatim}
1291
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001292In Python 2.4, the default will change to always returning floats.
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001293
1294Application developers should use this feature only if all their
1295libraries work properly when confronted with floating point time
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001296stamps, or if they use the tuple API. If used, the feature should be
1297activated on an application level instead of trying to enable it on a
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001298per-use basis.
1299
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001300\item Calling Tcl methods through \module{_tkinter} no longer
1301returns only strings. Instead, if Tcl returns other objects those
1302objects are converted to their Python equivalent, if one exists, or
1303wrapped with a \class{_tkinter.Tcl_Obj} object if no Python equivalent
1304exists. This behaviour can be controlled through the
1305\method{wantobjects()} method of \class{tkapp} objects.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001306
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001307When using \module{_tkinter} through the \module{Tkinter} module (as
1308most Tkinter applications will), this feature is always activated. It
1309should not cause compatibility problems, since Tkinter would always
1310convert string results to Python types where possible.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001311
1312If any incompatibilities are found, the old behaviour can be restored
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001313by setting the \member{wantobjects} variable in the \module{Tkinter}
1314module to false before creating the first \class{tkapp} object.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001315
1316\begin{verbatim}
1317import Tkinter
Martin v. Löwis8c8aa5d2002-11-26 21:39:48 +00001318Tkinter.wantobjects = 0
Martin v. Löwis39b48522002-11-26 09:47:25 +00001319\end{verbatim}
1320
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001321Please report any breakage caused by this change as a bug.
Martin v. Löwis39b48522002-11-26 09:47:25 +00001322
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001323\end{itemize}
1324
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001325
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001326%======================================================================
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001327\subsection{The \module{optparse} Module}
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001328
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001329The \module{getopt} module provides simple parsing of command-line
1330arguments. The new \module{optparse} module (originally named Optik)
1331provides more elaborate command-line parsing that follows the Unix
1332conventions, automatically creates the output for \longprogramopt{help},
1333and can perform different actions
1334
1335You start by creating an instance of \class{OptionParser} and telling
1336it what your program's options are.
1337
1338\begin{verbatim}
1339from optparse import OptionParser
1340
1341op = OptionParser()
1342op.add_option('-i', '--input',
1343 action='store', type='string', dest='input',
1344 help='set input filename')
1345op.add_option('-l', '--length',
1346 action='store', type='int', dest='length',
1347 help='set maximum length of output')
1348\end{verbatim}
1349
1350Parsing a command line is then done by calling the \method{parse_args()}
1351method.
1352
1353\begin{verbatim}
1354options, args = op.parse_args(sys.argv[1:])
1355print options
1356print args
1357\end{verbatim}
1358
1359This returns an object containing all of the option values,
1360and a list of strings containing the remaining arguments.
1361
1362Invoking the script with the various arguments now works as you'd
1363expect it to. Note that the length argument is automatically
1364converted to an integer.
1365
1366\begin{verbatim}
1367$ ./python opt.py -i data arg1
1368<Values at 0x400cad4c: {'input': 'data', 'length': None}>
1369['arg1']
1370$ ./python opt.py --input=data --length=4
1371<Values at 0x400cad2c: {'input': 'data', 'length': 4}>
1372['arg1']
1373$
1374\end{verbatim}
1375
1376The help message is automatically generated for you:
1377
1378\begin{verbatim}
1379$ ./python opt.py --help
1380usage: opt.py [options]
1381
1382options:
1383 -h, --help show this help message and exit
1384 -iINPUT, --input=INPUT
1385 set input filename
1386 -lLENGTH, --length=LENGTH
1387 set maximum length of output
1388$
1389\end{verbatim}
Andrew M. Kuchling669249e2002-11-19 13:05:33 +00001390% $ prevent Emacs tex-mode from getting confused
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001391
1392Optik was written by Greg Ward, with suggestions from the readers of
1393the Getopt SIG.
1394
1395\begin{seealso}
1396\seeurl{http://optik.sourceforge.net}
1397{The Optik site has tutorial and reference documentation for
1398\module{optparse}.
1399% XXX change to point to Python docs, when those docs get written.
1400}
1401\end{seealso}
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001402
1403
1404%======================================================================
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001405\section{Specialized Object Allocator (pymalloc)\label{section-pymalloc}}
1406
1407An experimental feature added to Python 2.1 was a specialized object
1408allocator called pymalloc, written by Vladimir Marangozov. Pymalloc
1409was intended to be faster than the system \cfunction{malloc()} and have
1410less memory overhead for typical allocation patterns of Python
1411programs. The allocator uses C's \cfunction{malloc()} function to get
1412large pools of memory, and then fulfills smaller memory requests from
1413these pools.
1414
1415In 2.1 and 2.2, pymalloc was an experimental feature and wasn't
1416enabled by default; you had to explicitly turn it on by providing the
1417\longprogramopt{with-pymalloc} option to the \program{configure}
1418script. In 2.3, pymalloc has had further enhancements and is now
1419enabled by default; you'll have to supply
1420\longprogramopt{without-pymalloc} to disable it.
1421
1422This change is transparent to code written in Python; however,
1423pymalloc may expose bugs in C extensions. Authors of C extension
1424modules should test their code with the object allocator enabled,
1425because some incorrect code may cause core dumps at runtime. There
1426are a bunch of memory allocation functions in Python's C API that have
1427previously been just aliases for the C library's \cfunction{malloc()}
1428and \cfunction{free()}, meaning that if you accidentally called
1429mismatched functions, the error wouldn't be noticeable. When the
1430object allocator is enabled, these functions aren't aliases of
1431\cfunction{malloc()} and \cfunction{free()} any more, and calling the
1432wrong function to free memory may get you a core dump. For example,
1433if memory was allocated using \cfunction{PyObject_Malloc()}, it has to
1434be freed using \cfunction{PyObject_Free()}, not \cfunction{free()}. A
1435few modules included with Python fell afoul of this and had to be
1436fixed; doubtless there are more third-party modules that will have the
1437same problem.
1438
1439As part of this change, the confusing multiple interfaces for
1440allocating memory have been consolidated down into two API families.
1441Memory allocated with one family must not be manipulated with
1442functions from the other family.
1443
1444There is another family of functions specifically for allocating
1445Python \emph{objects} (as opposed to memory).
1446
1447\begin{itemize}
1448 \item To allocate and free an undistinguished chunk of memory use
1449 the ``raw memory'' family: \cfunction{PyMem_Malloc()},
1450 \cfunction{PyMem_Realloc()}, and \cfunction{PyMem_Free()}.
1451
1452 \item The ``object memory'' family is the interface to the pymalloc
1453 facility described above and is biased towards a large number of
1454 ``small'' allocations: \cfunction{PyObject_Malloc},
1455 \cfunction{PyObject_Realloc}, and \cfunction{PyObject_Free}.
1456
1457 \item To allocate and free Python objects, use the ``object'' family
1458 \cfunction{PyObject_New()}, \cfunction{PyObject_NewVar()}, and
1459 \cfunction{PyObject_Del()}.
1460\end{itemize}
1461
1462Thanks to lots of work by Tim Peters, pymalloc in 2.3 also provides
1463debugging features to catch memory overwrites and doubled frees in
1464both extension modules and in the interpreter itself. To enable this
1465support, turn on the Python interpreter's debugging code by running
Fred Drake5c4cf152002-11-13 14:59:06 +00001466\program{configure} with \longprogramopt{with-pydebug}.
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001467
1468To aid extension writers, a header file \file{Misc/pymemcompat.h} is
1469distributed with the source to Python 2.3 that allows Python
1470extensions to use the 2.3 interfaces to memory allocation and compile
1471against any version of Python since 1.5.2. You would copy the file
1472from Python's source distribution and bundle it with the source of
1473your extension.
1474
1475\begin{seealso}
1476
1477\seeurl{http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/python/python/dist/src/Objects/obmalloc.c}
1478{For the full details of the pymalloc implementation, see
1479the comments at the top of the file \file{Objects/obmalloc.c} in the
1480Python source code. The above link points to the file within the
1481SourceForge CVS browser.}
1482
1483\end{seealso}
1484
1485
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001486% ======================================================================
1487\section{Build and C API Changes}
1488
Andrew M. Kuchling3c305d92002-07-22 18:50:11 +00001489Changes to Python's build process and to the C API include:
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001490
1491\begin{itemize}
1492
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001493\item The C-level interface to the garbage collector has been changed,
1494to make it easier to write extension types that support garbage
1495collection, and to make it easier to debug misuses of the functions.
1496Various functions have slightly different semantics, so a bunch of
1497functions had to be renamed. Extensions that use the old API will
1498still compile but will \emph{not} participate in garbage collection,
1499so updating them for 2.3 should be considered fairly high priority.
1500
1501To upgrade an extension module to the new API, perform the following
1502steps:
1503
1504\begin{itemize}
1505
1506\item Rename \cfunction{Py_TPFLAGS_GC} to \cfunction{PyTPFLAGS_HAVE_GC}.
1507
1508\item Use \cfunction{PyObject_GC_New} or \cfunction{PyObject_GC_NewVar} to
1509allocate objects, and \cfunction{PyObject_GC_Del} to deallocate them.
1510
1511\item Rename \cfunction{PyObject_GC_Init} to \cfunction{PyObject_GC_Track} and
1512\cfunction{PyObject_GC_Fini} to \cfunction{PyObject_GC_UnTrack}.
1513
1514\item Remove \cfunction{PyGC_HEAD_SIZE} from object size calculations.
1515
1516\item Remove calls to \cfunction{PyObject_AS_GC} and \cfunction{PyObject_FROM_GC}.
1517
1518\end{itemize}
1519
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001520\item Python can now optionally be built as a shared library
1521(\file{libpython2.3.so}) by supplying \longprogramopt{enable-shared}
Fred Drake5c4cf152002-11-13 14:59:06 +00001522when running Python's \program{configure} script. (Contributed by Ondrej
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +00001523Palkovsky.)
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +00001524
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001525\item The \csimplemacro{DL_EXPORT} and \csimplemacro{DL_IMPORT} macros
1526are now deprecated. Initialization functions for Python extension
1527modules should now be declared using the new macro
Andrew M. Kuchling3c305d92002-07-22 18:50:11 +00001528\csimplemacro{PyMODINIT_FUNC}, while the Python core will generally
1529use the \csimplemacro{PyAPI_FUNC} and \csimplemacro{PyAPI_DATA}
1530macros.
Neal Norwitzbba23a82002-07-22 13:18:59 +00001531
Fred Drake5c4cf152002-11-13 14:59:06 +00001532\item The interpreter can be compiled without any docstrings for
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001533the built-in functions and modules by supplying
Fred Drake5c4cf152002-11-13 14:59:06 +00001534\longprogramopt{without-doc-strings} to the \program{configure} script.
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001535This makes the Python executable about 10\% smaller, but will also
1536mean that you can't get help for Python's built-ins. (Contributed by
1537Gustavo Niemeyer.)
1538
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001539\item The cycle detection implementation used by the garbage collection
1540has proven to be stable, so it's now being made mandatory; you can no
1541longer compile Python without it, and the
Fred Drake5c4cf152002-11-13 14:59:06 +00001542\longprogramopt{with-cycle-gc} switch to \program{configure} has been removed.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001543
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001544\item The \cfunction{PyArg_NoArgs()} macro is now deprecated, and code
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00001545that uses it should be changed. For Python 2.2 and later, the method
1546definition table can specify the
Fred Drake5c4cf152002-11-13 14:59:06 +00001547\constant{METH_NOARGS} flag, signalling that there are no arguments, and
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00001548the argument checking can then be removed. If compatibility with
1549pre-2.2 versions of Python is important, the code could use
Fred Drake5c4cf152002-11-13 14:59:06 +00001550\code{PyArg_ParseTuple(args, "")} instead, but this will be slower
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00001551than using \constant{METH_NOARGS}.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001552
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001553\item A new function, \cfunction{PyObject_DelItemString(\var{mapping},
1554char *\var{key})} was added
Fred Drake5c4cf152002-11-13 14:59:06 +00001555as shorthand for
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001556\code{PyObject_DelItem(\var{mapping}, PyString_New(\var{key})}.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001557
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001558\item The \method{xreadlines()} method of file objects, introduced in
1559Python 2.1, is no longer necessary because files now behave as their
1560own iterator. \method{xreadlines()} was originally introduced as a
1561faster way to loop over all the lines in a file, but now you can
1562simply write \code{for line in file_obj}.
1563
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001564\item File objects now manage their internal string buffer
Fred Drake5c4cf152002-11-13 14:59:06 +00001565differently by increasing it exponentially when needed.
1566This results in the benchmark tests in \file{Lib/test/test_bufio.py}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001567speeding up from 57 seconds to 1.7 seconds, according to one
1568measurement.
1569
Andrew M. Kuchling72b58e02002-05-29 17:30:34 +00001570\item It's now possible to define class and static methods for a C
1571extension type by setting either the \constant{METH_CLASS} or
1572\constant{METH_STATIC} flags in a method's \ctype{PyMethodDef}
1573structure.
Andrew M. Kuchling45afd542002-04-02 14:25:25 +00001574
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00001575\item Python now includes a copy of the Expat XML parser's source code,
1576removing any dependence on a system version or local installation of
Fred Drake5c4cf152002-11-13 14:59:06 +00001577Expat.
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00001578
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001579\end{itemize}
1580
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001581
1582%======================================================================
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001583\subsection{Port-Specific Changes}
1584
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001585Support for a port to IBM's OS/2 using the EMX runtime environment was
1586merged into the main Python source tree. EMX is a POSIX emulation
1587layer over the OS/2 system APIs. The Python port for EMX tries to
1588support all the POSIX-like capability exposed by the EMX runtime, and
1589mostly succeeds; \function{fork()} and \function{fcntl()} are
1590restricted by the limitations of the underlying emulation layer. The
1591standard OS/2 port, which uses IBM's Visual Age compiler, also gained
1592support for case-sensitive import semantics as part of the integration
1593of the EMX port into CVS. (Contributed by Andrew MacIntyre.)
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001594
Andrew M. Kuchling72b58e02002-05-29 17:30:34 +00001595On MacOS, most toolbox modules have been weaklinked to improve
1596backward compatibility. This means that modules will no longer fail
1597to load if a single routine is missing on the curent OS version.
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001598Instead calling the missing routine will raise an exception.
1599(Contributed by Jack Jansen.)
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001600
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001601The RPM spec files, found in the \file{Misc/RPM/} directory in the
1602Python source distribution, were updated for 2.3. (Contributed by
1603Sean Reifschneider.)
Fred Drake03e10312002-03-26 19:17:43 +00001604
Andrew M. Kuchling3e3e1292002-10-10 11:32:30 +00001605Python now supports AtheOS (\url{http://www.atheos.cx}) and GNU/Hurd.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001606
Fred Drake03e10312002-03-26 19:17:43 +00001607
1608%======================================================================
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001609\section{Other Changes and Fixes}
1610
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00001611As usual, there were a bunch of other improvements and bugfixes
1612scattered throughout the source tree. A search through the CVS change
1613logs finds there were 289 patches applied and 323 bugs fixed between
1614Python 2.2 and 2.3. Both figures are likely to be underestimates.
1615
1616Some of the more notable changes are:
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001617
1618\begin{itemize}
1619
Fred Drake54fe3fd2002-11-26 22:07:35 +00001620\item The \file{regrtest.py} script now provides a way to allow ``all
1621resources except \var{foo}.'' A resource name passed to the
1622\programopt{-u} option can now be prefixed with a hyphen
1623(\character{-}) to mean ``remove this resource.'' For example, the
1624option `\code{\programopt{-u}all,-bsddb}' could be used to enable the
1625use of all resources except \code{bsddb}.
1626
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001627\item The tools used to build the documentation now work under Cygwin
1628as well as \UNIX.
1629
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001630\item The \code{SET_LINENO} opcode has been removed. Back in the
1631mists of time, this opcode was needed to produce line numbers in
1632tracebacks and support trace functions (for, e.g., \module{pdb}).
1633Since Python 1.5, the line numbers in tracebacks have been computed
1634using a different mechanism that works with ``python -O''. For Python
16352.3 Michael Hudson implemented a similar scheme to determine when to
1636call the trace function, removing the need for \code{SET_LINENO}
1637entirely.
1638
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00001639It would be difficult to detect any resulting difference from Python
1640code, apart from a slight speed up when Python is run without
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001641\programopt{-O}.
1642
1643C extensions that access the \member{f_lineno} field of frame objects
1644should instead call \code{PyCode_Addr2Line(f->f_code, f->f_lasti)}.
1645This will have the added effect of making the code work as desired
1646under ``python -O'' in earlier versions of Python.
1647
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001648\end{itemize}
1649
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001650
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001651%======================================================================
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001652\section{Porting to Python 2.3}
1653
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001654This section lists changes that may actually require changes to your code:
1655
1656\begin{itemize}
1657
1658\item \keyword{yield} is now always a keyword; if it's used as a
1659variable name in your code, a different name must be chosen.
1660
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001661\item For strings \var{X} and \var{Y}, \code{\var{X} in \var{Y}} now works
1662if \var{X} is more than one character long.
1663
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00001664\item The \function{int()} type constructor will now return a long
1665integer instead of raising an \exception{OverflowError} when a string
1666or floating-point number is too large to fit into an integer.
1667
Andrew M. Kuchlingb492fa92002-11-27 19:11:10 +00001668\item Calling Tcl methods through \module{_tkinter} no longer
1669returns only strings. Instead, if Tcl returns other objects those
1670objects are converted to their Python equivalent, if one exists, or
1671wrapped with a \class{_tkinter.Tcl_Obj} object if no Python equivalent
1672exists.
1673
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00001674\item You can no longer disable assertions by assigning to \code{__debug__}.
1675
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001676\item The Distutils \function{setup()} function has gained various new
Fred Drake5c4cf152002-11-13 14:59:06 +00001677keyword arguments such as \var{depends}. Old versions of the
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001678Distutils will abort if passed unknown keywords. The fix is to check
1679for the presence of the new \function{get_distutil_options()} function
1680in your \file{setup.py} if you want to only support the new keywords
1681with a version of the Distutils that supports them:
1682
1683\begin{verbatim}
1684from distutils import core
1685
1686kw = {'sources': 'foo.c', ...}
1687if hasattr(core, 'get_distutil_options'):
1688 kw['depends'] = ['foo.h']
Fred Drake5c4cf152002-11-13 14:59:06 +00001689ext = Extension(**kw)
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001690\end{verbatim}
1691
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00001692\item Using \code{None} as a variable name will now result in a
1693\exception{SyntaxWarning} warning.
1694
1695\item Names of extension types defined by the modules included with
1696Python now contain the module and a \character{.} in front of the type
1697name.
1698
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001699\end{itemize}
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001700
1701
1702%======================================================================
Fred Drake03e10312002-03-26 19:17:43 +00001703\section{Acknowledgements \label{acks}}
1704
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001705The author would like to thank the following people for offering
1706suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001707article: Simon Brunning, Michael Chermside, Scott David Daniels,
1708Fred~L. Drake, Jr., Michael Hudson, Detlef Lannert, Martin von
1709L\"owis, Andrew MacIntyre, Lalo Martins, Gustavo Niemeyer, Neal
Andrew M. Kuchlingb6f79592002-11-29 19:43:45 +00001710Norwitz, Chris Reedy, Neil Schemenauer, Jason Tishler.
Fred Drake03e10312002-03-26 19:17:43 +00001711
1712\end{document}