blob: 27519557b90611edd83f3bc72aee158e4bd2e49e [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
517\member{propagate} attribute to \code{True}.
518
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. Kuchling6f429c32002-11-19 13:09:00 +0000523\ulink{\module{logging} package's reference documentation}{http://www.python.org/dev/doc/devel/lib/module-logging.html}
524for all of the details. Reading
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000525\pep{282} will also be helpful.
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000526
527
528\begin{seealso}
529
530\seepep{282}{A Logging System}{Written by Vinay Sajip and Trent Mick;
531implemented by Vinay Sajip.}
532
533\end{seealso}
534
535
536%======================================================================
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000537\section{PEP 285: The \class{bool} Type\label{section-bool}}
538
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000539A Boolean type was added to Python 2.3. Two new constants were added
540to the \module{__builtin__} module, \constant{True} and
541\constant{False}. The type object for this new type is named
542\class{bool}; the constructor for it takes any Python value and
543converts it to \constant{True} or \constant{False}.
544
545\begin{verbatim}
546>>> bool(1)
547True
548>>> bool(0)
549False
550>>> bool([])
551False
552>>> bool( (1,) )
553True
554\end{verbatim}
555
556Most of the standard library modules and built-in functions have been
557changed to return Booleans.
558
559\begin{verbatim}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000560>>> obj = []
561>>> hasattr(obj, 'append')
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000562True
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000563>>> isinstance(obj, list)
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000564True
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000565>>> isinstance(obj, tuple)
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000566False
567\end{verbatim}
568
569Python's Booleans were added with the primary goal of making code
570clearer. For example, if you're reading a function and encounter the
Fred Drake5c4cf152002-11-13 14:59:06 +0000571statement \code{return 1}, you might wonder whether the \code{1}
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000572represents a truth value, or whether it's an index, or whether it's a
573coefficient that multiplies some other quantity. If the statement is
574\code{return True}, however, the meaning of the return value is quite
575clearly a truth value.
576
577Python's Booleans were not added for the sake of strict type-checking.
Andrew M. Kuchlinga2a206b2002-05-24 21:08:58 +0000578A very strict language such as Pascal would also prevent you
579performing arithmetic with Booleans, and would require that the
580expression in an \keyword{if} statement always evaluate to a Boolean.
581Python is not this strict, and it never will be. (\pep{285}
582explicitly says so.) So you can still use any expression in an
583\keyword{if}, even ones that evaluate to a list or tuple or some
584random object, and the Boolean type is a subclass of the
Andrew M. Kuchling821013e2002-05-06 17:46:39 +0000585\class{int} class, so arithmetic using a Boolean still works.
586
587\begin{verbatim}
588>>> True + 1
5892
590>>> False + 1
5911
592>>> False * 75
5930
594>>> True * 75
59575
596\end{verbatim}
597
598To sum up \constant{True} and \constant{False} in a sentence: they're
599alternative ways to spell the integer values 1 and 0, with the single
600difference that \function{str()} and \function{repr()} return the
Fred Drake5c4cf152002-11-13 14:59:06 +0000601strings \code{'True'} and \code{'False'} instead of \code{'1'} and
602\code{'0'}.
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000603
604\begin{seealso}
605
606\seepep{285}{Adding a bool type}{Written and implemented by GvR.}
607
608\end{seealso}
609
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000610
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000611%======================================================================
612\section{PEP 293: Codec Error Handling Callbacks}
613
Martin v. Löwis20eae692002-10-07 19:01:07 +0000614When encoding a Unicode string into a byte string, unencodable
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000615characters may be encountered. So far, Python has allowed specifying
616the error processing as either ``strict'' (raising
617\exception{UnicodeError}), ``ignore'' (skip the character), or
618``replace'' (with question mark), defaulting to ``strict''. It may be
619desirable to specify an alternative processing of the error, e.g. by
620inserting an XML character reference or HTML entity reference into the
621converted string.
Martin v. Löwis20eae692002-10-07 19:01:07 +0000622
623Python now has a flexible framework to add additional processing
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000624strategies. New error handlers can be added with
Martin v. Löwis20eae692002-10-07 19:01:07 +0000625\function{codecs.register_error}. Codecs then can access the error
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000626handler with \function{codecs.lookup_error}. An equivalent C API has
627been added for codecs written in C. The error handler gets the
628necessary state information, such as the string being converted, the
629position in the string where the error was detected, and the target
630encoding. The handler can then either raise an exception, or return a
631replacement string.
Martin v. Löwis20eae692002-10-07 19:01:07 +0000632
633Two additional error handlers have been implemented using this
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000634framework: ``backslashreplace'' uses Python backslash quoting to
Martin v. Löwis20eae692002-10-07 19:01:07 +0000635represent the unencodable character, and ``xmlcharrefreplace'' emits
636XML character references.
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000637
638\begin{seealso}
639
Fred Drake5c4cf152002-11-13 14:59:06 +0000640\seepep{293}{Codec Error Handling Callbacks}{Written and implemented by
Andrew M. Kuchling0a6fa962002-10-09 12:11:10 +0000641Walter D\"orwald.}
Andrew M. Kuchling65b72822002-09-03 00:53:21 +0000642
643\end{seealso}
644
645
646%======================================================================
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000647\section{Extended Slices\label{section-slices}}
Michael W. Hudson5efaf7e2002-06-11 10:55:12 +0000648
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000649Ever since Python 1.4, the slicing syntax has supported an optional
650third ``step'' or ``stride'' argument. For example, these are all
651legal Python syntax: \code{L[1:10:2]}, \code{L[:-1:1]},
652\code{L[::-1]}. This was added to Python included at the request of
653the developers of Numerical Python. However, the built-in sequence
654types of lists, tuples, and strings have never supported this feature,
655and you got a \exception{TypeError} if you tried it. Michael Hudson
Fred Drake5c4cf152002-11-13 14:59:06 +0000656contributed a patch that was applied to Python 2.3 and fixed this
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000657shortcoming.
658
659For example, you can now easily extract the elements of a list that
660have even indexes:
Fred Drakedf872a22002-07-03 12:02:01 +0000661
662\begin{verbatim}
663>>> L = range(10)
664>>> L[::2]
665[0, 2, 4, 6, 8]
666\end{verbatim}
667
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000668Negative values also work, so you can make a copy of the same list in
669reverse order:
Fred Drakedf872a22002-07-03 12:02:01 +0000670
671\begin{verbatim}
672>>> L[::-1]
673[9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
674\end{verbatim}
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000675
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000676This also works for strings:
677
678\begin{verbatim}
679>>> s='abcd'
680>>> s[::2]
681'ac'
682>>> s[::-1]
683'dcba'
684\end{verbatim}
685
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000686as well as tuples and arrays.
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000687
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000688If you have a mutable sequence (i.e. a list or an array) you can
689assign to or delete an extended slice, but there are some differences
690in assignment to extended and regular slices. Assignment to a regular
691slice can be used to change the length of the sequence:
692
693\begin{verbatim}
694>>> a = range(3)
695>>> a
696[0, 1, 2]
697>>> a[1:3] = [4, 5, 6]
698>>> a
699[0, 4, 5, 6]
700\end{verbatim}
701
702but when assigning to an extended slice the list on the right hand
703side of the statement must contain the same number of items as the
704slice it is replacing:
705
706\begin{verbatim}
707>>> a = range(4)
708>>> a
709[0, 1, 2, 3]
710>>> a[::2]
711[0, 2]
712>>> a[::2] = range(0, -2, -1)
713>>> a
714[0, 1, -1, 3]
715>>> a[::2] = range(3)
716Traceback (most recent call last):
717 File "<stdin>", line 1, in ?
718ValueError: attempt to assign list of size 3 to extended slice of size 2
719\end{verbatim}
720
721Deletion is more straightforward:
722
723\begin{verbatim}
724>>> a = range(4)
725>>> a[::2]
726[0, 2]
727>>> del a[::2]
728>>> a
729[1, 3]
730\end{verbatim}
731
732One can also now pass slice objects to builtin sequences
733\method{__getitem__} methods:
734
735\begin{verbatim}
736>>> range(10).__getitem__(slice(0, 5, 2))
737[0, 2, 4]
738\end{verbatim}
739
740or use them directly in subscripts:
741
742\begin{verbatim}
743>>> range(10)[slice(0, 5, 2)]
744[0, 2, 4]
745\end{verbatim}
746
747To make implementing sequences that support extended slicing in Python
748easier, slice ojects now have a method \method{indices} which given
749the length of a sequence returns \code{(start, stop, step)} handling
750omitted and out-of-bounds indices in a manner consistent with regular
751slices (and this innocuous phrase hides a welter of confusing
752details!). The method is intended to be used like this:
753
754\begin{verbatim}
755class FakeSeq:
756 ...
757 def calc_item(self, i):
758 ...
759 def __getitem__(self, item):
760 if isinstance(item, slice):
Fred Drake5c4cf152002-11-13 14:59:06 +0000761 return FakeSeq([self.calc_item(i)
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000762 in range(*item.indices(len(self)))])
Fred Drake5c4cf152002-11-13 14:59:06 +0000763 else:
Michael W. Hudson4da01ed2002-07-19 15:48:56 +0000764 return self.calc_item(i)
765\end{verbatim}
766
Andrew M. Kuchling90e9a792002-08-15 00:40:21 +0000767From this example you can also see that the builtin ``\class{slice}''
768object is now the type object for the slice type, and is no longer a
769function. This is consistent with Python 2.2, where \class{int},
770\class{str}, etc., underwent the same change.
771
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000772
Andrew M. Kuchling3a52ff62002-04-03 22:44:47 +0000773%======================================================================
Fred Drakedf872a22002-07-03 12:02:01 +0000774\section{Other Language Changes}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000775
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000776Here are all of the changes that Python 2.3 makes to the core Python
777language.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000778
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000779\begin{itemize}
780\item The \keyword{yield} statement is now always a keyword, as
781described in section~\ref{section-generators} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000782
Fred Drake5c4cf152002-11-13 14:59:06 +0000783\item A new built-in function \function{enumerate()}
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000784was added, as described in section~\ref{section-enumerate} of this
785document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000786
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000787\item Two new constants, \constant{True} and \constant{False} were
788added along with the built-in \class{bool} type, as described in
789section~\ref{section-bool} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000790
Andrew M. Kuchling495172c2002-11-20 13:50:15 +0000791\item The \function{int()} type constructor will now return a long
792integer instead of raising an \exception{OverflowError} when a string
793or floating-point number is too large to fit into an integer. This
794can lead to the paradoxical result that
795\code{isinstance(int(\var{expression}), int)} is false, but that seems unlikely to cause problems in practice.
796
Fred Drake5c4cf152002-11-13 14:59:06 +0000797\item Built-in types now support the extended slicing syntax,
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000798as described in section~\ref{section-slices} of this document.
Andrew M. Kuchling517109b2002-05-07 21:01:16 +0000799
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000800\item Dictionaries have a new method, \method{pop(\var{key})}, that
801returns the value corresponding to \var{key} and removes that
802key/value pair from the dictionary. \method{pop()} will raise a
803\exception{KeyError} if the requested key isn't present in the
804dictionary:
805
806\begin{verbatim}
807>>> d = {1:2}
808>>> d
809{1: 2}
810>>> d.pop(4)
811Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000812 File "stdin", line 1, in ?
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000813KeyError: 4
814>>> d.pop(1)
8152
816>>> d.pop(1)
817Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +0000818 File "stdin", line 1, in ?
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000819KeyError: pop(): dictionary is empty
820>>> d
821{}
822>>>
823\end{verbatim}
824
825(Patch contributed by Raymond Hettinger.)
826
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +0000827\item The \keyword{assert} statement no longer checks the \code{__debug__}
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000828flag, so you can no longer disable assertions by assigning to \code{__debug__}.
Fred Drake5c4cf152002-11-13 14:59:06 +0000829Running Python with the \programopt{-O} switch will still generate
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000830code that doesn't execute any assertions.
831
832\item Most type objects are now callable, so you can use them
833to create new objects such as functions, classes, and modules. (This
834means that the \module{new} module can be deprecated in a future
835Python version, because you can now use the type objects available
836in the \module{types} module.)
837% XXX should new.py use PendingDeprecationWarning?
838For example, you can create a new module object with the following code:
839
840\begin{verbatim}
841>>> import types
842>>> m = types.ModuleType('abc','docstring')
843>>> m
844<module 'abc' (built-in)>
845>>> m.__doc__
846'docstring'
847\end{verbatim}
848
Fred Drake5c4cf152002-11-13 14:59:06 +0000849\item
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000850A new warning, \exception{PendingDeprecationWarning} was added to
851indicate features which are in the process of being
852deprecated. The warning will \emph{not} be printed by default. To
853check for use of features that will be deprecated in the future,
854supply \programopt{-Walways::PendingDeprecationWarning::} on the
855command line or use \function{warnings.filterwarnings()}.
856
857\item Using \code{None} as a variable name will now result in a
858\exception{SyntaxWarning} warning. In a future version of Python,
859\code{None} may finally become a keyword.
860
Andrew M. Kuchlingb60ea3f2002-11-15 14:37:10 +0000861\item The method resolution order used by new-style classes has
862changed, though you'll only notice the difference if you have a really
863complicated inheritance hierarchy. (Classic classes are unaffected by
864this change.) Python 2.2 originally used a topological sort of a
865class's ancestors, but 2.3 now uses the C3 algorithm as described in
Andrew M. Kuchling6f429c32002-11-19 13:09:00 +0000866the paper \ulink{``A Monotonic Superclass Linearization for
867Dylan''}{http://www.webcom.com/haahr/dylan/linearization-oopsla96.html}.
868To understand the motivation for this change, read the thread on
869python-dev starting with the message at
Andrew M. Kuchlingb60ea3f2002-11-15 14:37:10 +0000870\url{http://mail.python.org/pipermail/python-dev/2002-October/029035.html}.
871Samuele Pedroni first pointed out the problem and also implemented the
872fix by coding the C3 algorithm.
873
Andrew M. Kuchlingdcfd8252002-09-13 22:21:42 +0000874\item Python runs multithreaded programs by switching between threads
875after executing N bytecodes. The default value for N has been
876increased from 10 to 100 bytecodes, speeding up single-threaded
877applications by reducing the switching overhead. Some multithreaded
878applications may suffer slower response time, but that's easily fixed
879by setting the limit back to a lower number by calling
880\function{sys.setcheckinterval(\var{N})}.
881
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000882\item One minor but far-reaching change is that the names of extension
883types defined by the modules included with Python now contain the
Fred Drake5c4cf152002-11-13 14:59:06 +0000884module and a \character{.} in front of the type name. For example, in
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000885Python 2.2, if you created a socket and printed its
886\member{__class__}, you'd get this output:
887
888\begin{verbatim}
889>>> s = socket.socket()
890>>> s.__class__
891<type 'socket'>
892\end{verbatim}
893
894In 2.3, you get this:
895\begin{verbatim}
896>>> s.__class__
897<type '_socket.socket'>
898\end{verbatim}
899
900\end{itemize}
901
902
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000903%======================================================================
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000904\subsection{String Changes}
905
906\begin{itemize}
907
908\item The \code{in} operator now works differently for strings.
909Previously, when evaluating \code{\var{X} in \var{Y}} where \var{X}
910and \var{Y} are strings, \var{X} could only be a single character.
911That's now changed; \var{X} can be a string of any length, and
912\code{\var{X} in \var{Y}} will return \constant{True} if \var{X} is a
913substring of \var{Y}. If \var{X} is the empty string, the result is
914always \constant{True}.
915
916\begin{verbatim}
917>>> 'ab' in 'abcd'
918True
919>>> 'ad' in 'abcd'
920False
921>>> '' in 'abcd'
922True
923\end{verbatim}
924
925Note that this doesn't tell you where the substring starts; the
926\method{find()} method is still necessary to figure that out.
927
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000928\item The \method{strip()}, \method{lstrip()}, and \method{rstrip()}
929string methods now have an optional argument for specifying the
930characters to strip. The default is still to remove all whitespace
931characters:
932
933\begin{verbatim}
934>>> ' abc '.strip()
935'abc'
936>>> '><><abc<><><>'.strip('<>')
937'abc'
938>>> '><><abc<><><>\n'.strip('<>')
939'abc<><><>\n'
940>>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
941u'\u4001abc'
942>>>
943\end{verbatim}
944
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +0000945(Suggested by Simon Brunning, and implemented by Walter D\"orwald.)
Andrew M. Kuchling346386f2002-07-12 20:24:42 +0000946
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +0000947\item The \method{startswith()} and \method{endswith()}
948string methods now accept negative numbers for the start and end
949parameters.
950
951\item Another new string method is \method{zfill()}, originally a
952function in the \module{string} module. \method{zfill()} pads a
953numeric string with zeros on the left until it's the specified width.
954Note that the \code{\%} operator is still more flexible and powerful
955than \method{zfill()}.
956
957\begin{verbatim}
958>>> '45'.zfill(4)
959'0045'
960>>> '12345'.zfill(4)
961'12345'
962>>> 'goofy'.zfill(6)
963'0goofy'
964\end{verbatim}
965
Andrew M. Kuchling346386f2002-07-12 20:24:42 +0000966(Contributed by Walter D\"orwald.)
967
Fred Drake5c4cf152002-11-13 14:59:06 +0000968\item A new type object, \class{basestring}, has been added.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +0000969 Both 8-bit strings and Unicode strings inherit from this type, so
970 \code{isinstance(obj, basestring)} will return \constant{True} for
971 either kind of string. It's a completely abstract type, so you
972 can't create \class{basestring} instances.
973
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000974\item Interned strings are no longer immortal. Interned will now be
975garbage-collected in the usual way when the only reference to them is
976from the internal dictionary of interned strings. (Implemented by
977Oren Tirosh.)
978
979\end{itemize}
980
981
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +0000982%======================================================================
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000983\subsection{Optimizations}
984
985\begin{itemize}
986
Andrew M. Kuchling950725f2002-08-06 01:40:48 +0000987\item The \method{sort()} method of list objects has been extensively
988rewritten by Tim Peters, and the implementation is significantly
989faster.
990
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000991\item Multiplication of large long integers is now much faster thanks
992to an implementation of Karatsuba multiplication, an algorithm that
993scales better than the O(n*n) required for the grade-school
994multiplication algorithm. (Original patch by Christopher A. Craig,
995and significantly reworked by Tim Peters.)
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +0000996
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +0000997\item The \code{SET_LINENO} opcode is now gone. This may provide a
998small speed increase, subject to your compiler's idiosyncrasies.
999(Removed by Michael Hudson.)
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001000
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001001\item A number of small rearrangements have been made in various
1002hotspots to improve performance, inlining a function here, removing
1003some code there. (Implemented mostly by GvR, but lots of people have
1004contributed to one change or another.)
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001005
1006\end{itemize}
Neal Norwitzd68f5172002-05-29 15:54:55 +00001007
Andrew M. Kuchling6974aa92002-08-20 00:54:36 +00001008
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001009%======================================================================
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001010\section{New and Improved Modules}
1011
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001012As usual, Python's standard modules had a number of enhancements and
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001013bug fixes. Here's a partial list of the most notable changes, sorted
1014alphabetically by module name. Consult the
1015\file{Misc/NEWS} file in the source tree for a more
1016complete list of changes, or look through the CVS logs for all the
1017details.
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001018
1019\begin{itemize}
1020
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001021\item The \module{array} module now supports arrays of Unicode
Fred Drake5c4cf152002-11-13 14:59:06 +00001022characters using the \character{u} format character. Arrays also now
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001023support using the \code{+=} assignment operator to add another array's
1024contents, and the \code{*=} assignment operator to repeat an array.
1025(Contributed by Jason Orendorff.)
1026
Andrew M. Kuchling669249e2002-11-19 13:05:33 +00001027\item The \module{bsddb} module has been updated to version 3.4.0
1028of the \ulink{PyBSDDB}{http://pybsddb.sourceforge.net} package,
1029providing a more complete interface to the transactional features of
1030the BerkeleyDB library.
1031The old version of the module has been renamed to
1032\module{bsddb185} and is no longer built automatically; you'll
1033have to edit \file{Modules/Setup} to enable it. Note that the new
1034\module{bsddb} package is intended to be compatible with the
1035old module, so be sure to file bugs if you discover any
1036incompatibilities.
1037
Fred Drake5c4cf152002-11-13 14:59:06 +00001038\item The Distutils \class{Extension} class now supports
1039an extra constructor argument named \var{depends} for listing
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001040additional source files that an extension depends on. This lets
1041Distutils recompile the module if any of the dependency files are
Fred Drake5c4cf152002-11-13 14:59:06 +00001042modified. For example, if \file{sampmodule.c} includes the header
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001043file \file{sample.h}, you would create the \class{Extension} object like
1044this:
1045
1046\begin{verbatim}
1047ext = Extension("samp",
1048 sources=["sampmodule.c"],
1049 depends=["sample.h"])
1050\end{verbatim}
1051
1052Modifying \file{sample.h} would then cause the module to be recompiled.
1053(Contributed by Jeremy Hylton.)
1054
Andrew M. Kuchlingdc3f7e12002-11-04 20:05:10 +00001055\item Other minor changes to Distutils:
1056it now checks for the \envvar{CC}, \envvar{CFLAGS}, \envvar{CPP},
1057\envvar{LDFLAGS}, and \envvar{CPPFLAGS} environment variables, using
1058them to override the settings in Python's configuration (contributed
1059by Robert Weber); the \function{get_distutils_option()} method lists
1060recently-added extensions to Distutils.
1061
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001062\item The \module{getopt} module gained a new function,
1063\function{gnu_getopt()}, that supports the same arguments as the existing
Fred Drake5c4cf152002-11-13 14:59:06 +00001064\function{getopt()} function but uses GNU-style scanning mode.
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001065The existing \function{getopt()} stops processing options as soon as a
1066non-option argument is encountered, but in GNU-style mode processing
1067continues, meaning that options and arguments can be mixed. For
1068example:
1069
1070\begin{verbatim}
1071>>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1072([('-f', 'filename')], ['output', '-v'])
1073>>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1074([('-f', 'filename'), ('-v', '')], ['output'])
1075\end{verbatim}
1076
1077(Contributed by Peter \AA{strand}.)
1078
1079\item The \module{grp}, \module{pwd}, and \module{resource} modules
Fred Drake5c4cf152002-11-13 14:59:06 +00001080now return enhanced tuples:
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001081
1082\begin{verbatim}
1083>>> import grp
1084>>> g = grp.getgrnam('amk')
1085>>> g.gr_name, g.gr_gid
1086('amk', 500)
1087\end{verbatim}
1088
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001089\item The new \module{heapq} module contains an implementation of a
1090heap queue algorithm. A heap is an array-like data structure that
1091keeps items in a sorted order such that, for every index k, heap[k] <=
1092heap[2*k+1] and heap[k] <= heap[2*k+2]. This makes it quick to remove
1093the smallest item, and inserting a new item while maintaining the heap
1094property is O(lg~n). (See
1095\url{http://www.nist.gov/dads/HTML/priorityque.html} for more
1096information about the priority queue data structure.)
1097
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001098The \module{heapq} module provides \function{heappush()} and
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001099\function{heappop()} functions for adding and removing items while
1100maintaining the heap property on top of some other mutable Python
1101sequence type. For example:
1102
1103\begin{verbatim}
1104>>> import heapq
1105>>> heap = []
1106>>> for item in [3, 7, 5, 11, 1]:
1107... heapq.heappush(heap, item)
1108...
1109>>> heap
1110[1, 3, 5, 11, 7]
1111>>> heapq.heappop(heap)
11121
1113>>> heapq.heappop(heap)
11143
1115>>> heap
1116[5, 7, 11]
1117>>>
1118>>> heapq.heappush(heap, 5)
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\end{verbatim}
1133
1134(Contributed by Kevin O'Connor.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001135
Fred Drake5c4cf152002-11-13 14:59:06 +00001136\item Two new functions in the \module{math} module,
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001137\function{degrees(\var{rads})} and \function{radians(\var{degs})},
Fred Drake5c4cf152002-11-13 14:59:06 +00001138convert between radians and degrees. Other functions in the
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001139\module{math} module such as
1140\function{math.sin()} and \function{math.cos()} have always required
1141input values measured in radians. (Contributed by Raymond Hettinger.)
1142
Andrew M. Kuchlingc309cca2002-10-10 16:04:08 +00001143\item Seven new functions, \function{getpgid()}, \function{killpg()},
1144\function{lchown()}, \function{major()}, \function{makedev()},
1145\function{minor()}, and \function{mknod()}, were added to the
1146\module{posix} module that underlies the \module{os} module.
1147(Contributed by Gustavo Niemeyer and Geert Jansen.)
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001148
Fred Drake5c4cf152002-11-13 14:59:06 +00001149\item The parser objects provided by the \module{pyexpat} module
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001150can now optionally buffer character data, resulting in fewer calls to
1151your character data handler and therefore faster performance. Setting
Fred Drake5c4cf152002-11-13 14:59:06 +00001152the parser object's \member{buffer_text} attribute to \constant{True}
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001153will enable buffering.
1154
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001155\item The \function{sample(\var{population}, \var{k})} function was
1156added to the \module{random} module. \var{population} is a sequence
1157containing the elements of a population, and \function{sample()}
1158chooses \var{k} elements from the population without replacing chosen
1159elements. \var{k} can be any value up to \code{len(\var{population})}.
1160For example:
1161
1162\begin{verbatim}
1163>>> pop = range(6) ; pop
1164[0, 1, 2, 3, 4, 5]
1165>>> random.sample(pop, 3) # Choose three elements
1166[0, 4, 3]
1167>>> random.sample(pop, 6) # Choose all six elements
1168[4, 5, 0, 3, 2, 1]
1169>>> random.sample(pop, 6) # Choose six again
1170[4, 2, 3, 0, 5, 1]
1171>>> random.sample(pop, 7) # Can't choose more than six
1172Traceback (most recent call last):
Andrew M. Kuchling28f2f882002-11-14 14:14:16 +00001173 File "<stdin>", line 1, in ?
1174 File "random.py", line 396, in sample
1175 raise ValueError, "sample larger than population"
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001176ValueError: sample larger than population
1177>>>
1178\end{verbatim}
1179
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001180\item The \module{readline} module also gained a number of new
1181functions: \function{get_history_item()},
1182\function{get_current_history_length()}, and \function{redisplay()}.
1183
1184\item Support for more advanced POSIX signal handling was added
1185to the \module{signal} module by adding the \function{sigpending},
1186\function{sigprocmask} and \function{sigsuspend} functions, where supported
1187by the platform. These functions make it possible to avoid some previously
1188unavoidable race conditions.
1189
1190\item The \module{socket} module now supports timeouts. You
1191can call the \method{settimeout(\var{t})} method on a socket object to
1192set a timeout of \var{t} seconds. Subsequent socket operations that
1193take longer than \var{t} seconds to complete will abort and raise a
Fred Drake5c4cf152002-11-13 14:59:06 +00001194\exception{socket.error} exception.
Andrew M. Kuchlinga982eb12002-07-22 18:57:36 +00001195
1196The original timeout implementation was by Tim O'Malley. Michael
1197Gilfix integrated it into the Python \module{socket} module, after the
1198patch had undergone a lengthy review. After it was checked in, Guido
1199van~Rossum rewrote parts of it. This is a good example of the free
1200software development process in action.
1201
Fred Drake5c4cf152002-11-13 14:59:06 +00001202\item The value of the C \constant{PYTHON_API_VERSION} macro is now exposed
Fred Drake583db0d2002-09-14 02:03:25 +00001203at the Python level as \code{sys.api_version}.
Andrew M. Kuchlingdcfd8252002-09-13 22:21:42 +00001204
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001205\item The new \module{textwrap} module contains functions for wrapping
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001206strings containing paragraphs of text. The \function{wrap(\var{text},
1207\var{width})} function takes a string and returns a list containing
1208the text split into lines of no more than the chosen width. The
1209\function{fill(\var{text}, \var{width})} function returns a single
1210string, reformatted to fit into lines no longer than the chosen width.
1211(As you can guess, \function{fill()} is built on top of
1212\function{wrap()}. For example:
1213
1214\begin{verbatim}
1215>>> import textwrap
1216>>> paragraph = "Not a whit, we defy augury: ... more text ..."
1217>>> textwrap.wrap(paragraph, 60)
Fred Drake5c4cf152002-11-13 14:59:06 +00001218["Not a whit, we defy augury: there's a special providence in",
1219 "the fall of a sparrow. If it be now, 'tis not to come; if it",
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001220 ...]
1221>>> print textwrap.fill(paragraph, 35)
1222Not a whit, we defy augury: there's
1223a special providence in the fall of
1224a sparrow. If it be now, 'tis not
1225to come; if it be not to come, it
1226will be now; if it be not now, yet
1227it will come: the readiness is all.
Fred Drake5c4cf152002-11-13 14:59:06 +00001228>>>
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001229\end{verbatim}
1230
1231The module also contains a \class{TextWrapper} class that actually
Fred Drake5c4cf152002-11-13 14:59:06 +00001232implements the text wrapping strategy. Both the
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001233\class{TextWrapper} class and the \function{wrap()} and
1234\function{fill()} functions support a number of additional keyword
1235arguments for fine-tuning the formatting; consult the module's
Fred Drake5c4cf152002-11-13 14:59:06 +00001236documentation for details.
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001237%XXX add a link to the module docs?
Andrew M. Kuchlingd003a2a2002-06-26 13:23:55 +00001238(Contributed by Greg Ward.)
1239
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001240\item The \module{time} module's \function{strptime()} function has
Fred Drake5c4cf152002-11-13 14:59:06 +00001241long been an annoyance because it uses the platform C library's
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001242\function{strptime()} implementation, and different platforms
1243sometimes have odd bugs. Brett Cannon contributed a portable
1244implementation that's written in pure Python, which should behave
1245identically on all platforms.
1246
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001247\item The DOM implementation
1248in \module{xml.dom.minidom} can now generate XML output in a
1249particular encoding, by specifying an optional encoding argument to
1250the \method{toxml()} and \method{toprettyxml()} methods of DOM nodes.
1251
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001252\item The \function{*stat()} family of functions can now report
1253fractions of a second in a timestamp. Such time stamps are
1254represented as floats, similar to \function{time.time()}.
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001255
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001256During testing, it was found that some applications will break if time
1257stamps are floats. For compatibility, when using the tuple interface
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001258of the \class{stat_result}, time stamps are represented as integers.
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001259When using named fields (a feature first introduced in Python 2.2),
1260time stamps are still represented as ints, unless
1261\function{os.stat_float_times()} is invoked to enable float return
1262values:
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001263
1264\begin{verbatim}
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001265>>> os.stat("/tmp").st_mtime
12661034791200
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001267>>> os.stat_float_times(True)
1268>>> os.stat("/tmp").st_mtime
12691034791200.6335014
1270\end{verbatim}
1271
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001272In Python 2.4, the default will change to always returning floats.
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001273
1274Application developers should use this feature only if all their
1275libraries work properly when confronted with floating point time
Andrew M. Kuchlingbc5e3cc2002-11-05 00:26:33 +00001276stamps, or if they use the tuple API. If used, the feature should be
1277activated on an application level instead of trying to enable it on a
Martin v. Löwisf607bda2002-10-16 18:27:39 +00001278per-use basis.
1279
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001280\end{itemize}
1281
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001282
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001283%======================================================================
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001284\subsection{The \module{optparse} Module}
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001285
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001286The \module{getopt} module provides simple parsing of command-line
1287arguments. The new \module{optparse} module (originally named Optik)
1288provides more elaborate command-line parsing that follows the Unix
1289conventions, automatically creates the output for \longprogramopt{help},
1290and can perform different actions
1291
1292You start by creating an instance of \class{OptionParser} and telling
1293it what your program's options are.
1294
1295\begin{verbatim}
1296from optparse import OptionParser
1297
1298op = OptionParser()
1299op.add_option('-i', '--input',
1300 action='store', type='string', dest='input',
1301 help='set input filename')
1302op.add_option('-l', '--length',
1303 action='store', type='int', dest='length',
1304 help='set maximum length of output')
1305\end{verbatim}
1306
1307Parsing a command line is then done by calling the \method{parse_args()}
1308method.
1309
1310\begin{verbatim}
1311options, args = op.parse_args(sys.argv[1:])
1312print options
1313print args
1314\end{verbatim}
1315
1316This returns an object containing all of the option values,
1317and a list of strings containing the remaining arguments.
1318
1319Invoking the script with the various arguments now works as you'd
1320expect it to. Note that the length argument is automatically
1321converted to an integer.
1322
1323\begin{verbatim}
1324$ ./python opt.py -i data arg1
1325<Values at 0x400cad4c: {'input': 'data', 'length': None}>
1326['arg1']
1327$ ./python opt.py --input=data --length=4
1328<Values at 0x400cad2c: {'input': 'data', 'length': 4}>
1329['arg1']
1330$
1331\end{verbatim}
1332
1333The help message is automatically generated for you:
1334
1335\begin{verbatim}
1336$ ./python opt.py --help
1337usage: opt.py [options]
1338
1339options:
1340 -h, --help show this help message and exit
1341 -iINPUT, --input=INPUT
1342 set input filename
1343 -lLENGTH, --length=LENGTH
1344 set maximum length of output
1345$
1346\end{verbatim}
Andrew M. Kuchling669249e2002-11-19 13:05:33 +00001347% $ prevent Emacs tex-mode from getting confused
Andrew M. Kuchling24d5a522002-11-14 23:40:42 +00001348
1349Optik was written by Greg Ward, with suggestions from the readers of
1350the Getopt SIG.
1351
1352\begin{seealso}
1353\seeurl{http://optik.sourceforge.net}
1354{The Optik site has tutorial and reference documentation for
1355\module{optparse}.
1356% XXX change to point to Python docs, when those docs get written.
1357}
1358\end{seealso}
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001359
1360
1361%======================================================================
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001362\section{Specialized Object Allocator (pymalloc)\label{section-pymalloc}}
1363
1364An experimental feature added to Python 2.1 was a specialized object
1365allocator called pymalloc, written by Vladimir Marangozov. Pymalloc
1366was intended to be faster than the system \cfunction{malloc()} and have
1367less memory overhead for typical allocation patterns of Python
1368programs. The allocator uses C's \cfunction{malloc()} function to get
1369large pools of memory, and then fulfills smaller memory requests from
1370these pools.
1371
1372In 2.1 and 2.2, pymalloc was an experimental feature and wasn't
1373enabled by default; you had to explicitly turn it on by providing the
1374\longprogramopt{with-pymalloc} option to the \program{configure}
1375script. In 2.3, pymalloc has had further enhancements and is now
1376enabled by default; you'll have to supply
1377\longprogramopt{without-pymalloc} to disable it.
1378
1379This change is transparent to code written in Python; however,
1380pymalloc may expose bugs in C extensions. Authors of C extension
1381modules should test their code with the object allocator enabled,
1382because some incorrect code may cause core dumps at runtime. There
1383are a bunch of memory allocation functions in Python's C API that have
1384previously been just aliases for the C library's \cfunction{malloc()}
1385and \cfunction{free()}, meaning that if you accidentally called
1386mismatched functions, the error wouldn't be noticeable. When the
1387object allocator is enabled, these functions aren't aliases of
1388\cfunction{malloc()} and \cfunction{free()} any more, and calling the
1389wrong function to free memory may get you a core dump. For example,
1390if memory was allocated using \cfunction{PyObject_Malloc()}, it has to
1391be freed using \cfunction{PyObject_Free()}, not \cfunction{free()}. A
1392few modules included with Python fell afoul of this and had to be
1393fixed; doubtless there are more third-party modules that will have the
1394same problem.
1395
1396As part of this change, the confusing multiple interfaces for
1397allocating memory have been consolidated down into two API families.
1398Memory allocated with one family must not be manipulated with
1399functions from the other family.
1400
1401There is another family of functions specifically for allocating
1402Python \emph{objects} (as opposed to memory).
1403
1404\begin{itemize}
1405 \item To allocate and free an undistinguished chunk of memory use
1406 the ``raw memory'' family: \cfunction{PyMem_Malloc()},
1407 \cfunction{PyMem_Realloc()}, and \cfunction{PyMem_Free()}.
1408
1409 \item The ``object memory'' family is the interface to the pymalloc
1410 facility described above and is biased towards a large number of
1411 ``small'' allocations: \cfunction{PyObject_Malloc},
1412 \cfunction{PyObject_Realloc}, and \cfunction{PyObject_Free}.
1413
1414 \item To allocate and free Python objects, use the ``object'' family
1415 \cfunction{PyObject_New()}, \cfunction{PyObject_NewVar()}, and
1416 \cfunction{PyObject_Del()}.
1417\end{itemize}
1418
1419Thanks to lots of work by Tim Peters, pymalloc in 2.3 also provides
1420debugging features to catch memory overwrites and doubled frees in
1421both extension modules and in the interpreter itself. To enable this
1422support, turn on the Python interpreter's debugging code by running
Fred Drake5c4cf152002-11-13 14:59:06 +00001423\program{configure} with \longprogramopt{with-pydebug}.
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001424
1425To aid extension writers, a header file \file{Misc/pymemcompat.h} is
1426distributed with the source to Python 2.3 that allows Python
1427extensions to use the 2.3 interfaces to memory allocation and compile
1428against any version of Python since 1.5.2. You would copy the file
1429from Python's source distribution and bundle it with the source of
1430your extension.
1431
1432\begin{seealso}
1433
1434\seeurl{http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/python/python/dist/src/Objects/obmalloc.c}
1435{For the full details of the pymalloc implementation, see
1436the comments at the top of the file \file{Objects/obmalloc.c} in the
1437Python source code. The above link points to the file within the
1438SourceForge CVS browser.}
1439
1440\end{seealso}
1441
1442
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001443% ======================================================================
1444\section{Build and C API Changes}
1445
Andrew M. Kuchling3c305d92002-07-22 18:50:11 +00001446Changes to Python's build process and to the C API include:
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001447
1448\begin{itemize}
1449
Andrew M. Kuchlingef5d06b2002-07-22 19:21:06 +00001450\item The C-level interface to the garbage collector has been changed,
1451to make it easier to write extension types that support garbage
1452collection, and to make it easier to debug misuses of the functions.
1453Various functions have slightly different semantics, so a bunch of
1454functions had to be renamed. Extensions that use the old API will
1455still compile but will \emph{not} participate in garbage collection,
1456so updating them for 2.3 should be considered fairly high priority.
1457
1458To upgrade an extension module to the new API, perform the following
1459steps:
1460
1461\begin{itemize}
1462
1463\item Rename \cfunction{Py_TPFLAGS_GC} to \cfunction{PyTPFLAGS_HAVE_GC}.
1464
1465\item Use \cfunction{PyObject_GC_New} or \cfunction{PyObject_GC_NewVar} to
1466allocate objects, and \cfunction{PyObject_GC_Del} to deallocate them.
1467
1468\item Rename \cfunction{PyObject_GC_Init} to \cfunction{PyObject_GC_Track} and
1469\cfunction{PyObject_GC_Fini} to \cfunction{PyObject_GC_UnTrack}.
1470
1471\item Remove \cfunction{PyGC_HEAD_SIZE} from object size calculations.
1472
1473\item Remove calls to \cfunction{PyObject_AS_GC} and \cfunction{PyObject_FROM_GC}.
1474
1475\end{itemize}
1476
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001477\item Python can now optionally be built as a shared library
1478(\file{libpython2.3.so}) by supplying \longprogramopt{enable-shared}
Fred Drake5c4cf152002-11-13 14:59:06 +00001479when running Python's \program{configure} script. (Contributed by Ondrej
Andrew M. Kuchlingfad2f592002-05-10 21:00:05 +00001480Palkovsky.)
Andrew M. Kuchlingf4dd65d2002-04-01 19:28:09 +00001481
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001482\item The \csimplemacro{DL_EXPORT} and \csimplemacro{DL_IMPORT} macros
1483are now deprecated. Initialization functions for Python extension
1484modules should now be declared using the new macro
Andrew M. Kuchling3c305d92002-07-22 18:50:11 +00001485\csimplemacro{PyMODINIT_FUNC}, while the Python core will generally
1486use the \csimplemacro{PyAPI_FUNC} and \csimplemacro{PyAPI_DATA}
1487macros.
Neal Norwitzbba23a82002-07-22 13:18:59 +00001488
Fred Drake5c4cf152002-11-13 14:59:06 +00001489\item The interpreter can be compiled without any docstrings for
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001490the built-in functions and modules by supplying
Fred Drake5c4cf152002-11-13 14:59:06 +00001491\longprogramopt{without-doc-strings} to the \program{configure} script.
Andrew M. Kuchlinge995d162002-07-11 20:09:50 +00001492This makes the Python executable about 10\% smaller, but will also
1493mean that you can't get help for Python's built-ins. (Contributed by
1494Gustavo Niemeyer.)
1495
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001496\item The cycle detection implementation used by the garbage collection
1497has proven to be stable, so it's now being made mandatory; you can no
1498longer compile Python without it, and the
Fred Drake5c4cf152002-11-13 14:59:06 +00001499\longprogramopt{with-cycle-gc} switch to \program{configure} has been removed.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001500
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001501\item The \cfunction{PyArg_NoArgs()} macro is now deprecated, and code
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00001502that uses it should be changed. For Python 2.2 and later, the method
1503definition table can specify the
Fred Drake5c4cf152002-11-13 14:59:06 +00001504\constant{METH_NOARGS} flag, signalling that there are no arguments, and
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00001505the argument checking can then be removed. If compatibility with
1506pre-2.2 versions of Python is important, the code could use
Fred Drake5c4cf152002-11-13 14:59:06 +00001507\code{PyArg_ParseTuple(args, "")} instead, but this will be slower
Andrew M. Kuchling7845e7c2002-07-11 19:27:46 +00001508than using \constant{METH_NOARGS}.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001509
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001510\item A new function, \cfunction{PyObject_DelItemString(\var{mapping},
1511char *\var{key})} was added
Fred Drake5c4cf152002-11-13 14:59:06 +00001512as shorthand for
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001513\code{PyObject_DelItem(\var{mapping}, PyString_New(\var{key})}.
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001514
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001515\item The \method{xreadlines()} method of file objects, introduced in
1516Python 2.1, is no longer necessary because files now behave as their
1517own iterator. \method{xreadlines()} was originally introduced as a
1518faster way to loop over all the lines in a file, but now you can
1519simply write \code{for line in file_obj}.
1520
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001521\item File objects now manage their internal string buffer
Fred Drake5c4cf152002-11-13 14:59:06 +00001522differently by increasing it exponentially when needed.
1523This results in the benchmark tests in \file{Lib/test/test_bufio.py}
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001524speeding up from 57 seconds to 1.7 seconds, according to one
1525measurement.
1526
Andrew M. Kuchling72b58e02002-05-29 17:30:34 +00001527\item It's now possible to define class and static methods for a C
1528extension type by setting either the \constant{METH_CLASS} or
1529\constant{METH_STATIC} flags in a method's \ctype{PyMethodDef}
1530structure.
Andrew M. Kuchling45afd542002-04-02 14:25:25 +00001531
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00001532\item Python now includes a copy of the Expat XML parser's source code,
1533removing any dependence on a system version or local installation of
Fred Drake5c4cf152002-11-13 14:59:06 +00001534Expat.
Andrew M. Kuchling346386f2002-07-12 20:24:42 +00001535
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001536\end{itemize}
1537
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001538
1539%======================================================================
Andrew M. Kuchling821013e2002-05-06 17:46:39 +00001540\subsection{Port-Specific Changes}
1541
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001542Support for a port to IBM's OS/2 using the EMX runtime environment was
1543merged into the main Python source tree. EMX is a POSIX emulation
1544layer over the OS/2 system APIs. The Python port for EMX tries to
1545support all the POSIX-like capability exposed by the EMX runtime, and
1546mostly succeeds; \function{fork()} and \function{fcntl()} are
1547restricted by the limitations of the underlying emulation layer. The
1548standard OS/2 port, which uses IBM's Visual Age compiler, also gained
1549support for case-sensitive import semantics as part of the integration
1550of the EMX port into CVS. (Contributed by Andrew MacIntyre.)
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001551
Andrew M. Kuchling72b58e02002-05-29 17:30:34 +00001552On MacOS, most toolbox modules have been weaklinked to improve
1553backward compatibility. This means that modules will no longer fail
1554to load if a single routine is missing on the curent OS version.
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001555Instead calling the missing routine will raise an exception.
1556(Contributed by Jack Jansen.)
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001557
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001558The RPM spec files, found in the \file{Misc/RPM/} directory in the
1559Python source distribution, were updated for 2.3. (Contributed by
1560Sean Reifschneider.)
Fred Drake03e10312002-03-26 19:17:43 +00001561
Andrew M. Kuchling3e3e1292002-10-10 11:32:30 +00001562Python now supports AtheOS (\url{http://www.atheos.cx}) and GNU/Hurd.
Andrew M. Kuchling20e5abc2002-07-11 20:50:34 +00001563
Fred Drake03e10312002-03-26 19:17:43 +00001564
1565%======================================================================
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001566\section{Other Changes and Fixes}
1567
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00001568As usual, there were a bunch of other improvements and bugfixes
1569scattered throughout the source tree. A search through the CVS change
1570logs finds there were 289 patches applied and 323 bugs fixed between
1571Python 2.2 and 2.3. Both figures are likely to be underestimates.
1572
1573Some of the more notable changes are:
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001574
1575\begin{itemize}
1576
1577\item The tools used to build the documentation now work under Cygwin
1578as well as \UNIX.
1579
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001580\item The \code{SET_LINENO} opcode has been removed. Back in the
1581mists of time, this opcode was needed to produce line numbers in
1582tracebacks and support trace functions (for, e.g., \module{pdb}).
1583Since Python 1.5, the line numbers in tracebacks have been computed
1584using a different mechanism that works with ``python -O''. For Python
15852.3 Michael Hudson implemented a similar scheme to determine when to
1586call the trace function, removing the need for \code{SET_LINENO}
1587entirely.
1588
Andrew M. Kuchling7a82b8c2002-11-04 20:17:24 +00001589It would be difficult to detect any resulting difference from Python
1590code, apart from a slight speed up when Python is run without
Michael W. Hudsondd32a912002-08-15 14:59:02 +00001591\programopt{-O}.
1592
1593C extensions that access the \member{f_lineno} field of frame objects
1594should instead call \code{PyCode_Addr2Line(f->f_code, f->f_lasti)}.
1595This will have the added effect of making the code work as desired
1596under ``python -O'' in earlier versions of Python.
1597
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001598\end{itemize}
1599
Andrew M. Kuchling187b1d82002-05-29 19:20:57 +00001600
Andrew M. Kuchling517109b2002-05-07 21:01:16 +00001601%======================================================================
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001602\section{Porting to Python 2.3}
1603
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001604This section lists changes that may actually require changes to your code:
1605
1606\begin{itemize}
1607
1608\item \keyword{yield} is now always a keyword; if it's used as a
1609variable name in your code, a different name must be chosen.
1610
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001611\item For strings \var{X} and \var{Y}, \code{\var{X} in \var{Y}} now works
1612if \var{X} is more than one character long.
1613
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00001614\item The \function{int()} type constructor will now return a long
1615integer instead of raising an \exception{OverflowError} when a string
1616or floating-point number is too large to fit into an integer.
1617
1618\item You can no longer disable assertions by assigning to \code{__debug__}.
1619
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001620\item The Distutils \function{setup()} function has gained various new
Fred Drake5c4cf152002-11-13 14:59:06 +00001621keyword arguments such as \var{depends}. Old versions of the
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001622Distutils will abort if passed unknown keywords. The fix is to check
1623for the presence of the new \function{get_distutil_options()} function
1624in your \file{setup.py} if you want to only support the new keywords
1625with a version of the Distutils that supports them:
1626
1627\begin{verbatim}
1628from distutils import core
1629
1630kw = {'sources': 'foo.c', ...}
1631if hasattr(core, 'get_distutil_options'):
1632 kw['depends'] = ['foo.h']
Fred Drake5c4cf152002-11-13 14:59:06 +00001633ext = Extension(**kw)
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001634\end{verbatim}
1635
Andrew M. Kuchling495172c2002-11-20 13:50:15 +00001636\item Using \code{None} as a variable name will now result in a
1637\exception{SyntaxWarning} warning.
1638
1639\item Names of extension types defined by the modules included with
1640Python now contain the module and a \character{.} in front of the type
1641name.
1642
Andrew M. Kuchling8a61f492002-11-13 13:24:41 +00001643\end{itemize}
Andrew M. Kuchling950725f2002-08-06 01:40:48 +00001644
1645
1646%======================================================================
Fred Drake03e10312002-03-26 19:17:43 +00001647\section{Acknowledgements \label{acks}}
1648
Andrew M. Kuchling03594bb2002-03-27 02:29:48 +00001649The author would like to thank the following people for offering
1650suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchling366c10c2002-11-14 23:07:57 +00001651article: Simon Brunning, Michael Chermside, Scott David Daniels,
1652Fred~L. Drake, Jr., Michael Hudson, Detlef Lannert, Martin von
1653L\"owis, Andrew MacIntyre, Lalo Martins, Gustavo Niemeyer, Neal
1654Norwitz, Neil Schemenauer, Jason Tishler.
Fred Drake03e10312002-03-26 19:17:43 +00001655
1656\end{document}