blob: 82ff06133875b7d515e28a1b0149937383d95ef8 [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. Kuchling71dd7902002-11-12 18:45:46 +00006\release{1.02}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00007\author{A.M. Kuchling}
Fred Drakeb914ef02004-01-02 06:57:50 +00008\authoraddress{
9 \strong{Python Software Foundation}\\
10 Email: \email{amk@amk.ca}
11}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000012\begin{document}
13\maketitle\tableofcontents
14
15\section{Introduction}
16
Andrew M. Kuchlingcab94a12002-11-12 18:59:20 +000017This article explains the new features in Python 2.2.2, released on
18October 14, 2002. Python 2.2.2 is a bugfix release of Python 2.2,
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +000019originally released on December 21, 2001.
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000020
21Python 2.2 can be thought of as the "cleanup release". There are some
22features such as generators and iterators that are completely new, but
23most of the changes, significant and far-reaching though they may be,
24are aimed at cleaning up irregularities and dark corners of the
25language design.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000026
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000027This article doesn't attempt to provide a complete specification of
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000028the new features, but instead provides a convenient overview. For
29full details, you should refer to the documentation for Python 2.2,
Fred Drake0d002542001-07-17 13:55:33 +000030such as the
Andrew M. Kuchling5e08d102001-12-20 16:33:45 +000031\citetitle[http://www.python.org/doc/2.2/lib/lib.html]{Python
Fred Drake0d002542001-07-17 13:55:33 +000032Library Reference} and the
Andrew M. Kuchling5e08d102001-12-20 16:33:45 +000033\citetitle[http://www.python.org/doc/2.2/ref/ref.html]{Python
34Reference Manual}. If you want to understand the complete
35implementation and design rationale for a change, refer to the PEP for
36a particular new feature.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000037
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000038\begin{seealso}
39
Andrew M. Kuchling2dab9c72001-10-31 13:16:10 +000040\seeurl{http://www.unixreview.com/documents/s=1356/urm0109h/0109h.htm}
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000041{``What's So Special About Python 2.2?'' is also about the new 2.2
42features, and was written by Cameron Laird and Kathryn Soraiz.}
43
44\end{seealso}
45
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000046
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000047%======================================================================
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +000048\section{PEPs 252 and 253: Type and Class Changes}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000049
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000050The largest and most far-reaching changes in Python 2.2 are to
51Python's model of objects and classes. The changes should be backward
52compatible, so it's likely that your code will continue to run
53unchanged, but the changes provide some amazing new capabilities.
54Before beginning this, the longest and most complicated section of
55this article, I'll provide an overview of the changes and offer some
56comments.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000057
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000058A long time ago I wrote a Web page
59(\url{http://www.amk.ca/python/writing/warts.html}) listing flaws in
60Python's design. One of the most significant flaws was that it's
61impossible to subclass Python types implemented in C. In particular,
62it's not possible to subclass built-in types, so you can't just
63subclass, say, lists in order to add a single useful method to them.
64The \module{UserList} module provides a class that supports all of the
65methods of lists and that can be subclassed further, but there's lots
66of C code that expects a regular Python list and won't accept a
67\class{UserList} instance.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000068
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000069Python 2.2 fixes this, and in the process adds some exciting new
70capabilities. A brief summary:
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000071
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000072\begin{itemize}
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +000073
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000074\item You can subclass built-in types such as lists and even integers,
75and your subclasses should work in every place that requires the
76original type.
77
78\item It's now possible to define static and class methods, in addition
79to the instance methods available in previous versions of Python.
80
81\item It's also possible to automatically call methods on accessing or
82setting an instance attribute by using a new mechanism called
83\dfn{properties}. Many uses of \method{__getattr__} can be rewritten
84to use properties instead, making the resulting code simpler and
85faster. As a small side benefit, attributes can now have docstrings,
86too.
87
88\item The list of legal attributes for an instance can be limited to a
89particular set using \dfn{slots}, making it possible to safeguard
90against typos and perhaps make more optimizations possible in future
91versions of Python.
92
93\end{itemize}
94
95Some users have voiced concern about all these changes. Sure, they
96say, the new features are neat and lend themselves to all sorts of
97tricks that weren't possible in previous versions of Python, but
98they also make the language more complicated. Some people have said
99that they've always recommended Python for its simplicity, and feel
100that its simplicity is being lost.
101
102Personally, I think there's no need to worry. Many of the new
103features are quite esoteric, and you can write a lot of Python code
104without ever needed to be aware of them. Writing a simple class is no
105more difficult than it ever was, so you don't need to bother learning
106or teaching them unless they're actually needed. Some very
107complicated tasks that were previously only possible from C will now
108be possible in pure Python, and to my mind that's all for the better.
109
110I'm not going to attempt to cover every single corner case and small
111change that were required to make the new features work. Instead this
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000112section will paint only the broad strokes. See section~\ref{sect-rellinks},
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000113``Related Links'', for further sources of information about Python 2.2's new
114object model.
115
116
117\subsection{Old and New Classes}
118
119First, you should know that Python 2.2 really has two kinds of
120classes: classic or old-style classes, and new-style classes. The
121old-style class model is exactly the same as the class model in
122earlier versions of Python. All the new features described in this
123section apply only to new-style classes. This divergence isn't
124intended to last forever; eventually old-style classes will be
125dropped, possibly in Python 3.0.
126
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000127So how do you define a new-style class? You do it by subclassing an
128existing new-style class. Most of Python's built-in types, such as
129integers, lists, dictionaries, and even files, are new-style classes
130now. A new-style class named \class{object}, the base class for all
Andrew M. Kuchling71dd7902002-11-12 18:45:46 +0000131built-in types, has also been added so if no built-in type is
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000132suitable, you can just subclass \class{object}:
133
134\begin{verbatim}
135class C(object):
136 def __init__ (self):
137 ...
138 ...
139\end{verbatim}
140
141This means that \keyword{class} statements that don't have any base
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000142classes are always classic classes in Python 2.2. (Actually you can
143also change this by setting a module-level variable named
144\member{__metaclass__} --- see \pep{253} for the details --- but it's
145easier to just subclass \keyword{object}.)
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000146
147The type objects for the built-in types are available as built-ins,
148named using a clever trick. Python has always had built-in functions
149named \function{int()}, \function{float()}, and \function{str()}. In
1502.2, they aren't functions any more, but type objects that behave as
151factories when called.
152
153\begin{verbatim}
154>>> int
155<type 'int'>
156>>> int('123')
157123
158\end{verbatim}
159
160To make the set of types complete, new type objects such as
Andrew M. Kuchling1117d932001-10-29 20:37:47 +0000161\function{dict} and \function{file} have been added. Here's a
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000162more interesting example, adding a \method{lock()} method to file
163objects:
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000164
165\begin{verbatim}
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000166class LockableFile(file):
167 def lock (self, operation, length=0, start=0, whence=0):
168 import fcntl
169 return fcntl.lockf(self.fileno(), operation,
170 length, start, whence)
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000171\end{verbatim}
172
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000173The now-obsolete \module{posixfile} module contained a class that
174emulated all of a file object's methods and also added a
175\method{lock()} method, but this class couldn't be passed to internal
176functions that expected a built-in file, something which is possible
177with our new \class{LockableFile}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000178
179
180\subsection{Descriptors}
181
182In previous versions of Python, there was no consistent way to
183discover what attributes and methods were supported by an object.
184There were some informal conventions, such as defining
185\member{__members__} and \member{__methods__} attributes that were
186lists of names, but often the author of an extension type or a class
187wouldn't bother to define them. You could fall back on inspecting the
188\member{__dict__} of an object, but when class inheritance or an
189arbitrary \method{__getattr__} hook were in use this could still be
190inaccurate.
191
192The one big idea underlying the new class model is that an API for
193describing the attributes of an object using \dfn{descriptors} has
194been formalized. Descriptors specify the value of an attribute,
195stating whether it's a method or a field. With the descriptor API,
196static methods and class methods become possible, as well as more
197exotic constructs.
198
199Attribute descriptors are objects that live inside class objects, and
200have a few attributes of their own:
201
202\begin{itemize}
203
204\item \member{__name__} is the attribute's name.
205
206\item \member{__doc__} is the attribute's docstring.
207
Andrew M. Kuchling9455df22001-12-03 20:55:37 +0000208\item \method{__get__(\var{object})} is a method that retrieves the
209attribute value from \var{object}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000210
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +0000211\item \method{__set__(\var{object}, \var{value})} sets the attribute
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000212on \var{object} to \var{value}.
213
Andrew M. Kuchlingc54fc312001-12-03 20:58:29 +0000214\item \method{__delete__(\var{object}, \var{value})} deletes the \var{value}
Andrew M. Kuchling9455df22001-12-03 20:55:37 +0000215attribute of \var{object}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000216\end{itemize}
217
218For example, when you write \code{obj.x}, the steps that Python
219actually performs are:
220
221\begin{verbatim}
222descriptor = obj.__class__.x
Andrew M. Kuchling7cc13de2001-10-30 14:22:11 +0000223descriptor.__get__(obj)
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000224\end{verbatim}
225
Andrew M. Kuchling7cc13de2001-10-30 14:22:11 +0000226For methods, \method{descriptor.__get__} returns a temporary object that's
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000227callable, and wraps up the instance and the method to be called on it.
228This is also why static methods and class methods are now possible;
229they have descriptors that wrap up just the method, or the method and
230the class. As a brief explanation of these new kinds of methods,
231static methods aren't passed the instance, and therefore resemble
232regular functions. Class methods are passed the class of the object,
Andrew M. Kuchling72a7fb72001-10-30 22:18:21 +0000233but not the object itself. Static and class methods are defined like
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000234this:
235
236\begin{verbatim}
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000237class C(object):
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000238 def f(arg1, arg2):
239 ...
240 f = staticmethod(f)
241
242 def g(cls, arg1, arg2):
243 ...
244 g = classmethod(g)
245\end{verbatim}
246
247The \function{staticmethod()} function takes the function
248\function{f}, and returns it wrapped up in a descriptor so it can be
249stored in the class object. You might expect there to be special
250syntax for creating such methods (\code{def static f()},
251\code{defstatic f()}, or something like that) but no such syntax has
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000252been defined yet; that's been left for future versions of Python.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000253
254More new features, such as slots and properties, are also implemented
255as new kinds of descriptors, and it's not difficult to write a
256descriptor class that does something novel. For example, it would be
257possible to write a descriptor class that made it possible to write
258Eiffel-style preconditions and postconditions for a method. A class
259that used this feature might be defined like this:
260
261\begin{verbatim}
262from eiffel import eiffelmethod
263
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000264class C(object):
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000265 def f(self, arg1, arg2):
266 # The actual function
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000267 ...
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000268 def pre_f(self):
269 # Check preconditions
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000270 ...
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000271 def post_f(self):
272 # Check postconditions
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000273 ...
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000274
275 f = eiffelmethod(f, pre_f, post_f)
276\end{verbatim}
277
278Note that a person using the new \function{eiffelmethod()} doesn't
279have to understand anything about descriptors. This is why I think
280the new features don't increase the basic complexity of the language.
281There will be a few wizards who need to know about it in order to
282write \function{eiffelmethod()} or the ZODB or whatever, but most
283users will just write code on top of the resulting libraries and
284ignore the implementation details.
285
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000286
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000287\subsection{Multiple Inheritance: The Diamond Rule}
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000288
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000289Multiple inheritance has also been made more useful through changing
290the rules under which names are resolved. Consider this set of classes
291(diagram taken from \pep{253} by Guido van Rossum):
292
293\begin{verbatim}
294 class A:
295 ^ ^ def save(self): ...
296 / \
297 / \
298 / \
299 / \
300 class B class C:
301 ^ ^ def save(self): ...
302 \ /
303 \ /
304 \ /
305 \ /
306 class D
307\end{verbatim}
308
309The lookup rule for classic classes is simple but not very smart; the
310base classes are searched depth-first, going from left to right. A
311reference to \method{D.save} will search the classes \class{D},
312\class{B}, and then \class{A}, where \method{save()} would be found
313and returned. \method{C.save()} would never be found at all. This is
314bad, because if \class{C}'s \method{save()} method is saving some
315internal state specific to \class{C}, not calling it will result in
316that state never getting saved.
317
318New-style classes follow a different algorithm that's a bit more
319complicated to explain, but does the right thing in this situation.
Andrew M. Kuchling88eed702002-11-15 14:37:46 +0000320(Note that Python 2.3 changes this algorithm to one that produces the
321same results in most cases, but produces more useful results for
322really complicated inheritance graphs.)
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000323
324\begin{enumerate}
325
326\item List all the base classes, following the classic lookup rule and
327include a class multiple times if it's visited repeatedly. In the
328above example, the list of visited classes is [\class{D}, \class{B},
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000329\class{A}, \class{C}, \class{A}].
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000330
331\item Scan the list for duplicated classes. If any are found, remove
332all but one occurrence, leaving the \emph{last} one in the list. In
333the above example, the list becomes [\class{D}, \class{B}, \class{C},
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000334\class{A}] after dropping duplicates.
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000335
336\end{enumerate}
337
338Following this rule, referring to \method{D.save()} will return
339\method{C.save()}, which is the behaviour we're after. This lookup
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000340rule is the same as the one followed by Common Lisp. A new built-in
341function, \function{super()}, provides a way to get at a class's
342superclasses without having to reimplement Python's algorithm.
343The most commonly used form will be
344\function{super(\var{class}, \var{obj})}, which returns
345a bound superclass object (not the actual class object). This form
346will be used in methods to call a method in the superclass; for
347example, \class{D}'s \method{save()} method would look like this:
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000348
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000349\begin{verbatim}
Andrew M. Kuchlingf08437c2004-09-10 19:33:00 +0000350class D (B,C):
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000351 def save (self):
352 # Call superclass .save()
353 super(D, self).save()
354 # Save D's private information here
355 ...
356\end{verbatim}
357
358\function{super()} can also return unbound superclass objects
359when called as \function{super(\var{class})} or
360\function{super(\var{class1}, \var{class2})}, but this probably won't
361often be useful.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000362
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000363
364\subsection{Attribute Access}
365
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000366A fair number of sophisticated Python classes define hooks for
367attribute access using \method{__getattr__}; most commonly this is
368done for convenience, to make code more readable by automatically
369mapping an attribute access such as \code{obj.parent} into a method
370call such as \code{obj.get_parent()}. Python 2.2 adds some new ways
371of controlling attribute access.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000372
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000373First, \method{__getattr__(\var{attr_name})} is still supported by
374new-style classes, and nothing about it has changed. As before, it
375will be called when an attempt is made to access \code{obj.foo} and no
376attribute named \samp{foo} is found in the instance's dictionary.
377
378New-style classes also support a new method,
379\method{__getattribute__(\var{attr_name})}. The difference between
380the two methods is that \method{__getattribute__} is \emph{always}
381called whenever any attribute is accessed, while the old
382\method{__getattr__} is only called if \samp{foo} isn't found in the
383instance's dictionary.
384
385However, Python 2.2's support for \dfn{properties} will often be a
386simpler way to trap attribute references. Writing a
387\method{__getattr__} method is complicated because to avoid recursion
388you can't use regular attribute accesses inside them, and instead have
389to mess around with the contents of \member{__dict__}.
390\method{__getattr__} methods also end up being called by Python when
391it checks for other methods such as \method{__repr__} or
392\method{__coerce__}, and so have to be written with this in mind.
393Finally, calling a function on every attribute access results in a
394sizable performance loss.
395
396\class{property} is a new built-in type that packages up three
397functions that get, set, or delete an attribute, and a docstring. For
398example, if you want to define a \member{size} attribute that's
399computed, but also settable, you could write:
400
401\begin{verbatim}
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000402class C(object):
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000403 def get_size (self):
404 result = ... computation ...
405 return result
406 def set_size (self, size):
407 ... compute something based on the size
408 and set internal state appropriately ...
409
410 # Define a property. The 'delete this attribute'
411 # method is defined as None, so the attribute
412 # can't be deleted.
413 size = property(get_size, set_size,
414 None,
415 "Storage size of this instance")
416\end{verbatim}
417
418That is certainly clearer and easier to write than a pair of
419\method{__getattr__}/\method{__setattr__} methods that check for the
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000420\member{size} attribute and handle it specially while retrieving all
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000421other attributes from the instance's \member{__dict__}. Accesses to
422\member{size} are also the only ones which have to perform the work of
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000423calling a function, so references to other attributes run at
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000424their usual speed.
425
426Finally, it's possible to constrain the list of attributes that can be
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000427referenced on an object using the new \member{__slots__} class attribute.
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000428Python objects are usually very dynamic; at any time it's possible to
429define a new attribute on an instance by just doing
Andrew M. Kuchling28137a02003-05-20 18:12:21 +0000430\code{obj.new_attr=1}. A new-style class can define a class attribute named
431\member{__slots__} to limit the legal attributes
432to a particular set of names. An example will make this clear:
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000433
434\begin{verbatim}
435>>> class C(object):
Andrew M. Kuchling038215a2001-12-07 14:22:13 +0000436... __slots__ = ('template', 'name')
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000437...
438>>> obj = C()
439>>> print obj.template
440None
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000441>>> obj.template = 'Test'
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000442>>> print obj.template
443Test
Andrew M. Kuchling28137a02003-05-20 18:12:21 +0000444>>> obj.newattr = None
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000445Traceback (most recent call last):
446 File "<stdin>", line 1, in ?
Andrew M. Kuchling28137a02003-05-20 18:12:21 +0000447AttributeError: 'C' object has no attribute 'newattr'
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000448\end{verbatim}
449
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000450Note how you get an \exception{AttributeError} on the attempt to
451assign to an attribute not listed in \member{__slots__}.
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000452
453
Andrew M. Kuchling28137a02003-05-20 18:12:21 +0000454
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000455\subsection{Related Links}
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000456\label{sect-rellinks}
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000457
458This section has just been a quick overview of the new features,
459giving enough of an explanation to start you programming, but many
460details have been simplified or ignored. Where should you go to get a
461more complete picture?
462
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000463\url{http://www.python.org/2.2/descrintro.html} is a lengthy tutorial
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000464introduction to the descriptor features, written by Guido van Rossum.
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000465If my description has whetted your appetite, go read this tutorial
466next, because it goes into much more detail about the new features
467while still remaining quite easy to read.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000468
469Next, there are two relevant PEPs, \pep{252} and \pep{253}. \pep{252}
470is titled "Making Types Look More Like Classes", and covers the
471descriptor API. \pep{253} is titled "Subtyping Built-in Types", and
472describes the changes to type objects that make it possible to subtype
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000473built-in objects. \pep{253} is the more complicated PEP of the two,
474and at a few points the necessary explanations of types and meta-types
475may cause your head to explode. Both PEPs were written and
476implemented by Guido van Rossum, with substantial assistance from the
477rest of the Zope Corp. team.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000478
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000479Finally, there's the ultimate authority: the source code. Most of the
480machinery for the type handling is in \file{Objects/typeobject.c}, but
481you should only resort to it after all other avenues have been
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000482exhausted, including posting a question to python-list or python-dev.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000483
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000484
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000485%======================================================================
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000486\section{PEP 234: Iterators}
487
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000488Another significant addition to 2.2 is an iteration interface at both
489the C and Python levels. Objects can define how they can be looped
490over by callers.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000491
492In Python versions up to 2.1, the usual way to make \code{for item in
493obj} work is to define a \method{__getitem__()} method that looks
494something like this:
495
496\begin{verbatim}
497 def __getitem__(self, index):
498 return <next item>
499\end{verbatim}
500
501\method{__getitem__()} is more properly used to define an indexing
502operation on an object so that you can write \code{obj[5]} to retrieve
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +0000503the sixth element. It's a bit misleading when you're using this only
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000504to support \keyword{for} loops. Consider some file-like object that
505wants to be looped over; the \var{index} parameter is essentially
506meaningless, as the class probably assumes that a series of
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000507\method{__getitem__()} calls will be made with \var{index}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000508incrementing by one each time. In other words, the presence of the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000509\method{__getitem__()} method doesn't mean that using \code{file[5]}
510to randomly access the sixth element will work, though it really should.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000511
512In Python 2.2, iteration can be implemented separately, and
513\method{__getitem__()} methods can be limited to classes that really
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000514do support random access. The basic idea of iterators is
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000515simple. A new built-in function, \function{iter(obj)} or
516\code{iter(\var{C}, \var{sentinel})}, is used to get an iterator.
517\function{iter(obj)} returns an iterator for the object \var{obj},
518while \code{iter(\var{C}, \var{sentinel})} returns an iterator that
519will invoke the callable object \var{C} until it returns
520\var{sentinel} to signal that the iterator is done.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000521
522Python classes can define an \method{__iter__()} method, which should
523create and return a new iterator for the object; if the object is its
524own iterator, this method can just return \code{self}. In particular,
525iterators will usually be their own iterators. Extension types
Fred Drakea030c762002-05-02 17:55:26 +0000526implemented in C can implement a \member{tp_iter} function in order to
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000527return an iterator, and extension types that want to behave as
Fred Drakea030c762002-05-02 17:55:26 +0000528iterators can define a \member{tp_iternext} function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000529
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000530So, after all this, what do iterators actually do? They have one
531required method, \method{next()}, which takes no arguments and returns
532the next value. When there are no more values to be returned, calling
533\method{next()} should raise the \exception{StopIteration} exception.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000534
535\begin{verbatim}
536>>> L = [1,2,3]
537>>> i = iter(L)
538>>> print i
539<iterator object at 0x8116870>
540>>> i.next()
5411
542>>> i.next()
5432
544>>> i.next()
5453
546>>> i.next()
547Traceback (most recent call last):
548 File "<stdin>", line 1, in ?
549StopIteration
550>>>
551\end{verbatim}
552
553In 2.2, Python's \keyword{for} statement no longer expects a sequence;
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000554it expects something for which \function{iter()} will return an iterator.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000555For backward compatibility and convenience, an iterator is
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000556automatically constructed for sequences that don't implement
Fred Drakea030c762002-05-02 17:55:26 +0000557\method{__iter__()} or a \member{tp_iter} slot, so \code{for i in
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000558[1,2,3]} will still work. Wherever the Python interpreter loops over
559a sequence, it's been changed to use the iterator protocol. This
560means you can do things like this:
561
562\begin{verbatim}
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000563>>> L = [1,2,3]
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000564>>> i = iter(L)
565>>> a,b,c = i
566>>> a,b,c
567(1, 2, 3)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000568\end{verbatim}
569
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000570Iterator support has been added to some of Python's basic types.
Fred Drake0d002542001-07-17 13:55:33 +0000571Calling \function{iter()} on a dictionary will return an iterator
Andrew M. Kuchling6ea9f0b2001-07-17 14:50:31 +0000572which loops over its keys:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000573
574\begin{verbatim}
575>>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
576... 'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
577>>> for key in m: print key, m[key]
578...
579Mar 3
580Feb 2
581Aug 8
582Sep 9
583May 5
584Jun 6
585Jul 7
586Jan 1
587Apr 4
588Nov 11
589Dec 12
590Oct 10
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000591\end{verbatim}
592
593That's just the default behaviour. If you want to iterate over keys,
594values, or key/value pairs, you can explicitly call the
595\method{iterkeys()}, \method{itervalues()}, or \method{iteritems()}
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000596methods to get an appropriate iterator. In a minor related change,
597the \keyword{in} operator now works on dictionaries, so
598\code{\var{key} in dict} is now equivalent to
599\code{dict.has_key(\var{key})}.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000600
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000601Files also provide an iterator, which calls the \method{readline()}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000602method until there are no more lines in the file. This means you can
603now read each line of a file using code like this:
604
605\begin{verbatim}
606for line in file:
607 # do something for each line
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000608 ...
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000609\end{verbatim}
610
611Note that you can only go forward in an iterator; there's no way to
612get the previous element, reset the iterator, or make a copy of it.
Fred Drake0d002542001-07-17 13:55:33 +0000613An iterator object could provide such additional capabilities, but the
614iterator protocol only requires a \method{next()} method.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000615
616\begin{seealso}
617
618\seepep{234}{Iterators}{Written by Ka-Ping Yee and GvR; implemented
619by the Python Labs crew, mostly by GvR and Tim Peters.}
620
621\end{seealso}
622
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000623
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000624%======================================================================
625\section{PEP 255: Simple Generators}
626
627Generators are another new feature, one that interacts with the
628introduction of iterators.
629
630You're doubtless familiar with how function calls work in Python or
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000631C. When you call a function, it gets a private namespace where its local
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000632variables are created. When the function reaches a \keyword{return}
633statement, the local variables are destroyed and the resulting value
634is returned to the caller. A later call to the same function will get
635a fresh new set of local variables. But, what if the local variables
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000636weren't thrown away on exiting a function? What if you could later
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000637resume the function where it left off? This is what generators
638provide; they can be thought of as resumable functions.
639
640Here's the simplest example of a generator function:
641
642\begin{verbatim}
643def generate_ints(N):
644 for i in range(N):
645 yield i
646\end{verbatim}
647
648A new keyword, \keyword{yield}, was introduced for generators. Any
649function containing a \keyword{yield} statement is a generator
650function; this is detected by Python's bytecode compiler which
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000651compiles the function specially as a result. Because a new keyword was
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000652introduced, generators must be explicitly enabled in a module by
653including a \code{from __future__ import generators} statement near
654the top of the module's source code. In Python 2.3 this statement
655will become unnecessary.
656
657When you call a generator function, it doesn't return a single value;
658instead it returns a generator object that supports the iterator
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000659protocol. On executing the \keyword{yield} statement, the generator
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000660outputs the value of \code{i}, similar to a \keyword{return}
661statement. The big difference between \keyword{yield} and a
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000662\keyword{return} statement is that on reaching a \keyword{yield} the
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000663generator's state of execution is suspended and local variables are
Fred Drakea030c762002-05-02 17:55:26 +0000664preserved. On the next call to the generator's \code{next()} method,
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000665the function will resume executing immediately after the
666\keyword{yield} statement. (For complicated reasons, the
667\keyword{yield} statement isn't allowed inside the \keyword{try} block
Fred Drakea030c762002-05-02 17:55:26 +0000668of a \keyword{try}...\keyword{finally} statement; read \pep{255} for a full
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000669explanation of the interaction between \keyword{yield} and
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000670exceptions.)
671
672Here's a sample usage of the \function{generate_ints} generator:
673
674\begin{verbatim}
675>>> gen = generate_ints(3)
676>>> gen
677<generator object at 0x8117f90>
678>>> gen.next()
6790
680>>> gen.next()
6811
682>>> gen.next()
6832
684>>> gen.next()
685Traceback (most recent call last):
686 File "<stdin>", line 1, in ?
687 File "<stdin>", line 2, in generate_ints
688StopIteration
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000689\end{verbatim}
690
691You could equally write \code{for i in generate_ints(5)}, or
692\code{a,b,c = generate_ints(3)}.
693
694Inside a generator function, the \keyword{return} statement can only
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000695be used without a value, and signals the end of the procession of
696values; afterwards the generator cannot return any further values.
697\keyword{return} with a value, such as \code{return 5}, is a syntax
698error inside a generator function. The end of the generator's results
699can also be indicated by raising \exception{StopIteration} manually,
700or by just letting the flow of execution fall off the bottom of the
701function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000702
703You could achieve the effect of generators manually by writing your
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000704own class and storing all the local variables of the generator as
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000705instance variables. For example, returning a list of integers could
706be done by setting \code{self.count} to 0, and having the
707\method{next()} method increment \code{self.count} and return it.
Andrew M. Kuchlingc32cc7c2001-07-17 18:25:01 +0000708However, for a moderately complicated generator, writing a
709corresponding class would be much messier.
710\file{Lib/test/test_generators.py} contains a number of more
711interesting examples. The simplest one implements an in-order
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000712traversal of a tree using generators recursively.
713
714\begin{verbatim}
715# A recursive generator that generates Tree leaves in in-order.
716def inorder(t):
717 if t:
718 for x in inorder(t.left):
719 yield x
720 yield t.label
721 for x in inorder(t.right):
722 yield x
723\end{verbatim}
724
725Two other examples in \file{Lib/test/test_generators.py} produce
726solutions for the N-Queens problem (placing $N$ queens on an $NxN$
727chess board so that no queen threatens another) and the Knight's Tour
728(a route that takes a knight to every square of an $NxN$ chessboard
729without visiting any square twice).
730
731The idea of generators comes from other programming languages,
732especially Icon (\url{http://www.cs.arizona.edu/icon/}), where the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000733idea of generators is central. In Icon, every
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000734expression and function call behaves like a generator. One example
735from ``An Overview of the Icon Programming Language'' at
736\url{http://www.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of
737what this looks like:
738
739\begin{verbatim}
740sentence := "Store it in the neighboring harbor"
741if (i := find("or", sentence)) > 5 then write(i)
742\end{verbatim}
743
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000744In Icon the \function{find()} function returns the indexes at which the
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000745substring ``or'' is found: 3, 23, 33. In the \keyword{if} statement,
746\code{i} is first assigned a value of 3, but 3 is less than 5, so the
747comparison fails, and Icon retries it with the second value of 23. 23
748is greater than 5, so the comparison now succeeds, and the code prints
749the value 23 to the screen.
750
751Python doesn't go nearly as far as Icon in adopting generators as a
752central concept. Generators are considered a new part of the core
753Python language, but learning or using them isn't compulsory; if they
754don't solve any problems that you have, feel free to ignore them.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000755One novel feature of Python's interface as compared to
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000756Icon's is that a generator's state is represented as a concrete object
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000757(the iterator) that can be passed around to other functions or stored
758in a data structure.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000759
760\begin{seealso}
761
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000762\seepep{255}{Simple Generators}{Written by Neil Schemenauer, Tim
763Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
764and Tim Peters, with other fixes from the Python Labs crew.}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000765
766\end{seealso}
767
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000768
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000769%======================================================================
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000770\section{PEP 237: Unifying Long Integers and Integers}
771
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000772In recent versions, the distinction between regular integers, which
773are 32-bit values on most machines, and long integers, which can be of
774arbitrary size, was becoming an annoyance. For example, on platforms
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000775that support files larger than \code{2**32} bytes, the
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000776\method{tell()} method of file objects has to return a long integer.
777However, there were various bits of Python that expected plain
778integers and would raise an error if a long integer was provided
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +0000779instead. For example, in Python 1.5, only regular integers
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000780could be used as a slice index, and \code{'abc'[1L:]} would raise a
781\exception{TypeError} exception with the message 'slice index must be
782int'.
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000783
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000784Python 2.2 will shift values from short to long integers as required.
785The 'L' suffix is no longer needed to indicate a long integer literal,
786as now the compiler will choose the appropriate type. (Using the 'L'
787suffix will be discouraged in future 2.x versions of Python,
788triggering a warning in Python 2.4, and probably dropped in Python
7893.0.) Many operations that used to raise an \exception{OverflowError}
790will now return a long integer as their result. For example:
791
792\begin{verbatim}
793>>> 1234567890123
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00007941234567890123L
795>>> 2 ** 64
79618446744073709551616L
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000797\end{verbatim}
798
799In most cases, integers and long integers will now be treated
800identically. You can still distinguish them with the
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000801\function{type()} built-in function, but that's rarely needed.
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000802
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000803\begin{seealso}
804
805\seepep{237}{Unifying Long Integers and Integers}{Written by
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000806Moshe Zadka and Guido van Rossum. Implemented mostly by Guido van
807Rossum.}
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000808
809\end{seealso}
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000810
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +0000811
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000812%======================================================================
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000813\section{PEP 238: Changing the Division Operator}
814
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000815The most controversial change in Python 2.2 heralds the start of an effort
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000816to fix an old design flaw that's been in Python from the beginning.
817Currently Python's division operator, \code{/}, behaves like C's
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000818division operator when presented with two integer arguments: it
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000819returns an integer result that's truncated down when there would be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000820a fractional part. For example, \code{3/2} is 1, not 1.5, and
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000821\code{(-1)/2} is -1, not -0.5. This means that the results of divison
822can vary unexpectedly depending on the type of the two operands and
823because Python is dynamically typed, it can be difficult to determine
824the possible types of the operands.
825
826(The controversy is over whether this is \emph{really} a design flaw,
827and whether it's worth breaking existing code to fix this. It's
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000828caused endless discussions on python-dev, and in July 2001 erupted into an
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000829storm of acidly sarcastic postings on \newsgroup{comp.lang.python}. I
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000830won't argue for either side here and will stick to describing what's
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000831implemented in 2.2. Read \pep{238} for a summary of arguments and
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000832counter-arguments.)
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000833
834Because this change might break code, it's being introduced very
835gradually. Python 2.2 begins the transition, but the switch won't be
836complete until Python 3.0.
837
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000838First, I'll borrow some terminology from \pep{238}. ``True division'' is the
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000839division that most non-programmers are familiar with: 3/2 is 1.5, 1/4
840is 0.25, and so forth. ``Floor division'' is what Python's \code{/}
841operator currently does when given integer operands; the result is the
842floor of the value returned by true division. ``Classic division'' is
843the current mixed behaviour of \code{/}; it returns the result of
844floor division when the operands are integers, and returns the result
845of true division when one of the operands is a floating-point number.
846
847Here are the changes 2.2 introduces:
848
849\begin{itemize}
850
851\item A new operator, \code{//}, is the floor division operator.
852(Yes, we know it looks like \Cpp's comment symbol.) \code{//}
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000853\emph{always} performs floor division no matter what the types of
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000854its operands are, so \code{1 // 2} is 0 and \code{1.0 // 2.0} is also
8550.0.
856
857\code{//} is always available in Python 2.2; you don't need to enable
858it using a \code{__future__} statement.
859
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +0000860\item By including a \code{from __future__ import division} in a
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000861module, the \code{/} operator will be changed to return the result of
862true division, so \code{1/2} is 0.5. Without the \code{__future__}
863statement, \code{/} still means classic division. The default meaning
864of \code{/} will not change until Python 3.0.
865
866\item Classes can define methods called \method{__truediv__} and
867\method{__floordiv__} to overload the two division operators. At the
Fred Drakea030c762002-05-02 17:55:26 +0000868C level, there are also slots in the \ctype{PyNumberMethods} structure
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000869so extension types can define the two operators.
870
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000871\item Python 2.2 supports some command-line arguments for testing
872whether code will works with the changed division semantics. Running
873python with \programopt{-Q warn} will cause a warning to be issued
874whenever division is applied to two integers. You can use this to
875find code that's affected by the change and fix it. By default,
876Python 2.2 will simply perform classic division without a warning; the
877warning will be turned on by default in Python 2.3.
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000878
879\end{itemize}
880
881\begin{seealso}
882
883\seepep{238}{Changing the Division Operator}{Written by Moshe Zadka and
884Guido van Rossum. Implemented by Guido van Rossum..}
885
886\end{seealso}
887
888
889%======================================================================
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000890\section{Unicode Changes}
891
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000892Python's Unicode support has been enhanced a bit in 2.2. Unicode
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000893strings are usually stored as UCS-2, as 16-bit unsigned integers.
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000894Python 2.2 can also be compiled to use UCS-4, 32-bit unsigned
895integers, as its internal encoding by supplying
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000896\longprogramopt{enable-unicode=ucs4} to the configure script.
897(It's also possible to specify
898\longprogramopt{disable-unicode} to completely disable Unicode
899support.)
900
901When built to use UCS-4 (a ``wide Python''), the interpreter can
902natively handle Unicode characters from U+000000 to U+110000, so the
903range of legal values for the \function{unichr()} function is expanded
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000904accordingly. Using an interpreter compiled to use UCS-2 (a ``narrow
905Python''), values greater than 65535 will still cause
906\function{unichr()} to raise a \exception{ValueError} exception.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000907This is all described in \pep{261}, ``Support for `wide' Unicode
908characters''; consult it for further details.
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000909
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000910Another change is simpler to explain. Since their introduction,
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000911Unicode strings have supported an \method{encode()} method to convert
912the string to a selected encoding such as UTF-8 or Latin-1. A
913symmetric \method{decode(\optional{\var{encoding}})} method has been
914added to 8-bit strings (though not to Unicode strings) in 2.2.
915\method{decode()} assumes that the string is in the specified encoding
916and decodes it, returning whatever is returned by the codec.
917
918Using this new feature, codecs have been added for tasks not directly
919related to Unicode. For example, codecs have been added for
920uu-encoding, MIME's base64 encoding, and compression with the
921\module{zlib} module:
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000922
923\begin{verbatim}
924>>> s = """Here is a lengthy piece of redundant, overly verbose,
925... and repetitive text.
926... """
927>>> data = s.encode('zlib')
928>>> data
929'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
930>>> data.decode('zlib')
931'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
932>>> print s.encode('uu')
933begin 666 <data>
934M2&5R92!I<R!A(&QE;F=T:'D@<&EE8V4@;V8@<F5D=6YD86YT+"!O=F5R;'D@
935>=F5R8F]S92P*86YD(')E<&5T:71I=F4@=&5X="X*
936
937end
938>>> "sheesh".encode('rot-13')
939'furrfu'
940\end{verbatim}
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000941
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000942To convert a class instance to Unicode, a \method{__unicode__} method
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000943can be defined by a class, analogous to \method{__str__}.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000944
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000945\method{encode()}, \method{decode()}, and \method{__unicode__} were
946implemented by Marc-Andr\'e Lemburg. The changes to support using
947UCS-4 internally were implemented by Fredrik Lundh and Martin von
948L\"owis.
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000949
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000950\begin{seealso}
951
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000952\seepep{261}{Support for `wide' Unicode characters}{Written by
953Paul Prescod.}
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000954
955\end{seealso}
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000956
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000957
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000958%======================================================================
959\section{PEP 227: Nested Scopes}
960
961In Python 2.1, statically nested scopes were added as an optional
962feature, to be enabled by a \code{from __future__ import
963nested_scopes} directive. In 2.2 nested scopes no longer need to be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000964specially enabled, and are now always present. The rest of this section
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000965is a copy of the description of nested scopes from my ``What's New in
966Python 2.1'' document; if you read it when 2.1 came out, you can skip
967the rest of this section.
968
969The largest change introduced in Python 2.1, and made complete in 2.2,
970is to Python's scoping rules. In Python 2.0, at any given time there
971are at most three namespaces used to look up variable names: local,
972module-level, and the built-in namespace. This often surprised people
973because it didn't match their intuitive expectations. For example, a
974nested recursive function definition doesn't work:
975
976\begin{verbatim}
977def f():
978 ...
979 def g(value):
980 ...
981 return g(value-1) + 1
982 ...
983\end{verbatim}
984
985The function \function{g()} will always raise a \exception{NameError}
986exception, because the binding of the name \samp{g} isn't in either
987its local namespace or in the module-level namespace. This isn't much
988of a problem in practice (how often do you recursively define interior
989functions like this?), but this also made using the \keyword{lambda}
990statement clumsier, and this was a problem in practice. In code which
991uses \keyword{lambda} you can often find local variables being copied
992by passing them as the default values of arguments.
993
994\begin{verbatim}
995def find(self, name):
996 "Return list of any entries equal to 'name'"
997 L = filter(lambda x, name=name: x == name,
998 self.list_attribute)
999 return L
1000\end{verbatim}
1001
1002The readability of Python code written in a strongly functional style
1003suffers greatly as a result.
1004
1005The most significant change to Python 2.2 is that static scoping has
1006been added to the language to fix this problem. As a first effect,
1007the \code{name=name} default argument is now unnecessary in the above
1008example. Put simply, when a given variable name is not assigned a
1009value within a function (by an assignment, or the \keyword{def},
1010\keyword{class}, or \keyword{import} statements), references to the
1011variable will be looked up in the local namespace of the enclosing
1012scope. A more detailed explanation of the rules, and a dissection of
1013the implementation, can be found in the PEP.
1014
1015This change may cause some compatibility problems for code where the
1016same variable name is used both at the module level and as a local
1017variable within a function that contains further function definitions.
1018This seems rather unlikely though, since such code would have been
1019pretty confusing to read in the first place.
1020
1021One side effect of the change is that the \code{from \var{module}
1022import *} and \keyword{exec} statements have been made illegal inside
1023a function scope under certain conditions. The Python reference
1024manual has said all along that \code{from \var{module} import *} is
1025only legal at the top level of a module, but the CPython interpreter
1026has never enforced this before. As part of the implementation of
1027nested scopes, the compiler which turns Python source into bytecodes
1028has to generate different code to access variables in a containing
1029scope. \code{from \var{module} import *} and \keyword{exec} make it
1030impossible for the compiler to figure this out, because they add names
1031to the local namespace that are unknowable at compile time.
1032Therefore, if a function contains function definitions or
1033\keyword{lambda} expressions with free variables, the compiler will
1034flag this by raising a \exception{SyntaxError} exception.
1035
1036To make the preceding explanation a bit clearer, here's an example:
1037
1038\begin{verbatim}
1039x = 1
1040def f():
1041 # The next line is a syntax error
1042 exec 'x=2'
1043 def g():
1044 return x
1045\end{verbatim}
1046
1047Line 4 containing the \keyword{exec} statement is a syntax error,
1048since \keyword{exec} would define a new local variable named \samp{x}
1049whose value should be accessed by \function{g()}.
1050
1051This shouldn't be much of a limitation, since \keyword{exec} is rarely
1052used in most Python code (and when it is used, it's often a sign of a
1053poor design anyway).
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001054
1055\begin{seealso}
1056
1057\seepep{227}{Statically Nested Scopes}{Written and implemented by
1058Jeremy Hylton.}
1059
1060\end{seealso}
1061
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +00001062
1063%======================================================================
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001064\section{New and Improved Modules}
1065
1066\begin{itemize}
1067
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001068 \item The \module{xmlrpclib} module was contributed to the standard
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001069 library by Fredrik Lundh, providing support for writing XML-RPC
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001070 clients. XML-RPC is a simple remote procedure call protocol built on
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001071 top of HTTP and XML. For example, the following snippet retrieves a
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001072 list of RSS channels from the O'Reilly Network, and then
1073 lists the recent headlines for one channel:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001074
1075\begin{verbatim}
1076import xmlrpclib
1077s = xmlrpclib.Server(
1078 'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
1079channels = s.meerkat.getChannels()
1080# channels is a list of dictionaries, like this:
1081# [{'id': 4, 'title': 'Freshmeat Daily News'}
1082# {'id': 190, 'title': '32Bits Online'},
1083# {'id': 4549, 'title': '3DGamers'}, ... ]
1084
1085# Get the items for one channel
1086items = s.meerkat.getItems( {'channel': 4} )
1087
1088# 'items' is another list of dictionaries, like this:
1089# [{'link': 'http://freshmeat.net/releases/52719/',
1090# 'description': 'A utility which converts HTML to XSL FO.',
1091# 'title': 'html2fo 0.3 (Default)'}, ... ]
1092\end{verbatim}
1093
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001094The \module{SimpleXMLRPCServer} module makes it easy to create
1095straightforward XML-RPC servers. See \url{http://www.xmlrpc.com/} for
1096more information about XML-RPC.
1097
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001098 \item The new \module{hmac} module implements the HMAC
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001099 algorithm described by \rfc{2104}.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001100 (Contributed by Gerhard H\"aring.)
1101
1102 \item Several functions that originally returned lengthy tuples now
1103 return pseudo-sequences that still behave like tuples but also have
1104 mnemonic attributes such as member{st_mtime} or \member{tm_year}.
1105 The enhanced functions include \function{stat()},
1106 \function{fstat()}, \function{statvfs()}, and \function{fstatvfs()}
1107 in the \module{os} module, and \function{localtime()},
1108 \function{gmtime()}, and \function{strptime()} in the \module{time}
1109 module.
1110
1111 For example, to obtain a file's size using the old tuples, you'd end
1112 up writing something like \code{file_size =
1113 os.stat(filename)[stat.ST_SIZE]}, but now this can be written more
1114 clearly as \code{file_size = os.stat(filename).st_size}.
1115
1116 The original patch for this feature was contributed by Nick Mathewson.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001117
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001118 \item The Python profiler has been extensively reworked and various
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001119 errors in its output have been corrected. (Contributed by
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001120 Fred~L. Drake, Jr. and Tim Peters.)
1121
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001122 \item The \module{socket} module can be compiled to support IPv6;
Andrew M. Kuchlingddeb1352001-07-16 14:35:52 +00001123 specify the \longprogramopt{enable-ipv6} option to Python's configure
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001124 script. (Contributed by Jun-ichiro ``itojun'' Hagino.)
1125
1126 \item Two new format characters were added to the \module{struct}
1127 module for 64-bit integers on platforms that support the C
1128 \ctype{long long} type. \samp{q} is for a signed 64-bit integer,
1129 and \samp{Q} is for an unsigned one. The value is returned in
1130 Python's long integer type. (Contributed by Tim Peters.)
1131
1132 \item In the interpreter's interactive mode, there's a new built-in
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001133 function \function{help()} that uses the \module{pydoc} module
1134 introduced in Python 2.1 to provide interactive help.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001135 \code{help(\var{object})} displays any available help text about
Fred Drakea030c762002-05-02 17:55:26 +00001136 \var{object}. \function{help()} with no argument puts you in an online
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001137 help utility, where you can enter the names of functions, classes,
1138 or modules to read their help text.
1139 (Contributed by Guido van Rossum, using Ka-Ping Yee's \module{pydoc} module.)
1140
1141 \item Various bugfixes and performance improvements have been made
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001142 to the SRE engine underlying the \module{re} module. For example,
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001143 the \function{re.sub()} and \function{re.split()} functions have
1144 been rewritten in C. Another contributed patch speeds up certain
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001145 Unicode character ranges by a factor of two, and a new \method{finditer()}
1146 method that returns an iterator over all the non-overlapping matches in
1147 a given string.
1148 (SRE is maintained by
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001149 Fredrik Lundh. The BIGCHARSET patch was contributed by Martin von
1150 L\"owis.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001151
Andrew M. Kuchling1efd7ad2001-09-14 16:19:27 +00001152 \item The \module{smtplib} module now supports \rfc{2487}, ``Secure
1153 SMTP over TLS'', so it's now possible to encrypt the SMTP traffic
1154 between a Python program and the mail transport agent being handed a
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001155 message. \module{smtplib} also supports SMTP authentication.
1156 (Contributed by Gerhard H\"aring.)
Andrew M. Kuchling1efd7ad2001-09-14 16:19:27 +00001157
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +00001158 \item The \module{imaplib} module, maintained by Piers Lauder, has
1159 support for several new extensions: the NAMESPACE extension defined
1160 in \rfc{2342}, SORT, GETACL and SETACL. (Contributed by Anthony
1161 Baxter and Michel Pelletier.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001162
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001163 \item The \module{rfc822} module's parsing of email addresses is now
1164 compliant with \rfc{2822}, an update to \rfc{822}. (The module's
1165 name is \emph{not} going to be changed to \samp{rfc2822}.) A new
1166 package, \module{email}, has also been added for parsing and
1167 generating e-mail messages. (Contributed by Barry Warsaw, and
1168 arising out of his work on Mailman.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001169
Andrew M. Kuchlingbbde5882001-10-31 13:13:36 +00001170 \item The \module{difflib} module now contains a new \class{Differ}
1171 class for producing human-readable lists of changes (a ``delta'')
1172 between two sequences of lines of text. There are also two
1173 generator functions, \function{ndiff()} and \function{restore()},
1174 which respectively return a delta from two sequences, or one of the
1175 original sequences from a delta. (Grunt work contributed by David
1176 Goodger, from ndiff.py code by Tim Peters who then did the
1177 generatorization.)
1178
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001179 \item New constants \constant{ascii_letters},
1180 \constant{ascii_lowercase}, and \constant{ascii_uppercase} were
1181 added to the \module{string} module. There were several modules in
1182 the standard library that used \constant{string.letters} to mean the
1183 ranges A-Za-z, but that assumption is incorrect when locales are in
1184 use, because \constant{string.letters} varies depending on the set
1185 of legal characters defined by the current locale. The buggy
1186 modules have all been fixed to use \constant{ascii_letters} instead.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001187 (Reported by an unknown person; fixed by Fred~L. Drake, Jr.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001188
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001189 \item The \module{mimetypes} module now makes it easier to use
1190 alternative MIME-type databases by the addition of a
1191 \class{MimeTypes} class, which takes a list of filenames to be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001192 parsed. (Contributed by Fred~L. Drake, Jr.)
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001193
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001194 \item A \class{Timer} class was added to the \module{threading}
1195 module that allows scheduling an activity to happen at some future
1196 time. (Contributed by Itamar Shtull-Trauring.)
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +00001197
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001198\end{itemize}
1199
1200
1201%======================================================================
1202\section{Interpreter Changes and Fixes}
1203
1204Some of the changes only affect people who deal with the Python
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001205interpreter at the C level because they're writing Python extension modules,
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001206embedding the interpreter, or just hacking on the interpreter itself.
1207If you only write Python code, none of the changes described here will
1208affect you very much.
1209
1210\begin{itemize}
1211
1212 \item Profiling and tracing functions can now be implemented in C,
1213 which can operate at much higher speeds than Python-based functions
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001214 and should reduce the overhead of profiling and tracing. This
1215 will be of interest to authors of development environments for
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001216 Python. Two new C functions were added to Python's API,
1217 \cfunction{PyEval_SetProfile()} and \cfunction{PyEval_SetTrace()}.
1218 The existing \function{sys.setprofile()} and
1219 \function{sys.settrace()} functions still exist, and have simply
1220 been changed to use the new C-level interface. (Contributed by Fred
1221 L. Drake, Jr.)
1222
1223 \item Another low-level API, primarily of interest to implementors
1224 of Python debuggers and development tools, was added.
1225 \cfunction{PyInterpreterState_Head()} and
1226 \cfunction{PyInterpreterState_Next()} let a caller walk through all
1227 the existing interpreter objects;
1228 \cfunction{PyInterpreterState_ThreadHead()} and
1229 \cfunction{PyThreadState_Next()} allow looping over all the thread
1230 states for a given interpreter. (Contributed by David Beazley.)
1231
Andrew M. Kuchling77ad8292003-08-29 17:49:26 +00001232\item The C-level interface to the garbage collector has been changed
1233to make it easier to write extension types that support garbage
1234collection and to debug misuses of the functions.
1235Various functions have slightly different semantics, so a bunch of
1236functions had to be renamed. Extensions that use the old API will
1237still compile but will \emph{not} participate in garbage collection,
1238so updating them for 2.2 should be considered fairly high priority.
1239
1240To upgrade an extension module to the new API, perform the following
1241steps:
1242
1243\begin{itemize}
1244
1245\item Rename \cfunction{Py_TPFLAGS_GC} to \cfunction{PyTPFLAGS_HAVE_GC}.
1246
1247\item Use \cfunction{PyObject_GC_New} or \cfunction{PyObject_GC_NewVar} to
1248allocate objects, and \cfunction{PyObject_GC_Del} to deallocate them.
1249
1250\item Rename \cfunction{PyObject_GC_Init} to \cfunction{PyObject_GC_Track} and
1251\cfunction{PyObject_GC_Fini} to \cfunction{PyObject_GC_UnTrack}.
1252
1253\item Remove \cfunction{PyGC_HEAD_SIZE} from object size calculations.
1254
1255\item Remove calls to \cfunction{PyObject_AS_GC} and \cfunction{PyObject_FROM_GC}.
1256
1257\end{itemize}
1258
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001259 \item A new \samp{et} format sequence was added to
1260 \cfunction{PyArg_ParseTuple}; \samp{et} takes both a parameter and
1261 an encoding name, and converts the parameter to the given encoding
1262 if the parameter turns out to be a Unicode string, or leaves it
1263 alone if it's an 8-bit string, assuming it to already be in the
1264 desired encoding. This differs from the \samp{es} format character,
1265 which assumes that 8-bit strings are in Python's default ASCII
1266 encoding and converts them to the specified new encoding.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001267 (Contributed by M.-A. Lemburg, and used for the MBCS support on
1268 Windows described in the following section.)
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +00001269
1270 \item A different argument parsing function,
1271 \cfunction{PyArg_UnpackTuple()}, has been added that's simpler and
1272 presumably faster. Instead of specifying a format string, the
1273 caller simply gives the minimum and maximum number of arguments
Fred Drakea030c762002-05-02 17:55:26 +00001274 expected, and a set of pointers to \ctype{PyObject*} variables that
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +00001275 will be filled in with argument values.
1276
Andrew M. Kuchling0ab31b82001-08-29 01:16:54 +00001277 \item Two new flags \constant{METH_NOARGS} and \constant{METH_O} are
1278 available in method definition tables to simplify implementation of
1279 methods with no arguments or a single untyped argument. Calling
1280 such methods is more efficient than calling a corresponding method
1281 that uses \constant{METH_VARARGS}.
1282 Also, the old \constant{METH_OLDARGS} style of writing C methods is
1283 now officially deprecated.
1284
1285\item
1286 Two new wrapper functions, \cfunction{PyOS_snprintf()} and
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001287 \cfunction{PyOS_vsnprintf()} were added to provide
Andrew M. Kuchling0ab31b82001-08-29 01:16:54 +00001288 cross-platform implementations for the relatively new
1289 \cfunction{snprintf()} and \cfunction{vsnprintf()} C lib APIs. In
1290 contrast to the standard \cfunction{sprintf()} and
1291 \cfunction{vsprintf()} functions, the Python versions check the
1292 bounds of the buffer used to protect against buffer overruns.
1293 (Contributed by M.-A. Lemburg.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001294
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +00001295 \item The \cfunction{_PyTuple_Resize()} function has lost an unused
1296 parameter, so now it takes 2 parameters instead of 3. The third
1297 argument was never used, and can simply be discarded when porting
1298 code from earlier versions to Python 2.2.
1299
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001300\end{itemize}
1301
1302
1303%======================================================================
1304\section{Other Changes and Fixes}
1305
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001306As usual there were a bunch of other improvements and bugfixes
1307scattered throughout the source tree. A search through the CVS change
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001308logs finds there were 527 patches applied and 683 bugs fixed between
Andrew M. Kuchlingcab94a12002-11-12 18:59:20 +00001309Python 2.1 and 2.2; 2.2.1 applied 139 patches and fixed 143 bugs;
13102.2.2 applied 106 patches and fixed 82 bugs. These figures are likely
1311to be underestimates.
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001312
1313Some of the more notable changes are:
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001314
1315\begin{itemize}
1316
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001317 \item The code for the MacOS port for Python, maintained by Jack
1318 Jansen, is now kept in the main Python CVS tree, and many changes
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001319 have been made to support MacOS~X.
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001320
1321The most significant change is the ability to build Python as a
1322framework, enabled by supplying the \longprogramopt{enable-framework}
1323option to the configure script when compiling Python. According to
1324Jack Jansen, ``This installs a self-contained Python installation plus
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001325the OS~X framework "glue" into
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001326\file{/Library/Frameworks/Python.framework} (or another location of
1327choice). For now there is little immediate added benefit to this
1328(actually, there is the disadvantage that you have to change your PATH
1329to be able to find Python), but it is the basis for creating a
1330full-blown Python application, porting the MacPython IDE, possibly
1331using Python as a standard OSA scripting language and much more.''
1332
1333Most of the MacPython toolbox modules, which interface to MacOS APIs
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001334such as windowing, QuickTime, scripting, etc. have been ported to OS~X,
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001335but they've been left commented out in \file{setup.py}. People who want
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001336to experiment with these modules can uncomment them manually.
1337
1338% Jack's original comments:
1339%The main change is the possibility to build Python as a
1340%framework. This installs a self-contained Python installation plus the
1341%OSX framework "glue" into /Library/Frameworks/Python.framework (or
1342%another location of choice). For now there is little immedeate added
1343%benefit to this (actually, there is the disadvantage that you have to
1344%change your PATH to be able to find Python), but it is the basis for
1345%creating a fullblown Python application, porting the MacPython IDE,
1346%possibly using Python as a standard OSA scripting language and much
1347%more. You enable this with "configure --enable-framework".
1348
1349%The other change is that most MacPython toolbox modules, which
1350%interface to all the MacOS APIs such as windowing, quicktime,
1351%scripting, etc. have been ported. Again, most of these are not of
1352%immedeate use, as they need a full application to be really useful, so
1353%they have been commented out in setup.py. People wanting to experiment
1354%can uncomment them. Gestalt and Internet Config modules are enabled by
1355%default.
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001356
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001357 \item Keyword arguments passed to builtin functions that don't take them
1358 now cause a \exception{TypeError} exception to be raised, with the
1359 message "\var{function} takes no keyword arguments".
1360
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001361 \item Weak references, added in Python 2.1 as an extension module,
1362 are now part of the core because they're used in the implementation
1363 of new-style classes. The \exception{ReferenceError} exception has
1364 therefore moved from the \module{weakref} module to become a
1365 built-in exception.
1366
Andrew M. Kuchling94a7eba2001-08-15 15:55:48 +00001367 \item A new script, \file{Tools/scripts/cleanfuture.py} by Tim
1368 Peters, automatically removes obsolete \code{__future__} statements
1369 from Python source code.
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001370
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +00001371 \item An additional \var{flags} argument has been added to the
1372 built-in function \function{compile()}, so the behaviour of
1373 \code{__future__} statements can now be correctly observed in
1374 simulated shells, such as those presented by IDLE and other
1375 development environments. This is described in \pep{264}.
1376 (Contributed by Michael Hudson.)
1377
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001378 \item The new license introduced with Python 1.6 wasn't
1379 GPL-compatible. This is fixed by some minor textual changes to the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001380 2.2 license, so it's now legal to embed Python inside a GPLed
1381 program again. Note that Python itself is not GPLed, but instead is
1382 under a license that's essentially equivalent to the BSD license,
1383 same as it always was. The license changes were also applied to the
1384 Python 2.0.1 and 2.1.1 releases.
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001385
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +00001386 \item When presented with a Unicode filename on Windows, Python will
1387 now convert it to an MBCS encoded string, as used by the Microsoft
1388 file APIs. As MBCS is explicitly used by the file APIs, Python's
1389 choice of ASCII as the default encoding turns out to be an
Fred Drakea030c762002-05-02 17:55:26 +00001390 annoyance. On \UNIX, the locale's character set is used if
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001391 \function{locale.nl_langinfo(CODESET)} is available. (Windows
1392 support was contributed by Mark Hammond with assistance from
Fred Drakea030c762002-05-02 17:55:26 +00001393 Marc-Andr\'e Lemburg. \UNIX{} support was added by Martin von L\"owis.)
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001394
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001395 \item Large file support is now enabled on Windows. (Contributed by
1396 Tim Peters.)
1397
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001398 \item The \file{Tools/scripts/ftpmirror.py} script
1399 now parses a \file{.netrc} file, if you have one.
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001400 (Contributed by Mike Romberg.)
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001401
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001402 \item Some features of the object returned by the
1403 \function{xrange()} function are now deprecated, and trigger
1404 warnings when they're accessed; they'll disappear in Python 2.3.
1405 \class{xrange} objects tried to pretend they were full sequence
1406 types by supporting slicing, sequence multiplication, and the
1407 \keyword{in} operator, but these features were rarely used and
1408 therefore buggy. The \method{tolist()} method and the
1409 \member{start}, \member{stop}, and \member{step} attributes are also
1410 being deprecated. At the C level, the fourth argument to the
1411 \cfunction{PyRange_New()} function, \samp{repeat}, has also been
1412 deprecated.
1413
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001414 \item There were a bunch of patches to the dictionary
1415 implementation, mostly to fix potential core dumps if a dictionary
1416 contains objects that sneakily changed their hash value, or mutated
1417 the dictionary they were contained in. For a while python-dev fell
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001418 into a gentle rhythm of Michael Hudson finding a case that dumped
1419 core, Tim Peters fixing the bug, Michael finding another case, and round
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001420 and round it went.
1421
Andrew M. Kuchling33a3b632001-09-04 21:25:58 +00001422 \item On Windows, Python can now be compiled with Borland C thanks
1423 to a number of patches contributed by Stephen Hansen, though the
1424 result isn't fully functional yet. (But this \emph{is} progress...)
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001425
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +00001426 \item Another Windows enhancement: Wise Solutions generously offered
1427 PythonLabs use of their InstallerMaster 8.1 system. Earlier
1428 PythonLabs Windows installers used Wise 5.0a, which was beginning to
1429 show its age. (Packaged up by Tim Peters.)
1430
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001431 \item Files ending in \samp{.pyw} can now be imported on Windows.
1432 \samp{.pyw} is a Windows-only thing, used to indicate that a script
1433 needs to be run using PYTHONW.EXE instead of PYTHON.EXE in order to
1434 prevent a DOS console from popping up to display the output. This
1435 patch makes it possible to import such scripts, in case they're also
1436 usable as modules. (Implemented by David Bolen.)
1437
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001438 \item On platforms where Python uses the C \cfunction{dlopen()} function
1439 to load extension modules, it's now possible to set the flags used
1440 by \cfunction{dlopen()} using the \function{sys.getdlopenflags()} and
1441 \function{sys.setdlopenflags()} functions. (Contributed by Bram Stolk.)
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +00001442
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001443 \item The \function{pow()} built-in function no longer supports 3
1444 arguments when floating-point numbers are supplied.
Andrew M. Kuchling1497b622001-09-24 14:51:16 +00001445 \code{pow(\var{x}, \var{y}, \var{z})} returns \code{(x**y) \% z}, but
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001446 this is never useful for floating point numbers, and the final
1447 result varies unpredictably depending on the platform. A call such
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001448 as \code{pow(2.0, 8.0, 7.0)} will now raise a \exception{TypeError}
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001449 exception.
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001450
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001451\end{itemize}
1452
1453
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001454%======================================================================
1455\section{Acknowledgements}
1456
1457The author would like to thank the following people for offering
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +00001458suggestions, corrections and assistance with various drafts of this
1459article: Fred Bremmer, Keith Briggs, Andrew Dalke, Fred~L. Drake, Jr.,
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +00001460Carel Fellinger, David Goodger, Mark Hammond, Stephen Hansen, Michael
1461Hudson, Jack Jansen, Marc-Andr\'e Lemburg, Martin von L\"owis, Fredrik
1462Lundh, Michael McLay, Nick Mathewson, Paul Moore, Gustavo Niemeyer,
Andrew M. Kuchling17850f72002-04-10 21:53:22 +00001463Don O'Donnell, Joonas Paalasma, Tim Peters, Jens Quade, Tom Reinhardt, Neil
Andrew M. Kuchling71dd7902002-11-12 18:45:46 +00001464Schemenauer, Guido van Rossum, Greg Ward, Edward Welbourne.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001465
1466\end{document}