blob: d3475e649f0395611299faf0efc87f43dda89354 [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. Kuchling89ba1ff2004-07-14 21:56:19 +000013\release{0.2}
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. Kuchling89ba1ff2004-07-14 21:56:19 +000024This article explains the new features in Python 2.4 alpha2, scheduled
25for release in late July 2004. The final version of Python 2.4 is
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000026expected 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. Kuchlingd91fcbe2004-08-02 12:44:28 +0000185\section{PEP 318: Decorators for Functions, Methods and Classes}
186
187% XXX write this section
188
189\begin{seealso}
190\seepep{318}{Decorators for Functions, Methods and Classes}{Written
191by Kevin D. Smith, Jim Jewett, and Skip Montanaro. Several people wrote
192patches implementing function decorators, but the one that was actually
193checked in was patch #979728, written by Mark Russell.}
194\end{seealso}
195
196%======================================================================
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000197\section{PEP 322: Reverse Iteration}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000198
Fred Drake56fcc232004-05-06 02:55:35 +0000199A new built-in function, \function{reversed(\var{seq})}, takes a sequence
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000200and returns an iterator that loops over the elements of the sequence
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000201in reverse order.
202
203\begin{verbatim}
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000204>>> for i in reversed(xrange(1,4)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000205... print i
206...
2073
2082
2091
210\end{verbatim}
211
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000212Compared to extended slicing, such as \code{range(1,4)[::-1]},
213\function{reversed()} is easier to read, runs faster, and uses
214substantially less memory.
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000215
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000216Note that \function{reversed()} only accepts sequences, not arbitrary
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000217iterators. If you want to reverse an iterator, first convert it to
218a list with \function{list()}.
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000219
220\begin{verbatim}
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000221>>> input= open('/etc/passwd', 'r')
222>>> for line in reversed(list(input)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000223... print line
224...
225root:*:0:0:System Administrator:/var/root:/bin/tcsh
226 ...
227\end{verbatim}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000228
Andrew M. Kuchlingf7a6b672003-11-08 16:05:37 +0000229\begin{seealso}
230\seepep{322}{Reverse Iteration}{Written and implemented by Raymond Hettinger.}
231
232\end{seealso}
233
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000234
235%======================================================================
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000236\section{PEP 327: Decimal Data Type}
237
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000238Python has always supported floating-point (FP) numbers as a data
239type, based on the underlying C \ctype{double} type. However, while
240most programming languages provide a floating-point type, most people
241(even programmers) are unaware that computing with floating-point
242numbers entails certain unavoidable inaccuracies. The new decimal
243type provides a way to avoid these inaccuracies.
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000244
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000245\subsection{Why is Decimal needed?}
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000246
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000247The limitations arise from the representation used for floating-point numbers.
248FP numbers are made up of three components:
249
250\begin{itemize}
251\item The sign, which is -1 or +1.
252\item The mantissa, which is a single-digit binary number
253followed by a fractional part. For example, \code{1.01} in base-2 notation
254is \code{1 + 0/2 + 1/4}, or 1.25 in decimal notation.
255\item The exponent, which tells where the decimal point is located in the number represented.
256\end{itemize}
257
258For example, the number 1.25 has sign +1, mantissa 1.01 (in binary),
259and exponent of 0 (the decimal point doesn't need to be shifted). The
260number 5 has the same sign and mantissa, but the exponent is 2
261because the mantissa is multiplied by 4 (2 to the power of the exponent 2).
262
263Modern systems usually provide floating-point support that conforms to
264a relevant standard called IEEE 754. C's \ctype{double} type is
265usually implemented as a 64-bit IEEE 754 number, which uses 52 bits of
266space for the mantissa. This means that numbers can only be specified
267to 52 bits of precision. If you're trying to represent numbers whose
268expansion repeats endlessly, the expansion is cut off after 52 bits.
269Unfortunately, most software needs to produce output in base 10, and
270base 10 often gives rise to such repeating decimals. For example, 1.1
271decimal is binary \code{1.0001100110011 ...}; .1 = 1/16 + 1/32 + 1/256
272plus an infinite number of additional terms. IEEE 754 has to chop off
273that infinitely repeated decimal after 52 digits, so the
274representation is slightly inaccurate.
275
276Sometimes you can see this inaccuracy when the number is printed:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000277\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000278>>> 1.1
2791.1000000000000001
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000280\end{verbatim}
281
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000282The inaccuracy isn't always visible when you print the number because
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000283the FP-to-decimal-string conversion is provided by the C library and
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000284most C libraries try to produce sensible output, but the inaccuracy is
285still there and subsequent operations can magnify the error.
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000286
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000287For many applications this doesn't matter. If I'm plotting points and
288displaying them on my monitor, the difference between 1.1 and
2891.1000000000000001 is too small to be visible. Reports often limit
290output to a certain number of decimal places, and if you round the
291number to two or three or even eight decimal places, the error is
292never apparent. However, for applications where it does matter,
293it's a lot of work to implement your own custom arithmetic routines.
294
295\subsection{The \class{Decimal} type}
296
297A new module, \module{decimal}, was added to Python's standard library.
298It contains two classes, \class{Decimal} and \class{Context}.
299\class{Decimal} instances represent numbers, and
300\class{Context} instances are used to wrap up various settings such as the precision and default rounding mode.
301
302\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.
303\class{Decimal} instances can be created from integers or strings:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000304
305\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000306>>> import decimal
307>>> decimal.Decimal(1972)
308Decimal("1972")
309>>> decimal.Decimal("1.1")
310Decimal("1.1")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000311\end{verbatim}
312
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000313You can also provide tuples containing the sign, mantissa represented
314as a tuple of decimal digits, and exponent:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000315
316\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000317>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
318Decimal("-14.75")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000319\end{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000320
321Cautionary note: the sign bit is a Boolean value, so 0 is positive and 1 is negative.
322
323Floating-point numbers posed a bit of a problem: should the FP number
324representing 1.1 turn into the decimal number for exactly 1.1, or for
3251.1 plus whatever inaccuracies are introduced? The decision was to
326leave such a conversion out of the API. Instead, you should convert
327the floating-point number into a string using the desired precision and
328pass the string to the \class{Decimal} constructor:
329
330\begin{verbatim}
331>>> f = 1.1
332>>> decimal.Decimal(str(f))
333Decimal("1.1")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000334>>> decimal.Decimal('%.12f' % f)
335Decimal("1.100000000000")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000336\end{verbatim}
337
338Once you have \class{Decimal} instances, you can perform the usual
339mathematical operations on them. One limitation: exponentiation
340requires an integer exponent:
341
342\begin{verbatim}
343>>> a = decimal.Decimal('35.72')
344>>> b = decimal.Decimal('1.73')
345>>> a+b
346Decimal("37.45")
347>>> a-b
348Decimal("33.99")
349>>> a*b
350Decimal("61.7956")
351>>> a/b
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000352Decimal("20.64739884393063583815028902")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000353>>> a ** 2
354Decimal("1275.9184")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000355>>> a**b
356Traceback (most recent call last):
357 ...
358decimal.InvalidOperation: x ** (non-integer)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000359\end{verbatim}
360
361You can combine \class{Decimal} instances with integers, but not with
362floating-point numbers:
363
364\begin{verbatim}
365>>> a + 4
366Decimal("39.72")
367>>> a + 4.5
368Traceback (most recent call last):
369 ...
370TypeError: You can interact Decimal only with int, long or Decimal data types.
371>>>
372\end{verbatim}
373
374\class{Decimal} numbers can be used with the \module{math} and
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000375\module{cmath} modules, but note that they'll be immediately converted to
376floating-point numbers before the operation is performed, resulting in
377a possible loss of precision and accuracy. You'll also get back a
378regular floating-point number and not a \class{Decimal}.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000379
380\begin{verbatim}
381>>> import math, cmath
382>>> d = decimal.Decimal('123456789012.345')
383>>> math.sqrt(d)
384351364.18288201344
385>>> cmath.sqrt(-d)
386351364.18288201344j
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000387\end{verbatim}
388
389Instances also have a \method{sqrt()} method that returns a
390\class{Decimal}, but if you need other things such as trigonometric
391functions you'll have to implement them.
392
393\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000394>>> d.sqrt()
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000395Decimal("351364.1828820134592177245001")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000396\end{verbatim}
397
398
399\subsection{The \class{Context} type}
400
401Instances of the \class{Context} class encapsulate several settings for
402decimal operations:
403
404\begin{itemize}
405 \item \member{prec} is the precision, the number of decimal places.
406 \item \member{rounding} specifies the rounding mode. The \module{decimal}
407 module has constants for the various possibilities:
408 \constant{ROUND_DOWN}, \constant{ROUND_CEILING}, \constant{ROUND_HALF_EVEN}, and various others.
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000409 \item \member{traps} is a dictionary specifying what happens on
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000410encountering certain error conditions: either an exception is raised or
411a value is returned. Some examples of error conditions are
412division by zero, loss of precision, and overflow.
413\end{itemize}
414
415There's a thread-local default context available by calling
416\function{getcontext()}; you can change the properties of this context
417to alter the default precision, rounding, or trap handling.
418
419\begin{verbatim}
420>>> decimal.getcontext().prec
42128
422>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000423Decimal("0.1428571428571428571428571429")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000424>>> decimal.getcontext().prec = 9
425>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000426Decimal("0.142857143")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000427\end{verbatim}
428
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000429The default action for error conditions is selectable; the module can
430either return a special value such as infinity or not-a-number, or
431exceptions can be raised:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000432
433\begin{verbatim}
434>>> decimal.Decimal(1) / decimal.Decimal(0)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000435Traceback (most recent call last):
436 ...
437decimal.DivisionByZero: x / 0
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000438>>> decimal.getcontext().traps[decimal.DivisionByZero] = False
439>>> decimal.Decimal(1) / decimal.Decimal(0)
440Decimal("Infinity")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000441>>>
442\end{verbatim}
443
444The \class{Context} instance also has various methods for formatting
445numbers such as \method{to_eng_string()} and \method{to_sci_string()}.
446
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000447For more information, see the documentation for the \module{decimal}
448module, which includes a quick-start tutorial and a reference.
449
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000450\begin{seealso}
451\seepep{327}{Decimal Data Type}{Written by Facundo Batista and implemented
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000452 by Facundo Batista, Eric Price, Raymond Hettinger, Aahz, and Tim Peters.}
453
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000454\seeurl{http://research.microsoft.com/\textasciitilde hollasch/cgindex/coding/ieeefloat.html}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000455{A more detailed overview of the IEEE-754 representation.}
456
457\seeurl{http://www.lahey.com/float.htm}
458{The article uses Fortran code to illustrate many of the problems
459that floating-point inaccuracy can cause.}
460
461\seeurl{http://www2.hursley.ibm.com/decimal/}
462{A description of a decimal-based representation. This representation
463is being proposed as a standard, and underlies the new Python decimal
464type. Much of this material was written by Mike Cowlishaw, designer of the
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000465Rexx language.}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000466
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000467\end{seealso}
468
469
470%======================================================================
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000471\section{PEP 331: Locale-Independent Float/String Conversions}
472
473The \module{locale} modules lets Python software select various
474conversions and display conventions that are localized to a particular
475country or language. However, the module was careful to not change
476the numeric locale because various functions in Python's
477implementation required that the numeric locale remain set to the
478\code{'C'} locale. Often this was because the code was using the C library's
479\cfunction{atof()} function.
480
481Not setting the numeric locale caused trouble for extensions that used
482third-party C libraries, however, because they wouldn't have the
483correct locale set. The motivating example was GTK+, whose user
484interface widgets weren't displaying numbers in the current locale.
485
486The solution described in the PEP is to add three new functions to the
487Python API that perform ASCII-only conversions, ignoring the locale
488setting:
489
490\begin{itemize}
491 \item \cfunction{PyOS_ascii_strtod(\var{str}, \var{ptr})}
492and \cfunction{PyOS_ascii_atof(\var{str}, \var{ptr})}
493both convert a string to a C \ctype{double}.
494 \item \cfunction{PyOS_ascii_formatd(\var{buffer}, \var{buf_len}, \var{format}, \var{d})} converts a \ctype{double} to an ASCII string.
495\end{itemize}
496
497The code for these functions came from the GLib library
498(\url{http://developer.gnome.org/arch/gtk/glib.html}), whose
499developers kindly relicensed the relevant functions and donated them
500to the Python Software Foundation. The \module{locale} module
501can now change the numeric locale, letting extensions such as GTK+
502produce the correct results.
503
504\begin{seealso}
505\seepep{331}{Locale-Independent Float/String Conversions}{Written by Christian R. Reis, and implemented by Gustavo Carneiro.}
506\end{seealso}
507
508%======================================================================
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000509\section{Other Language Changes}
510
511Here are all of the changes that Python 2.4 makes to the core Python
512language.
513
514\begin{itemize}
Raymond Hettingerd4462302003-11-26 17:52:45 +0000515
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000516\item The \method{dict.update()} method now accepts the same
517argument forms as the \class{dict} constructor. This includes any
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000518mapping, any iterable of key/value pairs, and keyword arguments.
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000519
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000520\item The string methods \method{ljust()}, \method{rjust()}, and
Andrew M. Kuchling67087562003-11-26 18:03:48 +0000521\method{center()} now take an optional argument for specifying a
Raymond Hettingerd4462302003-11-26 17:52:45 +0000522fill character other than a space.
523
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000524\item Strings also gained an \method{rsplit()} method that
Raymond Hettingered54d912003-12-31 01:59:18 +0000525works like the \method{split()} method but splits from the end of
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000526the string.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000527
528\begin{verbatim}
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000529>>> 'www.python.org'.split('.', 1)
530['www', 'python.org']
531'www.python.org'.rsplit('.', 1)
532['www.python', 'org']
533\end{verbatim}
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000534
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000535\item The \method{sort()} method of lists gained three keyword
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000536arguments: \var{cmp}, \var{key}, and \var{reverse}. These arguments
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000537make some common usages of \method{sort()} simpler. All are optional.
538
539\var{cmp} is the same as the previous single argument to
540\method{sort()}; if provided, the value should be a comparison
541function that takes two arguments and returns -1, 0, or +1 depending
542on how the arguments compare.
543
544\var{key} should be a single-argument function that takes a list
545element and returns a comparison key for the element. The list is
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000546then sorted using the comparison keys. The following example sorts a
547list case-insensitively:
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000548
549\begin{verbatim}
550>>> L = ['A', 'b', 'c', 'D']
551>>> L.sort() # Case-sensitive sort
552>>> L
553['A', 'D', 'b', 'c']
554>>> L.sort(key=lambda x: x.lower())
555>>> L
556['A', 'b', 'c', 'D']
557>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
558>>> L
559['A', 'b', 'c', 'D']
560\end{verbatim}
561
562The last example, which uses the \var{cmp} parameter, is the old way
Raymond Hettingered54d912003-12-31 01:59:18 +0000563to perform a case-insensitive sort. It works but is slower than
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000564using a \var{key} parameter. Using \var{key} results in calling the
565\method{lower()} method once for each element in the list while using
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000566\var{cmp} will call it twice for each comparison.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000567
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000568For simple key functions and comparison functions, it is often
569possible to avoid a \keyword{lambda} expression by using an unbound
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000570method instead. For example, the above case-insensitive sort is best
571coded as:
572
573\begin{verbatim}
574>>> L.sort(key=str.lower)
575>>> L
576['A', 'b', 'c', 'D']
577\end{verbatim}
578
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000579The \var{reverse} parameter should have a Boolean value. If the value
580is \constant{True}, the list will be sorted into reverse order.
581Instead of \code{L.sort(lambda x,y: cmp(x.score, y.score)) ;
582L.reverse()}, you can now write: \code{L.sort(key = lambda x: x.score,
583reverse=True)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000584
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000585The results of sorting are now guaranteed to be stable. This means
586that two entries with equal keys will be returned in the same order as
587they were input. For example, you can sort a list of people by name,
588and then sort the list by age, resulting in a list sorted by age where
589people with the same age are in name-sorted order.
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000590
Fred Drake56fcc232004-05-06 02:55:35 +0000591\item There is a new built-in function
592\function{sorted(\var{iterable})} that works like the in-place
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000593\method{list.sort()} method but can be used in
Fred Drake56fcc232004-05-06 02:55:35 +0000594expressions. The differences are:
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000595 \begin{itemize}
Raymond Hettinger7d1dd042003-11-12 16:42:10 +0000596 \item the input may be any iterable;
597 \item a newly formed copy is sorted, leaving the original intact; and
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000598 \item the expression returns the new sorted copy
599 \end{itemize}
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000600
601\begin{verbatim}
602>>> L = [9,7,8,3,2,4,1,6,5]
Raymond Hettinger64958a12003-12-17 20:43:33 +0000603>>> [10+i for i in sorted(L)] # usable in a list comprehension
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000604[11, 12, 13, 14, 15, 16, 17, 18, 19]
Hye-Shik Chang2b052482004-07-17 13:53:48 +0000605>>> L # original is left unchanged
Andrew M. Kuchlinge3e1eca2004-07-26 18:52:48 +0000606[9,7,8,3,2,4,1,6,5]
607>>> sorted('Monty Python') # any iterable may be an input
608[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']
Raymond Hettingerd4462302003-11-26 17:52:45 +0000609
610>>> # List the contents of a dict sorted by key values
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000611>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
Raymond Hettinger64958a12003-12-17 20:43:33 +0000612>>> for k, v in sorted(colormap.iteritems()):
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000613... print k, v
614...
615black 4
616blue 2
617green 3
618red 1
619yellow 5
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000620\end{verbatim}
621
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000622\item The \function{eval(\var{expr}, \var{globals}, \var{locals})}
Andrew M. Kuchling1455f792004-08-02 12:09:58 +0000623and \function{execfile(\var{filename}, \var{globals}, \var{locals})}
624functions and the \keyword{exec} statement now accept any mapping type
625for the \var{locals} argument. Previously this had to be a regular
626Python dictionary. (Contributed by Raymond Hettinger.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000627
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000628\item The \function{zip()} built-in function and \function{itertools.izip()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000629 now return an empty list if called with no arguments.
630 Previously they raised a \exception{TypeError}
631 exception. This makes them more
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000632 suitable for use with variable length argument lists:
633
634\begin{verbatim}
635>>> def transpose(array):
636... return zip(*array)
637...
638>>> transpose([(1,2,3), (4,5,6)])
639[(1, 4), (2, 5), (3, 6)]
640>>> transpose([])
641[]
642\end{verbatim}
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000643
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000644\item Encountering a failure while importing a module no longer leaves
645a partially-initialized module object in \code{sys.modules}. The
646incomplete module object left behind would fool further imports of the
647same module into succeeding, leading to confusing errors.
648
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000649\item \constant{None} is now a constant; code that binds a new value to
650the name \samp{None} is now a syntax error.
651
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000652\end{itemize}
653
654
655%======================================================================
656\subsection{Optimizations}
657
658\begin{itemize}
659
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000660\item The inner loops for list and tuple slicing
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000661 were optimized and now run about one-third faster. The inner loops
662 were also optimized for dictionaries, resulting in performance boosts for
663 \method{keys()}, \method{values()}, \method{items()},
664 \method{iterkeys()}, \method{itervalues()}, and \method{iteritems()}.
Raymond Hettingerb7d05db2004-03-08 07:25:05 +0000665
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000666\item The machinery for growing and shrinking lists was optimized for
667 speed and for space efficiency. Appending and popping from lists now
668 runs faster due to more efficient code paths and less frequent use of
669 the underlying system \cfunction{realloc()}. List comprehensions
670 also benefit. \method{list.extend()} was also optimized and no
671 longer converts its argument into a temporary list before extending
672 the base list.
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000673
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000674\item \function{list()}, \function{tuple()}, \function{map()},
675 \function{filter()}, and \function{zip()} now run several times
676 faster with non-sequence arguments that supply a \method{__len__()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000677 method.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000678
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +0000679\item The methods \method{list.__getitem__()},
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000680 \method{dict.__getitem__()}, and \method{dict.__contains__()} are
681 are now implemented as \class{method_descriptor} objects rather
682 than \class{wrapper_descriptor} objects. This form of optimized
683 access doubles their performance and makes them more suitable for
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +0000684 use as arguments to functionals:
685 \samp{map(mydict.__getitem__, keylist)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000686
Fred Draked6d35d92004-06-03 13:31:22 +0000687\item Added a new opcode, \code{LIST_APPEND}, that simplifies
Raymond Hettingerdd80f762004-03-07 07:31:06 +0000688 the generated bytecode for list comprehensions and speeds them up
689 by about a third.
690
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000691\end{itemize}
692
693The net result of the 2.4 optimizations is that Python 2.4 runs the
694pystone benchmark around XX\% faster than Python 2.3 and YY\% faster
695than Python 2.2.
696
697
698%======================================================================
699\section{New, Improved, and Deprecated Modules}
700
701As usual, Python's standard library received a number of enhancements and
702bug fixes. Here's a partial list of the most notable changes, sorted
703alphabetically by module name. Consult the
704\file{Misc/NEWS} file in the source tree for a more
705complete list of changes, or look through the CVS logs for all the
706details.
707
708\begin{itemize}
709
Anthony Baxter5da4c832004-07-09 16:16:46 +0000710% XXX new email parser
711
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000712\item The \module{asyncore} module's \function{loop()} now has a
713 \var{count} parameter that lets you perform a limited number
714 of passes through the polling loop. The default is still to loop
715 forever.
716
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +0000717\item The \module{curses} modules now supports the ncurses extension
Fred Draked6d35d92004-06-03 13:31:22 +0000718 \function{use_default_colors()}. On platforms where the terminal
719 supports transparency, this makes it possible to use a transparent
720 background. (Contributed by J\"org Lehmann.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000721
Raymond Hettinger0c410272004-01-05 10:13:35 +0000722\item The \module{bisect} module now has an underlying C implementation
723 for improved performance.
724 (Contributed by Dmitry Vasiliev.)
725
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000726\item The CJKCodecs collections of East Asian codecs, maintained
727by Hye-Shik Chang, was integrated into 2.4.
728The new encodings are:
729
730\begin{itemize}
Andrew M. Kuchling671c5062004-07-28 15:29:39 +0000731 \item Chinese (PRC): gb2312, gbk, gb18030, big5hkscs, hz
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000732 \item Chinese (ROC): big5, cp950
Andrew M. Kuchling671c5062004-07-28 15:29:39 +0000733 \item Japanese: cp932, euc-jis-2004, euc-jp,
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000734euc-jisx0213, iso-2022-jp, iso-2022-jp-1, iso-2022-jp-2,
Andrew M. Kuchling671c5062004-07-28 15:29:39 +0000735 iso-2022-jp-3, iso-2022-jp-ext, iso-2022-jp-2004,
736 shift-jis, shift-jisx0213, shift-jis-2004
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000737 \item Korean: cp949, euc-kr, johab, iso-2022-kr
738\end{itemize}
739
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000740\item There is a new \module{collections} module for
741 various specialized collection datatypes.
742 Currently it contains just one type, \class{deque},
743 a double-ended queue that supports efficiently adding and removing
744 elements from either end.
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000745
746\begin{verbatim}
747>>> from collections import deque
748>>> d = deque('ghi') # make a new deque with three items
749>>> d.append('j') # add a new entry to the right side
750>>> d.appendleft('f') # add a new entry to the left side
751>>> d # show the representation of the deque
752deque(['f', 'g', 'h', 'i', 'j'])
753>>> d.pop() # return and remove the rightmost item
754'j'
755>>> d.popleft() # return and remove the leftmost item
756'f'
757>>> list(d) # list the contents of the deque
758['g', 'h', 'i']
759>>> 'h' in d # search the deque
760True
761\end{verbatim}
762
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000763Several modules now take advantage of \class{collections.deque} for
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000764improved performance, such as the \module{Queue} and
765\module{threading} modules.
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000766
Fred Drake9f15b5c2004-05-18 04:30:00 +0000767\item The \module{ConfigParser} classes have been enhanced slightly.
768 The \method{read()} method now returns a list of the files that
769 were successfully parsed, and the \method{set()} method raises
770 \exception{TypeError} if passed a \var{value} argument that isn't a
771 string.
772
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000773\item The \module{heapq} module has been converted to C. The resulting
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000774 tenfold improvement in speed makes the module suitable for handling
Raymond Hettinger33ecffb2004-06-10 05:03:17 +0000775 high volumes of data. In addition, the module has two new functions
776 \function{nlargest()} and \function{nsmallest()} that use heaps to
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000777 find the N largest or smallest values in a dataset without the
Raymond Hettinger33ecffb2004-06-10 05:03:17 +0000778 expense of a full sort.
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000779
Andrew M. Kuchlingce4bae62004-07-27 12:13:25 +0000780\item The \module{imaplib} module now supports IMAP's THREAD command
781(contributed by Yves Dionne) and new \method{deleteacl()} and
782\method{myrights()} methods (contributed by Arnaud Mazin).
Andrew M. Kuchlingdff9dbd2003-11-20 22:22:19 +0000783
Andrew M. Kuchlingad809552003-12-06 23:19:23 +0000784\item The \module{itertools} module gained a
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000785 \function{groupby(\var{iterable}\optional{, \var{func}})} function.
Andrew M. Kuchlingad809552003-12-06 23:19:23 +0000786 \var{iterable} returns a succession of elements, and the optional
787 \var{func} is a function that takes an element and returns a key
788 value; if omitted, the key is simply the element itself.
789 \function{groupby()} then groups the elements into subsequences
790 which have matching values of the key, and returns a series of 2-tuples
791 containing the key value and an iterator over the subsequence.
792
793Here's an example. The \var{key} function simply returns whether a
794number is even or odd, so the result of \function{groupby()} is to
795return consecutive runs of odd or even numbers.
796
797\begin{verbatim}
798>>> import itertools
799>>> L = [2,4,6, 7,8,9,11, 12, 14]
800>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
801... print key_val, list(it)
802...
8030 [2, 4, 6]
8041 [7]
8050 [8]
8061 [9, 11]
8070 [12, 14]
808>>>
809\end{verbatim}
810
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000811\function{groupby()} is typically used with sorted input. The logic
812for \function{groupby()} is similar to the \UNIX{} \code{uniq} filter
813which makes it handy for eliminating, counting, or identifying
814duplicate elements:
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000815
816\begin{verbatim}
817>>> word = 'abracadabra'
Raymond Hettingered54d912003-12-31 01:59:18 +0000818>>> letters = sorted(word) # Turn string into a sorted list of letters
Raymond Hettinger64958a12003-12-17 20:43:33 +0000819>>> letters
Andrew M. Kuchling4612bc52003-12-16 20:59:37 +0000820['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000821>>> for k, g in itertools.groupby(letters):
822... print k, list(g)
823...
824a ['a', 'a', 'a', 'a', 'a']
825b ['b', 'b']
826c ['c']
827d ['d']
828r ['r', 'r']
829>>> # List unique letters
830>>> [k for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000831['a', 'b', 'c', 'd', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000832>>> # Count letter occurences
833>>> [(k, len(list(g))) for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000834[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000835\end{verbatim}
836
Raymond Hettingered54d912003-12-31 01:59:18 +0000837\item \module{itertools} also gained a function named
838\function{tee(\var{iterator}, \var{N})} that returns \var{N} independent
839iterators that replicate \var{iterator}. If \var{N} is omitted, the
840default is 2.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000841
842\begin{verbatim}
843>>> L = [1,2,3]
844>>> i1, i2 = itertools.tee(L)
845>>> i1,i2
846(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
Raymond Hettingered54d912003-12-31 01:59:18 +0000847>>> list(i1) # Run the first iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000848[1, 2, 3]
Raymond Hettingered54d912003-12-31 01:59:18 +0000849>>> list(i2) # Run the second iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000850[1, 2, 3]
851>\end{verbatim}
852
853Note that \function{tee()} has to keep copies of the values returned
Raymond Hettingered54d912003-12-31 01:59:18 +0000854by the iterator; in the worst case, it may need to keep all of them.
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000855This should therefore be used carefully if the leading iterator
Raymond Hettingered54d912003-12-31 01:59:18 +0000856can run far ahead of the trailing iterator in a long stream of inputs.
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000857If the separation is large, then you might as well use
Raymond Hettingered54d912003-12-31 01:59:18 +0000858\function{list()} instead. When the iterators track closely with one
859another, \function{tee()} is ideal. Possible applications include
860bookmarking, windowing, or lookahead iterators.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000861
Andrew M. Kuchling5785a132004-07-26 19:28:46 +0000862\item A number of functions were added to the \module{locale}
863module, such as \function{bind_textdomain_codeset()} to specify a
864particular encoding, and a family of \function{l*gettext()} functions
865that return messages in the chosen encoding.
866(Contributed by Gustavo Niemeyer.)
867
Andrew M. Kuchling23406892004-07-15 11:44:42 +0000868\item The \module{logging} package's \function{basicConfig} function
869gained some keyword arguments to simplify log configuration. The
870default behavior is to log messages to standard error, but
871various keyword arguments can be specified to log to a particular file,
872change the logging format, or set the logging level. For example:
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +0000873
874\begin{verbatim}
875import logging
876logging.basicConfig(filename = '/var/log/application.log',
877 level=0, # Log all messages, including debugging,
878 format='%(levelname):%(process):%(thread):%(message)')
879\end{verbatim}
880
881Another addition to \module{logging} is a
882\class{TimedRotatingFileHandler} class which rotates its log files at
883a timed interval. The module already had \class{RotatingFileHandler},
884which rotated logs once the file exceeded a certain size. Both
885classes derive from a new \class{BaseRotatingHandler} class that can
886be used to implement other rotating handlers.
887
Andrew M. Kuchling5785a132004-07-26 19:28:46 +0000888\item The \module{nntplib} module's \class{NNTP} class gained
889\method{description()} and \method{descriptions()} methods to retrieve
890newsgroup descriptions for a single group or for a range of groups.
891(Contributed by J\"urgen A. Erhard.)
892
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000893\item The \module{operator} module gained two new functions,
894\function{attrgetter(\var{attr})} and \function{itemgetter(\var{index})}.
895Both functions return callables that take a single argument and return
Raymond Hettingered54d912003-12-31 01:59:18 +0000896the corresponding attribute or item; these callables make excellent
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +0000897data extractors when used with \function{map()} or
898\function{sorted()}. For example:
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000899
900\begin{verbatim}
Raymond Hettingered54d912003-12-31 01:59:18 +0000901>>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000902>>> map(operator.itemgetter(0), L)
903['c', 'd', 'a', 'b']
904>>> map(operator.itemgetter(1), L)
Raymond Hettingered54d912003-12-31 01:59:18 +0000905[2, 1, 4, 3]
906>>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
907[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000908\end{verbatim}
909
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000910\item A new \function{getsid()} function was added to the
911\module{posix} module that underlies the \module{os} module.
912(Contributed by J. Raynor.)
913
914\item The \module{poplib} module now supports POP over SSL.
915
916\item The \module{profile} module can now profile C extension functions.
917% XXX more to say about this?
918
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000919\item The \module{random} module has a new method called \method{getrandbits(N)}
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000920 which returns an N-bit long integer. This method supports the existing
921 \method{randrange()} method, making it possible to efficiently generate
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000922 arbitrarily large random numbers.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000923
924\item The regular expression language accepted by the \module{re} module
925 was extended with simple conditional expressions, written as
926 \code{(?(\var{group})\var{A}|\var{B})}. \var{group} is either a
927 numeric group ID or a group name defined with \code{(?P<group>...)}
928 earlier in the expression. If the specified group matched, the
929 regular expression pattern \var{A} will be tested against the string; if
930 the group didn't match, the pattern \var{B} will be used instead.
Raymond Hettinger874ebd52004-05-31 03:15:02 +0000931
Anthony Baxter1869df12004-07-12 08:15:37 +0000932% XXX sre is now non-recursive.
933
Andrew M. Kuchling00457172004-07-15 11:52:40 +0000934\item The \module{threading} module now has an elegantly simple way to support
935thread-local data. The module contains a \class{local} class whose
936attribute values are local to different threads.
937
938\begin{verbatim}
939import threading
940
941data = threading.local()
942data.number = 42
943data.url = ('www.python.org', 80)
944\end{verbatim}
945
946Other threads can assign and retrieve their own values for the
947\member{number} and \member{url} attributes. You can subclass
948\class{local} to initialize attributes or to add methods.
949(Contributed by Jim Fulton.)
950
Raymond Hettinger874ebd52004-05-31 03:15:02 +0000951\item The \module{weakref} module now supports a wider variety of objects
952 including Python functions, class instances, sets, frozensets, deques,
953 arrays, files, sockets, and regular expression pattern objects.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000954
955\item The \module{xmlrpclib} module now supports a multi-call extension for
Andrew M. Kuchling00457172004-07-15 11:52:40 +0000956transmitting multiple XML-RPC calls in a single HTTP operation.
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +0000957
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000958\end{itemize}
959
960
961%======================================================================
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000962% whole new modules get described in subsections here
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000963
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000964\subsection{cookielib}
965
966The \module{cookielib} library supports client-side handling for HTTP
967cookies, just as the \module{Cookie} provides server-side cookie
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000968support in CGI scripts. Cookies are stored in cookie jars; the library
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000969transparently stores cookies offered by the web server in the cookie
970jar, and fetches the cookie from the jar when connecting to the
971server. Similar to web browsers, policy objects control whether
972cookies are accepted or not.
973
974In order to store cookies across sessions, two implementations of
975cookie jars are provided: one that stores cookies in the Netscape
976format, so applications can use the Mozilla or Lynx cookie jars, and
977one that stores cookies in the same format as the Perl libwww libary.
978
979\module{urllib2} has been changed to interact with \module{cookielib}:
980\class{HTTPCookieProcessor} manages a cookie jar that is used when
981accessing URLs.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000982
983% ======================================================================
984\section{Build and C API Changes}
985
986Changes to Python's build process and to the C API include:
987
988\begin{itemize}
989
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000990 \item Three new convenience macros were added for common return
991 values from extension functions: \csimplemacro{Py_RETURN_NONE},
992 \csimplemacro{Py_RETURN_TRUE}, and \csimplemacro{Py_RETURN_FALSE}.
993
Andrew M. Kuchling5785a132004-07-26 19:28:46 +0000994 \item Another new macro, \csimplemacro{Py_CLEAR(\var{obj})},
995 decreases the reference count of \var{obj} and sets \var{obj} to the
996 null pointer.
997
Fred Drakece3caf22004-02-12 18:13:12 +0000998 \item A new function, \cfunction{PyTuple_Pack(\var{N}, \var{obj1},
999 \var{obj2}, ..., \var{objN})}, constructs tuples from a variable
1000 length argument list of Python objects.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001001
Fred Drakece3caf22004-02-12 18:13:12 +00001002 \item A new function, \cfunction{PyDict_Contains(\var{d}, \var{k})},
1003 implements fast dictionary lookups without masking exceptions raised
1004 during the look-up process.
Raymond Hettingerd4462302003-11-26 17:52:45 +00001005
Fred Drakece3caf22004-02-12 18:13:12 +00001006 \item A new method flag, \constant{METH_COEXISTS}, allows a function
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001007 defined in slots to co-exist with a \ctype{PyCFunction} having the
1008 same name. This can halve the access time for a method such as
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001009 \method{set.__contains__()}.
1010
1011 \item Python can now be built with additional profiling for the interpreter
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001012 itself. This is intended for people developing on the Python core.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001013 Providing \longprogramopt{--enable-profiling} to the
1014 \program{configure} script will let you profile the interpreter with
1015 \program{gprof}, and providing the \longprogramopt{--with-tsc} switch
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001016 enables profiling using the Pentium's Time-Stamp-Counter register.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001017
1018 \item The \ctype{tracebackobject} type has been renamed to \ctype{PyTracebackObject}.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001019
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001020\end{itemize}
1021
1022
1023%======================================================================
1024\subsection{Port-Specific Changes}
1025
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001026\begin{itemize}
1027
1028\item The Windows port now builds under MSVC++ 7.1 as well as version 6.
1029
1030\end{itemize}
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001031
1032
1033%======================================================================
1034\section{Other Changes and Fixes \label{section-other}}
1035
1036As usual, there were a bunch of other improvements and bugfixes
1037scattered throughout the source tree. A search through the CVS change
1038logs finds there were XXX patches applied and YYY bugs fixed between
1039Python 2.3 and 2.4. Both figures are likely to be underestimates.
1040
1041Some of the more notable changes are:
1042
1043\begin{itemize}
1044
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001045\item The \module{timeit} module now automatically disables periodic
1046 garbarge collection during the timing loop. This change makes
1047 consecutive timings more comparable.
1048
1049\item The \module{base64} module now has more complete RFC 3548 support
1050 for Base64, Base32, and Base16 encoding and decoding, including
1051 optional case folding and optional alternative alphabets.
1052 (Contributed by Barry Warsaw.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001053
1054\end{itemize}
1055
1056
1057%======================================================================
1058\section{Porting to Python 2.4}
1059
1060This section lists previously described changes that may require
1061changes to your code:
1062
1063\begin{itemize}
1064
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001065\item The \function{zip()} built-in function and \function{itertools.izip()}
1066 now return an empty list instead of raising a \exception{TypeError}
1067 exception if called with no arguments.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001068
1069\item \function{dircache.listdir()} now passes exceptions to the caller
1070 instead of returning empty lists.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001071
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001072\item \function{LexicalHandler.startDTD()} used to receive the public and
1073 system IDs in the wrong order. This has been corrected; applications
Fred Drake56fcc232004-05-06 02:55:35 +00001074 relying on the wrong order need to be fixed.
Martin v. Löwis456ab1d2004-05-06 01:54:36 +00001075
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001076\item \function{fcntl.ioctl} now warns if the \var{mutate}
1077 argument is omitted and relevant.
Martin v. Löwis77ca6c42004-06-03 12:47:26 +00001078
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001079\end{itemize}
1080
1081
1082%======================================================================
1083\section{Acknowledgements \label{acks}}
1084
1085The author would like to thank the following people for offering
1086suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchling671c5062004-07-28 15:29:39 +00001087article: Hye-Shik Chang, Michael Dyck, Raymond Hettinger.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001088
1089\end{document}