blob: 6be2cbd255075d47aecf2cff3cdee4930ea12b10 [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
Fred Drakeed0fa3d2003-07-30 19:14:09 +00009\title{What's New in Python 2.4}
Andrew M. Kuchling536183b2004-11-25 01:15:25 +000010\release{1.01}
Fred Drakeed0fa3d2003-07-30 19:14:09 +000011\author{A.M.\ Kuchling}
Fred Drakeb914ef02004-01-02 06:57:50 +000012\authoraddress{
13 \strong{Python Software Foundation}\\
14 Email: \email{amk@amk.ca}
15}
Fred Drakeed0fa3d2003-07-30 19:14:09 +000016
17\begin{document}
18\maketitle
19\tableofcontents
20
Andrew M. Kuchling48715352004-11-30 14:42:24 +000021This article explains the new features in Python 2.4, released on
22November~30, 2004.
Fred Drakeed0fa3d2003-07-30 19:14:09 +000023
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000024Python 2.4 is a medium-sized release. It doesn't introduce as many
Andrew M. Kuchling3b790912004-07-04 16:39:40 +000025changes as the radical Python 2.2, but introduces more features than
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +000026the conservative 2.3 release. The most significant new language
27features are function decorators and generator expressions; most other
28changes are to the standard library.
29
Andrew M. Kuchling74666592004-11-19 14:26:23 +000030According to the CVS change logs, there were 481 patches applied and
31502 bugs fixed between Python 2.3 and 2.4. Both figures are likely to
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +000032be underestimates.
33
Fred Drakeed0fa3d2003-07-30 19:14:09 +000034This article doesn't attempt to provide a complete specification of
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +000035every single new feature, but instead provides a brief introduction to
36each feature. For full details, you should refer to the documentation
37for Python 2.4, such as the \citetitle[../lib/lib.html]{Python Library
38Reference} and the \citetitle[../ref/ref.html]{Python Reference
39Manual}. Often you will be referred to the PEP for a particular new
40feature for explanations of the implementation and design rationale.
Fred Drakeed0fa3d2003-07-30 19:14:09 +000041
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +000042
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000043%======================================================================
44\section{PEP 218: Built-In Set Objects}
45
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000046Python 2.3 introduced the \module{sets} module. C implementations of
47set data types have now been added to the Python core as two new
48built-in types, \function{set(\var{iterable})} and
49\function{frozenset(\var{iterable})}. They provide high speed
50operations for membership testing, for eliminating duplicates from
51sequences, and for mathematical operations like unions, intersections,
52differences, and symmetric differences.
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000053
54\begin{verbatim}
55>>> a = set('abracadabra') # form a set from a string
56>>> 'z' in a # fast membership testing
57False
58>>> a # unique letters in a
59set(['a', 'r', 'b', 'c', 'd'])
60>>> ''.join(a) # convert back into a string
61'arbcd'
Raymond Hettingerd4462302003-11-26 17:52:45 +000062
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000063>>> b = set('alacazam') # form a second set
64>>> a - b # letters in a but not in b
65set(['r', 'd', 'b'])
66>>> a | b # letters in either a or b
67set(['a', 'c', 'r', 'd', 'b', 'm', 'z', 'l'])
68>>> a & b # letters in both a and b
69set(['a', 'c'])
70>>> a ^ b # letters in a or b but not both
71set(['r', 'd', 'b', 'm', 'z', 'l'])
Raymond Hettingerd4462302003-11-26 17:52:45 +000072
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000073>>> a.add('z') # add a new element
74>>> a.update('wxy') # add multiple new elements
75>>> a
76set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'x', 'z'])
77>>> a.remove('x') # take one element out
78>>> a
79set(['a', 'c', 'b', 'd', 'r', 'w', 'y', 'z'])
80\end{verbatim}
81
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000082The \function{frozenset} type is an immutable version of \function{set}.
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000083Since it is immutable and hashable, it may be used as a dictionary key or
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000084as a member of another set.
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000085
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +000086The \module{sets} module remains in the standard library, and may be
87useful if you wish to subclass the \class{Set} or \class{ImmutableSet}
88classes. There are currently no plans to deprecate the module.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +000089
Raymond Hettinger7e0282f2003-11-24 07:14:54 +000090\begin{seealso}
91\seepep{218}{Adding a Built-In Set Object Type}{Originally proposed by
92Greg Wilson and ultimately implemented by Raymond Hettinger.}
93\end{seealso}
Fred Drakeed0fa3d2003-07-30 19:14:09 +000094
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +000095
Fred Drakeed0fa3d2003-07-30 19:14:09 +000096%======================================================================
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
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000119
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000120%======================================================================
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000121\section{PEP 289: Generator Expressions}
Raymond Hettinger354433a2004-05-19 08:20:33 +0000122
Andrew M. Kuchling38dc2a62004-08-07 13:24:12 +0000123The iterator feature introduced in Python 2.2 and the
124\module{itertools} module make it easier to write programs that loop
125through large data sets without having the entire data set in memory
126at one time. List comprehensions don't fit into this picture very
127well because they produce a Python list object containing all of the
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000128items. This unavoidably pulls all of the objects into memory, which
129can be a problem if your data set is very large. When trying to write
Andrew M. Kuchling38dc2a62004-08-07 13:24:12 +0000130a functionally-styled program, it would be natural to write something
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000131like:
Raymond Hettinger354433a2004-05-19 08:20:33 +0000132
133\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000134links = [link for link in get_all_links() if not link.followed]
135for link in links:
136 ...
Raymond Hettinger354433a2004-05-19 08:20:33 +0000137\end{verbatim}
138
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000139instead of
Raymond Hettinger354433a2004-05-19 08:20:33 +0000140
141\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000142for link in get_all_links():
143 if link.followed:
144 continue
145 ...
146\end{verbatim}
Raymond Hettinger354433a2004-05-19 08:20:33 +0000147
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000148The first form is more concise and perhaps more readable, but if
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000149you're dealing with a large number of link objects you'd have to write
150the second form to avoid having all link objects in memory at the same
151time.
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
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000184
185%======================================================================
186\section{PEP 292: Simpler String Substitutions}
187
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000188Some new classes in the standard library provide an alternative
189mechanism for substituting variables into strings; this style of
190substitution may be better for applications where untrained
191users need to edit templates.
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000192
193The usual way of substituting variables by name is the \code{\%}
194operator:
195
196\begin{verbatim}
197>>> '%(page)i: %(title)s' % {'page':2, 'title': 'The Best of Times'}
198'2: The Best of Times'
199\end{verbatim}
200
201When writing the template string, it can be easy to forget the
202\samp{i} or \samp{s} after the closing parenthesis. This isn't a big
203problem if the template is in a Python module, because you run the
204code, get an ``Unsupported format character'' \exception{ValueError},
205and fix the problem. However, consider an application such as Mailman
206where template strings or translations are being edited by users who
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000207aren't aware of the Python language. The format string's syntax is
208complicated to explain to such users, and if they make a mistake, it's
209difficult to provide helpful feedback to them.
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000210
211PEP 292 adds a \class{Template} class to the \module{string} module
212that uses \samp{\$} to indicate a substitution. \class{Template} is a
213subclass of the built-in Unicode type, so the result is always a
214Unicode string:
215
216\begin{verbatim}
217>>> import string
218>>> t = string.Template('$page: $title')
Andrew M. Kuchlinga79ec222004-09-10 11:34:39 +0000219>>> t.substitute({'page':2, 'title': 'The Best of Times'})
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000220u'2: The Best of Times'
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000221\end{verbatim}
222
223% $ Terminate $-mode for Emacs
224
Andrew M. Kuchlinga79ec222004-09-10 11:34:39 +0000225If a key is missing from the dictionary, the \method{substitute} method
226will raise a \exception{KeyError}. There's also a \method{safe_substitute}
227method that ignores missing keys:
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000228
229\begin{verbatim}
Andrew M. Kuchlingb69c49c2004-12-01 00:42:41 +0000230>>> t = string.Template('$page: $title')
Andrew M. Kuchlinga79ec222004-09-10 11:34:39 +0000231>>> t.safe_substitute({'page':3})
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000232u'3: $title'
233\end{verbatim}
234
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +0000235% $ Terminate math-mode for Emacs
236
237
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000238\begin{seealso}
239\seepep{292}{Simpler String Substitutions}{Written and implemented
240by Barry Warsaw.}
241\end{seealso}
242
243
Raymond Hettinger354433a2004-05-19 08:20:33 +0000244%======================================================================
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000245\section{PEP 318: Decorators for Functions and Methods}
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000246
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000247Python 2.2 extended Python's object model by adding static methods and
248class methods, but it didn't extend Python's syntax to provide any new
249way of defining static or class methods. Instead, you had to write a
250\keyword{def} statement in the usual way, and pass the resulting
251method to a \function{staticmethod()} or \function{classmethod()}
252function that would wrap up the function as a method of the new type.
253Your code would look like this:
254
255\begin{verbatim}
256class C:
257 def meth (cls):
258 ...
259
260 meth = classmethod(meth) # Rebind name to wrapped-up class method
261\end{verbatim}
262
263If the method was very long, it would be easy to miss or forget the
264\function{classmethod()} invocation after the function body.
265
266The intention was always to add some syntax to make such definitions
267more readable, but at the time of 2.2's release a good syntax was not
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000268obvious. Today a good syntax \emph{still} isn't obvious but users are
269asking for easier access to the feature; a new syntactic feature has
270been added to meet this need.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000271
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000272The new feature is called ``function decorators''. The name comes
273from the idea that \function{classmethod}, \function{staticmethod},
274and friends are storing additional information on a function object;
275they're \emph{decorating} functions with more details.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000276
Fred Drake3f5c6542004-08-06 03:34:20 +0000277The notation borrows from Java and uses the \character{@} character as an
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000278indicator. Using the new syntax, the example above would be written:
279
280\begin{verbatim}
281class C:
282
283 @classmethod
284 def meth (cls):
285 ...
286
287\end{verbatim}
288
289The \code{@classmethod} is shorthand for the
Fred Drake3f5c6542004-08-06 03:34:20 +0000290\code{meth=classmethod(meth)} assignment. More generally, if you have
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000291the following:
292
293\begin{verbatim}
294@A @B @C
295def f ():
296 ...
297\end{verbatim}
298
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000299It's equivalent to the following pre-decorator code:
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000300
301\begin{verbatim}
302def f(): ...
Andrew M. Kuchlingcebdd3c2004-10-08 18:29:29 +0000303f = A(B(C(f)))
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000304\end{verbatim}
305
306Decorators must come on the line before a function definition, and
307can't be on the same line, meaning that \code{@A def f(): ...} is
308illegal. You can only decorate function definitions, either at the
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000309module level or inside a class; you can't decorate class definitions.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000310
311A decorator is just a function that takes the function to be decorated
312as an argument and returns either the same function or some new
313callable thing. It's easy to write your own decorators. The
314following simple example just sets an attribute on the function
315object:
316
317\begin{verbatim}
318>>> def deco(func):
319... func.attr = 'decorated'
320... return func
321...
322>>> @deco
323... def f(): pass
324...
325>>> f
326<function f at 0x402ef0d4>
327>>> f.attr
328'decorated'
329>>>
330\end{verbatim}
331
332As a slightly more realistic example, the following decorator checks
333that the supplied argument is an integer:
334
335\begin{verbatim}
336def require_int (func):
337 def wrapper (arg):
338 assert isinstance(arg, int)
339 return func(arg)
340
341 return wrapper
342
343@require_int
344def p1 (arg):
345 print arg
346
347@require_int
348def p2(arg):
349 print arg*2
350\end{verbatim}
351
352An example in \pep{318} contains a fancier version of this idea that
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000353lets you both specify the required type and check the returned type.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000354
355Decorator functions can take arguments. If arguments are supplied,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000356your decorator function is called with only those arguments and must
357return a new decorator function; this function must take a single
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000358function and return a function, as previously described. In other
359words, \code{@A @B @C(args)} becomes:
360
361\begin{verbatim}
362def f(): ...
363_deco = C(args)
Andrew M. Kuchlingcebdd3c2004-10-08 18:29:29 +0000364f = A(B(_deco(f)))
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000365\end{verbatim}
366
367Getting this right can be slightly brain-bending, but it's not too
368difficult.
369
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000370A small related change makes the \member{func_name} attribute of
371functions writable. This attribute is used to display function names
372in tracebacks, so decorators should change the name of any new
373function that's constructed and returned.
374
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000375\begin{seealso}
376\seepep{318}{Decorators for Functions, Methods and Classes}{Written
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000377by Kevin D. Smith, Jim Jewett, and Skip Montanaro. Several people
378wrote patches implementing function decorators, but the one that was
Fred Drakee72bd4d2004-08-02 21:50:26 +0000379actually checked in was patch \#979728, written by Mark Russell.}
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000380\end{seealso}
381
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000382% XXX add link to decorators module in Wiki
383
384
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000385%======================================================================
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000386\section{PEP 322: Reverse Iteration}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000387
Fred Drake56fcc232004-05-06 02:55:35 +0000388A new built-in function, \function{reversed(\var{seq})}, takes a sequence
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000389and returns an iterator that loops over the elements of the sequence
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000390in reverse order.
391
392\begin{verbatim}
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000393>>> for i in reversed(xrange(1,4)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000394... print i
395...
3963
3972
3981
399\end{verbatim}
400
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000401Compared to extended slicing, such as \code{range(1,4)[::-1]},
402\function{reversed()} is easier to read, runs faster, and uses
403substantially less memory.
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000404
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000405Note that \function{reversed()} only accepts sequences, not arbitrary
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000406iterators. If you want to reverse an iterator, first convert it to
407a list with \function{list()}.
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000408
409\begin{verbatim}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000410>>> input = open('/etc/passwd', 'r')
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000411>>> for line in reversed(list(input)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000412... print line
413...
414root:*:0:0:System Administrator:/var/root:/bin/tcsh
415 ...
416\end{verbatim}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000417
Andrew M. Kuchlingf7a6b672003-11-08 16:05:37 +0000418\begin{seealso}
419\seepep{322}{Reverse Iteration}{Written and implemented by Raymond Hettinger.}
420
421\end{seealso}
422
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000423
424%======================================================================
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000425\section{PEP 324: New subprocess Module}
426
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000427The standard library provides a number of ways to execute a
428subprocess, offering different features and different levels of
429complexity. \function{os.system(\var{command})} is easy to use, but
430slow (it runs a shell process which executes the command) and
431dangerous (you have to be careful about escaping the shell's
432metacharacters). The \module{popen2} module offers classes that can
433capture standard output and standard error from the subprocess, but
434the naming is confusing. The \module{subprocess} module cleans
435this up, providing a unified interface that offers all the features
436you might need.
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000437
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000438Instead of \module{popen2}'s collection of classes,
439\module{subprocess} contains a single class called \class{Popen}
440whose constructor supports a number of different keyword arguments.
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000441
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000442\begin{verbatim}
443class Popen(args, bufsize=0, executable=None,
444 stdin=None, stdout=None, stderr=None,
445 preexec_fn=None, close_fds=False, shell=False,
446 cwd=None, env=None, universal_newlines=False,
447 startupinfo=None, creationflags=0):
448\end{verbatim}
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000449
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000450\var{args} is commonly a sequence of strings that will be the
451arguments to the program executed as the subprocess. (If the
452\var{shell} argument is true, \var{args} can be a string which will
453then be passed on to the shell for interpretation, just as
454\function{os.system()} does.)
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000455
456\var{stdin}, \var{stdout}, and \var{stderr} specify what the
457subprocess's input, output, and error streams will be. You can
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000458provide a file object or a file descriptor, or you can use the
459constant \code{subprocess.PIPE} to create a pipe between the
460subprocess and the parent.
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000461
462The constructor has a number of handy options:
463
464\begin{itemize}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000465 \item \var{close_fds} requests that all file descriptors be closed
466 before running the subprocess.
467
468 \item \var{cwd} specifies the working directory in which the
469 subprocess will be executed (defaulting to whatever the parent's
470 working directory is).
471
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000472 \item \var{env} is a dictionary specifying environment variables.
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000473
474 \item \var{preexec_fn} is a function that gets called before the
475 child is started.
476
477 \item \var{universal_newlines} opens the child's input and output
478 using Python's universal newline feature.
479
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000480\end{itemize}
481
482Once you've created the \class{Popen} instance,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000483you can call its \method{wait()} method to pause until the subprocess
484has exited, \method{poll()} to check if it's exited without pausing,
485or \method{communicate(\var{data})} to send the string \var{data} to
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000486the subprocess's standard input. \method{communicate(\var{data})}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000487then reads any data that the subprocess has sent to its standard output
488or standard error, returning a tuple \code{(\var{stdout_data},
489\var{stderr_data})}.
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000490
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000491\function{call()} is a shortcut that passes its arguments along to the
492\class{Popen} constructor, waits for the command to complete, and
493returns the status code of the subprocess. It can serve as a safer
494analog to \function{os.system()}:
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000495
496\begin{verbatim}
497sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
498if sts == 0:
499 # Success
500 ...
501else:
502 # dpkg returned an error
503 ...
504\end{verbatim}
505
506The command is invoked without use of the shell. If you really do want to
507use the shell, you can add \code{shell=True} as a keyword argument and provide
508a string instead of a sequence:
509
510\begin{verbatim}
511sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)
512\end{verbatim}
513
514The PEP takes various examples of shell and Python code and shows how
515they'd be translated into Python code that uses \module{subprocess}.
516Reading this section of the PEP is highly recommended.
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000517
518\begin{seealso}
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000519\seepep{324}{subprocess - New process module}{Written and implemented by Peter {\AA}strand, with assistance from Fredrik Lundh and others.}
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000520\end{seealso}
521
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000522
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000523%======================================================================
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000524\section{PEP 327: Decimal Data Type}
525
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000526Python has always supported floating-point (FP) numbers, based on the
527underlying C \ctype{double} type, as a data type. However, while most
Andrew M. Kuchling536183b2004-11-25 01:15:25 +0000528programming languages provide a floating-point type, many people (even
529programmers) are unaware that floating-point numbers don't represent
530certain decimal fractions accurately. The new \class{Decimal} type
531can represent these fractions accurately, up to a user-specified
532precision limit.
533
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000534
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000535\subsection{Why is Decimal needed?}
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000536
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000537The limitations arise from the representation used for floating-point numbers.
538FP numbers are made up of three components:
539
540\begin{itemize}
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000541\item The sign, which is positive or negative.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000542\item The mantissa, which is a single-digit binary number
543followed by a fractional part. For example, \code{1.01} in base-2 notation
544is \code{1 + 0/2 + 1/4}, or 1.25 in decimal notation.
545\item The exponent, which tells where the decimal point is located in the number represented.
546\end{itemize}
547
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000548For example, the number 1.25 has positive sign, a mantissa value of
5491.01 (in binary), and an exponent of 0 (the decimal point doesn't need
550to be shifted). The number 5 has the same sign and mantissa, but the
551exponent is 2 because the mantissa is multiplied by 4 (2 to the power
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000552of the exponent 2); 1.25 * 4 equals 5.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000553
554Modern systems usually provide floating-point support that conforms to
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000555a standard called IEEE 754. C's \ctype{double} type is usually
556implemented as a 64-bit IEEE 754 number, which uses 52 bits of space
557for the mantissa. This means that numbers can only be specified to 52
558bits of precision. If you're trying to represent numbers whose
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000559expansion repeats endlessly, the expansion is cut off after 52 bits.
560Unfortunately, most software needs to produce output in base 10, and
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000561common fractions in base 10 are often repeating decimals in binary.
562For example, 1.1 decimal is binary \code{1.0001100110011 ...}; .1 =
5631/16 + 1/32 + 1/256 plus an infinite number of additional terms. IEEE
564754 has to chop off that infinitely repeated decimal after 52 digits,
565so the representation is slightly inaccurate.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000566
567Sometimes you can see this inaccuracy when the number is printed:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000568\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000569>>> 1.1
5701.1000000000000001
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000571\end{verbatim}
572
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000573The inaccuracy isn't always visible when you print the number because
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000574the FP-to-decimal-string conversion is provided by the C library, and
575most C libraries try to produce sensible output. Even if it's not
576displayed, however, the inaccuracy is still there and subsequent
577operations can magnify the error.
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000578
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000579For many applications this doesn't matter. If I'm plotting points and
580displaying them on my monitor, the difference between 1.1 and
5811.1000000000000001 is too small to be visible. Reports often limit
582output to a certain number of decimal places, and if you round the
583number to two or three or even eight decimal places, the error is
584never apparent. However, for applications where it does matter,
585it's a lot of work to implement your own custom arithmetic routines.
586
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000587Hence, the \class{Decimal} type was created.
588
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000589\subsection{The \class{Decimal} type}
590
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000591A new module, \module{decimal}, was added to Python's standard
592library. It contains two classes, \class{Decimal} and
593\class{Context}. \class{Decimal} instances represent numbers, and
594\class{Context} instances are used to wrap up various settings such as
595the precision and default rounding mode.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000596
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000597\class{Decimal} instances are immutable, like regular Python integers
598and FP numbers; once it's been created, you can't change the value an
599instance represents. \class{Decimal} instances can be created from
600integers or strings:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000601
602\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000603>>> import decimal
604>>> decimal.Decimal(1972)
605Decimal("1972")
606>>> decimal.Decimal("1.1")
607Decimal("1.1")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000608\end{verbatim}
609
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000610You can also provide tuples containing the sign, the mantissa represented
611as a tuple of decimal digits, and the exponent:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000612
613\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000614>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
615Decimal("-14.75")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000616\end{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000617
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000618Cautionary note: the sign bit is a Boolean value, so 0 is positive and
6191 is negative.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000620
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000621Converting from floating-point numbers poses a bit of a problem:
622should the FP number representing 1.1 turn into the decimal number for
623exactly 1.1, or for 1.1 plus whatever inaccuracies are introduced?
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000624The decision was to dodge the issue and leave such a conversion out of
625the API. Instead, you should convert the floating-point number into a
626string using the desired precision and pass the string to the
627\class{Decimal} constructor:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000628
629\begin{verbatim}
630>>> f = 1.1
631>>> decimal.Decimal(str(f))
632Decimal("1.1")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000633>>> decimal.Decimal('%.12f' % f)
634Decimal("1.100000000000")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000635\end{verbatim}
636
637Once you have \class{Decimal} instances, you can perform the usual
638mathematical operations on them. One limitation: exponentiation
639requires an integer exponent:
640
641\begin{verbatim}
642>>> a = decimal.Decimal('35.72')
643>>> b = decimal.Decimal('1.73')
644>>> a+b
645Decimal("37.45")
646>>> a-b
647Decimal("33.99")
648>>> a*b
649Decimal("61.7956")
650>>> a/b
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000651Decimal("20.64739884393063583815028902")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000652>>> a ** 2
653Decimal("1275.9184")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000654>>> a**b
655Traceback (most recent call last):
656 ...
657decimal.InvalidOperation: x ** (non-integer)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000658\end{verbatim}
659
660You can combine \class{Decimal} instances with integers, but not with
661floating-point numbers:
662
663\begin{verbatim}
664>>> a + 4
665Decimal("39.72")
666>>> a + 4.5
667Traceback (most recent call last):
668 ...
669TypeError: You can interact Decimal only with int, long or Decimal data types.
670>>>
671\end{verbatim}
672
673\class{Decimal} numbers can be used with the \module{math} and
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000674\module{cmath} modules, but note that they'll be immediately converted to
675floating-point numbers before the operation is performed, resulting in
676a possible loss of precision and accuracy. You'll also get back a
677regular floating-point number and not a \class{Decimal}.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000678
679\begin{verbatim}
680>>> import math, cmath
681>>> d = decimal.Decimal('123456789012.345')
682>>> math.sqrt(d)
683351364.18288201344
684>>> cmath.sqrt(-d)
685351364.18288201344j
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000686\end{verbatim}
687
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000688\class{Decimal} instances have a \method{sqrt()} method that
689returns a \class{Decimal}, but if you need other things such as
690trigonometric functions you'll have to implement them.
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000691
692\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000693>>> d.sqrt()
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000694Decimal("351364.1828820134592177245001")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000695\end{verbatim}
696
697
698\subsection{The \class{Context} type}
699
700Instances of the \class{Context} class encapsulate several settings for
701decimal operations:
702
703\begin{itemize}
704 \item \member{prec} is the precision, the number of decimal places.
705 \item \member{rounding} specifies the rounding mode. The \module{decimal}
706 module has constants for the various possibilities:
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000707 \constant{ROUND_DOWN}, \constant{ROUND_CEILING},
708 \constant{ROUND_HALF_EVEN}, and various others.
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000709 \item \member{traps} is a dictionary specifying what happens on
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000710encountering certain error conditions: either an exception is raised or
711a value is returned. Some examples of error conditions are
712division by zero, loss of precision, and overflow.
713\end{itemize}
714
715There's a thread-local default context available by calling
716\function{getcontext()}; you can change the properties of this context
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000717to alter the default precision, rounding, or trap handling. The
718following example shows the effect of changing the precision of the default
719context:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000720
721\begin{verbatim}
722>>> decimal.getcontext().prec
72328
724>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000725Decimal("0.1428571428571428571428571429")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000726>>> decimal.getcontext().prec = 9
727>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000728Decimal("0.142857143")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000729\end{verbatim}
730
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000731The default action for error conditions is selectable; the module can
732either return a special value such as infinity or not-a-number, or
733exceptions can be raised:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000734
735\begin{verbatim}
736>>> decimal.Decimal(1) / decimal.Decimal(0)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000737Traceback (most recent call last):
738 ...
739decimal.DivisionByZero: x / 0
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000740>>> decimal.getcontext().traps[decimal.DivisionByZero] = False
741>>> decimal.Decimal(1) / decimal.Decimal(0)
742Decimal("Infinity")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000743>>>
744\end{verbatim}
745
746The \class{Context} instance also has various methods for formatting
747numbers such as \method{to_eng_string()} and \method{to_sci_string()}.
748
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000749For more information, see the documentation for the \module{decimal}
750module, which includes a quick-start tutorial and a reference.
751
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000752\begin{seealso}
753\seepep{327}{Decimal Data Type}{Written by Facundo Batista and implemented
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000754 by Facundo Batista, Eric Price, Raymond Hettinger, Aahz, and Tim Peters.}
755
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000756\seeurl{http://research.microsoft.com/\textasciitilde hollasch/cgindex/coding/ieeefloat.html}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000757{A more detailed overview of the IEEE-754 representation.}
758
759\seeurl{http://www.lahey.com/float.htm}
760{The article uses Fortran code to illustrate many of the problems
761that floating-point inaccuracy can cause.}
762
763\seeurl{http://www2.hursley.ibm.com/decimal/}
764{A description of a decimal-based representation. This representation
765is being proposed as a standard, and underlies the new Python decimal
766type. Much of this material was written by Mike Cowlishaw, designer of the
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000767Rexx language.}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000768
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000769\end{seealso}
770
771
772%======================================================================
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000773\section{PEP 328: Multi-line Imports}
774
775One language change is a small syntactic tweak aimed at making it
776easier to import many names from a module. In a
777\code{from \var{module} import \var{names}} statement,
778\var{names} is a sequence of names separated by commas. If the sequence is
779very long, you can either write multiple imports from the same module,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000780or you can use backslashes to escape the line endings like this:
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000781
782\begin{verbatim}
783from SimpleXMLRPCServer import SimpleXMLRPCServer,\
784 SimpleXMLRPCRequestHandler,\
785 CGIXMLRPCRequestHandler,\
786 resolve_dotted_attribute
787\end{verbatim}
788
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000789The syntactic change in Python 2.4 simply allows putting the names
790within parentheses. Python ignores newlines within a parenthesized
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000791expression, so the backslashes are no longer needed:
792
793\begin{verbatim}
794from SimpleXMLRPCServer import (SimpleXMLRPCServer,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000795 SimpleXMLRPCRequestHandler,
796 CGIXMLRPCRequestHandler,
797 resolve_dotted_attribute)
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000798\end{verbatim}
799
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000800The PEP also proposes that all \keyword{import} statements be absolute
801imports, with a leading \samp{.} character to indicate a relative
802import. This part of the PEP is not yet implemented, and will have to
803wait for Python 2.5 or some other future version.
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000804
805\begin{seealso}
Fred Drake410eb842004-09-01 04:05:08 +0000806\seepep{328}{Imports: Multi-Line and Absolute/Relative}
807 {Written by Aahz. Multi-line imports were implemented by
808 Dima Dorfman.}
809\end{seealso}
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000810
811
812%======================================================================
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000813\section{PEP 331: Locale-Independent Float/String Conversions}
814
815The \module{locale} modules lets Python software select various
816conversions and display conventions that are localized to a particular
817country or language. However, the module was careful to not change
818the numeric locale because various functions in Python's
819implementation required that the numeric locale remain set to the
820\code{'C'} locale. Often this was because the code was using the C library's
821\cfunction{atof()} function.
822
823Not setting the numeric locale caused trouble for extensions that used
824third-party C libraries, however, because they wouldn't have the
825correct locale set. The motivating example was GTK+, whose user
826interface widgets weren't displaying numbers in the current locale.
827
828The solution described in the PEP is to add three new functions to the
829Python API that perform ASCII-only conversions, ignoring the locale
830setting:
831
832\begin{itemize}
833 \item \cfunction{PyOS_ascii_strtod(\var{str}, \var{ptr})}
834and \cfunction{PyOS_ascii_atof(\var{str}, \var{ptr})}
835both convert a string to a C \ctype{double}.
836 \item \cfunction{PyOS_ascii_formatd(\var{buffer}, \var{buf_len}, \var{format}, \var{d})} converts a \ctype{double} to an ASCII string.
837\end{itemize}
838
839The code for these functions came from the GLib library
840(\url{http://developer.gnome.org/arch/gtk/glib.html}), whose
841developers kindly relicensed the relevant functions and donated them
842to the Python Software Foundation. The \module{locale} module
843can now change the numeric locale, letting extensions such as GTK+
844produce the correct results.
845
846\begin{seealso}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000847\seepep{331}{Locale-Independent Float/String Conversions}
848{Written by Christian R. Reis, and implemented by Gustavo Carneiro.}
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000849\end{seealso}
850
851%======================================================================
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000852\section{Other Language Changes}
853
854Here are all of the changes that Python 2.4 makes to the core Python
855language.
856
857\begin{itemize}
Raymond Hettingerd4462302003-11-26 17:52:45 +0000858
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000859\item Decorators for functions and methods were added (\pep{318}).
860
861\item Built-in \function{set} and \function{frozenset} types were
862added (\pep{218}). Other new built-ins include the \function{reversed(\var{seq})} function (\pep{322}).
863
864\item Generator expressions were added (\pep{289}).
865
866\item Certain numeric expressions no longer return values restricted to 32 or 64 bits (\pep{237}).
867
868\item You can now put parentheses around the list of names in a
869\code{from \var{module} import \var{names}} statement (\pep{328}).
870
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000871\item The \method{dict.update()} method now accepts the same
872argument forms as the \class{dict} constructor. This includes any
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +0000873mapping, any iterable of key/value pairs, and keyword arguments.
874(Contributed by Raymond Hettinger.)
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000875
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000876\item The string methods \method{ljust()}, \method{rjust()}, and
Andrew M. Kuchling67087562003-11-26 18:03:48 +0000877\method{center()} now take an optional argument for specifying a
Raymond Hettingerd4462302003-11-26 17:52:45 +0000878fill character other than a space.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +0000879(Contributed by Raymond Hettinger.)
Raymond Hettingerd4462302003-11-26 17:52:45 +0000880
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000881\item Strings also gained an \method{rsplit()} method that
Raymond Hettingered54d912003-12-31 01:59:18 +0000882works like the \method{split()} method but splits from the end of
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000883the string.
Andrew M. Kuchlingb69c49c2004-12-01 00:42:41 +0000884(Contributed by Sean Reifschneider.)
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000885
886\begin{verbatim}
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000887>>> 'www.python.org'.split('.', 1)
888['www', 'python.org']
889'www.python.org'.rsplit('.', 1)
890['www.python', 'org']
891\end{verbatim}
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000892
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000893\item Three keyword parameters, \var{cmp}, \var{key}, and
894\var{reverse}, were added to the \method{sort()} method of lists.
895These parameters make some common usages of \method{sort()} simpler.
896All of these parameters are optional.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000897
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000898For the \var{cmp} parameter, the value should be a comparison function
899that takes two parameters and returns -1, 0, or +1 depending on how
900the parameters compare. This function will then be used to sort the
901list. Previously this was the only parameter that could be provided
902to \method{sort()}.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000903
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000904\var{key} should be a single-parameter function that takes a list
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000905element and returns a comparison key for the element. The list is
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000906then sorted using the comparison keys. The following example sorts a
907list case-insensitively:
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000908
909\begin{verbatim}
910>>> L = ['A', 'b', 'c', 'D']
911>>> L.sort() # Case-sensitive sort
912>>> L
913['A', 'D', 'b', 'c']
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000914>>> # Using 'key' parameter to sort list
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000915>>> L.sort(key=lambda x: x.lower())
916>>> L
917['A', 'b', 'c', 'D']
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000918>>> # Old-fashioned way
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000919>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
920>>> L
921['A', 'b', 'c', 'D']
922\end{verbatim}
923
924The last example, which uses the \var{cmp} parameter, is the old way
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000925to perform a case-insensitive sort. It works but is slower than using
926a \var{key} parameter. Using \var{key} calls \method{lower()} method
927once for each element in the list while using \var{cmp} will call it
928twice for each comparison, so using \var{key} saves on invocations of
929the \method{lower()} method.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000930
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000931For simple key functions and comparison functions, it is often
932possible to avoid a \keyword{lambda} expression by using an unbound
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000933method instead. For example, the above case-insensitive sort is best
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000934written as:
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000935
936\begin{verbatim}
937>>> L.sort(key=str.lower)
938>>> L
939['A', 'b', 'c', 'D']
940\end{verbatim}
941
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000942Finally, the \var{reverse} parameter takes a Boolean value. If the
943value is true, the list will be sorted into reverse order.
944Instead of \code{L.sort() ; L.reverse()}, you can now write
945\code{L.sort(reverse=True)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000946
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000947The results of sorting are now guaranteed to be stable. This means
948that two entries with equal keys will be returned in the same order as
949they were input. For example, you can sort a list of people by name,
950and then sort the list by age, resulting in a list sorted by age where
951people with the same age are in name-sorted order.
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000952
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000953(All changes to \method{sort()} contributed by Raymond Hettinger.)
954
Fred Drake56fcc232004-05-06 02:55:35 +0000955\item There is a new built-in function
956\function{sorted(\var{iterable})} that works like the in-place
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000957\method{list.sort()} method but can be used in
Fred Drake56fcc232004-05-06 02:55:35 +0000958expressions. The differences are:
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000959 \begin{itemize}
Raymond Hettinger7d1dd042003-11-12 16:42:10 +0000960 \item the input may be any iterable;
961 \item a newly formed copy is sorted, leaving the original intact; and
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000962 \item the expression returns the new sorted copy
963 \end{itemize}
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000964
965\begin{verbatim}
966>>> L = [9,7,8,3,2,4,1,6,5]
Raymond Hettinger64958a12003-12-17 20:43:33 +0000967>>> [10+i for i in sorted(L)] # usable in a list comprehension
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000968[11, 12, 13, 14, 15, 16, 17, 18, 19]
Hye-Shik Chang2b052482004-07-17 13:53:48 +0000969>>> L # original is left unchanged
Andrew M. Kuchlinge3e1eca2004-07-26 18:52:48 +0000970[9,7,8,3,2,4,1,6,5]
971>>> sorted('Monty Python') # any iterable may be an input
972[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']
Raymond Hettingerd4462302003-11-26 17:52:45 +0000973
974>>> # List the contents of a dict sorted by key values
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000975>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
Raymond Hettinger64958a12003-12-17 20:43:33 +0000976>>> for k, v in sorted(colormap.iteritems()):
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000977... print k, v
978...
979black 4
980blue 2
981green 3
982red 1
983yellow 5
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000984\end{verbatim}
985
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +0000986(Contributed by Raymond Hettinger.)
987
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000988\item Integer operations will no longer trigger an \exception{OverflowWarning}.
989The \exception{OverflowWarning} warning will disappear in Python 2.5.
990
Andrew M. Kuchling5e3f9232004-10-07 12:00:33 +0000991\item The interpreter gained a new switch, \programopt{-m}, that
992takes a name, searches for the corresponding module on \code{sys.path},
993and runs the module as a script. For example,
994you can now run the Python profiler with \code{python -m profile}.
995(Contributed by Nick Coghlan.)
996
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000997\item The \function{eval(\var{expr}, \var{globals}, \var{locals})}
Andrew M. Kuchling1455f792004-08-02 12:09:58 +0000998and \function{execfile(\var{filename}, \var{globals}, \var{locals})}
999functions and the \keyword{exec} statement now accept any mapping type
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001000for the \var{locals} parameter. Previously this had to be a regular
Andrew M. Kuchling1455f792004-08-02 12:09:58 +00001001Python dictionary. (Contributed by Raymond Hettinger.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001002
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001003\item The \function{zip()} built-in function and \function{itertools.izip()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001004 now return an empty list if called with no arguments.
1005 Previously they raised a \exception{TypeError}
1006 exception. This makes them more
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001007 suitable for use with variable length argument lists:
1008
1009\begin{verbatim}
1010>>> def transpose(array):
1011... return zip(*array)
1012...
1013>>> transpose([(1,2,3), (4,5,6)])
1014[(1, 4), (2, 5), (3, 6)]
1015>>> transpose([])
1016[]
1017\end{verbatim}
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001018(Contributed by Raymond Hettinger.)
1019
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +00001020\item Encountering a failure while importing a module no longer leaves
1021a partially-initialized module object in \code{sys.modules}. The
1022incomplete module object left behind would fool further imports of the
1023same module into succeeding, leading to confusing errors.
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001024(Fixed by Tim Peters.)
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +00001025
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001026\item \constant{None} is now a constant; code that binds a new value to
1027the name \samp{None} is now a syntax error.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001028(Contributed by Raymond Hettinger.)
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001029
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001030\end{itemize}
1031
1032
1033%======================================================================
1034\subsection{Optimizations}
1035
1036\begin{itemize}
1037
Raymond Hettingerca1a7752004-07-12 13:00:45 +00001038\item The inner loops for list and tuple slicing
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001039 were optimized and now run about one-third faster. The inner loops
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001040 for dictionaries were also optimized , resulting in performance boosts for
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001041 \method{keys()}, \method{values()}, \method{items()},
1042 \method{iterkeys()}, \method{itervalues()}, and \method{iteritems()}.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001043 (Contributed by Raymond Hettinger.)
Raymond Hettingerb7d05db2004-03-08 07:25:05 +00001044
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001045\item The machinery for growing and shrinking lists was optimized for
1046 speed and for space efficiency. Appending and popping from lists now
1047 runs faster due to more efficient code paths and less frequent use of
1048 the underlying system \cfunction{realloc()}. List comprehensions
1049 also benefit. \method{list.extend()} was also optimized and no
1050 longer converts its argument into a temporary list before extending
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001051 the base list. (Contributed by Raymond Hettinger.)
Raymond Hettinger7a6d2972004-02-13 19:00:07 +00001052
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001053\item \function{list()}, \function{tuple()}, \function{map()},
1054 \function{filter()}, and \function{zip()} now run several times
1055 faster with non-sequence arguments that supply a \method{__len__()}
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001056 method. (Contributed by Raymond Hettinger.)
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001057
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +00001058\item The methods \method{list.__getitem__()},
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001059 \method{dict.__getitem__()}, and \method{dict.__contains__()} are
1060 are now implemented as \class{method_descriptor} objects rather
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001061 than \class{wrapper_descriptor} objects. This form of
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001062 access doubles their performance and makes them more suitable for
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +00001063 use as arguments to functionals:
1064 \samp{map(mydict.__getitem__, keylist)}.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001065 (Contributed by Raymond Hettinger.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001066
Fred Draked6d35d92004-06-03 13:31:22 +00001067\item Added a new opcode, \code{LIST_APPEND}, that simplifies
Raymond Hettingerdd80f762004-03-07 07:31:06 +00001068 the generated bytecode for list comprehensions and speeds them up
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001069 by about a third. (Contributed by Raymond Hettinger.)
Raymond Hettingerdd80f762004-03-07 07:31:06 +00001070
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001071\item The peephole bytecode optimizer has been improved to
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001072produce shorter, faster bytecode; remarkably, the resulting bytecode is
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001073more readable. (Enhanced by Raymond Hettinger.)
1074
Andrew M. Kuchlingac642872004-08-07 13:13:31 +00001075\item String concatenations in statements of the form \code{s = s +
1076"abc"} and \code{s += "abc"} are now performed more efficiently in
1077certain circumstances. This optimization won't be present in other
1078Python implementations such as Jython, so you shouldn't rely on it;
1079using the \method{join()} method of strings is still recommended when
1080you want to efficiently glue a large number of strings together.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001081(Contributed by Armin Rigo.)
Andrew M. Kuchlingac642872004-08-07 13:13:31 +00001082
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001083\end{itemize}
1084
Raymond Hettingerb2d5a8e2004-11-18 05:51:53 +00001085% pystone is almost useless for comparing different versions of Python;
1086% instead, it excels at predicting relative Python performance on
1087% different machines.
1088% So, this section would be more informative if it used other tools
1089% such as pybench and parrotbench. For a more application oriented
1090% benchmark, try comparing the timings of test_decimal.py under 2.3
1091% and 2.4.
1092
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001093The net result of the 2.4 optimizations is that Python 2.4 runs the
Andrew M. Kuchlingbae8f372004-11-19 14:55:28 +00001094pystone benchmark around 5\% faster than Python 2.3 and 35\% faster
1095than Python 2.2. (pystone is not a particularly good benchmark, but
1096it's the most commonly used measurement of Python's performance. Your
1097own applications may show greater or smaller benefits from Python~2.4.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001098
1099
1100%======================================================================
1101\section{New, Improved, and Deprecated Modules}
1102
1103As usual, Python's standard library received a number of enhancements and
1104bug fixes. Here's a partial list of the most notable changes, sorted
1105alphabetically by module name. Consult the
1106\file{Misc/NEWS} file in the source tree for a more
1107complete list of changes, or look through the CVS logs for all the
1108details.
1109
1110\begin{itemize}
1111
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001112\item The \module{asyncore} module's \function{loop()} function now
1113 has a \var{count} parameter that lets you perform a limited number
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001114 of passes through the polling loop. The default is still to loop
1115 forever.
1116
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001117\item The \module{base64} module now has more complete RFC 3548 support
1118 for Base64, Base32, and Base16 encoding and decoding, including
1119 optional case folding and optional alternative alphabets.
1120 (Contributed by Barry Warsaw.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001121
Raymond Hettinger0c410272004-01-05 10:13:35 +00001122\item The \module{bisect} module now has an underlying C implementation
1123 for improved performance.
1124 (Contributed by Dmitry Vasiliev.)
1125
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001126\item The CJKCodecs collections of East Asian codecs, maintained
1127by Hye-Shik Chang, was integrated into 2.4.
1128The new encodings are:
1129
1130\begin{itemize}
Andrew M. Kuchling671c5062004-07-28 15:29:39 +00001131 \item Chinese (PRC): gb2312, gbk, gb18030, big5hkscs, hz
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001132 \item Chinese (ROC): big5, cp950
Andrew M. Kuchling671c5062004-07-28 15:29:39 +00001133 \item Japanese: cp932, euc-jis-2004, euc-jp,
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001134euc-jisx0213, iso-2022-jp, iso-2022-jp-1, iso-2022-jp-2,
Andrew M. Kuchling671c5062004-07-28 15:29:39 +00001135 iso-2022-jp-3, iso-2022-jp-ext, iso-2022-jp-2004,
1136 shift-jis, shift-jisx0213, shift-jis-2004
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001137 \item Korean: cp949, euc-kr, johab, iso-2022-kr
1138\end{itemize}
1139
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001140\item Some other new encodings were added: HP Roman8,
1141ISO_8859-11, ISO_8859-16, PCTP-154, and TIS-620.
1142
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001143\item The UTF-8 and UTF-16 codecs now cope better with receiving partial input.
1144Previously the \class{StreamReader} class would try to read more data,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001145making it impossible to resume decoding from the stream. The
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001146\method{read()} method will now return as much data as it can and future
1147calls will resume decoding where previous ones left off.
1148(Implemented by Walter D\"orwald.)
1149
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +00001150\item There is a new \module{collections} module for
1151 various specialized collection datatypes.
1152 Currently it contains just one type, \class{deque},
1153 a double-ended queue that supports efficiently adding and removing
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001154 elements from either end:
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001155
1156\begin{verbatim}
1157>>> from collections import deque
1158>>> d = deque('ghi') # make a new deque with three items
1159>>> d.append('j') # add a new entry to the right side
1160>>> d.appendleft('f') # add a new entry to the left side
1161>>> d # show the representation of the deque
1162deque(['f', 'g', 'h', 'i', 'j'])
1163>>> d.pop() # return and remove the rightmost item
1164'j'
1165>>> d.popleft() # return and remove the leftmost item
1166'f'
1167>>> list(d) # list the contents of the deque
1168['g', 'h', 'i']
1169>>> 'h' in d # search the deque
1170True
1171\end{verbatim}
1172
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001173Several modules, such as the \module{Queue} and \module{threading}
1174modules, now take advantage of \class{collections.deque} for improved
1175performance. (Contributed by Raymond Hettinger.)
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001176
Fred Drake9f15b5c2004-05-18 04:30:00 +00001177\item The \module{ConfigParser} classes have been enhanced slightly.
1178 The \method{read()} method now returns a list of the files that
1179 were successfully parsed, and the \method{set()} method raises
1180 \exception{TypeError} if passed a \var{value} argument that isn't a
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001181 string. (Contributed by John Belmonte and David Goodger.)
Fred Drake9f15b5c2004-05-18 04:30:00 +00001182
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001183\item The \module{curses} module now supports the ncurses extension
1184 \function{use_default_colors()}. On platforms where the terminal
1185 supports transparency, this makes it possible to use a transparent
1186 background. (Contributed by J\"org Lehmann.)
1187
1188\item The \module{difflib} module now includes an \class{HtmlDiff} class
1189that creates an HTML table showing a side by side comparison
1190of two versions of a text. (Contributed by Dan Gass.)
1191
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001192\item The \module{email} package was updated to version 3.0,
1193which dropped various deprecated APIs and removes support for Python
1194versions earlier than 2.3. The 3.0 version of the package uses a new
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001195incremental parser for MIME messages, available in the
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001196\module{email.FeedParser} module. The new parser doesn't require
1197reading the entire message into memory, and doesn't throw exceptions
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001198if a message is malformed; instead it records any problems in the
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001199\member{defect} attribute of the message. (Developed by Anthony
1200Baxter, Barry Warsaw, Thomas Wouters, and others.)
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001201
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001202\item The \module{heapq} module has been converted to C. The resulting
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +00001203 tenfold improvement in speed makes the module suitable for handling
Raymond Hettinger33ecffb2004-06-10 05:03:17 +00001204 high volumes of data. In addition, the module has two new functions
1205 \function{nlargest()} and \function{nsmallest()} that use heaps to
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001206 find the N largest or smallest values in a dataset without the
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001207 expense of a full sort. (Contributed by Raymond Hettinger.)
Andrew M. Kuchling1a420252003-11-08 15:58:49 +00001208
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001209\item The \module{httplib} module now contains constants for HTTP
1210status codes defined in various HTTP-related RFC documents. Constants
1211have names such as \constant{OK}, \constant{CREATED},
1212\constant{CONTINUE}, and \constant{MOVED_PERMANENTLY}; use pydoc to
1213get a full list. (Contributed by Andrew Eland.)
1214
Andrew M. Kuchlingce4bae62004-07-27 12:13:25 +00001215\item The \module{imaplib} module now supports IMAP's THREAD command
1216(contributed by Yves Dionne) and new \method{deleteacl()} and
1217\method{myrights()} methods (contributed by Arnaud Mazin).
Andrew M. Kuchlingdff9dbd2003-11-20 22:22:19 +00001218
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001219\item The \module{itertools} module gained a
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001220 \function{groupby(\var{iterable}\optional{, \var{func}})} function.
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001221 \var{iterable} is something that can be iterated over to return a
1222 stream of elements, and the optional \var{func} parameter is a
1223 function that takes an element and returns a key value; if omitted,
1224 the key is simply the element itself. \function{groupby()} then
1225 groups the elements into subsequences which have matching values of
1226 the key, and returns a series of 2-tuples containing the key value
1227 and an iterator over the subsequence.
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001228
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001229Here's an example to make this clearer. The \var{key} function simply
1230returns whether a number is even or odd, so the result of
1231\function{groupby()} is to return consecutive runs of odd or even
1232numbers.
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001233
1234\begin{verbatim}
1235>>> import itertools
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001236>>> L = [2, 4, 6, 7, 8, 9, 11, 12, 14]
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001237>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
1238... print key_val, list(it)
1239...
12400 [2, 4, 6]
12411 [7]
12420 [8]
12431 [9, 11]
12440 [12, 14]
1245>>>
1246\end{verbatim}
1247
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001248\function{groupby()} is typically used with sorted input. The logic
1249for \function{groupby()} is similar to the \UNIX{} \code{uniq} filter
1250which makes it handy for eliminating, counting, or identifying
1251duplicate elements:
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001252
1253\begin{verbatim}
1254>>> word = 'abracadabra'
Raymond Hettingered54d912003-12-31 01:59:18 +00001255>>> letters = sorted(word) # Turn string into a sorted list of letters
Raymond Hettinger64958a12003-12-17 20:43:33 +00001256>>> letters
Andrew M. Kuchling4612bc52003-12-16 20:59:37 +00001257['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001258>>> for k, g in itertools.groupby(letters):
1259... print k, list(g)
1260...
1261a ['a', 'a', 'a', 'a', 'a']
1262b ['b', 'b']
1263c ['c']
1264d ['d']
1265r ['r', 'r']
1266>>> # List unique letters
1267>>> [k for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001268['a', 'b', 'c', 'd', 'r']
Johannes Gijsbersd3452252004-09-11 16:50:06 +00001269>>> # Count letter occurrences
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001270>>> [(k, len(list(g))) for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001271[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001272\end{verbatim}
1273
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001274(Contributed by Hye-Shik Chang.)
1275
Raymond Hettingered54d912003-12-31 01:59:18 +00001276\item \module{itertools} also gained a function named
1277\function{tee(\var{iterator}, \var{N})} that returns \var{N} independent
1278iterators that replicate \var{iterator}. If \var{N} is omitted, the
1279default is 2.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001280
1281\begin{verbatim}
1282>>> L = [1,2,3]
1283>>> i1, i2 = itertools.tee(L)
1284>>> i1,i2
1285(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
Raymond Hettingered54d912003-12-31 01:59:18 +00001286>>> list(i1) # Run the first iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001287[1, 2, 3]
Raymond Hettingered54d912003-12-31 01:59:18 +00001288>>> list(i2) # Run the second iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001289[1, 2, 3]
1290>\end{verbatim}
1291
1292Note that \function{tee()} has to keep copies of the values returned
Raymond Hettingered54d912003-12-31 01:59:18 +00001293by the iterator; in the worst case, it may need to keep all of them.
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +00001294This should therefore be used carefully if the leading iterator
Raymond Hettingered54d912003-12-31 01:59:18 +00001295can run far ahead of the trailing iterator in a long stream of inputs.
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001296If the separation is large, then you might as well use
Raymond Hettingered54d912003-12-31 01:59:18 +00001297\function{list()} instead. When the iterators track closely with one
1298another, \function{tee()} is ideal. Possible applications include
1299bookmarking, windowing, or lookahead iterators.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001300(Contributed by Raymond Hettinger.)
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001301
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001302\item A number of functions were added to the \module{locale}
1303module, such as \function{bind_textdomain_codeset()} to specify a
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001304particular encoding and a family of \function{l*gettext()} functions
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001305that return messages in the chosen encoding.
1306(Contributed by Gustavo Niemeyer.)
1307
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001308\item Some keyword arguments were added to the \module{logging}
1309package's \function{basicConfig} function to simplify log
1310configuration. The default behavior is to log messages to standard
1311error, but various keyword arguments can be specified to log to a
1312particular file, change the logging format, or set the logging level.
1313For example:
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001314
1315\begin{verbatim}
1316import logging
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001317logging.basicConfig(filename='/var/log/application.log',
1318 level=0, # Log all messages
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001319 format='%(levelname):%(process):%(thread):%(message)')
1320\end{verbatim}
1321
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001322Other additions to the \module{logging} package include a
1323\method{log(\var{level}, \var{msg})} convenience method, as well as a
1324\class{TimedRotatingFileHandler} class that rotates its log files at a
1325timed interval. The module already had \class{RotatingFileHandler},
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001326which rotated logs once the file exceeded a certain size. Both
1327classes derive from a new \class{BaseRotatingHandler} class that can
1328be used to implement other rotating handlers.
1329
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001330(Changes implemented by Vinay Sajip.)
1331
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001332\item The \module{marshal} module now shares interned strings on unpacking a
1333data structure. This may shrink the size of certain pickle strings,
1334but the primary effect is to make \file{.pyc} files significantly smaller.
1335(Contributed by Martin von Loewis.)
1336
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001337\item The \module{nntplib} module's \class{NNTP} class gained
1338\method{description()} and \method{descriptions()} methods to retrieve
1339newsgroup descriptions for a single group or for a range of groups.
1340(Contributed by J\"urgen A. Erhard.)
1341
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001342\item Two new functions were added to the \module{operator} module,
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001343\function{attrgetter(\var{attr})} and \function{itemgetter(\var{index})}.
1344Both functions return callables that take a single argument and return
Raymond Hettingered54d912003-12-31 01:59:18 +00001345the corresponding attribute or item; these callables make excellent
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001346data extractors when used with \function{map()} or
1347\function{sorted()}. For example:
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001348
1349\begin{verbatim}
Raymond Hettingered54d912003-12-31 01:59:18 +00001350>>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001351>>> map(operator.itemgetter(0), L)
1352['c', 'd', 'a', 'b']
1353>>> map(operator.itemgetter(1), L)
Raymond Hettingered54d912003-12-31 01:59:18 +00001354[2, 1, 4, 3]
1355>>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
1356[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001357\end{verbatim}
1358
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001359(Contributed by Raymond Hettinger.)
1360
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001361\item The \module{optparse} module was updated in various ways. The
1362module now passes its messages through \function{gettext.gettext()},
1363making it possible to internationalize Optik's help and error
1364messages. Help messages for options can now include the string
1365\code{'\%default'}, which will be replaced by the option's default
1366value. (Contributed by Greg Ward.)
Andrew M. Kuchlinge30c4d42004-08-07 13:58:02 +00001367
Andrew M. Kuchlingf3958f12004-10-11 19:20:06 +00001368\item The long-term plan is to deprecate the \module{rfc822} module
1369in some future Python release in favor of the \module{email} package.
1370To this end, the \function{email.Utils.formatdate()} function has been
1371changed to make it usable as a replacement for
1372\function{rfc822.formatdate()}. You may want to write new e-mail
1373processing code with this in mind. (Change implemented by Anthony
1374Baxter.)
1375
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001376\item A new \function{urandom(\var{n})} function was added to the
1377\module{os} module, returning a string containing \var{n} bytes of
1378random data. This function provides access to platform-specific
1379sources of randomness such as \file{/dev/urandom} on Linux or the
1380Windows CryptoAPI. (Contributed by Trevor Perrin.)
Andrew M. Kuchlingcb7b3f32004-08-30 11:58:04 +00001381
1382\item Another new function: \function{os.path.lexists(\var{path})}
1383returns true if the file specified by \var{path} exists, whether or
1384not it's a symbolic link. This differs from the existing
1385\function{os.path.exists(\var{path})} function, which returns false if
1386\var{path} is a symlink that points to a destination that doesn't exist.
1387(Contributed by Beni Cherniavsky.)
1388
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001389\item A new \function{getsid()} function was added to the
1390\module{posix} module that underlies the \module{os} module.
1391(Contributed by J. Raynor.)
1392
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001393\item The \module{poplib} module now supports POP over SSL. (Contributed by
1394Hector Urtubia.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001395
1396\item The \module{profile} module can now profile C extension functions.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001397(Contributed by Nick Bastin.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001398
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001399\item The \module{random} module has a new method called
1400 \method{getrandbits(\var{N})} that returns a long integer \var{N}
1401 bits in length. The existing \method{randrange()} method now uses
1402 \method{getrandbits()} where appropriate, making generation of
1403 arbitrarily large random numbers more efficient. (Contributed by
1404 Raymond Hettinger.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001405
1406\item The regular expression language accepted by the \module{re} module
1407 was extended with simple conditional expressions, written as
Andrew M. Kuchlingab778222004-08-31 12:07:43 +00001408 \regexp{(?(\var{group})\var{A}|\var{B})}. \var{group} is either a
1409 numeric group ID or a group name defined with \regexp{(?P<group>...)}
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001410 earlier in the expression. If the specified group matched, the
1411 regular expression pattern \var{A} will be tested against the string; if
1412 the group didn't match, the pattern \var{B} will be used instead.
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001413 (Contributed by Gustavo Niemeyer.)
Raymond Hettinger874ebd52004-05-31 03:15:02 +00001414
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001415\item The \module{re} module is also no longer recursive, thanks to a
1416massive amount of work by Gustavo Niemeyer. In a recursive regular
1417expression engine, certain patterns result in a large amount of C
1418stack space being consumed, and it was possible to overflow the stack.
1419For example, if you matched a 30000-byte string of \samp{a} characters
1420against the expression \regexp{(a|b)+}, one stack frame was consumed
1421per character. Python 2.3 tried to check for stack overflow and raise
1422a \exception{RuntimeError} exception, but certain patterns could
1423sidestep the checking and if you were unlucky Python could segfault.
1424Python 2.4's regular expression engine can match this pattern without
1425problems.
Andrew M. Kuchlingab778222004-08-31 12:07:43 +00001426
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001427\item A new \function{socketpair()} function, returning a pair of
1428connected sockets, was added to the \module{socket} module.
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001429(Contributed by Dave Cole.)
Andrew M. Kuchling7f203b82004-08-09 14:48:28 +00001430
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001431\item The \function{sys.exitfunc()} function has been deprecated. Code
1432should be using the existing \module{atexit} module, which correctly
1433handles calling multiple exit functions. Eventually
1434\function{sys.exitfunc()} will become a purely internal interface,
1435accessed only by \module{atexit}.
1436
1437\item The \module{tarfile} module now generates GNU-format tar files
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001438by default. (Contributed by Lars Gustaebel.)
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001439
Andrew M. Kuchling00457172004-07-15 11:52:40 +00001440\item The \module{threading} module now has an elegantly simple way to support
1441thread-local data. The module contains a \class{local} class whose
1442attribute values are local to different threads.
1443
1444\begin{verbatim}
1445import threading
1446
1447data = threading.local()
1448data.number = 42
1449data.url = ('www.python.org', 80)
1450\end{verbatim}
1451
1452Other threads can assign and retrieve their own values for the
1453\member{number} and \member{url} attributes. You can subclass
1454\class{local} to initialize attributes or to add methods.
1455(Contributed by Jim Fulton.)
1456
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001457\item The \module{timeit} module now automatically disables periodic
1458 garbarge collection during the timing loop. This change makes
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001459 consecutive timings more comparable. (Contributed by Raymond Hettinger.)
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001460
Raymond Hettinger874ebd52004-05-31 03:15:02 +00001461\item The \module{weakref} module now supports a wider variety of objects
1462 including Python functions, class instances, sets, frozensets, deques,
1463 arrays, files, sockets, and regular expression pattern objects.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001464 (Contributed by Raymond Hettinger.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001465
1466\item The \module{xmlrpclib} module now supports a multi-call extension for
Andrew M. Kuchling00457172004-07-15 11:52:40 +00001467transmitting multiple XML-RPC calls in a single HTTP operation.
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001468(Contributed by Brian Quinlan.)
Andrew M. Kuchling3d3db962004-08-31 13:57:02 +00001469
1470\item The \module{mpz}, \module{rotor}, and \module{xreadlines} modules have
1471been removed.
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +00001472
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001473\end{itemize}
1474
1475
1476%======================================================================
Raymond Hettingerca1a7752004-07-12 13:00:45 +00001477% whole new modules get described in subsections here
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001478
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001479%=====================
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001480\subsection{cookielib}
1481
1482The \module{cookielib} library supports client-side handling for HTTP
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001483cookies, mirroring the \module{Cookie} module's server-side cookie
1484support. Cookies are stored in cookie jars; the library transparently
1485stores cookies offered by the web server in the cookie jar, and
1486fetches the cookie from the jar when connecting to the server. As in
1487web browsers, policy objects control whether cookies are accepted or
1488not.
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001489
1490In order to store cookies across sessions, two implementations of
1491cookie jars are provided: one that stores cookies in the Netscape
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001492format so applications can use the Mozilla or Lynx cookie files, and
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001493one that stores cookies in the same format as the Perl libwww libary.
1494
1495\module{urllib2} has been changed to interact with \module{cookielib}:
1496\class{HTTPCookieProcessor} manages a cookie jar that is used when
1497accessing URLs.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001498
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001499This module was contributed by John J. Lee.
1500
1501
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001502% ==================
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001503\subsection{doctest}
1504
1505The \module{doctest} module underwent considerable refactoring thanks
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001506to Edward Loper and Tim Peters. Testing can still be as simple as
1507running \function{doctest.testmod()}, but the refactorings allow
1508customizing the module's operation in various ways
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001509
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001510The new \class{DocTestFinder} class extracts the tests from a given
1511object's docstrings:
1512
1513\begin{verbatim}
1514def f (x, y):
1515 """>>> f(2,2)
15164
1517>>> f(3,2)
15186
1519 """
1520 return x*y
1521
1522finder = doctest.DocTestFinder()
1523
1524# Get list of DocTest instances
1525tests = finder.find(f)
1526\end{verbatim}
1527
1528The new \class{DocTestRunner} class then runs individual tests and can
1529produce a summary of the results:
1530
1531\begin{verbatim}
1532runner = doctest.DocTestRunner()
1533for t in tests:
1534 tried, failed = runner.run(t)
1535
1536runner.summarize(verbose=1)
1537\end{verbatim}
1538
1539The above example produces the following output:
1540
1541\begin{verbatim}
15421 items passed all tests:
1543 2 tests in f
15442 tests in 1 items.
15452 passed and 0 failed.
1546Test passed.
1547\end{verbatim}
1548
1549\class{DocTestRunner} uses an instance of the \class{OutputChecker}
1550class to compare the expected output with the actual output. This
1551class takes a number of different flags that customize its behaviour;
1552ambitious users can also write a completely new subclass of
1553\class{OutputChecker}.
1554
1555The default output checker provides a number of handy features.
1556For example, with the \constant{doctest.ELLIPSIS} option flag,
1557an ellipsis (\samp{...}) in the expected output matches any substring,
1558making it easier to accommodate outputs that vary in minor ways:
1559
1560\begin{verbatim}
1561def o (n):
1562 """>>> o(1)
1563<__main__.C instance at 0x...>
1564>>>
1565"""
1566\end{verbatim}
1567
1568Another special string, \samp{<BLANKLINE>}, matches a blank line:
1569
1570\begin{verbatim}
1571def p (n):
1572 """>>> p(1)
1573<BLANKLINE>
1574>>>
1575"""
1576\end{verbatim}
1577
1578Another new capability is producing a diff-style display of the output
1579by specifying the \constant{doctest.REPORT_UDIFF} (unified diffs),
1580\constant{doctest.REPORT_CDIFF} (context diffs), or
1581\constant{doctest.REPORT_NDIFF} (delta-style) option flags. For example:
1582
1583\begin{verbatim}
1584def g (n):
1585 """>>> g(4)
1586here
1587is
1588a
1589lengthy
1590>>>"""
1591 L = 'here is a rather lengthy list of words'.split()
1592 for word in L[:n]:
1593 print word
1594\end{verbatim}
1595
1596Running the above function's tests with
1597\constant{doctest.REPORT_UDIFF} specified, you get the following output:
1598
1599\begin{verbatim}
1600**********************************************************************
1601File ``t.py'', line 15, in g
1602Failed example:
1603 g(4)
1604Differences (unified diff with -expected +actual):
1605 @@ -2,3 +2,3 @@
1606 is
1607 a
1608 -lengthy
1609 +rather
1610**********************************************************************
1611\end{verbatim}
1612
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001613
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001614% ======================================================================
1615\section{Build and C API Changes}
1616
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001617Some of the changes to Python's build process and to the C API are:
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001618
1619\begin{itemize}
1620
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001621 \item Three new convenience macros were added for common return
1622 values from extension functions: \csimplemacro{Py_RETURN_NONE},
1623 \csimplemacro{Py_RETURN_TRUE}, and \csimplemacro{Py_RETURN_FALSE}.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001624 (Contributed by Brett Cannon.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001625
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001626 \item Another new macro, \csimplemacro{Py_CLEAR(\var{obj})},
1627 decreases the reference count of \var{obj} and sets \var{obj} to the
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001628 null pointer. (Contributed by Jim Fulton.)
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001629
Fred Drakece3caf22004-02-12 18:13:12 +00001630 \item A new function, \cfunction{PyTuple_Pack(\var{N}, \var{obj1},
1631 \var{obj2}, ..., \var{objN})}, constructs tuples from a variable
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001632 length argument list of Python objects. (Contributed by Raymond Hettinger.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001633
Fred Drakece3caf22004-02-12 18:13:12 +00001634 \item A new function, \cfunction{PyDict_Contains(\var{d}, \var{k})},
1635 implements fast dictionary lookups without masking exceptions raised
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001636 during the look-up process. (Contributed by Raymond Hettinger.)
Raymond Hettingerd4462302003-11-26 17:52:45 +00001637
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001638 \item The \csimplemacro{Py_IS_NAN(\var{X})} macro returns 1 if
1639 its float or double argument \var{X} is a NaN.
1640 (Contributed by Tim Peters.)
1641
Andrew M. Kuchlingf3958f12004-10-11 19:20:06 +00001642 \item C code can avoid unnecessary locking by using the new
1643 \cfunction{PyEval_ThreadsInitialized()} function to tell
1644 if any thread operations have been performed. If this function
1645 returns false, no lock operations are needed.
1646 (Contributed by Nick Coghlan.)
1647
Andrew M. Kuchlinge30c4d42004-08-07 13:58:02 +00001648 \item A new function, \cfunction{PyArg_VaParseTupleAndKeywords()},
1649 is the same as \cfunction{PyArg_ParseTupleAndKeywords()} but takes a
1650 \ctype{va_list} instead of a number of arguments.
1651 (Contributed by Greg Chapman.)
1652
Fred Drakece3caf22004-02-12 18:13:12 +00001653 \item A new method flag, \constant{METH_COEXISTS}, allows a function
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001654 defined in slots to co-exist with a \ctype{PyCFunction} having the
1655 same name. This can halve the access time for a method such as
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001656 \method{set.__contains__()}. (Contributed by Raymond Hettinger.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001657
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001658 \item Python can now be built with additional profiling for the
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001659 interpreter itself, intended as an aid to people developing the
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001660 Python core. Providing \longprogramopt{--enable-profiling} to the
1661 \program{configure} script will let you profile the interpreter with
1662 \program{gprof}, and providing the \longprogramopt{--with-tsc}
1663 switch enables profiling using the Pentium's Time-Stamp-Counter
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001664 register. Note that the \longprogramopt{--with-tsc} switch is slightly
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001665 misnamed, because the profiling feature also works on the PowerPC
1666 platform, though that processor architecture doesn't call that
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001667 register ``the TSC register''. (Contributed by Jeremy Hylton.)
1668
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001669 \item The \ctype{tracebackobject} type has been renamed to \ctype{PyTracebackObject}.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001670
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001671\end{itemize}
1672
1673
1674%======================================================================
1675\subsection{Port-Specific Changes}
1676
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001677\begin{itemize}
1678
1679\item The Windows port now builds under MSVC++ 7.1 as well as version 6.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001680 (Contributed by Martin von Loewis.)
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001681
1682\end{itemize}
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001683
1684
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001685
1686%======================================================================
1687\section{Porting to Python 2.4}
1688
1689This section lists previously described changes that may require
1690changes to your code:
1691
1692\begin{itemize}
1693
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001694\item Left shifts and hexadecimal/octal constants that are too
1695 large no longer trigger a \exception{FutureWarning} and return
1696 a value limited to 32 or 64 bits; instead they return a long integer.
1697
1698\item Integer operations will no longer trigger an \exception{OverflowWarning}.
1699The \exception{OverflowWarning} warning will disappear in Python 2.5.
1700
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001701\item The \function{zip()} built-in function and \function{itertools.izip()}
1702 now return an empty list instead of raising a \exception{TypeError}
1703 exception if called with no arguments.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001704
1705\item \function{dircache.listdir()} now passes exceptions to the caller
1706 instead of returning empty lists.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001707
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001708\item \function{LexicalHandler.startDTD()} used to receive the public and
1709 system IDs in the wrong order. This has been corrected; applications
Fred Drake56fcc232004-05-06 02:55:35 +00001710 relying on the wrong order need to be fixed.
Martin v. Löwis456ab1d2004-05-06 01:54:36 +00001711
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001712\item \function{fcntl.ioctl} now warns if the \var{mutate}
1713 argument is omitted and relevant.
Martin v. Löwis77ca6c42004-06-03 12:47:26 +00001714
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001715\item The \module{tarfile} module now generates GNU-format tar files
1716by default.
1717
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001718\item Encountering a failure while importing a module no longer leaves
1719a partially-initialized module object in \code{sys.modules}.
1720
1721\item \constant{None} is now a constant; code that binds a new value to
1722the name \samp{None} is now a syntax error.
1723
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001724\end{itemize}
1725
1726
1727%======================================================================
1728\section{Acknowledgements \label{acks}}
1729
1730The author would like to thank the following people for offering
1731suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchling536183b2004-11-25 01:15:25 +00001732article: Koray Can, Hye-Shik Chang, Michael Dyck, Raymond Hettinger,
Andrew M. Kuchlingb69c49c2004-12-01 00:42:41 +00001733Brian Hurt, Hamish Lawson, Fredrik Lundh, Sean Reifschneider.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001734
1735\end{document}