blob: 431e269c4fb4d44b75f0332ca7b7267d8ddd721f [file] [log] [blame]
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00001\documentclass{howto}
2
3% $Id$
4
5\title{What's New in Python 2.2}
Andrew M. Kuchlingab010872001-07-19 14:59:53 +00006\release{0.04}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00007\author{A.M. Kuchling}
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +00008\authoraddress{\email{akuchlin@mems-exchange.org}}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +00009\begin{document}
10\maketitle\tableofcontents
11
12\section{Introduction}
13
14{\large This document is a draft, and is subject to change until the
15final version of Python 2.2 is released. Currently it's not up to
16date at all. Please send any comments, bug reports, or questions, no
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000017matter how minor, to \email{akuchlin@mems-exchange.org}. }
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000018
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000019This article explains the new features in Python 2.2. Python 2.2
20includes some significant changes that go far toward cleaning up the
21language's darkest corners, and some exciting new features.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000022
23This article doesn't attempt to provide a complete specification for
24the new features, but instead provides a convenient overview of the
25new features. For full details, you should refer to 2.2 documentation
Fred Drake0d002542001-07-17 13:55:33 +000026such as the
27\citetitle[http://python.sourceforge.net/devel-docs/lib/lib.html]{Python
28Library Reference} and the
29\citetitle[http://python.sourceforge.net/devel-docs/ref/ref.html]{Python
30Reference Manual}, or to the PEP for a particular new feature.
31% These \citetitle marks should get the python.org URLs for the final
32% release, just as soon as the docs are published there.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000033
34The final release of Python 2.2 is planned for October 2001.
35
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000036
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000037%======================================================================
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000038% It looks like this set of changes will likely get into 2.2,
39% so I need to read and digest the relevant PEPs.
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000040%\section{PEP 252: Type and Class Changes}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000041
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000042%XXX
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000043
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000044% GvR's description at http://www.python.org/2.2/descrintro.html
45
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000046%\begin{seealso}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000047
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000048%\seepep{252}{Making Types Look More Like Classes}{Written and implemented
49%by GvR.}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000050
Andrew M. Kuchling7bf82772001-07-11 18:54:26 +000051%\end{seealso}
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000052
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +000053
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +000054%======================================================================
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000055\section{PEP 234: Iterators}
56
57A significant addition to 2.2 is an iteration interface at both the C
58and Python levels. Objects can define how they can be looped over by
59callers.
60
61In Python versions up to 2.1, the usual way to make \code{for item in
62obj} work is to define a \method{__getitem__()} method that looks
63something like this:
64
65\begin{verbatim}
66 def __getitem__(self, index):
67 return <next item>
68\end{verbatim}
69
70\method{__getitem__()} is more properly used to define an indexing
71operation on an object so that you can write \code{obj[5]} to retrieve
72the fifth element. It's a bit misleading when you're using this only
73to support \keyword{for} loops. Consider some file-like object that
74wants to be looped over; the \var{index} parameter is essentially
75meaningless, as the class probably assumes that a series of
76\method{__getitem__()} calls will be made, with \var{index}
77incrementing by one each time. In other words, the presence of the
78\method{__getitem__()} method doesn't mean that \code{file[5]} will
79work, though it really should.
80
81In Python 2.2, iteration can be implemented separately, and
82\method{__getitem__()} methods can be limited to classes that really
83do support random access. The basic idea of iterators is quite
84simple. A new built-in function, \function{iter(obj)}, returns an
85iterator for the object \var{obj}. (It can also take two arguments:
Fred Drake0d002542001-07-17 13:55:33 +000086\code{iter(\var{C}, \var{sentinel})} will call the callable \var{C},
87until it returns \var{sentinel}, which will signal that the iterator
88is done. This form probably won't be used very often.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000089
90Python classes can define an \method{__iter__()} method, which should
91create and return a new iterator for the object; if the object is its
92own iterator, this method can just return \code{self}. In particular,
93iterators will usually be their own iterators. Extension types
94implemented in C can implement a \code{tp_iter} function in order to
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +000095return an iterator, and extension types that want to behave as
96iterators can define a \code{tp_iternext} function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +000097
98So what do iterators do? They have one required method,
99\method{next()}, which takes no arguments and returns the next value.
100When there are no more values to be returned, calling \method{next()}
101should raise the \exception{StopIteration} exception.
102
103\begin{verbatim}
104>>> L = [1,2,3]
105>>> i = iter(L)
106>>> print i
107<iterator object at 0x8116870>
108>>> i.next()
1091
110>>> i.next()
1112
112>>> i.next()
1133
114>>> i.next()
115Traceback (most recent call last):
116 File "<stdin>", line 1, in ?
117StopIteration
118>>>
119\end{verbatim}
120
121In 2.2, Python's \keyword{for} statement no longer expects a sequence;
122it expects something for which \function{iter()} will return something.
123For backward compatibility, and convenience, an iterator is
124automatically constructed for sequences that don't implement
125\method{__iter__()} or a \code{tp_iter} slot, so \code{for i in
126[1,2,3]} will still work. Wherever the Python interpreter loops over
127a sequence, it's been changed to use the iterator protocol. This
128means you can do things like this:
129
130\begin{verbatim}
131>>> i = iter(L)
132>>> a,b,c = i
133>>> a,b,c
134(1, 2, 3)
135>>>
136\end{verbatim}
137
138Iterator support has been added to some of Python's basic types. The
139\keyword{in} operator now works on dictionaries, so \code{\var{key} in
140dict} is now equivalent to \code{dict.has_key(\var{key})}.
Fred Drake0d002542001-07-17 13:55:33 +0000141Calling \function{iter()} on a dictionary will return an iterator
Andrew M. Kuchling6ea9f0b2001-07-17 14:50:31 +0000142which loops over its keys:
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000143
144\begin{verbatim}
145>>> m = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
146... 'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
147>>> for key in m: print key, m[key]
148...
149Mar 3
150Feb 2
151Aug 8
152Sep 9
153May 5
154Jun 6
155Jul 7
156Jan 1
157Apr 4
158Nov 11
159Dec 12
160Oct 10
161>>>
162\end{verbatim}
163
164That's just the default behaviour. If you want to iterate over keys,
165values, or key/value pairs, you can explicitly call the
166\method{iterkeys()}, \method{itervalues()}, or \method{iteritems()}
167methods to get an appropriate iterator.
168
169Files also provide an iterator, which calls its \method{readline()}
170method until there are no more lines in the file. This means you can
171now read each line of a file using code like this:
172
173\begin{verbatim}
174for line in file:
175 # do something for each line
176\end{verbatim}
177
178Note that you can only go forward in an iterator; there's no way to
179get the previous element, reset the iterator, or make a copy of it.
Fred Drake0d002542001-07-17 13:55:33 +0000180An iterator object could provide such additional capabilities, but the
181iterator protocol only requires a \method{next()} method.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000182
183\begin{seealso}
184
185\seepep{234}{Iterators}{Written by Ka-Ping Yee and GvR; implemented
186by the Python Labs crew, mostly by GvR and Tim Peters.}
187
188\end{seealso}
189
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000190
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000191%======================================================================
192\section{PEP 255: Simple Generators}
193
194Generators are another new feature, one that interacts with the
195introduction of iterators.
196
197You're doubtless familiar with how function calls work in Python or
198C. When you call a function, it gets a private area where its local
199variables are created. When the function reaches a \keyword{return}
200statement, the local variables are destroyed and the resulting value
201is returned to the caller. A later call to the same function will get
202a fresh new set of local variables. But, what if the local variables
203weren't destroyed on exiting a function? What if you could later
204resume the function where it left off? This is what generators
205provide; they can be thought of as resumable functions.
206
207Here's the simplest example of a generator function:
208
209\begin{verbatim}
210def generate_ints(N):
211 for i in range(N):
212 yield i
213\end{verbatim}
214
215A new keyword, \keyword{yield}, was introduced for generators. Any
216function containing a \keyword{yield} statement is a generator
217function; this is detected by Python's bytecode compiler which
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000218compiles the function specially. Because a new keyword was
219introduced, generators must be explicitly enabled in a module by
220including a \code{from __future__ import generators} statement near
221the top of the module's source code. In Python 2.3 this statement
222will become unnecessary.
223
224When you call a generator function, it doesn't return a single value;
225instead it returns a generator object that supports the iterator
226interface. On executing the \keyword{yield} statement, the generator
227outputs the value of \code{i}, similar to a \keyword{return}
228statement. The big difference between \keyword{yield} and a
229\keyword{return} statement is that, on reaching a \keyword{yield} the
230generator's state of execution is suspended and local variables are
231preserved. On the next call to the generator's \code{.next()} method,
232the function will resume executing immediately after the
233\keyword{yield} statement. (For complicated reasons, the
234\keyword{yield} statement isn't allowed inside the \keyword{try} block
235of a \code{try...finally} statement; read PEP 255 for a full
236explanation of the interaction between \keyword{yield} and
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000237exceptions.)
238
239Here's a sample usage of the \function{generate_ints} generator:
240
241\begin{verbatim}
242>>> gen = generate_ints(3)
243>>> gen
244<generator object at 0x8117f90>
245>>> gen.next()
2460
247>>> gen.next()
2481
249>>> gen.next()
2502
251>>> gen.next()
252Traceback (most recent call last):
253 File "<stdin>", line 1, in ?
254 File "<stdin>", line 2, in generate_ints
255StopIteration
256>>>
257\end{verbatim}
258
259You could equally write \code{for i in generate_ints(5)}, or
260\code{a,b,c = generate_ints(3)}.
261
262Inside a generator function, the \keyword{return} statement can only
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000263be used without a value, and signals the end of the procession of
264values; afterwards the generator cannot return any further values.
265\keyword{return} with a value, such as \code{return 5}, is a syntax
266error inside a generator function. The end of the generator's results
267can also be indicated by raising \exception{StopIteration} manually,
268or by just letting the flow of execution fall off the bottom of the
269function.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000270
271You could achieve the effect of generators manually by writing your
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000272own class and storing all the local variables of the generator as
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000273instance variables. For example, returning a list of integers could
274be done by setting \code{self.count} to 0, and having the
275\method{next()} method increment \code{self.count} and return it.
Andrew M. Kuchlingc32cc7c2001-07-17 18:25:01 +0000276However, for a moderately complicated generator, writing a
277corresponding class would be much messier.
278\file{Lib/test/test_generators.py} contains a number of more
279interesting examples. The simplest one implements an in-order
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000280traversal of a tree using generators recursively.
281
282\begin{verbatim}
283# A recursive generator that generates Tree leaves in in-order.
284def inorder(t):
285 if t:
286 for x in inorder(t.left):
287 yield x
288 yield t.label
289 for x in inorder(t.right):
290 yield x
291\end{verbatim}
292
293Two other examples in \file{Lib/test/test_generators.py} produce
294solutions for the N-Queens problem (placing $N$ queens on an $NxN$
295chess board so that no queen threatens another) and the Knight's Tour
296(a route that takes a knight to every square of an $NxN$ chessboard
297without visiting any square twice).
298
299The idea of generators comes from other programming languages,
300especially Icon (\url{http://www.cs.arizona.edu/icon/}), where the
301idea of generators is central to the language. In Icon, every
302expression and function call behaves like a generator. One example
303from ``An Overview of the Icon Programming Language'' at
304\url{http://www.cs.arizona.edu/icon/docs/ipd266.htm} gives an idea of
305what this looks like:
306
307\begin{verbatim}
308sentence := "Store it in the neighboring harbor"
309if (i := find("or", sentence)) > 5 then write(i)
310\end{verbatim}
311
312The \function{find()} function returns the indexes at which the
313substring ``or'' is found: 3, 23, 33. In the \keyword{if} statement,
314\code{i} is first assigned a value of 3, but 3 is less than 5, so the
315comparison fails, and Icon retries it with the second value of 23. 23
316is greater than 5, so the comparison now succeeds, and the code prints
317the value 23 to the screen.
318
319Python doesn't go nearly as far as Icon in adopting generators as a
320central concept. Generators are considered a new part of the core
321Python language, but learning or using them isn't compulsory; if they
322don't solve any problems that you have, feel free to ignore them.
323This is different from Icon where the idea of generators is a basic
324concept. One novel feature of Python's interface as compared to
325Icon's is that a generator's state is represented as a concrete object
326that can be passed around to other functions or stored in a data
327structure.
328
329\begin{seealso}
330
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000331\seepep{255}{Simple Generators}{Written by Neil Schemenauer, Tim
332Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
333and Tim Peters, with other fixes from the Python Labs crew.}
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000334
335\end{seealso}
336
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000337
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000338%======================================================================
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000339\section{Unicode Changes}
340
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000341Python's Unicode support has been enhanced a bit in 2.2. Unicode
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000342strings are usually stored as UTF-16, as 16-bit unsigned integers.
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000343Python 2.2 can also be compiled to use UCS-4, 32-bit unsigned
344integers, as its internal encoding by supplying
345\longprogramopt{enable-unicode=ucs4} to the configure script. When
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000346built to use UCS-4 (a ``wide Python''), the interpreter can natively
347handle Unicode characters from U+000000 to U+110000. The range of
348legal values for the \function{unichr()} function has been expanded;
349it used to only accept values up to 65535, but in 2.2 will accept
350values from 0 to 0x110000. Using a ``narrow Python'', an interpreter
351compiled to use UTF-16, values greater than 65535 will result in
352\function{unichr()} returning a string of length 2:
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000353
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000354\begin{verbatim}
355>>> s = unichr(65536)
356>>> s
357u'\ud800\udc00'
358>>> len(s)
3592
360\end{verbatim}
361
362This possibly-confusing behaviour, breaking the intuitive invariant
363that \function{chr()} and\function{unichr()} always return strings of
364length 1, may be changed later in 2.2 depending on public reaction.
365
366All this is the province of the still-unimplemented PEP 261, ``Support
367for `wide' Unicode characters''; consult it for further details, and
368please offer comments and suggestions on the proposal it describes.
369
370Another change is much simpler to explain. Since their introduction,
371Unicode strings have supported an \method{encode()} method to convert
372the string to a selected encoding such as UTF-8 or Latin-1. A
373symmetric \method{decode(\optional{\var{encoding}})} method has been
374added to 8-bit strings (though not to Unicode strings) in 2.2.
375\method{decode()} assumes that the string is in the specified encoding
376and decodes it, returning whatever is returned by the codec.
377
378Using this new feature, codecs have been added for tasks not directly
379related to Unicode. For example, codecs have been added for
380uu-encoding, MIME's base64 encoding, and compression with the
381\module{zlib} module:
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000382
383\begin{verbatim}
384>>> s = """Here is a lengthy piece of redundant, overly verbose,
385... and repetitive text.
386... """
387>>> data = s.encode('zlib')
388>>> data
389'x\x9c\r\xc9\xc1\r\x80 \x10\x04\xc0?Ul...'
390>>> data.decode('zlib')
391'Here is a lengthy piece of redundant, overly verbose,\nand repetitive text.\n'
392>>> print s.encode('uu')
393begin 666 <data>
394M2&5R92!I<R!A(&QE;F=T:'D@<&EE8V4@;V8@<F5D=6YD86YT+"!O=F5R;'D@
395>=F5R8F]S92P*86YD(')E<&5T:71I=F4@=&5X="X*
396
397end
398>>> "sheesh".encode('rot-13')
399'furrfu'
400\end{verbatim}
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000401
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000402\method{encode()} and \method{decode()} were implemented by
403Marc-Andr\'e Lemburg. The changes to support using UCS-4 internally
404were implemented by Fredrik Lundh and Martin von L\"owis.
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000405
Andrew M. Kuchlingf5fec3c2001-07-19 01:48:08 +0000406\begin{seealso}
407
408\seepep{261}{Support for `wide' Unicode characters}{PEP written by
409Paul Prescod. Not yet accepted or fully implemented.}
410
411\end{seealso}
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000412
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000413%======================================================================
414\section{PEP 227: Nested Scopes}
415
416In Python 2.1, statically nested scopes were added as an optional
417feature, to be enabled by a \code{from __future__ import
418nested_scopes} directive. In 2.2 nested scopes no longer need to be
419specially enabled, but are always enabled. The rest of this section
420is a copy of the description of nested scopes from my ``What's New in
421Python 2.1'' document; if you read it when 2.1 came out, you can skip
422the rest of this section.
423
424The largest change introduced in Python 2.1, and made complete in 2.2,
425is to Python's scoping rules. In Python 2.0, at any given time there
426are at most three namespaces used to look up variable names: local,
427module-level, and the built-in namespace. This often surprised people
428because it didn't match their intuitive expectations. For example, a
429nested recursive function definition doesn't work:
430
431\begin{verbatim}
432def f():
433 ...
434 def g(value):
435 ...
436 return g(value-1) + 1
437 ...
438\end{verbatim}
439
440The function \function{g()} will always raise a \exception{NameError}
441exception, because the binding of the name \samp{g} isn't in either
442its local namespace or in the module-level namespace. This isn't much
443of a problem in practice (how often do you recursively define interior
444functions like this?), but this also made using the \keyword{lambda}
445statement clumsier, and this was a problem in practice. In code which
446uses \keyword{lambda} you can often find local variables being copied
447by passing them as the default values of arguments.
448
449\begin{verbatim}
450def find(self, name):
451 "Return list of any entries equal to 'name'"
452 L = filter(lambda x, name=name: x == name,
453 self.list_attribute)
454 return L
455\end{verbatim}
456
457The readability of Python code written in a strongly functional style
458suffers greatly as a result.
459
460The most significant change to Python 2.2 is that static scoping has
461been added to the language to fix this problem. As a first effect,
462the \code{name=name} default argument is now unnecessary in the above
463example. Put simply, when a given variable name is not assigned a
464value within a function (by an assignment, or the \keyword{def},
465\keyword{class}, or \keyword{import} statements), references to the
466variable will be looked up in the local namespace of the enclosing
467scope. A more detailed explanation of the rules, and a dissection of
468the implementation, can be found in the PEP.
469
470This change may cause some compatibility problems for code where the
471same variable name is used both at the module level and as a local
472variable within a function that contains further function definitions.
473This seems rather unlikely though, since such code would have been
474pretty confusing to read in the first place.
475
476One side effect of the change is that the \code{from \var{module}
477import *} and \keyword{exec} statements have been made illegal inside
478a function scope under certain conditions. The Python reference
479manual has said all along that \code{from \var{module} import *} is
480only legal at the top level of a module, but the CPython interpreter
481has never enforced this before. As part of the implementation of
482nested scopes, the compiler which turns Python source into bytecodes
483has to generate different code to access variables in a containing
484scope. \code{from \var{module} import *} and \keyword{exec} make it
485impossible for the compiler to figure this out, because they add names
486to the local namespace that are unknowable at compile time.
487Therefore, if a function contains function definitions or
488\keyword{lambda} expressions with free variables, the compiler will
489flag this by raising a \exception{SyntaxError} exception.
490
491To make the preceding explanation a bit clearer, here's an example:
492
493\begin{verbatim}
494x = 1
495def f():
496 # The next line is a syntax error
497 exec 'x=2'
498 def g():
499 return x
500\end{verbatim}
501
502Line 4 containing the \keyword{exec} statement is a syntax error,
503since \keyword{exec} would define a new local variable named \samp{x}
504whose value should be accessed by \function{g()}.
505
506This shouldn't be much of a limitation, since \keyword{exec} is rarely
507used in most Python code (and when it is used, it's often a sign of a
508poor design anyway).
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000509
510\begin{seealso}
511
512\seepep{227}{Statically Nested Scopes}{Written and implemented by
513Jeremy Hylton.}
514
515\end{seealso}
516
Andrew M. Kuchlinga43e7032001-06-27 20:32:12 +0000517
518%======================================================================
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000519\section{New and Improved Modules}
520
521\begin{itemize}
522
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000523 \item The \module{xmlrpclib} module was contributed to the standard
524library by Fredrik Lundh. It provides support for writing XML-RPC
525clients; XML-RPC is a simple remote procedure call protocol built on
526top of HTTP and XML. For example, the following snippet retrieves a
527list of RSS channels from the O'Reilly Network, and then retrieves a
528list of the recent headlines for one channel:
529
530\begin{verbatim}
531import xmlrpclib
532s = xmlrpclib.Server(
533 'http://www.oreillynet.com/meerkat/xml-rpc/server.php')
534channels = s.meerkat.getChannels()
535# channels is a list of dictionaries, like this:
536# [{'id': 4, 'title': 'Freshmeat Daily News'}
537# {'id': 190, 'title': '32Bits Online'},
538# {'id': 4549, 'title': '3DGamers'}, ... ]
539
540# Get the items for one channel
541items = s.meerkat.getItems( {'channel': 4} )
542
543# 'items' is another list of dictionaries, like this:
544# [{'link': 'http://freshmeat.net/releases/52719/',
545# 'description': 'A utility which converts HTML to XSL FO.',
546# 'title': 'html2fo 0.3 (Default)'}, ... ]
547\end{verbatim}
548
Fred Drake0d002542001-07-17 13:55:33 +0000549See \url{http://www.xmlrpc.com/} for more information about XML-RPC.
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000550
551 \item The \module{socket} module can be compiled to support IPv6;
Andrew M. Kuchlingddeb1352001-07-16 14:35:52 +0000552 specify the \longprogramopt{enable-ipv6} option to Python's configure
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000553 script. (Contributed by Jun-ichiro ``itojun'' Hagino.)
554
555 \item Two new format characters were added to the \module{struct}
556 module for 64-bit integers on platforms that support the C
557 \ctype{long long} type. \samp{q} is for a signed 64-bit integer,
558 and \samp{Q} is for an unsigned one. The value is returned in
559 Python's long integer type. (Contributed by Tim Peters.)
560
561 \item In the interpreter's interactive mode, there's a new built-in
562 function \function{help()}, that uses the \module{pydoc} module
563 introduced in Python 2.1 to provide interactive.
564 \code{help(\var{object})} displays any available help text about
565 \var{object}. \code{help()} with no argument puts you in an online
566 help utility, where you can enter the names of functions, classes,
567 or modules to read their help text.
568 (Contributed by Guido van Rossum, using Ka-Ping Yee's \module{pydoc} module.)
569
570 \item Various bugfixes and performance improvements have been made
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000571 to the SRE engine underlying the \module{re} module. For example,
572 \function{re.sub()} will now use \function{string.replace()}
573 automatically when the pattern and its replacement are both just
574 literal strings without regex metacharacters. Another contributed
575 patch speeds up certain Unicode character ranges by a factor of
576 two. (SRE is maintained by Fredrik Lundh. The BIGCHARSET patch was
577 contributed by Martin von L\"owis.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000578
579 \item The \module{imaplib} module now has support for the IMAP
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000580 NAMESPACE extension defined in \rfc{2342}. (Contributed by Michel
581 Pelletier.)
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000582
Fred Drake0d002542001-07-17 13:55:33 +0000583 \item The \module{rfc822} module's parsing of email addresses is
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000584 now compliant with \rfc{2822}, an update to \rfc{822}. The module's
585 name is \emph{not} going to be changed to \samp{rfc2822}.
586 (Contributed by Barry Warsaw.)
587
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000588\end{itemize}
589
590
591%======================================================================
592\section{Other Changes and Fixes}
593
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000594% XXX update the patch and bug figures as we go
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000595As usual there were a bunch of other improvements and bugfixes
596scattered throughout the source tree. A search through the CVS change
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000597logs finds there were 43 patches applied, and 77 bugs fixed; both
Andrew M. Kuchling4dbf8712001-07-16 02:17:14 +0000598figures are likely to be underestimates. Some of the more notable
599changes are:
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000600
601\begin{itemize}
602
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000603 \item Keyword arguments passed to builtin functions that don't take them
604 now cause a \exception{TypeError} exception to be raised, with the
605 message "\var{function} takes no keyword arguments".
606
Fred Drake0d002542001-07-17 13:55:33 +0000607 \item The code for the Mac OS port for Python, maintained by Jack
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000608 Jansen, is now kept in the main Python CVS tree.
609
610 \item The new license introduced with Python 1.6 wasn't
611 GPL-compatible. This is fixed by some minor textual changes to the
612 2.2 license, so Python can now be embedded inside a GPLed program
613 again. The license changes were also applied to the Python 2.0.1
614 and 2.1.1 releases.
615
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000616 \item Profiling and tracing functions can now be implemented in C,
617 which can operate at much higher speeds than Python-based functions
618 and should reduce the overhead of enabling profiling and tracing, so
619 it will be of interest to authors of development environments for
620 Python. Two new C functions were added to Python's API,
621 \cfunction{PyEval_SetProfile()} and \cfunction{PyEval_SetTrace()}.
622 The existing \function{sys.setprofile()} and
623 \function{sys.settrace()} functions still exist, and have simply
Fred Drake0d002542001-07-17 13:55:33 +0000624 been changed to use the new C-level interface. (Contributed by Fred
625 L. Drake, Jr.)
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000626
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000627 \item Another low-level API, primarily of interest to implementors
628 of Python debuggers and development tools, was added.
629 \cfunction{PyInterpreterState_Head()} and
630 \cfunction{PyInterpreterState_Next()} let a caller walk through all
631 the existing interpreter objects;
632 \cfunction{PyInterpreterState_ThreadHead()} and
633 \cfunction{PyThreadState_Next()} allow looping over all the thread
634 states for a given interpreter. (Contributed by David Beazley.)
635
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000636 % XXX is this explanation correct?
637 \item When presented with a Unicode filename on Windows, Python will
638 now correctly convert it to a string using the MBCS encoding.
639 Filenames on Windows are a case where Python's choice of ASCII as
640 the default encoding turns out to be an annoyance.
641
642 This patch also adds \samp{et} as a format sequence to
643 \cfunction{PyArg_ParseTuple}; \samp{et} takes both a parameter and
644 an encoding name, and converts it to the given encoding if the
645 parameter turns out to be a Unicode string, or leaves it alone if
646 it's an 8-bit string, assuming it to already be in the desired
647 encoding. (This differs from the \samp{es} format character, which
648 assumes that 8-bit strings are in Python's default ASCII encoding
649 and converts them to the specified new encoding.)
650
651 (Contributed by Mark Hammond with assistance from Marc-Andr\'e
652 Lemburg.)
653
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000654 \item The \file{Tools/scripts/ftpmirror.py} script
655 now parses a \file{.netrc} file, if you have one.
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000656 (Contributed by Mike Romberg.)
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000657
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000658 \item Some features of the object returned by the
659 \function{xrange()} function are now deprecated, and trigger
660 warnings when they're accessed; they'll disappear in Python 2.3.
661 \class{xrange} objects tried to pretend they were full sequence
662 types by supporting slicing, sequence multiplication, and the
663 \keyword{in} operator, but these features were rarely used and
664 therefore buggy. The \method{tolist()} method and the
665 \member{start}, \member{stop}, and \member{step} attributes are also
666 being deprecated. At the C level, the fourth argument to the
667 \cfunction{PyRange_New()} function, \samp{repeat}, has also been
668 deprecated.
669
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000670 \item There were a bunch of patches to the dictionary
671 implementation, mostly to fix potential core dumps if a dictionary
672 contains objects that sneakily changed their hash value, or mutated
673 the dictionary they were contained in. For a while python-dev fell
674 into a gentle rhythm of Michael Hudson finding a case that dump
675 core, Tim Peters fixing it, Michael finding another case, and round
676 and round it went.
677
Andrew M. Kuchling4cf52a92001-07-17 12:48:48 +0000678 \item On Windows, Python can now be compiled with Borland C thanks
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000679 to a number of patches contributed by Stephen Hansen.
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000680
Andrew M. Kuchling8cfa9052001-07-19 01:19:59 +0000681 \item On platforms where Python uses the C \cfunction{dlopen()} function
682 to load extension modules, it's now possible to set the flags used
683 by \cfunction{dlopen()} using the \function{sys.getdlopenflags()} and
684 \function{sys.setdlopenflags()} functions. (Contributed by Bram Stolk.)
Andrew M. Kuchling2cd712b2001-07-16 13:39:08 +0000685
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000686\end{itemize}
687
688
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000689%======================================================================
690\section{Acknowledgements}
691
692The author would like to thank the following people for offering
Andrew M. Kuchling6ea9f0b2001-07-17 14:50:31 +0000693suggestions and corrections to various drafts of this article: Fred
Andrew M. Kuchlingab010872001-07-19 14:59:53 +0000694Bremmer, Fred L. Drake, Jr., Marc-Andr\'e Lemburg,
695Tim Peters, Neil Schemenauer, Guido van Rossum.
Andrew M. Kuchlinga8defaa2001-05-05 16:37:29 +0000696
697\end{document}