blob: 3c98aa61c91e0ca04916a5ef56302bbe631c9070 [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. Kuchlingaafdc9c2004-12-01 00:46:33 +000010\release{1.02}
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
Andrew M. Kuchlinge2a66bf2004-12-01 00:45:15 +0000212that uses \samp{\$} to indicate a substitution:
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000213
214\begin{verbatim}
215>>> import string
216>>> t = string.Template('$page: $title')
Andrew M. Kuchlinga79ec222004-09-10 11:34:39 +0000217>>> t.substitute({'page':2, 'title': 'The Best of Times'})
Andrew M. Kuchlinge2a66bf2004-12-01 00:45:15 +0000218'2: The Best of Times'
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000219\end{verbatim}
220
221% $ Terminate $-mode for Emacs
222
Andrew M. Kuchlinga79ec222004-09-10 11:34:39 +0000223If a key is missing from the dictionary, the \method{substitute} method
224will raise a \exception{KeyError}. There's also a \method{safe_substitute}
225method that ignores missing keys:
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000226
227\begin{verbatim}
Andrew M. Kuchlingb69c49c2004-12-01 00:42:41 +0000228>>> t = string.Template('$page: $title')
Andrew M. Kuchlinga79ec222004-09-10 11:34:39 +0000229>>> t.safe_substitute({'page':3})
Andrew M. Kuchlinge2a66bf2004-12-01 00:45:15 +0000230'3: $title'
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000231\end{verbatim}
232
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +0000233% $ Terminate math-mode for Emacs
234
235
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000236\begin{seealso}
237\seepep{292}{Simpler String Substitutions}{Written and implemented
238by Barry Warsaw.}
239\end{seealso}
240
241
Raymond Hettinger354433a2004-05-19 08:20:33 +0000242%======================================================================
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000243\section{PEP 318: Decorators for Functions and Methods}
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000244
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000245Python 2.2 extended Python's object model by adding static methods and
246class methods, but it didn't extend Python's syntax to provide any new
247way of defining static or class methods. Instead, you had to write a
248\keyword{def} statement in the usual way, and pass the resulting
249method to a \function{staticmethod()} or \function{classmethod()}
250function that would wrap up the function as a method of the new type.
251Your code would look like this:
252
253\begin{verbatim}
254class C:
255 def meth (cls):
256 ...
257
258 meth = classmethod(meth) # Rebind name to wrapped-up class method
259\end{verbatim}
260
261If the method was very long, it would be easy to miss or forget the
262\function{classmethod()} invocation after the function body.
263
264The intention was always to add some syntax to make such definitions
265more readable, but at the time of 2.2's release a good syntax was not
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000266obvious. Today a good syntax \emph{still} isn't obvious but users are
267asking for easier access to the feature; a new syntactic feature has
268been added to meet this need.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000269
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000270The new feature is called ``function decorators''. The name comes
271from the idea that \function{classmethod}, \function{staticmethod},
272and friends are storing additional information on a function object;
273they're \emph{decorating} functions with more details.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000274
Fred Drake3f5c6542004-08-06 03:34:20 +0000275The notation borrows from Java and uses the \character{@} character as an
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000276indicator. Using the new syntax, the example above would be written:
277
278\begin{verbatim}
279class C:
280
281 @classmethod
282 def meth (cls):
283 ...
284
285\end{verbatim}
286
287The \code{@classmethod} is shorthand for the
Fred Drake3f5c6542004-08-06 03:34:20 +0000288\code{meth=classmethod(meth)} assignment. More generally, if you have
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000289the following:
290
291\begin{verbatim}
Skip Montanaro9935e7f2004-12-26 15:29:28 +0000292@A
293@B
294@C
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000295def 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
Skip Montanaro9935e7f2004-12-26 15:29:28 +0000306Decorators must come on the line before a function definition, one decorator
307per line, and can't be on the same line as the def statement, meaning that
308\code{@A def f(): ...} is illegal. You can only decorate function
309definitions, either at the module level or inside a class; you can't
310decorate class definitions.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000311
Skip Montanaro9935e7f2004-12-26 15:29:28 +0000312A decorator is just a function that takes the function to be decorated as an
313argument and returns either the same function or some new object. The
314return value of the decorator need not be callable (though it typically is),
315unless further decorators will be applied to the result. It's easy to write
316your own decorators. The following simple example just sets an attribute on
317the function object:
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000318
319\begin{verbatim}
320>>> def deco(func):
321... func.attr = 'decorated'
322... return func
323...
324>>> @deco
325... def f(): pass
326...
327>>> f
328<function f at 0x402ef0d4>
329>>> f.attr
330'decorated'
331>>>
332\end{verbatim}
333
334As a slightly more realistic example, the following decorator checks
335that the supplied argument is an integer:
336
337\begin{verbatim}
338def require_int (func):
339 def wrapper (arg):
340 assert isinstance(arg, int)
341 return func(arg)
342
343 return wrapper
344
345@require_int
346def p1 (arg):
347 print arg
348
349@require_int
350def p2(arg):
351 print arg*2
352\end{verbatim}
353
354An example in \pep{318} contains a fancier version of this idea that
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000355lets you both specify the required type and check the returned type.
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000356
357Decorator functions can take arguments. If arguments are supplied,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000358your decorator function is called with only those arguments and must
359return a new decorator function; this function must take a single
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000360function and return a function, as previously described. In other
361words, \code{@A @B @C(args)} becomes:
362
363\begin{verbatim}
364def f(): ...
365_deco = C(args)
Andrew M. Kuchlingcebdd3c2004-10-08 18:29:29 +0000366f = A(B(_deco(f)))
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000367\end{verbatim}
368
369Getting this right can be slightly brain-bending, but it's not too
370difficult.
371
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000372A small related change makes the \member{func_name} attribute of
373functions writable. This attribute is used to display function names
374in tracebacks, so decorators should change the name of any new
375function that's constructed and returned.
376
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000377\begin{seealso}
378\seepep{318}{Decorators for Functions, Methods and Classes}{Written
Andrew M. Kuchling77a602f2004-08-02 13:48:18 +0000379by Kevin D. Smith, Jim Jewett, and Skip Montanaro. Several people
380wrote patches implementing function decorators, but the one that was
Fred Drakee72bd4d2004-08-02 21:50:26 +0000381actually checked in was patch \#979728, written by Mark Russell.}
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000382\end{seealso}
383
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000384% XXX add link to decorators module in Wiki
385
386
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +0000387%======================================================================
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000388\section{PEP 322: Reverse Iteration}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000389
Fred Drake56fcc232004-05-06 02:55:35 +0000390A new built-in function, \function{reversed(\var{seq})}, takes a sequence
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000391and returns an iterator that loops over the elements of the sequence
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000392in reverse order.
393
394\begin{verbatim}
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000395>>> for i in reversed(xrange(1,4)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000396... print i
397...
3983
3992
4001
401\end{verbatim}
402
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000403Compared to extended slicing, such as \code{range(1,4)[::-1]},
404\function{reversed()} is easier to read, runs faster, and uses
405substantially less memory.
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000406
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000407Note that \function{reversed()} only accepts sequences, not arbitrary
Raymond Hettingerbc3cba22003-11-12 16:39:30 +0000408iterators. If you want to reverse an iterator, first convert it to
409a list with \function{list()}.
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000410
411\begin{verbatim}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000412>>> input = open('/etc/passwd', 'r')
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000413>>> for line in reversed(list(input)):
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000414... print line
415...
416root:*:0:0:System Administrator:/var/root:/bin/tcsh
417 ...
418\end{verbatim}
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000419
Andrew M. Kuchlingf7a6b672003-11-08 16:05:37 +0000420\begin{seealso}
421\seepep{322}{Reverse Iteration}{Written and implemented by Raymond Hettinger.}
422
423\end{seealso}
424
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000425
426%======================================================================
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000427\section{PEP 324: New subprocess Module}
428
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000429The standard library provides a number of ways to execute a
430subprocess, offering different features and different levels of
431complexity. \function{os.system(\var{command})} is easy to use, but
432slow (it runs a shell process which executes the command) and
433dangerous (you have to be careful about escaping the shell's
434metacharacters). The \module{popen2} module offers classes that can
435capture standard output and standard error from the subprocess, but
436the naming is confusing. The \module{subprocess} module cleans
437this up, providing a unified interface that offers all the features
438you might need.
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000439
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000440Instead of \module{popen2}'s collection of classes,
441\module{subprocess} contains a single class called \class{Popen}
442whose constructor supports a number of different keyword arguments.
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000443
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000444\begin{verbatim}
445class Popen(args, bufsize=0, executable=None,
446 stdin=None, stdout=None, stderr=None,
447 preexec_fn=None, close_fds=False, shell=False,
448 cwd=None, env=None, universal_newlines=False,
449 startupinfo=None, creationflags=0):
450\end{verbatim}
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000451
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000452\var{args} is commonly a sequence of strings that will be the
453arguments to the program executed as the subprocess. (If the
454\var{shell} argument is true, \var{args} can be a string which will
455then be passed on to the shell for interpretation, just as
456\function{os.system()} does.)
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000457
458\var{stdin}, \var{stdout}, and \var{stderr} specify what the
459subprocess's input, output, and error streams will be. You can
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000460provide a file object or a file descriptor, or you can use the
461constant \code{subprocess.PIPE} to create a pipe between the
462subprocess and the parent.
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000463
464The constructor has a number of handy options:
465
466\begin{itemize}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000467 \item \var{close_fds} requests that all file descriptors be closed
468 before running the subprocess.
469
470 \item \var{cwd} specifies the working directory in which the
471 subprocess will be executed (defaulting to whatever the parent's
472 working directory is).
473
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000474 \item \var{env} is a dictionary specifying environment variables.
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000475
476 \item \var{preexec_fn} is a function that gets called before the
477 child is started.
478
479 \item \var{universal_newlines} opens the child's input and output
480 using Python's universal newline feature.
481
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000482\end{itemize}
483
484Once you've created the \class{Popen} instance,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000485you can call its \method{wait()} method to pause until the subprocess
486has exited, \method{poll()} to check if it's exited without pausing,
487or \method{communicate(\var{data})} to send the string \var{data} to
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000488the subprocess's standard input. \method{communicate(\var{data})}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000489then reads any data that the subprocess has sent to its standard output
490or standard error, returning a tuple \code{(\var{stdout_data},
491\var{stderr_data})}.
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000492
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000493\function{call()} is a shortcut that passes its arguments along to the
494\class{Popen} constructor, waits for the command to complete, and
495returns the status code of the subprocess. It can serve as a safer
496analog to \function{os.system()}:
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000497
498\begin{verbatim}
499sts = subprocess.call(['dpkg', '-i', '/tmp/new-package.deb'])
500if sts == 0:
501 # Success
502 ...
503else:
504 # dpkg returned an error
505 ...
506\end{verbatim}
507
508The command is invoked without use of the shell. If you really do want to
509use the shell, you can add \code{shell=True} as a keyword argument and provide
510a string instead of a sequence:
511
512\begin{verbatim}
513sts = subprocess.call('dpkg -i /tmp/new-package.deb', shell=True)
514\end{verbatim}
515
516The PEP takes various examples of shell and Python code and shows how
517they'd be translated into Python code that uses \module{subprocess}.
518Reading this section of the PEP is highly recommended.
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000519
520\begin{seealso}
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000521\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 +0000522\end{seealso}
523
Andrew M. Kuchlingb6ffc272004-10-12 16:36:57 +0000524
Andrew M. Kuchlingc9e7d772004-10-12 15:58:02 +0000525%======================================================================
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000526\section{PEP 327: Decimal Data Type}
527
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000528Python has always supported floating-point (FP) numbers, based on the
529underlying C \ctype{double} type, as a data type. However, while most
Andrew M. Kuchling536183b2004-11-25 01:15:25 +0000530programming languages provide a floating-point type, many people (even
531programmers) are unaware that floating-point numbers don't represent
532certain decimal fractions accurately. The new \class{Decimal} type
533can represent these fractions accurately, up to a user-specified
534precision limit.
535
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000536
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000537\subsection{Why is Decimal needed?}
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000538
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000539The limitations arise from the representation used for floating-point numbers.
540FP numbers are made up of three components:
541
542\begin{itemize}
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000543\item The sign, which is positive or negative.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000544\item The mantissa, which is a single-digit binary number
545followed by a fractional part. For example, \code{1.01} in base-2 notation
546is \code{1 + 0/2 + 1/4}, or 1.25 in decimal notation.
547\item The exponent, which tells where the decimal point is located in the number represented.
548\end{itemize}
549
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000550For example, the number 1.25 has positive sign, a mantissa value of
5511.01 (in binary), and an exponent of 0 (the decimal point doesn't need
552to be shifted). The number 5 has the same sign and mantissa, but the
553exponent is 2 because the mantissa is multiplied by 4 (2 to the power
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000554of the exponent 2); 1.25 * 4 equals 5.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000555
556Modern systems usually provide floating-point support that conforms to
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000557a standard called IEEE 754. C's \ctype{double} type is usually
558implemented as a 64-bit IEEE 754 number, which uses 52 bits of space
559for the mantissa. This means that numbers can only be specified to 52
560bits of precision. If you're trying to represent numbers whose
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000561expansion repeats endlessly, the expansion is cut off after 52 bits.
562Unfortunately, most software needs to produce output in base 10, and
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000563common fractions in base 10 are often repeating decimals in binary.
564For example, 1.1 decimal is binary \code{1.0001100110011 ...}; .1 =
5651/16 + 1/32 + 1/256 plus an infinite number of additional terms. IEEE
566754 has to chop off that infinitely repeated decimal after 52 digits,
567so the representation is slightly inaccurate.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000568
569Sometimes you can see this inaccuracy when the number is printed:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000570\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000571>>> 1.1
5721.1000000000000001
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000573\end{verbatim}
574
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000575The inaccuracy isn't always visible when you print the number because
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000576the FP-to-decimal-string conversion is provided by the C library, and
577most C libraries try to produce sensible output. Even if it's not
578displayed, however, the inaccuracy is still there and subsequent
579operations can magnify the error.
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000580
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000581For many applications this doesn't matter. If I'm plotting points and
582displaying them on my monitor, the difference between 1.1 and
5831.1000000000000001 is too small to be visible. Reports often limit
584output to a certain number of decimal places, and if you round the
585number to two or three or even eight decimal places, the error is
586never apparent. However, for applications where it does matter,
587it's a lot of work to implement your own custom arithmetic routines.
588
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000589Hence, the \class{Decimal} type was created.
590
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000591\subsection{The \class{Decimal} type}
592
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000593A new module, \module{decimal}, was added to Python's standard
594library. It contains two classes, \class{Decimal} and
595\class{Context}. \class{Decimal} instances represent numbers, and
596\class{Context} instances are used to wrap up various settings such as
597the precision and default rounding mode.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000598
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000599\class{Decimal} instances are immutable, like regular Python integers
600and FP numbers; once it's been created, you can't change the value an
601instance represents. \class{Decimal} instances can be created from
602integers or strings:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000603
604\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000605>>> import decimal
606>>> decimal.Decimal(1972)
607Decimal("1972")
608>>> decimal.Decimal("1.1")
609Decimal("1.1")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000610\end{verbatim}
611
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000612You can also provide tuples containing the sign, the mantissa represented
613as a tuple of decimal digits, and the exponent:
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000614
615\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000616>>> decimal.Decimal((1, (1, 4, 7, 5), -2))
617Decimal("-14.75")
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000618\end{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000619
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000620Cautionary note: the sign bit is a Boolean value, so 0 is positive and
6211 is negative.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000622
Andrew M. Kuchlinge34c3bd2004-08-31 12:21:44 +0000623Converting from floating-point numbers poses a bit of a problem:
624should the FP number representing 1.1 turn into the decimal number for
625exactly 1.1, or for 1.1 plus whatever inaccuracies are introduced?
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000626The decision was to dodge the issue and leave such a conversion out of
627the API. Instead, you should convert the floating-point number into a
628string using the desired precision and pass the string to the
629\class{Decimal} constructor:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000630
631\begin{verbatim}
632>>> f = 1.1
633>>> decimal.Decimal(str(f))
634Decimal("1.1")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000635>>> decimal.Decimal('%.12f' % f)
636Decimal("1.100000000000")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000637\end{verbatim}
638
639Once you have \class{Decimal} instances, you can perform the usual
640mathematical operations on them. One limitation: exponentiation
641requires an integer exponent:
642
643\begin{verbatim}
644>>> a = decimal.Decimal('35.72')
645>>> b = decimal.Decimal('1.73')
646>>> a+b
647Decimal("37.45")
648>>> a-b
649Decimal("33.99")
650>>> a*b
651Decimal("61.7956")
652>>> a/b
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000653Decimal("20.64739884393063583815028902")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000654>>> a ** 2
655Decimal("1275.9184")
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000656>>> a**b
657Traceback (most recent call last):
658 ...
659decimal.InvalidOperation: x ** (non-integer)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000660\end{verbatim}
661
662You can combine \class{Decimal} instances with integers, but not with
663floating-point numbers:
664
665\begin{verbatim}
666>>> a + 4
667Decimal("39.72")
668>>> a + 4.5
669Traceback (most recent call last):
670 ...
671TypeError: You can interact Decimal only with int, long or Decimal data types.
672>>>
673\end{verbatim}
674
675\class{Decimal} numbers can be used with the \module{math} and
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000676\module{cmath} modules, but note that they'll be immediately converted to
677floating-point numbers before the operation is performed, resulting in
678a possible loss of precision and accuracy. You'll also get back a
679regular floating-point number and not a \class{Decimal}.
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000680
681\begin{verbatim}
682>>> import math, cmath
683>>> d = decimal.Decimal('123456789012.345')
684>>> math.sqrt(d)
685351364.18288201344
686>>> cmath.sqrt(-d)
687351364.18288201344j
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000688\end{verbatim}
689
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000690\class{Decimal} instances have a \method{sqrt()} method that
691returns a \class{Decimal}, but if you need other things such as
692trigonometric functions you'll have to implement them.
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000693
694\begin{verbatim}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000695>>> d.sqrt()
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000696Decimal("351364.1828820134592177245001")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000697\end{verbatim}
698
699
700\subsection{The \class{Context} type}
701
702Instances of the \class{Context} class encapsulate several settings for
703decimal operations:
704
705\begin{itemize}
706 \item \member{prec} is the precision, the number of decimal places.
707 \item \member{rounding} specifies the rounding mode. The \module{decimal}
708 module has constants for the various possibilities:
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000709 \constant{ROUND_DOWN}, \constant{ROUND_CEILING},
710 \constant{ROUND_HALF_EVEN}, and various others.
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000711 \item \member{traps} is a dictionary specifying what happens on
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000712encountering certain error conditions: either an exception is raised or
713a value is returned. Some examples of error conditions are
714division by zero, loss of precision, and overflow.
715\end{itemize}
716
717There's a thread-local default context available by calling
718\function{getcontext()}; you can change the properties of this context
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000719to alter the default precision, rounding, or trap handling. The
720following example shows the effect of changing the precision of the default
721context:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000722
723\begin{verbatim}
724>>> decimal.getcontext().prec
72528
726>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000727Decimal("0.1428571428571428571428571429")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000728>>> decimal.getcontext().prec = 9
729>>> decimal.Decimal(1) / decimal.Decimal(7)
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000730Decimal("0.142857143")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000731\end{verbatim}
732
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000733The default action for error conditions is selectable; the module can
734either return a special value such as infinity or not-a-number, or
735exceptions can be raised:
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000736
737\begin{verbatim}
738>>> decimal.Decimal(1) / decimal.Decimal(0)
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000739Traceback (most recent call last):
740 ...
741decimal.DivisionByZero: x / 0
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000742>>> decimal.getcontext().traps[decimal.DivisionByZero] = False
743>>> decimal.Decimal(1) / decimal.Decimal(0)
744Decimal("Infinity")
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000745>>>
746\end{verbatim}
747
748The \class{Context} instance also has various methods for formatting
749numbers such as \method{to_eng_string()} and \method{to_sci_string()}.
750
Andrew M. Kuchling0ad20f12004-07-21 13:00:06 +0000751For more information, see the documentation for the \module{decimal}
752module, which includes a quick-start tutorial and a reference.
753
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000754\begin{seealso}
755\seepep{327}{Decimal Data Type}{Written by Facundo Batista and implemented
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000756 by Facundo Batista, Eric Price, Raymond Hettinger, Aahz, and Tim Peters.}
757
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000758\seeurl{http://research.microsoft.com/\textasciitilde hollasch/cgindex/coding/ieeefloat.html}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000759{A more detailed overview of the IEEE-754 representation.}
760
761\seeurl{http://www.lahey.com/float.htm}
762{The article uses Fortran code to illustrate many of the problems
763that floating-point inaccuracy can cause.}
764
765\seeurl{http://www2.hursley.ibm.com/decimal/}
766{A description of a decimal-based representation. This representation
767is being proposed as a standard, and underlies the new Python decimal
768type. Much of this material was written by Mike Cowlishaw, designer of the
Raymond Hettingerca1a7752004-07-12 13:00:45 +0000769Rexx language.}
Andrew M. Kuchlingc8f8a812004-07-04 01:26:42 +0000770
Raymond Hettinger0fff62f2004-07-01 11:52:15 +0000771\end{seealso}
772
773
774%======================================================================
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000775\section{PEP 328: Multi-line Imports}
776
777One language change is a small syntactic tweak aimed at making it
778easier to import many names from a module. In a
779\code{from \var{module} import \var{names}} statement,
780\var{names} is a sequence of names separated by commas. If the sequence is
781very long, you can either write multiple imports from the same module,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000782or you can use backslashes to escape the line endings like this:
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000783
784\begin{verbatim}
785from SimpleXMLRPCServer import SimpleXMLRPCServer,\
786 SimpleXMLRPCRequestHandler,\
787 CGIXMLRPCRequestHandler,\
788 resolve_dotted_attribute
789\end{verbatim}
790
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000791The syntactic change in Python 2.4 simply allows putting the names
792within parentheses. Python ignores newlines within a parenthesized
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000793expression, so the backslashes are no longer needed:
794
795\begin{verbatim}
796from SimpleXMLRPCServer import (SimpleXMLRPCServer,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000797 SimpleXMLRPCRequestHandler,
798 CGIXMLRPCRequestHandler,
799 resolve_dotted_attribute)
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000800\end{verbatim}
801
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000802The PEP also proposes that all \keyword{import} statements be absolute
803imports, with a leading \samp{.} character to indicate a relative
804import. This part of the PEP is not yet implemented, and will have to
805wait for Python 2.5 or some other future version.
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000806
807\begin{seealso}
Fred Drake410eb842004-09-01 04:05:08 +0000808\seepep{328}{Imports: Multi-Line and Absolute/Relative}
809 {Written by Aahz. Multi-line imports were implemented by
810 Dima Dorfman.}
811\end{seealso}
Andrew M. Kuchling3294e9d2004-08-31 11:26:23 +0000812
813
814%======================================================================
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000815\section{PEP 331: Locale-Independent Float/String Conversions}
816
817The \module{locale} modules lets Python software select various
818conversions and display conventions that are localized to a particular
819country or language. However, the module was careful to not change
820the numeric locale because various functions in Python's
821implementation required that the numeric locale remain set to the
822\code{'C'} locale. Often this was because the code was using the C library's
823\cfunction{atof()} function.
824
825Not setting the numeric locale caused trouble for extensions that used
826third-party C libraries, however, because they wouldn't have the
827correct locale set. The motivating example was GTK+, whose user
828interface widgets weren't displaying numbers in the current locale.
829
830The solution described in the PEP is to add three new functions to the
831Python API that perform ASCII-only conversions, ignoring the locale
832setting:
833
834\begin{itemize}
835 \item \cfunction{PyOS_ascii_strtod(\var{str}, \var{ptr})}
836and \cfunction{PyOS_ascii_atof(\var{str}, \var{ptr})}
837both convert a string to a C \ctype{double}.
838 \item \cfunction{PyOS_ascii_formatd(\var{buffer}, \var{buf_len}, \var{format}, \var{d})} converts a \ctype{double} to an ASCII string.
839\end{itemize}
840
841The code for these functions came from the GLib library
842(\url{http://developer.gnome.org/arch/gtk/glib.html}), whose
843developers kindly relicensed the relevant functions and donated them
844to the Python Software Foundation. The \module{locale} module
845can now change the numeric locale, letting extensions such as GTK+
846produce the correct results.
847
848\begin{seealso}
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000849\seepep{331}{Locale-Independent Float/String Conversions}
850{Written by Christian R. Reis, and implemented by Gustavo Carneiro.}
Andrew M. Kuchling65a33322004-07-21 12:41:38 +0000851\end{seealso}
852
853%======================================================================
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000854\section{Other Language Changes}
855
856Here are all of the changes that Python 2.4 makes to the core Python
857language.
858
859\begin{itemize}
Raymond Hettingerd4462302003-11-26 17:52:45 +0000860
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000861\item Decorators for functions and methods were added (\pep{318}).
862
863\item Built-in \function{set} and \function{frozenset} types were
864added (\pep{218}). Other new built-ins include the \function{reversed(\var{seq})} function (\pep{322}).
865
866\item Generator expressions were added (\pep{289}).
867
868\item Certain numeric expressions no longer return values restricted to 32 or 64 bits (\pep{237}).
869
870\item You can now put parentheses around the list of names in a
871\code{from \var{module} import \var{names}} statement (\pep{328}).
872
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000873\item The \method{dict.update()} method now accepts the same
874argument forms as the \class{dict} constructor. This includes any
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +0000875mapping, any iterable of key/value pairs, and keyword arguments.
876(Contributed by Raymond Hettinger.)
Raymond Hettinger31017ae2004-03-04 08:25:44 +0000877
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000878\item The string methods \method{ljust()}, \method{rjust()}, and
Andrew M. Kuchling67087562003-11-26 18:03:48 +0000879\method{center()} now take an optional argument for specifying a
Raymond Hettingerd4462302003-11-26 17:52:45 +0000880fill character other than a space.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +0000881(Contributed by Raymond Hettinger.)
Raymond Hettingerd4462302003-11-26 17:52:45 +0000882
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000883\item Strings also gained an \method{rsplit()} method that
Raymond Hettingered54d912003-12-31 01:59:18 +0000884works like the \method{split()} method but splits from the end of
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +0000885the string.
Andrew M. Kuchlingb69c49c2004-12-01 00:42:41 +0000886(Contributed by Sean Reifschneider.)
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +0000887
888\begin{verbatim}
Raymond Hettinger7a6d2972004-02-13 19:00:07 +0000889>>> 'www.python.org'.split('.', 1)
890['www', 'python.org']
891'www.python.org'.rsplit('.', 1)
892['www.python', 'org']
893\end{verbatim}
Raymond Hettinger97ef8de2004-01-05 00:29:57 +0000894
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000895\item Three keyword parameters, \var{cmp}, \var{key}, and
896\var{reverse}, were added to the \method{sort()} method of lists.
897These parameters make some common usages of \method{sort()} simpler.
898All of these parameters are optional.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000899
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000900For the \var{cmp} parameter, the value should be a comparison function
901that takes two parameters and returns -1, 0, or +1 depending on how
902the parameters compare. This function will then be used to sort the
903list. Previously this was the only parameter that could be provided
904to \method{sort()}.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000905
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000906\var{key} should be a single-parameter function that takes a list
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000907element and returns a comparison key for the element. The list is
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000908then sorted using the comparison keys. The following example sorts a
909list case-insensitively:
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000910
911\begin{verbatim}
912>>> L = ['A', 'b', 'c', 'D']
913>>> L.sort() # Case-sensitive sort
914>>> L
915['A', 'D', 'b', 'c']
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000916>>> # Using 'key' parameter to sort list
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000917>>> L.sort(key=lambda x: x.lower())
918>>> L
919['A', 'b', 'c', 'D']
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000920>>> # Old-fashioned way
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000921>>> L.sort(cmp=lambda x,y: cmp(x.lower(), y.lower()))
922>>> L
923['A', 'b', 'c', 'D']
924\end{verbatim}
925
926The last example, which uses the \var{cmp} parameter, is the old way
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000927to perform a case-insensitive sort. It works but is slower than using
928a \var{key} parameter. Using \var{key} calls \method{lower()} method
929once for each element in the list while using \var{cmp} will call it
930twice for each comparison, so using \var{key} saves on invocations of
931the \method{lower()} method.
Andrew M. Kuchling2fb4d512003-10-21 12:31:16 +0000932
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000933For simple key functions and comparison functions, it is often
934possible to avoid a \keyword{lambda} expression by using an unbound
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000935method instead. For example, the above case-insensitive sort is best
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000936written as:
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000937
938\begin{verbatim}
939>>> L.sort(key=str.lower)
940>>> L
941['A', 'b', 'c', 'D']
942\end{verbatim}
943
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000944Finally, the \var{reverse} parameter takes a Boolean value. If the
945value is true, the list will be sorted into reverse order.
946Instead of \code{L.sort() ; L.reverse()}, you can now write
947\code{L.sort(reverse=True)}.
Fred Drakeed0fa3d2003-07-30 19:14:09 +0000948
Andrew M. Kuchling981a9182003-11-13 21:33:26 +0000949The results of sorting are now guaranteed to be stable. This means
950that two entries with equal keys will be returned in the same order as
951they were input. For example, you can sort a list of people by name,
952and then sort the list by age, resulting in a list sorted by age where
953people with the same age are in name-sorted order.
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000954
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +0000955(All changes to \method{sort()} contributed by Raymond Hettinger.)
956
Fred Drake56fcc232004-05-06 02:55:35 +0000957\item There is a new built-in function
958\function{sorted(\var{iterable})} that works like the in-place
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +0000959\method{list.sort()} method but can be used in
Fred Drake56fcc232004-05-06 02:55:35 +0000960expressions. The differences are:
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000961 \begin{itemize}
Raymond Hettinger7d1dd042003-11-12 16:42:10 +0000962 \item the input may be any iterable;
963 \item a newly formed copy is sorted, leaving the original intact; and
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000964 \item the expression returns the new sorted copy
965 \end{itemize}
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000966
967\begin{verbatim}
968>>> L = [9,7,8,3,2,4,1,6,5]
Raymond Hettinger64958a12003-12-17 20:43:33 +0000969>>> [10+i for i in sorted(L)] # usable in a list comprehension
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000970[11, 12, 13, 14, 15, 16, 17, 18, 19]
Hye-Shik Chang2b052482004-07-17 13:53:48 +0000971>>> L # original is left unchanged
Andrew M. Kuchlinge3e1eca2004-07-26 18:52:48 +0000972[9,7,8,3,2,4,1,6,5]
973>>> sorted('Monty Python') # any iterable may be an input
974[' ', 'M', 'P', 'h', 'n', 'n', 'o', 'o', 't', 't', 'y', 'y']
Raymond Hettingerd4462302003-11-26 17:52:45 +0000975
976>>> # List the contents of a dict sorted by key values
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000977>>> colormap = dict(red=1, blue=2, green=3, black=4, yellow=5)
Raymond Hettinger64958a12003-12-17 20:43:33 +0000978>>> for k, v in sorted(colormap.iteritems()):
Raymond Hettinger607c00f2003-11-12 16:27:50 +0000979... print k, v
980...
981black 4
982blue 2
983green 3
984red 1
985yellow 5
Andrew M. Kuchling1a420252003-11-08 15:58:49 +0000986\end{verbatim}
987
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +0000988(Contributed by Raymond Hettinger.)
989
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +0000990\item Integer operations will no longer trigger an \exception{OverflowWarning}.
991The \exception{OverflowWarning} warning will disappear in Python 2.5.
992
Andrew M. Kuchling5e3f9232004-10-07 12:00:33 +0000993\item The interpreter gained a new switch, \programopt{-m}, that
994takes a name, searches for the corresponding module on \code{sys.path},
995and runs the module as a script. For example,
996you can now run the Python profiler with \code{python -m profile}.
997(Contributed by Nick Coghlan.)
998
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +0000999\item The \function{eval(\var{expr}, \var{globals}, \var{locals})}
Andrew M. Kuchling1455f792004-08-02 12:09:58 +00001000and \function{execfile(\var{filename}, \var{globals}, \var{locals})}
1001functions and the \keyword{exec} statement now accept any mapping type
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001002for the \var{locals} parameter. Previously this had to be a regular
Andrew M. Kuchling1455f792004-08-02 12:09:58 +00001003Python dictionary. (Contributed by Raymond Hettinger.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001004
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001005\item The \function{zip()} built-in function and \function{itertools.izip()}
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001006 now return an empty list if called with no arguments.
1007 Previously they raised a \exception{TypeError}
1008 exception. This makes them more
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001009 suitable for use with variable length argument lists:
1010
1011\begin{verbatim}
1012>>> def transpose(array):
1013... return zip(*array)
1014...
1015>>> transpose([(1,2,3), (4,5,6)])
1016[(1, 4), (2, 5), (3, 6)]
1017>>> transpose([])
1018[]
1019\end{verbatim}
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001020(Contributed by Raymond Hettinger.)
1021
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +00001022\item Encountering a failure while importing a module no longer leaves
1023a partially-initialized module object in \code{sys.modules}. The
1024incomplete module object left behind would fool further imports of the
1025same module into succeeding, leading to confusing errors.
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001026(Fixed by Tim Peters.)
Andrew M. Kuchlingd91fcbe2004-08-02 12:44:28 +00001027
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001028\item \constant{None} is now a constant; code that binds a new value to
1029the name \samp{None} is now a syntax error.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001030(Contributed by Raymond Hettinger.)
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001031
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001032\end{itemize}
1033
1034
1035%======================================================================
1036\subsection{Optimizations}
1037
1038\begin{itemize}
1039
Raymond Hettingerca1a7752004-07-12 13:00:45 +00001040\item The inner loops for list and tuple slicing
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001041 were optimized and now run about one-third faster. The inner loops
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001042 for dictionaries were also optimized , resulting in performance boosts for
Andrew M. Kuchling65a33322004-07-21 12:41:38 +00001043 \method{keys()}, \method{values()}, \method{items()},
1044 \method{iterkeys()}, \method{itervalues()}, and \method{iteritems()}.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001045 (Contributed by Raymond Hettinger.)
Raymond Hettingerb7d05db2004-03-08 07:25:05 +00001046
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001047\item The machinery for growing and shrinking lists was optimized for
1048 speed and for space efficiency. Appending and popping from lists now
1049 runs faster due to more efficient code paths and less frequent use of
1050 the underlying system \cfunction{realloc()}. List comprehensions
1051 also benefit. \method{list.extend()} was also optimized and no
1052 longer converts its argument into a temporary list before extending
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001053 the base list. (Contributed by Raymond Hettinger.)
Raymond Hettinger7a6d2972004-02-13 19:00:07 +00001054
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001055\item \function{list()}, \function{tuple()}, \function{map()},
1056 \function{filter()}, and \function{zip()} now run several times
1057 faster with non-sequence arguments that supply a \method{__len__()}
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001058 method. (Contributed by Raymond Hettinger.)
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001059
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +00001060\item The methods \method{list.__getitem__()},
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001061 \method{dict.__getitem__()}, and \method{dict.__contains__()} are
1062 are now implemented as \class{method_descriptor} objects rather
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001063 than \class{wrapper_descriptor} objects. This form of
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001064 access doubles their performance and makes them more suitable for
Raymond Hettinger23a0f4e2004-01-05 08:15:20 +00001065 use as arguments to functionals:
1066 \samp{map(mydict.__getitem__, keylist)}.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001067 (Contributed by Raymond Hettinger.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001068
Fred Draked6d35d92004-06-03 13:31:22 +00001069\item Added a new opcode, \code{LIST_APPEND}, that simplifies
Raymond Hettingerdd80f762004-03-07 07:31:06 +00001070 the generated bytecode for list comprehensions and speeds them up
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001071 by about a third. (Contributed by Raymond Hettinger.)
Raymond Hettingerdd80f762004-03-07 07:31:06 +00001072
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001073\item The peephole bytecode optimizer has been improved to
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001074produce shorter, faster bytecode; remarkably, the resulting bytecode is
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001075more readable. (Enhanced by Raymond Hettinger.)
1076
Andrew M. Kuchlingac642872004-08-07 13:13:31 +00001077\item String concatenations in statements of the form \code{s = s +
1078"abc"} and \code{s += "abc"} are now performed more efficiently in
1079certain circumstances. This optimization won't be present in other
1080Python implementations such as Jython, so you shouldn't rely on it;
1081using the \method{join()} method of strings is still recommended when
1082you want to efficiently glue a large number of strings together.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001083(Contributed by Armin Rigo.)
Andrew M. Kuchlingac642872004-08-07 13:13:31 +00001084
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001085\end{itemize}
1086
Raymond Hettingerb2d5a8e2004-11-18 05:51:53 +00001087% pystone is almost useless for comparing different versions of Python;
1088% instead, it excels at predicting relative Python performance on
1089% different machines.
1090% So, this section would be more informative if it used other tools
1091% such as pybench and parrotbench. For a more application oriented
1092% benchmark, try comparing the timings of test_decimal.py under 2.3
1093% and 2.4.
1094
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001095The net result of the 2.4 optimizations is that Python 2.4 runs the
Andrew M. Kuchlingbae8f372004-11-19 14:55:28 +00001096pystone benchmark around 5\% faster than Python 2.3 and 35\% faster
1097than Python 2.2. (pystone is not a particularly good benchmark, but
1098it's the most commonly used measurement of Python's performance. Your
1099own applications may show greater or smaller benefits from Python~2.4.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001100
1101
1102%======================================================================
1103\section{New, Improved, and Deprecated Modules}
1104
1105As usual, Python's standard library received a number of enhancements and
1106bug fixes. Here's a partial list of the most notable changes, sorted
1107alphabetically by module name. Consult the
1108\file{Misc/NEWS} file in the source tree for a more
1109complete list of changes, or look through the CVS logs for all the
1110details.
1111
1112\begin{itemize}
1113
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001114\item The \module{asyncore} module's \function{loop()} function now
1115 has a \var{count} parameter that lets you perform a limited number
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001116 of passes through the polling loop. The default is still to loop
1117 forever.
1118
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001119\item The \module{base64} module now has more complete RFC 3548 support
1120 for Base64, Base32, and Base16 encoding and decoding, including
1121 optional case folding and optional alternative alphabets.
1122 (Contributed by Barry Warsaw.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001123
Raymond Hettinger0c410272004-01-05 10:13:35 +00001124\item The \module{bisect} module now has an underlying C implementation
1125 for improved performance.
1126 (Contributed by Dmitry Vasiliev.)
1127
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001128\item The CJKCodecs collections of East Asian codecs, maintained
1129by Hye-Shik Chang, was integrated into 2.4.
1130The new encodings are:
1131
1132\begin{itemize}
Andrew M. Kuchling671c5062004-07-28 15:29:39 +00001133 \item Chinese (PRC): gb2312, gbk, gb18030, big5hkscs, hz
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001134 \item Chinese (ROC): big5, cp950
Andrew M. Kuchling671c5062004-07-28 15:29:39 +00001135 \item Japanese: cp932, euc-jis-2004, euc-jp,
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001136euc-jisx0213, iso-2022-jp, iso-2022-jp-1, iso-2022-jp-2,
Andrew M. Kuchling671c5062004-07-28 15:29:39 +00001137 iso-2022-jp-3, iso-2022-jp-ext, iso-2022-jp-2004,
1138 shift-jis, shift-jisx0213, shift-jis-2004
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001139 \item Korean: cp949, euc-kr, johab, iso-2022-kr
1140\end{itemize}
1141
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001142\item Some other new encodings were added: HP Roman8,
1143ISO_8859-11, ISO_8859-16, PCTP-154, and TIS-620.
1144
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001145\item The UTF-8 and UTF-16 codecs now cope better with receiving partial input.
1146Previously the \class{StreamReader} class would try to read more data,
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001147making it impossible to resume decoding from the stream. The
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001148\method{read()} method will now return as much data as it can and future
1149calls will resume decoding where previous ones left off.
1150(Implemented by Walter D\"orwald.)
1151
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +00001152\item There is a new \module{collections} module for
1153 various specialized collection datatypes.
1154 Currently it contains just one type, \class{deque},
1155 a double-ended queue that supports efficiently adding and removing
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001156 elements from either end:
Raymond Hettinger756b3f32004-01-29 06:37:52 +00001157
1158\begin{verbatim}
1159>>> from collections import deque
1160>>> d = deque('ghi') # make a new deque with three items
1161>>> d.append('j') # add a new entry to the right side
1162>>> d.appendleft('f') # add a new entry to the left side
1163>>> d # show the representation of the deque
1164deque(['f', 'g', 'h', 'i', 'j'])
1165>>> d.pop() # return and remove the rightmost item
1166'j'
1167>>> d.popleft() # return and remove the leftmost item
1168'f'
1169>>> list(d) # list the contents of the deque
1170['g', 'h', 'i']
1171>>> 'h' in d # search the deque
1172True
1173\end{verbatim}
1174
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001175Several modules, such as the \module{Queue} and \module{threading}
1176modules, now take advantage of \class{collections.deque} for improved
1177performance. (Contributed by Raymond Hettinger.)
Andrew M. Kuchling5303a962004-01-18 15:55:51 +00001178
Fred Drake9f15b5c2004-05-18 04:30:00 +00001179\item The \module{ConfigParser} classes have been enhanced slightly.
1180 The \method{read()} method now returns a list of the files that
1181 were successfully parsed, and the \method{set()} method raises
1182 \exception{TypeError} if passed a \var{value} argument that isn't a
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001183 string. (Contributed by John Belmonte and David Goodger.)
Fred Drake9f15b5c2004-05-18 04:30:00 +00001184
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001185\item The \module{curses} module now supports the ncurses extension
1186 \function{use_default_colors()}. On platforms where the terminal
1187 supports transparency, this makes it possible to use a transparent
1188 background. (Contributed by J\"org Lehmann.)
1189
1190\item The \module{difflib} module now includes an \class{HtmlDiff} class
1191that creates an HTML table showing a side by side comparison
1192of two versions of a text. (Contributed by Dan Gass.)
1193
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001194\item The \module{email} package was updated to version 3.0,
1195which dropped various deprecated APIs and removes support for Python
1196versions earlier than 2.3. The 3.0 version of the package uses a new
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001197incremental parser for MIME messages, available in the
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001198\module{email.FeedParser} module. The new parser doesn't require
1199reading the entire message into memory, and doesn't throw exceptions
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001200if a message is malformed; instead it records any problems in the
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001201\member{defect} attribute of the message. (Developed by Anthony
1202Baxter, Barry Warsaw, Thomas Wouters, and others.)
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001203
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001204\item The \module{heapq} module has been converted to C. The resulting
Andrew M. Kuchlingfd0e4942004-02-09 13:23:34 +00001205 tenfold improvement in speed makes the module suitable for handling
Raymond Hettinger33ecffb2004-06-10 05:03:17 +00001206 high volumes of data. In addition, the module has two new functions
1207 \function{nlargest()} and \function{nsmallest()} that use heaps to
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001208 find the N largest or smallest values in a dataset without the
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001209 expense of a full sort. (Contributed by Raymond Hettinger.)
Andrew M. Kuchling1a420252003-11-08 15:58:49 +00001210
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001211\item The \module{httplib} module now contains constants for HTTP
1212status codes defined in various HTTP-related RFC documents. Constants
1213have names such as \constant{OK}, \constant{CREATED},
1214\constant{CONTINUE}, and \constant{MOVED_PERMANENTLY}; use pydoc to
1215get a full list. (Contributed by Andrew Eland.)
1216
Andrew M. Kuchlingce4bae62004-07-27 12:13:25 +00001217\item The \module{imaplib} module now supports IMAP's THREAD command
1218(contributed by Yves Dionne) and new \method{deleteacl()} and
1219\method{myrights()} methods (contributed by Arnaud Mazin).
Andrew M. Kuchlingdff9dbd2003-11-20 22:22:19 +00001220
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001221\item The \module{itertools} module gained a
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001222 \function{groupby(\var{iterable}\optional{, \var{func}})} function.
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001223 \var{iterable} is something that can be iterated over to return a
1224 stream of elements, and the optional \var{func} parameter is a
1225 function that takes an element and returns a key value; if omitted,
1226 the key is simply the element itself. \function{groupby()} then
1227 groups the elements into subsequences which have matching values of
1228 the key, and returns a series of 2-tuples containing the key value
1229 and an iterator over the subsequence.
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001230
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001231Here's an example to make this clearer. The \var{key} function simply
1232returns whether a number is even or odd, so the result of
1233\function{groupby()} is to return consecutive runs of odd or even
1234numbers.
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001235
1236\begin{verbatim}
1237>>> import itertools
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001238>>> L = [2, 4, 6, 7, 8, 9, 11, 12, 14]
Andrew M. Kuchlingad809552003-12-06 23:19:23 +00001239>>> for key_val, it in itertools.groupby(L, lambda x: x % 2):
1240... print key_val, list(it)
1241...
12420 [2, 4, 6]
12431 [7]
12440 [8]
12451 [9, 11]
12460 [12, 14]
1247>>>
1248\end{verbatim}
1249
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001250\function{groupby()} is typically used with sorted input. The logic
1251for \function{groupby()} is similar to the \UNIX{} \code{uniq} filter
1252which makes it handy for eliminating, counting, or identifying
1253duplicate elements:
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001254
1255\begin{verbatim}
1256>>> word = 'abracadabra'
Raymond Hettingered54d912003-12-31 01:59:18 +00001257>>> letters = sorted(word) # Turn string into a sorted list of letters
Raymond Hettinger64958a12003-12-17 20:43:33 +00001258>>> letters
Andrew M. Kuchling4612bc52003-12-16 20:59:37 +00001259['a', 'a', 'a', 'a', 'a', 'b', 'b', 'c', 'd', 'r', 'r']
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001260>>> for k, g in itertools.groupby(letters):
1261... print k, list(g)
1262...
1263a ['a', 'a', 'a', 'a', 'a']
1264b ['b', 'b']
1265c ['c']
1266d ['d']
1267r ['r', 'r']
1268>>> # List unique letters
1269>>> [k for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001270['a', 'b', 'c', 'd', 'r']
Johannes Gijsbersd3452252004-09-11 16:50:06 +00001271>>> # Count letter occurrences
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001272>>> [(k, len(list(g))) for k, g in groupby(letters)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001273[('a', 5), ('b', 2), ('c', 1), ('d', 1), ('r', 2)]
Raymond Hettingerfeb78c92003-12-12 13:13:47 +00001274\end{verbatim}
1275
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001276(Contributed by Hye-Shik Chang.)
1277
Raymond Hettingered54d912003-12-31 01:59:18 +00001278\item \module{itertools} also gained a function named
1279\function{tee(\var{iterator}, \var{N})} that returns \var{N} independent
1280iterators that replicate \var{iterator}. If \var{N} is omitted, the
1281default is 2.
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001282
1283\begin{verbatim}
1284>>> L = [1,2,3]
1285>>> i1, i2 = itertools.tee(L)
1286>>> i1,i2
1287(<itertools.tee object at 0x402c2080>, <itertools.tee object at 0x402c2090>)
Raymond Hettingered54d912003-12-31 01:59:18 +00001288>>> list(i1) # Run the first iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001289[1, 2, 3]
Raymond Hettingered54d912003-12-31 01:59:18 +00001290>>> list(i2) # Run the second iterator to exhaustion
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001291[1, 2, 3]
1292>\end{verbatim}
1293
1294Note that \function{tee()} has to keep copies of the values returned
Raymond Hettingered54d912003-12-31 01:59:18 +00001295by the iterator; in the worst case, it may need to keep all of them.
Andrew M. Kuchling44a31e12004-01-01 18:33:34 +00001296This should therefore be used carefully if the leading iterator
Raymond Hettingered54d912003-12-31 01:59:18 +00001297can run far ahead of the trailing iterator in a long stream of inputs.
Andrew M. Kuchling3bf85f12004-07-05 01:37:07 +00001298If the separation is large, then you might as well use
Raymond Hettingered54d912003-12-31 01:59:18 +00001299\function{list()} instead. When the iterators track closely with one
1300another, \function{tee()} is ideal. Possible applications include
1301bookmarking, windowing, or lookahead iterators.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001302(Contributed by Raymond Hettinger.)
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001303
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001304\item A number of functions were added to the \module{locale}
1305module, such as \function{bind_textdomain_codeset()} to specify a
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001306particular encoding and a family of \function{l*gettext()} functions
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001307that return messages in the chosen encoding.
1308(Contributed by Gustavo Niemeyer.)
1309
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001310\item Some keyword arguments were added to the \module{logging}
1311package's \function{basicConfig} function to simplify log
1312configuration. The default behavior is to log messages to standard
1313error, but various keyword arguments can be specified to log to a
1314particular file, change the logging format, or set the logging level.
1315For example:
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001316
1317\begin{verbatim}
1318import logging
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001319logging.basicConfig(filename='/var/log/application.log',
1320 level=0, # Log all messages
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001321 format='%(levelname):%(process):%(thread):%(message)')
1322\end{verbatim}
1323
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001324Other additions to the \module{logging} package include a
1325\method{log(\var{level}, \var{msg})} convenience method, as well as a
1326\class{TimedRotatingFileHandler} class that rotates its log files at a
1327timed interval. The module already had \class{RotatingFileHandler},
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001328which rotated logs once the file exceeded a certain size. Both
1329classes derive from a new \class{BaseRotatingHandler} class that can
1330be used to implement other rotating handlers.
1331
Andrew M. Kuchling579b3e22004-10-05 20:23:34 +00001332(Changes implemented by Vinay Sajip.)
1333
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001334\item The \module{marshal} module now shares interned strings on unpacking a
1335data structure. This may shrink the size of certain pickle strings,
1336but the primary effect is to make \file{.pyc} files significantly smaller.
1337(Contributed by Martin von Loewis.)
1338
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001339\item The \module{nntplib} module's \class{NNTP} class gained
1340\method{description()} and \method{descriptions()} methods to retrieve
1341newsgroup descriptions for a single group or for a range of groups.
1342(Contributed by J\"urgen A. Erhard.)
1343
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001344\item Two new functions were added to the \module{operator} module,
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001345\function{attrgetter(\var{attr})} and \function{itemgetter(\var{index})}.
1346Both functions return callables that take a single argument and return
Raymond Hettingered54d912003-12-31 01:59:18 +00001347the corresponding attribute or item; these callables make excellent
Andrew M. Kuchlingbcefe692004-07-07 13:01:53 +00001348data extractors when used with \function{map()} or
1349\function{sorted()}. For example:
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001350
1351\begin{verbatim}
Raymond Hettingered54d912003-12-31 01:59:18 +00001352>>> L = [('c', 2), ('d', 1), ('a', 4), ('b', 3)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001353>>> map(operator.itemgetter(0), L)
1354['c', 'd', 'a', 'b']
1355>>> map(operator.itemgetter(1), L)
Raymond Hettingered54d912003-12-31 01:59:18 +00001356[2, 1, 4, 3]
1357>>> sorted(L, key=operator.itemgetter(1)) # Sort list by second tuple item
1358[('d', 1), ('c', 2), ('b', 3), ('a', 4)]
Andrew M. Kuchling35f2b052003-12-18 13:28:13 +00001359\end{verbatim}
1360
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001361(Contributed by Raymond Hettinger.)
1362
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001363\item The \module{optparse} module was updated in various ways. The
1364module now passes its messages through \function{gettext.gettext()},
1365making it possible to internationalize Optik's help and error
1366messages. Help messages for options can now include the string
1367\code{'\%default'}, which will be replaced by the option's default
1368value. (Contributed by Greg Ward.)
Andrew M. Kuchlinge30c4d42004-08-07 13:58:02 +00001369
Andrew M. Kuchlingf3958f12004-10-11 19:20:06 +00001370\item The long-term plan is to deprecate the \module{rfc822} module
1371in some future Python release in favor of the \module{email} package.
1372To this end, the \function{email.Utils.formatdate()} function has been
1373changed to make it usable as a replacement for
1374\function{rfc822.formatdate()}. You may want to write new e-mail
1375processing code with this in mind. (Change implemented by Anthony
1376Baxter.)
1377
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001378\item A new \function{urandom(\var{n})} function was added to the
1379\module{os} module, returning a string containing \var{n} bytes of
1380random data. This function provides access to platform-specific
1381sources of randomness such as \file{/dev/urandom} on Linux or the
1382Windows CryptoAPI. (Contributed by Trevor Perrin.)
Andrew M. Kuchlingcb7b3f32004-08-30 11:58:04 +00001383
1384\item Another new function: \function{os.path.lexists(\var{path})}
1385returns true if the file specified by \var{path} exists, whether or
1386not it's a symbolic link. This differs from the existing
1387\function{os.path.exists(\var{path})} function, which returns false if
1388\var{path} is a symlink that points to a destination that doesn't exist.
1389(Contributed by Beni Cherniavsky.)
1390
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001391\item A new \function{getsid()} function was added to the
1392\module{posix} module that underlies the \module{os} module.
1393(Contributed by J. Raynor.)
1394
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001395\item The \module{poplib} module now supports POP over SSL. (Contributed by
1396Hector Urtubia.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001397
1398\item The \module{profile} module can now profile C extension functions.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001399(Contributed by Nick Bastin.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001400
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001401\item The \module{random} module has a new method called
1402 \method{getrandbits(\var{N})} that returns a long integer \var{N}
1403 bits in length. The existing \method{randrange()} method now uses
1404 \method{getrandbits()} where appropriate, making generation of
1405 arbitrarily large random numbers more efficient. (Contributed by
1406 Raymond Hettinger.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001407
1408\item The regular expression language accepted by the \module{re} module
1409 was extended with simple conditional expressions, written as
Andrew M. Kuchlingab778222004-08-31 12:07:43 +00001410 \regexp{(?(\var{group})\var{A}|\var{B})}. \var{group} is either a
1411 numeric group ID or a group name defined with \regexp{(?P<group>...)}
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001412 earlier in the expression. If the specified group matched, the
1413 regular expression pattern \var{A} will be tested against the string; if
1414 the group didn't match, the pattern \var{B} will be used instead.
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001415 (Contributed by Gustavo Niemeyer.)
Raymond Hettinger874ebd52004-05-31 03:15:02 +00001416
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001417\item The \module{re} module is also no longer recursive, thanks to a
1418massive amount of work by Gustavo Niemeyer. In a recursive regular
1419expression engine, certain patterns result in a large amount of C
1420stack space being consumed, and it was possible to overflow the stack.
1421For example, if you matched a 30000-byte string of \samp{a} characters
1422against the expression \regexp{(a|b)+}, one stack frame was consumed
1423per character. Python 2.3 tried to check for stack overflow and raise
1424a \exception{RuntimeError} exception, but certain patterns could
1425sidestep the checking and if you were unlucky Python could segfault.
1426Python 2.4's regular expression engine can match this pattern without
1427problems.
Andrew M. Kuchlingab778222004-08-31 12:07:43 +00001428
Andrew M. Kuchling3805fe72004-12-01 00:57:12 +00001429\item Two new functions were added to the \module{socket} module.
1430\function{socketpair()} returns a pair of connected sockets and
1431\function{getservbyport(\var{port})} looks up the service name for a
1432given port number. (Contributed by Dave Cole and Barry Warsaw.)
Andrew M. Kuchling7f203b82004-08-09 14:48:28 +00001433
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001434\item The \function{sys.exitfunc()} function has been deprecated. Code
1435should be using the existing \module{atexit} module, which correctly
1436handles calling multiple exit functions. Eventually
1437\function{sys.exitfunc()} will become a purely internal interface,
1438accessed only by \module{atexit}.
1439
1440\item The \module{tarfile} module now generates GNU-format tar files
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001441by default. (Contributed by Lars Gustaebel.)
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001442
Andrew M. Kuchling00457172004-07-15 11:52:40 +00001443\item The \module{threading} module now has an elegantly simple way to support
1444thread-local data. The module contains a \class{local} class whose
1445attribute values are local to different threads.
1446
1447\begin{verbatim}
1448import threading
1449
1450data = threading.local()
1451data.number = 42
1452data.url = ('www.python.org', 80)
1453\end{verbatim}
1454
1455Other threads can assign and retrieve their own values for the
1456\member{number} and \member{url} attributes. You can subclass
1457\class{local} to initialize attributes or to add methods.
1458(Contributed by Jim Fulton.)
1459
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001460\item The \module{timeit} module now automatically disables periodic
1461 garbarge collection during the timing loop. This change makes
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001462 consecutive timings more comparable. (Contributed by Raymond Hettinger.)
Andrew M. Kuchlinga331e862004-09-10 13:05:22 +00001463
Raymond Hettinger874ebd52004-05-31 03:15:02 +00001464\item The \module{weakref} module now supports a wider variety of objects
1465 including Python functions, class instances, sets, frozensets, deques,
1466 arrays, files, sockets, and regular expression pattern objects.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001467 (Contributed by Raymond Hettinger.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001468
1469\item The \module{xmlrpclib} module now supports a multi-call extension for
Andrew M. Kuchling00457172004-07-15 11:52:40 +00001470transmitting multiple XML-RPC calls in a single HTTP operation.
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001471(Contributed by Brian Quinlan.)
Andrew M. Kuchling3d3db962004-08-31 13:57:02 +00001472
1473\item The \module{mpz}, \module{rotor}, and \module{xreadlines} modules have
1474been removed.
Andrew M. Kuchling69f31eb2003-08-13 23:11:04 +00001475
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001476\end{itemize}
1477
1478
1479%======================================================================
Raymond Hettingerca1a7752004-07-12 13:00:45 +00001480% whole new modules get described in subsections here
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001481
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001482%=====================
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001483\subsection{cookielib}
1484
1485The \module{cookielib} library supports client-side handling for HTTP
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001486cookies, mirroring the \module{Cookie} module's server-side cookie
1487support. Cookies are stored in cookie jars; the library transparently
1488stores cookies offered by the web server in the cookie jar, and
1489fetches the cookie from the jar when connecting to the server. As in
1490web browsers, policy objects control whether cookies are accepted or
1491not.
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001492
1493In order to store cookies across sessions, two implementations of
1494cookie jars are provided: one that stores cookies in the Netscape
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001495format so applications can use the Mozilla or Lynx cookie files, and
Martin v. Löwis2a6ba902004-05-31 18:22:40 +00001496one that stores cookies in the same format as the Perl libwww libary.
1497
1498\module{urllib2} has been changed to interact with \module{cookielib}:
1499\class{HTTPCookieProcessor} manages a cookie jar that is used when
1500accessing URLs.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001501
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001502This module was contributed by John J. Lee.
1503
1504
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001505% ==================
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001506\subsection{doctest}
1507
1508The \module{doctest} module underwent considerable refactoring thanks
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001509to Edward Loper and Tim Peters. Testing can still be as simple as
1510running \function{doctest.testmod()}, but the refactorings allow
1511customizing the module's operation in various ways
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001512
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001513The new \class{DocTestFinder} class extracts the tests from a given
1514object's docstrings:
1515
1516\begin{verbatim}
1517def f (x, y):
1518 """>>> f(2,2)
15194
1520>>> f(3,2)
15216
1522 """
1523 return x*y
1524
1525finder = doctest.DocTestFinder()
1526
1527# Get list of DocTest instances
1528tests = finder.find(f)
1529\end{verbatim}
1530
1531The new \class{DocTestRunner} class then runs individual tests and can
1532produce a summary of the results:
1533
1534\begin{verbatim}
1535runner = doctest.DocTestRunner()
1536for t in tests:
1537 tried, failed = runner.run(t)
1538
1539runner.summarize(verbose=1)
1540\end{verbatim}
1541
1542The above example produces the following output:
1543
1544\begin{verbatim}
15451 items passed all tests:
1546 2 tests in f
15472 tests in 1 items.
15482 passed and 0 failed.
1549Test passed.
1550\end{verbatim}
1551
1552\class{DocTestRunner} uses an instance of the \class{OutputChecker}
1553class to compare the expected output with the actual output. This
1554class takes a number of different flags that customize its behaviour;
1555ambitious users can also write a completely new subclass of
1556\class{OutputChecker}.
1557
1558The default output checker provides a number of handy features.
1559For example, with the \constant{doctest.ELLIPSIS} option flag,
1560an ellipsis (\samp{...}) in the expected output matches any substring,
1561making it easier to accommodate outputs that vary in minor ways:
1562
1563\begin{verbatim}
1564def o (n):
1565 """>>> o(1)
1566<__main__.C instance at 0x...>
1567>>>
1568"""
1569\end{verbatim}
1570
1571Another special string, \samp{<BLANKLINE>}, matches a blank line:
1572
1573\begin{verbatim}
1574def p (n):
1575 """>>> p(1)
1576<BLANKLINE>
1577>>>
1578"""
1579\end{verbatim}
1580
1581Another new capability is producing a diff-style display of the output
1582by specifying the \constant{doctest.REPORT_UDIFF} (unified diffs),
1583\constant{doctest.REPORT_CDIFF} (context diffs), or
1584\constant{doctest.REPORT_NDIFF} (delta-style) option flags. For example:
1585
1586\begin{verbatim}
1587def g (n):
1588 """>>> g(4)
1589here
1590is
1591a
1592lengthy
1593>>>"""
1594 L = 'here is a rather lengthy list of words'.split()
1595 for word in L[:n]:
1596 print word
1597\end{verbatim}
1598
1599Running the above function's tests with
1600\constant{doctest.REPORT_UDIFF} specified, you get the following output:
1601
1602\begin{verbatim}
1603**********************************************************************
1604File ``t.py'', line 15, in g
1605Failed example:
1606 g(4)
1607Differences (unified diff with -expected +actual):
1608 @@ -2,3 +2,3 @@
1609 is
1610 a
1611 -lengthy
1612 +rather
1613**********************************************************************
1614\end{verbatim}
1615
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001616
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001617% ======================================================================
1618\section{Build and C API Changes}
1619
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001620Some of the changes to Python's build process and to the C API are:
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001621
1622\begin{itemize}
1623
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001624 \item Three new convenience macros were added for common return
1625 values from extension functions: \csimplemacro{Py_RETURN_NONE},
1626 \csimplemacro{Py_RETURN_TRUE}, and \csimplemacro{Py_RETURN_FALSE}.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001627 (Contributed by Brett Cannon.)
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001628
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001629 \item Another new macro, \csimplemacro{Py_CLEAR(\var{obj})},
1630 decreases the reference count of \var{obj} and sets \var{obj} to the
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001631 null pointer. (Contributed by Jim Fulton.)
Andrew M. Kuchling5785a132004-07-26 19:28:46 +00001632
Fred Drakece3caf22004-02-12 18:13:12 +00001633 \item A new function, \cfunction{PyTuple_Pack(\var{N}, \var{obj1},
1634 \var{obj2}, ..., \var{objN})}, constructs tuples from a variable
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001635 length argument list of Python objects. (Contributed by Raymond Hettinger.)
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001636
Fred Drakece3caf22004-02-12 18:13:12 +00001637 \item A new function, \cfunction{PyDict_Contains(\var{d}, \var{k})},
1638 implements fast dictionary lookups without masking exceptions raised
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001639 during the look-up process. (Contributed by Raymond Hettinger.)
Raymond Hettingerd4462302003-11-26 17:52:45 +00001640
Andrew M. Kuchling0c789562004-09-23 20:15:41 +00001641 \item The \csimplemacro{Py_IS_NAN(\var{X})} macro returns 1 if
1642 its float or double argument \var{X} is a NaN.
1643 (Contributed by Tim Peters.)
1644
Andrew M. Kuchlingf3958f12004-10-11 19:20:06 +00001645 \item C code can avoid unnecessary locking by using the new
1646 \cfunction{PyEval_ThreadsInitialized()} function to tell
1647 if any thread operations have been performed. If this function
1648 returns false, no lock operations are needed.
1649 (Contributed by Nick Coghlan.)
1650
Andrew M. Kuchlinge30c4d42004-08-07 13:58:02 +00001651 \item A new function, \cfunction{PyArg_VaParseTupleAndKeywords()},
1652 is the same as \cfunction{PyArg_ParseTupleAndKeywords()} but takes a
1653 \ctype{va_list} instead of a number of arguments.
1654 (Contributed by Greg Chapman.)
1655
Fred Drakece3caf22004-02-12 18:13:12 +00001656 \item A new method flag, \constant{METH_COEXISTS}, allows a function
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001657 defined in slots to co-exist with a \ctype{PyCFunction} having the
1658 same name. This can halve the access time for a method such as
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001659 \method{set.__contains__()}. (Contributed by Raymond Hettinger.)
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001660
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001661 \item Python can now be built with additional profiling for the
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001662 interpreter itself, intended as an aid to people developing the
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001663 Python core. Providing \longprogramopt{--enable-profiling} to the
1664 \program{configure} script will let you profile the interpreter with
1665 \program{gprof}, and providing the \longprogramopt{--with-tsc}
1666 switch enables profiling using the Pentium's Time-Stamp-Counter
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001667 register. Note that the \longprogramopt{--with-tsc} switch is slightly
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001668 misnamed, because the profiling feature also works on the PowerPC
1669 platform, though that processor architecture doesn't call that
Andrew M. Kuchling067947e2004-11-19 14:43:36 +00001670 register ``the TSC register''. (Contributed by Jeremy Hylton.)
1671
Andrew M. Kuchlingd0b6d9d2004-07-04 15:35:00 +00001672 \item The \ctype{tracebackobject} type has been renamed to \ctype{PyTracebackObject}.
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001673
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001674\end{itemize}
1675
1676
1677%======================================================================
1678\subsection{Port-Specific Changes}
1679
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001680\begin{itemize}
1681
1682\item The Windows port now builds under MSVC++ 7.1 as well as version 6.
Andrew M. Kuchling7642f7a2004-09-13 15:06:50 +00001683 (Contributed by Martin von Loewis.)
Raymond Hettinger97ef8de2004-01-05 00:29:57 +00001684
1685\end{itemize}
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001686
1687
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001688
1689%======================================================================
1690\section{Porting to Python 2.4}
1691
1692This section lists previously described changes that may require
1693changes to your code:
1694
1695\begin{itemize}
1696
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001697\item Left shifts and hexadecimal/octal constants that are too
1698 large no longer trigger a \exception{FutureWarning} and return
1699 a value limited to 32 or 64 bits; instead they return a long integer.
1700
1701\item Integer operations will no longer trigger an \exception{OverflowWarning}.
1702The \exception{OverflowWarning} warning will disappear in Python 2.5.
1703
Raymond Hettinger607c00f2003-11-12 16:27:50 +00001704\item The \function{zip()} built-in function and \function{itertools.izip()}
1705 now return an empty list instead of raising a \exception{TypeError}
1706 exception if called with no arguments.
Andrew M. Kuchling6aedcfc2003-10-21 12:48:23 +00001707
1708\item \function{dircache.listdir()} now passes exceptions to the caller
1709 instead of returning empty lists.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001710
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001711\item \function{LexicalHandler.startDTD()} used to receive the public and
1712 system IDs in the wrong order. This has been corrected; applications
Fred Drake56fcc232004-05-06 02:55:35 +00001713 relying on the wrong order need to be fixed.
Martin v. Löwis456ab1d2004-05-06 01:54:36 +00001714
Andrew M. Kuchling71432f12004-07-05 01:40:07 +00001715\item \function{fcntl.ioctl} now warns if the \var{mutate}
1716 argument is omitted and relevant.
Martin v. Löwis77ca6c42004-06-03 12:47:26 +00001717
Andrew M. Kuchling87c98b22004-08-25 13:38:46 +00001718\item The \module{tarfile} module now generates GNU-format tar files
1719by default.
1720
Andrew M. Kuchlingf8c075c2004-11-09 02:58:02 +00001721\item Encountering a failure while importing a module no longer leaves
1722a partially-initialized module object in \code{sys.modules}.
1723
1724\item \constant{None} is now a constant; code that binds a new value to
1725the name \samp{None} is now a syntax error.
1726
Anthony Baxter57ee7702004-12-13 11:39:33 +00001727% signal module now raises a RuntimeError on insane calls - e.g. setting a
1728% handler on SIGKILL
1729
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001730\end{itemize}
1731
1732
1733%======================================================================
1734\section{Acknowledgements \label{acks}}
1735
1736The author would like to thank the following people for offering
1737suggestions, corrections and assistance with various drafts of this
Andrew M. Kuchling536183b2004-11-25 01:15:25 +00001738article: Koray Can, Hye-Shik Chang, Michael Dyck, Raymond Hettinger,
Andrew M. Kuchlingb69c49c2004-12-01 00:42:41 +00001739Brian Hurt, Hamish Lawson, Fredrik Lundh, Sean Reifschneider.
Fred Drakeed0fa3d2003-07-30 19:14:09 +00001740
1741\end{document}