blob: 29927e9d2cec3afbfb02828e6285216942696244 [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. 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
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000271the FP-to-decimal-string conversion is provided by the C library and
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000272most 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")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000322>>> decimal.Decimal('%.12f' % f)
323Decimal("1.100000000000")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000324\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
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000340Decimal("20.64739884393063583815028902")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000341>>> a ** 2
342Decimal("1275.9184")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000343>>> a**b
344Traceback (most recent call last):
345 ...
346decimal.InvalidOperation: x ** (non-integer)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000347\end{verbatim}
348
349You can combine \class{Decimal} instances with integers, but not with
350floating-point numbers:
351
352\begin{verbatim}
353>>> a + 4
354Decimal("39.72")
355>>> a + 4.5
356Traceback (most recent call last):
357 ...
358TypeError: You can interact Decimal only with int, long or Decimal data types.
359>>>
360\end{verbatim}
361
362\class{Decimal} numbers can be used with the \module{math} and
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000363\module{cmath} modules, but note that they'll be immediately converted to
364floating-point numbers before the operation is performed, resulting in
365a possible loss of precision and accuracy. You'll also get back a
366regular floating-point number and not a \class{Decimal}.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000367
368\begin{verbatim}
369>>> import math, cmath
370>>> d = decimal.Decimal('123456789012.345')
371>>> math.sqrt(d)
372351364.18288201344
373>>> cmath.sqrt(-d)
374351364.18288201344j
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000375\end{verbatim}
376
377Instances also have a \method{sqrt()} method that returns a
378\class{Decimal}, but if you need other things such as trigonometric
379functions you'll have to implement them.
380
381\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000382>>> d.sqrt()
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000383Decimal("351364.1828820134592177245001")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000384\end{verbatim}
385
386
387\subsection{The \class{Context} type}
388
389Instances of the \class{Context} class encapsulate several settings for
390decimal operations:
391
392\begin{itemize}
393 \item \member{prec} is the precision, the number of decimal places.
394 \item \member{rounding} specifies the rounding mode. The \module{decimal}
395 module has constants for the various possibilities:
396 \constant{ROUND_DOWN}, \constant{ROUND_CEILING}, \constant{ROUND_HALF_EVEN}, and various others.
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000397 \item \member{traps} is a dictionary specifying what happens on
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000398encountering certain error conditions: either an exception is raised or
399a value is returned. Some examples of error conditions are
400division by zero, loss of precision, and overflow.
401\end{itemize}
402
403There's a thread-local default context available by calling
404\function{getcontext()}; you can change the properties of this context
405to alter the default precision, rounding, or trap handling.
406
407\begin{verbatim}
408>>> decimal.getcontext().prec
40928
410>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000411Decimal("0.1428571428571428571428571429")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000412>>> decimal.getcontext().prec = 9
413>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000414Decimal("0.142857143")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000415\end{verbatim}
416
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000417The default action for error conditions is selectable; the module can
418either return a special value such as infinity or not-a-number, or
419exceptions can be raised:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000420
421\begin{verbatim}
422>>> decimal.Decimal(1) / decimal.Decimal(0)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000423Traceback (most recent call last):
424 ...
425decimal.DivisionByZero: x / 0
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000426>>> decimal.getcontext().traps[decimal.DivisionByZero] = False
427>>> decimal.Decimal(1) / decimal.Decimal(0)
428Decimal("Infinity")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000429>>>
430\end{verbatim}
431
432The \class{Context} instance also has various methods for formatting
433numbers such as \method{to_eng_string()} and \method{to_sci_string()}.
434
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000435For more information, see the documentation for the \module{decimal}
436module, which includes a quick-start tutorial and a reference.
437
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000438\begin{seealso}
439\seepep{327}{Decimal Data Type}{Written by Facundo Batista and implemented
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000440 by Facundo Batista, Eric Price, Raymond Hettinger, Aahz, and Tim Peters.}
441
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000442\seeurl{http://research.microsoft.com/\textasciitilde hollasch/cgindex/coding/ieeefloat.html}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000443{A more detailed overview of the IEEE-754 representation.}
444
445\seeurl{http://www.lahey.com/float.htm}
446{The article uses Fortran code to illustrate many of the problems
447that floating-point inaccuracy can cause.}
448
449\seeurl{http://www2.hursley.ibm.com/decimal/}
450{A description of a decimal-based representation. This representation
451is being proposed as a standard, and underlies the new Python decimal
452type. Much of this material was written by Mike Cowlishaw, designer of the
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000453Rexx language.}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000454
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000455\end{seealso}
456
457
458%======================================================================
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000459\section{PEP 331: Locale-Independent Float/String Conversions}
460
461The \module{locale} modules lets Python software select various
462conversions and display conventions that are localized to a particular
463country or language. However, the module was careful to not change
464the numeric locale because various functions in Python's
465implementation required that the numeric locale remain set to the
466\code{'C'} locale. Often this was because the code was using the C library's
467\cfunction{atof()} function.
468
469Not setting the numeric locale caused trouble for extensions that used
470third-party C libraries, however, because they wouldn't have the
471correct locale set. The motivating example was GTK+, whose user
472interface widgets weren't displaying numbers in the current locale.
473
474The solution described in the PEP is to add three new functions to the
475Python API that perform ASCII-only conversions, ignoring the locale
476setting:
477
478\begin{itemize}
479 \item \cfunction{PyOS_ascii_strtod(\var{str}, \var{ptr})}
480and \cfunction{PyOS_ascii_atof(\var{str}, \var{ptr})}
481both convert a string to a C \ctype{double}.
482 \item \cfunction{PyOS_ascii_formatd(\var{buffer}, \var{buf_len}, \var{format}, \var{d})} converts a \ctype{double} to an ASCII string.
483\end{itemize}
484
485The code for these functions came from the GLib library
486(\url{http://developer.gnome.org/arch/gtk/glib.html}), whose
487developers kindly relicensed the relevant functions and donated them
488to the Python Software Foundation. The \module{locale} module
489can now change the numeric locale, letting extensions such as GTK+
490produce the correct results.
491
492\begin{seealso}
493\seepep{331}{Locale-Independent Float/String Conversions}{Written by Christian R. Reis, and implemented by Gustavo Carneiro.}
494\end{seealso}
495
496%======================================================================
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000497\section{Other Language Changes}
498
499Here are all of the changes that Python 2.4 makes to the core Python
500language.
501
502\begin{itemize}
Raymond Hettingerd4462302003-11-26 17:52:45 +0000503
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000504\item The \method{dict.update()} method now accepts the same
505argument forms as the \class{dict} constructor. This includes any
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000506mapping, any iterable of key/value pairs, and keyword arguments.
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000507
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000508\item The string methods \method{ljust()}, \method{rjust()}, and
Andrew M. Kuchling67087562003-11-26 18:03:48 +0000509\method{center()} now take an optional argument for specifying a
Raymond Hettingerd4462302003-11-26 17:52:45 +0000510fill character other than a space.
511
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000512\item Strings also gained an \method{rsplit()} method that
Raymond Hettingered54d912003-12-31 01:59:18 +0000513works like the \method{split()} method but splits from the end of
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000514the string.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000515
516\begin{verbatim}
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000517>>> 'www.python.org'.split('.', 1)
518['www', 'python.org']
519'www.python.org'.rsplit('.', 1)
520['www.python', 'org']
521\end{verbatim}
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000522
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000523\item The \method{sort()} method of lists gained three keyword
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000524arguments: \var{cmp}, \var{key}, and \var{reverse}. These arguments
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000525make some common usages of \method{sort()} simpler. All are optional.
526
527\var{cmp} is the same as the previous single argument to
528\method{sort()}; if provided, the value should be a comparison
529function that takes two arguments and returns -1, 0, or +1 depending
530on how the arguments compare.
531
532\var{key} should be a single-argument function that takes a list
533element and returns a comparison key for the element. The list is
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000534then sorted using the comparison keys. The following example sorts a
535list case-insensitively:
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000536
537\begin{verbatim}
538>>> L = ['A', 'b', 'c', 'D']
539>>> L.sort() # Case-sensitive sort
540>>> L
541['A', 'D', 'b', 'c']
542>>> L.sort(key=lambda x: x.lower())
543>>> L
544['A', 'b', 'c', 'D']
545>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
546>>> L
547['A', 'b', 'c', 'D']
548\end{verbatim}
549
550The last example, which uses the \var{cmp} parameter, is the old way
Raymond Hettingered54d912003-12-31 01:59:18 +0000551to perform a case-insensitive sort. It works but is slower than
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000552using a \var{key} parameter. Using \var{key} results in calling the
553\method{lower()} method once for each element in the list while using
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000554\var{cmp} will call it twice for each comparison.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000555
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000556For simple key functions and comparison functions, it is often
557possible to avoid a \keyword{lambda} expression by using an unbound
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000558method instead. For example, the above case-insensitive sort is best
559coded as:
560
561\begin{verbatim}
562>>> L.sort(key=str.lower)
563>>> L
564['A', 'b', 'c', 'D']
565\end{verbatim}
566
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000567The \var{reverse} parameter should have a Boolean value. If the value
568is \constant{True}, the list will be sorted into reverse order.
569Instead of \code{L.sort(lambda x,y: cmp(x.score, y.score)) ;
570L.reverse()}, you can now write: \code{L.sort(key = lambda x: x.score,
571reverse=True)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000572
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000573The results of sorting are now guaranteed to be stable. This means
574that two entries with equal keys will be returned in the same order as
575they were input. For example, you can sort a list of people by name,
576and then sort the list by age, resulting in a list sorted by age where
577people with the same age are in name-sorted order.
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000578
Fred Drake56fcc232004-05-06 02:55:35 +0000579\item There is a new built-in function
580\function{sorted(\var{iterable})} that works like the in-place
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000581\method{list.sort()} method but can be used in
Fred Drake56fcc232004-05-06 02:55:35 +0000582expressions. The differences are:
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000583 \begin{itemize}
Raymond Hettinger7d1dd042003-11-12 16:42:10 +0000584 \item the input may be any iterable;
585 \item a newly formed copy is sorted, leaving the original intact; and
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000586 \item the expression returns the new sorted copy
587 \end{itemize}
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000588
589\begin{verbatim}
590>>> L = [9,7,8,3,2,4,1,6,5]
Raymond Hettinger64958a12003-12-17 20:43:33 +0000591>>> [10+i for i in sorted(L)] # usable in a list comprehension
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000592[11, 12, 13, 14, 15, 16, 17, 18, 19]
Hye-Shik Chang2b052482004-07-17 13:53:48 +0000593>>> L # original is left unchanged
Andrew M. Kuchlinge3e1eca2004-07-26 18:52:48 +0000594[9,7,8,3,2,4,1,6,5]
595>>> sorted('Monty Python') # any iterable may be an input
596[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']
Raymond Hettingerd4462302003-11-26 17:52:45 +0000597
598>>> # List the contents of a dict sorted by key values
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000599>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
Raymond Hettinger64958a12003-12-17 20:43:33 +0000600>>> for k, v in sorted(colormap.iteritems()):
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000601... print k, v
602...
603black 4
604blue 2
605green 3
606red 1
607yellow 5
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000608\end{verbatim}
609
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000610\item The \function{eval(\var{expr}, \var{globals}, \var{locals})}
611function now accepts any mapping type for the \var{locals} argument.
612Previously this had to be a regular Python dictionary.
613
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000614\item The \function{zip()} built-in function and \function{itertools.izip()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000615 now return an empty list if called with no arguments.
616 Previously they raised a \exception{TypeError}
617 exception. This makes them more
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000618 suitable for use with variable length argument lists:
619
620\begin{verbatim}
621>>> def transpose(array):
622... return zip(*array)
623...
624>>> transpose([(1,2,3), (4,5,6)])
625[(1, 4), (2, 5), (3, 6)]
626>>> transpose([])
627[]
628\end{verbatim}
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000629
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000630\item \constant{None} is now a constant; code that binds a new value to
631the name \samp{None} is now a syntax error.
632
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000633\end{itemize}
634
635
636%======================================================================
637\subsection{Optimizations}
638
639\begin{itemize}
640
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000641\item The inner loops for list and tuple slicing
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000642 were optimized and now run about one-third faster. The inner loops
643 were also optimized for dictionaries, resulting in performance boosts for
644 \method{keys()}, \method{values()}, \method{items()},
645 \method{iterkeys()}, \method{itervalues()}, and \method{iteritems()}.
Raymond Hettingerb7d05db2004-03-08 07:25:05 +0000646
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000647\item The machinery for growing and shrinking lists was optimized for
648 speed and for space efficiency. Appending and popping from lists now
649 runs faster due to more efficient code paths and less frequent use of
650 the underlying system \cfunction{realloc()}. List comprehensions
651 also benefit. \method{list.extend()} was also optimized and no
652 longer converts its argument into a temporary list before extending
653 the base list.
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000654
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000655\item \function{list()}, \function{tuple()}, \function{map()},
656 \function{filter()}, and \function{zip()} now run several times
657 faster with non-sequence arguments that supply a \method{__len__()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000658 method.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000659
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +0000660\item The methods \method{list.__getitem__()},
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000661 \method{dict.__getitem__()}, and \method{dict.__contains__()} are
662 are now implemented as \class{method_descriptor} objects rather
663 than \class{wrapper_descriptor} objects. This form of optimized
664 access doubles their performance and makes them more suitable for
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +0000665 use as arguments to functionals:
666 \samp{map(mydict.__getitem__, keylist)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000667
Fred Draked6d35d92004-06-03 13:31:22 +0000668\item Added a new opcode, \code{LIST_APPEND}, that simplifies
Raymond Hettingerdd80f762004-03-07 07:31:06 +0000669 the generated bytecode for list comprehensions and speeds them up
670 by about a third.
671
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000672\end{itemize}
673
674The net result of the 2.4 optimizations is that Python 2.4 runs the
675pystone benchmark around XX\% faster than Python 2.3 and YY\% faster
676than Python 2.2.
677
678
679%======================================================================
680\section{New, Improved, and Deprecated Modules}
681
682As usual, Python's standard library received a number of enhancements and
683bug fixes. Here's a partial list of the most notable changes, sorted
684alphabetically by module name. Consult the
685\file{Misc/NEWS} file in the source tree for a more
686complete list of changes, or look through the CVS logs for all the
687details.
688
689\begin{itemize}
690
Anthony Baxter5da4c832004-07-09 16:16:46 +0000691% XXX new email parser
692
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000693\item The \module{asyncore} module's \function{loop()} now has a
694 \var{count} parameter that lets you perform a limited number
695 of passes through the polling loop. The default is still to loop
696 forever.
697
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +0000698\item The \module{curses} modules now supports the ncurses extension
Fred Draked6d35d92004-06-03 13:31:22 +0000699 \function{use_default_colors()}. On platforms where the terminal
700 supports transparency, this makes it possible to use a transparent
701 background. (Contributed by J\"org Lehmann.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000702
Raymond Hettinger0c410272004-01-05 10:13:35 +0000703\item The \module{bisect} module now has an underlying C implementation
704 for improved performance.
705 (Contributed by Dmitry Vasiliev.)
706
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000707\item The CJKCodecs collections of East Asian codecs, maintained
708by Hye-Shik Chang, was integrated into 2.4.
709The new encodings are:
710
711\begin{itemize}
712 \item Chinese (PRC): gb2312, gbk, gb18030, hz
713 \item Chinese (ROC): big5, cp950
714 \item Japanese: cp932, shift-jis, shift-jisx0213, euc-jp,
715euc-jisx0213, iso-2022-jp, iso-2022-jp-1, iso-2022-jp-2,
716 iso-2022-jp-3, iso-2022-jp-ext
717 \item Korean: cp949, euc-kr, johab, iso-2022-kr
718\end{itemize}
719
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000720\item There is a new \module{collections} module for
721 various specialized collection datatypes.
722 Currently it contains just one type, \class{deque},
723 a double-ended queue that supports efficiently adding and removing
724 elements from either end.
Raymond Hettinger756b3f32004-01-29 06:37:52 +0000725
726\begin{verbatim}
727>>> from collections import deque
728>>> d = deque('ghi') # make a new deque with three items
729>>> d.append('j') # add a new entry to the right side
730>>> d.appendleft('f') # add a new entry to the left side
731>>> d # show the representation of the deque
732deque(['f', 'g', 'h', 'i', 'j'])
733>>> d.pop() # return and remove the rightmost item
734'j'
735>>> d.popleft() # return and remove the leftmost item
736'f'
737>>> list(d) # list the contents of the deque
738['g', 'h', 'i']
739>>> 'h' in d # search the deque
740True
741\end{verbatim}
742
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000743Several modules now take advantage of \class{collections.deque} for
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000744improved performance, such as the \module{Queue} and
745\module{threading} modules.
Andrew M. Kuchling5303a962004-01-18 15:55:51 +0000746
Fred Drake9f15b5c2004-05-18 04:30:00 +0000747\item The \module{ConfigParser} classes have been enhanced slightly.
748 The \method{read()} method now returns a list of the files that
749 were successfully parsed, and the \method{set()} method raises
750 \exception{TypeError} if passed a \var{value} argument that isn't a
751 string.
752
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000753\item The \module{heapq} module has been converted to C. The resulting
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +0000754 tenfold improvement in speed makes the module suitable for handling
Raymond Hettinger33ecffb2004-06-10 05:03:17 +0000755 high volumes of data. In addition, the module has two new functions
756 \function{nlargest()} and \function{nsmallest()} that use heaps to
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000757 find the N largest or smallest values in a dataset without the
Raymond Hettinger33ecffb2004-06-10 05:03:17 +0000758 expense of a full sort.
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000759
Andrew M. Kuchlingce4bae62004-07-27 12:13:25 +0000760\item The \module{imaplib} module now supports IMAP's THREAD command
761(contributed by Yves Dionne) and new \method{deleteacl()} and
762\method{myrights()} methods (contributed by Arnaud Mazin).
Andrew M. Kuchlingdff9dbd2003-11-20 22:22:19 +0000763
Andrew M. Kuchlingad809552003-12-06 23:19:23 +0000764\item The \module{itertools} module gained a
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000765 \function{groupby(\var{iterable}\optional{, \var{func}})} function.
Andrew M. Kuchlingad809552003-12-06 23:19:23 +0000766 \var{iterable} returns a succession of elements, and the optional
767 \var{func} is a function that takes an element and returns a key
768 value; if omitted, the key is simply the element itself.
769 \function{groupby()} then groups the elements into subsequences
770 which have matching values of the key, and returns a series of 2-tuples
771 containing the key value and an iterator over the subsequence.
772
773Here's an example. The \var{key} function simply returns whether a
774number is even or odd, so the result of \function{groupby()} is to
775return consecutive runs of odd or even numbers.
776
777\begin{verbatim}
778>>> import itertools
779>>> L = [2,4,6, 7,8,9,11, 12, 14]
780>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
781... print key_val, list(it)
782...
7830 [2, 4, 6]
7841 [7]
7850 [8]
7861 [9, 11]
7870 [12, 14]
788>>>
789\end{verbatim}
790
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000791\function{groupby()} is typically used with sorted input. The logic
792for \function{groupby()} is similar to the \UNIX{} \code{uniq} filter
793which makes it handy for eliminating, counting, or identifying
794duplicate elements:
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000795
796\begin{verbatim}
797>>> word = 'abracadabra'
Raymond Hettingered54d912003-12-31 01:59:18 +0000798>>> letters = sorted(word) # Turn string into a sorted list of letters
Raymond Hettinger64958a12003-12-17 20:43:33 +0000799>>> letters
Andrew M. Kuchling4612bc52003-12-16 20:59:37 +0000800['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000801>>> for k, g in itertools.groupby(letters):
802... print k, list(g)
803...
804a ['a', 'a', 'a', 'a', 'a']
805b ['b', 'b']
806c ['c']
807d ['d']
808r ['r', 'r']
809>>> # List unique letters
810>>> [k for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000811['a', 'b', 'c', 'd', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000812>>> # Count letter occurences
813>>> [(k, len(list(g))) for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000814[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +0000815\end{verbatim}
816
Raymond Hettingered54d912003-12-31 01:59:18 +0000817\item \module{itertools} also gained a function named
818\function{tee(\var{iterator}, \var{N})} that returns \var{N} independent
819iterators that replicate \var{iterator}. If \var{N} is omitted, the
820default is 2.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000821
822\begin{verbatim}
823>>> L = [1,2,3]
824>>> i1, i2 = itertools.tee(L)
825>>> i1,i2
826(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
Raymond Hettingered54d912003-12-31 01:59:18 +0000827>>> list(i1) # Run the first iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000828[1, 2, 3]
Raymond Hettingered54d912003-12-31 01:59:18 +0000829>>> list(i2) # Run the second iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000830[1, 2, 3]
831>\end{verbatim}
832
833Note that \function{tee()} has to keep copies of the values returned
Raymond Hettingered54d912003-12-31 01:59:18 +0000834by the iterator; in the worst case, it may need to keep all of them.
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000835This should therefore be used carefully if the leading iterator
Raymond Hettingered54d912003-12-31 01:59:18 +0000836can run far ahead of the trailing iterator in a long stream of inputs.
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000837If the separation is large, then you might as well use
Raymond Hettingered54d912003-12-31 01:59:18 +0000838\function{list()} instead. When the iterators track closely with one
839another, \function{tee()} is ideal. Possible applications include
840bookmarking, windowing, or lookahead iterators.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000841
Andrew M. Kuchling5785a132004-07-26 19:28:46 +0000842\item A number of functions were added to the \module{locale}
843module, such as \function{bind_textdomain_codeset()} to specify a
844particular encoding, and a family of \function{l*gettext()} functions
845that return messages in the chosen encoding.
846(Contributed by Gustavo Niemeyer.)
847
Andrew M. Kuchling23406892004-07-15 11:44:42 +0000848\item The \module{logging} package's \function{basicConfig} function
849gained some keyword arguments to simplify log configuration. The
850default behavior is to log messages to standard error, but
851various keyword arguments can be specified to log to a particular file,
852change the logging format, or set the logging level. For example:
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +0000853
854\begin{verbatim}
855import logging
856logging.basicConfig(filename = '/var/log/application.log',
857 level=0, # Log all messages, including debugging,
858 format='%(levelname):%(process):%(thread):%(message)')
859\end{verbatim}
860
861Another addition to \module{logging} is a
862\class{TimedRotatingFileHandler} class which rotates its log files at
863a timed interval. The module already had \class{RotatingFileHandler},
864which rotated logs once the file exceeded a certain size. Both
865classes derive from a new \class{BaseRotatingHandler} class that can
866be used to implement other rotating handlers.
867
Andrew M. Kuchling5785a132004-07-26 19:28:46 +0000868\item The \module{nntplib} module's \class{NNTP} class gained
869\method{description()} and \method{descriptions()} methods to retrieve
870newsgroup descriptions for a single group or for a range of groups.
871(Contributed by J\"urgen A. Erhard.)
872
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000873\item The \module{operator} module gained two new functions,
874\function{attrgetter(\var{attr})} and \function{itemgetter(\var{index})}.
875Both functions return callables that take a single argument and return
Raymond Hettingered54d912003-12-31 01:59:18 +0000876the corresponding attribute or item; these callables make excellent
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +0000877data extractors when used with \function{map()} or
878\function{sorted()}. For example:
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000879
880\begin{verbatim}
Raymond Hettingered54d912003-12-31 01:59:18 +0000881>>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000882>>> map(operator.itemgetter(0), L)
883['c', 'd', 'a', 'b']
884>>> map(operator.itemgetter(1), L)
Raymond Hettingered54d912003-12-31 01:59:18 +0000885[2, 1, 4, 3]
886>>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
887[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000888\end{verbatim}
889
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000890\item A new \function{getsid()} function was added to the
891\module{posix} module that underlies the \module{os} module.
892(Contributed by J. Raynor.)
893
894\item The \module{poplib} module now supports POP over SSL.
895
896\item The \module{profile} module can now profile C extension functions.
897% XXX more to say about this?
898
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000899\item The \module{random} module has a new method called \method{getrandbits(N)}
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000900 which returns an N-bit long integer. This method supports the existing
901 \method{randrange()} method, making it possible to efficiently generate
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000902 arbitrarily large random numbers.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000903
904\item The regular expression language accepted by the \module{re} module
905 was extended with simple conditional expressions, written as
906 \code{(?(\var{group})\var{A}|\var{B})}. \var{group} is either a
907 numeric group ID or a group name defined with \code{(?P<group>...)}
908 earlier in the expression. If the specified group matched, the
909 regular expression pattern \var{A} will be tested against the string; if
910 the group didn't match, the pattern \var{B} will be used instead.
Raymond Hettinger874ebd52004-05-31 03:15:02 +0000911
Anthony Baxter1869df12004-07-12 08:15:37 +0000912% XXX sre is now non-recursive.
913
Andrew M. Kuchling00457172004-07-15 11:52:40 +0000914\item The \module{threading} module now has an elegantly simple way to support
915thread-local data. The module contains a \class{local} class whose
916attribute values are local to different threads.
917
918\begin{verbatim}
919import threading
920
921data = threading.local()
922data.number = 42
923data.url = ('www.python.org', 80)
924\end{verbatim}
925
926Other threads can assign and retrieve their own values for the
927\member{number} and \member{url} attributes. You can subclass
928\class{local} to initialize attributes or to add methods.
929(Contributed by Jim Fulton.)
930
Raymond Hettinger874ebd52004-05-31 03:15:02 +0000931\item The \module{weakref} module now supports a wider variety of objects
932 including Python functions, class instances, sets, frozensets, deques,
933 arrays, files, sockets, and regular expression pattern objects.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000934
935\item The \module{xmlrpclib} module now supports a multi-call extension for
Andrew M. Kuchling00457172004-07-15 11:52:40 +0000936transmitting multiple XML-RPC calls in a single HTTP operation.
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +0000937
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000938\end{itemize}
939
940
941%======================================================================
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000942% whole new modules get described in subsections here
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000943
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000944\subsection{cookielib}
945
946The \module{cookielib} library supports client-side handling for HTTP
947cookies, just as the \module{Cookie} provides server-side cookie
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000948support in CGI scripts. Cookies are stored in cookie jars; the library
Martin v. Löwis2a6ba902004-05-31 18:22:40 +0000949transparently stores cookies offered by the web server in the cookie
950jar, and fetches the cookie from the jar when connecting to the
951server. Similar to web browsers, policy objects control whether
952cookies are accepted or not.
953
954In order to store cookies across sessions, two implementations of
955cookie jars are provided: one that stores cookies in the Netscape
956format, so applications can use the Mozilla or Lynx cookie jars, and
957one that stores cookies in the same format as the Perl libwww libary.
958
959\module{urllib2} has been changed to interact with \module{cookielib}:
960\class{HTTPCookieProcessor} manages a cookie jar that is used when
961accessing URLs.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000962
963% ======================================================================
964\section{Build and C API Changes}
965
966Changes to Python's build process and to the C API include:
967
968\begin{itemize}
969
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +0000970 \item Three new convenience macros were added for common return
971 values from extension functions: \csimplemacro{Py_RETURN_NONE},
972 \csimplemacro{Py_RETURN_TRUE}, and \csimplemacro{Py_RETURN_FALSE}.
973
Andrew M. Kuchling5785a132004-07-26 19:28:46 +0000974 \item Another new macro, \csimplemacro{Py_CLEAR(\var{obj})},
975 decreases the reference count of \var{obj} and sets \var{obj} to the
976 null pointer.
977
Fred Drakece3caf22004-02-12 18:13:12 +0000978 \item A new function, \cfunction{PyTuple_Pack(\var{N}, \var{obj1},
979 \var{obj2}, ..., \var{objN})}, constructs tuples from a variable
980 length argument list of Python objects.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000981
Fred Drakece3caf22004-02-12 18:13:12 +0000982 \item A new function, \cfunction{PyDict_Contains(\var{d}, \var{k})},
983 implements fast dictionary lookups without masking exceptions raised
984 during the look-up process.
Raymond Hettingerd4462302003-11-26 17:52:45 +0000985
Fred Drakece3caf22004-02-12 18:13:12 +0000986 \item A new method flag, \constant{METH_COEXISTS}, allows a function
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000987 defined in slots to co-exist with a \ctype{PyCFunction} having the
988 same name. This can halve the access time for a method such as
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000989 \method{set.__contains__()}.
990
991 \item Python can now be built with additional profiling for the interpreter
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000992 itself. This is intended for people developing on the Python core.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000993 Providing \longprogramopt{--enable-profiling} to the
994 \program{configure} script will let you profile the interpreter with
995 \program{gprof}, and providing the \longprogramopt{--with-tsc} switch
Andrew M. Kuchling71432f12004-07-05 01:40:07 +0000996 enables profiling using the Pentium's Time-Stamp-Counter register.
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000997
998 \item The \ctype{tracebackobject} type has been renamed to \ctype{PyTracebackObject}.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000999
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001000\end{itemize}
1001
1002
1003%======================================================================
1004\subsection{Port-Specific Changes}
1005
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001006\begin{itemize}
1007
1008\item The Windows port now builds under MSVC++ 7.1 as well as version 6.
1009
1010\end{itemize}
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001011
1012
1013%======================================================================
1014\section{Other Changes and Fixes \label{section-other}}
1015
1016As usual, there were a bunch of other improvements and bugfixes
1017scattered throughout the source tree. A search through the CVS change
1018logs finds there were XXX patches applied and YYY bugs fixed between
1019Python 2.3 and 2.4. Both figures are likely to be underestimates.
1020
1021Some of the more notable changes are:
1022
1023\begin{itemize}
1024
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001025\item The \module{timeit} module now automatically disables periodic
1026 garbarge collection during the timing loop. This change makes
1027 consecutive timings more comparable.
1028
1029\item The \module{base64} module now has more complete RFC 3548 support
1030 for Base64, Base32, and Base16 encoding and decoding, including
1031 optional case folding and optional alternative alphabets.
1032 (Contributed by Barry Warsaw.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001033
1034\end{itemize}
1035
1036
1037%======================================================================
1038\section{Porting to Python 2.4}
1039
1040This section lists previously described changes that may require
1041changes to your code:
1042
1043\begin{itemize}
1044
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001045\item The \function{zip()} built-in function and \function{itertools.izip()}
1046 now return an empty list instead of raising a \exception{TypeError}
1047 exception if called with no arguments.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001048
1049\item \function{dircache.listdir()} now passes exceptions to the caller
1050 instead of returning empty lists.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001051
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001052\item \function{LexicalHandler.startDTD()} used to receive the public and
1053 system IDs in the wrong order. This has been corrected; applications
Fred Drake56fcc232004-05-06 02:55:35 +00001054 relying on the wrong order need to be fixed.
Martin v. Löwis456ab1d2004-05-06 01:54:36 +00001055
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001056\item \function{fcntl.ioctl} now warns if the \var{mutate}
1057 argument is omitted and relevant.
Martin v. Löwis77ca6c42004-06-03 12:47:26 +00001058
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001059\end{itemize}
1060
1061
1062%======================================================================
1063\section{Acknowledgements \label{acks}}
1064
1065The author would like to thank the following people for offering
1066suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchlinge3e1eca2004-07-26 18:52:48 +00001067article: Michael Dyck, Raymond Hettinger.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001068
1069\end{document}