blob: b89164ea39413d3e4621a8ae62db6629cecf7efa [file] [log] [blame]
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001\documentclass{howto}
2\usepackage{distutils}
3% $Id$
4
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +00005% Don't write extensive text for new sections; I'll do that.
6% Feel free to add commented-out reminders of things that need
7% to be covered. --amk
8
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00009% XXX pydoc can display links to module docs -- but when?
10%
11
Fred Drakeed0fa3d2003-07-30 19:14:09 +000012\title{What's New in Python 2.4}
Andrew M. Kuchling3b790912004-07-04 16:39:40 +000013\release{0.1}
Fred Drakeed0fa3d2003-07-30 19:14:09 +000014\author{A.M.\ Kuchling}
Fred Drakeb914ef02004-01-02 06:57:50 +000015\authoraddress{
16 \strong{Python Software Foundation}\\
17 Email: \email{amk@amk.ca}
18}
Fred Drakeed0fa3d2003-07-30 19:14:09 +000019
20\begin{document}
21\maketitle
22\tableofcontents
23
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000024This article explains the new features in Python 2.4 alpha1, scheduled
25for release in early July 2004. The final version of Python 2.4 is
26expected to be released around September 2004.
Fred Drakeed0fa3d2003-07-30 19:14:09 +000027
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000028Python 2.4 is a medium-sized release. It doesn't introduce as many
Andrew M. Kuchling3b790912004-07-04 16:39:40 +000029changes as the radical Python 2.2, but introduces more features than
30the conservative 2.3 release did. The most significant new language
31feature (as of this writing) is the addition of generator expressions;
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000032most other changes are to the standard library.
Fred Drakeed0fa3d2003-07-30 19:14:09 +000033
34This article doesn't attempt to provide a complete specification of
Andrew M. Kuchling3b790912004-07-04 16:39:40 +000035every single new feature, but instead provides a convenient overview.
36For full details, you should refer to the documentation for Python
372.4, such as the \citetitle[../lib/lib.html]{Python Library Reference}
38and the \citetitle[../ref/ref.html]{Python Reference Manual}. If you
39want to understand the complete implementation and design rationale,
40refer to the PEP for a particular new feature or to the module
41documentation.
Fred Drakeed0fa3d2003-07-30 19:14:09 +000042
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +000043
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000044%======================================================================
45\section{PEP 218: Built-In Set Objects}
46
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000047Python 2.3 introduced the \module{sets} module. C implementations of
48set data types have now been added to the Python core as two new
49built-in types, \function{set(\var{iterable})} and
50\function{frozenset(\var{iterable})}. They provide high speed
51operations for membership testing, for eliminating duplicates from
52sequences, and for mathematical operations like unions, intersections,
53differences, and symmetric differences.
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000054
55\begin{verbatim}
56>>> a = set('abracadabra') # form a set from a string
57>>> 'z' in a # fast membership testing
58False
59>>> a # unique letters in a
60set(['a', 'r', 'b', 'c', 'd'])
61>>> ''.join(a) # convert back into a string
62'arbcd'
Raymond Hettingerd4462302003-11-26 17:52:45 +000063
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000064>>> b = set('alacazam') # form a second set
65>>> a - b # letters in a but not in b
66set(['r', 'd', 'b'])
67>>> a | b # letters in either a or b
68set(['a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'])
69>>> a & b # letters in both a and b
70set(['a', 'c'])
71>>> a ^ b # letters in a or b but not both
72set(['r', 'd', 'b', 'm', 'z', 'l'])
Raymond Hettingerd4462302003-11-26 17:52:45 +000073
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000074>>> a.add('z') # add a new element
75>>> a.update('wxy') # add multiple new elements
76>>> a
77set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'x', 'z'])
78>>> a.remove('x') # take one element out
79>>> a
80set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'z'])
81\end{verbatim}
82
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000083The \function{frozenset} type is an immutable version of \function{set}.
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000084Since it is immutable and hashable, it may be used as a dictionary key or
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000085as a member of another set.
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000086
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000087The \module{sets} module remains in the standard library, and may be
88useful if you wish to subclass the \class{Set} or \class{ImmutableSet}
89classes. There are currently no plans to deprecate the module.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +000090
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000091\begin{seealso}
92\seepep{218}{Adding a Built-In Set Object Type}{Originally proposed by
93Greg Wilson and ultimately implemented by Raymond Hettinger.}
94\end{seealso}
Fred Drakeed0fa3d2003-07-30 19:14:09 +000095
96%======================================================================
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +000097\section{PEP 237: Unifying Long Integers and Integers}
98
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000099The lengthy transition process for this PEP, begun in Python 2.2,
Andrew M. Kuchlingd4be86c2004-07-04 01:44:04 +0000100takes another step forward in Python 2.4. In 2.3, certain integer
101operations that would behave differently after int/long unification
102triggered \exception{FutureWarning} warnings and returned values
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000103limited to 32 or 64 bits (depending on your platform). In 2.4, these
104expressions no longer produce a warning and instead produce a
105different result that's usually a long integer.
Andrew M. Kuchlingd4be86c2004-07-04 01:44:04 +0000106
107The problematic expressions are primarily left shifts and lengthy
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000108hexadecimal and octal constants. For example,
109\code{2 \textless{}\textless{} 32} results
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000110in a warning in 2.3, evaluating to 0 on 32-bit platforms. In Python
1112.4, this expression now returns the correct answer, 8589934592.
Andrew M. Kuchlingd4be86c2004-07-04 01:44:04 +0000112
113\begin{seealso}
114\seepep{237}{Unifying Long Integers and Integers}{Original PEP
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000115written by Moshe Zadka and GvR. The changes for 2.4 were implemented by
Andrew M. Kuchlingd4be86c2004-07-04 01:44:04 +0000116Kalle Svensson.}
117\end{seealso}
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000118
119%======================================================================
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000120\section{PEP 289: Generator Expressions}
Raymond Hettinger354433a2004-05-19 08:20:33 +0000121
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000122The iterator feature introduced in Python 2.2 makes it easier to write
123programs that loop through large data sets without having the entire
124data set in memory at one time. Programmers can use iterators and the
125\module{itertools} module to write code in a fairly functional style.
126
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000127% XXX avoid metaphor
128List comprehensions have been the fly in the ointment because they
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000129produce a Python list object containing all of the items, unavoidably
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000130pulling them all into memory. When trying to write a
131functionally-styled program, it would be natural to write something
132like:
Raymond Hettinger354433a2004-05-19 08:20:33 +0000133
134\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000135links = [link for link in get_all_links() if not link.followed]
136for link in links:
137 ...
Raymond Hettinger354433a2004-05-19 08:20:33 +0000138\end{verbatim}
139
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000140instead of
Raymond Hettinger354433a2004-05-19 08:20:33 +0000141
142\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000143for link in get_all_links():
144 if link.followed:
145 continue
146 ...
147\end{verbatim}
Raymond Hettinger354433a2004-05-19 08:20:33 +0000148
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000149The first form is more concise and perhaps more readable, but if
150you're dealing with a large number of link objects the second form
151would have to be used.
Raymond Hettinger354433a2004-05-19 08:20:33 +0000152
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000153Generator expressions work similarly to list comprehensions but don't
154materialize the entire list; instead they create a generator that will
155return elements one by one. The above example could be written as:
Raymond Hettinger354433a2004-05-19 08:20:33 +0000156
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000157\begin{verbatim}
158links = (link for link in get_all_links() if not link.followed)
159for link in links:
160 ...
161\end{verbatim}
Raymond Hettinger170a6222004-05-19 19:45:19 +0000162
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000163Generator expressions always have to be written inside parentheses, as
164in the above example. The parentheses signalling a function call also
165count, so if you want to create a iterator that will be immediately
166passed to a function you could write:
Raymond Hettinger170a6222004-05-19 19:45:19 +0000167
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000168\begin{verbatim}
169print sum(obj.count for obj in list_all_objects())
170\end{verbatim}
Raymond Hettinger170a6222004-05-19 19:45:19 +0000171
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000172Generator expressions differ from list comprehensions in various small
173ways. Most notably, the loop variable (\var{obj} in the above
174example) is not accessible outside of the generator expression. List
175comprehensions leave the variable assigned to its last value; future
176versions of Python will change this, making list comprehensions match
177generator expressions in this respect.
Raymond Hettinger354433a2004-05-19 08:20:33 +0000178
179\begin{seealso}
180\seepep{289}{Generator Expressions}{Proposed by Raymond Hettinger and
181implemented by Jiwon Seo with early efforts steered by Hye-Shik Chang.}
182\end{seealso}
183
184%======================================================================
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000185\section{PEP 322: Reverse Iteration}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000186
Fred Drake56fcc232004-05-06 02:55:35 +0000187A new built-in function, \function{reversed(\var{seq})}, takes a sequence
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000188and returns an iterator that loops over the elements of the sequence
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000189in reverse order.
190
191\begin{verbatim}
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000192>>> for i in reversed(xrange(1,4)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000193... print i
194...
1953
1962
1971
198\end{verbatim}
199
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000200Compared to extended slicing, such as \code{range(1,4)[::-1]},
201\function{reversed()} is easier to read, runs faster, and uses
202substantially less memory.
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000203
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000204Note that \function{reversed()} only accepts sequences, not arbitrary
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000205iterators. If you want to reverse an iterator, first convert it to
206a list with \function{list()}.
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000207
208\begin{verbatim}
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000209>>> input= open('/etc/passwd', 'r')
210>>> for line in reversed(list(input)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000211... print line
212...
213root:*:0:0:System Administrator:/var/root:/bin/tcsh
214 ...
215\end{verbatim}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000216
Andrew M. Kuchlingf7a6b672003-11-08 16:05:37 +0000217\begin{seealso}
218\seepep{322}{Reverse Iteration}{Written and implemented by Raymond Hettinger.}
219
220\end{seealso}
221
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000222
223%======================================================================
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000224\section{PEP 327: Decimal Data Type}
225
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000226Python has always supported floating-point (FP) numbers as a data
227type, based on the underlying C \ctype{double} type. However, while
228most programming languages provide a floating-point type, most people
229(even programmers) are unaware that computing with floating-point
230numbers entails certain unavoidable inaccuracies. The new decimal
231type provides a way to avoid these inaccuracies.
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000232
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000233\subsection{Why is Decimal needed?}
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000234
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000235The limitations arise from the representation used for floating-point numbers.
236FP numbers are made up of three components:
237
238\begin{itemize}
239\item The sign, which is -1 or +1.
240\item The mantissa, which is a single-digit binary number
241followed by a fractional part. For example, \code{1.01} in base-2 notation
242is \code{1 + 0/2 + 1/4}, or 1.25 in decimal notation.
243\item The exponent, which tells where the decimal point is located in the number represented.
244\end{itemize}
245
246For example, the number 1.25 has sign +1, mantissa 1.01 (in binary),
247and exponent of 0 (the decimal point doesn't need to be shifted). The
248number 5 has the same sign and mantissa, but the exponent is 2
249because the mantissa is multiplied by 4 (2 to the power of the exponent 2).
250
251Modern systems usually provide floating-point support that conforms to
252a relevant standard called IEEE 754. C's \ctype{double} type is
253usually implemented as a 64-bit IEEE 754 number, which uses 52 bits of
254space for the mantissa. This means that numbers can only be specified
255to 52 bits of precision. If you're trying to represent numbers whose
256expansion repeats endlessly, the expansion is cut off after 52 bits.
257Unfortunately, most software needs to produce output in base 10, and
258base 10 often gives rise to such repeating decimals. For example, 1.1
259decimal is binary \code{1.0001100110011 ...}; .1 = 1/16 + 1/32 + 1/256
260plus an infinite number of additional terms. IEEE 754 has to chop off
261that infinitely repeated decimal after 52 digits, so the
262representation is slightly inaccurate.
263
264Sometimes you can see this inaccuracy when the number is printed:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000265\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000266>>> 1.1
2671.1000000000000001
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000268\end{verbatim}
269
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000270The inaccuracy isn't always visible when you print the number because
271the FP-to-decimal-string conversion is provided by the C library, and
272most C libraries try to produce sensible output, but the inaccuracy is
273still there and subsequent operations can magnify the error.
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000274
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000275For many applications this doesn't matter. If I'm plotting points and
276displaying them on my monitor, the difference between 1.1 and
2771.1000000000000001 is too small to be visible. Reports often limit
278output to a certain number of decimal places, and if you round the
279number to two or three or even eight decimal places, the error is
280never apparent. However, for applications where it does matter,
281it's a lot of work to implement your own custom arithmetic routines.
282
283\subsection{The \class{Decimal} type}
284
285A new module, \module{decimal}, was added to Python's standard library.
286It contains two classes, \class{Decimal} and \class{Context}.
287\class{Decimal} instances represent numbers, and
288\class{Context} instances are used to wrap up various settings such as the precision and default rounding mode.
289
290\class{Decimal} instances, like regular Python integers and FP numbers, are immutable; once they've been created, you can't change the value it represents.
291\class{Decimal} instances can be created from integers or strings:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000292
293\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000294>>> import decimal
295>>> decimal.Decimal(1972)
296Decimal("1972")
297>>> decimal.Decimal("1.1")
298Decimal("1.1")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000299\end{verbatim}
300
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000301You can also provide tuples containing the sign, mantissa represented
302as a tuple of decimal digits, and exponent:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000303
304\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000305>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
306Decimal("-14.75")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000307\end{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000308
309Cautionary note: the sign bit is a Boolean value, so 0 is positive and 1 is negative.
310
311Floating-point numbers posed a bit of a problem: should the FP number
312representing 1.1 turn into the decimal number for exactly 1.1, or for
3131.1 plus whatever inaccuracies are introduced? The decision was to
314leave such a conversion out of the API. Instead, you should convert
315the floating-point number into a string using the desired precision and
316pass the string to the \class{Decimal} constructor:
317
318\begin{verbatim}
319>>> f = 1.1
320>>> decimal.Decimal(str(f))
321Decimal("1.1")
322>>> decimal.Decimal(repr(f))
323Decimal("1.1000000000000001")
324\end{verbatim}
325
326Once you have \class{Decimal} instances, you can perform the usual
327mathematical operations on them. One limitation: exponentiation
328requires an integer exponent:
329
330\begin{verbatim}
331>>> a = decimal.Decimal('35.72')
332>>> b = decimal.Decimal('1.73')
333>>> a+b
334Decimal("37.45")
335>>> a-b
336Decimal("33.99")
337>>> a*b
338Decimal("61.7956")
339>>> a/b
340Decimal("20.6473988")
341>>> a ** 2
342Decimal("1275.9184")
343>>> a ** b
344Decimal("NaN")
345\end{verbatim}
346
347You can combine \class{Decimal} instances with integers, but not with
348floating-point numbers:
349
350\begin{verbatim}
351>>> a + 4
352Decimal("39.72")
353>>> a + 4.5
354Traceback (most recent call last):
355 ...
356TypeError: You can interact Decimal only with int, long or Decimal data types.
357>>>
358\end{verbatim}
359
360\class{Decimal} numbers can be used with the \module{math} and
361\module{cmath} modules, though you'll get back a regular
362floating-point number and not a \class{Decimal}. Instances also have a \method{sqrt()} method:
363
364\begin{verbatim}
365>>> import math, cmath
366>>> d = decimal.Decimal('123456789012.345')
367>>> math.sqrt(d)
368351364.18288201344
369>>> cmath.sqrt(-d)
370351364.18288201344j
371>>> d.sqrt()
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000372Decimal("351364.1828820134592177245001")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000373\end{verbatim}
374
375
376\subsection{The \class{Context} type}
377
378Instances of the \class{Context} class encapsulate several settings for
379decimal operations:
380
381\begin{itemize}
382 \item \member{prec} is the precision, the number of decimal places.
383 \item \member{rounding} specifies the rounding mode. The \module{decimal}
384 module has constants for the various possibilities:
385 \constant{ROUND_DOWN}, \constant{ROUND_CEILING}, \constant{ROUND_HALF_EVEN}, and various others.
386 \item \member{trap_enablers} is a dictionary specifying what happens on
387encountering certain error conditions: either an exception is raised or
388a value is returned. Some examples of error conditions are
389division by zero, loss of precision, and overflow.
390\end{itemize}
391
392There's a thread-local default context available by calling
393\function{getcontext()}; you can change the properties of this context
394to alter the default precision, rounding, or trap handling.
395
396\begin{verbatim}
397>>> decimal.getcontext().prec
39828
399>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000400Decimal("0.1428571428571428571428571429")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000401>>> decimal.getcontext().prec = 9
402>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000403Decimal("0.142857143")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000404\end{verbatim}
405
406The default action for error conditions is to return a special value
407such as infinity or not-a-number, but you can request that exceptions
408be raised:
409
410\begin{verbatim}
411>>> decimal.Decimal(1) / decimal.Decimal(0)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000412Decimal("Infinity")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000413>>> decimal.getcontext().trap_enablers[decimal.DivisionByZero] = True
414>>> decimal.Decimal(1) / decimal.Decimal(0)
415Traceback (most recent call last):
416 ...
417decimal.DivisionByZero: x / 0
418>>>
419\end{verbatim}
420
421The \class{Context} instance also has various methods for formatting
422numbers such as \method{to_eng_string()} and \method{to_sci_string()}.
423
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000424
425\begin{seealso}
426\seepep{327}{Decimal Data Type}{Written by Facundo Batista and implemented
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000427 by Facundo Batista, Eric Price, Raymond Hettinger, Aahz, and Tim Peters.}
428
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000429\seeurl{http://research.microsoft.com/\textasciitilde hollasch/cgindex/coding/ieeefloat.html}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000430{A more detailed overview of the IEEE-754 representation.}
431
432\seeurl{http://www.lahey.com/float.htm}
433{The article uses Fortran code to illustrate many of the problems
434that floating-point inaccuracy can cause.}
435
436\seeurl{http://www2.hursley.ibm.com/decimal/}
437{A description of a decimal-based representation. This representation
438is being proposed as a standard, and underlies the new Python decimal
439type. Much of this material was written by Mike Cowlishaw, designer of the
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000440Rexx language.}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000441
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000442\end{seealso}
443
444
445%======================================================================
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000446\section{Other Language Changes}
447
448Here are all of the changes that Python 2.4 makes to the core Python
449language.
450
451\begin{itemize}
Raymond Hettingerd4462302003-11-26 17:52:45 +0000452
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000453\item The \method{dict.update()} method now accepts the same
454argument forms as the \class{dict} constructor. This includes any
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000455mapping, any iterable of key/value pairs, and keyword arguments.
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000456
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000457\item The string methods \method{ljust()}, \method{rjust()}, and
Andrew M. Kuchling67087562003-11-26 18:03:48 +0000458\method{center()} now take an optional argument for specifying a
Raymond Hettingerd4462302003-11-26 17:52:45 +0000459fill character other than a space.
460
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000461\item Strings also gained an \method{rsplit()} method that
Raymond Hettingered54d912003-12-31 01:59:18 +0000462works like the \method{split()} method but splits from the end of
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000463the string.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000464
465\begin{verbatim}
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000466>>> 'www.python.org'.split('.', 1)
467['www', 'python.org']
468'www.python.org'.rsplit('.', 1)
469['www.python', 'org']
470\end{verbatim}
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000471
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000472\item The \method{sort()} method of lists gained three keyword
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000473arguments: \var{cmp}, \var{key}, and \var{reverse}. These arguments
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000474make some common usages of \method{sort()} simpler. All are optional.
475
476\var{cmp} is the same as the previous single argument to
477\method{sort()}; if provided, the value should be a comparison
478function that takes two arguments and returns -1, 0, or +1 depending
479on how the arguments compare.
480
481\var{key} should be a single-argument function that takes a list
482element and returns a comparison key for the element. The list is
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000483then sorted using the comparison keys. The following example sorts a
484list case-insensitively:
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000485
486\begin{verbatim}
487>>> L = ['A', 'b', 'c', 'D']
488>>> L.sort() # Case-sensitive sort
489>>> L
490['A', 'D', 'b', 'c']
491>>> L.sort(key=lambda x: x.lower())
492>>> L
493['A', 'b', 'c', 'D']
494>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
495>>> L
496['A', 'b', 'c', 'D']
497\end{verbatim}
498
499The last example, which uses the \var{cmp} parameter, is the old way
Raymond Hettingered54d912003-12-31 01:59:18 +0000500to perform a case-insensitive sort. It works but is slower than
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000501using a \var{key} parameter. Using \var{key} results in calling the
502\method{lower()} method once for each element in the list while using
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000503\var{cmp} will call it twice for each comparison.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000504
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000505For simple key functions and comparison functions, it is often
506possible to avoid a \keyword{lambda} expression by using an unbound
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000507method instead. For example, the above case-insensitive sort is best
508coded as:
509
510\begin{verbatim}
511>>> L.sort(key=str.lower)
512>>> L
513['A', 'b', 'c', 'D']
514\end{verbatim}
515
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000516The \var{reverse} parameter should have a Boolean value. If the value
517is \constant{True}, the list will be sorted into reverse order.
518Instead of \code{L.sort(lambda x,y: cmp(x.score, y.score)) ;
519L.reverse()}, you can now write: \code{L.sort(key = lambda x: x.score,
520reverse=True)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000521
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000522The results of sorting are now guaranteed to be stable. This means
523that two entries with equal keys will be returned in the same order as
524they were input. For example, you can sort a list of people by name,
525and then sort the list by age, resulting in a list sorted by age where
526people with the same age are in name-sorted order.
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000527
Fred Drake56fcc232004-05-06 02:55:35 +0000528\item There is a new built-in function
529\function{sorted(\var{iterable})} that works like the in-place
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000530\method{list.sort()} method but can be used in
Fred Drake56fcc232004-05-06 02:55:35 +0000531expressions. The differences are:
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000532 \begin{itemize}
Raymond Hettinger7d1dd042003-11-12 16:42:10 +0000533 \item the input may be any iterable;
534 \item a newly formed copy is sorted, leaving the original intact; and
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000535 \item the expression returns the new sorted copy
536 \end{itemize}
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000537
538\begin{verbatim}
539>>> L = [9,7,8,3,2,4,1,6,5]
Raymond Hettinger64958a12003-12-17 20:43:33 +0000540>>> [10+i for i in sorted(L)] # usable in a list comprehension
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000541[11, 12, 13, 14, 15, 16, 17, 18, 19]
542>>> L = [9,7,8,3,2,4,1,6,5] # original is left unchanged
543[9,7,8,3,2,4,1,6,5]
Raymond Hettingerd4462302003-11-26 17:52:45 +0000544
Raymond Hettinger64958a12003-12-17 20:43:33 +0000545>>> sorted('Monte Python') # any iterable may be an input
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000546[' ', 'M', 'P', 'e', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y']
Raymond Hettingerd4462302003-11-26 17:52:45 +0000547
548>>> # List the contents of a dict sorted by key values
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000549>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
Raymond Hettinger64958a12003-12-17 20:43:33 +0000550>>> for k, v in sorted(colormap.iteritems()):
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000551... print k, v
552...
553black 4
554blue 2
555green 3
556red 1
557yellow 5
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000558\end{verbatim}
559
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000560\item The \function{eval(\var{expr}, \var{globals}, \var{locals})}
561function now accepts any mapping type for the \var{locals} argument.
562Previously this had to be a regular Python dictionary.
563
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000564\item The \function{zip()} built-in function and \function{itertools.izip()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000565 now return an empty list if called with no arguments.
566 Previously they raised a \exception{TypeError}
567 exception. This makes them more
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000568 suitable for use with variable length argument lists:
569
570\begin{verbatim}
571>>> def transpose(array):
572... return zip(*array)
573...
574>>> transpose([(1,2,3), (4,5,6)])
575[(1, 4), (2, 5), (3, 6)]
576>>> transpose([])
577[]
578\end{verbatim}
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000579
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000580\end{itemize}
581
582
583%======================================================================
584\subsection{Optimizations}
585
586\begin{itemize}
587
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000588\item The inner loops for list and tuple slicing
Raymond Hettingerade08ea2004-03-18 09:48:12 +0000589 were optimized and now run about one-third faster. The inner
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000590 loops were also optimized for dictionaries with performance
Raymond Hettingerade08ea2004-03-18 09:48:12 +0000591 boosts to \method{keys()}, \method{values()}, \method{items()},
Fred Drake9de0a2b2004-03-20 08:13:32 +0000592\method{iterkeys()}, \method{itervalues()}, and \method{iteritems()}.
Raymond Hettingerb7d05db2004-03-08 07:25:05 +0000593
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000594\item The machinery for growing and shrinking lists was optimized for
595 speed and for space efficiency. Appending and popping from lists now
596 runs faster due to more efficient code paths and less frequent use of
597 the underlying system \cfunction{realloc()}. List comprehensions
598 also benefit. \method{list.extend()} was also optimized and no
599 longer converts its argument into a temporary list before extending
600 the base list.
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000601
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000602\item \function{list()}, \function{tuple()}, \function{map()},
603 \function{filter()}, and \function{zip()} now run several times
604 faster with non-sequence arguments that supply a \method{__len__()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000605 method.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000606
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +0000607\item The methods \method{list.__getitem__()},
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000608 \method{dict.__getitem__()}, and \method{dict.__contains__()} are
609 are now implemented as \class{method_descriptor} objects rather
610 than \class{wrapper_descriptor} objects. This form of optimized
611 access doubles their performance and makes them more suitable for
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +0000612 use as arguments to functionals:
613 \samp{map(mydict.__getitem__, keylist)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000614
Fred Draked6d35d92004-06-03 13:31:22 +0000615\item Added a new opcode, \code{LIST_APPEND}, that simplifies
Raymond Hettingerdd80f762004-03-07 07:31:06 +0000616 the generated bytecode for list comprehensions and speeds them up
617 by about a third.
618
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000619\end{itemize}
620
621The net result of the 2.4 optimizations is that Python 2.4 runs the
622pystone benchmark around XX\% faster than Python 2.3 and YY\% faster
623than Python 2.2.
624
625
626%======================================================================
627\section{New, Improved, and Deprecated Modules}
628
629As usual, Python's standard library received a number of enhancements and
630bug fixes. Here's a partial list of the most notable changes, sorted
631alphabetically by module name. Consult the
632\file{Misc/NEWS} file in the source tree for a more
633complete list of changes, or look through the CVS logs for all the
634details.
635
636\begin{itemize}
637
Anthony Baxter5da4c832004-07-09 16:16:46 +0000638% XXX new email parser
639
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000640\item The \module{asyncore} module's \function{loop()} now has a
641 \var{count} parameter that lets you perform a limited number
642 of passes through the polling loop. The default is still to loop
643 forever.
644
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +0000645\item The \module{curses} modules now supports the ncurses extension
Fred Draked6d35d92004-06-03 13:31:22 +0000646 \function{use_default_colors()}. On platforms where the terminal
647 supports transparency, this makes it possible to use a transparent
648 background. (Contributed by J\"org Lehmann.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000649
Raymond Hettinger0c410272004-01-05 10:13:35 +0000650\item The \module{bisect} module now has an underlying C implementation
651 for improved performance.
652 (Contributed by Dmitry Vasiliev.)
653
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000654\item The CJKCodecs collections of East Asian codecs, maintained
655by Hye-Shik Chang, was integrated into 2.4.
656The new encodings are:
657
658\begin{itemize}
659 \item Chinese (PRC): gb2312, gbk, gb18030, hz
660 \item Chinese (ROC): big5, cp950
661 \item Japanese: cp932, shift-jis, shift-jisx0213, euc-jp,
662euc-jisx0213, iso-2022-jp, iso-2022-jp-1, iso-2022-jp-2,
663 iso-2022-jp-3, iso-2022-jp-ext
664 \item Korean: cp949, euc-kr, johab, iso-2022-kr
665\end{itemize}
666
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000667\item There is a new \module{collections} module for
668 various specialized collection datatypes.
669 Currently it contains just one type, \class{deque},
670 a double-ended queue that supports efficiently adding and removing
671 elements from either end.
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000672
673\begin{verbatim}
674>>> from collections import deque
675>>> d = deque('ghi') # make a new deque with three items
676>>> d.append('j') # add a new entry to the right side
677>>> d.appendleft('f') # add a new entry to the left side
678>>> d # show the representation of the deque
679deque(['f', 'g', 'h', 'i', 'j'])
680>>> d.pop() # return and remove the rightmost item
681'j'
682>>> d.popleft() # return and remove the leftmost item
683'f'
684>>> list(d) # list the contents of the deque
685['g', 'h', 'i']
686>>> 'h' in d # search the deque
687True
688\end{verbatim}
689
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000690Several modules now take advantage of \class{collections.deque} for
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000691improved performance, such as the \module{Queue} and
692\module{threading} modules.
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000693
Fred Drake9f15b5c2004-05-18 04:30:00 +0000694\item The \module{ConfigParser} classes have been enhanced slightly.
695 The \method{read()} method now returns a list of the files that
696 were successfully parsed, and the \method{set()} method raises
697 \exception{TypeError} if passed a \var{value} argument that isn't a
698 string.
699
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000700\item The \module{heapq} module has been converted to C. The resulting
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000701 tenfold improvement in speed makes the module suitable for handling
Raymond Hettinger33ecffb2004-06-10 05:03:17 +0000702 high volumes of data. In addition, the module has two new functions
703 \function{nlargest()} and \function{nsmallest()} that use heaps to
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000704 find the N largest or smallest values in a dataset without the
Raymond Hettinger33ecffb2004-06-10 05:03:17 +0000705 expense of a full sort.
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000706
Andrew M. Kuchlingdff9dbd2003-11-20 22:22:19 +0000707\item The \module{imaplib} module now supports IMAP's THREAD command.
708(Contributed by Yves Dionne.)
709
Andrew M. Kuchlingad809552003-12-06 23:19:23 +0000710\item The \module{itertools} module gained a
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000711 \function{groupby(\var{iterable}\optional{, \var{func}})} function.
Andrew M. Kuchlingad809552003-12-06 23:19:23 +0000712 \var{iterable} returns a succession of elements, and the optional
713 \var{func} is a function that takes an element and returns a key
714 value; if omitted, the key is simply the element itself.
715 \function{groupby()} then groups the elements into subsequences
716 which have matching values of the key, and returns a series of 2-tuples
717 containing the key value and an iterator over the subsequence.
718
719Here's an example. The \var{key} function simply returns whether a
720number is even or odd, so the result of \function{groupby()} is to
721return consecutive runs of odd or even numbers.
722
723\begin{verbatim}
724>>> import itertools
725>>> L = [2,4,6, 7,8,9,11, 12, 14]
726>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
727... print key_val, list(it)
728...
7290 [2, 4, 6]
7301 [7]
7310 [8]
7321 [9, 11]
7330 [12, 14]
734>>>
735\end{verbatim}
736
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000737\function{groupby()} is typically used with sorted input. The logic
738for \function{groupby()} is similar to the \UNIX{} \code{uniq} filter
739which makes it handy for eliminating, counting, or identifying
740duplicate elements:
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000741
742\begin{verbatim}
743>>> word = 'abracadabra'
Raymond Hettingered54d912003-12-31 01:59:18 +0000744>>> letters = sorted(word) # Turn string into a sorted list of letters
Raymond Hettinger64958a12003-12-17 20:43:33 +0000745>>> letters
Andrew M. Kuchling4612bc52003-12-16 20:59:37 +0000746['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000747>>> for k, g in itertools.groupby(letters):
748... print k, list(g)
749...
750a ['a', 'a', 'a', 'a', 'a']
751b ['b', 'b']
752c ['c']
753d ['d']
754r ['r', 'r']
755>>> # List unique letters
756>>> [k for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000757['a', 'b', 'c', 'd', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000758>>> # Count letter occurences
759>>> [(k, len(list(g))) for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000760[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000761\end{verbatim}
762
Raymond Hettingered54d912003-12-31 01:59:18 +0000763\item \module{itertools} also gained a function named
764\function{tee(\var{iterator}, \var{N})} that returns \var{N} independent
765iterators that replicate \var{iterator}. If \var{N} is omitted, the
766default is 2.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000767
768\begin{verbatim}
769>>> L = [1,2,3]
770>>> i1, i2 = itertools.tee(L)
771>>> i1,i2
772(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
Raymond Hettingered54d912003-12-31 01:59:18 +0000773>>> list(i1) # Run the first iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000774[1, 2, 3]
Raymond Hettingered54d912003-12-31 01:59:18 +0000775>>> list(i2) # Run the second iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000776[1, 2, 3]
777>\end{verbatim}
778
779Note that \function{tee()} has to keep copies of the values returned
Raymond Hettingered54d912003-12-31 01:59:18 +0000780by the iterator; in the worst case, it may need to keep all of them.
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000781This should therefore be used carefully if the leading iterator
Raymond Hettingered54d912003-12-31 01:59:18 +0000782can run far ahead of the trailing iterator in a long stream of inputs.
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000783If the separation is large, then you might as well use
Raymond Hettingered54d912003-12-31 01:59:18 +0000784\function{list()} instead. When the iterators track closely with one
785another, \function{tee()} is ideal. Possible applications include
786bookmarking, windowing, or lookahead iterators.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000787
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +0000788\item A \function{basicConfig} function was added to the
789\module{logging} package to simplify log configuration. It defaults
790to logging to standard error, but a
791number of optional keyword arguments can be specified to
792log to a particular file, change the logging format, or set the
793logging level. For example:
794
795\begin{verbatim}
796import logging
797logging.basicConfig(filename = '/var/log/application.log',
798 level=0, # Log all messages, including debugging,
799 format='%(levelname):%(process):%(thread):%(message)')
800\end{verbatim}
801
802Another addition to \module{logging} is a
803\class{TimedRotatingFileHandler} class which rotates its log files at
804a timed interval. The module already had \class{RotatingFileHandler},
805which rotated logs once the file exceeded a certain size. Both
806classes derive from a new \class{BaseRotatingHandler} class that can
807be used to implement other rotating handlers.
808
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000809\item The \module{operator} module gained two new functions,
810\function{attrgetter(\var{attr})} and \function{itemgetter(\var{index})}.
811Both functions return callables that take a single argument and return
Raymond Hettingered54d912003-12-31 01:59:18 +0000812the corresponding attribute or item; these callables make excellent
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +0000813data extractors when used with \function{map()} or
814\function{sorted()}. For example:
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000815
816\begin{verbatim}
Raymond Hettingered54d912003-12-31 01:59:18 +0000817>>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000818>>> map(operator.itemgetter(0), L)
819['c', 'd', 'a', 'b']
820>>> map(operator.itemgetter(1), L)
Raymond Hettingered54d912003-12-31 01:59:18 +0000821[2, 1, 4, 3]
822>>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
823[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000824\end{verbatim}
825
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000826\item A new \function{getsid()} function was added to the
827\module{posix} module that underlies the \module{os} module.
828(Contributed by J. Raynor.)
829
830\item The \module{poplib} module now supports POP over SSL.
831
832\item The \module{profile} module can now profile C extension functions.
833% XXX more to say about this?
834
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000835\item The \module{random} module has a new method called \method{getrandbits(N)}
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000836 which returns an N-bit long integer. This method supports the existing
837 \method{randrange()} method, making it possible to efficiently generate
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000838 arbitrarily large random numbers.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000839
840\item The regular expression language accepted by the \module{re} module
841 was extended with simple conditional expressions, written as
842 \code{(?(\var{group})\var{A}|\var{B})}. \var{group} is either a
843 numeric group ID or a group name defined with \code{(?P<group>...)}
844 earlier in the expression. If the specified group matched, the
845 regular expression pattern \var{A} will be tested against the string; if
846 the group didn't match, the pattern \var{B} will be used instead.
Raymond Hettinger874ebd52004-05-31 03:15:02 +0000847
Anthony Baxter1869df12004-07-12 08:15:37 +0000848% XXX sre is now non-recursive.
849
Raymond Hettinger874ebd52004-05-31 03:15:02 +0000850\item The \module{weakref} module now supports a wider variety of objects
851 including Python functions, class instances, sets, frozensets, deques,
852 arrays, files, sockets, and regular expression pattern objects.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000853
854\item The \module{xmlrpclib} module now supports a multi-call extension for
855tranmitting multiple XML-RPC calls in a single HTTP operation.
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +0000856
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000857\end{itemize}
858
859
860%======================================================================
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000861% whole new modules get described in subsections here
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000862
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000863\subsection{cookielib}
864
865The \module{cookielib} library supports client-side handling for HTTP
866cookies, just as the \module{Cookie} provides server-side cookie
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000867support in CGI scripts. Cookies are stored in cookie jars; the library
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000868transparently stores cookies offered by the web server in the cookie
869jar, and fetches the cookie from the jar when connecting to the
870server. Similar to web browsers, policy objects control whether
871cookies are accepted or not.
872
873In order to store cookies across sessions, two implementations of
874cookie jars are provided: one that stores cookies in the Netscape
875format, so applications can use the Mozilla or Lynx cookie jars, and
876one that stores cookies in the same format as the Perl libwww libary.
877
878\module{urllib2} has been changed to interact with \module{cookielib}:
879\class{HTTPCookieProcessor} manages a cookie jar that is used when
880accessing URLs.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000881
882% ======================================================================
883\section{Build and C API Changes}
884
885Changes to Python's build process and to the C API include:
886
887\begin{itemize}
888
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000889 \item Three new convenience macros were added for common return
890 values from extension functions: \csimplemacro{Py_RETURN_NONE},
891 \csimplemacro{Py_RETURN_TRUE}, and \csimplemacro{Py_RETURN_FALSE}.
892
Fred Drakece3caf22004-02-12 18:13:12 +0000893 \item A new function, \cfunction{PyTuple_Pack(\var{N}, \var{obj1},
894 \var{obj2}, ..., \var{objN})}, constructs tuples from a variable
895 length argument list of Python objects.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000896
Fred Drakece3caf22004-02-12 18:13:12 +0000897 \item A new function, \cfunction{PyDict_Contains(\var{d}, \var{k})},
898 implements fast dictionary lookups without masking exceptions raised
899 during the look-up process.
Raymond Hettingerd4462302003-11-26 17:52:45 +0000900
Fred Drakece3caf22004-02-12 18:13:12 +0000901 \item A new method flag, \constant{METH_COEXISTS}, allows a function
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000902 defined in slots to co-exist with a \ctype{PyCFunction} having the
903 same name. This can halve the access time for a method such as
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000904 \method{set.__contains__()}.
905
906 \item Python can now be built with additional profiling for the interpreter
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000907 itself. This is intended for people developing on the Python core.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000908 Providing \longprogramopt{--enable-profiling} to the
909 \program{configure} script will let you profile the interpreter with
910 \program{gprof}, and providing the \longprogramopt{--with-tsc} switch
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000911 enables profiling using the Pentium's Time-Stamp-Counter register.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000912
913 \item The \ctype{tracebackobject} type has been renamed to \ctype{PyTracebackObject}.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000914
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000915\end{itemize}
916
917
918%======================================================================
919\subsection{Port-Specific Changes}
920
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000921\begin{itemize}
922
923\item The Windows port now builds under MSVC++ 7.1 as well as version 6.
924
925\end{itemize}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000926
927
928%======================================================================
929\section{Other Changes and Fixes \label{section-other}}
930
931As usual, there were a bunch of other improvements and bugfixes
932scattered throughout the source tree. A search through the CVS change
933logs finds there were XXX patches applied and YYY bugs fixed between
934Python 2.3 and 2.4. Both figures are likely to be underestimates.
935
936Some of the more notable changes are:
937
938\begin{itemize}
939
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000940\item The \module{timeit} module now automatically disables periodic
941 garbarge collection during the timing loop. This change makes
942 consecutive timings more comparable.
943
944\item The \module{base64} module now has more complete RFC 3548 support
945 for Base64, Base32, and Base16 encoding and decoding, including
946 optional case folding and optional alternative alphabets.
947 (Contributed by Barry Warsaw.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000948
949\end{itemize}
950
951
952%======================================================================
953\section{Porting to Python 2.4}
954
955This section lists previously described changes that may require
956changes to your code:
957
958\begin{itemize}
959
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000960\item The \function{zip()} built-in function and \function{itertools.izip()}
961 now return an empty list instead of raising a \exception{TypeError}
962 exception if called with no arguments.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000963
964\item \function{dircache.listdir()} now passes exceptions to the caller
965 instead of returning empty lists.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000966
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000967\item \function{LexicalHandler.startDTD()} used to receive the public and
968 system IDs in the wrong order. This has been corrected; applications
Fred Drake56fcc232004-05-06 02:55:35 +0000969 relying on the wrong order need to be fixed.
Martin v. Löwis456ab1d2004-05-06 01:54:36 +0000970
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000971\item \function{fcntl.ioctl} now warns if the \var{mutate}
972 argument is omitted and relevant.
Martin v. Löwis77ca6c42004-06-03 12:47:26 +0000973
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000974\end{itemize}
975
976
977%======================================================================
978\section{Acknowledgements \label{acks}}
979
980The author would like to thank the following people for offering
981suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000982article: Raymond Hettinger.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000983
984\end{document}