5 \title{What's New in Python
2.3}
7 \author{A.M.\ Kuchling
}
8 \authoraddress{\email{amk@amk.ca
}}
15 % MacOS framework-related changes (section of its own, probably)
17 %\section{Introduction \label{intro}}
19 {\large This article is a draft, and is currently up to date for
20 Python
2.3beta1. Please send any additions, comments or errata to the
23 This article explains the new features in Python
2.3. The tentative
24 release date of Python
2.3 is currently scheduled for mid-
2003.
26 This article doesn't attempt to provide a complete specification of
27 the new features, but instead provides a convenient overview. For
28 full details, you should refer to the documentation for Python
2.3,
29 such as the
\citetitle[../lib/lib.html
]{Python Library Reference
} and
30 the
\citetitle[../ref/ref.html
]{Python Reference Manual
}. If you want
31 to understand the complete implementation and design rationale for a
32 change, refer to the PEP for a particular new feature.
35 %======================================================================
36 \section{PEP
218: A Standard Set Datatype
}
38 The new
\module{sets
} module contains an implementation of a set
39 datatype. The
\class{Set
} class is for mutable sets, sets that can
40 have members added and removed. The
\class{ImmutableSet
} class is for
41 sets that can't be modified, and instances of
\class{ImmutableSet
} can
42 therefore be used as dictionary keys. Sets are built on top of
43 dictionaries, so the elements within a set must be hashable.
45 Here's a simple example:
49 >>> S = sets.Set(
[1,
2,
3])
63 The union and intersection of sets can be computed with the
64 \method{union()
} and
\method{intersection()
} methods or
65 alternatively using the bitwise operators
\code{\&
} and
\code{|
}.
66 Mutable sets also have in-place versions of these methods,
67 \method{union_update()
} and
\method{intersection_update()
}.
70 >>> S1 = sets.Set(
[1,
2,
3])
71 >>> S2 = sets.Set(
[4,
5,
6])
73 Set(
[1,
2,
3,
4,
5,
6])
74 >>> S1 | S2 # Alternative notation
75 Set(
[1,
2,
3,
4,
5,
6])
76 >>> S1.intersection(S2)
78 >>> S1 & S2 # Alternative notation
80 >>> S1.union_update(S2)
82 Set(
[1,
2,
3,
4,
5,
6])
86 It's also possible to take the symmetric difference of two sets. This
87 is the set of all elements in the union that aren't in the
88 intersection. An alternative way of expressing the symmetric
89 difference is that it contains all elements that are in exactly one
90 set. Again, there's an alternative notation (
\code{\^
}), and an
91 in-place version with the ungainly name
92 \method{symmetric_difference_update()
}.
95 >>> S1 = sets.Set(
[1,
2,
3,
4])
96 >>> S2 = sets.Set(
[3,
4,
5,
6])
97 >>> S1.symmetric_difference(S2)
104 There are also
\method{issubset()
} and
\method{issuperset()
} methods
105 for checking whether one set is a subset or superset of another:
108 >>> S1 = sets.Set(
[1,
2,
3])
109 >>> S2 = sets.Set(
[2,
3])
114 >>> S1.issuperset(S2)
122 \seepep{218}{Adding a Built-In Set Object Type
}{PEP written by Greg V. Wilson.
123 Implemented by Greg V. Wilson, Alex Martelli, and GvR.
}
129 %======================================================================
130 \section{PEP
255: Simple Generators
\label{section-generators
}}
132 In Python
2.2, generators were added as an optional feature, to be
133 enabled by a
\code{from __future__ import generators
} directive. In
134 2.3 generators no longer need to be specially enabled, and are now
135 always present; this means that
\keyword{yield
} is now always a
136 keyword. The rest of this section is a copy of the description of
137 generators from the ``What's New in Python
2.2''
document; if you read
138 it back when Python
2.2 came out, you can skip the rest of this section.
140 You're doubtless familiar with how function calls work in Python or C.
141 When you call a function, it gets a private namespace where its local
142 variables are created. When the function reaches a
\keyword{return
}
143 statement, the local variables are destroyed and the resulting value
144 is returned to the caller. A later call to the same function will get
145 a fresh new set of local variables. But, what if the local variables
146 weren't thrown away on exiting a function? What if you could later
147 resume the function where it left off? This is what generators
148 provide; they can be thought of as resumable functions.
150 Here's the simplest example of a generator function:
153 def generate_ints(N):
158 A new keyword,
\keyword{yield
}, was introduced for generators. Any
159 function containing a
\keyword{yield
} statement is a generator
160 function; this is detected by Python's bytecode compiler which
161 compiles the function specially as a result.
163 When you call a generator function, it doesn't return a single value;
164 instead it returns a generator object that supports the iterator
165 protocol. On executing the
\keyword{yield
} statement, the generator
166 outputs the value of
\code{i
}, similar to a
\keyword{return
}
167 statement. The big difference between
\keyword{yield
} and a
168 \keyword{return
} statement is that on reaching a
\keyword{yield
} the
169 generator's state of execution is suspended and local variables are
170 preserved. On the next call to the generator's
\code{.next()
} method,
171 the function will resume executing immediately after the
172 \keyword{yield
} statement. (For complicated reasons, the
173 \keyword{yield
} statement isn't allowed inside the
\keyword{try
} block
174 of a
\keyword{try
}...
\keyword{finally
} statement; read
\pep{255} for a full
175 explanation of the interaction between
\keyword{yield
} and
178 Here's a sample usage of the
\function{generate_ints()
} generator:
181 >>> gen = generate_ints(
3)
183 <generator object at
0x8117f90>
191 Traceback (most recent call last):
192 File "stdin", line
1, in ?
193 File "stdin", line
2, in generate_ints
197 You could equally write
\code{for i in generate_ints(
5)
}, or
198 \code{a,b,c = generate_ints(
3)
}.
200 Inside a generator function, the
\keyword{return
} statement can only
201 be used without a value, and signals the end of the procession of
202 values; afterwards the generator cannot return any further values.
203 \keyword{return
} with a value, such as
\code{return
5}, is a syntax
204 error inside a generator function. The end of the generator's results
205 can also be indicated by raising
\exception{StopIteration
} manually,
206 or by just letting the flow of execution fall off the bottom of the
209 You could achieve the effect of generators manually by writing your
210 own class and storing all the local variables of the generator as
211 instance variables. For example, returning a list of integers could
212 be done by setting
\code{self.count
} to
0, and having the
213 \method{next()
} method increment
\code{self.count
} and return it.
214 However, for a moderately complicated generator, writing a
215 corresponding class would be much messier.
216 \file{Lib/test/test_generators.py
} contains a number of more
217 interesting examples. The simplest one implements an in-order
218 traversal of a tree using generators recursively.
221 # A recursive generator that generates Tree leaves in in-order.
224 for x in inorder(t.left):
227 for x in inorder(t.right):
231 Two other examples in
\file{Lib/test/test_generators.py
} produce
232 solutions for the N-Queens problem (placing $N$ queens on an $NxN$
233 chess board so that no queen threatens another) and the Knight's Tour
234 (a route that takes a knight to every square of an $NxN$ chessboard
235 without visiting any square twice).
237 The idea of generators comes from other programming languages,
238 especially Icon (
\url{http://www.cs.arizona.edu/icon/
}), where the
239 idea of generators is central. In Icon, every
240 expression and function call behaves like a generator. One example
241 from ``An Overview of the Icon Programming Language'' at
242 \url{http://www.cs.arizona.edu/icon/docs/ipd266.htm
} gives an idea of
243 what this looks like:
246 sentence := "Store it in the neighboring harbor"
247 if (i := find("or", sentence)) >
5 then write(i)
250 In Icon the
\function{find()
} function returns the indexes at which the
251 substring ``or'' is found:
3,
23,
33. In the
\keyword{if
} statement,
252 \code{i
} is first assigned a value of
3, but
3 is less than
5, so the
253 comparison fails, and Icon retries it with the second value of
23.
23
254 is greater than
5, so the comparison now succeeds, and the code prints
255 the value
23 to the screen.
257 Python doesn't go nearly as far as Icon in adopting generators as a
258 central concept. Generators are considered part of the core
259 Python language, but learning or using them isn't compulsory; if they
260 don't solve any problems that you have, feel free to ignore them.
261 One novel feature of Python's interface as compared to
262 Icon's is that a generator's state is represented as a concrete object
263 (the iterator) that can be passed around to other functions or stored
268 \seepep{255}{Simple Generators
}{Written by Neil Schemenauer, Tim
269 Peters, Magnus Lie Hetland. Implemented mostly by Neil Schemenauer
270 and Tim Peters, with other fixes from the Python Labs crew.
}
275 %======================================================================
276 \section{PEP
263: Source Code Encodings
\label{section-encodings
}}
278 Python source files can now be declared as being in different
279 character set encodings. Encodings are declared by including a
280 specially formatted comment in the first or second line of the source
281 file. For example, a UTF-
8 file can be declared with:
284 #!/usr/bin/env python
285 # -*- coding: UTF-
8 -*-
288 Without such an encoding declaration, the default encoding used is
289 7-bit ASCII. Executing or importing modules containing string
290 literals with
8-bit characters and no encoding declaration will result
291 in a
\exception{DeprecationWarning
} being signalled by Python
2.3; in
292 2.4 this will be a syntax error.
294 The encoding declaration only affects Unicode string literals, which
295 will be converted to Unicode using the specified encoding. Note that
296 Python identifiers are still restricted to ASCII characters, so you
297 can't have variable names that use characters outside of the usual
302 \seepep{263}{Defining Python Source Code Encodings
}{Written by
303 Marc-Andr\'e Lemburg and Martin von~L\"owis; implemented by Suzuki
304 Hisao and Martin von~L\"owis.
}
309 %======================================================================
310 \section{PEP
277: Unicode file name support for Windows NT
}
312 On Windows NT,
2000, and XP, the system stores file names as Unicode
313 strings. Traditionally, Python has represented file names as byte
314 strings, which is inadequate because it renders some file names
317 Python now allows using arbitrary Unicode strings (within the
318 limitations of the file system) for all functions that expect file
319 names, most notably the
\function{open()
} built-in function. If a Unicode
320 string is passed to
\function{os.listdir()
}, Python now returns a list
321 of Unicode strings. A new function,
\function{os.getcwdu()
}, returns
322 the current directory as a Unicode string.
324 Byte strings still work as file names, and on Windows Python will
325 transparently convert them to Unicode using the
\code{mbcs
} encoding.
327 Other systems also allow Unicode strings as file names but convert
328 them to byte strings before passing them to the system, which can
329 cause a
\exception{UnicodeError
} to be raised. Applications can test
330 whether arbitrary Unicode strings are supported as file names by
331 checking
\member{os.path.supports_unicode_filenames
}, a Boolean value.
333 Under MacOS,
\function{os.listdir()
} may now return Unicode filenames.
337 \seepep{277}{Unicode file name support for Windows NT
}{Written by Neil
338 Hodgson; implemented by Neil Hodgson, Martin von~L\"owis, and Mark
344 %======================================================================
345 \section{PEP
278: Universal Newline Support
}
347 The three major operating systems used today are Microsoft Windows,
348 Apple's Macintosh OS, and the various
\UNIX\ derivatives. A minor
349 irritation is that these three platforms all use different characters
350 to mark the ends of lines in text files.
\UNIX\ uses the linefeed
351 (ASCII character
10), while MacOS uses the carriage return (ASCII
352 character
13), and Windows uses a two-character sequence containing a
353 carriage return plus a newline.
355 Python's file objects can now support end of line conventions other
356 than the one followed by the platform on which Python is running.
357 Opening a file with the mode
\code{'U'
} or
\code{'rU'
} will open a file
358 for reading in universal newline mode. All three line ending
359 conventions will be translated to a
\character{\e n
} in the strings
360 returned by the various file methods such as
\method{read()
} and
363 Universal newline support is also used when importing modules and when
364 executing a file with the
\function{execfile()
} function. This means
365 that Python modules can be shared between all three operating systems
366 without needing to convert the line-endings.
368 This feature can be disabled at compile-time by specifying
369 \longprogramopt{without-universal-newlines
} when running Python's
370 \program{configure
} script.
374 \seepep{278}{Universal Newline Support
}{Written
375 and implemented by Jack Jansen.
}
380 %======================================================================
381 \section{PEP
279: enumerate()
\label{section-enumerate
}}
383 A new built-in function,
\function{enumerate()
}, will make
384 certain loops a bit clearer.
\code{enumerate(thing)
}, where
385 \var{thing
} is either an iterator or a sequence, returns a iterator
386 that will return
\code{(
0,
\var{thing
[0]})
},
\code{(
1,
387 \var{thing
[1]})
},
\code{(
2,
\var{thing
[2]})
}, and so forth.
389 Fairly often you'll see code to change every element of a list that
393 for i in range(len(L)):
395 # ... compute some result based on item ...
399 This can be rewritten using
\function{enumerate()
} as:
402 for i, item in enumerate(L):
403 # ... compute some result based on item ...
410 \seepep{279}{The enumerate() built-in function
}{Written
411 and implemented by Raymond D. Hettinger.
}
416 %======================================================================
417 \section{PEP
282: The logging Package
}
419 A standard package for writing logs,
\module{logging
}, has been added
420 to Python
2.3. It provides a powerful and flexible mechanism for
421 components to generate logging output which can then be filtered and
422 processed in various ways. A standard configuration file format can
423 be used to control the logging behavior of a program. Python's
424 standard library includes handlers that will write log records to
425 standard error or to a file or socket, send them to the system log, or
426 even e-mail them to a particular address, and of course it's also
427 possible to write your own handler classes.
429 The
\class{Logger
} class is the primary class.
430 Most application code will deal with one or more
\class{Logger
}
431 objects, each one used by a particular subsystem of the application.
432 Each
\class{Logger
} is identified by a name, and names are organized
433 into a hierarchy using
\samp{.
} as the component separator. For
434 example, you might have
\class{Logger
} instances named
\samp{server
},
435 \samp{server.auth
} and
\samp{server.network
}. The latter two
436 instances are below
\samp{server
} in the hierarchy. This means that
437 if you turn up the verbosity for
\samp{server
} or direct
\samp{server
}
438 messages to a different handler, the changes will also apply to
439 records logged to
\samp{server.auth
} and
\samp{server.network
}.
440 There's also a root
\class{Logger
} that's the parent of all other
443 For simple uses, the
\module{logging
} package contains some
444 convenience functions that always use the root log:
449 logging.debug('Debugging information')
450 logging.info('Informational message')
451 logging.warning('Warning:config file
%s not found', 'server.conf')
452 logging.error('Error occurred')
453 logging.critical('Critical error -- shutting down')
456 This produces the following output:
459 WARNING:root:Warning:config file server.conf not found
460 ERROR:root:Error occurred
461 CRITICAL:root:Critical error -- shutting down
464 In the default configuration, informational and debugging messages are
465 suppressed and the output is sent to standard error. You can enable
466 the display of information and debugging messages by calling the
467 \method{setLevel()
} method on the root logger.
469 Notice the
\function{warning()
} call's use of string formatting
470 operators; all of the functions for logging messages take the
471 arguments
\code{(
\var{msg
},
\var{arg1
},
\var{arg2
}, ...)
} and log the
472 string resulting from
\code{\var{msg
} \% (
\var{arg1
},
\var{arg2
},
475 There's also an
\function{exception()
} function that records the most
476 recent traceback. Any of the other functions will also record the
477 traceback if you specify a true value for the keyword argument
483 except: logging.exception('Problem recorded')
488 This produces the following output:
491 ERROR:root:Problem recorded
492 Traceback (most recent call last):
493 File "t.py", line
6, in f
495 ZeroDivisionError: integer division or modulo by zero
498 Slightly more advanced programs will use a logger other than the root
499 logger. The
\function{getLogger(
\var{name
})
} function is used to get
500 a particular log, creating it if it doesn't exist yet.
501 \function{getLogger(None)
} returns the root logger.
505 log = logging.getLogger('server')
507 log.info('Listening on port
%i', port)
509 log.critical('Disk full')
513 Log records are usually propagated up the hierarchy, so a message
514 logged to
\samp{server.auth
} is also seen by
\samp{server
} and
515 \samp{root
}, but a
\class{Logger
} can prevent this by setting its
516 \member{propagate
} attribute to
\constant{False
}.
518 There are more classes provided by the
\module{logging
} package that
519 can be customized. When a
\class{Logger
} instance is told to log a
520 message, it creates a
\class{LogRecord
} instance that is sent to any
521 number of different
\class{Handler
} instances. Loggers and handlers
522 can also have an attached list of filters, and each filter can cause
523 the
\class{LogRecord
} to be ignored or can modify the record before
524 passing it along. When they're finally output,
\class{LogRecord
}
525 instances are converted to text by a
\class{Formatter
} class. All of
526 these classes can be replaced by your own specially-written classes.
528 With all of these features the
\module{logging
} package should provide
529 enough flexibility for even the most complicated applications. This
530 is only an incomplete overview of its features, so please see the
531 \ulink{package's reference documentation
}{../lib/module-logging.html
}
532 for all of the details. Reading
\pep{282} will also be helpful.
537 \seepep{282}{A Logging System
}{Written by Vinay Sajip and Trent Mick;
538 implemented by Vinay Sajip.
}
543 %======================================================================
544 \section{PEP
285: A Boolean Type
\label{section-bool
}}
546 A Boolean type was added to Python
2.3. Two new constants were added
547 to the
\module{__builtin__
} module,
\constant{True
} and
548 \constant{False
}. (
\constant{True
} and
549 \constant{False
} constants were added to the built-ins
550 in Python
2.2.1, but the
2.2.1 versions simply have integer values of
551 1 and
0 and aren't a different type.)
553 The type object for this new type is named
554 \class{bool
}; the constructor for it takes any Python value and
555 converts it to
\constant{True
} or
\constant{False
}.
568 Most of the standard library modules and built-in functions have been
569 changed to return Booleans.
573 >>> hasattr(obj, 'append')
575 >>> isinstance(obj, list)
577 >>> isinstance(obj, tuple)
581 Python's Booleans were added with the primary goal of making code
582 clearer. For example, if you're reading a function and encounter the
583 statement
\code{return
1}, you might wonder whether the
\code{1}
584 represents a Boolean truth value, an index, or a
585 coefficient that multiplies some other quantity. If the statement is
586 \code{return True
}, however, the meaning of the return value is quite
589 Python's Booleans were
\emph{not
} added for the sake of strict
590 type-checking. A very strict language such as Pascal would also
591 prevent you performing arithmetic with Booleans, and would require
592 that the expression in an
\keyword{if
} statement always evaluate to a
593 Boolean. Python is not this strict, and it never will be, as
594 \pep{285} explicitly says. This means you can still use any
595 expression in an
\keyword{if
} statement, even ones that evaluate to a
596 list or tuple or some random object, and the Boolean type is a
597 subclass of the
\class{int
} class so that arithmetic using a Boolean
611 To sum up
\constant{True
} and
\constant{False
} in a sentence: they're
612 alternative ways to spell the integer values
1 and
0, with the single
613 difference that
\function{str()
} and
\function{repr()
} return the
614 strings
\code{'True'
} and
\code{'False'
} instead of
\code{'
1'
} and
619 \seepep{285}{Adding a bool type
}{Written and implemented by GvR.
}
624 %======================================================================
625 \section{PEP
293: Codec Error Handling Callbacks
}
627 When encoding a Unicode string into a byte string, unencodable
628 characters may be encountered. So far, Python has allowed specifying
629 the error processing as either ``strict'' (raising
630 \exception{UnicodeError
}), ``ignore'' (skipping the character), or
631 ``replace'' (using a question mark in the output string), with
632 ``strict'' being the default behavior. It may be desirable to specify
633 alternative processing of such errors, such as inserting an XML
634 character reference or HTML entity reference into the converted
637 Python now has a flexible framework to add different processing
638 strategies. New error handlers can be added with
639 \function{codecs.register_error
}. Codecs then can access the error
640 handler with
\function{codecs.lookup_error
}. An equivalent C API has
641 been added for codecs written in C. The error handler gets the
642 necessary state information such as the string being converted, the
643 position in the string where the error was detected, and the target
644 encoding. The handler can then either raise an exception or return a
647 Two additional error handlers have been implemented using this
648 framework: ``backslashreplace'' uses Python backslash quoting to
649 represent unencodable characters and ``xmlcharrefreplace'' emits
650 XML character references.
654 \seepep{293}{Codec Error Handling Callbacks
}{Written and implemented by
660 %======================================================================
661 \section{PEP
273: Importing Modules from Zip Archives
}
663 The new
\module{zipimport
} module adds support for importing
664 modules from a ZIP-format archive. You don't need to import the
665 module explicitly; it will be automatically imported if a ZIP
666 archive's filename is added to
\code{sys.path
}. For example:
669 amk@nyman:~/src/python$ unzip -l /tmp/example.zip
670 Archive: /tmp/example.zip
671 Length Date Time Name
672 -------- ---- ---- ----
673 8467 11-
26-
02 22:
30 jwzthreading.py
676 amk@nyman:~/src/python$ ./python
677 Python
2.3a0 (
#1, Dec
30 2002,
19:
54:
32)
679 >>> sys.path.insert(
0, '/tmp/example.zip') # Add .zip file to front of path
680 >>> import jwzthreading
681 >>> jwzthreading.__file__
682 '/tmp/example.zip/jwzthreading.py'
686 An entry in
\code{sys.path
} can now be the filename of a ZIP archive.
687 The ZIP archive can contain any kind of files, but only files named
688 \file{*.py
},
\file{*.pyc
}, or
\file{*.pyo
} can be imported. If an
689 archive only contains
\file{*.py
} files, Python will not attempt to
690 modify the archive by adding the corresponding
\file{*.pyc
} file, meaning
691 that if a ZIP archive doesn't contain
\file{*.pyc
} files, importing may be
694 A path within the archive can also be specified to only import from a
695 subdirectory; for example, the path
\file{/tmp/example.zip/lib/
}
696 would only import from the
\file{lib/
} subdirectory within the
701 \seepep{273}{Import Modules from Zip Archives
}{Written by James C. Ahlstrom,
702 who also provided an implementation.
703 Python
2.3 follows the specification in
\pep{273},
704 but uses an implementation written by Just van~Rossum
705 that uses the import hooks described in
\pep{302}.
706 See section~
\ref{section-pep302
} for a description of the new import hooks.
711 %======================================================================
712 \section{PEP
301: Package Index and Metadata for
713 Distutils
\label{section-pep301
}}
715 Support for the long-requested Python catalog makes its first
718 The core component is the new Distutils
\command{register
} command.
719 Running
\code{python setup.py register
} will collect the metadata
720 describing a package, such as its name, version, maintainer,
721 description, \&c., and send it to a central catalog server. The
722 catalog is available from
\url{http://www.python.org/pypi
}.
724 To make the catalog a bit more useful, a new optional
725 \var{classifiers
} keyword argument has been added to the Distutils
726 \function{setup()
} function. A list of
727 \ulink{Trove
}{http://catb.org/
\textasciitilde esr/trove/
}-style
728 strings can be supplied to help classify the software.
730 Here's an example
\file{setup.py
} with classifiers, written to be compatible
731 with older versions of the Distutils:
734 from distutils import core
735 kw =
{'name': "Quixote",
737 'description': "A highly Pythonic Web application framework",
741 if (hasattr(core, 'setup_keywords') and
742 'classifiers' in core.setup_keywords):
743 kw
['classifiers'
] = \
744 ['Topic :: Internet :: WWW/HTTP :: Dynamic Content',
745 'Environment :: No Input/Output (Daemon)',
746 'Intended Audience :: Developers'
],
751 The full list of classifiers can be obtained by running
752 \code{python setup.py register --list-classifiers}.
756 \seepep{301}{Package Index and Metadata for Distutils}{Written and
757 implemented by Richard Jones.}
762 %======================================================================
763 \section{PEP 302: New Import Hooks \label{section-pep302}}
765 While it's been possible to write custom import hooks ever since the
766 \module{ihooks} module was introduced in Python 1.3, no one has ever
767 been really happy with it because writing new import hooks is
768 difficult and messy. There have been various proposed alternatives
769 such as the \module{imputil} and \module{iu} modules, but none of them
770 has ever gained much acceptance, and none of them were easily usable
773 \pep{302} borrows ideas from its predecessors, especially from
774 Gordon McMillan's \module{iu} module. Three new items
775 are added to the \module{sys} module:
778 \item \code{sys.path_hooks} is a list of callable objects; most
779 often they'll be classes. Each callable takes a string containing a
780 path and either returns an importer object that will handle imports
781 from this path or raises an \exception{ImportError} exception if it
782 can't handle this path.
784 \item \code{sys.path_importer_cache} caches importer objects for
785 each path, so \code{sys.path_hooks} will only need to be traversed
788 \item \code{sys.meta_path} is a list of importer objects that will
789 be traversed before \code{sys.path} is checked. This list is
790 initially empty, but user code can add objects to it. Additional
791 built-in and frozen modules can be imported by an object added to
796 Importer objects must have a single method,
797 \method{find_module(\var{fullname}, \var{path}=None)}. \var{fullname}
798 will be a module or package name, e.g. \samp{string} or
799 \samp{distutils.core}. \method{find_module()} must return a loader object
800 that has a single method, \method{load_module(\var{fullname})}, that
801 creates and returns the corresponding module object.
803 Pseudo-code for Python's new import logic, therefore, looks something
804 like this (simplified a bit; see \pep{302} for the full details):
807 for mp in sys.meta_path:
808 loader = mp(fullname)
809 if loader is not None:
810 <module> = loader.load_module(fullname)
812 for path in sys.path:
813 for hook in sys.path_hooks:
815 importer = hook(path)
817 # ImportError, so try the other path hooks
820 loader = importer.find_module(fullname)
821 <module> = loader.load_module(fullname)
829 \seepep{302}{New Import Hooks}{Written by Just van~Rossum and Paul Moore.
830 Implemented by Just van~Rossum.
836 %======================================================================
837 \section{PEP 305: Comma-separated Files \label{section-pep305}}
839 Comma-separated files are a format frequently used for exporting data
840 from databases and spreadsheets. Python 2.3 adds a parser for
841 comma-separated files.
842 The format is deceptively simple at first glance:
848 Read a line and call \code{line.split(',')}: what could be simpler?
849 But toss in string data that can contain commas, and things get more
853 "Costs",150,200,3.95,"Includes taxes, shipping, and sundry items"
856 A big ugly regular expression can parse this, but using the new
857 \module{csv} package is much simpler:
862 input = open('datafile', 'rb')
863 reader = csv.reader(input)
868 The \function{reader} function takes a number of different options.
869 The field separator isn't limited to the comma and can be changed to
870 any character, and so can the quoting and line-ending characters.
872 Different dialects of comma-separated files can be defined and
873 registered; currently there are two, both for Microsoft Excel.
874 A separate \class{csv.writer} class will generate comma-separated files
875 from a succession of tuples or lists, quoting strings that contain the
880 \seepep{305}{CSV File API}{Written and implemented
881 by Kevin Altis, Dave Cole, Andrew McNamara, Skip Montanaro, Cliff Wells.
886 %======================================================================
887 \section{PEP 307: Pickle Enhancements \label{section-pep305}}
889 The \module{pickle} and \module{cPickle} modules received some
890 attention during the 2.3 development cycle. In 2.2, new-style classes
891 could be pickled without difficulty, but they weren't pickled very
892 compactly; \pep{307} quotes a trivial example where a new-style class
893 results in a pickled string three times longer than that for a classic
896 The solution was to invent a new pickle protocol. The
897 \function{pickle.dumps()} function has supported a text-or-binary flag
898 for a long time. In 2.3, this flag is redefined from a Boolean to an
899 integer; 0 is the old text-mode pickle format, 1 is the old binary
900 format, and now 2 is a new 2.3-specific format. (A new constant,
901 \constant{pickle.HIGHEST_PROTOCOL}, can be used to select the fanciest
904 Unpickling is no longer considered a safe operation. 2.2's
905 \module{pickle} provided hooks for trying to prevent unsafe classes
906 from being unpickled (specifically, a
907 \member{__safe_for_unpickling__} attribute), but none of this code
908 was ever audited and therefore it's all been ripped out in 2.3. You
909 should not unpickle untrusted data in any version of Python.
911 To reduce the pickling overhead for new-style classes, a new interface
912 for customizing pickling was added using three special methods:
913 \method{__getstate__}, \method{__setstate__}, and
914 \method{__getnewargs__}. Consult \pep{307} for the full semantics
917 As a way to compress pickles yet further, it's now possible to use
918 integer codes instead of long strings to identify pickled classes.
919 The Python Software Foundation will maintain a list of standardized
920 codes; there's also a range of codes for private use. Currently no
921 codes have been specified.
925 \seepep{307}{Extensions to the pickle protocol}{Written and implemented
926 by Guido van Rossum and Tim Peters.}
930 %======================================================================
931 \section{Extended Slices\label{section-slices}}
933 Ever since Python 1.4, the slicing syntax has supported an optional
934 third ``step'' or ``stride'' argument. For example, these are all
935 legal Python syntax: \code{L[1:10:2]}, \code{L[:-1:1]},
936 \code{L[::-1]}. This was added to Python at the request of
937 the developers of Numerical Python, which uses the third argument
938 extensively. However, Python's built-in list, tuple, and string
939 sequence types have never supported this feature, and you got a
940 \exception{TypeError} if you tried it. Michael Hudson contributed a
941 patch to fix this shortcoming.
943 For example, you can now easily extract the elements of a list that
952 Negative values also work to make a copy of the same list in reverse
957 [9, 8, 7, 6, 5, 4, 3, 2, 1, 0]
960 This also works for tuples, arrays, and strings:
970 If you have a mutable sequence such as a list or an array you can
971 assign to or delete an extended slice, but there are some differences
972 between assignment to extended and regular slices. Assignment to a
973 regular slice can be used to change the length of the sequence:
979 >>> a[1:3] = [4, 5, 6]
984 Extended slices aren't this flexible. When assigning to an extended
985 slice the list on the right hand side of the statement must contain
986 the same number of items as the slice it is replacing:
998 Traceback (most recent call last):
999 File "<stdin>", line 1, in ?
1000 ValueError: attempt to assign sequence of size 3 to extended slice of size 2
1003 Deletion is more straightforward:
1016 One can also now pass slice objects to the
1017 \method{__getitem__} methods of the built-in sequences:
1020 >>> range(10).__getitem__(slice(0, 5, 2))
1024 Or use slice objects directly in subscripts:
1027 >>> range(10)[slice(0, 5, 2)]
1031 To simplify implementing sequences that support extended slicing,
1032 slice objects now have a method \method{indices(\var{length})} which,
1033 given the length of a sequence, returns a \code{(\var{start},
1034 \var{stop}, \var{step})} tuple that can be passed directly to
1036 \method{indices()} handles omitted and out-of-bounds indices in a
1037 manner consistent with regular slices (and this innocuous phrase hides
1038 a welter of confusing details!). The method is intended to be used
1044 def calc_item(self, i):
1046 def __getitem__(self, item):
1047 if isinstance(item, slice):
1048 indices = item.indices(len(self))
1049 return FakeSeq([self.calc_item(i) in range(*indices)])
1051 return self.calc_item(i)
1054 From this example you can also see that the built-in \class{slice}
1055 object is now the type object for the slice type, and is no longer a
1056 function. This is consistent with Python 2.2, where \class{int},
1057 \class{str}, etc., underwent the same change.
1060 %======================================================================
1061 \section{Other Language Changes}
1063 Here are all of the changes that Python 2.3 makes to the core Python
1067 \item The \keyword{yield} statement is now always a keyword, as
1068 described in section~\ref{section-generators} of this document.
1070 \item A new built-in function \function{enumerate()}
1071 was added, as described in section~\ref{section-enumerate} of this
1074 \item Two new constants, \constant{True} and \constant{False} were
1075 added along with the built-in \class{bool} type, as described in
1076 section~\ref{section-bool} of this document.
1078 \item The \function{int()} type constructor will now return a long
1079 integer instead of raising an \exception{OverflowError} when a string
1080 or floating-point number is too large to fit into an integer. This
1081 can lead to the paradoxical result that
1082 \code{isinstance(int(\var{expression}), int)} is false, but that seems
1083 unlikely to cause problems in practice.
1085 \item Built-in types now support the extended slicing syntax,
1086 as described in section~\ref{section-slices} of this document.
1088 \item A new built-in function, \function{sum(\var{iterable}, \var{start}=0)},
1089 adds up the numeric items in the iterable object and returns their sum.
1090 \function{sum()} only accepts numbers, meaning that you can't use it
1091 to concatenate a bunch of strings, for example. (Contributed by Alex
1094 \item \code{list.insert(\var{pos}, \var{value})} used to
1095 insert \var{value} at the front of the list when \var{pos} was
1096 negative. The behaviour has now been changed to be consistent with
1097 slice indexing, so when \var{pos} is -1 the value will be inserted
1098 before the last element, and so forth.
1100 \item Dictionaries have a new method, \method{pop(\var{key}\optional{,
1101 \var{default}})}, that returns the value corresponding to \var{key}
1102 and removes that key/value pair from the dictionary. If the requested
1103 key isn't present in the dictionary, \var{default} is returned if it's
1104 specified and \exception{KeyError} raised if it isn't.
1111 Traceback (most recent call last):
1112 File "stdin", line 1, in ?
1117 Traceback (most recent call last):
1118 File "stdin", line 1, in ?
1119 KeyError: 'pop(): dictionary is empty'
1125 There's also a new class method,
1126 \method{dict.fromkeys(\var{iterable}, \var{value})}, that
1127 creates a dictionary with keys taken from the supplied iterator
1128 \var{iterable} and all values set to \var{value}, defaulting to
1131 (Patches contributed by Raymond Hettinger.)
1133 Also, the \function{dict()} constructor now accepts keyword arguments to
1134 simplify creating small dictionaries:
1137 >>> dict(red=1, blue=2, green=3, black=4)
1138 {'blue': 2, 'black': 4, 'green': 3, 'red': 1}
1141 (Contributed by Just van~Rossum.)
1143 \item The \keyword{assert} statement no longer checks the \code{__debug__}
1144 flag, so you can no longer disable assertions by assigning to \code{__debug__}.
1145 Running Python with the \programopt{-O} switch will still generate
1146 code that doesn't execute any assertions.
1148 \item Most type objects are now callable, so you can use them
1149 to create new objects such as functions, classes, and modules. (This
1150 means that the \module{new} module can be deprecated in a future
1151 Python version, because you can now use the type objects available in
1152 the \module{types} module.)
1153 % XXX should new.py use PendingDeprecationWarning?
1154 For example, you can create a new module object with the following code:
1158 >>> m = types.ModuleType('abc','docstring')
1160 <module 'abc' (built-in)>
1166 A new warning, \exception{PendingDeprecationWarning} was added to
1167 indicate features which are in the process of being
1168 deprecated. The warning will \emph{not} be printed by default. To
1169 check for use of features that will be deprecated in the future,
1170 supply \programopt{-Walways::PendingDeprecationWarning::} on the
1171 command line or use \function{warnings.filterwarnings()}.
1173 \item The process of deprecating string-based exceptions, as
1174 in \code{raise "Error occurred"}, has begun. Raising a string will
1175 now trigger \exception{PendingDeprecationWarning}.
1177 \item Using \code{None} as a variable name will now result in a
1178 \exception{SyntaxWarning} warning. In a future version of Python,
1179 \code{None} may finally become a keyword.
1181 \item The method resolution order used by new-style classes has
1182 changed, though you'll only notice the difference if you have a really
1183 complicated inheritance hierarchy. (Classic classes are unaffected by
1184 this change.) Python 2.2 originally used a topological sort of a
1185 class's ancestors, but 2.3 now uses the C3 algorithm as described in
1186 the paper \ulink{``A Monotonic Superclass Linearization for
1187 Dylan''}{http://www.webcom.com/haahr/dylan/linearization-oopsla96.html}.
1188 To understand the motivation for this change,
1189 read Michele Simionato's article
1190 \ulink{``Python 2.3 Method Resolution Order''}
1191 {http://www.python.org/2.3/mro.html}, or
1192 read the thread on python-dev starting with the message at
1193 \url{http://mail.python.org/pipermail/python-dev/2002-October/029035.html}.
1194 Samuele Pedroni first pointed out the problem and also implemented the
1195 fix by coding the C3 algorithm.
1197 \item Python runs multithreaded programs by switching between threads
1198 after executing N bytecodes. The default value for N has been
1199 increased from 10 to 100 bytecodes, speeding up single-threaded
1200 applications by reducing the switching overhead. Some multithreaded
1201 applications may suffer slower response time, but that's easily fixed
1202 by setting the limit back to a lower number using
1203 \function{sys.setcheckinterval(\var{N})}.
1205 \item One minor but far-reaching change is that the names of extension
1206 types defined by the modules included with Python now contain the
1207 module and a \character{.} in front of the type name. For example, in
1208 Python 2.2, if you created a socket and printed its
1209 \member{__class__}, you'd get this output:
1212 >>> s = socket.socket()
1217 In 2.3, you get this:
1220 <type '_socket.socket'>
1223 \item One of the noted incompatibilities between old- and new-style
1224 classes has been removed: you can now assign to the
1225 \member{__name__} and \member{__bases__} attributes of new-style
1226 classes. There are some restrictions on what can be assigned to
1227 \member{__bases__} along the lines of those relating to assigning to
1228 an instance's \member{__class__} attribute.
1233 %======================================================================
1234 \subsection{String Changes}
1238 \item The \keyword{in} operator now works differently for strings.
1239 Previously, when evaluating \code{\var{X} in \var{Y}} where \var{X}
1240 and \var{Y} are strings, \var{X} could only be a single character.
1241 That's now changed; \var{X} can be a string of any length, and
1242 \code{\var{X} in \var{Y}} will return \constant{True} if \var{X} is a
1243 substring of \var{Y}. If \var{X} is the empty string, the result is
1244 always \constant{True}.
1255 Note that this doesn't tell you where the substring starts; if you
1256 need that information, you must use the \method{find()} method
1259 \item The \method{strip()}, \method{lstrip()}, and \method{rstrip()}
1260 string methods now have an optional argument for specifying the
1261 characters to strip. The default is still to remove all whitespace
1267 >>> '><><abc<><><>'.strip('<>')
1269 >>> '><><abc<><><>\n'.strip('<>')
1271 >>> u'\u4000\u4001abc\u4000'.strip(u'\u4000')
1276 (Suggested by Simon Brunning and implemented by Walter D\"orwald.)
1278 \item The \method{startswith()} and \method{endswith()}
1279 string methods now accept negative numbers for the start and end
1282 \item Another new string method is \method{zfill()}, originally a
1283 function in the \module{string} module. \method{zfill()} pads a
1284 numeric string with zeros on the left until it's the specified width.
1285 Note that the \code{\%} operator is still more flexible and powerful
1286 than \method{zfill()}.
1291 >>> '12345'.zfill(4)
1293 >>> 'goofy'.zfill(6)
1297 (Contributed by Walter D\"orwald.)
1299 \item A new type object, \class{basestring}, has been added.
1300 Both 8-bit strings and Unicode strings inherit from this type, so
1301 \code{isinstance(obj, basestring)} will return \constant{True} for
1302 either kind of string. It's a completely abstract type, so you
1303 can't create \class{basestring} instances.
1305 \item Interned strings are no longer immortal, and will now be
1306 garbage-collected in the usual way when the only reference to them is
1307 from the internal dictionary of interned strings. (Implemented by
1313 %======================================================================
1314 \subsection{Optimizations}
1318 \item The creation of new-style class instances has been made much
1319 faster; they're now faster than classic classes!
1321 \item The \method{sort()} method of list objects has been extensively
1322 rewritten by Tim Peters, and the implementation is significantly
1325 \item Multiplication of large long integers is now much faster thanks
1326 to an implementation of Karatsuba multiplication, an algorithm that
1327 scales better than the O(n*n) required for the grade-school
1328 multiplication algorithm. (Original patch by Christopher A. Craig,
1329 and significantly reworked by Tim Peters.)
1331 \item The \code{SET_LINENO} opcode is now gone. This may provide a
1332 small speed increase, depending on your compiler's idiosyncrasies.
1333 See section~\ref{section-other} for a longer explanation.
1334 (Removed by Michael Hudson.)
1336 \item \function{xrange()} objects now have their own iterator, making
1337 \code{for i in xrange(n)} slightly faster than
1338 \code{for i in range(n)}. (Patch by Raymond Hettinger.)
1340 \item A number of small rearrangements have been made in various
1341 hotspots to improve performance, inlining a function here, removing
1342 some code there. (Implemented mostly by GvR, but lots of people have
1343 contributed single changes.)
1348 %======================================================================
1349 \section{New, Improved, and Deprecated Modules}
1351 As usual, Python's standard library received a number of enhancements and
1352 bug fixes. Here's a partial list of the most notable changes, sorted
1353 alphabetically by module name. Consult the
1354 \file{Misc/NEWS} file in the source tree for a more
1355 complete list of changes, or look through the CVS logs for all the
1360 \item The \module{array} module now supports arrays of Unicode
1361 characters using the \character{u} format character. Arrays also now
1362 support using the \code{+=} assignment operator to add another array's
1363 contents, and the \code{*=} assignment operator to repeat an array.
1364 (Contributed by Jason Orendorff.)
1366 \item The \module{bsddb} module has been replaced by version 4.1.1
1367 of the \ulink{PyBSDDB}{http://pybsddb.sourceforge.net} package,
1368 providing a more complete interface to the transactional features of
1369 the BerkeleyDB library.
1370 The old version of the module has been renamed to
1371 \module{bsddb185} and is no longer built automatically; you'll
1372 have to edit \file{Modules/Setup} to enable it. Note that the new
1373 \module{bsddb} package is intended to be compatible with the
1374 old module, so be sure to file bugs if you discover any
1375 incompatibilities. When upgrading to Python 2.3, if you also change
1376 the underlying BerkeleyDB library, you will almost certainly have to
1377 convert your database files to the new version. You can do this
1378 fairly easily with the new scripts \file{db2pickle.py} and
1379 \file{pickle2db.py} which you will find in the distribution's
1380 Tools/scripts directory. If you've already been using the PyBSDDB
1381 package and importing it as \module{bsddb3}, you will have to change your
1382 \code{import} statements.
1384 \item The new \module{bz2} module is an interface to the bz2 data
1385 compression library. bz2 usually produces output that's smaller than
1386 the compressed output from the \module{zlib} module, meaning that it
1387 compresses data more highly. (Contributed by Gustavo Niemeyer.)
1389 \item The Distutils \class{Extension} class now supports
1390 an extra constructor argument named \var{depends} for listing
1391 additional source files that an extension depends on. This lets
1392 Distutils recompile the module if any of the dependency files are
1393 modified. For example, if \file{sampmodule.c} includes the header
1394 file \file{sample.h}, you would create the \class{Extension} object like
1398 ext = Extension("samp",
1399 sources=["sampmodule.c"],
1400 depends=["sample.h"])
1403 Modifying \file{sample.h} would then cause the module to be recompiled.
1404 (Contributed by Jeremy Hylton.)
1406 \item Other minor changes to Distutils:
1407 it now checks for the \envvar{CC}, \envvar{CFLAGS}, \envvar{CPP},
1408 \envvar{LDFLAGS}, and \envvar{CPPFLAGS} environment variables, using
1409 them to override the settings in Python's configuration (contributed
1412 \item The new \function{gc.get_referents(\var{object})} function returns a
1413 list of all the objects referenced by \var{object}.
1415 \item The \module{getopt} module gained a new function,
1416 \function{gnu_getopt()}, that supports the same arguments as the existing
1417 \function{getopt()} function but uses GNU-style scanning mode.
1418 The existing \function{getopt()} stops processing options as soon as a
1419 non-option argument is encountered, but in GNU-style mode processing
1420 continues, meaning that options and arguments can be mixed. For
1424 >>> getopt.getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1425 ([('-f', 'filename')], ['output', '-v'])
1426 >>> getopt.gnu_getopt(['-f', 'filename', 'output', '-v'], 'f:v')
1427 ([('-f', 'filename'), ('-v', '')], ['output'])
1430 (Contributed by Peter \AA{strand}.)
1432 \item The \module{grp}, \module{pwd}, and \module{resource} modules
1433 now return enhanced tuples:
1437 >>> g = grp.getgrnam('amk')
1438 >>> g.gr_name, g.gr_gid
1442 \item The \module{gzip} module can now handle files exceeding 2~Gb.
1444 \item The new \module{heapq} module contains an implementation of a
1445 heap queue algorithm. A heap is an array-like data structure that
1446 keeps items in a partially sorted order such that, for every index
1447 \var{k}, \code{heap[\var{k}] <= heap[2*\var{k}+1]} and
1448 \code{heap[\var{k}] <= heap[2*\var{k}+2]}. This makes it quick to
1449 remove the smallest item, and inserting a new item while maintaining
1450 the heap property is O(lg~n). (See
1451 \url{http://www.nist.gov/dads/HTML/priorityque.html} for more
1452 information about the priority queue data structure.)
1454 The \module{heapq} module provides \function{heappush()} and
1455 \function{heappop()} functions for adding and removing items while
1456 maintaining the heap property on top of some other mutable Python
1457 sequence type. For example:
1462 >>> for item in [3, 7, 5, 11, 1]:
1463 ... heapq.heappush(heap, item)
1467 >>> heapq.heappop(heap)
1469 >>> heapq.heappop(heap)
1475 (Contributed by Kevin O'Connor.)
1477 \item The \module{imaplib} module now supports IMAP over SSL.
1478 (Contributed by Piers Lauder and Tino Lange.)
1480 \item The \module{itertools} contains a number of useful functions for
1481 use with iterators, inspired by various functions provided by the ML
1482 and Haskell languages. For example,
1483 \code{itertools.ifilter(predicate, iterator)} returns all elements in
1484 the iterator for which the function \function{predicate()} returns
1485 \constant{True}, and \code{itertools.repeat(obj, \var{N})} returns
1486 \code{obj} \var{N} times. There are a number of other functions in
1487 the module; see the \ulink{package's reference
1488 documentation}{../lib/module-itertools.html} for details.
1489 (Contributed by Raymond Hettinger.)
1491 \item Two new functions in the \module{math} module,
1492 \function{degrees(\var{rads})} and \function{radians(\var{degs})},
1493 convert between radians and degrees. Other functions in the
1494 \module{math} module such as \function{math.sin()} and
1495 \function{math.cos()} have always required input values measured in
1496 radians. Also, an optional \var{base} argument was added to
1497 \function{math.log()} to make it easier to compute logarithms for
1498 bases other than \code{e} and \code{10}. (Contributed by Raymond
1501 \item Several new functions (\function{getpgid()}, \function{killpg()},
1502 \function{lchown()}, \function{loadavg()}, \function{major()}, \function{makedev()},
1503 \function{minor()}, and \function{mknod()}) were added to the
1504 \module{posix} module that underlies the \module{os} module.
1505 (Contributed by Gustavo Niemeyer, Geert Jansen, and Denis S. Otkidach.)
1507 \item In the \module{os} module, the \function{*stat()} family of functions can now report
1508 fractions of a second in a timestamp. Such time stamps are
1509 represented as floats, similar to \function{time.time()}.
1511 During testing, it was found that some applications will break if time
1512 stamps are floats. For compatibility, when using the tuple interface
1513 of the \class{stat_result} time stamps will be represented as integers.
1514 When using named fields (a feature first introduced in Python 2.2),
1515 time stamps are still represented as integers, unless
1516 \function{os.stat_float_times()} is invoked to enable float return
1520 >>> os.stat("/tmp").st_mtime
1522 >>> os.stat_float_times(True)
1523 >>> os.stat("/tmp").st_mtime
1527 In Python 2.4, the default will change to always returning floats.
1529 Application developers should enable this feature only if all their
1530 libraries work properly when confronted with floating point time
1531 stamps, or if they use the tuple API. If used, the feature should be
1532 activated on an application level instead of trying to enable it on a
1535 \item The old and never-documented \module{linuxaudiodev} module has
1536 been deprecated, and a new version named \module{ossaudiodev} has been
1537 added. The module was renamed because the OSS sound drivers can be
1538 used on platforms other than Linux, and the interface has also been
1539 tidied and brought up to date in various ways. (Contributed by Greg
1540 Ward and Nicholas FitzRoy-Dale.)
1542 \item The new \module{platform} module contains a number of functions
1543 that try to determine various properties of the platform you're
1544 running on. There are functions for getting the architecture, CPU
1545 type, the Windows OS version, and even the Linux distribution version.
1546 (Contributed by Marc-Andr\'e Lemburg.)
1548 \item The parser objects provided by the \module{pyexpat} module
1549 can now optionally buffer character data, resulting in fewer calls to
1550 your character data handler and therefore faster performance. Setting
1551 the parser object's \member{buffer_text} attribute to \constant{True}
1552 will enable buffering.
1554 \item The \function{sample(\var{population}, \var{k})} function was
1555 added to the \module{random} module. \var{population} is a sequence
1556 or \class{xrange} object containing the elements of a population, and
1558 chooses \var{k} elements from the population without replacing chosen
1559 elements. \var{k} can be any value up to \code{len(\var{population})}.
1563 >>> days = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'St', 'Sn']
1564 >>> random.sample(days, 3) # Choose 3 elements
1566 >>> random.sample(days, 7) # Choose 7 elements
1567 ['Tu', 'Th', 'Mo', 'We', 'St', 'Fr', 'Sn']
1568 >>> random.sample(days, 7) # Choose 7 again
1569 ['We', 'Mo', 'Sn', 'Fr', 'Tu', 'St', 'Th']
1570 >>> random.sample(days, 8) # Can't choose eight
1571 Traceback (most recent call last):
1572 File "<stdin>", line 1, in ?
1573 File "random.py", line 414, in sample
1574 raise ValueError, "sample larger than population"
1575 ValueError: sample larger than population
1576 >>> random.sample(xrange(1,10000,2), 10) # Choose ten odd nos. under 10000
1577 [3407, 3805, 1505, 7023, 2401, 2267, 9733, 3151, 8083, 9195]
1580 The \module{random} module now uses a new algorithm, the Mersenne
1581 Twister, implemented in C. It's faster and more extensively studied
1582 than the previous algorithm.
1584 (All changes contributed by Raymond Hettinger.)
1586 \item The \module{readline} module also gained a number of new
1587 functions: \function{get_history_item()},
1588 \function{get_current_history_length()}, and \function{redisplay()}.
1590 \item The \module{rexec} and \module{Bastion} modules have been
1591 declared dead, and attempts to import them will fail with a
1592 \exception{RuntimeError}. New-style classes provide new ways to break
1593 out of the restricted execution environment provided by
1594 \module{rexec}, and no one has interest in fixing them or time to do
1595 so. If you have applications using \module{rexec}, rewrite them to
1598 (Sticking with Python 2.2 or 2.1 will not make your applications any
1599 safer because there are known bugs in the \module{rexec} module in
1600 those versions. To repeat: if you're using \module{rexec}, stop using
1603 \item The \module{rotor} module has been deprecated because the
1604 algorithm it uses for encryption is not believed to be secure. If
1605 you need encryption, use one of the several AES Python modules
1606 that are available separately.
1608 \item The \module{shutil} module gained a \function{move(\var{src},
1609 \var{dest})} function that recursively moves a file or directory to a new
1612 \item Support for more advanced POSIX signal handling was added
1613 to the \module{signal} but then removed again as it proved impossible
1614 to make it work reliably across platforms.
1616 \item The \module{socket} module now supports timeouts. You
1617 can call the \method{settimeout(\var{t})} method on a socket object to
1618 set a timeout of \var{t} seconds. Subsequent socket operations that
1619 take longer than \var{t} seconds to complete will abort and raise a
1620 \exception{socket.error} exception.
1622 The original timeout implementation was by Tim O'Malley. Michael
1623 Gilfix integrated it into the Python \module{socket} module and
1624 shepherded it through a lengthy review. After the code was checked
1625 in, Guido van~Rossum rewrote parts of it. (This is a good example of
1626 a collaborative development process in action.)
1628 \item On Windows, the \module{socket} module now ships with Secure
1629 Sockets Layer (SSL) support.
1631 \item The value of the C \constant{PYTHON_API_VERSION} macro is now
1632 exposed at the Python level as \code{sys.api_version}. The current
1633 exception can be cleared by calling the new \function{sys.exc_clear()}
1636 \item The new \module{tarfile} module
1637 allows reading from and writing to \program{tar}-format archive files.
1638 (Contributed by Lars Gust\"abel.)
1640 \item The new \module{textwrap} module contains functions for wrapping
1641 strings containing paragraphs of text. The \function{wrap(\var{text},
1642 \var{width})} function takes a string and returns a list containing
1643 the text split into lines of no more than the chosen width. The
1644 \function{fill(\var{text}, \var{width})} function returns a single
1645 string, reformatted to fit into lines no longer than the chosen width.
1646 (As you can guess, \function{fill()} is built on top of
1647 \function{wrap()}. For example:
1651 >>> paragraph = "Not a whit, we defy augury: ... more text ..."
1652 >>> textwrap.wrap(paragraph, 60)
1653 ["Not a whit, we defy augury: there's a special providence in",
1654 "the fall of a sparrow. If it be now, 'tis not to come; if it",
1656 >>> print textwrap.fill(paragraph, 35)
1657 Not a whit, we defy augury: there's
1658 a special providence in the fall of
1659 a sparrow. If it be now, 'tis not
1660 to come; if it be not to come, it
1661 will be now; if it be not now, yet
1662 it will come: the readiness is all.
1666 The module also contains a \class{TextWrapper} class that actually
1667 implements the text wrapping strategy. Both the
1668 \class{TextWrapper} class and the \function{wrap()} and
1669 \function{fill()} functions support a number of additional keyword
1670 arguments for fine-tuning the formatting; consult the \ulink{module's
1671 documentation}{../lib/module-textwrap.html} for details.
1672 (Contributed by Greg Ward.)
1674 \item The \module{thread} and \module{threading} modules now have
1675 companion modules, \module{dummy_thread} and \module{dummy_threading},
1676 that provide a do-nothing implementation of the \module{thread}
1677 module's interface for platforms where threads are not supported. The
1678 intention is to simplify thread-aware modules (ones that \emph{don't}
1679 rely on threads to run) by putting the following code at the top:
1683 import threading as _threading
1685 import dummy_threading as _threading
1688 Code can then call functions and use classes in \module{_threading}
1689 whether or not threads are supported, avoiding an \keyword{if}
1690 statement and making the code slightly clearer. This module will not
1691 magically make multithreaded code run without threads; code that waits
1692 for another thread to return or to do something will simply hang
1693 forever. (In this example, \module{_threading} is used as the module
1694 name to make it clear that the module being used is not necessarily
1695 the actual \module{threading} module.)
1697 \item The \module{time} module's \function{strptime()} function has
1698 long been an annoyance because it uses the platform C library's
1699 \function{strptime()} implementation, and different platforms
1700 sometimes have odd bugs. Brett Cannon contributed a portable
1701 implementation that's written in pure Python and should behave
1702 identically on all platforms.
1704 \item The new \module{timeit} module helps measure how long snippets
1705 of Python code take to execute. The \file{timeit.py} file can be run
1706 directly from the command line, or the module's \class{Timer} class
1707 can be imported and used directly. Here's a short example that
1708 figures out whether it's faster to convert an 8-bit string to Unicode
1709 by appending an empty Unicode string to it or by using the
1710 \function{unicode()} function:
1715 timer1 = timeit.Timer('unicode("abc")')
1716 timer2 = timeit.Timer('"abc" + u""')
1719 print timer1.repeat(repeat=3, number=100000)
1720 print timer2.repeat(repeat=3, number=100000)
1722 # On my laptop this outputs:
1723 # [0.36831796169281006, 0.37441694736480713, 0.35304892063140869]
1724 # [0.17574405670166016, 0.18193507194519043, 0.17565798759460449]
1728 \item The \module{UserDict} module has a new \class{DictMixin} class which
1729 defines all dictionary methods for classes that already have a minimum
1730 mapping interface. This greatly simplifies writing classes that need
1731 to be substitutable for dictionaries, such as the classes in
1732 the \module{shelve} module.
1734 Adding the mixin as a superclass provides the full dictionary
1735 interface whenever the class defines \method{__getitem__},
1736 \method{__setitem__}, \method{__delitem__}, and \method{keys}.
1741 >>> class SeqDict(UserDict.DictMixin):
1742 """Dictionary lookalike implemented with lists."""
1746 def __getitem__(self, key):
1748 i = self.keylist.index(key)
1751 return self.valuelist[i]
1752 def __setitem__(self, key, value):
1754 i = self.keylist.index(key)
1755 self.valuelist[i] = value
1757 self.keylist.append(key)
1758 self.valuelist.append(value)
1759 def __delitem__(self, key):
1761 i = self.keylist.index(key)
1765 self.valuelist.pop(i)
1767 return list(self.keylist)
1770 >>> dir(s) # See that other dictionary methods are implemented
1771 ['__cmp__', '__contains__', '__delitem__', '__doc__', '__getitem__',
1772 '__init__', '__iter__', '__len__', '__module__', '__repr__',
1773 '__setitem__', 'clear', 'get', 'has_key', 'items', 'iteritems',
1774 'iterkeys', 'itervalues', 'keylist', 'keys', 'pop', 'popitem',
1775 'setdefault', 'update', 'valuelist', 'values']
1778 (Contributed by Raymond Hettinger.)
1780 item The \module{Tix} module has received various bug fixes and
1781 updates for the current version of the Tix package.
1783 \item The \module{Tkinter} module now works with a thread-enabled
1784 version of Tcl. Tcl's threading model requires that widgets only be
1785 accessed from the thread in which they're created; accesses from
1786 another thread can cause Tcl to panic. For certain Tcl interfaces,
1787 \module{Tkinter} will now automatically avoid this
1788 when a widget is accessed from a different thread by marshalling a
1789 command, passing it to the correct thread, and waiting for the
1790 results. Other interfaces can't be handled automatically but
1791 \module{Tkinter} will now raise an exception on such an access so that
1792 at least you can find out about the problem. See
1793 \url{http://mail.python.org/pipermail/python-dev/2002-December/031107.html} %
1794 for a more detailed explanation of this change. (Implemented by
1795 Martin von~L\"owis.)
1797 \item Calling Tcl methods through \module{_tkinter} no longer
1798 returns only strings. Instead, if Tcl returns other objects those
1799 objects are converted to their Python equivalent, if one exists, or
1800 wrapped with a \class{_tkinter.Tcl_Obj} object if no Python equivalent
1801 exists. This behavior can be controlled through the
1802 \method{wantobjects()} method of \class{tkapp} objects.
1804 When using \module{_tkinter} through the \module{Tkinter} module (as
1805 most Tkinter applications will), this feature is always activated. It
1806 should not cause compatibility problems, since Tkinter would always
1807 convert string results to Python types where possible.
1809 If any incompatibilities are found, the old behavior can be restored
1810 by setting the \member{wantobjects} variable in the \module{Tkinter}
1811 module to false before creating the first \class{tkapp} object.
1815 Tkinter.wantobjects = 0
1818 Any breakage caused by this change should be reported as a bug.
1820 \item The DOM implementation
1821 in \module{xml.dom.minidom} can now generate XML output in a
1822 particular encoding by providing an optional encoding argument to
1823 the \method{toxml()} and \method{toprettyxml()} methods of DOM nodes.
1825 \item The new \module{DocXMLRPCServer} module allows writing
1826 self-documenting XML-RPC servers. Run it in demo mode (as a program)
1827 to see it in action. Pointing the Web browser to the RPC server
1828 produces pydoc-style documentation; pointing xmlrpclib to the
1829 server allows invoking the actual methods.
1830 (Contributed by Brian Quinlan.)
1832 \item Support for internationalized domain names (RFCs 3454, 3490,
1833 3491, and 3492) has been added. The ``idna'' encoding can be used
1834 to convert between a Unicode domain name and the ASCII-compatible
1835 encoding (ACE) of that name.
1838 >{}>{}> u"www.Alliancefran\c{c}aise.nu".encode("idna")
1839 'www.xn--alliancefranaise-npb.nu'
1842 The \module{socket} module has also been extended to transparently
1843 convert Unicode hostnames to the ACE version before passing them to
1844 the C library. Modules that deal with hostnames such as
1845 \module{httplib} and \module{ftplib}) also support Unicode host names;
1846 \module{httplib} also sends HTTP \samp{Host} headers using the ACE
1847 version of the domain name. \module{urllib} supports Unicode URLs
1848 with non-ASCII host names as long as the \code{path} part of the URL
1851 To implement this change, the module \module{stringprep}, the tool
1852 \code{mkstringprep} and the \code{punycode} encoding have been added.
1857 %======================================================================
1858 \subsection{Date/Time Type}
1860 Date and time types suitable for expressing timestamps were added as
1861 the \module{datetime} module. The types don't support different
1862 calendars or many fancy features, and just stick to the basics of
1865 The three primary types are: \class{date}, representing a day, month,
1866 and year; \class{time}, consisting of hour, minute, and second; and
1867 \class{datetime}, which contains all the attributes of both
1868 \class{date} and \class{time}. There's also a
1869 \class{timedelta} class representing differences between two points
1870 in time, and time zone logic is implemented by classes inheriting from
1871 the abstract \class{tzinfo} class.
1873 You can create instances of \class{date} and \class{time} by either
1874 supplying keyword arguments to the appropriate constructor,
1875 e.g. \code{datetime.date(year=1972, month=10, day=15)}, or by using
1876 one of a number of class methods. For example, the \method{date.today()}
1877 class method returns the current local date.
1879 Once created, instances of the date/time classes are all immutable.
1880 There are a number of methods for producing formatted strings from
1885 >>> now = datetime.datetime.now()
1887 '2002-12-30T21:27:03.994956'
1888 >>> now.ctime() # Only available on date, datetime
1889 'Mon Dec 30 21:27:03 2002'
1890 >>> now.strftime('%Y %d %b')
1894 The \method{replace()} method allows modifying one or more fields
1895 of a \class{date} or \class{datetime} instance:
1898 >>> d = datetime.datetime.now()
1900 datetime.datetime(2002, 12, 30, 22, 15, 38, 827738)
1901 >>> d.replace(year=2001, hour = 12)
1902 datetime.datetime(2001, 12, 30, 12, 15, 38, 827738)
1906 Instances can be compared, hashed, and converted to strings (the
1907 result is the same as that of \method{isoformat()}). \class{date} and
1908 \class{datetime} instances can be subtracted from each other, and
1909 added to \class{timedelta} instances. The largest missing feature is
1910 that there's no support for parsing strings and getting back a
1911 \class{date} or \class{datetime}.
1913 For more information, refer to the \ulink{module's reference
1914 documentation}{../lib/module-datetime.html}.
1915 (Contributed by Tim Peters.)
1918 %======================================================================
1919 \subsection{The optparse Module}
1921 The \module{getopt} module provides simple parsing of command-line
1922 arguments. The new \module{optparse} module (originally named Optik)
1923 provides more elaborate command-line parsing that follows the Unix
1924 conventions, automatically creates the output for \longprogramopt{help},
1925 and can perform different actions for different options.
1927 You start by creating an instance of \class{OptionParser} and telling
1928 it what your program's options are.
1932 from optparse import OptionParser
1935 op.add_option('-i', '--input',
1936 action='store', type='string', dest='input',
1937 help='set input filename')
1938 op.add_option('-l', '--length',
1939 action='store', type='int', dest='length',
1940 help='set maximum length of output')
1943 Parsing a command line is then done by calling the \method{parse_args()}
1949 options, args = optparse.parse_args(sys.argv[1:])
1954 This returns an object containing all of the option values,
1955 and a list of strings containing the remaining arguments.
1957 Invoking the script with the various arguments now works as you'd
1958 expect it to. Note that the length argument is automatically
1959 converted to an integer.
1962 $ ./python opt.py -i data arg1
1963 <Values at 0x400cad4c: {'input': 'data', 'length': None}>
1965 $ ./python opt.py --input=data --length=4
1966 <Values at 0x400cad2c: {'input': 'data', 'length': 4}>
1971 The help message is automatically generated for you:
1974 $ ./python opt.py --help
1975 usage: opt.py [options]
1978 -h, --help show this help message and exit
1979 -iINPUT, --input=INPUT
1981 -lLENGTH, --length=LENGTH
1982 set maximum length of output
1985 % $ prevent Emacs tex-mode from getting confused
1987 See the \ulink{module's documentation}{../lib/module-optparse.html}
1990 Optik was written by Greg Ward, with suggestions from the readers of
1994 %======================================================================
1995 \section{Pymalloc: A Specialized Object Allocator\label{section-pymalloc}}
1997 Pymalloc, a specialized object allocator written by Vladimir
1998 Marangozov, was a feature added to Python 2.1. Pymalloc is intended
1999 to be faster than the system \cfunction{malloc()} and to have less
2000 memory overhead for allocation patterns typical of Python programs.
2001 The allocator uses C's \cfunction{malloc()} function to get large
2002 pools of memory and then fulfills smaller memory requests from these
2005 In 2.1 and 2.2, pymalloc was an experimental feature and wasn't
2006 enabled by default; you had to explicitly enable it when compiling
2007 Python by providing the
2008 \longprogramopt{with-pymalloc} option to the \program{configure}
2009 script. In 2.3, pymalloc has had further enhancements and is now
2010 enabled by default; you'll have to supply
2011 \longprogramopt{without-pymalloc} to disable it.
2013 This change is transparent to code written in Python; however,
2014 pymalloc may expose bugs in C extensions. Authors of C extension
2015 modules should test their code with pymalloc enabled,
2016 because some incorrect code may cause core dumps at runtime.
2018 There's one particularly common error that causes problems. There are
2019 a number of memory allocation functions in Python's C API that have
2020 previously just been aliases for the C library's \cfunction{malloc()}
2021 and \cfunction{free()}, meaning that if you accidentally called
2022 mismatched functions the error wouldn't be noticeable. When the
2023 object allocator is enabled, these functions aren't aliases of
2024 \cfunction{malloc()} and \cfunction{free()} any more, and calling the
2025 wrong function to free memory may get you a core dump. For example,
2026 if memory was allocated using \cfunction{PyObject_Malloc()}, it has to
2027 be freed using \cfunction{PyObject_Free()}, not \cfunction{free()}. A
2028 few modules included with Python fell afoul of this and had to be
2029 fixed; doubtless there are more third-party modules that will have the
2032 As part of this change, the confusing multiple interfaces for
2033 allocating memory have been consolidated down into two API families.
2034 Memory allocated with one family must not be manipulated with
2035 functions from the other family. There is one family for allocating
2036 chunks of memory, and another family of functions specifically for
2037 allocating Python objects.
2040 \item To allocate and free an undistinguished chunk of memory use
2041 the ``raw memory'' family: \cfunction{PyMem_Malloc()},
2042 \cfunction{PyMem_Realloc()}, and \cfunction{PyMem_Free()}.
2044 \item The ``object memory'' family is the interface to the pymalloc
2045 facility described above and is biased towards a large number of
2046 ``small'' allocations: \cfunction{PyObject_Malloc},
2047 \cfunction{PyObject_Realloc}, and \cfunction{PyObject_Free}.
2049 \item To allocate and free Python objects, use the ``object'' family
2050 \cfunction{PyObject_New()}, \cfunction{PyObject_NewVar()}, and
2051 \cfunction{PyObject_Del()}.
2054 Thanks to lots of work by Tim Peters, pymalloc in 2.3 also provides
2055 debugging features to catch memory overwrites and doubled frees in
2056 both extension modules and in the interpreter itself. To enable this
2057 support, compile a debugging version of the Python interpreter by
2058 running \program{configure} with \longprogramopt{with-pydebug}.
2060 To aid extension writers, a header file \file{Misc/pymemcompat.h} is
2061 distributed with the source to Python 2.3 that allows Python
2062 extensions to use the 2.3 interfaces to memory allocation while
2063 compiling against any version of Python since 1.5.2. You would copy
2064 the file from Python's source distribution and bundle it with the
2065 source of your extension.
2069 \seeurl{http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/python/python/dist/src/Objects/obmalloc.c}
2070 {For the full details of the pymalloc implementation, see
2071 the comments at the top of the file \file{Objects/obmalloc.c} in the
2072 Python source code. The above link points to the file within the
2073 SourceForge CVS browser.}
2078 % ======================================================================
2079 \section{Build and C API Changes}
2081 Changes to Python's build process and to the C API include:
2085 \item The C-level interface to the garbage collector has been changed,
2086 to make it easier to write extension types that support garbage
2087 collection, and to make it easier to debug misuses of the functions.
2088 Various functions have slightly different semantics, so a bunch of
2089 functions had to be renamed. Extensions that use the old API will
2090 still compile but will \emph{not} participate in garbage collection,
2091 so updating them for 2.3 should be considered fairly high priority.
2093 To upgrade an extension module to the new API, perform the following
2098 \item Rename \cfunction{Py_TPFLAGS_GC} to \cfunction{PyTPFLAGS_HAVE_GC}.
2100 \item Use \cfunction{PyObject_GC_New} or \cfunction{PyObject_GC_NewVar} to
2101 allocate objects, and \cfunction{PyObject_GC_Del} to deallocate them.
2103 \item Rename \cfunction{PyObject_GC_Init} to \cfunction{PyObject_GC_Track} and
2104 \cfunction{PyObject_GC_Fini} to \cfunction{PyObject_GC_UnTrack}.
2106 \item Remove \cfunction{PyGC_HEAD_SIZE} from object size calculations.
2108 \item Remove calls to \cfunction{PyObject_AS_GC} and \cfunction{PyObject_FROM_GC}.
2112 \item The cycle detection implementation used by the garbage collection
2113 has proven to be stable, so it's now being made mandatory; you can no
2114 longer compile Python without it, and the
2115 \longprogramopt{with-cycle-gc} switch to \program{configure} has been removed.
2117 \item Python can now optionally be built as a shared library
2118 (\file{libpython2.3.so}) by supplying \longprogramopt{enable-shared}
2119 when running Python's \program{configure} script. (Contributed by Ondrej
2122 \item The \csimplemacro{DL_EXPORT} and \csimplemacro{DL_IMPORT} macros
2123 are now deprecated. Initialization functions for Python extension
2124 modules should now be declared using the new macro
2125 \csimplemacro{PyMODINIT_FUNC}, while the Python core will generally
2126 use the \csimplemacro{PyAPI_FUNC} and \csimplemacro{PyAPI_DATA}
2129 \item The interpreter can be compiled without any docstrings for
2130 the built-in functions and modules by supplying
2131 \longprogramopt{without-doc-strings} to the \program{configure} script.
2132 This makes the Python executable about 10\% smaller, but will also
2133 mean that you can't get help for Python's built-ins. (Contributed by
2136 \item The \cfunction{PyArg_NoArgs()} macro is now deprecated, and code
2137 that uses it should be changed. For Python 2.2 and later, the method
2138 definition table can specify the
2139 \constant{METH_NOARGS} flag, signalling that there are no arguments, and
2140 the argument checking can then be removed. If compatibility with
2141 pre-2.2 versions of Python is important, the code could use
2142 \code{PyArg_ParseTuple(\var{args}, "")} instead, but this will be slower
2143 than using \constant{METH_NOARGS}.
2145 \item A new function, \cfunction{PyObject_DelItemString(\var{mapping},
2146 char *\var{key})} was added
2148 \code{PyObject_DelItem(\var{mapping}, PyString_New(\var{key})}.
2150 \item The \method{xreadlines()} method of file objects, introduced in
2151 Python 2.1, is no longer necessary because files now behave as their
2152 own iterator. \method{xreadlines()} was originally introduced as a
2153 faster way to loop over all the lines in a file, but now you can
2154 simply write \code{for line in file_obj}.
2156 \item File objects now manage their internal string buffer
2157 differently, increasing it exponentially when needed. This results in
2158 the benchmark tests in \file{Lib/test/test_bufio.py} speeding up
2159 considerably (from 57 seconds to 1.7 seconds, according to one
2162 \item It's now possible to define class and static methods for a C
2163 extension type by setting either the \constant{METH_CLASS} or
2164 \constant{METH_STATIC} flags in a method's \ctype{PyMethodDef}
2167 \item Python now includes a copy of the Expat XML parser's source code,
2168 removing any dependence on a system version or local installation of
2171 \item If you dynamically allocate type objects in your extension, you
2172 should be aware of a change in the rules relating to the
2173 \member{__module__} and \member{__name__} attributes. In summary,
2174 you will want to ensure the type's dictionary contains a
2175 \code{'__module__'} key; making the module name the part of the type
2176 name leading up to the final period will no longer have the desired
2177 effect. For more detail, read the API reference documentation or the
2183 %======================================================================
2184 \subsection{Port-Specific Changes}
2186 Support for a port to IBM's OS/2 using the EMX runtime environment was
2187 merged into the main Python source tree. EMX is a POSIX emulation
2188 layer over the OS/2 system APIs. The Python port for EMX tries to
2189 support all the POSIX-like capability exposed by the EMX runtime, and
2190 mostly succeeds; \function{fork()} and \function{fcntl()} are
2191 restricted by the limitations of the underlying emulation layer. The
2192 standard OS/2 port, which uses IBM's Visual Age compiler, also gained
2193 support for case-sensitive import semantics as part of the integration
2194 of the EMX port into CVS. (Contributed by Andrew MacIntyre.)
2196 On MacOS, most toolbox modules have been weaklinked to improve
2197 backward compatibility. This means that modules will no longer fail
2198 to load if a single routine is missing on the curent OS version.
2199 Instead calling the missing routine will raise an exception.
2200 (Contributed by Jack Jansen.)
2202 The RPM spec files, found in the \file{Misc/RPM/} directory in the
2203 Python source distribution, were updated for 2.3. (Contributed by
2204 Sean Reifschneider.)
2206 Other new platforms now supported by Python include AtheOS
2207 (\url{http://www.atheos.cx/}), GNU/Hurd, and OpenVMS.
2210 %======================================================================
2211 \section{Other Changes and Fixes \label{section-other}}
2213 As usual, there were a bunch of other improvements and bugfixes
2214 scattered throughout the source tree. A search through the CVS change
2215 logs finds there were 121 patches applied and 103 bugs fixed between
2216 Python 2.2 and 2.3. Both figures are likely to be underestimates.
2218 Some of the more notable changes are:
2222 \item The \file{regrtest.py} script now provides a way to allow ``all
2223 resources except \var{foo}.'' A resource name passed to the
2224 \programopt{-u} option can now be prefixed with a hyphen
2225 (\character{-}) to mean ``remove this resource.'' For example, the
2226 option `\code{\programopt{-u}all,-bsddb}' could be used to enable the
2227 use of all resources except \code{bsddb}.
2229 \item The tools used to build the documentation now work under Cygwin
2232 \item The \code{SET_LINENO} opcode has been removed. Back in the
2233 mists of time, this opcode was needed to produce line numbers in
2234 tracebacks and support trace functions (for, e.g., \module{pdb}).
2235 Since Python 1.5, the line numbers in tracebacks have been computed
2236 using a different mechanism that works with ``python -O''. For Python
2237 2.3 Michael Hudson implemented a similar scheme to determine when to
2238 call the trace function, removing the need for \code{SET_LINENO}
2241 It would be difficult to detect any resulting difference from Python
2242 code, apart from a slight speed up when Python is run without
2245 C extensions that access the \member{f_lineno} field of frame objects
2246 should instead call \code{PyCode_Addr2Line(f->f_code, f->f_lasti)}.
2247 This will have the added effect of making the code work as desired
2248 under ``python -O'' in earlier versions of Python.
2250 A nifty new feature is that trace functions can now assign to the
2251 \member{f_lineno} attribute of frame objects, changing the line that
2252 will be executed next. A \samp{jump} command has been added to the
2253 \module{pdb} debugger taking advantage of this new feature.
2254 (Implemented by Richie Hindle.)
2259 %======================================================================
2260 \section{Porting to Python 2.3}
2262 This section lists previously described changes that may require
2263 changes to your code:
2267 \item \keyword{yield} is now always a keyword; if it's used as a
2268 variable name in your code, a different name must be chosen.
2270 \item For strings \var{X} and \var{Y}, \code{\var{X} in \var{Y}} now works
2271 if \var{X} is more than one character long.
2273 \item The \function{int()} type constructor will now return a long
2274 integer instead of raising an \exception{OverflowError} when a string
2275 or floating-point number is too large to fit into an integer.
2277 \item If you have Unicode strings that contain 8-bit characters, you
2278 must declare the file's encoding (UTF-8, Latin-1, or whatever) by
2279 adding a comment to the top of the file. See
2280 section~\ref{section-encodings} for more information.
2282 \item Calling Tcl methods through \module{_tkinter} no longer
2283 returns only strings. Instead, if Tcl returns other objects those
2284 objects are converted to their Python equivalent, if one exists, or
2285 wrapped with a \class{_tkinter.Tcl_Obj} object if no Python equivalent
2288 \item Large octal and hex literals such as
2289 \code{0xffffffff} now trigger a \exception{FutureWarning}. Currently
2290 they're stored as 32-bit numbers and result in a negative value, but
2291 in Python 2.4 they'll become positive long integers.
2293 There are a few ways to fix this warning. If you really need a
2294 positive number, just add an \samp{L} to the end of the literal. If
2295 you're trying to get a 32-bit integer with low bits set and have
2296 previously used an expression such as \code{~(1 << 31)}, it's probably
2297 clearest to start with all bits set and clear the desired upper bits.
2298 For example, to clear just the top bit (bit 31), you could write
2299 \code{0xffffffffL {\&}{\textasciitilde}(1L<<31)}.
2301 \item You can no longer disable assertions by assigning to \code{__debug__}.
2303 \item The Distutils \function{setup()} function has gained various new
2304 keyword arguments such as \var{depends}. Old versions of the
2305 Distutils will abort if passed unknown keywords. The fix is to check
2306 for the presence of the new \function{get_distutil_options()} function
2307 in your \file{setup.py} if you want to only support the new keywords
2308 with a version of the Distutils that supports them:
2311 from distutils import core
2313 kw = {'sources': 'foo.c', ...}
2314 if hasattr(core, 'get_distutil_options'):
2315 kw['depends'] = ['foo.h']
2316 ext = Extension(**kw)
2319 \item Using \code{None} as a variable name will now result in a
2320 \exception{SyntaxWarning} warning.
2322 \item Names of extension types defined by the modules included with
2323 Python now contain the module and a \character{.} in front of the type
2329 %======================================================================
2330 \section{Acknowledgements \label{acks}}
2332 The author would like to thank the following people for offering
2333 suggestions, corrections and assistance with various drafts of this
2334 article: Jeff Bauer, Simon Brunning, Brett Cannon, Michael Chermside,
2335 Andrew Dalke, Scott David Daniels, Fred~L. Drake, Jr., Kelly Gerber,
2336 Raymond Hettinger, Michael Hudson, Chris Lambert, Detlef Lannert,
2337 Martin von~L\"owis, Andrew MacIntyre, Lalo Martins, Chad Netzer,
2338 Gustavo Niemeyer, Neal Norwitz, Hans Nowak, Chris Reedy, Francesco
2339 Ricciardi, Vinay Sajip, Neil Schemenauer, Roman Suzi, Jason Tishler,