blob: dc4ec916bf6bcf3edff87cf6525eef1460b052c3 [file] [log] [blame]
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001\documentclass{howto}
2
3% $Id$
4
5\title{What's New in Python 2.2}
Andrew M. Kuchlingab010872001-07-19 14:59:53 +00006\release{0.04}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00007\author{A.M. Kuchling}
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +00008\authoraddress{\email{akuchlin@mems-exchange.org}}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00009\begin{document}
10\maketitle\tableofcontents
11
12\section{Introduction}
13
14{\large This document is a draft, and is subject to change until the
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +000015final version of Python 2.2 is released. Currently it's up to date
16for Python 2.2 alpha 1. Please send any comments, bug reports, or
17questions, no matter how minor, to \email{akuchlin@mems-exchange.org}.
18}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000019
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000020This article explains the new features in Python 2.2. Python 2.2
21includes some significant changes that go far toward cleaning up the
22language's darkest corners, and some exciting new features.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000023
24This article doesn't attempt to provide a complete specification for
25the new features, but instead provides a convenient overview of the
26new features. For full details, you should refer to 2.2 documentation
Fred Drake0d002542001-07-17 13:55:33 +000027such as the
28\citetitle[http://python.sourceforge.net/devel-docs/lib/lib.html]{Python
29Library Reference} and the
30\citetitle[http://python.sourceforge.net/devel-docs/ref/ref.html]{Python
31Reference Manual}, or to the PEP for a particular new feature.
32% These \citetitle marks should get the python.org URLs for the final
33% release, just as soon as the docs are published there.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000034
35The final release of Python 2.2 is planned for October 2001.
36
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000037
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000038%======================================================================
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000039% It looks like this set of changes will likely get into 2.2,
40% so I need to read and digest the relevant PEPs.
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000041%\section{PEP 252: Type and Class Changes}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000042
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000043%XXX
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000044
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000045% GvR's description at http://www.python.org/2.2/descrintro.html
46
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000047%\begin{seealso}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000048
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000049%\seepep{252}{Making Types Look More Like Classes}{Written and implemented
50%by GvR.}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000051
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000052%\end{seealso}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000053
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000054
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000055%======================================================================
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000056\section{PEP 234: Iterators}
57
58A significant addition to 2.2 is an iteration interface at both the C
59and Python levels. Objects can define how they can be looped over by
60callers.
61
62In Python versions up to 2.1, the usual way to make \code{for item in
63obj} work is to define a \method{__getitem__()} method that looks
64something like this:
65
66\begin{verbatim}
67 def __getitem__(self, index):
68 return <next item>
69\end{verbatim}
70
71\method{__getitem__()} is more properly used to define an indexing
72operation on an object so that you can write \code{obj[5]} to retrieve
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +000073the sixth element. It's a bit misleading when you're using this only
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000074to support \keyword{for} loops. Consider some file-like object that
75wants to be looped over; the \var{index} parameter is essentially
76meaningless, as the class probably assumes that a series of
77\method{__getitem__()} calls will be made, with \var{index}
78incrementing by one each time. In other words, the presence of the
79\method{__getitem__()} method doesn't mean that \code{file[5]} will
80work, though it really should.
81
82In Python 2.2, iteration can be implemented separately, and
83\method{__getitem__()} methods can be limited to classes that really
84do support random access. The basic idea of iterators is quite
85simple. A new built-in function, \function{iter(obj)}, returns an
86iterator for the object \var{obj}. (It can also take two arguments:
Fred Drake0d002542001-07-17 13:55:33 +000087\code{iter(\var{C}, \var{sentinel})} will call the callable \var{C},
88until it returns \var{sentinel}, which will signal that the iterator
89is done. This form probably won't be used very often.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000090
91Python classes can define an \method{__iter__()} method, which should
92create and return a new iterator for the object; if the object is its
93own iterator, this method can just return \code{self}. In particular,
94iterators will usually be their own iterators. Extension types
95implemented in C can implement a \code{tp_iter} function in order to
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +000096return an iterator, and extension types that want to behave as
97iterators can define a \code{tp_iternext} function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000098
99So what do iterators do? They have one required method,
100\method{next()}, which takes no arguments and returns the next value.
101When there are no more values to be returned, calling \method{next()}
102should raise the \exception{StopIteration} exception.
103
104\begin{verbatim}
105>>> L = [1,2,3]
106>>> i = iter(L)
107>>> print i
108<iterator object at 0x8116870>
109>>> i.next()
1101
111>>> i.next()
1122
113>>> i.next()
1143
115>>> i.next()
116Traceback (most recent call last):
117 File "<stdin>", line 1, in ?
118StopIteration
119>>>
120\end{verbatim}
121
122In 2.2, Python's \keyword{for} statement no longer expects a sequence;
123it expects something for which \function{iter()} will return something.
124For backward compatibility, and convenience, an iterator is
125automatically constructed for sequences that don't implement
126\method{__iter__()} or a \code{tp_iter} slot, so \code{for i in
127[1,2,3]} will still work. Wherever the Python interpreter loops over
128a sequence, it's been changed to use the iterator protocol. This
129means you can do things like this:
130
131\begin{verbatim}
132>>> i = iter(L)
133>>> a,b,c = i
134>>> a,b,c
135(1, 2, 3)
136>>>
137\end{verbatim}
138
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000139Iterator support has been added to some of Python's basic types.
Fred Drake0d002542001-07-17 13:55:33 +0000140Calling \function{iter()} on a dictionary will return an iterator
Andrew M. Kuchling6ea9f0b2001-07-17 14:50:31 +0000141which loops over its keys:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000142
143\begin{verbatim}
144>>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
145... 'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
146>>> for key in m: print key, m[key]
147...
148Mar 3
149Feb 2
150Aug 8
151Sep 9
152May 5
153Jun 6
154Jul 7
155Jan 1
156Apr 4
157Nov 11
158Dec 12
159Oct 10
160>>>
161\end{verbatim}
162
163That's just the default behaviour. If you want to iterate over keys,
164values, or key/value pairs, you can explicitly call the
165\method{iterkeys()}, \method{itervalues()}, or \method{iteritems()}
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000166methods to get an appropriate iterator. In a minor related change,
167the \keyword{in} operator now works on dictionaries, so
168\code{\var{key} in dict} is now equivalent to
169\code{dict.has_key(\var{key})}.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000170
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000171
172Files also provide an iterator, which calls the \method{readline()}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000173method until there are no more lines in the file. This means you can
174now read each line of a file using code like this:
175
176\begin{verbatim}
177for line in file:
178 # do something for each line
179\end{verbatim}
180
181Note that you can only go forward in an iterator; there's no way to
182get the previous element, reset the iterator, or make a copy of it.
Fred Drake0d002542001-07-17 13:55:33 +0000183An iterator object could provide such additional capabilities, but the
184iterator protocol only requires a \method{next()} method.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000185
186\begin{seealso}
187
188\seepep{234}{Iterators}{Written by Ka-Ping Yee and GvR; implemented
189by the Python Labs crew, mostly by GvR and Tim Peters.}
190
191\end{seealso}
192
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000193
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000194%======================================================================
195\section{PEP 255: Simple Generators}
196
197Generators are another new feature, one that interacts with the
198introduction of iterators.
199
200You're doubtless familiar with how function calls work in Python or
201C. When you call a function, it gets a private area where its local
202variables are created. When the function reaches a \keyword{return}
203statement, the local variables are destroyed and the resulting value
204is returned to the caller. A later call to the same function will get
205a fresh new set of local variables. But, what if the local variables
206weren't destroyed on exiting a function? What if you could later
207resume the function where it left off? This is what generators
208provide; they can be thought of as resumable functions.
209
210Here's the simplest example of a generator function:
211
212\begin{verbatim}
213def generate_ints(N):
214 for i in range(N):
215 yield i
216\end{verbatim}
217
218A new keyword, \keyword{yield}, was introduced for generators. Any
219function containing a \keyword{yield} statement is a generator
220function; this is detected by Python's bytecode compiler which
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000221compiles the function specially. Because a new keyword was
222introduced, generators must be explicitly enabled in a module by
223including a \code{from __future__ import generators} statement near
224the top of the module's source code. In Python 2.3 this statement
225will become unnecessary.
226
227When you call a generator function, it doesn't return a single value;
228instead it returns a generator object that supports the iterator
229interface. On executing the \keyword{yield} statement, the generator
230outputs the value of \code{i}, similar to a \keyword{return}
231statement. The big difference between \keyword{yield} and a
232\keyword{return} statement is that, on reaching a \keyword{yield} the
233generator's state of execution is suspended and local variables are
234preserved. On the next call to the generator's \code{.next()} method,
235the function will resume executing immediately after the
236\keyword{yield} statement. (For complicated reasons, the
237\keyword{yield} statement isn't allowed inside the \keyword{try} block
238of a \code{try...finally} statement; read PEP 255 for a full
239explanation of the interaction between \keyword{yield} and
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000240exceptions.)
241
242Here's a sample usage of the \function{generate_ints} generator:
243
244\begin{verbatim}
245>>> gen = generate_ints(3)
246>>> gen
247<generator object at 0x8117f90>
248>>> gen.next()
2490
250>>> gen.next()
2511
252>>> gen.next()
2532
254>>> gen.next()
255Traceback (most recent call last):
256 File "<stdin>", line 1, in ?
257 File "<stdin>", line 2, in generate_ints
258StopIteration
259>>>
260\end{verbatim}
261
262You could equally write \code{for i in generate_ints(5)}, or
263\code{a,b,c = generate_ints(3)}.
264
265Inside a generator function, the \keyword{return} statement can only
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000266be used without a value, and signals the end of the procession of
267values; afterwards the generator cannot return any further values.
268\keyword{return} with a value, such as \code{return 5}, is a syntax
269error inside a generator function. The end of the generator's results
270can also be indicated by raising \exception{StopIteration} manually,
271or by just letting the flow of execution fall off the bottom of the
272function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000273
274You could achieve the effect of generators manually by writing your
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000275own class and storing all the local variables of the generator as
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000276instance variables. For example, returning a list of integers could
277be done by setting \code{self.count} to 0, and having the
278\method{next()} method increment \code{self.count} and return it.
Andrew M. Kuchlingc32cc7c2001-07-17 18:25:01 +0000279However, for a moderately complicated generator, writing a
280corresponding class would be much messier.
281\file{Lib/test/test_generators.py} contains a number of more
282interesting examples. The simplest one implements an in-order
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000283traversal of a tree using generators recursively.
284
285\begin{verbatim}
286# A recursive generator that generates Tree leaves in in-order.
287def inorder(t):
288 if t:
289 for x in inorder(t.left):
290 yield x
291 yield t.label
292 for x in inorder(t.right):
293 yield x
294\end{verbatim}
295
296Two other examples in \file{Lib/test/test_generators.py} produce
297solutions for the N-Queens problem (placing $N$ queens on an $NxN$
298chess board so that no queen threatens another) and the Knight's Tour
299(a route that takes a knight to every square of an $NxN$ chessboard
300without visiting any square twice).
301
302The idea of generators comes from other programming languages,
303especially Icon (\url{http://www.cs.arizona.edu/icon/}), where the
304idea of generators is central to the language. In Icon, every
305expression and function call behaves like a generator. One example
306from ``An Overview of the Icon Programming Language'' at
307\url{http://www.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of
308what this looks like:
309
310\begin{verbatim}
311sentence := "Store it in the neighboring harbor"
312if (i := find("or", sentence)) > 5 then write(i)
313\end{verbatim}
314
315The \function{find()} function returns the indexes at which the
316substring ``or'' is found: 3, 23, 33. In the \keyword{if} statement,
317\code{i} is first assigned a value of 3, but 3 is less than 5, so the
318comparison fails, and Icon retries it with the second value of 23. 23
319is greater than 5, so the comparison now succeeds, and the code prints
320the value 23 to the screen.
321
322Python doesn't go nearly as far as Icon in adopting generators as a
323central concept. Generators are considered a new part of the core
324Python language, but learning or using them isn't compulsory; if they
325don't solve any problems that you have, feel free to ignore them.
326This is different from Icon where the idea of generators is a basic
327concept. One novel feature of Python's interface as compared to
328Icon's is that a generator's state is represented as a concrete object
329that can be passed around to other functions or stored in a data
330structure.
331
332\begin{seealso}
333
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000334\seepep{255}{Simple Generators}{Written by Neil Schemenauer, Tim
335Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
336and Tim Peters, with other fixes from the Python Labs crew.}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000337
338\end{seealso}
339
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000340
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000341%======================================================================
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000342\section{PEP 238: Changing the Division Operator}
343
344The most controversial change in Python 2.2 is the start of an effort
345to fix an old design flaw that's been in Python from the beginning.
346Currently Python's division operator, \code{/}, behaves like C's
347division operator when presented with two integer arguments. It
348returns an integer result that's truncated down when there would be
349fractional part. For example, \code{3/2} is 1, not 1.5, and
350\code{(-1)/2} is -1, not -0.5. This means that the results of divison
351can vary unexpectedly depending on the type of the two operands and
352because Python is dynamically typed, it can be difficult to determine
353the possible types of the operands.
354
355(The controversy is over whether this is \emph{really} a design flaw,
356and whether it's worth breaking existing code to fix this. It's
357caused endless discussions on python-dev and in July erupted into an
358storm of acidly sarcastic postings on \newsgroup{comp.lang.python}. I
359won't argue for either side here; read PEP 238 for a summary of
360arguments and counter-arguments.)
361
362Because this change might break code, it's being introduced very
363gradually. Python 2.2 begins the transition, but the switch won't be
364complete until Python 3.0.
365
366First, some terminology from PEP 238. ``True division'' is the
367division that most non-programmers are familiar with: 3/2 is 1.5, 1/4
368is 0.25, and so forth. ``Floor division'' is what Python's \code{/}
369operator currently does when given integer operands; the result is the
370floor of the value returned by true division. ``Classic division'' is
371the current mixed behaviour of \code{/}; it returns the result of
372floor division when the operands are integers, and returns the result
373of true division when one of the operands is a floating-point number.
374
375Here are the changes 2.2 introduces:
376
377\begin{itemize}
378
379\item A new operator, \code{//}, is the floor division operator.
380(Yes, we know it looks like \Cpp's comment symbol.) \code{//}
381\emph{always} returns the floor divison no matter what the types of
382its operands are, so \code{1 // 2} is 0 and \code{1.0 // 2.0} is also
3830.0.
384
385\code{//} is always available in Python 2.2; you don't need to enable
386it using a \code{__future__} statement.
387
388\item By including a \code{from __future__ import true_division} in a
389module, the \code{/} operator will be changed to return the result of
390true division, so \code{1/2} is 0.5. Without the \code{__future__}
391statement, \code{/} still means classic division. The default meaning
392of \code{/} will not change until Python 3.0.
393
394\item Classes can define methods called \method{__truediv__} and
395\method{__floordiv__} to overload the two division operators. At the
396C level, there are also slots in the \code{PyNumberMethods} structure
397so extension types can define the two operators.
398
399% XXX a warning someday?
400
401\end{itemize}
402
403\begin{seealso}
404
405\seepep{238}{Changing the Division Operator}{Written by Moshe Zadka and
406Guido van Rossum. Implemented by Guido van Rossum..}
407
408\end{seealso}
409
410
411%======================================================================
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000412\section{Unicode Changes}
413
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000414Python's Unicode support has been enhanced a bit in 2.2. Unicode
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000415strings are usually stored as UCS-2, as 16-bit unsigned integers.
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000416Python 2.2 can also be compiled to use UCS-4, 32-bit unsigned
417integers, as its internal encoding by supplying
418\longprogramopt{enable-unicode=ucs4} to the configure script. When
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000419built to use UCS-4 (a ``wide Python''), the interpreter can natively
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000420handle Unicode characters from U+000000 to U+110000, so the range of
421legal values for the \function{unichr()} function is expanded
422accordingly. Using an interpreter compiled to use UCS-2 (a ``narrow
423Python''), values greater than 65535 will still cause
424\function{unichr()} to raise a \exception{ValueError} exception.
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000425
426All this is the province of the still-unimplemented PEP 261, ``Support
427for `wide' Unicode characters''; consult it for further details, and
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000428please offer comments on the PEP and on your experiences with the
4292.2 alpha releases.
430% XXX update previous line once 2.2 reaches beta.
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000431
432Another change is much simpler to explain. Since their introduction,
433Unicode strings have supported an \method{encode()} method to convert
434the string to a selected encoding such as UTF-8 or Latin-1. A
435symmetric \method{decode(\optional{\var{encoding}})} method has been
436added to 8-bit strings (though not to Unicode strings) in 2.2.
437\method{decode()} assumes that the string is in the specified encoding
438and decodes it, returning whatever is returned by the codec.
439
440Using this new feature, codecs have been added for tasks not directly
441related to Unicode. For example, codecs have been added for
442uu-encoding, MIME's base64 encoding, and compression with the
443\module{zlib} module:
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000444
445\begin{verbatim}
446>>> s = """Here is a lengthy piece of redundant, overly verbose,
447... and repetitive text.
448... """
449>>> data = s.encode('zlib')
450>>> data
451'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
452>>> data.decode('zlib')
453'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
454>>> print s.encode('uu')
455begin 666 <data>
456M2&5R92!I<R!A(&QE;F=T:'D@<&EE8V4@;V8@<F5D=6YD86YT+"!O=F5R;'D@
457>=F5R8F]S92P*86YD(')E<&5T:71I=F4@=&5X="X*
458
459end
460>>> "sheesh".encode('rot-13')
461'furrfu'
462\end{verbatim}
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000463
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000464\method{encode()} and \method{decode()} were implemented by
465Marc-Andr\'e Lemburg. The changes to support using UCS-4 internally
466were implemented by Fredrik Lundh and Martin von L\"owis.
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000467
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000468\begin{seealso}
469
470\seepep{261}{Support for `wide' Unicode characters}{PEP written by
471Paul Prescod. Not yet accepted or fully implemented.}
472
473\end{seealso}
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000474
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000475%======================================================================
476\section{PEP 227: Nested Scopes}
477
478In Python 2.1, statically nested scopes were added as an optional
479feature, to be enabled by a \code{from __future__ import
480nested_scopes} directive. In 2.2 nested scopes no longer need to be
481specially enabled, but are always enabled. The rest of this section
482is a copy of the description of nested scopes from my ``What's New in
483Python 2.1'' document; if you read it when 2.1 came out, you can skip
484the rest of this section.
485
486The largest change introduced in Python 2.1, and made complete in 2.2,
487is to Python's scoping rules. In Python 2.0, at any given time there
488are at most three namespaces used to look up variable names: local,
489module-level, and the built-in namespace. This often surprised people
490because it didn't match their intuitive expectations. For example, a
491nested recursive function definition doesn't work:
492
493\begin{verbatim}
494def f():
495 ...
496 def g(value):
497 ...
498 return g(value-1) + 1
499 ...
500\end{verbatim}
501
502The function \function{g()} will always raise a \exception{NameError}
503exception, because the binding of the name \samp{g} isn't in either
504its local namespace or in the module-level namespace. This isn't much
505of a problem in practice (how often do you recursively define interior
506functions like this?), but this also made using the \keyword{lambda}
507statement clumsier, and this was a problem in practice. In code which
508uses \keyword{lambda} you can often find local variables being copied
509by passing them as the default values of arguments.
510
511\begin{verbatim}
512def find(self, name):
513 "Return list of any entries equal to 'name'"
514 L = filter(lambda x, name=name: x == name,
515 self.list_attribute)
516 return L
517\end{verbatim}
518
519The readability of Python code written in a strongly functional style
520suffers greatly as a result.
521
522The most significant change to Python 2.2 is that static scoping has
523been added to the language to fix this problem. As a first effect,
524the \code{name=name} default argument is now unnecessary in the above
525example. Put simply, when a given variable name is not assigned a
526value within a function (by an assignment, or the \keyword{def},
527\keyword{class}, or \keyword{import} statements), references to the
528variable will be looked up in the local namespace of the enclosing
529scope. A more detailed explanation of the rules, and a dissection of
530the implementation, can be found in the PEP.
531
532This change may cause some compatibility problems for code where the
533same variable name is used both at the module level and as a local
534variable within a function that contains further function definitions.
535This seems rather unlikely though, since such code would have been
536pretty confusing to read in the first place.
537
538One side effect of the change is that the \code{from \var{module}
539import *} and \keyword{exec} statements have been made illegal inside
540a function scope under certain conditions. The Python reference
541manual has said all along that \code{from \var{module} import *} is
542only legal at the top level of a module, but the CPython interpreter
543has never enforced this before. As part of the implementation of
544nested scopes, the compiler which turns Python source into bytecodes
545has to generate different code to access variables in a containing
546scope. \code{from \var{module} import *} and \keyword{exec} make it
547impossible for the compiler to figure this out, because they add names
548to the local namespace that are unknowable at compile time.
549Therefore, if a function contains function definitions or
550\keyword{lambda} expressions with free variables, the compiler will
551flag this by raising a \exception{SyntaxError} exception.
552
553To make the preceding explanation a bit clearer, here's an example:
554
555\begin{verbatim}
556x = 1
557def f():
558 # The next line is a syntax error
559 exec 'x=2'
560 def g():
561 return x
562\end{verbatim}
563
564Line 4 containing the \keyword{exec} statement is a syntax error,
565since \keyword{exec} would define a new local variable named \samp{x}
566whose value should be accessed by \function{g()}.
567
568This shouldn't be much of a limitation, since \keyword{exec} is rarely
569used in most Python code (and when it is used, it's often a sign of a
570poor design anyway).
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000571
572\begin{seealso}
573
574\seepep{227}{Statically Nested Scopes}{Written and implemented by
575Jeremy Hylton.}
576
577\end{seealso}
578
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000579
580%======================================================================
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000581\section{New and Improved Modules}
582
583\begin{itemize}
584
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000585 \item The \module{xmlrpclib} module was contributed to the standard
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +0000586 library by Fredrik Lundh. It provides support for writing XML-RPC
587 clients; XML-RPC is a simple remote procedure call protocol built on
588 top of HTTP and XML. For example, the following snippet retrieves a
589 list of RSS channels from the O'Reilly Network, and then retrieves a
590 list of the recent headlines for one channel:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000591
592\begin{verbatim}
593import xmlrpclib
594s = xmlrpclib.Server(
595 'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
596channels = s.meerkat.getChannels()
597# channels is a list of dictionaries, like this:
598# [{'id': 4, 'title': 'Freshmeat Daily News'}
599# {'id': 190, 'title': '32Bits Online'},
600# {'id': 4549, 'title': '3DGamers'}, ... ]
601
602# Get the items for one channel
603items = s.meerkat.getItems( {'channel': 4} )
604
605# 'items' is another list of dictionaries, like this:
606# [{'link': 'http://freshmeat.net/releases/52719/',
607# 'description': 'A utility which converts HTML to XSL FO.',
608# 'title': 'html2fo 0.3 (Default)'}, ... ]
609\end{verbatim}
610
Fred Drake0d002542001-07-17 13:55:33 +0000611See \url{http://www.xmlrpc.com/} for more information about XML-RPC.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000612
613 \item The \module{socket} module can be compiled to support IPv6;
Andrew M. Kuchlingddeb1352001-07-16 14:35:52 +0000614 specify the \longprogramopt{enable-ipv6} option to Python's configure
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000615 script. (Contributed by Jun-ichiro ``itojun'' Hagino.)
616
617 \item Two new format characters were added to the \module{struct}
618 module for 64-bit integers on platforms that support the C
619 \ctype{long long} type. \samp{q} is for a signed 64-bit integer,
620 and \samp{Q} is for an unsigned one. The value is returned in
621 Python's long integer type. (Contributed by Tim Peters.)
622
623 \item In the interpreter's interactive mode, there's a new built-in
624 function \function{help()}, that uses the \module{pydoc} module
625 introduced in Python 2.1 to provide interactive.
626 \code{help(\var{object})} displays any available help text about
627 \var{object}. \code{help()} with no argument puts you in an online
628 help utility, where you can enter the names of functions, classes,
629 or modules to read their help text.
630 (Contributed by Guido van Rossum, using Ka-Ping Yee's \module{pydoc} module.)
631
632 \item Various bugfixes and performance improvements have been made
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000633 to the SRE engine underlying the \module{re} module. For example,
634 \function{re.sub()} will now use \function{string.replace()}
635 automatically when the pattern and its replacement are both just
636 literal strings without regex metacharacters. Another contributed
637 patch speeds up certain Unicode character ranges by a factor of
638 two. (SRE is maintained by Fredrik Lundh. The BIGCHARSET patch was
639 contributed by Martin von L\"owis.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000640
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000641 \item The \module{imaplib} module, maintained by Piers Lauder, has
642 support for several new extensions: the NAMESPACE extension defined
643 in \rfc{2342}, SORT, GETACL and SETACL. (Contributed by Anthony
644 Baxter and Michel Pelletier.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000645
Fred Drake0d002542001-07-17 13:55:33 +0000646 \item The \module{rfc822} module's parsing of email addresses is
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000647 now compliant with \rfc{2822}, an update to \rfc{822}. The module's
648 name is \emph{not} going to be changed to \samp{rfc2822}.
649 (Contributed by Barry Warsaw.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +0000650
651 \item New constants \constant{ascii_letters},
652 \constant{ascii_lowercase}, and \constant{ascii_uppercase} were
653 added to the \module{string} module. There were several modules in
654 the standard library that used \constant{string.letters} to mean the
655 ranges A-Za-z, but that assumption is incorrect when locales are in
656 use, because \constant{string.letters} varies depending on the set
657 of legal characters defined by the current locale. The buggy
658 modules have all been fixed to use \constant{ascii_letters} instead.
659 (Reported by an unknown person; fixed by Fred L. Drake, Jr.)
660
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +0000661 \item The \module{mimetypes} module now makes it easier to use
662 alternative MIME-type databases by the addition of a
663 \class{MimeTypes} class, which takes a list of filenames to be
664 parsed. (Contributed by Fred L. Drake, Jr.)
665
Andrew M. Kuchling77707672001-07-31 15:51:16 +0000666\end{itemize}
667
668
669%======================================================================
670\section{Interpreter Changes and Fixes}
671
672Some of the changes only affect people who deal with the Python
673interpreter at the C level, writing Python extension modules,
674embedding the interpreter, or just hacking on the interpreter itself.
675If you only write Python code, none of the changes described here will
676affect you very much.
677
678\begin{itemize}
679
680 \item Profiling and tracing functions can now be implemented in C,
681 which can operate at much higher speeds than Python-based functions
682 and should reduce the overhead of enabling profiling and tracing, so
683 it will be of interest to authors of development environments for
684 Python. Two new C functions were added to Python's API,
685 \cfunction{PyEval_SetProfile()} and \cfunction{PyEval_SetTrace()}.
686 The existing \function{sys.setprofile()} and
687 \function{sys.settrace()} functions still exist, and have simply
688 been changed to use the new C-level interface. (Contributed by Fred
689 L. Drake, Jr.)
690
691 \item Another low-level API, primarily of interest to implementors
692 of Python debuggers and development tools, was added.
693 \cfunction{PyInterpreterState_Head()} and
694 \cfunction{PyInterpreterState_Next()} let a caller walk through all
695 the existing interpreter objects;
696 \cfunction{PyInterpreterState_ThreadHead()} and
697 \cfunction{PyThreadState_Next()} allow looping over all the thread
698 states for a given interpreter. (Contributed by David Beazley.)
699
700 \item A new \samp{et} format sequence was added to
701 \cfunction{PyArg_ParseTuple}; \samp{et} takes both a parameter and
702 an encoding name, and converts the parameter to the given encoding
703 if the parameter turns out to be a Unicode string, or leaves it
704 alone if it's an 8-bit string, assuming it to already be in the
705 desired encoding. This differs from the \samp{es} format character,
706 which assumes that 8-bit strings are in Python's default ASCII
707 encoding and converts them to the specified new encoding.
708 (Contributed by M.-A. Lemburg, and used for the MBCS support on
709 Windows described in the previous section.)
710
711 \item Two new wrapper functions, \cfunction{PyOS_snprintf()} and
712 \cfunction{PyOS_vsnprintf()} were added. which provide a cross-platform
713 implementations for the relatively new snprintf()/vsnprintf() C lib
714 APIs. In contrast to the standard sprintf() and vsprintf() C lib
715 APIs, these versions apply bounds checking on the used buffer which
716 enhances protection against buffer overruns.
717 (Contributed by M.-A. Lemburg.)
718
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000719\end{itemize}
720
721
722%======================================================================
723\section{Other Changes and Fixes}
724
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000725% XXX update the patch and bug figures as we go
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000726As usual there were a bunch of other improvements and bugfixes
727scattered throughout the source tree. A search through the CVS change
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000728logs finds there were 43 patches applied, and 77 bugs fixed; both
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000729figures are likely to be underestimates. Some of the more notable
730changes are:
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000731
732\begin{itemize}
733
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000734 \item Keyword arguments passed to builtin functions that don't take them
735 now cause a \exception{TypeError} exception to be raised, with the
736 message "\var{function} takes no keyword arguments".
737
Fred Drake0d002542001-07-17 13:55:33 +0000738 \item The code for the Mac OS port for Python, maintained by Jack
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000739 Jansen, is now kept in the main Python CVS tree.
740
741 \item The new license introduced with Python 1.6 wasn't
742 GPL-compatible. This is fixed by some minor textual changes to the
743 2.2 license, so Python can now be embedded inside a GPLed program
744 again. The license changes were also applied to the Python 2.0.1
745 and 2.1.1 releases.
746
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +0000747 \item When presented with a Unicode filename on Windows, Python will
748 now convert it to an MBCS encoded string, as used by the Microsoft
749 file APIs. As MBCS is explicitly used by the file APIs, Python's
750 choice of ASCII as the default encoding turns out to be an
751 annoyance.
752
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000753 (Contributed by Mark Hammond with assistance from Marc-Andr\'e
754 Lemburg.)
755
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000756 \item The \file{Tools/scripts/ftpmirror.py} script
757 now parses a \file{.netrc} file, if you have one.
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000758 (Contributed by Mike Romberg.)
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000759
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000760 \item Some features of the object returned by the
761 \function{xrange()} function are now deprecated, and trigger
762 warnings when they're accessed; they'll disappear in Python 2.3.
763 \class{xrange} objects tried to pretend they were full sequence
764 types by supporting slicing, sequence multiplication, and the
765 \keyword{in} operator, but these features were rarely used and
766 therefore buggy. The \method{tolist()} method and the
767 \member{start}, \member{stop}, and \member{step} attributes are also
768 being deprecated. At the C level, the fourth argument to the
769 \cfunction{PyRange_New()} function, \samp{repeat}, has also been
770 deprecated.
771
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000772 \item There were a bunch of patches to the dictionary
773 implementation, mostly to fix potential core dumps if a dictionary
774 contains objects that sneakily changed their hash value, or mutated
775 the dictionary they were contained in. For a while python-dev fell
776 into a gentle rhythm of Michael Hudson finding a case that dump
777 core, Tim Peters fixing it, Michael finding another case, and round
778 and round it went.
779
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000780 \item On Windows, Python can now be compiled with Borland C thanks
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000781 to a number of patches contributed by Stephen Hansen.
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +0000782
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +0000783 \item Another Windows enhancement: Wise Solutions generously offered
784 PythonLabs use of their InstallerMaster 8.1 system. Earlier
785 PythonLabs Windows installers used Wise 5.0a, which was beginning to
786 show its age. (Packaged up by Tim Peters.)
787
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +0000788 \item Files ending in \samp{.pyw} can now be imported on Windows.
789 \samp{.pyw} is a Windows-only thing, used to indicate that a script
790 needs to be run using PYTHONW.EXE instead of PYTHON.EXE in order to
791 prevent a DOS console from popping up to display the output. This
792 patch makes it possible to import such scripts, in case they're also
793 usable as modules. (Implemented by David Bolen.)
794
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000795 \item On platforms where Python uses the C \cfunction{dlopen()} function
796 to load extension modules, it's now possible to set the flags used
797 by \cfunction{dlopen()} using the \function{sys.getdlopenflags()} and
798 \function{sys.setdlopenflags()} functions. (Contributed by Bram Stolk.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +0000799
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000800\end{itemize}
801
802
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000803%======================================================================
804\section{Acknowledgements}
805
806The author would like to thank the following people for offering
Andrew M. Kuchling6ea9f0b2001-07-17 14:50:31 +0000807suggestions and corrections to various drafts of this article: Fred
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000808Bremmer, Keith Briggs, Fred L. Drake, Jr., Carel Fellinger, Mark
809Hammond, Marc-Andr\'e Lemburg, Tim Peters, Neil Schemenauer, Guido van
810Rossum.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000811
812\end{document}