blob: e12c591045dbdd785177bf21ec9ad3531a140d52 [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. Kuchlingbbde5882001-10-31 13:13:36 +00006\release{0.09}
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
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +000016for Python 2.2 beta 1. Please send any comments, bug reports, or
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +000017questions, no matter how minor, to \email{akuchlin@mems-exchange.org}.
18}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000019
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000020This article explains the new features in Python 2.2.
21
22Python 2.2 can be thought of as the "cleanup release". There are some
23features such as generators and iterators that are completely new, but
24most of the changes, significant and far-reaching though they may be,
25are aimed at cleaning up irregularities and dark corners of the
26language design.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000027
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000028This article doesn't attempt to provide a complete specification of
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000029the new features, but instead provides a convenient overview. For
30full details, you should refer to the documentation for Python 2.2,
Fred Drake0d002542001-07-17 13:55:33 +000031such as the
32\citetitle[http://python.sourceforge.net/devel-docs/lib/lib.html]{Python
33Library Reference} and the
34\citetitle[http://python.sourceforge.net/devel-docs/ref/ref.html]{Python
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000035Reference Manual}.
36% XXX These \citetitle marks should get the python.org URLs for the final
Fred Drake0d002542001-07-17 13:55:33 +000037% release, just as soon as the docs are published there.
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000038If you want to understand the complete implementation and design
39rationale for a change, refer to the PEP for a particular new feature.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000040
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +000041The final release of Python 2.2 is planned for December 2001.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000042
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000043\begin{seealso}
44
Andrew M. Kuchling2dab9c72001-10-31 13:16:10 +000045\seeurl{http://www.unixreview.com/documents/s=1356/urm0109h/0109h.htm}
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000046{``What's So Special About Python 2.2?'' is also about the new 2.2
47features, and was written by Cameron Laird and Kathryn Soraiz.}
48
49\end{seealso}
50
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000051
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000052%======================================================================
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +000053\section{PEPs 252 and 253: Type and Class Changes}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000054
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000055The largest and most far-reaching changes in Python 2.2 are to
56Python's model of objects and classes. The changes should be backward
57compatible, so it's likely that your code will continue to run
58unchanged, but the changes provide some amazing new capabilities.
59Before beginning this, the longest and most complicated section of
60this article, I'll provide an overview of the changes and offer some
61comments.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000062
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000063A long time ago I wrote a Web page
64(\url{http://www.amk.ca/python/writing/warts.html}) listing flaws in
65Python's design. One of the most significant flaws was that it's
66impossible to subclass Python types implemented in C. In particular,
67it's not possible to subclass built-in types, so you can't just
68subclass, say, lists in order to add a single useful method to them.
69The \module{UserList} module provides a class that supports all of the
70methods of lists and that can be subclassed further, but there's lots
71of C code that expects a regular Python list and won't accept a
72\class{UserList} instance.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000073
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000074Python 2.2 fixes this, and in the process adds some exciting new
75capabilities. A brief summary:
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000076
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000077\begin{itemize}
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +000078
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000079\item You can subclass built-in types such as lists and even integers,
80and your subclasses should work in every place that requires the
81original type.
82
83\item It's now possible to define static and class methods, in addition
84to the instance methods available in previous versions of Python.
85
86\item It's also possible to automatically call methods on accessing or
87setting an instance attribute by using a new mechanism called
88\dfn{properties}. Many uses of \method{__getattr__} can be rewritten
89to use properties instead, making the resulting code simpler and
90faster. As a small side benefit, attributes can now have docstrings,
91too.
92
93\item The list of legal attributes for an instance can be limited to a
94particular set using \dfn{slots}, making it possible to safeguard
95against typos and perhaps make more optimizations possible in future
96versions of Python.
97
98\end{itemize}
99
100Some users have voiced concern about all these changes. Sure, they
101say, the new features are neat and lend themselves to all sorts of
102tricks that weren't possible in previous versions of Python, but
103they also make the language more complicated. Some people have said
104that they've always recommended Python for its simplicity, and feel
105that its simplicity is being lost.
106
107Personally, I think there's no need to worry. Many of the new
108features are quite esoteric, and you can write a lot of Python code
109without ever needed to be aware of them. Writing a simple class is no
110more difficult than it ever was, so you don't need to bother learning
111or teaching them unless they're actually needed. Some very
112complicated tasks that were previously only possible from C will now
113be possible in pure Python, and to my mind that's all for the better.
114
115I'm not going to attempt to cover every single corner case and small
116change that were required to make the new features work. Instead this
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000117section will paint only the broad strokes. See section~\ref{sect-rellinks},
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000118``Related Links'', for further sources of information about Python 2.2's new
119object model.
120
121
122\subsection{Old and New Classes}
123
124First, you should know that Python 2.2 really has two kinds of
125classes: classic or old-style classes, and new-style classes. The
126old-style class model is exactly the same as the class model in
127earlier versions of Python. All the new features described in this
128section apply only to new-style classes. This divergence isn't
129intended to last forever; eventually old-style classes will be
130dropped, possibly in Python 3.0.
131
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000132So how do you define a new-style class? You do it by subclassing an
133existing new-style class. Most of Python's built-in types, such as
134integers, lists, dictionaries, and even files, are new-style classes
135now. A new-style class named \class{object}, the base class for all
136built-in types, has been also been added so if no built-in type is
137suitable, you can just subclass \class{object}:
138
139\begin{verbatim}
140class C(object):
141 def __init__ (self):
142 ...
143 ...
144\end{verbatim}
145
146This means that \keyword{class} statements that don't have any base
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000147classes are always classic classes in Python 2.2. (Actually you can
148also change this by setting a module-level variable named
149\member{__metaclass__} --- see \pep{253} for the details --- but it's
150easier to just subclass \keyword{object}.)
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000151
152The type objects for the built-in types are available as built-ins,
153named using a clever trick. Python has always had built-in functions
154named \function{int()}, \function{float()}, and \function{str()}. In
1552.2, they aren't functions any more, but type objects that behave as
156factories when called.
157
158\begin{verbatim}
159>>> int
160<type 'int'>
161>>> int('123')
162123
163\end{verbatim}
164
165To make the set of types complete, new type objects such as
Andrew M. Kuchling1117d932001-10-29 20:37:47 +0000166\function{dict} and \function{file} have been added. Here's a
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000167more interesting example, adding a \method{lock()} method to file
168objects:
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000169
170\begin{verbatim}
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000171class LockableFile(file):
172 def lock (self, operation, length=0, start=0, whence=0):
173 import fcntl
174 return fcntl.lockf(self.fileno(), operation,
175 length, start, whence)
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000176\end{verbatim}
177
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000178The now-obsolete \module{posixfile} module contained a class that
179emulated all of a file object's methods and also added a
180\method{lock()} method, but this class couldn't be passed to internal
181functions that expected a built-in file, something which is possible
182with our new \class{LockableFile}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000183
184
185\subsection{Descriptors}
186
187In previous versions of Python, there was no consistent way to
188discover what attributes and methods were supported by an object.
189There were some informal conventions, such as defining
190\member{__members__} and \member{__methods__} attributes that were
191lists of names, but often the author of an extension type or a class
192wouldn't bother to define them. You could fall back on inspecting the
193\member{__dict__} of an object, but when class inheritance or an
194arbitrary \method{__getattr__} hook were in use this could still be
195inaccurate.
196
197The one big idea underlying the new class model is that an API for
198describing the attributes of an object using \dfn{descriptors} has
199been formalized. Descriptors specify the value of an attribute,
200stating whether it's a method or a field. With the descriptor API,
201static methods and class methods become possible, as well as more
202exotic constructs.
203
204Attribute descriptors are objects that live inside class objects, and
205have a few attributes of their own:
206
207\begin{itemize}
208
209\item \member{__name__} is the attribute's name.
210
211\item \member{__doc__} is the attribute's docstring.
212
Andrew M. Kuchling9455df22001-12-03 20:55:37 +0000213\item \method{__get__(\var{object})} is a method that retrieves the
214attribute value from \var{object}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000215
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +0000216\item \method{__set__(\var{object}, \var{value})} sets the attribute
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000217on \var{object} to \var{value}.
218
Andrew M. Kuchlingc54fc312001-12-03 20:58:29 +0000219\item \method{__delete__(\var{object}, \var{value})} deletes the \var{value}
Andrew M. Kuchling9455df22001-12-03 20:55:37 +0000220attribute of \var{object}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000221\end{itemize}
222
223For example, when you write \code{obj.x}, the steps that Python
224actually performs are:
225
226\begin{verbatim}
227descriptor = obj.__class__.x
Andrew M. Kuchling7cc13de2001-10-30 14:22:11 +0000228descriptor.__get__(obj)
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000229\end{verbatim}
230
Andrew M. Kuchling7cc13de2001-10-30 14:22:11 +0000231For methods, \method{descriptor.__get__} returns a temporary object that's
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000232callable, and wraps up the instance and the method to be called on it.
233This is also why static methods and class methods are now possible;
234they have descriptors that wrap up just the method, or the method and
235the class. As a brief explanation of these new kinds of methods,
236static methods aren't passed the instance, and therefore resemble
237regular functions. Class methods are passed the class of the object,
Andrew M. Kuchling72a7fb72001-10-30 22:18:21 +0000238but not the object itself. Static and class methods are defined like
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000239this:
240
241\begin{verbatim}
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000242class C(object):
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000243 def f(arg1, arg2):
244 ...
245 f = staticmethod(f)
246
247 def g(cls, arg1, arg2):
248 ...
249 g = classmethod(g)
250\end{verbatim}
251
252The \function{staticmethod()} function takes the function
253\function{f}, and returns it wrapped up in a descriptor so it can be
254stored in the class object. You might expect there to be special
255syntax for creating such methods (\code{def static f()},
256\code{defstatic f()}, or something like that) but no such syntax has
257been defined yet; that's been left for future versions.
258
259More new features, such as slots and properties, are also implemented
260as new kinds of descriptors, and it's not difficult to write a
261descriptor class that does something novel. For example, it would be
262possible to write a descriptor class that made it possible to write
263Eiffel-style preconditions and postconditions for a method. A class
264that used this feature might be defined like this:
265
266\begin{verbatim}
267from eiffel import eiffelmethod
268
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000269class C(object):
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000270 def f(self, arg1, arg2):
271 # The actual function
272 def pre_f(self):
273 # Check preconditions
274 def post_f(self):
275 # Check postconditions
276
277 f = eiffelmethod(f, pre_f, post_f)
278\end{verbatim}
279
280Note that a person using the new \function{eiffelmethod()} doesn't
281have to understand anything about descriptors. This is why I think
282the new features don't increase the basic complexity of the language.
283There will be a few wizards who need to know about it in order to
284write \function{eiffelmethod()} or the ZODB or whatever, but most
285users will just write code on top of the resulting libraries and
286ignore the implementation details.
287
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000288\subsection{Multiple Inheritance: The Diamond Rule}
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000289
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000290Multiple inheritance has also been made more useful through changing
291the rules under which names are resolved. Consider this set of classes
292(diagram taken from \pep{253} by Guido van Rossum):
293
294\begin{verbatim}
295 class A:
296 ^ ^ def save(self): ...
297 / \
298 / \
299 / \
300 / \
301 class B class C:
302 ^ ^ def save(self): ...
303 \ /
304 \ /
305 \ /
306 \ /
307 class D
308\end{verbatim}
309
310The lookup rule for classic classes is simple but not very smart; the
311base classes are searched depth-first, going from left to right. A
312reference to \method{D.save} will search the classes \class{D},
313\class{B}, and then \class{A}, where \method{save()} would be found
314and returned. \method{C.save()} would never be found at all. This is
315bad, because if \class{C}'s \method{save()} method is saving some
316internal state specific to \class{C}, not calling it will result in
317that state never getting saved.
318
319New-style classes follow a different algorithm that's a bit more
320complicated to explain, but does the right thing in this situation.
321
322\begin{enumerate}
323
324\item List all the base classes, following the classic lookup rule and
325include a class multiple times if it's visited repeatedly. In the
326above example, the list of visited classes is [\class{D}, \class{B},
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000327\class{A}, \class{C}, \class{A}].
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000328
329\item Scan the list for duplicated classes. If any are found, remove
330all but one occurrence, leaving the \emph{last} one in the list. In
331the above example, the list becomes [\class{D}, \class{B}, \class{C},
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000332\class{A}] after dropping duplicates.
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000333
334\end{enumerate}
335
336Following this rule, referring to \method{D.save()} will return
337\method{C.save()}, which is the behaviour we're after. This lookup
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000338rule is the same as the one followed by Common Lisp.
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000339
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000340% XXX mention super()
341
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000342
343\subsection{Attribute Access}
344
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000345A fair number of sophisticated Python classes define hooks for
346attribute access using \method{__getattr__}; most commonly this is
347done for convenience, to make code more readable by automatically
348mapping an attribute access such as \code{obj.parent} into a method
349call such as \code{obj.get_parent()}. Python 2.2 adds some new ways
350of controlling attribute access.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000351
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000352First, \method{__getattr__(\var{attr_name})} is still supported by
353new-style classes, and nothing about it has changed. As before, it
354will be called when an attempt is made to access \code{obj.foo} and no
355attribute named \samp{foo} is found in the instance's dictionary.
356
357New-style classes also support a new method,
358\method{__getattribute__(\var{attr_name})}. The difference between
359the two methods is that \method{__getattribute__} is \emph{always}
360called whenever any attribute is accessed, while the old
361\method{__getattr__} is only called if \samp{foo} isn't found in the
362instance's dictionary.
363
364However, Python 2.2's support for \dfn{properties} will often be a
365simpler way to trap attribute references. Writing a
366\method{__getattr__} method is complicated because to avoid recursion
367you can't use regular attribute accesses inside them, and instead have
368to mess around with the contents of \member{__dict__}.
369\method{__getattr__} methods also end up being called by Python when
370it checks for other methods such as \method{__repr__} or
371\method{__coerce__}, and so have to be written with this in mind.
372Finally, calling a function on every attribute access results in a
373sizable performance loss.
374
375\class{property} is a new built-in type that packages up three
376functions that get, set, or delete an attribute, and a docstring. For
377example, if you want to define a \member{size} attribute that's
378computed, but also settable, you could write:
379
380\begin{verbatim}
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000381class C(object):
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000382 def get_size (self):
383 result = ... computation ...
384 return result
385 def set_size (self, size):
386 ... compute something based on the size
387 and set internal state appropriately ...
388
389 # Define a property. The 'delete this attribute'
390 # method is defined as None, so the attribute
391 # can't be deleted.
392 size = property(get_size, set_size,
393 None,
394 "Storage size of this instance")
395\end{verbatim}
396
397That is certainly clearer and easier to write than a pair of
398\method{__getattr__}/\method{__setattr__} methods that check for the
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000399\member{size} attribute and handle it specially while retrieving all
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000400other attributes from the instance's \member{__dict__}. Accesses to
401\member{size} are also the only ones which have to perform the work of
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000402calling a function, so references to other attributes run at
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000403their usual speed.
404
405Finally, it's possible to constrain the list of attributes that can be
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000406referenced on an object using the new \member{__slots__} class attribute.
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000407Python objects are usually very dynamic; at any time it's possible to
408define a new attribute on an instance by just doing
409\code{obj.new_attr=1}. This is flexible and convenient, but this
410flexibility can also lead to bugs, as when you meant to write
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000411\code{obj.template = 'a'} but made a typo and wrote
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000412\code{obj.templtae} by accident.
413
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000414A new-style class can define a class attribute named \member{__slots__}
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000415to constrain the list of legal attribute names. An example will make
416this clear:
417
418\begin{verbatim}
419>>> class C(object):
420... __slots__ = ['template', 'name']
421...
422>>> obj = C()
423>>> print obj.template
424None
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000425>>> obj.template = 'Test'
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000426>>> print obj.template
427Test
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000428>>> obj.templtae = None
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000429Traceback (most recent call last):
430 File "<stdin>", line 1, in ?
431AttributeError: 'C' object has no attribute 'templtae'
432\end{verbatim}
433
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000434Note how you get an \exception{AttributeError} on the attempt to
435assign to an attribute not listed in \member{__slots__}.
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000436
437
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000438\subsection{Related Links}
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000439\label{sect-rellinks}
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000440
441This section has just been a quick overview of the new features,
442giving enough of an explanation to start you programming, but many
443details have been simplified or ignored. Where should you go to get a
444more complete picture?
445
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000446\url{http://www.python.org/2.2/descrintro.html} is a lengthy tutorial
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000447introduction to the descriptor features, written by Guido van Rossum.
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000448If my description has whetted your appetite, go read this tutorial
449next, because it goes into much more detail about the new features
450while still remaining quite easy to read.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000451
452Next, there are two relevant PEPs, \pep{252} and \pep{253}. \pep{252}
453is titled "Making Types Look More Like Classes", and covers the
454descriptor API. \pep{253} is titled "Subtyping Built-in Types", and
455describes the changes to type objects that make it possible to subtype
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000456built-in objects. \pep{253} is the more complicated PEP of the two,
457and at a few points the necessary explanations of types and meta-types
458may cause your head to explode. Both PEPs were written and
459implemented by Guido van Rossum, with substantial assistance from the
460rest of the Zope Corp. team.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000461
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000462Finally, there's the ultimate authority: the source code. Most of the
463machinery for the type handling is in \file{Objects/typeobject.c}, but
464you should only resort to it after all other avenues have been
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000465exhausted, including posting a question to python-list or python-dev.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000466
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000467
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000468%======================================================================
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000469\section{PEP 234: Iterators}
470
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000471Another significant addition to 2.2 is an iteration interface at both
472the C and Python levels. Objects can define how they can be looped
473over by callers.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000474
475In Python versions up to 2.1, the usual way to make \code{for item in
476obj} work is to define a \method{__getitem__()} method that looks
477something like this:
478
479\begin{verbatim}
480 def __getitem__(self, index):
481 return <next item>
482\end{verbatim}
483
484\method{__getitem__()} is more properly used to define an indexing
485operation on an object so that you can write \code{obj[5]} to retrieve
Andrew M. Kuchling8c69c912001-08-07 14:28:58 +0000486the sixth element. It's a bit misleading when you're using this only
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000487to support \keyword{for} loops. Consider some file-like object that
488wants to be looped over; the \var{index} parameter is essentially
489meaningless, as the class probably assumes that a series of
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000490\method{__getitem__()} calls will be made with \var{index}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000491incrementing by one each time. In other words, the presence of the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000492\method{__getitem__()} method doesn't mean that using \code{file[5]}
493to randomly access the sixth element will work, though it really should.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000494
495In Python 2.2, iteration can be implemented separately, and
496\method{__getitem__()} methods can be limited to classes that really
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000497do support random access. The basic idea of iterators is
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000498simple. A new built-in function, \function{iter(obj)} or
499\code{iter(\var{C}, \var{sentinel})}, is used to get an iterator.
500\function{iter(obj)} returns an iterator for the object \var{obj},
501while \code{iter(\var{C}, \var{sentinel})} returns an iterator that
502will invoke the callable object \var{C} until it returns
503\var{sentinel} to signal that the iterator is done.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000504
505Python classes can define an \method{__iter__()} method, which should
506create and return a new iterator for the object; if the object is its
507own iterator, this method can just return \code{self}. In particular,
508iterators will usually be their own iterators. Extension types
509implemented in C can implement a \code{tp_iter} function in order to
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000510return an iterator, and extension types that want to behave as
511iterators can define a \code{tp_iternext} function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000512
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000513So, after all this, what do iterators actually do? They have one
514required method, \method{next()}, which takes no arguments and returns
515the next value. When there are no more values to be returned, calling
516\method{next()} should raise the \exception{StopIteration} exception.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000517
518\begin{verbatim}
519>>> L = [1,2,3]
520>>> i = iter(L)
521>>> print i
522<iterator object at 0x8116870>
523>>> i.next()
5241
525>>> i.next()
5262
527>>> i.next()
5283
529>>> i.next()
530Traceback (most recent call last):
531 File "<stdin>", line 1, in ?
532StopIteration
533>>>
534\end{verbatim}
535
536In 2.2, Python's \keyword{for} statement no longer expects a sequence;
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000537it expects something for which \function{iter()} will return an iterator.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000538For backward compatibility and convenience, an iterator is
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000539automatically constructed for sequences that don't implement
540\method{__iter__()} or a \code{tp_iter} slot, so \code{for i in
541[1,2,3]} will still work. Wherever the Python interpreter loops over
542a sequence, it's been changed to use the iterator protocol. This
543means you can do things like this:
544
545\begin{verbatim}
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000546>>> L = [1,2,3]
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000547>>> i = iter(L)
548>>> a,b,c = i
549>>> a,b,c
550(1, 2, 3)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000551\end{verbatim}
552
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000553Iterator support has been added to some of Python's basic types.
Fred Drake0d002542001-07-17 13:55:33 +0000554Calling \function{iter()} on a dictionary will return an iterator
Andrew M. Kuchling6ea9f0b2001-07-17 14:50:31 +0000555which loops over its keys:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000556
557\begin{verbatim}
558>>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
559... 'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
560>>> for key in m: print key, m[key]
561...
562Mar 3
563Feb 2
564Aug 8
565Sep 9
566May 5
567Jun 6
568Jul 7
569Jan 1
570Apr 4
571Nov 11
572Dec 12
573Oct 10
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000574\end{verbatim}
575
576That's just the default behaviour. If you want to iterate over keys,
577values, or key/value pairs, you can explicitly call the
578\method{iterkeys()}, \method{itervalues()}, or \method{iteritems()}
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000579methods to get an appropriate iterator. In a minor related change,
580the \keyword{in} operator now works on dictionaries, so
581\code{\var{key} in dict} is now equivalent to
582\code{dict.has_key(\var{key})}.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000583
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000584Files also provide an iterator, which calls the \method{readline()}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000585method until there are no more lines in the file. This means you can
586now read each line of a file using code like this:
587
588\begin{verbatim}
589for line in file:
590 # do something for each line
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000591 ...
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000592\end{verbatim}
593
594Note that you can only go forward in an iterator; there's no way to
595get the previous element, reset the iterator, or make a copy of it.
Fred Drake0d002542001-07-17 13:55:33 +0000596An iterator object could provide such additional capabilities, but the
597iterator protocol only requires a \method{next()} method.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000598
599\begin{seealso}
600
601\seepep{234}{Iterators}{Written by Ka-Ping Yee and GvR; implemented
602by the Python Labs crew, mostly by GvR and Tim Peters.}
603
604\end{seealso}
605
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000606
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000607%======================================================================
608\section{PEP 255: Simple Generators}
609
610Generators are another new feature, one that interacts with the
611introduction of iterators.
612
613You're doubtless familiar with how function calls work in Python or
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000614C. When you call a function, it gets a private namespace where its local
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000615variables are created. When the function reaches a \keyword{return}
616statement, the local variables are destroyed and the resulting value
617is returned to the caller. A later call to the same function will get
618a fresh new set of local variables. But, what if the local variables
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000619weren't thrown away on exiting a function? What if you could later
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000620resume the function where it left off? This is what generators
621provide; they can be thought of as resumable functions.
622
623Here's the simplest example of a generator function:
624
625\begin{verbatim}
626def generate_ints(N):
627 for i in range(N):
628 yield i
629\end{verbatim}
630
631A new keyword, \keyword{yield}, was introduced for generators. Any
632function containing a \keyword{yield} statement is a generator
633function; this is detected by Python's bytecode compiler which
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000634compiles the function specially as a result. Because a new keyword was
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000635introduced, generators must be explicitly enabled in a module by
636including a \code{from __future__ import generators} statement near
637the top of the module's source code. In Python 2.3 this statement
638will become unnecessary.
639
640When you call a generator function, it doesn't return a single value;
641instead it returns a generator object that supports the iterator
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000642protocol. On executing the \keyword{yield} statement, the generator
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000643outputs the value of \code{i}, similar to a \keyword{return}
644statement. The big difference between \keyword{yield} and a
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000645\keyword{return} statement is that on reaching a \keyword{yield} the
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000646generator's state of execution is suspended and local variables are
647preserved. On the next call to the generator's \code{.next()} method,
648the function will resume executing immediately after the
649\keyword{yield} statement. (For complicated reasons, the
650\keyword{yield} statement isn't allowed inside the \keyword{try} block
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000651of a \code{try...finally} statement; read \pep{255} for a full
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000652explanation of the interaction between \keyword{yield} and
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000653exceptions.)
654
655Here's a sample usage of the \function{generate_ints} generator:
656
657\begin{verbatim}
658>>> gen = generate_ints(3)
659>>> gen
660<generator object at 0x8117f90>
661>>> gen.next()
6620
663>>> gen.next()
6641
665>>> gen.next()
6662
667>>> gen.next()
668Traceback (most recent call last):
669 File "<stdin>", line 1, in ?
670 File "<stdin>", line 2, in generate_ints
671StopIteration
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000672\end{verbatim}
673
674You could equally write \code{for i in generate_ints(5)}, or
675\code{a,b,c = generate_ints(3)}.
676
677Inside a generator function, the \keyword{return} statement can only
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000678be used without a value, and signals the end of the procession of
679values; afterwards the generator cannot return any further values.
680\keyword{return} with a value, such as \code{return 5}, is a syntax
681error inside a generator function. The end of the generator's results
682can also be indicated by raising \exception{StopIteration} manually,
683or by just letting the flow of execution fall off the bottom of the
684function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000685
686You could achieve the effect of generators manually by writing your
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000687own class and storing all the local variables of the generator as
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000688instance variables. For example, returning a list of integers could
689be done by setting \code{self.count} to 0, and having the
690\method{next()} method increment \code{self.count} and return it.
Andrew M. Kuchlingc32cc7c2001-07-17 18:25:01 +0000691However, for a moderately complicated generator, writing a
692corresponding class would be much messier.
693\file{Lib/test/test_generators.py} contains a number of more
694interesting examples. The simplest one implements an in-order
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000695traversal of a tree using generators recursively.
696
697\begin{verbatim}
698# A recursive generator that generates Tree leaves in in-order.
699def inorder(t):
700 if t:
701 for x in inorder(t.left):
702 yield x
703 yield t.label
704 for x in inorder(t.right):
705 yield x
706\end{verbatim}
707
708Two other examples in \file{Lib/test/test_generators.py} produce
709solutions for the N-Queens problem (placing $N$ queens on an $NxN$
710chess board so that no queen threatens another) and the Knight's Tour
711(a route that takes a knight to every square of an $NxN$ chessboard
712without visiting any square twice).
713
714The idea of generators comes from other programming languages,
715especially Icon (\url{http://www.cs.arizona.edu/icon/}), where the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000716idea of generators is central. In Icon, every
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000717expression and function call behaves like a generator. One example
718from ``An Overview of the Icon Programming Language'' at
719\url{http://www.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of
720what this looks like:
721
722\begin{verbatim}
723sentence := "Store it in the neighboring harbor"
724if (i := find("or", sentence)) > 5 then write(i)
725\end{verbatim}
726
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000727In Icon the \function{find()} function returns the indexes at which the
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000728substring ``or'' is found: 3, 23, 33. In the \keyword{if} statement,
729\code{i} is first assigned a value of 3, but 3 is less than 5, so the
730comparison fails, and Icon retries it with the second value of 23. 23
731is greater than 5, so the comparison now succeeds, and the code prints
732the value 23 to the screen.
733
734Python doesn't go nearly as far as Icon in adopting generators as a
735central concept. Generators are considered a new part of the core
736Python language, but learning or using them isn't compulsory; if they
737don't solve any problems that you have, feel free to ignore them.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000738One novel feature of Python's interface as compared to
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000739Icon's is that a generator's state is represented as a concrete object
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000740(the iterator) that can be passed around to other functions or stored
741in a data structure.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000742
743\begin{seealso}
744
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000745\seepep{255}{Simple Generators}{Written by Neil Schemenauer, Tim
746Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
747and Tim Peters, with other fixes from the Python Labs crew.}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000748
749\end{seealso}
750
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000751
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000752%======================================================================
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000753\section{PEP 237: Unifying Long Integers and Integers}
754
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000755In recent versions, the distinction between regular integers, which
756are 32-bit values on most machines, and long integers, which can be of
757arbitrary size, was becoming an annoyance. For example, on platforms
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000758that support files larger than \code{2**32} bytes, the
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000759\method{tell()} method of file objects has to return a long integer.
760However, there were various bits of Python that expected plain
761integers and would raise an error if a long integer was provided
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +0000762instead. For example, in Python 1.5, only regular integers
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000763could be used as a slice index, and \code{'abc'[1L:]} would raise a
764\exception{TypeError} exception with the message 'slice index must be
765int'.
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000766
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000767Python 2.2 will shift values from short to long integers as required.
768The 'L' suffix is no longer needed to indicate a long integer literal,
769as now the compiler will choose the appropriate type. (Using the 'L'
770suffix will be discouraged in future 2.x versions of Python,
771triggering a warning in Python 2.4, and probably dropped in Python
7723.0.) Many operations that used to raise an \exception{OverflowError}
773will now return a long integer as their result. For example:
774
775\begin{verbatim}
776>>> 1234567890123
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00007771234567890123L
778>>> 2 ** 64
77918446744073709551616L
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000780\end{verbatim}
781
782In most cases, integers and long integers will now be treated
783identically. You can still distinguish them with the
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000784\function{type()} built-in function, but that's rarely needed.
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000785
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000786\begin{seealso}
787
788\seepep{237}{Unifying Long Integers and Integers}{Written by
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000789Moshe Zadka and Guido van Rossum. Implemented mostly by Guido van
790Rossum.}
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000791
792\end{seealso}
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000793
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +0000794
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000795%======================================================================
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000796\section{PEP 238: Changing the Division Operator}
797
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000798The most controversial change in Python 2.2 heralds the start of an effort
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000799to fix an old design flaw that's been in Python from the beginning.
800Currently Python's division operator, \code{/}, behaves like C's
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000801division operator when presented with two integer arguments: it
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000802returns an integer result that's truncated down when there would be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000803a fractional part. For example, \code{3/2} is 1, not 1.5, and
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000804\code{(-1)/2} is -1, not -0.5. This means that the results of divison
805can vary unexpectedly depending on the type of the two operands and
806because Python is dynamically typed, it can be difficult to determine
807the possible types of the operands.
808
809(The controversy is over whether this is \emph{really} a design flaw,
810and whether it's worth breaking existing code to fix this. It's
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000811caused endless discussions on python-dev, and in July 2001 erupted into an
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000812storm of acidly sarcastic postings on \newsgroup{comp.lang.python}. I
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000813won't argue for either side here and will stick to describing what's
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000814implemented in 2.2. Read \pep{238} for a summary of arguments and
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000815counter-arguments.)
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000816
817Because this change might break code, it's being introduced very
818gradually. Python 2.2 begins the transition, but the switch won't be
819complete until Python 3.0.
820
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000821First, I'll borrow some terminology from \pep{238}. ``True division'' is the
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000822division that most non-programmers are familiar with: 3/2 is 1.5, 1/4
823is 0.25, and so forth. ``Floor division'' is what Python's \code{/}
824operator currently does when given integer operands; the result is the
825floor of the value returned by true division. ``Classic division'' is
826the current mixed behaviour of \code{/}; it returns the result of
827floor division when the operands are integers, and returns the result
828of true division when one of the operands is a floating-point number.
829
830Here are the changes 2.2 introduces:
831
832\begin{itemize}
833
834\item A new operator, \code{//}, is the floor division operator.
835(Yes, we know it looks like \Cpp's comment symbol.) \code{//}
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000836\emph{always} performs floor division no matter what the types of
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000837its operands are, so \code{1 // 2} is 0 and \code{1.0 // 2.0} is also
8380.0.
839
840\code{//} is always available in Python 2.2; you don't need to enable
841it using a \code{__future__} statement.
842
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +0000843\item By including a \code{from __future__ import division} in a
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000844module, the \code{/} operator will be changed to return the result of
845true division, so \code{1/2} is 0.5. Without the \code{__future__}
846statement, \code{/} still means classic division. The default meaning
847of \code{/} will not change until Python 3.0.
848
849\item Classes can define methods called \method{__truediv__} and
850\method{__floordiv__} to overload the two division operators. At the
851C level, there are also slots in the \code{PyNumberMethods} structure
852so extension types can define the two operators.
853
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000854\item Python 2.2 supports some command-line arguments for testing
855whether code will works with the changed division semantics. Running
856python with \programopt{-Q warn} will cause a warning to be issued
857whenever division is applied to two integers. You can use this to
858find code that's affected by the change and fix it. By default,
859Python 2.2 will simply perform classic division without a warning; the
860warning will be turned on by default in Python 2.3.
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000861
862\end{itemize}
863
864\begin{seealso}
865
866\seepep{238}{Changing the Division Operator}{Written by Moshe Zadka and
867Guido van Rossum. Implemented by Guido van Rossum..}
868
869\end{seealso}
870
871
872%======================================================================
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000873\section{Unicode Changes}
874
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000875Python's Unicode support has been enhanced a bit in 2.2. Unicode
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000876strings are usually stored as UCS-2, as 16-bit unsigned integers.
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000877Python 2.2 can also be compiled to use UCS-4, 32-bit unsigned
878integers, as its internal encoding by supplying
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000879\longprogramopt{enable-unicode=ucs4} to the configure script.
880(It's also possible to specify
881\longprogramopt{disable-unicode} to completely disable Unicode
882support.)
883
884When built to use UCS-4 (a ``wide Python''), the interpreter can
885natively handle Unicode characters from U+000000 to U+110000, so the
886range of legal values for the \function{unichr()} function is expanded
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000887accordingly. Using an interpreter compiled to use UCS-2 (a ``narrow
888Python''), values greater than 65535 will still cause
889\function{unichr()} to raise a \exception{ValueError} exception.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000890This is all described in \pep{261}, ``Support for `wide' Unicode
891characters''; consult it for further details.
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000892
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000893Another change is simpler to explain. Since their introduction,
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000894Unicode strings have supported an \method{encode()} method to convert
895the string to a selected encoding such as UTF-8 or Latin-1. A
896symmetric \method{decode(\optional{\var{encoding}})} method has been
897added to 8-bit strings (though not to Unicode strings) in 2.2.
898\method{decode()} assumes that the string is in the specified encoding
899and decodes it, returning whatever is returned by the codec.
900
901Using this new feature, codecs have been added for tasks not directly
902related to Unicode. For example, codecs have been added for
903uu-encoding, MIME's base64 encoding, and compression with the
904\module{zlib} module:
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000905
906\begin{verbatim}
907>>> s = """Here is a lengthy piece of redundant, overly verbose,
908... and repetitive text.
909... """
910>>> data = s.encode('zlib')
911>>> data
912'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
913>>> data.decode('zlib')
914'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
915>>> print s.encode('uu')
916begin 666 <data>
917M2&5R92!I<R!A(&QE;F=T:'D@<&EE8V4@;V8@<F5D=6YD86YT+"!O=F5R;'D@
918>=F5R8F]S92P*86YD(')E<&5T:71I=F4@=&5X="X*
919
920end
921>>> "sheesh".encode('rot-13')
922'furrfu'
923\end{verbatim}
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000924
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000925To convert a class instance to Unicode, a \method{__unicode__} method
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000926can be defined by a class, analogous to \method{__str__}.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000927
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000928\method{encode()}, \method{decode()}, and \method{__unicode__} were
929implemented by Marc-Andr\'e Lemburg. The changes to support using
930UCS-4 internally were implemented by Fredrik Lundh and Martin von
931L\"owis.
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000932
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000933\begin{seealso}
934
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000935\seepep{261}{Support for `wide' Unicode characters}{Written by
936Paul Prescod.}
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000937
938\end{seealso}
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000939
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000940
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000941%======================================================================
942\section{PEP 227: Nested Scopes}
943
944In Python 2.1, statically nested scopes were added as an optional
945feature, to be enabled by a \code{from __future__ import
946nested_scopes} directive. In 2.2 nested scopes no longer need to be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000947specially enabled, and are now always present. The rest of this section
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000948is a copy of the description of nested scopes from my ``What's New in
949Python 2.1'' document; if you read it when 2.1 came out, you can skip
950the rest of this section.
951
952The largest change introduced in Python 2.1, and made complete in 2.2,
953is to Python's scoping rules. In Python 2.0, at any given time there
954are at most three namespaces used to look up variable names: local,
955module-level, and the built-in namespace. This often surprised people
956because it didn't match their intuitive expectations. For example, a
957nested recursive function definition doesn't work:
958
959\begin{verbatim}
960def f():
961 ...
962 def g(value):
963 ...
964 return g(value-1) + 1
965 ...
966\end{verbatim}
967
968The function \function{g()} will always raise a \exception{NameError}
969exception, because the binding of the name \samp{g} isn't in either
970its local namespace or in the module-level namespace. This isn't much
971of a problem in practice (how often do you recursively define interior
972functions like this?), but this also made using the \keyword{lambda}
973statement clumsier, and this was a problem in practice. In code which
974uses \keyword{lambda} you can often find local variables being copied
975by passing them as the default values of arguments.
976
977\begin{verbatim}
978def find(self, name):
979 "Return list of any entries equal to 'name'"
980 L = filter(lambda x, name=name: x == name,
981 self.list_attribute)
982 return L
983\end{verbatim}
984
985The readability of Python code written in a strongly functional style
986suffers greatly as a result.
987
988The most significant change to Python 2.2 is that static scoping has
989been added to the language to fix this problem. As a first effect,
990the \code{name=name} default argument is now unnecessary in the above
991example. Put simply, when a given variable name is not assigned a
992value within a function (by an assignment, or the \keyword{def},
993\keyword{class}, or \keyword{import} statements), references to the
994variable will be looked up in the local namespace of the enclosing
995scope. A more detailed explanation of the rules, and a dissection of
996the implementation, can be found in the PEP.
997
998This change may cause some compatibility problems for code where the
999same variable name is used both at the module level and as a local
1000variable within a function that contains further function definitions.
1001This seems rather unlikely though, since such code would have been
1002pretty confusing to read in the first place.
1003
1004One side effect of the change is that the \code{from \var{module}
1005import *} and \keyword{exec} statements have been made illegal inside
1006a function scope under certain conditions. The Python reference
1007manual has said all along that \code{from \var{module} import *} is
1008only legal at the top level of a module, but the CPython interpreter
1009has never enforced this before. As part of the implementation of
1010nested scopes, the compiler which turns Python source into bytecodes
1011has to generate different code to access variables in a containing
1012scope. \code{from \var{module} import *} and \keyword{exec} make it
1013impossible for the compiler to figure this out, because they add names
1014to the local namespace that are unknowable at compile time.
1015Therefore, if a function contains function definitions or
1016\keyword{lambda} expressions with free variables, the compiler will
1017flag this by raising a \exception{SyntaxError} exception.
1018
1019To make the preceding explanation a bit clearer, here's an example:
1020
1021\begin{verbatim}
1022x = 1
1023def f():
1024 # The next line is a syntax error
1025 exec 'x=2'
1026 def g():
1027 return x
1028\end{verbatim}
1029
1030Line 4 containing the \keyword{exec} statement is a syntax error,
1031since \keyword{exec} would define a new local variable named \samp{x}
1032whose value should be accessed by \function{g()}.
1033
1034This shouldn't be much of a limitation, since \keyword{exec} is rarely
1035used in most Python code (and when it is used, it's often a sign of a
1036poor design anyway).
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001037
1038\begin{seealso}
1039
1040\seepep{227}{Statically Nested Scopes}{Written and implemented by
1041Jeremy Hylton.}
1042
1043\end{seealso}
1044
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +00001045
1046%======================================================================
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001047\section{New and Improved Modules}
1048
1049\begin{itemize}
1050
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001051 \item The \module{xmlrpclib} module was contributed to the standard
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001052 library by Fredrik Lundh, provding support for writing XML-RPC
1053 clients. XML-RPC is a simple remote procedure call protocol built on
Andrew M. Kuchling8c69c912001-08-07 14:28:58 +00001054 top of HTTP and XML. For example, the following snippet retrieves a
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001055 list of RSS channels from the O'Reilly Network, and then
1056 lists the recent headlines for one channel:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001057
1058\begin{verbatim}
1059import xmlrpclib
1060s = xmlrpclib.Server(
1061 'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
1062channels = s.meerkat.getChannels()
1063# channels is a list of dictionaries, like this:
1064# [{'id': 4, 'title': 'Freshmeat Daily News'}
1065# {'id': 190, 'title': '32Bits Online'},
1066# {'id': 4549, 'title': '3DGamers'}, ... ]
1067
1068# Get the items for one channel
1069items = s.meerkat.getItems( {'channel': 4} )
1070
1071# 'items' is another list of dictionaries, like this:
1072# [{'link': 'http://freshmeat.net/releases/52719/',
1073# 'description': 'A utility which converts HTML to XSL FO.',
1074# 'title': 'html2fo 0.3 (Default)'}, ... ]
1075\end{verbatim}
1076
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001077The \module{SimpleXMLRPCServer} module makes it easy to create
1078straightforward XML-RPC servers. See \url{http://www.xmlrpc.com/} for
1079more information about XML-RPC.
1080
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001081 \item The new \module{hmac} module implements the HMAC
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001082 algorithm described by \rfc{2104}.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001083 (Contributed by Gerhard H\"aring.)
1084
1085 \item Several functions that originally returned lengthy tuples now
1086 return pseudo-sequences that still behave like tuples but also have
1087 mnemonic attributes such as member{st_mtime} or \member{tm_year}.
1088 The enhanced functions include \function{stat()},
1089 \function{fstat()}, \function{statvfs()}, and \function{fstatvfs()}
1090 in the \module{os} module, and \function{localtime()},
1091 \function{gmtime()}, and \function{strptime()} in the \module{time}
1092 module.
1093
1094 For example, to obtain a file's size using the old tuples, you'd end
1095 up writing something like \code{file_size =
1096 os.stat(filename)[stat.ST_SIZE]}, but now this can be written more
1097 clearly as \code{file_size = os.stat(filename).st_size}.
1098
1099 The original patch for this feature was contributed by Nick Mathewson.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001100
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001101 \item The Python profiler has been extensively reworked and various
1102 errors in its output have been corrected. (Contributed by Fred
1103 Fred~L. Drake, Jr. and Tim Peters.)
1104
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001105 \item The \module{socket} module can be compiled to support IPv6;
Andrew M. Kuchlingddeb1352001-07-16 14:35:52 +00001106 specify the \longprogramopt{enable-ipv6} option to Python's configure
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001107 script. (Contributed by Jun-ichiro ``itojun'' Hagino.)
1108
1109 \item Two new format characters were added to the \module{struct}
1110 module for 64-bit integers on platforms that support the C
1111 \ctype{long long} type. \samp{q} is for a signed 64-bit integer,
1112 and \samp{Q} is for an unsigned one. The value is returned in
1113 Python's long integer type. (Contributed by Tim Peters.)
1114
1115 \item In the interpreter's interactive mode, there's a new built-in
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001116 function \function{help()} that uses the \module{pydoc} module
1117 introduced in Python 2.1 to provide interactive help.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001118 \code{help(\var{object})} displays any available help text about
1119 \var{object}. \code{help()} with no argument puts you in an online
1120 help utility, where you can enter the names of functions, classes,
1121 or modules to read their help text.
1122 (Contributed by Guido van Rossum, using Ka-Ping Yee's \module{pydoc} module.)
1123
1124 \item Various bugfixes and performance improvements have been made
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001125 to the SRE engine underlying the \module{re} module. For example,
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001126 the \function{re.sub()} and \function{re.split()} functions have
1127 been rewritten in C. Another contributed patch speeds up certain
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001128 Unicode character ranges by a factor of two, and a new \method{finditer()}
1129 method that returns an iterator over all the non-overlapping matches in
1130 a given string.
1131 (SRE is maintained by
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001132 Fredrik Lundh. The BIGCHARSET patch was contributed by Martin von
1133 L\"owis.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001134
Andrew M. Kuchling1efd7ad2001-09-14 16:19:27 +00001135 \item The \module{smtplib} module now supports \rfc{2487}, ``Secure
1136 SMTP over TLS'', so it's now possible to encrypt the SMTP traffic
1137 between a Python program and the mail transport agent being handed a
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001138 message. \module{smtplib} also supports SMTP authentication.
1139 (Contributed by Gerhard H\"aring.)
Andrew M. Kuchling1efd7ad2001-09-14 16:19:27 +00001140
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +00001141 \item The \module{imaplib} module, maintained by Piers Lauder, has
1142 support for several new extensions: the NAMESPACE extension defined
1143 in \rfc{2342}, SORT, GETACL and SETACL. (Contributed by Anthony
1144 Baxter and Michel Pelletier.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001145
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001146 % XXX should the 'email' module get a section of its own?
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001147 \item The \module{rfc822} module's parsing of email addresses is now
1148 compliant with \rfc{2822}, an update to \rfc{822}. (The module's
1149 name is \emph{not} going to be changed to \samp{rfc2822}.) A new
1150 package, \module{email}, has also been added for parsing and
1151 generating e-mail messages. (Contributed by Barry Warsaw, and
1152 arising out of his work on Mailman.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001153
Andrew M. Kuchlingbbde5882001-10-31 13:13:36 +00001154 \item The \module{difflib} module now contains a new \class{Differ}
1155 class for producing human-readable lists of changes (a ``delta'')
1156 between two sequences of lines of text. There are also two
1157 generator functions, \function{ndiff()} and \function{restore()},
1158 which respectively return a delta from two sequences, or one of the
1159 original sequences from a delta. (Grunt work contributed by David
1160 Goodger, from ndiff.py code by Tim Peters who then did the
1161 generatorization.)
1162
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001163 \item New constants \constant{ascii_letters},
1164 \constant{ascii_lowercase}, and \constant{ascii_uppercase} were
1165 added to the \module{string} module. There were several modules in
1166 the standard library that used \constant{string.letters} to mean the
1167 ranges A-Za-z, but that assumption is incorrect when locales are in
1168 use, because \constant{string.letters} varies depending on the set
1169 of legal characters defined by the current locale. The buggy
1170 modules have all been fixed to use \constant{ascii_letters} instead.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001171 (Reported by an unknown person; fixed by Fred~L. Drake, Jr.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001172
Andrew M. Kuchling8c69c912001-08-07 14:28:58 +00001173 \item The \module{mimetypes} module now makes it easier to use
1174 alternative MIME-type databases by the addition of a
1175 \class{MimeTypes} class, which takes a list of filenames to be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001176 parsed. (Contributed by Fred~L. Drake, Jr.)
Andrew M. Kuchling8c69c912001-08-07 14:28:58 +00001177
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001178 \item A \class{Timer} class was added to the \module{threading}
1179 module that allows scheduling an activity to happen at some future
1180 time. (Contributed by Itamar Shtull-Trauring.)
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +00001181
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001182\end{itemize}
1183
1184
1185%======================================================================
1186\section{Interpreter Changes and Fixes}
1187
1188Some of the changes only affect people who deal with the Python
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001189interpreter at the C level because they're writing Python extension modules,
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001190embedding the interpreter, or just hacking on the interpreter itself.
1191If you only write Python code, none of the changes described here will
1192affect you very much.
1193
1194\begin{itemize}
1195
1196 \item Profiling and tracing functions can now be implemented in C,
1197 which can operate at much higher speeds than Python-based functions
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001198 and should reduce the overhead of profiling and tracing. This
1199 will be of interest to authors of development environments for
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001200 Python. Two new C functions were added to Python's API,
1201 \cfunction{PyEval_SetProfile()} and \cfunction{PyEval_SetTrace()}.
1202 The existing \function{sys.setprofile()} and
1203 \function{sys.settrace()} functions still exist, and have simply
1204 been changed to use the new C-level interface. (Contributed by Fred
1205 L. Drake, Jr.)
1206
1207 \item Another low-level API, primarily of interest to implementors
1208 of Python debuggers and development tools, was added.
1209 \cfunction{PyInterpreterState_Head()} and
1210 \cfunction{PyInterpreterState_Next()} let a caller walk through all
1211 the existing interpreter objects;
1212 \cfunction{PyInterpreterState_ThreadHead()} and
1213 \cfunction{PyThreadState_Next()} allow looping over all the thread
1214 states for a given interpreter. (Contributed by David Beazley.)
1215
1216 \item A new \samp{et} format sequence was added to
1217 \cfunction{PyArg_ParseTuple}; \samp{et} takes both a parameter and
1218 an encoding name, and converts the parameter to the given encoding
1219 if the parameter turns out to be a Unicode string, or leaves it
1220 alone if it's an 8-bit string, assuming it to already be in the
1221 desired encoding. This differs from the \samp{es} format character,
1222 which assumes that 8-bit strings are in Python's default ASCII
1223 encoding and converts them to the specified new encoding.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001224 (Contributed by M.-A. Lemburg, and used for the MBCS support on
1225 Windows described in the following section.)
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +00001226
1227 \item A different argument parsing function,
1228 \cfunction{PyArg_UnpackTuple()}, has been added that's simpler and
1229 presumably faster. Instead of specifying a format string, the
1230 caller simply gives the minimum and maximum number of arguments
1231 expected, and a set of pointers to \code{PyObject*} variables that
1232 will be filled in with argument values.
1233
Andrew M. Kuchling0ab31b82001-08-29 01:16:54 +00001234 \item Two new flags \constant{METH_NOARGS} and \constant{METH_O} are
1235 available in method definition tables to simplify implementation of
1236 methods with no arguments or a single untyped argument. Calling
1237 such methods is more efficient than calling a corresponding method
1238 that uses \constant{METH_VARARGS}.
1239 Also, the old \constant{METH_OLDARGS} style of writing C methods is
1240 now officially deprecated.
1241
1242\item
1243 Two new wrapper functions, \cfunction{PyOS_snprintf()} and
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001244 \cfunction{PyOS_vsnprintf()} were added to provide
Andrew M. Kuchling0ab31b82001-08-29 01:16:54 +00001245 cross-platform implementations for the relatively new
1246 \cfunction{snprintf()} and \cfunction{vsnprintf()} C lib APIs. In
1247 contrast to the standard \cfunction{sprintf()} and
1248 \cfunction{vsprintf()} functions, the Python versions check the
1249 bounds of the buffer used to protect against buffer overruns.
1250 (Contributed by M.-A. Lemburg.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001251
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +00001252 \item The \cfunction{_PyTuple_Resize()} function has lost an unused
1253 parameter, so now it takes 2 parameters instead of 3. The third
1254 argument was never used, and can simply be discarded when porting
1255 code from earlier versions to Python 2.2.
1256
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001257\end{itemize}
1258
1259
1260%======================================================================
1261\section{Other Changes and Fixes}
1262
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001263% XXX update the patch and bug figures as we go
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001264As usual there were a bunch of other improvements and bugfixes
1265scattered throughout the source tree. A search through the CVS change
Andrew M. Kuchling32e32322001-10-22 15:32:05 +00001266logs finds there were 312 patches applied, and 391 bugs fixed; both
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001267figures are likely to be underestimates. Some of the more notable
1268changes are:
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001269
1270\begin{itemize}
1271
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001272 \item The code for the MacOS port for Python, maintained by Jack
1273 Jansen, is now kept in the main Python CVS tree, and many changes
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001274 have been made to support MacOS~X.
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001275
1276The most significant change is the ability to build Python as a
1277framework, enabled by supplying the \longprogramopt{enable-framework}
1278option to the configure script when compiling Python. According to
1279Jack Jansen, ``This installs a self-contained Python installation plus
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001280the OS~X framework "glue" into
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001281\file{/Library/Frameworks/Python.framework} (or another location of
1282choice). For now there is little immediate added benefit to this
1283(actually, there is the disadvantage that you have to change your PATH
1284to be able to find Python), but it is the basis for creating a
1285full-blown Python application, porting the MacPython IDE, possibly
1286using Python as a standard OSA scripting language and much more.''
1287
1288Most of the MacPython toolbox modules, which interface to MacOS APIs
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001289such as windowing, QuickTime, scripting, etc. have been ported to OS~X,
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001290but they've been left commented out in \file{setup.py}. People who want
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001291to experiment with these modules can uncomment them manually.
1292
1293% Jack's original comments:
1294%The main change is the possibility to build Python as a
1295%framework. This installs a self-contained Python installation plus the
1296%OSX framework "glue" into /Library/Frameworks/Python.framework (or
1297%another location of choice). For now there is little immedeate added
1298%benefit to this (actually, there is the disadvantage that you have to
1299%change your PATH to be able to find Python), but it is the basis for
1300%creating a fullblown Python application, porting the MacPython IDE,
1301%possibly using Python as a standard OSA scripting language and much
1302%more. You enable this with "configure --enable-framework".
1303
1304%The other change is that most MacPython toolbox modules, which
1305%interface to all the MacOS APIs such as windowing, quicktime,
1306%scripting, etc. have been ported. Again, most of these are not of
1307%immedeate use, as they need a full application to be really useful, so
1308%they have been commented out in setup.py. People wanting to experiment
1309%can uncomment them. Gestalt and Internet Config modules are enabled by
1310%default.
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001311
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001312 \item Keyword arguments passed to builtin functions that don't take them
1313 now cause a \exception{TypeError} exception to be raised, with the
1314 message "\var{function} takes no keyword arguments".
1315
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001316 \item Weak references, added in Python 2.1 as an extension module,
1317 are now part of the core because they're used in the implementation
1318 of new-style classes. The \exception{ReferenceError} exception has
1319 therefore moved from the \module{weakref} module to become a
1320 built-in exception.
1321
Andrew M. Kuchling94a7eba2001-08-15 15:55:48 +00001322 \item A new script, \file{Tools/scripts/cleanfuture.py} by Tim
1323 Peters, automatically removes obsolete \code{__future__} statements
1324 from Python source code.
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001325
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +00001326 \item An additional \var{flags} argument has been added to the
1327 built-in function \function{compile()}, so the behaviour of
1328 \code{__future__} statements can now be correctly observed in
1329 simulated shells, such as those presented by IDLE and other
1330 development environments. This is described in \pep{264}.
1331 (Contributed by Michael Hudson.)
1332
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001333 \item The new license introduced with Python 1.6 wasn't
1334 GPL-compatible. This is fixed by some minor textual changes to the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001335 2.2 license, so it's now legal to embed Python inside a GPLed
1336 program again. Note that Python itself is not GPLed, but instead is
1337 under a license that's essentially equivalent to the BSD license,
1338 same as it always was. The license changes were also applied to the
1339 Python 2.0.1 and 2.1.1 releases.
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001340
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +00001341 \item When presented with a Unicode filename on Windows, Python will
1342 now convert it to an MBCS encoded string, as used by the Microsoft
1343 file APIs. As MBCS is explicitly used by the file APIs, Python's
1344 choice of ASCII as the default encoding turns out to be an
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001345 annoyance. On Unix, the locale's character set is used if
1346 \function{locale.nl_langinfo(CODESET)} is available. (Windows
1347 support was contributed by Mark Hammond with assistance from
1348 Marc-Andr\'e Lemburg. Unix support was added by Martin von L\"owis.)
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001349
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001350 \item Large file support is now enabled on Windows. (Contributed by
1351 Tim Peters.)
1352
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001353 \item The \file{Tools/scripts/ftpmirror.py} script
1354 now parses a \file{.netrc} file, if you have one.
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001355 (Contributed by Mike Romberg.)
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001356
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001357 \item Some features of the object returned by the
1358 \function{xrange()} function are now deprecated, and trigger
1359 warnings when they're accessed; they'll disappear in Python 2.3.
1360 \class{xrange} objects tried to pretend they were full sequence
1361 types by supporting slicing, sequence multiplication, and the
1362 \keyword{in} operator, but these features were rarely used and
1363 therefore buggy. The \method{tolist()} method and the
1364 \member{start}, \member{stop}, and \member{step} attributes are also
1365 being deprecated. At the C level, the fourth argument to the
1366 \cfunction{PyRange_New()} function, \samp{repeat}, has also been
1367 deprecated.
1368
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001369 \item There were a bunch of patches to the dictionary
1370 implementation, mostly to fix potential core dumps if a dictionary
1371 contains objects that sneakily changed their hash value, or mutated
1372 the dictionary they were contained in. For a while python-dev fell
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001373 into a gentle rhythm of Michael Hudson finding a case that dumped
1374 core, Tim Peters fixing the bug, Michael finding another case, and round
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001375 and round it went.
1376
Andrew M. Kuchling33a3b632001-09-04 21:25:58 +00001377 \item On Windows, Python can now be compiled with Borland C thanks
1378 to a number of patches contributed by Stephen Hansen, though the
1379 result isn't fully functional yet. (But this \emph{is} progress...)
Andrew M. Kuchling8c69c912001-08-07 14:28:58 +00001380
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +00001381 \item Another Windows enhancement: Wise Solutions generously offered
1382 PythonLabs use of their InstallerMaster 8.1 system. Earlier
1383 PythonLabs Windows installers used Wise 5.0a, which was beginning to
1384 show its age. (Packaged up by Tim Peters.)
1385
Andrew M. Kuchling8c69c912001-08-07 14:28:58 +00001386 \item Files ending in \samp{.pyw} can now be imported on Windows.
1387 \samp{.pyw} is a Windows-only thing, used to indicate that a script
1388 needs to be run using PYTHONW.EXE instead of PYTHON.EXE in order to
1389 prevent a DOS console from popping up to display the output. This
1390 patch makes it possible to import such scripts, in case they're also
1391 usable as modules. (Implemented by David Bolen.)
1392
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001393 \item On platforms where Python uses the C \cfunction{dlopen()} function
1394 to load extension modules, it's now possible to set the flags used
1395 by \cfunction{dlopen()} using the \function{sys.getdlopenflags()} and
1396 \function{sys.setdlopenflags()} functions. (Contributed by Bram Stolk.)
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +00001397
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001398 \item The \function{pow()} built-in function no longer supports 3
1399 arguments when floating-point numbers are supplied.
Andrew M. Kuchling1497b622001-09-24 14:51:16 +00001400 \code{pow(\var{x}, \var{y}, \var{z})} returns \code{(x**y) \% z}, but
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001401 this is never useful for floating point numbers, and the final
1402 result varies unpredictably depending on the platform. A call such
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001403 as \code{pow(2.0, 8.0, 7.0)} will now raise a \exception{TypeError}
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001404 exception.
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001405
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001406\end{itemize}
1407
1408
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001409%======================================================================
1410\section{Acknowledgements}
1411
1412The author would like to thank the following people for offering
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +00001413suggestions, corrections and assistance with various drafts of this
1414article: Fred Bremmer, Keith Briggs, Andrew Dalke, Fred~L. Drake, Jr.,
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +00001415Carel Fellinger, David Goodger, Mark Hammond, Stephen Hansen, Michael
1416Hudson, Jack Jansen, Marc-Andr\'e Lemburg, Martin von L\"owis, Fredrik
1417Lundh, Michael McLay, Nick Mathewson, Paul Moore, Gustavo Niemeyer,
1418Don O'Donnell, Tim Peters, Jens Quade, Tom Reinhardt, Neil
1419Schemenauer, Guido van Rossum, Greg Ward.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001420
1421\end{document}