Fix three PyChecker-detected gotchas.
[python/dscho.git] / Misc / NEWS
blob8766a47dfff73f49de9bfdb74a686e614cd1494e
1 What's New in Python 2.1c2?
2 ===========================
4 A flurry of small changes, and one showstopper fixed in the nick of
5 time made it necessary to release another release candidate.  The list
6 here is the *complete* list of patches (except version updates):
8 Core
10 - Tim discovered a nasty bug in the dictionary code, caused by
11   PyDict_Next() calling dict_resize(), and the GC code's use of
12   PyDict_Next() violating an assumption in dict_items().  This was
13   fixed with considerable amounts of band-aid, but the net effect is a
14   saner and more robust implementation.
16 - Made a bunch of symbols static that were accidentally global.
18 Build and Ports
20 - The setup.py script didn't check for a new enough version of zlib
21   (1.1.3 is needed).  Now it does.
23 - Changed "make clean" target to also remove shared libraries.
25 - Added a more general warning about the SGI Irix optimizer to README.
27 Library
29 - Fix a bug in urllib.basejoin("http://host", "../file.html") which
30   omitted the slash between host and file.html.
32 - The mailbox module's _Mailbox class contained a completely broken
33   and undocumented seek() method.  Ripped it out.
35 - Fixed a bunch of typos in various library modules (urllib2, smtpd,
36   sgmllib, netrc, chunk) found by Neil Norwitz's PyChecker.
38 - Fixed a few last-minute bugs in unittest.
40 Extensions
42 - Reverted the patch to the OpenSSL code in socketmodule.c to support
43   RAND_status() and the EGD, and the subsequent patch that tried to
44   fix it for pre-0.9.5 versions; the problem with the patch is that on
45   some systems it issues a warning whenever socket is imported, and
46   that's unacceptable.
48 Tests
50 - Fixed the pickle tests to work with "import test.test_pickle".
52 - Tweaked test_locale.py to actually run the test Windows.
54 - In distutils/archive_util.py, call zipfile.ZipFile() with mode "w",
55   not "wb" (which is not a valid mode at all).
57 - Fix pstats browser crashes.  Import readline if it exists to make
58   the user interface nicer.
60 - Add "import thread" to the top of test modules that import the
61   threading module (test_asynchat and test_threadedtempfile).  This
62   prevents test failures caused by a broken threading module resulting
63   from a previously caught failed import.
65 - Changed test_asynchat.py to set the SO_REUSEADDR option; this was
66   needed on some platforms (e.g. Solaris 8) when the tests are run
67   twice in succession.
69 - Skip rather than fail test_sunaudiodev if no audio device is found.
72 What's New in Python 2.1c1?
73 ===========================
75 This list was significantly updated when 2.1c2 was released; the 2.1c1
76 release didn't mention most changes that were actually part of 2.1c1:
78 Legal
80 - Copyright was assigned to the Python Software Foundation (PSF) and a
81   PSF license (very similar to the CNRI license) was added.
83 - The CNRI copyright notice was updated to include 2001.
85 Core
87 - After a public outcry, assignment to __debug__ is no longer illegal;
88   instead, a warning is issued.  It will become illegal in 2.2.
90 - Fixed a core dump with "%#x" % 0, and changed the semantics so that
91   "%#x" now always prepends "0x", even if the value is zero.
93 - Fixed some nits in the bytecode compiler.
95 - Fixed core dumps when calling certain kinds of non-functions.
97 - Fixed various core dumps caused by reference count bugs.
99 Build and Ports
101 - Use INSTALL_SCRIPT to install script files.
103 - New port: SCO Unixware 7, by Billy G. Allie.
105 - Updated RISCOS port.
107 - Updated BeOS port and notes.
109 - Various other porting problems resolved.
111 Library
113 - The TERMIOS and SOCKET modules are now truly obsolete and
114   unnecessary.  Their symbols are incorporated in the termios and
115   socket modules.
117 - Fixed some 64-bit bugs in pickle, cPickle, and struct, and added
118   better tests for pickling.
120 - threading: make Condition.wait() robust against KeyboardInterrupt.
122 - zipfile: add support to zipfile to support opening an archive
123   represented by an open file rather than a file name.  Fix bug where
124   the archive was not properly closed.  Fixed a bug in this bugfix
125   where flush() was called for a read-only file.
127 - imputil: added an uninstall() method to the ImportManager.
129 - Canvas: fixed bugs in lower() and tkraise() methods.
131 - SocketServer: API change (added overridable close_request() method)
132   so that the TCP server can explicitly close the request.
134 - pstats: Eric Raymond added a simple interactive statistics browser,
135   invoked when the module is run as a script.
137 - locale: fixed a problem in format().
139 - webbrowser: made it work when the BROWSER environment variable has a
140   value like "/usr/bin/netscape".  Made it auto-detect Konqueror for
141   KDE 2.  Fixed some other nits.
143 - unittest: changes to allow using a different exception than
144   AssertionError, and added a few more function aliases.  Some other
145   small changes.
147 - urllib, urllib2: fixed redirect problems and a coupleof other nits.
149 - asynchat: fixed a critical bug in asynchat that slipped through the
150   2.1b2 release.  Fixed another rare bug.
152 - Fix some unqualified except: clauses (always a bad code example).
156 - pyexpat: new API get_version_string().
158 - Fixed some minidom bugs.
160 Extensions
162 - Fixed a core dump in _weakref.  Removed the weakref.mapping()
163   function (it adds nothing to the API).
165 - Rationalized the use of header files in the readline module, to make
166   it compile (albeit with some warnings) with the very recent readline
167   4.2, without breaking for earlier versions.
169 - Hopefully fixed a buffering problem in linuxaudiodev.
171 - Attempted a fix to make the OpenSSL support in the socket module
172   work again with pre-0.9.5 versions of OpenSSL.
174 Tests
176 - Added a test case for asynchat and asyncore.
178 - Removed coupling between tests where one test failing could break
179   another.
181 Tools
183 - Ping added an interactive help browser to pydoc, fixed some nits
184   in the rest of the pydoc code, and added some features to his
185   inspect module.
187 - An updated python-mode.el version 4.1 which integrates Ken
188   Manheimer's pdbtrack.el.  This makes debugging Python code via pdb
189   much nicer in XEmacs and Emacs.  When stepping through your program
190   with pdb, in either the shell window or the *Python* window, the
191   source file and line will be tracked by an arrow.  Very cool!
193 - IDLE: syntax warnings in interactive mode are changed into errors.
195 - Some improvements to Tools/webchecker (ignore some more URL types,
196   follow some more links). 
198 - Brought the Tools/compiler package up to date.
201 What's New in Python 2.1 beta 2?
202 ================================
204 (Unlisted are many fixed bugs, more documentation, etc.)
206 Core language, builtins, and interpreter
208 - The nested scopes work (enabled by "from __future__ import
209   nested_scopes") is completed; in particular, the future now extends
210   into code executed through exec, eval() and execfile(), and into the
211   interactive interpreter.
213 - When calling a base class method (e.g. BaseClass.__init__(self)),
214   this is now allowed even if self is not strictly spoken a class
215   instance (e.g. when using metaclasses or the Don Beaudry hook).
217 - Slice objects are now comparable but not hashable; this prevents
218   dict[:] from being accepted but meaningless.
220 - Complex division is now calculated using less braindead algorithms.
221   This doesn't change semantics except it's more likely to give useful
222   results in extreme cases.  Complex repr() now uses full precision
223   like float repr().
225 - sgmllib.py now calls handle_decl() for simple <!...> declarations.
227 - It is illegal to assign to the name __debug__, which is set when the
228   interpreter starts.  It is effectively a compile-time constant.
230 - A warning will be issued if a global statement for a variable
231   follows a use or assignment of that variable.
233 Standard library
235 - unittest.py, a unit testing framework by Steve Purcell (PyUNIT,
236   inspired by JUnit), is now part of the standard library.  You now
237   have a choice of two testing frameworks: unittest requires you to
238   write testcases as separate code, doctest gathers them from
239   docstrings.  Both approaches have their advantages and
240   disadvantages.
242 - A new module Tix was added, which wraps the Tix extension library
243   for Tk.  With that module, it is not necessary to statically link
244   Tix with _tkinter, since Tix will be loaded with Tcl's "package
245   require" command.  See Demo/tix/.
247 - tzparse.py is now obsolete.
249 - In gzip.py, the seek() and tell() methods are removed -- they were
250   non-functional anyway, and it's better if callers can test for their
251   existence with hasattr().
253 Python/C API
255 - PyDict_Next(): it is now safe to call PyDict_SetItem() with a key
256   that's already in the dictionary during a PyDict_Next() iteration.
257   This used to fail occasionally when a dictionary resize operation
258   could be triggered that would rehash all the keys.  All other
259   modifications to the dictionary are still off-limits during a
260   PyDict_Next() iteration!
262 - New extended APIs related to passing compiler variables around.
264 - New abstract APIs PyObject_IsInstance(), PyObject_IsSubclass()
265   implement isinstance() and issubclass().
267 - Py_BuildValue() now has a "D" conversion to create a Python complex
268   number from a Py_complex C value.
270 - Extensions types which support weak references must now set the
271   field allocated for the weak reference machinery to NULL themselves;
272   this is done to avoid the cost of checking each object for having a
273   weakly referencable type in PyObject_INIT(), since most types are
274   not weakly referencable.
276 - PyFrame_FastToLocals() and PyFrame_LocalsToFast() copy bindings for
277   free variables and cell variables to and from the frame's f_locals.
279 - Variants of several functions defined in pythonrun.h have been added
280   to support the nested_scopes future statement.  The variants all end
281   in Flags and take an extra argument, a PyCompilerFlags *; examples:
282   PyRun_AnyFileExFlags(), PyRun_InteractiveLoopFlags().  These
283   variants may be removed in Python 2.2, when nested scopes are
284   mandatory. 
286 Distutils
288 - the sdist command now writes a PKG-INFO file, as described in PEP 241,
289   into the release tree.
291 - several enhancements to the bdist_wininst command from Thomas Heller 
292   (an uninstaller, more customization of the installer's display)
294 - from Jack Jansen: added Mac-specific code to generate a dialog for
295   users to specify the command-line (because providing a command-line with
296   MacPython is awkward).  Jack also made various fixes for the Mac 
297   and the Metrowerks compiler.
298   
299 - added 'platforms' and 'keywords' to the set of metadata that can be 
300   specified for a distribution.  
302 - applied patches from Jason Tishler to make the compiler class work with
303   Cygwin.
306 What's New in Python 2.1 beta 1?
307 ================================
309 Core language, builtins, and interpreter
311 - Following an outcry from the community about the amount of code
312   broken by the nested scopes feature introduced in 2.1a2, we decided
313   to make this feature optional, and to wait until Python 2.2 (or at
314   least 6 months) to make it standard.  The option can be enabled on a
315   per-module basis by adding "from __future__ import nested_scopes" at
316   the beginning of a module (before any other statements, but after
317   comments and an optional docstring).  See PEP 236 (Back to the
318   __future__) for a description of the __future__ statement.  PEP 227
319   (Statically Nested Scopes) has been updated to reflect this change,
320   and to clarify the semantics in a number of endcases.
322 - The nested scopes code, when enabled, has been hardened, and most
323   bugs and memory leaks in it have been fixed.
325 - Compile-time warnings are now generated for a number of conditions
326   that will break or change in meaning when nested scopes are enabled:
328   - Using "from...import *" or "exec" without in-clause in a function
329     scope that also defines a lambda or nested function with one or
330     more free (non-local) variables.  The presence of the import* or
331     bare exec makes it impossible for the compiler to determine the
332     exact set of local variables in the outer scope, which makes it
333     impossible to determine the bindings for free variables in the
334     inner scope.  To avoid the warning about import *, change it into
335     an import of explicitly name object, or move the import* statement
336     to the global scope; to avoid the warning about bare exec, use
337     exec...in... (a good idea anyway -- there's a possibility that
338     bare exec will be deprecated in the future).
340   - Use of a global variable in a nested scope with the same name as a
341     local variable in a surrounding scope.  This will change in
342     meaning with nested scopes: the name in the inner scope will
343     reference the variable in the outer scope rather than the global
344     of the same name.  To avoid the warning, either rename the outer
345     variable, or use a global statement in the inner function.
347 - An optional object allocator has been included.  This allocator is
348   optimized for Python objects and should be faster and use less memory
349   than the standard system allocator.  It is not enabled by default
350   because of possible thread safety problems.  The allocator is only
351   protected by the Python interpreter lock and it is possible that some
352   extension modules require a thread safe allocator.  The object
353   allocator can be enabled by providing the "--with-pymalloc" option to
354   configure.
356 Standard library
358 - pyexpat now detects the expat version if expat.h defines it. A
359   number of additional handlers are provided, which are only available
360   since expat 1.95. In addition, the methods SetParamEntityParsing and
361   GetInputContext of Parser objects are available with 1.95.x
362   only. Parser objects now provide the ordered_attributes and
363   specified_attributes attributes. A new module expat.model was added,
364   which offers a number of additional constants if 1.95.x is used.
366 - xml.dom offers the new functions registerDOMImplementation and
367   getDOMImplementation.
369 - xml.dom.minidom offers a toprettyxml method. A number of DOM
370   conformance issues have been resolved. In particular, Element now
371   has an hasAttributes method, and the handling of namespaces was
372   improved.
374 - Ka-Ping Yee contributed two new modules: inspect.py, a module for
375   getting information about live Python code, and pydoc.py, a module
376   for interactively converting docstrings to HTML or text.
377   Tools/scripts/pydoc, which is now automatically installed into
378   <prefix>/bin, uses pydoc.py to display documentation; try running
379   "pydoc -h" for instructions.  "pydoc -g" pops up a small GUI that
380   lets you browse the module docstrings using a web browser.
382 - New library module difflib.py, primarily packaging the SequenceMatcher
383   class at the heart of the popular ndiff.py file-comparison tool.
385 - doctest.py (a framework for verifying Python code examples in docstrings)
386   is now part of the std library.
388 Windows changes
390 - A new entry in the Start menu, "Module Docs", runs "pydoc -g" -- a
391   small GUI that lets you browse the module docstrings using your
392   default web browser.
394 - Import is now case-sensitive.  PEP 235 (Import on Case-Insensitive
395   Platforms) is implemented.  See
397       http://python.sourceforge.net/peps/pep-0235.html
399   for full details, especially the "Current Lower-Left Semantics" section.
400   The new Windows import rules are simpler than before:
402   A. If the PYTHONCASEOK environment variable exists, same as
403      before:  silently accept the first case-insensitive match of any
404      kind; raise ImportError if none found.
406   B. Else search sys.path for the first case-sensitive match; raise
407      ImportError if none found.
409   The same rules have been implented on other platforms with case-
410   insensitive but case-preserving filesystems too (including Cygwin, and
411   several flavors of Macintosh operating systems).
413 - winsound module:  Under Win9x, winsound.Beep() now attempts to simulate
414   what it's supposed to do (and does do under NT and 2000) via direct
415   port manipulation.  It's unknown whether this will work on all systems,
416   but it does work on my Win98SE systems now and was known to be useless on
417   all Win9x systems before.
419 - Build:  Subproject _test (effectively) renamed to _testcapi.
421 New platforms
423 - 2.1 should compile and run out of the box under MacOS X, even using HFS+.
424   Thanks to Steven Majewski!
426 - 2.1 should compile and run out of the box on Cygwin.  Thanks to Jason
427   Tishler!
429 - 2.1 contains new files and patches for RISCOS, thanks to Dietmar
430   Schwertberger!  See RISCOS/README for more information -- it seems
431   that because of the bizarre filename conventions on RISCOS, no port
432   to that platform is easy.  Note that the new variable os.endsep is
433   silently supported in order to make life easier on this platform,
434   but we don't advertise it because it's not worth for most folks to
435   care about RISCOS portability.
438 What's New in Python 2.1 alpha 2?
439 =================================
441 Core language, builtins, and interpreter
443 - Scopes nest.  If a name is used in a function or class, but is not
444   local, the definition in the nearest enclosing function scope will
445   be used.  One consequence of this change is that lambda statements
446   could reference variables in the namespaces where the lambda is
447   defined.  In some unusual cases, this change will break code.
449   In all previous version of Python, names were resolved in exactly
450   three namespaces -- the local namespace, the global namespace, and
451   the builtin namespace.  According to this old definition, if a
452   function A is defined within a function B, the names bound in B are
453   not visible in A.  The new rules make names bound in B visible in A,
454   unless A contains a name binding that hides the binding in B.
456   Section 4.1 of the reference manual describes the new scoping rules
457   in detail.  The test script in Lib/test/test_scope.py demonstrates
458   some of the effects of the change.
460   The new rules will cause existing code to break if it defines nested
461   functions where an outer function has local variables with the same
462   name as globals or builtins used by the inner function.  Example:
464     def munge(str):
465         def helper(x):
466             return str(x)
467         if type(str) != type(''):
468             str = helper(str)
469         return str.strip()
471   Under the old rules, the name str in helper() is bound to the
472   builtin function str().  Under the new rules, it will be bound to
473   the argument named str and an error will occur when helper() is
474   called.
476 - The compiler will report a SyntaxError if "from ... import *" occurs
477   in a function or class scope.  The language reference has documented
478   that this case is illegal, but the compiler never checked for it.
479   The recent introduction of nested scope makes the meaning of this
480   form of name binding ambiguous.  In a future release, the compiler
481   may allow this form when there is no possibility of ambiguity.
483 - repr(string) is easier to read, now using hex escapes instead of octal,
484   and using \t, \n and \r instead of \011, \012 and \015 (respectively):
486   >>> "\texample \r\n" + chr(0) + chr(255)
487   '\texample \r\n\x00\xff'         # in 2.1
488   '\011example \015\012\000\377'   # in 2.0
490 - Functions are now compared and hashed by identity, not by value, since
491   the func_code attribute is writable.
493 - Weak references (PEP 205) have been added.  This involves a few
494   changes in the core, an extension module (_weakref), and a Python
495   module (weakref).  The weakref module is the public interface.  It
496   includes support for "explicit" weak references, proxy objects, and
497   mappings with weakly held values.
499 - A 'continue' statement can now appear in a try block within the body
500   of a loop.  It is still not possible to use continue in a finally
501   clause.
503 Standard library
505 - mailbox.py now has a new class, PortableUnixMailbox which is
506   identical to UnixMailbox but uses a more portable scheme for
507   determining From_ separators.  Also, the constructors for all the
508   classes in this module have a new optional `factory' argument, which
509   is a callable used when new message classes must be instantiated by
510   the next() method.
512 - random.py is now self-contained, and offers all the functionality of
513   the now-deprecated whrandom.py.  See the docs for details.  random.py
514   also supports new functions getstate() and setstate(), for saving
515   and restoring the internal state of the generator; and jumpahead(n),
516   for quickly forcing the internal state to be the same as if n calls to
517   random() had been made.  The latter is particularly useful for multi-
518   threaded programs, creating one instance of the random.Random() class for
519   each thread, then using .jumpahead() to force each instance to use a
520   non-overlapping segment of the full period.
522 - random.py's seed() function is new.  For bit-for-bit compatibility with
523   prior releases, use the whseed function instead.  The new seed function
524   addresses two problems:  (1) The old function couldn't produce more than
525   about 2**24 distinct internal states; the new one about 2**45 (the best
526   that can be done in the Wichmann-Hill generator).  (2) The old function
527   sometimes produced identical internal states when passed distinct
528   integers, and there was no simple way to predict when that would happen;
529   the new one guarantees to produce distinct internal states for all
530   arguments in [0, 27814431486576L).
532 - The socket module now supports raw packets on Linux.  The socket
533   family is AF_PACKET.
535 - test_capi.py is a start at running tests of the Python C API.  The tests
536   are implemented by the new Modules/_testmodule.c.
538 - A new extension module, _symtable, provides provisional access to the
539   internal symbol table used by the Python compiler.  A higher-level
540   interface will be added on top of _symtable in a future release.
542 - Removed the obsolete soundex module.
544 - xml.dom.minidom now uses the standard DOM exceptions. Node supports
545   the isSameNode method; NamedNodeMap the get method.
547 - xml.sax.expatreader supports the lexical handler property; it
548   generates comment, startCDATA, and endCDATA events.
550 Windows changes
552 - Build procedure:  the zlib project is built in a different way that
553   ensures the zlib header files used can no longer get out of synch with
554   the zlib binary used.  See PCbuild\readme.txt for details.  Your old
555   zlib-related directories can be deleted; you'll need to download fresh
556   source for zlib and unpack it into a new directory.
558 - Build:  New subproject _test for the benefit of test_capi.py (see above).
560 - Build:  New subproject _symtable, for new DLL _symtable.pyd (a nascent
561   interface to some Python compiler internals).
563 - Build:  Subproject ucnhash is gone, since the code was folded into the
564   unicodedata subproject.
566 What's New in Python 2.1 alpha 1?
567 =================================
569 Core language, builtins, and interpreter
571 - There is a new Unicode companion to the PyObject_Str() API
572   called PyObject_Unicode(). It behaves in the same way as the
573   former, but assures that the returned value is an Unicode object
574   (applying the usual coercion if necessary).
576 - The comparison operators support "rich comparison overloading" (PEP
577   207).  C extension types can provide a rich comparison function in
578   the new tp_richcompare slot in the type object.  The cmp() function
579   and the C function PyObject_Compare() first try the new rich
580   comparison operators before trying the old 3-way comparison.  There
581   is also a new C API PyObject_RichCompare() (which also falls back on
582   the old 3-way comparison, but does not constrain the outcome of the
583   rich comparison to a Boolean result).
585   The rich comparison function takes two objects (at least one of
586   which is guaranteed to have the type that provided the function) and
587   an integer indicating the opcode, which can be Py_LT, Py_LE, Py_EQ,
588   Py_NE, Py_GT, Py_GE (for <, <=, ==, !=, >, >=), and returns a Python
589   object, which may be NotImplemented (in which case the tp_compare
590   slot function is used as a fallback, if defined).
592   Classes can overload individual comparison operators by defining one
593   or more of the methods__lt__, __le__, __eq__, __ne__, __gt__,
594   __ge__.  There are no explicit "reflected argument" versions of
595   these; instead, __lt__ and __gt__ are each other's reflection,
596   likewise for__le__ and __ge__; __eq__ and __ne__ are their own
597   reflection (similar at the C level).  No other implications are
598   made; in particular, Python does not assume that == is the Boolean
599   inverse of !=, or that < is the Boolean inverse of >=.  This makes
600   it possible to define types with partial orderings.
602   Classes or types that want to implement (in)equality tests but not
603   the ordering operators (i.e. unordered types) should implement ==
604   and !=, and raise an error for the ordering operators.
606   It is possible to define types whose rich comparison results are not
607   Boolean; e.g. a matrix type might want to return a matrix of bits
608   for A < B, giving elementwise comparisons.  Such types should ensure
609   that any interpretation of their value in a Boolean context raises
610   an exception, e.g. by defining __nonzero__ (or the tp_nonzero slot
611   at the C level) to always raise an exception.
613 - Complex numbers use rich comparisons to define == and != but raise
614   an exception for <, <=, > and >=.  Unfortunately, this also means
615   that cmp() of two complex numbers raises an exception when the two
616   numbers differ.  Since it is not mathematically meaningful to compare
617   complex numbers except for equality, I hope that this doesn't break
618   too much code.
620 - The outcome of comparing non-numeric objects of different types is
621   not defined by the language, other than that it's arbitrary but
622   consistent (see the Reference Manual).  An implementation detail changed
623   in 2.1a1 such that None now compares less than any other object.  Code
624   relying on this new behavior (like code that relied on the previous
625   behavior) does so at its own risk.
627 - Functions and methods now support getting and setting arbitrarily
628   named attributes (PEP 232).  Functions have a new __dict__
629   (a.k.a. func_dict) which hold the function attributes.  Methods get
630   and set attributes on their underlying im_func.  It is a TypeError
631   to set an attribute on a bound method.
633 - The xrange() object implementation has been improved so that
634   xrange(sys.maxint) can be used on 64-bit platforms.  There's still a
635   limitation that in this case len(xrange(sys.maxint)) can't be
636   calculated, but the common idiom "for i in xrange(sys.maxint)" will
637   work fine as long as the index i doesn't actually reach 2**31.
638   (Python uses regular ints for sequence and string indices; fixing
639   that is much more work.)
641 - Two changes to from...import:
643   1) "from M import X" now works even if (after loading module M)
644      sys.modules['M'] is not a real module; it's basically a getattr()
645      operation with AttributeError exceptions changed into ImportError.
647   2) "from M import *" now looks for M.__all__ to decide which names to
648      import; if M.__all__ doesn't exist, it uses M.__dict__.keys() but
649      filters out names starting with '_' as before.  Whether or not
650      __all__ exists, there's no restriction on the type of M.
652 - File objects have a new method, xreadlines().  This is the fastest
653   way to iterate over all lines in a file:
655   for line in file.xreadlines():
656       ...do something to line...
658   See the xreadlines module (mentioned below) for how to do this for
659   other file-like objects.
661 - Even if you don't use file.xreadlines(), you may expect a speedup on
662   line-by-line input.  The file.readline() method has been optimized
663   quite a bit in platform-specific ways:  on systems (like Linux) that
664   support flockfile(), getc_unlocked(), and funlockfile(), those are
665   used by default.  On systems (like Windows) without getc_unlocked(),
666   a complicated (but still thread-safe) method using fgets() is used by
667   default.
669   You can force use of the fgets() method by #define'ing
670   USE_FGETS_IN_GETLINE at build time (it may be faster than
671   getc_unlocked()).
673   You can force fgets() not to be used by #define'ing
674   DONT_USE_FGETS_IN_GETLINE (this is the first thing to try if std test
675   test_bufio.py fails -- and let us know if it does!).
677 - In addition, the fileinput module, while still slower than the other
678   methods on most platforms, has been sped up too, by using
679   file.readlines(sizehint).
681 - Support for run-time warnings has been added, including a new
682   command line option (-W) to specify the disposition of warnings.
683   See the description of the warnings module below.
685 - Extensive changes have been made to the coercion code.  This mostly
686   affects extension modules (which can now implement mixed-type
687   numerical operators without having to use coercion), but
688   occasionally, in boundary cases the coercion semantics have changed
689   subtly.  Since this was a terrible gray area of the language, this
690   is considered an improvement.  Also note that __rcmp__ is no longer
691   supported -- instead of calling __rcmp__, __cmp__ is called with
692   reflected arguments.
694 - In connection with the coercion changes, a new built-in singleton
695   object, NotImplemented is defined.  This can be returned for
696   operations that wish to indicate they are not implemented for a
697   particular combination of arguments.  From C, this is
698   Py_NotImplemented.
700 - The interpreter accepts now bytecode files on the command line even
701   if they do not have a .pyc or .pyo extension. On Linux, after executing
703 import imp,sys,string
704 magic = string.join(["\\x%.2x" % ord(c) for c in imp.get_magic()],"")
705 reg = ':pyc:M::%s::%s:' % (magic, sys.executable)
706 open("/proc/sys/fs/binfmt_misc/register","wb").write(reg)
708   any byte code file can be used as an executable (i.e. as an argument
709   to execve(2)).
711 - %[xXo] formats of negative Python longs now produce a sign
712   character.  In 1.6 and earlier, they never produced a sign,
713   and raised an error if the value of the long was too large
714   to fit in a Python int.  In 2.0, they produced a sign if and
715   only if too large to fit in an int.  This was inconsistent
716   across platforms (because the size of an int varies across
717   platforms), and inconsistent with hex() and oct().  Example:
719   >>> "%x" % -0x42L
720   '-42'      # in 2.1
721   'ffffffbe' # in 2.0 and before, on 32-bit machines
722   >>> hex(-0x42L)
723   '-0x42L'   # in all versions of Python
725   The behavior of %d formats for negative Python longs remains
726   the same as in 2.0 (although in 1.6 and before, they raised
727   an error if the long didn't fit in a Python int).
729   %u formats don't make sense for Python longs, but are allowed
730   and treated the same as %d in 2.1.  In 2.0, a negative long
731   formatted via %u produced a sign if and only if too large to
732   fit in an int.  In 1.6 and earlier, a negative long formatted
733   via %u raised an error if it was too big to fit in an int.
735 - Dictionary objects have an odd new method, popitem().  This removes
736   an arbitrary item from the dictionary and returns it (in the form of
737   a (key, value) pair).  This can be useful for algorithms that use a
738   dictionary as a bag of "to do" items and repeatedly need to pick one
739   item.  Such algorithms normally end up running in quadratic time;
740   using popitem() they can usually be made to run in linear time.
742 Standard library
744 - In the time module, the time argument to the functions strftime,
745   localtime, gmtime, asctime and ctime is now optional, defaulting to
746   the current time (in the local timezone).
748 - The ftplib module now defaults to passive mode, which is deemed a
749   more useful default given that clients are often inside firewalls
750   these days.  Note that this could break if ftplib is used to connect
751   to a *server* that is inside a firewall, from outside; this is
752   expected to be a very rare situation.  To fix that, you can call
753   ftp.set_pasv(0).
755 - The module site now treats .pth files not only for path configuration,
756   but also supports extensions to the initialization code: Lines starting
757   with import are executed.
759 - There's a new module, warnings, which implements a mechanism for
760   issuing and filtering warnings.  There are some new built-in
761   exceptions that serve as warning categories, and a new command line
762   option, -W, to control warnings (e.g. -Wi ignores all warnings, -We
763   turns warnings into errors).  warnings.warn(message[, category])
764   issues a warning message; this can also be called from C as
765   PyErr_Warn(category, message).
767 - A new module xreadlines was added.  This exports a single factory
768   function, xreadlines().  The intention is that this code is the
769   absolutely fastest way to iterate over all lines in an open
770   file(-like) object:
772   import xreadlines
773   for line in xreadlines.xreadlines(file):
774       ...do something to line...
776   This is equivalent to the previous the speed record holder using
777   file.readlines(sizehint).  Note that if file is a real file object
778   (as opposed to a file-like object), this is equivalent:
780   for line in file.xreadlines():
781       ...do something to line...
783 - The bisect module has new functions bisect_left, insort_left,
784   bisect_right and insort_right.  The old names bisect and insort
785   are now aliases for bisect_right and insort_right.  XXX_right
786   and XXX_left methods differ in what happens when the new element
787   compares equal to one or more elements already in the list:  the
788   XXX_left methods insert to the left, the XXX_right methods to the
789   right.  Code that doesn't care where equal elements end up should
790   continue to use the old, short names ("bisect" and "insort").
792 - The new curses.panel module wraps the panel library that forms part
793   of SYSV curses and ncurses.  Contributed by Thomas Gellekum.
795 - The SocketServer module now sets the allow_reuse_address flag by
796   default in the TCPServer class.
798 - A new function, sys._getframe(), returns the stack frame pointer of
799   the caller.  This is intended only as a building block for
800   higher-level mechanisms such as string interpolation.
802 - The pyexpat module supports a number of new handlers, which are
803   available only in expat 1.2. If invocation of a callback fails, it
804   will report an additional frame in the traceback. Parser objects
805   participate now in garbage collection. If expat reports an unknown
806   encoding, pyexpat will try to use a Python codec; that works only
807   for single-byte charsets. The parser type objects is exposed as
808   XMLParserObject.
810 - xml.dom now offers standard definitions for symbolic node type and
811   exception code constants, and a hierarchy of DOM exceptions. minidom
812   was adjusted to use them.
814 - The conformance of xml.dom.minidom to the DOM specification was
815   improved. It detects a number of additional error cases; the
816   previous/next relationship works even when the tree is modified;
817   Node supports the normalize() method; NamedNodeMap, DocumentType and
818   DOMImplementation classes were added; Element supports the
819   hasAttribute and hasAttributeNS methods; and Text supports the splitText
820   method.
822 Build issues
824 - For Unix (and Unix-compatible) builds, configuration and building of
825   extension modules is now greatly automated.  Rather than having to
826   edit the Modules/Setup file to indicate which modules should be
827   built and where their include files and libraries are, a
828   distutils-based setup.py script now takes care of building most
829   extension modules.  All extension modules built this way are built
830   as shared libraries.  Only a few modules that must be linked
831   statically are still listed in the Setup file; you won't need to
832   edit their configuration.
834 - Python should now build out of the box on Cygwin.  If it doesn't,
835   mail to Jason Tishler (jlt63 at users.sourceforge.net).
837 - Python now always uses its own (renamed) implementation of getopt()
838   -- there's too much variation among C library getopt()
839   implementations.
841 - C++ compilers are better supported; the CXX macro is always set to a
842   C++ compiler if one is found.
844 Windows changes
846 - select module:  By default under Windows, a select() call
847   can specify no more than 64 sockets.  Python now boosts
848   this Microsoft default to 512.  If you need even more than
849   that, see the MS docs (you'll need to #define FD_SETSIZE
850   and recompile Python from source).
852 - Support for Windows 3.1, DOS and OS/2 is gone.  The Lib/dos-8x3
853   subdirectory is no more!
856 What's New in Python 2.0?
857 =========================
859 Below is a list of all relevant changes since release 1.6.  Older
860 changes are in the file HISTORY.  If you are making the jump directly
861 from Python 1.5.2 to 2.0, make sure to read the section for 1.6 in the
862 HISTORY file!  Many important changes listed there.
864 Alternatively, a good overview of the changes between 1.5.2 and 2.0 is
865 the document "What's New in Python 2.0" by Kuchling and Moshe Zadka:
866 http://starship.python.net/crew/amk/python/writing/new-python/.
868 --Guido van Rossum (home page: http://www.pythonlabs.com/~guido/)
870 ======================================================================
872 What's new in 2.0 (since release candidate 1)?
873 ==============================================
875 Standard library
877 - The copy_reg module was modified to clarify its intended use: to
878   register pickle support for extension types, not for classes.
879   pickle() will raise a TypeError if it is passed a class.
881 - Fixed a bug in gettext's "normalize and expand" code that prevented
882   it from finding an existing .mo file.
884 - Restored support for HTTP/0.9 servers in httplib.
886 - The math module was changed to stop raising OverflowError in case of
887   underflow, and return 0 instead in underflow cases.  Whether Python
888   used to raise OverflowError in case of underflow was platform-
889   dependent (it did when the platform math library set errno to ERANGE
890   on underflow).
892 - Fixed a bug in StringIO that occurred when the file position was not
893   at the end of the file and write() was called with enough data to
894   extend past the end of the file.
896 - Fixed a bug that caused Tkinter error messages to get lost on
897   Windows.  The bug was fixed by replacing direct use of
898   interp->result with Tcl_GetStringResult(interp).
900 - Fixed bug in urllib2 that caused it to fail when it received an HTTP
901   redirect response.
903 - Several changes were made to distutils: Some debugging code was
904   removed from util.  Fixed the installer used when an external zip
905   program (like WinZip) is not found; the source code for this
906   installer is in Misc/distutils.  check_lib() was modified to behave
907   more like AC_CHECK_LIB by add other_libraries() as a parameter.  The
908   test for whether installed modules are on sys.path was changed to
909   use both normcase() and normpath().
911 - Several minor bugs were fixed in the xml package (the minidom,
912   pulldom, expatreader, and saxutils modules).
914 - The regression test driver (regrtest.py) behavior when invoked with
915   -l changed: It now reports a count of objects that are recognized as
916   garbage but not freed by the garbage collector.
918 - The regression test for the math module was changed to test
919   exceptional behavior when the test is run in verbose mode.  Python
920   cannot yet guarantee consistent exception behavior across platforms,
921   so the exception part of test_math is run only in verbose mode, and
922   may fail on your platform.
924 Internals
926 - PyOS_CheckStack() has been disabled on Win64, where it caused
927   test_sre to fail.
929 Build issues
931 - Changed compiler flags, so that gcc is always invoked with -Wall and
932   -Wstrict-prototypes.  Users compiling Python with GCC should see
933   exactly one warning, except if they have passed configure the
934   --with-pydebug flag.  The expected warning is for getopt() in
935   Modules/main.c.  This warning will be fixed for Python 2.1.
937 - Fixed configure to add -threads argument during linking on OSF1.
939 Tools and other miscellany
941 - The compiler in Tools/compiler was updated to support the new
942   language features introduced in 2.0: extended print statement, list
943   comprehensions, and augmented assignments.  The new compiler should
944   also be backwards compatible with Python 1.5.2; the compiler will
945   always generate code for the version of the interpreter it runs
946   under.
948 What's new in 2.0 release candidate 1 (since beta 2)?
949 =====================================================
951 What is release candidate 1?
953 We believe that release candidate 1 will fix all known bugs that we
954 intend to fix for the 2.0 final release.  This release should be a bit
955 more stable than the previous betas.  We would like to see even more
956 widespread testing before the final release, so we are producing this
957 release candidate.  The final release will be exactly the same unless
958 any show-stopping (or brown bag) bugs are found by testers of the
959 release candidate.
961 All the changes since the last beta release are bug fixes or changes
962 to support building Python for specific platforms.
964 Core language, builtins, and interpreter
966 - A bug that caused crashes when __coerce__ was used with augmented
967   assignment, e.g. +=, was fixed.
969 - Raise ZeroDivisionError when raising zero to a negative number,
970   e.g. 0.0 ** -2.0.  Note that math.pow is unrelated to the builtin
971   power operator and the result of math.pow(0.0, -2.0) will vary by
972   platform.  On Linux, it raises a ValueError.
974 - A bug in Unicode string interpolation was fixed that occasionally
975   caused errors with formats including "%%".  For example, the
976   following expression "%% %s" % u"abc" no longer raises a TypeError.
978 - Compilation of deeply nested expressions raises MemoryError instead
979   of SyntaxError, e.g. eval("[" * 50 + "]" * 50).
981 - In 2.0b2 on Windows, the interpreter wrote .pyc files in text mode,
982   rendering them useless.  They are now written in binary mode again.
984 Standard library
986 - Keyword arguments are now accepted for most pattern and match object
987   methods in SRE, the standard regular expression engine.
989 - In SRE, fixed error with negative lookahead and lookbehind that
990   manifested itself as a runtime error in patterns like "(?<!abc)(def)".
992 - Several bugs in the Unicode handling and error handling in _tkinter
993   were fixed.
995 - Fix memory management errors in Merge() and Tkapp_Call() routines.
997 - Several changes were made to cStringIO to make it compatible with
998   the file-like object interface and with StringIO.  If operations are
999   performed on a closed object, an exception is raised.  The truncate
1000   method now accepts a position argument and readline accepts a size
1001   argument.
1003 - There were many changes made to the linuxaudiodev module and its
1004   test suite; as a result, a short, unexpected audio sample should now
1005   play when the regression test is run.
1007   Note that this module is named poorly, because it should work
1008   correctly on any platform that supports the Open Sound System
1009   (OSS).
1011   The module now raises exceptions when errors occur instead of
1012   crashing.  It also defines the AFMT_A_LAW format (logarithmic A-law
1013   audio) and defines a getptr() method that calls the
1014   SNDCTL_DSP_GETxPTR ioctl defined in the OSS Programmer's Guide.
1016 - The library_version attribute, introduced in an earlier beta, was
1017   removed because it can not be supported with early versions of the C
1018   readline library, which provides no way to determine the version at
1019   compile-time.
1021 - The binascii module is now enabled on Win64.
1023 - tokenize.py no longer suffers "recursion depth" errors when parsing
1024   programs with very long string literals.
1026 Internals
1028 - Fixed several buffer overflow vulnerabilities in calculate_path(),
1029   which is called when the interpreter starts up to determine where
1030   the standard library is installed.  These vulnerabilities affect all
1031   previous versions of Python and can be exploited by setting very
1032   long values for PYTHONHOME or argv[0].  The risk is greatest for a
1033   setuid Python script, although use of the wrapper in
1034   Misc/setuid-prog.c will eliminate the vulnerability.
1036 - Fixed garbage collection bugs in instance creation that were
1037   triggered when errors occurred during initialization.  The solution,
1038   applied in cPickle and in PyInstance_New(), is to call
1039   PyObject_GC_Init() after the initialization of the object's
1040   container attributes is complete.
1042 - pyexpat adds definitions of PyModule_AddStringConstant and
1043   PyModule_AddObject if the Python version is less than 2.0, which
1044   provides compatibility with PyXML on Python 1.5.2.
1046 - If the platform has a bogus definition for LONG_BIT (the number of
1047   bits in a long), an error will be reported at compile time.
1049 - Fix bugs in _PyTuple_Resize() which caused hard-to-interpret garbage
1050   collection crashes and possibly other, unreported crashes.
1052 - Fixed a memory leak in _PyUnicode_Fini().
1054 Build issues
1056 - configure now accepts a --with-suffix option that specifies the
1057   executable suffix.  This is useful for builds on Cygwin and Mac OS
1058   X, for example.
1060 - The mmap.PAGESIZE constant is now initialized using sysconf when
1061   possible, which eliminates a dependency on -lucb for Reliant UNIX.
1063 - The md5 file should now compile on all platforms.
1065 - The select module now compiles on platforms that do not define
1066   POLLRDNORM and related constants.
1068 - Darwin (Mac OS X):  Initial support for static builds on this
1069   platform.
1071 - BeOS: A number of changes were made to the build and installation
1072   process.  ar-fake now operates on a directory of object files.
1073   dl_export.h is gone, and its macros now appear on the mwcc command
1074   line during build on PPC BeOS.
1076 - Platform directory in lib/python2.0 is "plat-beos5" (or
1077   "plat-beos4", if building on BeOS 4.5), rather than "plat-beos".
1079 - Cygwin: Support for shared libraries, Tkinter, and sockets.
1081 - SunOS 4.1.4_JL: Fix test for directory existence in configure.
1083 Tools and other miscellany
1085 - Removed debugging prints from main used with freeze.
1087 - IDLE auto-indent no longer crashes when it encounters Unicode
1088   characters.
1090 What's new in 2.0 beta 2 (since beta 1)?
1091 ========================================
1093 Core language, builtins, and interpreter
1095 - Add support for unbounded ints in %d,i,u,x,X,o formats; for example
1096   "%d" % 2L**64 == "18446744073709551616".
1098 - Add -h and -V command line options to print the usage message and
1099   Python version number and exit immediately.
1101 - eval() and exec accept Unicode objects as code parameters.
1103 - getattr() and setattr() now also accept Unicode objects for the
1104   attribute name, which are converted to strings using the default
1105   encoding before lookup.
1107 - Multiplication on string and Unicode now does proper bounds
1108   checking; e.g. 'a' * 65536 * 65536 will raise ValueError, "repeated
1109   string is too long."
1111 - Better error message when continue is found in try statement in a
1112   loop.
1115 Standard library and extensions
1117 - socket module: the OpenSSL code now adds support for RAND_status()
1118   and EGD (Entropy Gathering Device).
1120 - array: reverse() method of array now works.  buffer_info() now does
1121   argument checking; it still takes no arguments.
1123 - asyncore/asynchat: Included most recent version from Sam Rushing.
1125 - cgi: Accept '&' or ';' as separator characters when parsing form data.
1127 - CGIHTTPServer: Now works on Windows (and perhaps even Mac).
1129 - ConfigParser: When reading the file, options spelled in upper case
1130   letters are now correctly converted to lowercase.
1132 - copy: Copy Unicode objects atomically.
1134 - cPickle: Fail gracefully when copy_reg can't be imported.
1136 - cStringIO: Implemented readlines() method.
1138 - dbm: Add get() and setdefault() methods to dbm object.  Add constant
1139   `library' to module that names the library used.  Added doc strings
1140   and method names to error messages.  Uses configure to determine
1141   which ndbm.h file to include; Berkeley DB's nbdm and GDBM's ndbm is
1142   now available options.
1144 - distutils: Update to version 0.9.3.
1146 - dl: Add several dl.RTLD_ constants.
1148 - fpectl: Now supported on FreeBSD.
1150 - gc: Add DEBUG_SAVEALL option.  When enabled all garbage objects
1151   found by the collector will be saved in gc.garbage.  This is useful
1152   for debugging a program that creates reference cycles.
1154 - httplib: Three changes: Restore support for set_debuglevel feature
1155   of HTTP class.  Do not close socket on zero-length response.  Do not
1156   crash when server sends invalid content-length header.
1158 - mailbox: Mailbox class conforms better to qmail specifications.
1160 - marshal: When reading a short, sign-extend on platforms where shorts
1161   are bigger than 16 bits.  When reading a long, repair the unportable
1162   sign extension that was being done for 64-bit machines.  (It assumed
1163   that signed right shift sign-extends.)
1165 - operator: Add contains(), invert(), __invert__() as aliases for
1166   __contains__(), inv(), and __inv__() respectively.
1168 - os: Add support for popen2() and popen3() on all platforms where
1169   fork() exists.  (popen4() is still in the works.)
1171 - os: (Windows only:) Add startfile() function that acts like double-
1172   clicking on a file in Explorer (or passing the file name to the
1173   DOS "start" command).
1175 - os.path: (Windows, DOS:) Treat trailing colon correctly in
1176   os.path.join.  os.path.join("a:", "b") yields "a:b".
1178 - pickle: Now raises ValueError when an invalid pickle that contains
1179   a non-string repr where a string repr was expected.  This behavior
1180   matches cPickle.
1182 - posixfile: Remove broken __del__() method.
1184 - py_compile: support CR+LF line terminators in source file.
1186 - readline: Does not immediately exit when ^C is hit when readline and
1187   threads are configured.  Adds definition of rl_library_version.  (The
1188   latter addition requires GNU readline 2.2 or later.)
1190 - rfc822: Domain literals returned by AddrlistClass method
1191   getdomainliteral() are now properly wrapped in brackets.
1193 - site: sys.setdefaultencoding() should only be called in case the
1194   standard default encoding ("ascii") is changed. This saves quite a
1195   few cycles during startup since the first call to
1196   setdefaultencoding() will initialize the codec registry and the
1197   encodings package.
1199 - socket: Support for size hint in readlines() method of object returned
1200   by makefile().
1202 - sre: Added experimental expand() method to match objects.  Does not
1203   use buffer interface on Unicode strings.  Does not hang if group id
1204   is followed by whitespace.
1206 - StringIO: Size hint in readlines() is now supported as documented.
1208 - struct: Check ranges for bytes and shorts.
1210 - urllib: Improved handling of win32 proxy settings. Fixed quote and
1211   quote_plus functions so that the always encode a comma.
1213 - Tkinter: Image objects are now guaranteed to have unique ids.  Set
1214   event.delta to zero if Tk version doesn't support mousewheel.
1215   Removed some debugging prints.
1217 - UserList: now implements __contains__().
1219 - webbrowser: On Windows, use os.startfile() instead of os.popen(),
1220   which works around a bug in Norton AntiVirus 2000 that leads directly
1221   to a Blue Screen freeze.
1223 - xml: New version detection code allows PyXML to override standard
1224   XML package if PyXML version is greater than 0.6.1.
1226 - xml.dom: DOM level 1 support for basic XML.  Includes xml.dom.minidom
1227   (conventional DOM), and xml.dom.pulldom, which allows building the DOM
1228   tree only for nodes which are sufficiently interesting to a specific
1229   application.  Does not provide the HTML-specific extensions.  Still
1230   undocumented.
1232 - xml.sax: SAX 2 support for Python, including all the handler
1233   interfaces needed to process XML 1.0 compliant XML.  Some
1234   documentation is already available.
1236 - pyexpat: Renamed to xml.parsers.expat since this is part of the new,
1237   packagized XML support.
1240 C API
1242 - Add three new convenience functions for module initialization --
1243   PyModule_AddObject(), PyModule_AddIntConstant(), and
1244   PyModule_AddStringConstant().
1246 - Cleaned up definition of NULL in C source code; all definitions were
1247   removed and add #error to Python.h if NULL isn't defined after
1248   #include of stdio.h.
1250 - Py_PROTO() macros that were removed in 2.0b1 have been restored for
1251   backwards compatibility (at the source level) with old extensions.
1253 - A wrapper API was added for signal() and sigaction().  Instead of
1254   either function, always use PyOS_getsig() to get a signal handler
1255   and PyOS_setsig() to set one.  A new convenience typedef
1256   PyOS_sighandler_t is defined for the type of signal handlers.
1258 - Add PyString_AsStringAndSize() function that provides access to the
1259   internal data buffer and size of a string object -- or the default
1260   encoded version of a Unicode object.
1262 - PyString_Size() and PyString_AsString() accept Unicode objects.
1264 - The standard header <limits.h> is now included by Python.h (if it
1265   exists).  INT_MAX and LONG_MAX will always be defined, even if
1266   <limits.h> is not available.
1268 - PyFloat_FromString takes a second argument, pend, that was
1269   effectively useless.  It is now officially useless but preserved for
1270   backwards compatibility.  If the pend argument is not NULL, *pend is
1271   set to NULL.
1273 - PyObject_GetAttr() and PyObject_SetAttr() now accept Unicode objects
1274   for the attribute name.  See note on getattr() above.
1276 - A few bug fixes to argument processing for Unicode.
1277   PyArg_ParseTupleAndKeywords() now accepts "es#" and "es".
1278   PyArg_Parse() special cases "s#" for Unicode objects; it returns a
1279   pointer to the default encoded string data instead of to the raw
1280   UTF-16.
1282 - Py_BuildValue accepts B format (for bgen-generated code).
1285 Internals
1287 - On Unix, fix code for finding Python installation directory so that
1288   it works when argv[0] is a relative path.
1290 - Added a true unicode_internal_encode() function and fixed the
1291   unicode_internal_decode function() to support Unicode objects directly
1292   rather than by generating a copy of the object.
1294 - Several of the internal Unicode tables are much smaller now, and
1295   the source code should be much friendlier to weaker compilers.
1297 - In the garbage collector: Fixed bug in collection of tuples.  Fixed
1298   bug that caused some instances to be removed from the container set
1299   while they were still live.  Fixed parsing in gc.set_debug() for
1300   platforms where sizeof(long) > sizeof(int).
1302 - Fixed refcount problem in instance deallocation that only occurred
1303   when Py_REF_DEBUG was defined and Py_TRACE_REFS was not.
1305 - On Windows, getpythonregpath is now protected against null data in
1306   registry key.
1308 - On Unix, create .pyc/.pyo files with O_EXCL flag to avoid a race
1309   condition.
1312 Build and platform-specific issues
1314 - Better support of GNU Pth via --with-pth configure option.
1316 - Python/C API now properly exposed to dynamically-loaded extension
1317   modules on Reliant UNIX.
1319 - Changes for the benefit of SunOS 4.1.4 (really!).  mmapmodule.c:
1320   Don't define MS_SYNC to be zero when it is undefined.  Added missing
1321   prototypes in posixmodule.c.
1323 - Improved support for HP-UX build.  Threads should now be correctly
1324   configured (on HP-UX 10.20 and 11.00).
1326 - Fix largefile support on older NetBSD systems and OpenBSD by adding
1327   define for TELL64.
1330 Tools and other miscellany
1332 - ftpmirror: Call to main() is wrapped in if __name__ == "__main__".
1334 - freeze: The modulefinder now works with 2.0 opcodes.
1336 - IDLE:
1337   Move hackery of sys.argv until after the Tk instance has been
1338   created, which allows the application-specific Tkinter
1339   initialization to be executed if present; also pass an explicit
1340   className parameter to the Tk() constructor.
1343 What's new in 2.0 beta 1?
1344 =========================
1346 Source Incompatibilities
1347 ------------------------
1349 None.  Note that 1.6 introduced several incompatibilities with 1.5.2,
1350 such as single-argument append(), connect() and bind(), and changes to
1351 str(long) and repr(float).
1354 Binary Incompatibilities
1355 ------------------------
1357 - Third party extensions built for Python 1.5.x or 1.6 cannot be used
1358 with Python 2.0; these extensions will have to be rebuilt for Python
1359 2.0.
1361 - On Windows, attempting to import a third party extension built for
1362 Python 1.5.x or 1.6 results in an immediate crash; there's not much we
1363 can do about this.  Check your PYTHONPATH environment variable!
1365 - Python bytecode files (*.pyc and *.pyo) are not compatible between
1366 releases.
1369 Overview of Changes Since 1.6
1370 -----------------------------
1372 There are many new modules (including brand new XML support through
1373 the xml package, and i18n support through the gettext module); a list
1374 of all new modules is included below.  Lots of bugs have been fixed.
1376 The process for making major new changes to the language has changed
1377 since Python 1.6.  Enhancements must now be documented by a Python
1378 Enhancement Proposal (PEP) before they can be accepted.
1380 There are several important syntax enhancements, described in more
1381 detail below:
1383   - Augmented assignment, e.g. x += 1
1385   - List comprehensions, e.g. [x**2 for x in range(10)]
1387   - Extended import statement, e.g. import Module as Name
1389   - Extended print statement, e.g. print >> file, "Hello"
1391 Other important changes:
1393   - Optional collection of cyclical garbage
1395 Python Enhancement Proposal (PEP)
1396 ---------------------------------
1398 PEP stands for Python Enhancement Proposal.  A PEP is a design
1399 document providing information to the Python community, or describing
1400 a new feature for Python.  The PEP should provide a concise technical
1401 specification of the feature and a rationale for the feature.
1403 We intend PEPs to be the primary mechanisms for proposing new
1404 features, for collecting community input on an issue, and for
1405 documenting the design decisions that have gone into Python.  The PEP
1406 author is responsible for building consensus within the community and
1407 documenting dissenting opinions.
1409 The PEPs are available at http://python.sourceforge.net/peps/.
1411 Augmented Assignment
1412 --------------------
1414 This must have been the most-requested feature of the past years!
1415 Eleven new assignment operators were added:
1417     += -= *= /= %= **= <<= >>= &= ^= |=
1419 For example,
1421     A += B
1423 is similar to
1425     A = A + B
1427 except that A is evaluated only once (relevant when A is something
1428 like dict[index].attr).
1430 However, if A is a mutable object, A may be modified in place.  Thus,
1431 if A is a number or a string, A += B has the same effect as A = A+B
1432 (except A is only evaluated once); but if a is a list, A += B has the
1433 same effect as A.extend(B)!
1435 Classes and built-in object types can override the new operators in
1436 order to implement the in-place behavior; the not-in-place behavior is
1437 used automatically as a fallback when an object doesn't implement the
1438 in-place behavior.  For classes, the method name is derived from the
1439 method name for the corresponding not-in-place operator by inserting
1440 an 'i' in front of the name, e.g. __iadd__ implements in-place
1441 __add__.
1443 Augmented assignment was implemented by Thomas Wouters.
1446 List Comprehensions
1447 -------------------
1449 This is a flexible new notation for lists whose elements are computed
1450 from another list (or lists).  The simplest form is:
1452     [<expression> for <variable> in <sequence>]
1454 For example, [i**2 for i in range(4)] yields the list [0, 1, 4, 9].
1455 This is more efficient than a for loop with a list.append() call.
1457 You can also add a condition:
1459     [<expression> for <variable> in <sequence> if <condition>]
1461 For example, [w for w in words if w == w.lower()] would yield the list
1462 of words that contain no uppercase characters.  This is more efficient
1463 than a for loop with an if statement and a list.append() call.
1465 You can also have nested for loops and more than one 'if' clause.  For
1466 example, here's a function that flattens a sequence of sequences::
1468     def flatten(seq):
1469         return [x for subseq in seq for x in subseq]
1471     flatten([[0], [1,2,3], [4,5], [6,7,8,9], []])
1473 This prints
1475     [0, 1, 2, 3, 4, 5, 6, 7, 8, 9]
1477 List comprehensions originated as a patch set from Greg Ewing; Skip
1478 Montanaro and Thomas Wouters also contributed.  Described by PEP 202.
1481 Extended Import Statement
1482 -------------------------
1484 Many people have asked for a way to import a module under a different
1485 name.  This can be accomplished like this:
1487     import foo
1488     bar = foo
1489     del foo
1491 but this common idiom gets old quickly.  A simple extension of the
1492 import statement now allows this to be written as follows:
1494     import foo as bar
1496 There's also a variant for 'from ... import':
1498     from foo import bar as spam
1500 This also works with packages; e.g. you can write this:
1502     import test.regrtest as regrtest
1504 Note that 'as' is not a new keyword -- it is recognized only in this
1505 context (this is only possible because the syntax for the import
1506 statement doesn't involve expressions).
1508 Implemented by Thomas Wouters.  Described by PEP 221.
1511 Extended Print Statement
1512 ------------------------
1514 Easily the most controversial new feature, this extension to the print
1515 statement adds an option to make the output go to a different file
1516 than the default sys.stdout.
1518 For example, to write an error message to sys.stderr, you can now
1519 write:
1521     print >> sys.stderr, "Error: bad dog!"
1523 As a special feature, if the expression used to indicate the file
1524 evaluates to None, the current value of sys.stdout is used.  Thus:
1526     print >> None, "Hello world"
1528 is equivalent to
1530     print "Hello world"
1532 Design and implementation by Barry Warsaw.  Described by PEP 214.
1535 Optional Collection of Cyclical Garbage
1536 ---------------------------------------
1538 Python is now equipped with a garbage collector that can hunt down
1539 cyclical references between Python objects.  It's no replacement for
1540 reference counting; in fact, it depends on the reference counts being
1541 correct, and decides that a set of objects belong to a cycle if all
1542 their reference counts can be accounted for from their references to
1543 each other.  This devious scheme was first proposed by Eric Tiedemann,
1544 and brought to implementation by Neil Schemenauer.
1546 There's a module "gc" that lets you control some parameters of the
1547 garbage collection.  There's also an option to the configure script
1548 that lets you enable or disable the garbage collection.  In 2.0b1,
1549 it's on by default, so that we (hopefully) can collect decent user
1550 experience with this new feature.  There are some questions about its
1551 performance.  If it proves to be too much of a problem, we'll turn it
1552 off by default in the final 2.0 release.
1555 Smaller Changes
1556 ---------------
1558 A new function zip() was added.  zip(seq1, seq2, ...) is equivalent to
1559 map(None, seq1, seq2, ...) when the sequences have the same length;
1560 i.e. zip([1,2,3], [10,20,30]) returns [(1,10), (2,20), (3,30)].  When
1561 the lists are not all the same length, the shortest list wins:
1562 zip([1,2,3], [10,20]) returns [(1,10), (2,20)].  See PEP 201.
1564 sys.version_info is a tuple (major, minor, micro, level, serial).
1566 Dictionaries have an odd new method, setdefault(key, default).
1567 dict.setdefault(key, default) returns dict[key] if it exists; if not,
1568 it sets dict[key] to default and returns that value.  Thus:
1570     dict.setdefault(key, []).append(item)
1572 does the same work as this common idiom:
1574     if not dict.has_key(key):
1575         dict[key] = []
1576     dict[key].append(item)
1578 There are two new variants of SyntaxError that are raised for
1579 indentation-related errors: IndentationError and TabError.
1581 Changed \x to consume exactly two hex digits; see PEP 223.  Added \U
1582 escape that consumes exactly eight hex digits.
1584 The limits on the size of expressions and file in Python source code
1585 have been raised from 2**16 to 2**32.  Previous versions of Python
1586 were limited because the maximum argument size the Python VM accepted
1587 was 2**16.  This limited the size of object constructor expressions,
1588 e.g. [1,2,3] or {'a':1, 'b':2}, and the size of source files.  This
1589 limit was raised thanks to a patch by Charles Waldman that effectively
1590 fixes the problem.  It is now much more likely that you will be
1591 limited by available memory than by an arbitrary limit in Python.
1593 The interpreter's maximum recursion depth can be modified by Python
1594 programs using sys.getrecursionlimit and sys.setrecursionlimit.  This
1595 limit is the maximum number of recursive calls that can be made by
1596 Python code.  The limit exists to prevent infinite recursion from
1597 overflowing the C stack and causing a core dump.  The default value is
1598 1000.  The maximum safe value for a particular platform can be found
1599 by running Misc/find_recursionlimit.py.
1601 New Modules and Packages
1602 ------------------------
1604 atexit - for registering functions to be called when Python exits.
1606 imputil - Greg Stein's alternative API for writing custom import
1607 hooks.
1609 pyexpat - an interface to the Expat XML parser, contributed by Paul
1610 Prescod.
1612 xml - a new package with XML support code organized (so far) in three
1613 subpackages: xml.dom, xml.sax, and xml.parsers.  Describing these
1614 would fill a volume.  There's a special feature whereby a
1615 user-installed package named _xmlplus overrides the standard
1616 xmlpackage; this is intended to give the XML SIG a hook to distribute
1617 backwards-compatible updates to the standard xml package.
1619 webbrowser - a platform-independent API to launch a web browser.
1622 Changed Modules
1623 ---------------
1625 array -- new methods for array objects: count, extend, index, pop, and
1626 remove
1628 binascii -- new functions b2a_hex and a2b_hex that convert between
1629 binary data and its hex representation
1631 calendar -- Many new functions that support features including control
1632 over which day of the week is the first day, returning strings instead
1633 of printing them.  Also new symbolic constants for days of week,
1634 e.g. MONDAY, ..., SUNDAY.
1636 cgi -- FieldStorage objects have a getvalue method that works like a
1637 dictionary's get method and returns the value attribute of the object.
1639 ConfigParser -- The parser object has new methods has_option,
1640 remove_section, remove_option, set, and write.  They allow the module
1641 to be used for writing config files as well as reading them.
1643 ftplib -- ntransfercmd(), transfercmd(), and retrbinary() all now
1644 optionally support the RFC 959 REST command.
1646 gzip -- readline and readlines now accept optional size arguments
1648 httplib -- New interfaces and support for HTTP/1.1 by Greg Stein.  See
1649 the module doc strings for details.
1651 locale -- implement getdefaultlocale for Win32 and Macintosh
1653 marshal -- no longer dumps core when marshaling deeply nested or
1654 recursive data structures
1656 os -- new functions isatty, seteuid, setegid, setreuid, setregid
1658 os/popen2 -- popen2/popen3/popen4 support under Windows.  popen2/popen3
1659 support under Unix.
1661 os/pty -- support for openpty and forkpty
1663 os.path -- fix semantics of os.path.commonprefix
1665 smtplib -- support for sending very long messages
1667 socket -- new function getfqdn()
1669 readline -- new functions to read, write and truncate history files.
1670 The readline section of the library reference manual contains an
1671 example.
1673 select -- add interface to poll system call
1675 shutil -- new copyfileobj function
1677 SimpleHTTPServer, CGIHTTPServer -- Fix problems with buffering in the
1678 HTTP server.
1680 Tkinter -- optimization of function flatten
1682 urllib -- scans environment variables for proxy configuration,
1683 e.g. http_proxy.
1685 whichdb -- recognizes dumbdbm format
1688 Obsolete Modules
1689 ----------------
1691 None.  However note that 1.6 made a whole slew of modules obsolete:
1692 stdwin, soundex, cml, cmpcache, dircache, dump, find, grep, packmail,
1693 poly, zmod, strop, util, whatsound.
1696 Changed, New, Obsolete Tools
1697 ----------------------------
1699 None.
1702 C-level Changes
1703 ---------------
1705 Several cleanup jobs were carried out throughout the source code.
1707 All C code was converted to ANSI C; we got rid of all uses of the
1708 Py_PROTO() macro, which makes the header files a lot more readable.
1710 Most of the portability hacks were moved to a new header file,
1711 pyport.h; several other new header files were added and some old
1712 header files were removed, in an attempt to create a more rational set
1713 of header files.  (Few of these ever need to be included explicitly;
1714 they are all included by Python.h.)
1716 Trent Mick ensured portability to 64-bit platforms, under both Linux
1717 and Win64, especially for the new Intel Itanium processor.  Mick also
1718 added large file support for Linux64 and Win64.
1720 The C APIs to return an object's size have been update to consistently
1721 use the form PyXXX_Size, e.g. PySequence_Size and PyDict_Size.  In
1722 previous versions, the abstract interfaces used PyXXX_Length and the
1723 concrete interfaces used PyXXX_Size.  The old names,
1724 e.g. PyObject_Length, are still available for backwards compatibility
1725 at the API level, but are deprecated.
1727 The PyOS_CheckStack function has been implemented on Windows by
1728 Fredrik Lundh.  It prevents Python from failing with a stack overflow
1729 on Windows.
1731 The GC changes resulted in creation of two new slots on object,
1732 tp_traverse and tp_clear.  The augmented assignment changes result in
1733 the creation of a new slot for each in-place operator.
1735 The GC API creates new requirements for container types implemented in
1736 C extension modules.  See Include/objimpl.h for details.
1738 PyErr_Format has been updated to automatically calculate the size of
1739 the buffer needed to hold the formatted result string.  This change
1740 prevents crashes caused by programmer error.
1742 New C API calls: PyObject_AsFileDescriptor, PyErr_WriteUnraisable.
1744 PyRun_AnyFileEx, PyRun_SimpleFileEx, PyRun_FileEx -- New functions
1745 that are the same as their non-Ex counterparts except they take an
1746 extra flag argument that tells them to close the file when done.
1748 XXX There were other API changes that should be fleshed out here.
1751 Windows Changes
1752 ---------------
1754 New popen2/popen3/peopen4 in os module (see Changed Modules above).
1756 os.popen is much more usable on Windows 95 and 98.  See Microsoft
1757 Knowledge Base article Q150956.  The Win9x workaround described there
1758 is implemented by the new w9xpopen.exe helper in the root of your
1759 Python installation.  Note that Python uses this internally; it is not
1760 a standalone program.
1762 Administrator privileges are no longer required to install Python
1763 on Windows NT or Windows 2000.  If you have administrator privileges,
1764 Python's registry info will be written under HKEY_LOCAL_MACHINE.
1765 Otherwise the installer backs off to writing Python's registry info
1766 under HKEY_CURRENT_USER.  The latter is sufficient for all "normal"
1767 uses of Python, but will prevent some advanced uses from working
1768 (for example, running a Python script as an NT service, or possibly
1769 from CGI).
1771 [This was new in 1.6] The installer no longer runs a separate Tcl/Tk
1772 installer; instead, it installs the needed Tcl/Tk files directly in the
1773 Python directory.  If you already have a Tcl/Tk installation, this
1774 wastes some disk space (about 4 Megs) but avoids problems with
1775 conflicting Tcl/Tk installations, and makes it much easier for Python
1776 to ensure that Tcl/Tk can find all its files.
1778 [This was new in 1.6] The Windows installer now installs by default in
1779 \Python20\ on the default volume, instead of \Program Files\Python-2.0\.
1782 Updates to the changes between 1.5.2 and 1.6
1783 --------------------------------------------
1785 The 1.6 NEWS file can't be changed after the release is done, so here
1786 is some late-breaking news:
1788 New APIs in locale.py: normalize(), getdefaultlocale(), resetlocale(),
1789 and changes to getlocale() and setlocale().
1791 The new module is now enabled per default.
1793 It is not true that the encodings codecs cannot be used for normal
1794 strings: the string.encode() (which is also present on 8-bit strings
1795 !) allows using them for 8-bit strings too, e.g. to convert files from
1796 cp1252 (Windows) to latin-1 or vice-versa.
1798 Japanese codecs are available from Tamito KAJIYAMA:
1799 http://pseudo.grad.sccs.chukyo-u.ac.jp/~kajiyama/python/
1802 ======================================================================