blob: 6075821ac6d43434a792df877e282add504c4806 [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}
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
Andrew M. Kuchlingcab94a12002-11-12 18:59:20 +000014This article explains the new features in Python 2.2.2, released on
15October 14, 2002. Python 2.2.2 is a bugfix release of Python 2.2,
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +000016originally released on December 21, 2001.
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000017
18Python 2.2 can be thought of as the "cleanup release". There are some
19features such as generators and iterators that are completely new, but
20most of the changes, significant and far-reaching though they may be,
21are aimed at cleaning up irregularities and dark corners of the
22language design.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000023
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000024This article doesn't attempt to provide a complete specification of
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000025the new features, but instead provides a convenient overview. For
26full details, you should refer to the documentation for Python 2.2,
Fred Drake0d002542001-07-17 13:55:33 +000027such as the
Andrew M. Kuchling5e08d102001-12-20 16:33:45 +000028\citetitle[http://www.python.org/doc/2.2/lib/lib.html]{Python
Fred Drake0d002542001-07-17 13:55:33 +000029Library Reference} and the
Andrew M. Kuchling5e08d102001-12-20 16:33:45 +000030\citetitle[http://www.python.org/doc/2.2/ref/ref.html]{Python
31Reference Manual}. If you want to understand the complete
32implementation and design rationale for a change, refer to the PEP for
33a particular new feature.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000034
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000035\begin{seealso}
36
Andrew M. Kuchling2dab9c72001-10-31 13:16:10 +000037\seeurl{http://www.unixreview.com/documents/s=1356/urm0109h/0109h.htm}
Andrew M. Kuchling1497b622001-09-24 14:51:16 +000038{``What's So Special About Python 2.2?'' is also about the new 2.2
39features, and was written by Cameron Laird and Kathryn Soraiz.}
40
41\end{seealso}
42
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000043
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000044%======================================================================
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +000045\section{PEPs 252 and 253: Type and Class Changes}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000046
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000047The largest and most far-reaching changes in Python 2.2 are to
48Python's model of objects and classes. The changes should be backward
49compatible, so it's likely that your code will continue to run
50unchanged, but the changes provide some amazing new capabilities.
51Before beginning this, the longest and most complicated section of
52this article, I'll provide an overview of the changes and offer some
53comments.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000054
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000055A long time ago I wrote a Web page
56(\url{http://www.amk.ca/python/writing/warts.html}) listing flaws in
57Python's design. One of the most significant flaws was that it's
58impossible to subclass Python types implemented in C. In particular,
59it's not possible to subclass built-in types, so you can't just
60subclass, say, lists in order to add a single useful method to them.
61The \module{UserList} module provides a class that supports all of the
62methods of lists and that can be subclassed further, but there's lots
63of C code that expects a regular Python list and won't accept a
64\class{UserList} instance.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000065
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000066Python 2.2 fixes this, and in the process adds some exciting new
67capabilities. A brief summary:
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +000068
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000069\begin{itemize}
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +000070
Andrew M. Kuchling279e7442001-10-22 02:03:40 +000071\item You can subclass built-in types such as lists and even integers,
72and your subclasses should work in every place that requires the
73original type.
74
75\item It's now possible to define static and class methods, in addition
76to the instance methods available in previous versions of Python.
77
78\item It's also possible to automatically call methods on accessing or
79setting an instance attribute by using a new mechanism called
80\dfn{properties}. Many uses of \method{__getattr__} can be rewritten
81to use properties instead, making the resulting code simpler and
82faster. As a small side benefit, attributes can now have docstrings,
83too.
84
85\item The list of legal attributes for an instance can be limited to a
86particular set using \dfn{slots}, making it possible to safeguard
87against typos and perhaps make more optimizations possible in future
88versions of Python.
89
90\end{itemize}
91
92Some users have voiced concern about all these changes. Sure, they
93say, the new features are neat and lend themselves to all sorts of
94tricks that weren't possible in previous versions of Python, but
95they also make the language more complicated. Some people have said
96that they've always recommended Python for its simplicity, and feel
97that its simplicity is being lost.
98
99Personally, I think there's no need to worry. Many of the new
100features are quite esoteric, and you can write a lot of Python code
101without ever needed to be aware of them. Writing a simple class is no
102more difficult than it ever was, so you don't need to bother learning
103or teaching them unless they're actually needed. Some very
104complicated tasks that were previously only possible from C will now
105be possible in pure Python, and to my mind that's all for the better.
106
107I'm not going to attempt to cover every single corner case and small
108change that were required to make the new features work. Instead this
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000109section will paint only the broad strokes. See section~\ref{sect-rellinks},
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000110``Related Links'', for further sources of information about Python 2.2's new
111object model.
112
113
114\subsection{Old and New Classes}
115
116First, you should know that Python 2.2 really has two kinds of
117classes: classic or old-style classes, and new-style classes. The
118old-style class model is exactly the same as the class model in
119earlier versions of Python. All the new features described in this
120section apply only to new-style classes. This divergence isn't
121intended to last forever; eventually old-style classes will be
122dropped, possibly in Python 3.0.
123
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000124So how do you define a new-style class? You do it by subclassing an
125existing new-style class. Most of Python's built-in types, such as
126integers, lists, dictionaries, and even files, are new-style classes
127now. A new-style class named \class{object}, the base class for all
Andrew M. Kuchling71dd7902002-11-12 18:45:46 +0000128built-in types, has also been added so if no built-in type is
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000129suitable, you can just subclass \class{object}:
130
131\begin{verbatim}
132class C(object):
133 def __init__ (self):
134 ...
135 ...
136\end{verbatim}
137
138This means that \keyword{class} statements that don't have any base
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000139classes are always classic classes in Python 2.2. (Actually you can
140also change this by setting a module-level variable named
141\member{__metaclass__} --- see \pep{253} for the details --- but it's
142easier to just subclass \keyword{object}.)
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000143
144The type objects for the built-in types are available as built-ins,
145named using a clever trick. Python has always had built-in functions
146named \function{int()}, \function{float()}, and \function{str()}. In
1472.2, they aren't functions any more, but type objects that behave as
148factories when called.
149
150\begin{verbatim}
151>>> int
152<type 'int'>
153>>> int('123')
154123
155\end{verbatim}
156
157To make the set of types complete, new type objects such as
Andrew M. Kuchling1117d932001-10-29 20:37:47 +0000158\function{dict} and \function{file} have been added. Here's a
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000159more interesting example, adding a \method{lock()} method to file
160objects:
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000161
162\begin{verbatim}
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000163class LockableFile(file):
164 def lock (self, operation, length=0, start=0, whence=0):
165 import fcntl
166 return fcntl.lockf(self.fileno(), operation,
167 length, start, whence)
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000168\end{verbatim}
169
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000170The now-obsolete \module{posixfile} module contained a class that
171emulated all of a file object's methods and also added a
172\method{lock()} method, but this class couldn't be passed to internal
173functions that expected a built-in file, something which is possible
174with our new \class{LockableFile}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000175
176
177\subsection{Descriptors}
178
179In previous versions of Python, there was no consistent way to
180discover what attributes and methods were supported by an object.
181There were some informal conventions, such as defining
182\member{__members__} and \member{__methods__} attributes that were
183lists of names, but often the author of an extension type or a class
184wouldn't bother to define them. You could fall back on inspecting the
185\member{__dict__} of an object, but when class inheritance or an
186arbitrary \method{__getattr__} hook were in use this could still be
187inaccurate.
188
189The one big idea underlying the new class model is that an API for
190describing the attributes of an object using \dfn{descriptors} has
191been formalized. Descriptors specify the value of an attribute,
192stating whether it's a method or a field. With the descriptor API,
193static methods and class methods become possible, as well as more
194exotic constructs.
195
196Attribute descriptors are objects that live inside class objects, and
197have a few attributes of their own:
198
199\begin{itemize}
200
201\item \member{__name__} is the attribute's name.
202
203\item \member{__doc__} is the attribute's docstring.
204
Andrew M. Kuchling9455df22001-12-03 20:55:37 +0000205\item \method{__get__(\var{object})} is a method that retrieves the
206attribute value from \var{object}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000207
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +0000208\item \method{__set__(\var{object}, \var{value})} sets the attribute
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000209on \var{object} to \var{value}.
210
Andrew M. Kuchlingc54fc312001-12-03 20:58:29 +0000211\item \method{__delete__(\var{object}, \var{value})} deletes the \var{value}
Andrew M. Kuchling9455df22001-12-03 20:55:37 +0000212attribute of \var{object}.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000213\end{itemize}
214
215For example, when you write \code{obj.x}, the steps that Python
216actually performs are:
217
218\begin{verbatim}
219descriptor = obj.__class__.x
Andrew M. Kuchling7cc13de2001-10-30 14:22:11 +0000220descriptor.__get__(obj)
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000221\end{verbatim}
222
Andrew M. Kuchling7cc13de2001-10-30 14:22:11 +0000223For methods, \method{descriptor.__get__} returns a temporary object that's
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000224callable, and wraps up the instance and the method to be called on it.
225This is also why static methods and class methods are now possible;
226they have descriptors that wrap up just the method, or the method and
227the class. As a brief explanation of these new kinds of methods,
228static methods aren't passed the instance, and therefore resemble
229regular functions. Class methods are passed the class of the object,
Andrew M. Kuchling72a7fb72001-10-30 22:18:21 +0000230but not the object itself. Static and class methods are defined like
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000231this:
232
233\begin{verbatim}
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000234class C(object):
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000235 def f(arg1, arg2):
236 ...
237 f = staticmethod(f)
238
239 def g(cls, arg1, arg2):
240 ...
241 g = classmethod(g)
242\end{verbatim}
243
244The \function{staticmethod()} function takes the function
245\function{f}, and returns it wrapped up in a descriptor so it can be
246stored in the class object. You might expect there to be special
247syntax for creating such methods (\code{def static f()},
248\code{defstatic f()}, or something like that) but no such syntax has
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000249been defined yet; that's been left for future versions of Python.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000250
251More new features, such as slots and properties, are also implemented
252as new kinds of descriptors, and it's not difficult to write a
253descriptor class that does something novel. For example, it would be
254possible to write a descriptor class that made it possible to write
255Eiffel-style preconditions and postconditions for a method. A class
256that used this feature might be defined like this:
257
258\begin{verbatim}
259from eiffel import eiffelmethod
260
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000261class C(object):
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000262 def f(self, arg1, arg2):
263 # The actual function
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000264 ...
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000265 def pre_f(self):
266 # Check preconditions
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000267 ...
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000268 def post_f(self):
269 # Check postconditions
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000270 ...
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000271
272 f = eiffelmethod(f, pre_f, post_f)
273\end{verbatim}
274
275Note that a person using the new \function{eiffelmethod()} doesn't
276have to understand anything about descriptors. This is why I think
277the new features don't increase the basic complexity of the language.
278There will be a few wizards who need to know about it in order to
279write \function{eiffelmethod()} or the ZODB or whatever, but most
280users will just write code on top of the resulting libraries and
281ignore the implementation details.
282
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000283
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000284\subsection{Multiple Inheritance: The Diamond Rule}
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000285
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000286Multiple inheritance has also been made more useful through changing
287the rules under which names are resolved. Consider this set of classes
288(diagram taken from \pep{253} by Guido van Rossum):
289
290\begin{verbatim}
291 class A:
292 ^ ^ def save(self): ...
293 / \
294 / \
295 / \
296 / \
297 class B class C:
298 ^ ^ def save(self): ...
299 \ /
300 \ /
301 \ /
302 \ /
303 class D
304\end{verbatim}
305
306The lookup rule for classic classes is simple but not very smart; the
307base classes are searched depth-first, going from left to right. A
308reference to \method{D.save} will search the classes \class{D},
309\class{B}, and then \class{A}, where \method{save()} would be found
310and returned. \method{C.save()} would never be found at all. This is
311bad, because if \class{C}'s \method{save()} method is saving some
312internal state specific to \class{C}, not calling it will result in
313that state never getting saved.
314
315New-style classes follow a different algorithm that's a bit more
316complicated to explain, but does the right thing in this situation.
317
318\begin{enumerate}
319
320\item List all the base classes, following the classic lookup rule and
321include a class multiple times if it's visited repeatedly. In the
322above example, the list of visited classes is [\class{D}, \class{B},
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000323\class{A}, \class{C}, \class{A}].
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000324
325\item Scan the list for duplicated classes. If any are found, remove
326all but one occurrence, leaving the \emph{last} one in the list. In
327the above example, the list becomes [\class{D}, \class{B}, \class{C},
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000328\class{A}] after dropping duplicates.
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000329
330\end{enumerate}
331
332Following this rule, referring to \method{D.save()} will return
333\method{C.save()}, which is the behaviour we're after. This lookup
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000334rule is the same as the one followed by Common Lisp. A new built-in
335function, \function{super()}, provides a way to get at a class's
336superclasses without having to reimplement Python's algorithm.
337The most commonly used form will be
338\function{super(\var{class}, \var{obj})}, which returns
339a bound superclass object (not the actual class object). This form
340will be used in methods to call a method in the superclass; for
341example, \class{D}'s \method{save()} method would look like this:
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000342
Andrew M. Kuchlingbec5b362001-12-21 04:39:11 +0000343\begin{verbatim}
344class D:
345 def save (self):
346 # Call superclass .save()
347 super(D, self).save()
348 # Save D's private information here
349 ...
350\end{verbatim}
351
352\function{super()} can also return unbound superclass objects
353when called as \function{super(\var{class})} or
354\function{super(\var{class1}, \var{class2})}, but this probably won't
355often be useful.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000356
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000357
358\subsection{Attribute Access}
359
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000360A fair number of sophisticated Python classes define hooks for
361attribute access using \method{__getattr__}; most commonly this is
362done for convenience, to make code more readable by automatically
363mapping an attribute access such as \code{obj.parent} into a method
364call such as \code{obj.get_parent()}. Python 2.2 adds some new ways
365of controlling attribute access.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000366
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000367First, \method{__getattr__(\var{attr_name})} is still supported by
368new-style classes, and nothing about it has changed. As before, it
369will be called when an attempt is made to access \code{obj.foo} and no
370attribute named \samp{foo} is found in the instance's dictionary.
371
372New-style classes also support a new method,
373\method{__getattribute__(\var{attr_name})}. The difference between
374the two methods is that \method{__getattribute__} is \emph{always}
375called whenever any attribute is accessed, while the old
376\method{__getattr__} is only called if \samp{foo} isn't found in the
377instance's dictionary.
378
379However, Python 2.2's support for \dfn{properties} will often be a
380simpler way to trap attribute references. Writing a
381\method{__getattr__} method is complicated because to avoid recursion
382you can't use regular attribute accesses inside them, and instead have
383to mess around with the contents of \member{__dict__}.
384\method{__getattr__} methods also end up being called by Python when
385it checks for other methods such as \method{__repr__} or
386\method{__coerce__}, and so have to be written with this in mind.
387Finally, calling a function on every attribute access results in a
388sizable performance loss.
389
390\class{property} is a new built-in type that packages up three
391functions that get, set, or delete an attribute, and a docstring. For
392example, if you want to define a \member{size} attribute that's
393computed, but also settable, you could write:
394
395\begin{verbatim}
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +0000396class C(object):
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000397 def get_size (self):
398 result = ... computation ...
399 return result
400 def set_size (self, size):
401 ... compute something based on the size
402 and set internal state appropriately ...
403
404 # Define a property. The 'delete this attribute'
405 # method is defined as None, so the attribute
406 # can't be deleted.
407 size = property(get_size, set_size,
408 None,
409 "Storage size of this instance")
410\end{verbatim}
411
412That is certainly clearer and easier to write than a pair of
413\method{__getattr__}/\method{__setattr__} methods that check for the
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000414\member{size} attribute and handle it specially while retrieving all
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000415other attributes from the instance's \member{__dict__}. Accesses to
416\member{size} are also the only ones which have to perform the work of
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000417calling a function, so references to other attributes run at
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000418their usual speed.
419
420Finally, it's possible to constrain the list of attributes that can be
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000421referenced on an object using the new \member{__slots__} class attribute.
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000422Python objects are usually very dynamic; at any time it's possible to
423define a new attribute on an instance by just doing
424\code{obj.new_attr=1}. This is flexible and convenient, but this
425flexibility can also lead to bugs, as when you meant to write
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000426\code{obj.template = 'a'} but made a typo and wrote
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000427\code{obj.templtae} by accident.
428
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000429A new-style class can define a class attribute named \member{__slots__}
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000430to constrain the list of legal attribute names. An example will make
431this clear:
432
433\begin{verbatim}
434>>> class C(object):
Andrew M. Kuchling038215a2001-12-07 14:22:13 +0000435... __slots__ = ('template', 'name')
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000436...
437>>> obj = C()
438>>> print obj.template
439None
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000440>>> obj.template = 'Test'
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000441>>> print obj.template
442Test
Andrew M. Kuchling28369072001-10-29 15:47:33 +0000443>>> obj.templtae = None
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000444Traceback (most recent call last):
445 File "<stdin>", line 1, in ?
446AttributeError: 'C' object has no attribute 'templtae'
447\end{verbatim}
448
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000449Note how you get an \exception{AttributeError} on the attempt to
450assign to an attribute not listed in \member{__slots__}.
Andrew M. Kuchling4855b022001-10-23 20:26:16 +0000451
452
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000453\subsection{Related Links}
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000454\label{sect-rellinks}
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000455
456This section has just been a quick overview of the new features,
457giving enough of an explanation to start you programming, but many
458details have been simplified or ignored. Where should you go to get a
459more complete picture?
460
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000461\url{http://www.python.org/2.2/descrintro.html} is a lengthy tutorial
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000462introduction to the descriptor features, written by Guido van Rossum.
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000463If my description has whetted your appetite, go read this tutorial
464next, because it goes into much more detail about the new features
465while still remaining quite easy to read.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000466
467Next, there are two relevant PEPs, \pep{252} and \pep{253}. \pep{252}
468is titled "Making Types Look More Like Classes", and covers the
469descriptor API. \pep{253} is titled "Subtyping Built-in Types", and
470describes the changes to type objects that make it possible to subtype
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000471built-in objects. \pep{253} is the more complicated PEP of the two,
472and at a few points the necessary explanations of types and meta-types
473may cause your head to explode. Both PEPs were written and
474implemented by Guido van Rossum, with substantial assistance from the
475rest of the Zope Corp. team.
Andrew M. Kuchling279e7442001-10-22 02:03:40 +0000476
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +0000477Finally, there's the ultimate authority: the source code. Most of the
478machinery for the type handling is in \file{Objects/typeobject.c}, but
479you should only resort to it after all other avenues have been
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000480exhausted, including posting a question to python-list or python-dev.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000481
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000482
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000483%======================================================================
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000484\section{PEP 234: Iterators}
485
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000486Another significant addition to 2.2 is an iteration interface at both
487the C and Python levels. Objects can define how they can be looped
488over by callers.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000489
490In Python versions up to 2.1, the usual way to make \code{for item in
491obj} work is to define a \method{__getitem__()} method that looks
492something like this:
493
494\begin{verbatim}
495 def __getitem__(self, index):
496 return <next item>
497\end{verbatim}
498
499\method{__getitem__()} is more properly used to define an indexing
500operation on an object so that you can write \code{obj[5]} to retrieve
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +0000501the sixth element. It's a bit misleading when you're using this only
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000502to support \keyword{for} loops. Consider some file-like object that
503wants to be looped over; the \var{index} parameter is essentially
504meaningless, as the class probably assumes that a series of
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000505\method{__getitem__()} calls will be made with \var{index}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000506incrementing by one each time. In other words, the presence of the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000507\method{__getitem__()} method doesn't mean that using \code{file[5]}
508to randomly access the sixth element will work, though it really should.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000509
510In Python 2.2, iteration can be implemented separately, and
511\method{__getitem__()} methods can be limited to classes that really
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000512do support random access. The basic idea of iterators is
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000513simple. A new built-in function, \function{iter(obj)} or
514\code{iter(\var{C}, \var{sentinel})}, is used to get an iterator.
515\function{iter(obj)} returns an iterator for the object \var{obj},
516while \code{iter(\var{C}, \var{sentinel})} returns an iterator that
517will invoke the callable object \var{C} until it returns
518\var{sentinel} to signal that the iterator is done.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000519
520Python classes can define an \method{__iter__()} method, which should
521create and return a new iterator for the object; if the object is its
522own iterator, this method can just return \code{self}. In particular,
523iterators will usually be their own iterators. Extension types
Fred Drakea030c762002-05-02 17:55:26 +0000524implemented in C can implement a \member{tp_iter} function in order to
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000525return an iterator, and extension types that want to behave as
Fred Drakea030c762002-05-02 17:55:26 +0000526iterators can define a \member{tp_iternext} function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000527
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000528So, after all this, what do iterators actually do? They have one
529required method, \method{next()}, which takes no arguments and returns
530the next value. When there are no more values to be returned, calling
531\method{next()} should raise the \exception{StopIteration} exception.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000532
533\begin{verbatim}
534>>> L = [1,2,3]
535>>> i = iter(L)
536>>> print i
537<iterator object at 0x8116870>
538>>> i.next()
5391
540>>> i.next()
5412
542>>> i.next()
5433
544>>> i.next()
545Traceback (most recent call last):
546 File "<stdin>", line 1, in ?
547StopIteration
548>>>
549\end{verbatim}
550
551In 2.2, Python's \keyword{for} statement no longer expects a sequence;
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000552it expects something for which \function{iter()} will return an iterator.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000553For backward compatibility and convenience, an iterator is
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000554automatically constructed for sequences that don't implement
Fred Drakea030c762002-05-02 17:55:26 +0000555\method{__iter__()} or a \member{tp_iter} slot, so \code{for i in
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000556[1,2,3]} will still work. Wherever the Python interpreter loops over
557a sequence, it's been changed to use the iterator protocol. This
558means you can do things like this:
559
560\begin{verbatim}
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000561>>> L = [1,2,3]
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000562>>> i = iter(L)
563>>> a,b,c = i
564>>> a,b,c
565(1, 2, 3)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000566\end{verbatim}
567
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000568Iterator support has been added to some of Python's basic types.
Fred Drake0d002542001-07-17 13:55:33 +0000569Calling \function{iter()} on a dictionary will return an iterator
Andrew M. Kuchling6ea9f0b2001-07-17 14:50:31 +0000570which loops over its keys:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000571
572\begin{verbatim}
573>>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
574... 'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
575>>> for key in m: print key, m[key]
576...
577Mar 3
578Feb 2
579Aug 8
580Sep 9
581May 5
582Jun 6
583Jul 7
584Jan 1
585Apr 4
586Nov 11
587Dec 12
588Oct 10
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000589\end{verbatim}
590
591That's just the default behaviour. If you want to iterate over keys,
592values, or key/value pairs, you can explicitly call the
593\method{iterkeys()}, \method{itervalues()}, or \method{iteritems()}
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000594methods to get an appropriate iterator. In a minor related change,
595the \keyword{in} operator now works on dictionaries, so
596\code{\var{key} in dict} is now equivalent to
597\code{dict.has_key(\var{key})}.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000598
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000599Files also provide an iterator, which calls the \method{readline()}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000600method until there are no more lines in the file. This means you can
601now read each line of a file using code like this:
602
603\begin{verbatim}
604for line in file:
605 # do something for each line
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000606 ...
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000607\end{verbatim}
608
609Note that you can only go forward in an iterator; there's no way to
610get the previous element, reset the iterator, or make a copy of it.
Fred Drake0d002542001-07-17 13:55:33 +0000611An iterator object could provide such additional capabilities, but the
612iterator protocol only requires a \method{next()} method.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000613
614\begin{seealso}
615
616\seepep{234}{Iterators}{Written by Ka-Ping Yee and GvR; implemented
617by the Python Labs crew, mostly by GvR and Tim Peters.}
618
619\end{seealso}
620
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000621
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000622%======================================================================
623\section{PEP 255: Simple Generators}
624
625Generators are another new feature, one that interacts with the
626introduction of iterators.
627
628You're doubtless familiar with how function calls work in Python or
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000629C. When you call a function, it gets a private namespace where its local
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000630variables are created. When the function reaches a \keyword{return}
631statement, the local variables are destroyed and the resulting value
632is returned to the caller. A later call to the same function will get
633a fresh new set of local variables. But, what if the local variables
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000634weren't thrown away on exiting a function? What if you could later
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000635resume the function where it left off? This is what generators
636provide; they can be thought of as resumable functions.
637
638Here's the simplest example of a generator function:
639
640\begin{verbatim}
641def generate_ints(N):
642 for i in range(N):
643 yield i
644\end{verbatim}
645
646A new keyword, \keyword{yield}, was introduced for generators. Any
647function containing a \keyword{yield} statement is a generator
648function; this is detected by Python's bytecode compiler which
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000649compiles the function specially as a result. Because a new keyword was
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000650introduced, generators must be explicitly enabled in a module by
651including a \code{from __future__ import generators} statement near
652the top of the module's source code. In Python 2.3 this statement
653will become unnecessary.
654
655When you call a generator function, it doesn't return a single value;
656instead it returns a generator object that supports the iterator
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000657protocol. On executing the \keyword{yield} statement, the generator
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000658outputs the value of \code{i}, similar to a \keyword{return}
659statement. The big difference between \keyword{yield} and a
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000660\keyword{return} statement is that on reaching a \keyword{yield} the
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000661generator's state of execution is suspended and local variables are
Fred Drakea030c762002-05-02 17:55:26 +0000662preserved. On the next call to the generator's \code{next()} method,
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000663the function will resume executing immediately after the
664\keyword{yield} statement. (For complicated reasons, the
665\keyword{yield} statement isn't allowed inside the \keyword{try} block
Fred Drakea030c762002-05-02 17:55:26 +0000666of a \keyword{try}...\keyword{finally} statement; read \pep{255} for a full
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000667explanation of the interaction between \keyword{yield} and
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000668exceptions.)
669
670Here's a sample usage of the \function{generate_ints} generator:
671
672\begin{verbatim}
673>>> gen = generate_ints(3)
674>>> gen
675<generator object at 0x8117f90>
676>>> gen.next()
6770
678>>> gen.next()
6791
680>>> gen.next()
6812
682>>> gen.next()
683Traceback (most recent call last):
684 File "<stdin>", line 1, in ?
685 File "<stdin>", line 2, in generate_ints
686StopIteration
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000687\end{verbatim}
688
689You could equally write \code{for i in generate_ints(5)}, or
690\code{a,b,c = generate_ints(3)}.
691
692Inside a generator function, the \keyword{return} statement can only
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000693be used without a value, and signals the end of the procession of
694values; afterwards the generator cannot return any further values.
695\keyword{return} with a value, such as \code{return 5}, is a syntax
696error inside a generator function. The end of the generator's results
697can also be indicated by raising \exception{StopIteration} manually,
698or by just letting the flow of execution fall off the bottom of the
699function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000700
701You could achieve the effect of generators manually by writing your
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000702own class and storing all the local variables of the generator as
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000703instance variables. For example, returning a list of integers could
704be done by setting \code{self.count} to 0, and having the
705\method{next()} method increment \code{self.count} and return it.
Andrew M. Kuchlingc32cc7c2001-07-17 18:25:01 +0000706However, for a moderately complicated generator, writing a
707corresponding class would be much messier.
708\file{Lib/test/test_generators.py} contains a number of more
709interesting examples. The simplest one implements an in-order
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000710traversal of a tree using generators recursively.
711
712\begin{verbatim}
713# A recursive generator that generates Tree leaves in in-order.
714def inorder(t):
715 if t:
716 for x in inorder(t.left):
717 yield x
718 yield t.label
719 for x in inorder(t.right):
720 yield x
721\end{verbatim}
722
723Two other examples in \file{Lib/test/test_generators.py} produce
724solutions for the N-Queens problem (placing $N$ queens on an $NxN$
725chess board so that no queen threatens another) and the Knight's Tour
726(a route that takes a knight to every square of an $NxN$ chessboard
727without visiting any square twice).
728
729The idea of generators comes from other programming languages,
730especially Icon (\url{http://www.cs.arizona.edu/icon/}), where the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000731idea of generators is central. In Icon, every
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000732expression and function call behaves like a generator. One example
733from ``An Overview of the Icon Programming Language'' at
734\url{http://www.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of
735what this looks like:
736
737\begin{verbatim}
738sentence := "Store it in the neighboring harbor"
739if (i := find("or", sentence)) > 5 then write(i)
740\end{verbatim}
741
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000742In Icon the \function{find()} function returns the indexes at which the
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000743substring ``or'' is found: 3, 23, 33. In the \keyword{if} statement,
744\code{i} is first assigned a value of 3, but 3 is less than 5, so the
745comparison fails, and Icon retries it with the second value of 23. 23
746is greater than 5, so the comparison now succeeds, and the code prints
747the value 23 to the screen.
748
749Python doesn't go nearly as far as Icon in adopting generators as a
750central concept. Generators are considered a new part of the core
751Python language, but learning or using them isn't compulsory; if they
752don't solve any problems that you have, feel free to ignore them.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000753One novel feature of Python's interface as compared to
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000754Icon's is that a generator's state is represented as a concrete object
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000755(the iterator) that can be passed around to other functions or stored
756in a data structure.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000757
758\begin{seealso}
759
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000760\seepep{255}{Simple Generators}{Written by Neil Schemenauer, Tim
761Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
762and Tim Peters, with other fixes from the Python Labs crew.}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000763
764\end{seealso}
765
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000766
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000767%======================================================================
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000768\section{PEP 237: Unifying Long Integers and Integers}
769
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000770In recent versions, the distinction between regular integers, which
771are 32-bit values on most machines, and long integers, which can be of
772arbitrary size, was becoming an annoyance. For example, on platforms
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000773that support files larger than \code{2**32} bytes, the
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000774\method{tell()} method of file objects has to return a long integer.
775However, there were various bits of Python that expected plain
776integers and would raise an error if a long integer was provided
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +0000777instead. For example, in Python 1.5, only regular integers
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000778could be used as a slice index, and \code{'abc'[1L:]} would raise a
779\exception{TypeError} exception with the message 'slice index must be
780int'.
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000781
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000782Python 2.2 will shift values from short to long integers as required.
783The 'L' suffix is no longer needed to indicate a long integer literal,
784as now the compiler will choose the appropriate type. (Using the 'L'
785suffix will be discouraged in future 2.x versions of Python,
786triggering a warning in Python 2.4, and probably dropped in Python
7873.0.) Many operations that used to raise an \exception{OverflowError}
788will now return a long integer as their result. For example:
789
790\begin{verbatim}
791>>> 1234567890123
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00007921234567890123L
793>>> 2 ** 64
79418446744073709551616L
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000795\end{verbatim}
796
797In most cases, integers and long integers will now be treated
798identically. You can still distinguish them with the
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000799\function{type()} built-in function, but that's rarely needed.
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000800
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000801\begin{seealso}
802
803\seepep{237}{Unifying Long Integers and Integers}{Written by
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000804Moshe Zadka and Guido van Rossum. Implemented mostly by Guido van
805Rossum.}
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +0000806
807\end{seealso}
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000808
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +0000809
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +0000810%======================================================================
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000811\section{PEP 238: Changing the Division Operator}
812
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000813The most controversial change in Python 2.2 heralds the start of an effort
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000814to fix an old design flaw that's been in Python from the beginning.
815Currently Python's division operator, \code{/}, behaves like C's
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000816division operator when presented with two integer arguments: it
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000817returns an integer result that's truncated down when there would be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000818a fractional part. For example, \code{3/2} is 1, not 1.5, and
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000819\code{(-1)/2} is -1, not -0.5. This means that the results of divison
820can vary unexpectedly depending on the type of the two operands and
821because Python is dynamically typed, it can be difficult to determine
822the possible types of the operands.
823
824(The controversy is over whether this is \emph{really} a design flaw,
825and whether it's worth breaking existing code to fix this. It's
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000826caused endless discussions on python-dev, and in July 2001 erupted into an
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000827storm of acidly sarcastic postings on \newsgroup{comp.lang.python}. I
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000828won't argue for either side here and will stick to describing what's
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000829implemented in 2.2. Read \pep{238} for a summary of arguments and
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000830counter-arguments.)
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000831
832Because this change might break code, it's being introduced very
833gradually. Python 2.2 begins the transition, but the switch won't be
834complete until Python 3.0.
835
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000836First, I'll borrow some terminology from \pep{238}. ``True division'' is the
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000837division that most non-programmers are familiar with: 3/2 is 1.5, 1/4
838is 0.25, and so forth. ``Floor division'' is what Python's \code{/}
839operator currently does when given integer operands; the result is the
840floor of the value returned by true division. ``Classic division'' is
841the current mixed behaviour of \code{/}; it returns the result of
842floor division when the operands are integers, and returns the result
843of true division when one of the operands is a floating-point number.
844
845Here are the changes 2.2 introduces:
846
847\begin{itemize}
848
849\item A new operator, \code{//}, is the floor division operator.
850(Yes, we know it looks like \Cpp's comment symbol.) \code{//}
Andrew M. Kuchling7aa63c22001-10-30 14:35:03 +0000851\emph{always} performs floor division no matter what the types of
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000852its operands are, so \code{1 // 2} is 0 and \code{1.0 // 2.0} is also
8530.0.
854
855\code{//} is always available in Python 2.2; you don't need to enable
856it using a \code{__future__} statement.
857
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +0000858\item By including a \code{from __future__ import division} in a
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000859module, the \code{/} operator will be changed to return the result of
860true division, so \code{1/2} is 0.5. Without the \code{__future__}
861statement, \code{/} still means classic division. The default meaning
862of \code{/} will not change until Python 3.0.
863
864\item Classes can define methods called \method{__truediv__} and
865\method{__floordiv__} to overload the two division operators. At the
Fred Drakea030c762002-05-02 17:55:26 +0000866C level, there are also slots in the \ctype{PyNumberMethods} structure
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000867so extension types can define the two operators.
868
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000869\item Python 2.2 supports some command-line arguments for testing
870whether code will works with the changed division semantics. Running
871python with \programopt{-Q warn} will cause a warning to be issued
872whenever division is applied to two integers. You can use this to
873find code that's affected by the change and fix it. By default,
874Python 2.2 will simply perform classic division without a warning; the
875warning will be turned on by default in Python 2.3.
Andrew M. Kuchling9e9c1352001-08-11 03:06:50 +0000876
877\end{itemize}
878
879\begin{seealso}
880
881\seepep{238}{Changing the Division Operator}{Written by Moshe Zadka and
882Guido van Rossum. Implemented by Guido van Rossum..}
883
884\end{seealso}
885
886
887%======================================================================
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000888\section{Unicode Changes}
889
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000890Python's Unicode support has been enhanced a bit in 2.2. Unicode
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000891strings are usually stored as UCS-2, as 16-bit unsigned integers.
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000892Python 2.2 can also be compiled to use UCS-4, 32-bit unsigned
893integers, as its internal encoding by supplying
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000894\longprogramopt{enable-unicode=ucs4} to the configure script.
895(It's also possible to specify
896\longprogramopt{disable-unicode} to completely disable Unicode
897support.)
898
899When built to use UCS-4 (a ``wide Python''), the interpreter can
900natively handle Unicode characters from U+000000 to U+110000, so the
901range of legal values for the \function{unichr()} function is expanded
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +0000902accordingly. Using an interpreter compiled to use UCS-2 (a ``narrow
903Python''), values greater than 65535 will still cause
904\function{unichr()} to raise a \exception{ValueError} exception.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000905This is all described in \pep{261}, ``Support for `wide' Unicode
906characters''; consult it for further details.
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000907
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000908Another change is simpler to explain. Since their introduction,
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000909Unicode strings have supported an \method{encode()} method to convert
910the string to a selected encoding such as UTF-8 or Latin-1. A
911symmetric \method{decode(\optional{\var{encoding}})} method has been
912added to 8-bit strings (though not to Unicode strings) in 2.2.
913\method{decode()} assumes that the string is in the specified encoding
914and decodes it, returning whatever is returned by the codec.
915
916Using this new feature, codecs have been added for tasks not directly
917related to Unicode. For example, codecs have been added for
918uu-encoding, MIME's base64 encoding, and compression with the
919\module{zlib} module:
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000920
921\begin{verbatim}
922>>> s = """Here is a lengthy piece of redundant, overly verbose,
923... and repetitive text.
924... """
925>>> data = s.encode('zlib')
926>>> data
927'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
928>>> data.decode('zlib')
929'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
930>>> print s.encode('uu')
931begin 666 <data>
932M2&5R92!I<R!A(&QE;F=T:'D@<&EE8V4@;V8@<F5D=6YD86YT+"!O=F5R;'D@
933>=F5R8F]S92P*86YD(')E<&5T:71I=F4@=&5X="X*
934
935end
936>>> "sheesh".encode('rot-13')
937'furrfu'
938\end{verbatim}
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000939
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000940To convert a class instance to Unicode, a \method{__unicode__} method
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000941can be defined by a class, analogous to \method{__str__}.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000942
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000943\method{encode()}, \method{decode()}, and \method{__unicode__} were
944implemented by Marc-Andr\'e Lemburg. The changes to support using
945UCS-4 internally were implemented by Fredrik Lundh and Martin von
946L\"owis.
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000947
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000948\begin{seealso}
949
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +0000950\seepep{261}{Support for `wide' Unicode characters}{Written by
951Paul Prescod.}
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000952
953\end{seealso}
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000954
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +0000955
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000956%======================================================================
957\section{PEP 227: Nested Scopes}
958
959In Python 2.1, statically nested scopes were added as an optional
960feature, to be enabled by a \code{from __future__ import
961nested_scopes} directive. In 2.2 nested scopes no longer need to be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +0000962specially enabled, and are now always present. The rest of this section
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000963is a copy of the description of nested scopes from my ``What's New in
964Python 2.1'' document; if you read it when 2.1 came out, you can skip
965the rest of this section.
966
967The largest change introduced in Python 2.1, and made complete in 2.2,
968is to Python's scoping rules. In Python 2.0, at any given time there
969are at most three namespaces used to look up variable names: local,
970module-level, and the built-in namespace. This often surprised people
971because it didn't match their intuitive expectations. For example, a
972nested recursive function definition doesn't work:
973
974\begin{verbatim}
975def f():
976 ...
977 def g(value):
978 ...
979 return g(value-1) + 1
980 ...
981\end{verbatim}
982
983The function \function{g()} will always raise a \exception{NameError}
984exception, because the binding of the name \samp{g} isn't in either
985its local namespace or in the module-level namespace. This isn't much
986of a problem in practice (how often do you recursively define interior
987functions like this?), but this also made using the \keyword{lambda}
988statement clumsier, and this was a problem in practice. In code which
989uses \keyword{lambda} you can often find local variables being copied
990by passing them as the default values of arguments.
991
992\begin{verbatim}
993def find(self, name):
994 "Return list of any entries equal to 'name'"
995 L = filter(lambda x, name=name: x == name,
996 self.list_attribute)
997 return L
998\end{verbatim}
999
1000The readability of Python code written in a strongly functional style
1001suffers greatly as a result.
1002
1003The most significant change to Python 2.2 is that static scoping has
1004been added to the language to fix this problem. As a first effect,
1005the \code{name=name} default argument is now unnecessary in the above
1006example. Put simply, when a given variable name is not assigned a
1007value within a function (by an assignment, or the \keyword{def},
1008\keyword{class}, or \keyword{import} statements), references to the
1009variable will be looked up in the local namespace of the enclosing
1010scope. A more detailed explanation of the rules, and a dissection of
1011the implementation, can be found in the PEP.
1012
1013This change may cause some compatibility problems for code where the
1014same variable name is used both at the module level and as a local
1015variable within a function that contains further function definitions.
1016This seems rather unlikely though, since such code would have been
1017pretty confusing to read in the first place.
1018
1019One side effect of the change is that the \code{from \var{module}
1020import *} and \keyword{exec} statements have been made illegal inside
1021a function scope under certain conditions. The Python reference
1022manual has said all along that \code{from \var{module} import *} is
1023only legal at the top level of a module, but the CPython interpreter
1024has never enforced this before. As part of the implementation of
1025nested scopes, the compiler which turns Python source into bytecodes
1026has to generate different code to access variables in a containing
1027scope. \code{from \var{module} import *} and \keyword{exec} make it
1028impossible for the compiler to figure this out, because they add names
1029to the local namespace that are unknowable at compile time.
1030Therefore, if a function contains function definitions or
1031\keyword{lambda} expressions with free variables, the compiler will
1032flag this by raising a \exception{SyntaxError} exception.
1033
1034To make the preceding explanation a bit clearer, here's an example:
1035
1036\begin{verbatim}
1037x = 1
1038def f():
1039 # The next line is a syntax error
1040 exec 'x=2'
1041 def g():
1042 return x
1043\end{verbatim}
1044
1045Line 4 containing the \keyword{exec} statement is a syntax error,
1046since \keyword{exec} would define a new local variable named \samp{x}
1047whose value should be accessed by \function{g()}.
1048
1049This shouldn't be much of a limitation, since \keyword{exec} is rarely
1050used in most Python code (and when it is used, it's often a sign of a
1051poor design anyway).
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001052
1053\begin{seealso}
1054
1055\seepep{227}{Statically Nested Scopes}{Written and implemented by
1056Jeremy Hylton.}
1057
1058\end{seealso}
1059
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +00001060
1061%======================================================================
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001062\section{New and Improved Modules}
1063
1064\begin{itemize}
1065
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001066 \item The \module{xmlrpclib} module was contributed to the standard
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001067 library by Fredrik Lundh, providing support for writing XML-RPC
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001068 clients. XML-RPC is a simple remote procedure call protocol built on
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001069 top of HTTP and XML. For example, the following snippet retrieves a
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001070 list of RSS channels from the O'Reilly Network, and then
1071 lists the recent headlines for one channel:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001072
1073\begin{verbatim}
1074import xmlrpclib
1075s = xmlrpclib.Server(
1076 'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
1077channels = s.meerkat.getChannels()
1078# channels is a list of dictionaries, like this:
1079# [{'id': 4, 'title': 'Freshmeat Daily News'}
1080# {'id': 190, 'title': '32Bits Online'},
1081# {'id': 4549, 'title': '3DGamers'}, ... ]
1082
1083# Get the items for one channel
1084items = s.meerkat.getItems( {'channel': 4} )
1085
1086# 'items' is another list of dictionaries, like this:
1087# [{'link': 'http://freshmeat.net/releases/52719/',
1088# 'description': 'A utility which converts HTML to XSL FO.',
1089# 'title': 'html2fo 0.3 (Default)'}, ... ]
1090\end{verbatim}
1091
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001092The \module{SimpleXMLRPCServer} module makes it easy to create
1093straightforward XML-RPC servers. See \url{http://www.xmlrpc.com/} for
1094more information about XML-RPC.
1095
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001096 \item The new \module{hmac} module implements the HMAC
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001097 algorithm described by \rfc{2104}.
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001098 (Contributed by Gerhard H\"aring.)
1099
1100 \item Several functions that originally returned lengthy tuples now
1101 return pseudo-sequences that still behave like tuples but also have
1102 mnemonic attributes such as member{st_mtime} or \member{tm_year}.
1103 The enhanced functions include \function{stat()},
1104 \function{fstat()}, \function{statvfs()}, and \function{fstatvfs()}
1105 in the \module{os} module, and \function{localtime()},
1106 \function{gmtime()}, and \function{strptime()} in the \module{time}
1107 module.
1108
1109 For example, to obtain a file's size using the old tuples, you'd end
1110 up writing something like \code{file_size =
1111 os.stat(filename)[stat.ST_SIZE]}, but now this can be written more
1112 clearly as \code{file_size = os.stat(filename).st_size}.
1113
1114 The original patch for this feature was contributed by Nick Mathewson.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001115
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001116 \item The Python profiler has been extensively reworked and various
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001117 errors in its output have been corrected. (Contributed by
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001118 Fred~L. Drake, Jr. and Tim Peters.)
1119
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001120 \item The \module{socket} module can be compiled to support IPv6;
Andrew M. Kuchlingddeb1352001-07-16 14:35:52 +00001121 specify the \longprogramopt{enable-ipv6} option to Python's configure
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001122 script. (Contributed by Jun-ichiro ``itojun'' Hagino.)
1123
1124 \item Two new format characters were added to the \module{struct}
1125 module for 64-bit integers on platforms that support the C
1126 \ctype{long long} type. \samp{q} is for a signed 64-bit integer,
1127 and \samp{Q} is for an unsigned one. The value is returned in
1128 Python's long integer type. (Contributed by Tim Peters.)
1129
1130 \item In the interpreter's interactive mode, there's a new built-in
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001131 function \function{help()} that uses the \module{pydoc} module
1132 introduced in Python 2.1 to provide interactive help.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001133 \code{help(\var{object})} displays any available help text about
Fred Drakea030c762002-05-02 17:55:26 +00001134 \var{object}. \function{help()} with no argument puts you in an online
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001135 help utility, where you can enter the names of functions, classes,
1136 or modules to read their help text.
1137 (Contributed by Guido van Rossum, using Ka-Ping Yee's \module{pydoc} module.)
1138
1139 \item Various bugfixes and performance improvements have been made
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001140 to the SRE engine underlying the \module{re} module. For example,
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001141 the \function{re.sub()} and \function{re.split()} functions have
1142 been rewritten in C. Another contributed patch speeds up certain
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001143 Unicode character ranges by a factor of two, and a new \method{finditer()}
1144 method that returns an iterator over all the non-overlapping matches in
1145 a given string.
1146 (SRE is maintained by
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001147 Fredrik Lundh. The BIGCHARSET patch was contributed by Martin von
1148 L\"owis.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001149
Andrew M. Kuchling1efd7ad2001-09-14 16:19:27 +00001150 \item The \module{smtplib} module now supports \rfc{2487}, ``Secure
1151 SMTP over TLS'', so it's now possible to encrypt the SMTP traffic
1152 between a Python program and the mail transport agent being handed a
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001153 message. \module{smtplib} also supports SMTP authentication.
1154 (Contributed by Gerhard H\"aring.)
Andrew M. Kuchling1efd7ad2001-09-14 16:19:27 +00001155
Andrew M. Kuchlinga6d2a042001-07-20 18:34:34 +00001156 \item The \module{imaplib} module, maintained by Piers Lauder, has
1157 support for several new extensions: the NAMESPACE extension defined
1158 in \rfc{2342}, SORT, GETACL and SETACL. (Contributed by Anthony
1159 Baxter and Michel Pelletier.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001160
Andrew M. Kuchlingd4707e32001-09-28 20:46:46 +00001161 \item The \module{rfc822} module's parsing of email addresses is now
1162 compliant with \rfc{2822}, an update to \rfc{822}. (The module's
1163 name is \emph{not} going to be changed to \samp{rfc2822}.) A new
1164 package, \module{email}, has also been added for parsing and
1165 generating e-mail messages. (Contributed by Barry Warsaw, and
1166 arising out of his work on Mailman.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001167
Andrew M. Kuchlingbbde5882001-10-31 13:13:36 +00001168 \item The \module{difflib} module now contains a new \class{Differ}
1169 class for producing human-readable lists of changes (a ``delta'')
1170 between two sequences of lines of text. There are also two
1171 generator functions, \function{ndiff()} and \function{restore()},
1172 which respectively return a delta from two sequences, or one of the
1173 original sequences from a delta. (Grunt work contributed by David
1174 Goodger, from ndiff.py code by Tim Peters who then did the
1175 generatorization.)
1176
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001177 \item New constants \constant{ascii_letters},
1178 \constant{ascii_lowercase}, and \constant{ascii_uppercase} were
1179 added to the \module{string} module. There were several modules in
1180 the standard library that used \constant{string.letters} to mean the
1181 ranges A-Za-z, but that assumption is incorrect when locales are in
1182 use, because \constant{string.letters} varies depending on the set
1183 of legal characters defined by the current locale. The buggy
1184 modules have all been fixed to use \constant{ascii_letters} instead.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001185 (Reported by an unknown person; fixed by Fred~L. Drake, Jr.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001186
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001187 \item The \module{mimetypes} module now makes it easier to use
1188 alternative MIME-type databases by the addition of a
1189 \class{MimeTypes} class, which takes a list of filenames to be
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001190 parsed. (Contributed by Fred~L. Drake, Jr.)
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001191
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001192 \item A \class{Timer} class was added to the \module{threading}
1193 module that allows scheduling an activity to happen at some future
1194 time. (Contributed by Itamar Shtull-Trauring.)
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +00001195
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001196\end{itemize}
1197
1198
1199%======================================================================
1200\section{Interpreter Changes and Fixes}
1201
1202Some of the changes only affect people who deal with the Python
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001203interpreter at the C level because they're writing Python extension modules,
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001204embedding the interpreter, or just hacking on the interpreter itself.
1205If you only write Python code, none of the changes described here will
1206affect you very much.
1207
1208\begin{itemize}
1209
1210 \item Profiling and tracing functions can now be implemented in C,
1211 which can operate at much higher speeds than Python-based functions
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001212 and should reduce the overhead of profiling and tracing. This
1213 will be of interest to authors of development environments for
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001214 Python. Two new C functions were added to Python's API,
1215 \cfunction{PyEval_SetProfile()} and \cfunction{PyEval_SetTrace()}.
1216 The existing \function{sys.setprofile()} and
1217 \function{sys.settrace()} functions still exist, and have simply
1218 been changed to use the new C-level interface. (Contributed by Fred
1219 L. Drake, Jr.)
1220
1221 \item Another low-level API, primarily of interest to implementors
1222 of Python debuggers and development tools, was added.
1223 \cfunction{PyInterpreterState_Head()} and
1224 \cfunction{PyInterpreterState_Next()} let a caller walk through all
1225 the existing interpreter objects;
1226 \cfunction{PyInterpreterState_ThreadHead()} and
1227 \cfunction{PyThreadState_Next()} allow looping over all the thread
1228 states for a given interpreter. (Contributed by David Beazley.)
1229
1230 \item A new \samp{et} format sequence was added to
1231 \cfunction{PyArg_ParseTuple}; \samp{et} takes both a parameter and
1232 an encoding name, and converts the parameter to the given encoding
1233 if the parameter turns out to be a Unicode string, or leaves it
1234 alone if it's an 8-bit string, assuming it to already be in the
1235 desired encoding. This differs from the \samp{es} format character,
1236 which assumes that 8-bit strings are in Python's default ASCII
1237 encoding and converts them to the specified new encoding.
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001238 (Contributed by M.-A. Lemburg, and used for the MBCS support on
1239 Windows described in the following section.)
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +00001240
1241 \item A different argument parsing function,
1242 \cfunction{PyArg_UnpackTuple()}, has been added that's simpler and
1243 presumably faster. Instead of specifying a format string, the
1244 caller simply gives the minimum and maximum number of arguments
Fred Drakea030c762002-05-02 17:55:26 +00001245 expected, and a set of pointers to \ctype{PyObject*} variables that
Andrew M. Kuchlingcf31d5d2001-10-26 20:37:55 +00001246 will be filled in with argument values.
1247
Andrew M. Kuchling0ab31b82001-08-29 01:16:54 +00001248 \item Two new flags \constant{METH_NOARGS} and \constant{METH_O} are
1249 available in method definition tables to simplify implementation of
1250 methods with no arguments or a single untyped argument. Calling
1251 such methods is more efficient than calling a corresponding method
1252 that uses \constant{METH_VARARGS}.
1253 Also, the old \constant{METH_OLDARGS} style of writing C methods is
1254 now officially deprecated.
1255
1256\item
1257 Two new wrapper functions, \cfunction{PyOS_snprintf()} and
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001258 \cfunction{PyOS_vsnprintf()} were added to provide
Andrew M. Kuchling0ab31b82001-08-29 01:16:54 +00001259 cross-platform implementations for the relatively new
1260 \cfunction{snprintf()} and \cfunction{vsnprintf()} C lib APIs. In
1261 contrast to the standard \cfunction{sprintf()} and
1262 \cfunction{vsprintf()} functions, the Python versions check the
1263 bounds of the buffer used to protect against buffer overruns.
1264 (Contributed by M.-A. Lemburg.)
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001265
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +00001266 \item The \cfunction{_PyTuple_Resize()} function has lost an unused
1267 parameter, so now it takes 2 parameters instead of 3. The third
1268 argument was never used, and can simply be discarded when porting
1269 code from earlier versions to Python 2.2.
1270
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001271\end{itemize}
1272
1273
1274%======================================================================
1275\section{Other Changes and Fixes}
1276
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +00001277As usual there were a bunch of other improvements and bugfixes
1278scattered throughout the source tree. A search through the CVS change
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001279logs finds there were 527 patches applied and 683 bugs fixed between
Andrew M. Kuchlingcab94a12002-11-12 18:59:20 +00001280Python 2.1 and 2.2; 2.2.1 applied 139 patches and fixed 143 bugs;
12812.2.2 applied 106 patches and fixed 82 bugs. These figures are likely
1282to be underestimates.
Andrew M. Kuchling9da3efd2002-04-01 19:22:34 +00001283
1284Some of the more notable changes are:
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001285
1286\begin{itemize}
1287
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001288 \item The code for the MacOS port for Python, maintained by Jack
1289 Jansen, is now kept in the main Python CVS tree, and many changes
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001290 have been made to support MacOS~X.
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001291
1292The most significant change is the ability to build Python as a
1293framework, enabled by supplying the \longprogramopt{enable-framework}
1294option to the configure script when compiling Python. According to
1295Jack Jansen, ``This installs a self-contained Python installation plus
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001296the OS~X framework "glue" into
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001297\file{/Library/Frameworks/Python.framework} (or another location of
1298choice). For now there is little immediate added benefit to this
1299(actually, there is the disadvantage that you have to change your PATH
1300to be able to find Python), but it is the basis for creating a
1301full-blown Python application, porting the MacPython IDE, possibly
1302using Python as a standard OSA scripting language and much more.''
1303
1304Most of the MacPython toolbox modules, which interface to MacOS APIs
Andrew M. Kuchling279e7442001-10-22 02:03:40 +00001305such as windowing, QuickTime, scripting, etc. have been ported to OS~X,
Andrew M. Kuchlingbeb38552001-10-22 14:11:06 +00001306but they've been left commented out in \file{setup.py}. People who want
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001307to experiment with these modules can uncomment them manually.
1308
1309% Jack's original comments:
1310%The main change is the possibility to build Python as a
1311%framework. This installs a self-contained Python installation plus the
1312%OSX framework "glue" into /Library/Frameworks/Python.framework (or
1313%another location of choice). For now there is little immedeate added
1314%benefit to this (actually, there is the disadvantage that you have to
1315%change your PATH to be able to find Python), but it is the basis for
1316%creating a fullblown Python application, porting the MacPython IDE,
1317%possibly using Python as a standard OSA scripting language and much
1318%more. You enable this with "configure --enable-framework".
1319
1320%The other change is that most MacPython toolbox modules, which
1321%interface to all the MacOS APIs such as windowing, quicktime,
1322%scripting, etc. have been ported. Again, most of these are not of
1323%immedeate use, as they need a full application to be really useful, so
1324%they have been commented out in setup.py. People wanting to experiment
1325%can uncomment them. Gestalt and Internet Config modules are enabled by
1326%default.
Andrew M. Kuchling0e03f582001-08-30 21:30:16 +00001327
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001328 \item Keyword arguments passed to builtin functions that don't take them
1329 now cause a \exception{TypeError} exception to be raised, with the
1330 message "\var{function} takes no keyword arguments".
1331
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001332 \item Weak references, added in Python 2.1 as an extension module,
1333 are now part of the core because they're used in the implementation
1334 of new-style classes. The \exception{ReferenceError} exception has
1335 therefore moved from the \module{weakref} module to become a
1336 built-in exception.
1337
Andrew M. Kuchling94a7eba2001-08-15 15:55:48 +00001338 \item A new script, \file{Tools/scripts/cleanfuture.py} by Tim
1339 Peters, automatically removes obsolete \code{__future__} statements
1340 from Python source code.
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001341
Andrew M. Kuchling4f9e2202001-10-29 18:09:42 +00001342 \item An additional \var{flags} argument has been added to the
1343 built-in function \function{compile()}, so the behaviour of
1344 \code{__future__} statements can now be correctly observed in
1345 simulated shells, such as those presented by IDLE and other
1346 development environments. This is described in \pep{264}.
1347 (Contributed by Michael Hudson.)
1348
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001349 \item The new license introduced with Python 1.6 wasn't
1350 GPL-compatible. This is fixed by some minor textual changes to the
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001351 2.2 license, so it's now legal to embed Python inside a GPLed
1352 program again. Note that Python itself is not GPLed, but instead is
1353 under a license that's essentially equivalent to the BSD license,
1354 same as it always was. The license changes were also applied to the
1355 Python 2.0.1 and 2.1.1 releases.
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001356
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +00001357 \item When presented with a Unicode filename on Windows, Python will
1358 now convert it to an MBCS encoded string, as used by the Microsoft
1359 file APIs. As MBCS is explicitly used by the file APIs, Python's
1360 choice of ASCII as the default encoding turns out to be an
Fred Drakea030c762002-05-02 17:55:26 +00001361 annoyance. On \UNIX, the locale's character set is used if
Andrew M. Kuchling433b5c42001-10-30 21:36:04 +00001362 \function{locale.nl_langinfo(CODESET)} is available. (Windows
1363 support was contributed by Mark Hammond with assistance from
Fred Drakea030c762002-05-02 17:55:26 +00001364 Marc-Andr\'e Lemburg. \UNIX{} support was added by Martin von L\"owis.)
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001365
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001366 \item Large file support is now enabled on Windows. (Contributed by
1367 Tim Peters.)
1368
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001369 \item The \file{Tools/scripts/ftpmirror.py} script
1370 now parses a \file{.netrc} file, if you have one.
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001371 (Contributed by Mike Romberg.)
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +00001372
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +00001373 \item Some features of the object returned by the
1374 \function{xrange()} function are now deprecated, and trigger
1375 warnings when they're accessed; they'll disappear in Python 2.3.
1376 \class{xrange} objects tried to pretend they were full sequence
1377 types by supporting slicing, sequence multiplication, and the
1378 \keyword{in} operator, but these features were rarely used and
1379 therefore buggy. The \method{tolist()} method and the
1380 \member{start}, \member{stop}, and \member{step} attributes are also
1381 being deprecated. At the C level, the fourth argument to the
1382 \cfunction{PyRange_New()} function, \samp{repeat}, has also been
1383 deprecated.
1384
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001385 \item There were a bunch of patches to the dictionary
1386 implementation, mostly to fix potential core dumps if a dictionary
1387 contains objects that sneakily changed their hash value, or mutated
1388 the dictionary they were contained in. For a while python-dev fell
Andrew M. Kuchling8b42f012001-10-22 02:00:11 +00001389 into a gentle rhythm of Michael Hudson finding a case that dumped
1390 core, Tim Peters fixing the bug, Michael finding another case, and round
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001391 and round it went.
1392
Andrew M. Kuchling33a3b632001-09-04 21:25:58 +00001393 \item On Windows, Python can now be compiled with Borland C thanks
1394 to a number of patches contributed by Stephen Hansen, though the
1395 result isn't fully functional yet. (But this \emph{is} progress...)
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001396
Andrew M. Kuchlingf4ccf582001-07-31 01:11:36 +00001397 \item Another Windows enhancement: Wise Solutions generously offered
1398 PythonLabs use of their InstallerMaster 8.1 system. Earlier
1399 PythonLabs Windows installers used Wise 5.0a, which was beginning to
1400 show its age. (Packaged up by Tim Peters.)
1401
Andrew M. Kuchling8c69c91b2001-08-07 14:28:58 +00001402 \item Files ending in \samp{.pyw} can now be imported on Windows.
1403 \samp{.pyw} is a Windows-only thing, used to indicate that a script
1404 needs to be run using PYTHONW.EXE instead of PYTHON.EXE in order to
1405 prevent a DOS console from popping up to display the output. This
1406 patch makes it possible to import such scripts, in case they're also
1407 usable as modules. (Implemented by David Bolen.)
1408
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +00001409 \item On platforms where Python uses the C \cfunction{dlopen()} function
1410 to load extension modules, it's now possible to set the flags used
1411 by \cfunction{dlopen()} using the \function{sys.getdlopenflags()} and
1412 \function{sys.setdlopenflags()} functions. (Contributed by Bram Stolk.)
Andrew M. Kuchling2f0047a2001-09-05 14:53:31 +00001413
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001414 \item The \function{pow()} built-in function no longer supports 3
1415 arguments when floating-point numbers are supplied.
Andrew M. Kuchling1497b622001-09-24 14:51:16 +00001416 \code{pow(\var{x}, \var{y}, \var{z})} returns \code{(x**y) \% z}, but
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001417 this is never useful for floating point numbers, and the final
1418 result varies unpredictably depending on the platform. A call such
Andrew M. Kuchlingd6e40e22001-09-10 16:18:50 +00001419 as \code{pow(2.0, 8.0, 7.0)} will now raise a \exception{TypeError}
Andrew M. Kuchling26c39bf2001-09-10 03:20:53 +00001420 exception.
Andrew M. Kuchling77707672001-07-31 15:51:16 +00001421
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001422\end{itemize}
1423
1424
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001425%======================================================================
1426\section{Acknowledgements}
1427
1428The author would like to thank the following people for offering
Andrew M. Kuchlingb83769c2001-10-26 20:07:03 +00001429suggestions, corrections and assistance with various drafts of this
1430article: Fred Bremmer, Keith Briggs, Andrew Dalke, Fred~L. Drake, Jr.,
Andrew M. Kuchlingccf04652001-11-26 18:15:44 +00001431Carel Fellinger, David Goodger, Mark Hammond, Stephen Hansen, Michael
1432Hudson, Jack Jansen, Marc-Andr\'e Lemburg, Martin von L\"owis, Fredrik
1433Lundh, Michael McLay, Nick Mathewson, Paul Moore, Gustavo Niemeyer,
Andrew M. Kuchling17850f72002-04-10 21:53:22 +00001434Don O'Donnell, Joonas Paalasma, Tim Peters, Jens Quade, Tom Reinhardt, Neil
Andrew M. Kuchling71dd7902002-11-12 18:45:46 +00001435Schemenauer, Guido van Rossum, Greg Ward, Edward Welbourne.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001436
1437\end{document}