blob: f52dac359d145631410b4e16cd42fe421291fed2 [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001****************************
2 What's New in Python 2.6
3****************************
4
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00005.. XXX add trademark info for Apple, Microsoft, SourceForge.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00006
Georg Brandl8ec7f652007-08-15 14:28:01 +00007:Author: A.M. Kuchling
8:Release: |release|
9:Date: |today|
10
Georg Brandlb19be572007-12-29 10:57:00 +000011.. $Id: whatsnew26.tex 55746 2007-06-02 18:33:53Z neal.norwitz $
12 Rules for maintenance:
13
14 * Anyone can add text to this document. Do not spend very much time
15 on the wording of your changes, because your text will probably
16 get rewritten to some degree.
17
18 * The maintainer will go through Misc/NEWS periodically and add
19 changes; it's therefore more important to add your changes to
20 Misc/NEWS than to this file.
21
22 * This is not a complete list of every single change; completeness
23 is the purpose of Misc/NEWS. Some changes I consider too small
24 or esoteric to include. If such a change is added to the text,
25 I'll just remove it. (This is another reason you shouldn't spend
26 too much time on writing your addition.)
27
28 * If you want to draw your new text to the attention of the
29 maintainer, add 'XXX' to the beginning of the paragraph or
30 section.
31
32 * It's OK to just add a fragmentary note about a change. For
33 example: "XXX Describe the transmogrify() function added to the
34 socket module." The maintainer will research the change and
35 write the necessary text.
36
37 * You can comment out your additions if you like, but it's not
38 necessary (especially when a final release is some months away).
39
40 * Credit the author of a patch or bugfix. Just the name is
41 sufficient; the e-mail address isn't necessary.
42
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000043 * It's helpful to add the bug/patch number in a parenthetical comment.
Georg Brandlb19be572007-12-29 10:57:00 +000044
Georg Brandlb19be572007-12-29 10:57:00 +000045 XXX Describe the transmogrify() function added to the socket
46 module.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +000047 (Contributed by P.Y. Developer; :issue:`12345`.)
Georg Brandlb19be572007-12-29 10:57:00 +000048
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000049 This saves the maintainer some effort going through the SVN logs
Georg Brandlb19be572007-12-29 10:57:00 +000050 when researching a change.
Georg Brandl8ec7f652007-08-15 14:28:01 +000051
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000052This article explains the new features in Python 2.6. The release
53schedule is described in :pep:`361`; currently the final release is
54scheduled for September 3 2008.
Georg Brandl8ec7f652007-08-15 14:28:01 +000055
Andrew M. Kuchling17f84292008-04-10 21:29:01 +000056This article doesn't attempt to provide a complete specification of
57the new features, but instead provides a convenient overview. For
58full details, you should refer to the documentation for Python 2.6. If
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000059you want to understand the rationale for the design and
60implementation, refer to the PEP for a particular new feature.
61Whenever possible, "What's New in Python" links to the bug/patch item
62for each change.
Georg Brandl8ec7f652007-08-15 14:28:01 +000063
Georg Brandlb19be572007-12-29 10:57:00 +000064.. Compare with previous release in 2 - 3 sentences here.
65 add hyperlink when the documentation becomes available online.
Georg Brandl8ec7f652007-08-15 14:28:01 +000066
Georg Brandlb19be572007-12-29 10:57:00 +000067.. ========================================================================
68.. Large, PEP-level features and changes should be described here.
69.. Should there be a new section here for 3k migration?
70.. Or perhaps a more general section describing module changes/deprecation?
71.. ========================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +000072
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +000073Python 3.0
74================
75
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +000076The development cycle for Python 2.6 also saw the release of the first
77alphas of Python 3.0, and the development of 3.0 has influenced
78a number of features in 2.6.
79
80Python 3.0 is a far-ranging redesign of Python that breaks
81compatibility with the 2.x series. This means that existing Python
82code will need a certain amount of conversion in order to run on
83Python 3.0. However, not all the changes in 3.0 necessarily break
84compatibility. In cases where new features won't cause existing code
85to break, they've been backported to 2.6 and are described in this
86document in the appropriate place. Some of the 3.0-derived features
87are:
88
89* A :meth:`__complex__` method for converting objects to a complex number.
90* Alternate syntax for catching exceptions: ``except TypeError as exc``.
91* The addition of :func:`functools.reduce` as a synonym for the built-in
92 :func:`reduce` function.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +000093
94A new command-line switch, :option:`-3`, enables warnings
95about features that will be removed in Python 3.0. You can run code
96with this switch to see how much work will be necessary to port
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +000097code to 3.0. The value of this switch is available
Georg Brandld5b635f2008-03-25 08:29:14 +000098to Python code as the boolean variable :data:`sys.py3kwarning`,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +000099and to C extension code as :cdata:`Py_Py3kWarningFlag`.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000100
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000101Python 3.0 adds several new built-in functions and change the
102semantics of some existing built-ins. Entirely new functions such as
103:func:`bin` have simply been added to Python 2.6, but existing
104built-ins haven't been changed; instead, the :mod:`future_builtins`
105module has versions with the new 3.0 semantics. Code written to be
106compatible with 3.0 can do ``from future_builtins import hex, map``
107as necessary.
108
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000109.. seealso::
110
111 The 3xxx series of PEPs, which describes the development process for
112 Python 3.0 and various features that have been accepted, rejected,
113 or are still under consideration.
114
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000115
116Development Changes
117==================================================
118
119While 2.6 was being developed, the Python development process
120underwent two significant changes: the developer group
121switched from SourceForge's issue tracker to a customized
122Roundup installation, and the documentation was converted from
David Goodger09f57b72008-04-21 14:40:22 +0000123LaTeX to reStructuredText.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000124
125
126New Issue Tracker: Roundup
127--------------------------------------------------
128
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000129For a long time, the Python developers have been growing increasingly
130annoyed by SourceForge's bug tracker. SourceForge's hosted solution
131doesn't permit much customization; for example, it wasn't possible to
132customize the life cycle of issues.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000133
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000134The infrastructure committee of the Python Software Foundation
135therefore posted a call for issue trackers, asking volunteers to set
136up different products and import some of the bugs and patches from
137SourceForge. Four different trackers were examined: Atlassian's `Jira
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000138<http://www.atlassian.com/software/jira/>`__,
139`Launchpad <http://www.launchpad.net>`__,
140`Roundup <http://roundup.sourceforge.net/>`__, and
Benjamin Peterson80ef62e2008-04-30 22:03:36 +0000141`Trac <http://trac.edgewall.org/>`__.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000142The committee eventually settled on Jira
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000143and Roundup as the two candidates. Jira is a commercial product that
144offers a no-cost hosted instance to free-software projects; Roundup
145is an open-source project that requires volunteers
146to administer it and a server to host it.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000147
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000148After posting a call for volunteers, a new Roundup installation was
149set up at http://bugs.python.org. One installation of Roundup can
150host multiple trackers, and this server now also hosts issue trackers
151for Jython and for the Python web site. It will surely find
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000152other uses in the future. Where possible,
153this edition of "What's New in Python" links to the bug/patch
154item for each change.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000155
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000156Hosting is kindly provided by
157`Upfront Systems <http://www.upfrontsystems.co.za/>`__
158of Stellenbosch, South Africa. Martin von Loewis put a
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000159lot of effort into importing existing bugs and patches from
160SourceForge; his scripts for this import operation are at
161http://svn.python.org/view/tracker/importer/.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000162
163.. seealso::
164
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000165 http://bugs.python.org
166 The Python bug tracker.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000167
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000168 http://bugs.jython.org:
169 The Jython bug tracker.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000170
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000171 http://roundup.sourceforge.net/
172 Roundup downloads and documentation.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000173
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000174
Benjamin Peterson56fcb0b2008-05-02 22:12:58 +0000175New Documentation Format: reStructuredText Using Sphinx
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000176-----------------------------------------------------------
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000177
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000178Since the Python project's inception around 1989, the documentation
179had been written using LaTeX. At that time, most documentation was
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000180printed out for later study, not viewed online. LaTeX was widely used
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000181because it provided attractive printed output while remaining
182straightforward to write, once the basic rules of the markup have been
183learned.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000184
185LaTeX is still used today for writing technical publications destined
186for printing, but the landscape for programming tools has shifted. We
187no longer print out reams of documentation; instead, we browse through
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000188it online and HTML has become the most important format to support.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000189Unfortunately, converting LaTeX to HTML is fairly complicated, and
190Fred L. Drake Jr., the Python documentation editor for many years,
191spent a lot of time wrestling the conversion process into shape.
192Occasionally people would suggest converting the documentation into
193SGML or, later, XML, but performing a good conversion is a major task
194and no one pursued the task to completion.
195
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000196During the 2.6 development cycle, Georg Brandl put a substantial
197effort into building a new toolchain for processing the documentation.
198The resulting package is called Sphinx, and is available from
David Goodger09f57b72008-04-21 14:40:22 +0000199http://sphinx.pocoo.org/. The input format is reStructuredText, a
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000200markup commonly used in the Python community that supports custom
201extensions and directives. Sphinx concentrates on HTML output,
202producing attractively styled and modern HTML, though printed output
203is still supported through conversion to LaTeX. Sphinx is a
204standalone package that can be used in documenting other projects.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000205
206.. seealso::
207
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000208 :ref:`documenting-index`
209 Describes how to write for Python's documentation.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000210
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000211 `Sphinx <http://sphinx.pocoo.org/>`__
212 Documentation and code for the Sphinx toolchain.
213
214 `Docutils <http://docutils.sf.net>`__
David Goodger09f57b72008-04-21 14:40:22 +0000215 The underlying reStructuredText parser and toolset.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000216
217
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000218PEP 343: The 'with' statement
219=============================
220
221The previous version, Python 2.5, added the ':keyword:`with`'
222statement an optional feature, to be enabled by a ``from __future__
Andrew M. Kuchling6e751f42007-12-03 21:28:41 +0000223import with_statement`` directive. In 2.6 the statement no longer needs to
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000224be specially enabled; this means that :keyword:`with` is now always a
225keyword. The rest of this section is a copy of the corresponding
226section from "What's New in Python 2.5" document; if you read
227it back when Python 2.5 came out, you can skip the rest of this
228section.
229
230The ':keyword:`with`' statement clarifies code that previously would use
231``try...finally`` blocks to ensure that clean-up code is executed. In this
232section, I'll discuss the statement as it will commonly be used. In the next
233section, I'll examine the implementation details and show how to write objects
234for use with this statement.
235
236The ':keyword:`with`' statement is a new control-flow structure whose basic
237structure is::
238
239 with expression [as variable]:
240 with-block
241
242The expression is evaluated, and it should result in an object that supports the
243context management protocol (that is, has :meth:`__enter__` and :meth:`__exit__`
244methods.
245
246The object's :meth:`__enter__` is called before *with-block* is executed and
247therefore can run set-up code. It also may return a value that is bound to the
248name *variable*, if given. (Note carefully that *variable* is *not* assigned
249the result of *expression*.)
250
251After execution of the *with-block* is finished, the object's :meth:`__exit__`
252method is called, even if the block raised an exception, and can therefore run
253clean-up code.
254
255Some standard Python objects now support the context management protocol and can
256be used with the ':keyword:`with`' statement. File objects are one example::
257
258 with open('/etc/passwd', 'r') as f:
259 for line in f:
260 print line
261 ... more processing code ...
262
263After this statement has executed, the file object in *f* will have been
264automatically closed, even if the :keyword:`for` loop raised an exception part-
265way through the block.
266
267.. note::
268
269 In this case, *f* is the same object created by :func:`open`, because
270 :meth:`file.__enter__` returns *self*.
271
272The :mod:`threading` module's locks and condition variables also support the
273':keyword:`with`' statement::
274
275 lock = threading.Lock()
276 with lock:
277 # Critical section of code
278 ...
279
280The lock is acquired before the block is executed and always released once the
281block is complete.
282
283The new :func:`localcontext` function in the :mod:`decimal` module makes it easy
284to save and restore the current decimal context, which encapsulates the desired
285precision and rounding characteristics for computations::
286
287 from decimal import Decimal, Context, localcontext
288
289 # Displays with default precision of 28 digits
290 v = Decimal('578')
291 print v.sqrt()
292
293 with localcontext(Context(prec=16)):
294 # All code in this block uses a precision of 16 digits.
295 # The original context is restored on exiting the block.
296 print v.sqrt()
297
298
299.. _new-26-context-managers:
300
301Writing Context Managers
302------------------------
303
304Under the hood, the ':keyword:`with`' statement is fairly complicated. Most
305people will only use ':keyword:`with`' in company with existing objects and
306don't need to know these details, so you can skip the rest of this section if
307you like. Authors of new objects will need to understand the details of the
308underlying implementation and should keep reading.
309
310A high-level explanation of the context management protocol is:
311
312* The expression is evaluated and should result in an object called a "context
313 manager". The context manager must have :meth:`__enter__` and :meth:`__exit__`
314 methods.
315
316* The context manager's :meth:`__enter__` method is called. The value returned
Georg Brandld41b8dc2007-12-16 23:15:07 +0000317 is assigned to *VAR*. If no ``as VAR`` clause is present, the value is simply
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000318 discarded.
319
320* The code in *BLOCK* is executed.
321
322* If *BLOCK* raises an exception, the :meth:`__exit__(type, value, traceback)`
323 is called with the exception details, the same values returned by
324 :func:`sys.exc_info`. The method's return value controls whether the exception
325 is re-raised: any false value re-raises the exception, and ``True`` will result
326 in suppressing it. You'll only rarely want to suppress the exception, because
327 if you do the author of the code containing the ':keyword:`with`' statement will
328 never realize anything went wrong.
329
330* If *BLOCK* didn't raise an exception, the :meth:`__exit__` method is still
331 called, but *type*, *value*, and *traceback* are all ``None``.
332
333Let's think through an example. I won't present detailed code but will only
334sketch the methods necessary for a database that supports transactions.
335
336(For people unfamiliar with database terminology: a set of changes to the
337database are grouped into a transaction. Transactions can be either committed,
338meaning that all the changes are written into the database, or rolled back,
339meaning that the changes are all discarded and the database is unchanged. See
340any database textbook for more information.)
341
342Let's assume there's an object representing a database connection. Our goal will
343be to let the user write code like this::
344
345 db_connection = DatabaseConnection()
346 with db_connection as cursor:
347 cursor.execute('insert into ...')
348 cursor.execute('delete from ...')
349 # ... more operations ...
350
351The transaction should be committed if the code in the block runs flawlessly or
352rolled back if there's an exception. Here's the basic interface for
353:class:`DatabaseConnection` that I'll assume::
354
355 class DatabaseConnection:
356 # Database interface
Georg Brandl9f72d232007-12-16 23:13:29 +0000357 def cursor(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000358 "Returns a cursor object and starts a new transaction"
Georg Brandl9f72d232007-12-16 23:13:29 +0000359 def commit(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000360 "Commits current transaction"
Georg Brandl9f72d232007-12-16 23:13:29 +0000361 def rollback(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000362 "Rolls back current transaction"
363
364The :meth:`__enter__` method is pretty easy, having only to start a new
365transaction. For this application the resulting cursor object would be a useful
366result, so the method will return it. The user can then add ``as cursor`` to
367their ':keyword:`with`' statement to bind the cursor to a variable name. ::
368
369 class DatabaseConnection:
370 ...
Georg Brandl9f72d232007-12-16 23:13:29 +0000371 def __enter__(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000372 # Code to start a new transaction
373 cursor = self.cursor()
374 return cursor
375
376The :meth:`__exit__` method is the most complicated because it's where most of
377the work has to be done. The method has to check if an exception occurred. If
378there was no exception, the transaction is committed. The transaction is rolled
379back if there was an exception.
380
381In the code below, execution will just fall off the end of the function,
382returning the default value of ``None``. ``None`` is false, so the exception
383will be re-raised automatically. If you wished, you could be more explicit and
384add a :keyword:`return` statement at the marked location. ::
385
386 class DatabaseConnection:
387 ...
Georg Brandl9f72d232007-12-16 23:13:29 +0000388 def __exit__(self, type, value, tb):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000389 if tb is None:
390 # No exception, so commit
391 self.commit()
392 else:
393 # Exception occurred, so rollback.
394 self.rollback()
395 # return False
396
397
398.. _module-contextlib:
399
400The contextlib module
401---------------------
402
403The new :mod:`contextlib` module provides some functions and a decorator that
404are useful for writing objects for use with the ':keyword:`with`' statement.
405
406The decorator is called :func:`contextmanager`, and lets you write a single
407generator function instead of defining a new class. The generator should yield
408exactly one value. The code up to the :keyword:`yield` will be executed as the
409:meth:`__enter__` method, and the value yielded will be the method's return
410value that will get bound to the variable in the ':keyword:`with`' statement's
411:keyword:`as` clause, if any. The code after the :keyword:`yield` will be
412executed in the :meth:`__exit__` method. Any exception raised in the block will
413be raised by the :keyword:`yield` statement.
414
415Our database example from the previous section could be written using this
416decorator as::
417
418 from contextlib import contextmanager
419
420 @contextmanager
Georg Brandl9f72d232007-12-16 23:13:29 +0000421 def db_transaction(connection):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000422 cursor = connection.cursor()
423 try:
424 yield cursor
425 except:
426 connection.rollback()
427 raise
428 else:
429 connection.commit()
430
431 db = DatabaseConnection()
432 with db_transaction(db) as cursor:
433 ...
434
435The :mod:`contextlib` module also has a :func:`nested(mgr1, mgr2, ...)` function
436that combines a number of context managers so you don't need to write nested
437':keyword:`with`' statements. In this example, the single ':keyword:`with`'
438statement both starts a database transaction and acquires a thread lock::
439
440 lock = threading.Lock()
441 with nested (db_transaction(db), lock) as (cursor, locked):
442 ...
443
444Finally, the :func:`closing(object)` function returns *object* so that it can be
445bound to a variable, and calls ``object.close`` at the end of the block. ::
446
447 import urllib, sys
448 from contextlib import closing
449
450 with closing(urllib.urlopen('http://www.yahoo.com')) as f:
451 for line in f:
452 sys.stdout.write(line)
453
454
455.. seealso::
456
457 :pep:`343` - The "with" statement
458 PEP written by Guido van Rossum and Nick Coghlan; implemented by Mike Bland,
459 Guido van Rossum, and Neal Norwitz. The PEP shows the code generated for a
460 ':keyword:`with`' statement, which can be helpful in learning how the statement
461 works.
462
463 The documentation for the :mod:`contextlib` module.
464
Georg Brandlb19be572007-12-29 10:57:00 +0000465.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000466
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000467.. _pep-0366:
468
469PEP 366: Explicit Relative Imports From a Main Module
470============================================================
471
472Python's :option:`-m` switch allows running a module as a script.
473When you ran a module that was located inside a package, relative
474imports didn't work correctly.
475
476The fix in Python 2.6 adds a :attr:`__package__` attribute to modules.
477When present, relative imports will be relative to the value of this
478attribute instead of the :attr:`__name__` attribute. PEP 302-style
479importers can then set :attr:`__package__`. The :mod:`runpy` module
480that implements the :option:`-m` switch now does this, so relative imports
481can now be used in scripts running from inside a package.
482
Georg Brandlb19be572007-12-29 10:57:00 +0000483.. ======================================================================
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000484
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000485.. _pep-0370:
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000486
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000487PEP 370: Per-user ``site-packages`` Directory
488=====================================================
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000489
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000490When you run Python, the module search path ``sys.modules`` usually
491includes a directory whose path ends in ``"site-packages"``. This
492directory is intended to hold locally-installed packages available to
493all users on a machine or using a particular site installation.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000494
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000495Python 2.6 introduces a convention for user-specific site directories.
496The directory varies depending on the platform:
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000497
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000498* Unix and MacOS: :file:`~/.local/`
499* Windows: :file:`%APPDATA%/Python`
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000500
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000501Within this directory, there will be version-specific subdirectories,
502such as :file:`lib/python2.6/site-packages` on Unix/MacOS and
503:file:`Python26/site-packages` on Windows.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000504
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000505If you don't like the default directory, it can be overridden by an
506environment variable. :envvar:`PYTHONUSERBASE` sets the root
507directory used for all Python versions supporting this feature. On
508Windows, the directory for application-specific data can be changed by
509setting the :envvar:`APPDATA` environment variable. You can also
510modify the :file:`site.py` file for your Python installation.
511
512The feature can be disabled entirely by running Python with the
513:option:`-s` option or setting the :envvar:`PYTHONNOUSERSITE`
514environment variable.
515
516.. seealso::
517
518 :pep:`370` - Per-user ``site-packages`` Directory
519 PEP written and implemented by Christian Heimes.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000520
521
522.. ======================================================================
523
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000524.. _pep-3101:
525
526PEP 3101: Advanced String Formatting
527=====================================================
528
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000529In Python 3.0, the `%` operator is supplemented by a more powerful
530string formatting method, :meth:`format`. Support for the
531:meth:`format` method has been backported to Python 2.6.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000532
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000533In 2.6, both 8-bit and Unicode strings have a `.format()` method that
534treats the string as a template and takes the arguments to be formatted.
535The formatting template uses curly brackets (`{`, `}`) as special characters::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000536
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000537 # Substitute positional argument 0 into the string.
538 "User ID: {0}".format("root") -> "User ID: root"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000539
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000540 # Use the named keyword arguments
541 uid = 'root'
542
543 'User ID: {uid} Last seen: {last_login}'.format(uid='root',
544 last_login = '5 Mar 2008 07:20') ->
545 'User ID: root Last seen: 5 Mar 2008 07:20'
546
547Curly brackets can be escaped by doubling them::
548
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000549 format("Empty dict: {{}}") -> "Empty dict: {}"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000550
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000551Field names can be integers indicating positional arguments, such as
552``{0}``, ``{1}``, etc. or names of keyword arguments. You can also
553supply compound field names that read attributes or access dictionary keys::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000554
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000555 import sys
556 'Platform: {0.platform}\nPython version: {0.version}'.format(sys) ->
557 'Platform: darwin\n
558 Python version: 2.6a1+ (trunk:61261M, Mar 5 2008, 20:29:41) \n
559 [GCC 4.0.1 (Apple Computer, Inc. build 5367)]'
560
561 import mimetypes
562 'Content-type: {0[.mp4]}'.format(mimetypes.types_map) ->
563 'Content-type: video/mp4'
564
565Note that when using dictionary-style notation such as ``[.mp4]``, you
566don't need to put any quotation marks around the string; it will look
567up the value using ``.mp4`` as the key. Strings beginning with a
568number will be converted to an integer. You can't write more
569complicated expressions inside a format string.
570
571So far we've shown how to specify which field to substitute into the
572resulting string. The precise formatting used is also controllable by
Georg Brandl859043c2008-03-21 17:19:29 +0000573adding a colon followed by a format specifier. For example::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000574
575 # Field 0: left justify, pad to 15 characters
576 # Field 1: right justify, pad to 6 characters
577 fmt = '{0:15} ${1:>6}'
578 fmt.format('Registration', 35) ->
579 'Registration $ 35'
580 fmt.format('Tutorial', 50) ->
581 'Tutorial $ 50'
582 fmt.format('Banquet', 125) ->
583 'Banquet $ 125'
584
Georg Brandl859043c2008-03-21 17:19:29 +0000585Format specifiers can reference other fields through nesting::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000586
587 fmt = '{0:{1}}'
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000588 fmt.format('Invoice #1234', 15) ->
589 'Invoice #1234 '
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000590 width = 35
591 fmt.format('Invoice #1234', width) ->
592 'Invoice #1234 '
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000593
594The alignment of a field within the desired width can be specified:
595
596================ ============================================
597Character Effect
598================ ============================================
599< (default) Left-align
600> Right-align
601^ Center
602= (For numeric types only) Pad after the sign.
603================ ============================================
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000604
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000605Format specifiers can also include a presentation type, which
606controls how the value is formatted. For example, floating-point numbers
607can be formatted as a general number or in exponential notation:
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000608
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000609 >>> '{0:g}'.format(3.75)
610 '3.75'
611 >>> '{0:e}'.format(3.75)
612 '3.750000e+00'
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000613
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000614A variety of presentation types are available. Consult the 2.6
Georg Brandle321c2f2008-05-12 16:45:43 +0000615documentation for a :ref:`complete list <formatstrings>`; here's a sample::
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000616
617 'b' - Binary. Outputs the number in base 2.
618 'c' - Character. Converts the integer to the corresponding
619 Unicode character before printing.
620 'd' - Decimal Integer. Outputs the number in base 10.
621 'o' - Octal format. Outputs the number in base 8.
622 'x' - Hex format. Outputs the number in base 16, using lower-
623 case letters for the digits above 9.
624 'e' - Exponent notation. Prints the number in scientific
625 notation using the letter 'e' to indicate the exponent.
626 'g' - General format. This prints the number as a fixed-point
627 number, unless the number is too large, in which case
628 it switches to 'e' exponent notation.
Eric Smith103f19d2008-05-12 14:00:01 +0000629 'n' - Number. This is the same as 'g' (for floats) or 'd' (for
630 integers), except that it uses the current locale setting to
631 insert the appropriate number separator characters.
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000632 '%' - Percentage. Multiplies the number by 100 and displays
633 in fixed ('f') format, followed by a percent sign.
634
635Classes and types can define a __format__ method to control how they're
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000636formatted. It receives a single argument, the format specifier::
637
638 def __format__(self, format_spec):
639 if isinstance(format_spec, unicode):
640 return unicode(str(self))
641 else:
642 return str(self)
643
644There's also a format() built-in that will format a single value. It calls
645the type's :meth:`__format__` method with the provided specifier::
646
647 >>> format(75.6564, '.2f')
648 '75.66'
649
650.. seealso::
651
652 :pep:`3101` - Advanced String Formatting
653 PEP written by Talin.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000654
655.. ======================================================================
656
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000657.. _pep-3105:
658
659PEP 3105: ``print`` As a Function
660=====================================================
661
662The ``print`` statement becomes the :func:`print` function in Python 3.0.
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000663Making :func:`print` a function makes it easier to change
664by doing 'def print(...)' or importing a new function from somewhere else.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000665
666Python 2.6 has a ``__future__`` import that removes ``print`` as language
667syntax, letting you use the functional form instead. For example::
668
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000669 from __future__ import print_function
670 print('# of entries', len(dictionary), file=sys.stderr)
671
672The signature of the new function is::
673
674 def print(*args, sep=' ', end='\n', file=None)
675
676The parameters are:
677
678 * **args**: positional arguments whose values will be printed out.
679 * **sep**: the separator, which will be printed between arguments.
680 * **end**: the ending text, which will be printed after all of the
681 arguments have been output.
682 * **file**: the file object to which the output will be sent.
683
684.. seealso::
685
Eric Smith33dd0942008-03-20 23:04:04 +0000686 :pep:`3105` - Make print a function
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000687 PEP written by Georg Brandl.
688
689.. ======================================================================
690
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000691.. _pep-3110:
692
693PEP 3110: Exception-Handling Changes
694=====================================================
695
696One error that Python programmers occasionally make
697is the following::
698
699 try:
700 ...
701 except TypeError, ValueError:
702 ...
703
704The author is probably trying to catch both
705:exc:`TypeError` and :exc:`ValueError` exceptions, but this code
706actually does something different: it will catch
707:exc:`TypeError` and bind the resulting exception object
708to the local name ``"ValueError"``. The correct code
709would have specified a tuple::
710
711 try:
712 ...
713 except (TypeError, ValueError):
714 ...
715
716This error is possible because the use of the comma here is ambiguous:
717does it indicate two different nodes in the parse tree, or a single
718node that's a tuple.
719
720Python 3.0 changes the syntax to make this unambiguous by replacing
721the comma with the word "as". To catch an exception and store the
722exception object in the variable ``exc``, you must write::
723
724 try:
725 ...
726 except TypeError as exc:
727 ...
728
729Python 3.0 will only support the use of "as", and therefore interprets
730the first example as catching two different exceptions. Python 2.6
731supports both the comma and "as", so existing code will continue to
732work.
733
734.. seealso::
735
736 :pep:`3110` - Catching Exceptions in Python 3000
737 PEP written and implemented by Collin Winter.
738
Georg Brandlb19be572007-12-29 10:57:00 +0000739.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000740
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000741.. _pep-3112:
742
743PEP 3112: Byte Literals
744=====================================================
745
746Python 3.0 adopts Unicode as the language's fundamental string type, and
747denotes 8-bit literals differently, either as ``b'string'``
748or using a :class:`bytes` constructor. For future compatibility,
749Python 2.6 adds :class:`bytes` as a synonym for the :class:`str` type,
750and it also supports the ``b''`` notation.
751
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000752There's also a ``__future__`` import that causes all string literals
753to become Unicode strings. This means that ``\u`` escape sequences
Benjamin Peterson83343302008-05-04 03:05:49 +0000754can be used to include Unicode characters::
755
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000756
Andrew M. Kuchlingda950eb2008-04-13 22:39:12 +0000757 from __future__ import unicode_literals
758
759 s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
760 '\u3081\u3000\u751f\u305f\u307e\u3054')
761
762 print len(s) # 12 Unicode characters
763
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000764
Benjamin Peterson83343302008-05-04 03:05:49 +0000765
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000766.. seealso::
767
768 :pep:`3112` - Bytes literals in Python 3000
769 PEP written by Jason Orendorff; backported to 2.6 by Christian Heimes.
770
771.. ======================================================================
772
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000773.. _pep-3116:
774
775PEP 3116: New I/O Library
776=====================================================
777
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000778Python's built-in file objects support a number of methods, but
779file-like objects don't necessarily support all of them. Objects that
780imitate files usually support :meth:`read` and :meth:`write`, but they
781may not support :meth:`readline`. Python 3.0 introduces a layered I/O
782library in the :mod:`io` module that separates buffering and
783text-handling features from the fundamental read and write operations.
784
785There are three levels of abstract base classes provided by
786the :mod:`io` module:
787
788* :class:`RawIOBase`: defines raw I/O operations: :meth:`read`,
789 :meth:`readinto`,
790 :meth:`write`, :meth:`seek`, :meth:`tell`, :meth:`truncate`,
791 and :meth:`close`.
792 Most of the methods of this class will often map to a single system call.
793 There are also :meth:`readable`, :meth:`writable`, and :meth:`seekable`
794 methods for determining what operations a given object will allow.
795
796 Python 3.0 has concrete implementations of this class for files and
797 sockets, but Python 2.6 hasn't restructured its file and socket objects
798 in this way.
799
800 .. XXX should 2.6 register them in io.py?
801
802* :class:`BufferedIOBase`: is an abstract base class that
803 buffers data in memory to reduce the number of
804 system calls used, making I/O processing more efficient.
805 It supports all of the methods of :class:`RawIOBase`,
806 and adds a :attr:`raw` attribute holding the underlying raw object.
807
808 There are four concrete classes implementing this ABC:
809 :class:`BufferedWriter` and
810 :class:`BufferedReader` for objects that only support
811 writing or reading and don't support random access,
812 :class:`BufferedRandom` for objects that support the :meth:`seek` method
813 for random access,
814 and :class:`BufferedRWPair` for objects such as TTYs that have
815 both read and write operations that act upon unconnected streams of data.
816
817* :class:`TextIOBase`: Provides functions for reading and writing
818 strings (remember, strings will be Unicode in Python 3.0),
819 and supporting universal newlines. :class:`TextIOBase` defines
820 the :meth:`readline` method and supports iteration upon
821 objects.
822
823 There are two concrete implementations. :class:`TextIOWrapper`
824 wraps a buffered I/O object, supporting all of the methods for
825 text I/O and adding a :attr:`buffer` attribute for access
826 to the underlying object. :class:`StringIO` simply buffers
827 everything in memory without ever writing anything to disk.
828
829 (In current 2.6 alpha releases, :class:`io.StringIO` is implemented in
830 pure Python, so it's pretty slow. You should therefore stick with the
831 existing :mod:`StringIO` module or :mod:`cStringIO` for now. At some
832 point Python 3.0's :mod:`io` module will be rewritten into C for speed,
833 and perhaps the C implementation will be backported to the 2.x releases.)
834
835 .. XXX check before final release: is io.py still written in Python?
836
837In Python 2.6, the underlying implementations haven't been
838restructured to build on top of the :mod:`io` module's classes. The
839module is being provided to make it easier to write code that's
840forward-compatible with 3.0, and to save developers the effort of writing
841their own implementations of buffering and text I/O.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000842
843.. seealso::
844
845 :pep:`3116` - New I/O
846 PEP written by Daniel Stutzbach, Mike Verdone, and Guido van Rossum.
Andrew M. Kuchling04f58762008-04-15 02:24:15 +0000847 Code by Guido van Rossum, Georg Brandl, Walter Doerwald,
848 Jeremy Hylton, Martin von Loewis, Tony Lownds, and others.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000849
850.. ======================================================================
851
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000852.. _pep-3118:
853
854PEP 3118: Revised Buffer Protocol
855=====================================================
856
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000857The buffer protocol is a C-level API that lets Python types
858exchange pointers into their internal representations. A
859memory-mapped file can be viewed as a buffer of characters, for
860example, and this lets another module such as :mod:`re`
861treat memory-mapped files as a string of characters to be searched.
862
863The primary users of the buffer protocol are numeric-processing
864packages such as NumPy, which can expose the internal representation
865of arrays so that callers can write data directly into an array instead
866of going through a slower API. This PEP updates the buffer protocol in light of experience
867from NumPy development, adding a number of new features
868such as indicating the shape of an array,
869locking memory .
870
871The most important new C API function is
872``PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)``, which
873takes an object and a set of flags, and fills in the
874``Py_buffer`` structure with information
875about the object's memory representation. Objects
876can use this operation to lock memory in place
877while an external caller could be modifying the contents,
878so there's a corresponding
879``PyObject_ReleaseBuffer(PyObject *obj, Py_buffer *view)`` to
880indicate that the external caller is done.
881
882The **flags** argument to :cfunc:`PyObject_GetBuffer` specifies
883constraints upon the memory returned. Some examples are:
884
885 * :const:`PyBUF_WRITABLE` indicates that the memory must be writable.
886
887 * :const:`PyBUF_LOCK` requests a read-only or exclusive lock on the memory.
888
889 * :const:`PyBUF_C_CONTIGUOUS` and :const:`PyBUF_F_CONTIGUOUS`
890 requests a C-contiguous (last dimension varies the fastest) or
891 Fortran-contiguous (first dimension varies the fastest) layout.
892
893.. XXX this feature is not in 2.6 docs yet
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000894
895.. seealso::
896
897 :pep:`3118` - Revising the buffer protocol
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000898 PEP written by Travis Oliphant and Carl Banks; implemented by
899 Travis Oliphant.
900
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000901
902.. ======================================================================
903
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000904.. _pep-3119:
905
906PEP 3119: Abstract Base Classes
907=====================================================
908
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000909Some object-oriented languages such as Java support interfaces: declarations
910that a class has a given set of methods or supports a given access protocol.
911Abstract Base Classes (or ABCs) are an equivalent feature for Python. The ABC
912support consists of an :mod:`abc` module containing a metaclass called
913:class:`ABCMeta`, special handling
914of this metaclass by the :func:`isinstance` and :func:`issubclass` built-ins,
915and a collection of basic ABCs that the Python developers think will be widely
916useful.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000917
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000918Let's say you have a particular class and wish to know whether it supports
919dictionary-style access. The phrase "dictionary-style" is vague, however.
920It probably means that accessing items with ``obj[1]`` works.
921Does it imply that setting items with ``obj[2] = value`` works?
922Or that the object will have :meth:`keys`, :meth:`values`, and :meth:`items`
923methods? What about the iterative variants such as :meth:`iterkeys`? :meth:`copy`
924and :meth:`update`? Iterating over the object with :func:`iter`?
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000925
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000926Python 2.6 includes a number of different ABCs in the :mod:`collections`
927module. :class:`Iterable` indicates that a class defines :meth:`__iter__`,
928and :class:`Container` means the class supports ``x in y`` expressions
929by defining a :meth:`__contains__` method. The basic dictionary interface of
930getting items, setting items, and
931:meth:`keys`, :meth:`values`, and :meth:`items`, is defined by the
932:class:`MutableMapping` ABC.
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000933
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000934You can derive your own classes from a particular ABC
935to indicate they support that ABC's interface::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000936
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000937 import collections
938
939 class Storage(collections.MutableMapping):
940 ...
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000941
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000942
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000943Alternatively, you could write the class without deriving from
944the desired ABC and instead register the class by
945calling the ABC's :meth:`register` method::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000946
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000947 import collections
948
949 class Storage:
950 ...
951
952 collections.MutableMapping.register(Storage)
953
954For classes that you write, deriving from the ABC is probably clearer.
955The :meth:`register` method is useful when you've written a new
956ABC that can describe an existing type or class, or if you want
957to declare that some third-party class implements an ABC.
958For example, if you defined a :class:`PrintableType` ABC,
959it's legal to do:
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +0000960
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000961 # Register Python's types
962 PrintableType.register(int)
963 PrintableType.register(float)
964 PrintableType.register(str)
965
966Classes should obey the semantics specified by an ABC, but
967Python can't check this; it's up to the class author to
968understand the ABC's requirements and to implement the code accordingly.
969
970To check whether an object supports a particular interface, you can
971now write::
972
973 def func(d):
974 if not isinstance(d, collections.MutableMapping):
975 raise ValueError("Mapping object expected, not %r" % d)
976
977(Don't feel that you must now begin writing lots of checks as in the
978above example. Python has a strong tradition of duck-typing, where
979explicit type-checking isn't done and code simply calls methods on
980an object, trusting that those methods will be there and raising an
981exception if they aren't. Be judicious in checking for ABCs
982and only do it where it helps.)
983
984You can write your own ABCs by using ``abc.ABCMeta`` as the
985metaclass in a class definition::
986
987 from abc import ABCMeta
988
989 class Drawable():
990 __metaclass__ = ABCMeta
991
992 def draw(self, x, y, scale=1.0):
993 pass
994
995 def draw_doubled(self, x, y):
996 self.draw(x, y, scale=2.0)
997
998
999 class Square(Drawable):
1000 def draw(self, x, y, scale):
1001 ...
1002
1003
1004In the :class:`Drawable` ABC above, the :meth:`draw_doubled` method
1005renders the object at twice its size and can be implemented in terms
1006of other methods described in :class:`Drawable`. Classes implementing
1007this ABC therefore don't need to provide their own implementation
1008of :meth:`draw_doubled`, though they can do so. An implementation
1009of :meth:`draw` is necessary, though; the ABC can't provide
1010a useful generic implementation. You
1011can apply the ``@abstractmethod`` decorator to methods such as
1012:meth:`draw` that must be implemented; Python will
1013then raise an exception for classes that
1014don't define the method::
1015
1016 class Drawable():
1017 __metaclass__ = ABCMeta
1018
1019 @abstractmethod
1020 def draw(self, x, y, scale):
1021 pass
1022
1023Note that the exception is only raised when you actually
1024try to create an instance of a subclass without the method::
1025
1026 >>> s=Square()
1027 Traceback (most recent call last):
1028 File "<stdin>", line 1, in <module>
1029 TypeError: Can't instantiate abstract class Square with abstract methods draw
1030 >>>
1031
1032Abstract data attributes can be declared using the ``@abstractproperty`` decorator::
1033
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001034 @abstractproperty
1035 def readonly(self):
1036 return self._x
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001037
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001038Subclasses must then define a :meth:`readonly` property
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001039
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001040.. seealso::
1041
1042 :pep:`3119` - Introducing Abstract Base Classes
1043 PEP written by Guido van Rossum and Talin.
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001044 Implemented by Guido van Rossum.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001045 Backported to 2.6 by Benjamin Aranguren, with Alex Martelli.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001046
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001047.. ======================================================================
1048
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001049.. _pep-3127:
1050
1051PEP 3127: Integer Literal Support and Syntax
1052=====================================================
1053
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001054Python 3.0 changes the syntax for octal (base-8) integer literals,
1055which are now prefixed by "0o" or "0O" instead of a leading zero, and
1056adds support for binary (base-2) integer literals, signalled by a "0b"
1057or "0B" prefix.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001058
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001059Python 2.6 doesn't drop support for a leading 0 signalling
1060an octal number, but it does add support for "0o" and "0b"::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001061
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001062 >>> 0o21, 2*8 + 1
1063 (17, 17)
1064 >>> 0b101111
1065 47
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001066
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001067The :func:`oct` built-in still returns numbers
1068prefixed with a leading zero, and a new :func:`bin`
1069built-in returns the binary representation for a number::
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001070
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001071 >>> oct(42)
1072 '052'
1073 >>> bin(173)
1074 '0b10101101'
1075
1076The :func:`int` and :func:`long` built-ins will now accept the "0o"
1077and "0b" prefixes when base-8 or base-2 are requested, or when the
1078**base** argument is zero (meaning the base used is determined from
1079the string):
1080
1081 >>> int ('0o52', 0)
1082 42
1083 >>> int('1101', 2)
1084 13
1085 >>> int('0b1101', 2)
1086 13
1087 >>> int('0b1101', 0)
1088 13
1089
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001090
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001091.. seealso::
1092
1093 :pep:`3127` - Integer Literal Support and Syntax
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001094 PEP written by Patrick Maupin; backported to 2.6 by
1095 Eric Smith.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001096
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001097.. ======================================================================
1098
1099.. _pep-3129:
1100
1101PEP 3129: Class Decorators
1102=====================================================
1103
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001104Decorators have been extended from functions to classes. It's now legal to
1105write::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001106
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001107 @foo
1108 @bar
1109 class A:
1110 pass
1111
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001112This is equivalent to::
1113
1114 class A:
1115 pass
1116
1117 A = foo(bar(A))
1118
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001119.. seealso::
1120
1121 :pep:`3129` - Class Decorators
1122 PEP written by Collin Winter.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001123
1124.. ======================================================================
1125
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001126.. _pep-3141:
1127
1128PEP 3141: A Type Hierarchy for Numbers
1129=====================================================
1130
1131In Python 3.0, several abstract base classes for numeric types,
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001132inspired by Scheme's numeric tower, are being added.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001133This change was backported to 2.6 as the :mod:`numbers` module.
1134
1135The most general ABC is :class:`Number`. It defines no operations at
1136all, and only exists to allow checking if an object is a number by
1137doing ``isinstance(obj, Number)``.
1138
1139Numbers are further divided into :class:`Exact` and :class:`Inexact`.
1140Exact numbers can represent values precisely and operations never
1141round off the results or introduce tiny errors that may break the
Georg Brandl907a7202008-02-22 12:31:45 +00001142commutativity and associativity properties; inexact numbers may
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001143perform such rounding or introduce small errors. Integers, long
1144integers, and rational numbers are exact, while floating-point
1145and complex numbers are inexact.
1146
1147:class:`Complex` is a subclass of :class:`Number`. Complex numbers
1148can undergo the basic operations of addition, subtraction,
1149multiplication, division, and exponentiation, and you can retrieve the
1150real and imaginary parts and obtain a number's conjugate. Python's built-in
1151complex type is an implementation of :class:`Complex`.
1152
1153:class:`Real` further derives from :class:`Complex`, and adds
1154operations that only work on real numbers: :func:`floor`, :func:`trunc`,
1155rounding, taking the remainder mod N, floor division,
1156and comparisons.
1157
1158:class:`Rational` numbers derive from :class:`Real`, have
1159:attr:`numerator` and :attr:`denominator` properties, and can be
Mark Dickinsond058cd22008-02-10 21:29:51 +00001160converted to floats. Python 2.6 adds a simple rational-number class,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001161:class:`Fraction`, in the :mod:`fractions` module. (It's called
1162:class:`Fraction` instead of :class:`Rational` to avoid
1163a name clash with :class:`numbers.Rational`.)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001164
1165:class:`Integral` numbers derive from :class:`Rational`, and
1166can be shifted left and right with ``<<`` and ``>>``,
1167combined using bitwise operations such as ``&`` and ``|``,
1168and can be used as array indexes and slice boundaries.
1169
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001170In Python 3.0, the PEP slightly redefines the existing built-ins
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001171:func:`round`, :func:`math.floor`, :func:`math.ceil`, and adds a new
1172one, :func:`math.trunc`, that's been backported to Python 2.6.
1173:func:`math.trunc` rounds toward zero, returning the closest
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001174:class:`Integral` that's between the function's argument and zero.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001175
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001176.. seealso::
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001177
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001178 :pep:`3141` - A Type Hierarchy for Numbers
1179 PEP written by Jeffrey Yasskin.
1180
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001181 `Scheme's numerical tower <http://www.gnu.org/software/guile/manual/html_node/Numerical-Tower.html#Numerical-Tower>`__, from the Guile manual.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001182
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001183 `Scheme's number datatypes <http://schemers.org/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2>`__ from the R5RS Scheme specification.
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001184
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001185
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001186The :mod:`fractions` Module
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001187--------------------------------------------------
1188
1189To fill out the hierarchy of numeric types, a rational-number class
Mark Dickinsond058cd22008-02-10 21:29:51 +00001190has been added as the :mod:`fractions` module. Rational numbers are
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001191represented as a fraction, and can exactly represent
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001192numbers such as two-thirds that floating-point numbers can only
1193approximate.
1194
Mark Dickinsond058cd22008-02-10 21:29:51 +00001195The :class:`Fraction` constructor takes two :class:`Integral` values
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001196that will be the numerator and denominator of the resulting fraction. ::
1197
Mark Dickinsond058cd22008-02-10 21:29:51 +00001198 >>> from fractions import Fraction
1199 >>> a = Fraction(2, 3)
1200 >>> b = Fraction(2, 5)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001201 >>> float(a), float(b)
1202 (0.66666666666666663, 0.40000000000000002)
1203 >>> a+b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001204 Fraction(16, 15)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001205 >>> a/b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001206 Fraction(5, 3)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001207
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001208To help in converting floating-point numbers to rationals,
1209the float type now has a :meth:`as_integer_ratio()` method that returns
1210the numerator and denominator for a fraction that evaluates to the same
1211floating-point value::
1212
1213 >>> (2.5) .as_integer_ratio()
1214 (5, 2)
1215 >>> (3.1415) .as_integer_ratio()
1216 (7074029114692207L, 2251799813685248L)
1217 >>> (1./3) .as_integer_ratio()
1218 (6004799503160661L, 18014398509481984L)
1219
1220Note that values that can only be approximated by floating-point
1221numbers, such as 1./3, are not simplified to the number being
1222approximated; the fraction attempts to match the floating-point value
1223**exactly**.
1224
Mark Dickinsond058cd22008-02-10 21:29:51 +00001225The :mod:`fractions` module is based upon an implementation by Sjoerd
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001226Mullender that was in Python's :file:`Demo/classes/` directory for a
1227long time. This implementation was significantly updated by Jeffrey
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001228Yasskin.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001229
Brett Cannon4b964f92008-05-05 20:21:38 +00001230
Georg Brandl8ec7f652007-08-15 14:28:01 +00001231Other Language Changes
1232======================
1233
1234Here are all of the changes that Python 2.6 makes to the core Python language.
1235
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001236* When calling a function using the ``**`` syntax to provide keyword
1237 arguments, you are no longer required to use a Python dictionary;
1238 any mapping will now work::
1239
1240 >>> def f(**kw):
1241 ... print sorted(kw)
1242 ...
1243 >>> ud=UserDict.UserDict()
1244 >>> ud['a'] = 1
1245 >>> ud['b'] = 'string'
1246 >>> f(**ud)
1247 ['a', 'b']
1248
Andrew M. Kuchlingc157c9c2008-04-09 22:28:43 +00001249 (Contributed by Alexander Belopolsky; :issue:`1686487`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001250
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001251* Tuples now have an :meth:`index` method matching the list type's
1252 :meth:`index` method::
1253
1254 >>> t = (0,1,2,3,4)
1255 >>> t.index(3)
1256 3
1257
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001258* The built-in types now have improved support for extended slicing syntax,
1259 where various combinations of ``(start, stop, step)`` are supplied.
1260 Previously, the support was partial and certain corner cases wouldn't work.
1261 (Implemented by Thomas Wouters.)
1262
Georg Brandlb19be572007-12-29 10:57:00 +00001263 .. Revision 57619
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001264
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001265* Properties now have three attributes, :attr:`getter`,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001266 :attr:`setter` and :attr:`deleter`, that are useful shortcuts for
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001267 adding or modifying a getter, setter or deleter function to an
1268 existing property. You would use them like this::
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001269
1270 class C(object):
1271 @property
1272 def x(self):
1273 return self._x
1274
1275 @x.setter
1276 def x(self, value):
1277 self._x = value
1278
1279 @x.deleter
1280 def x(self):
1281 del self._x
1282
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001283 class D(C):
1284 @C.x.getter
1285 def x(self):
1286 return self._x * 2
1287
1288 @x.setter
1289 def x(self, value):
1290 self._x = value / 2
1291
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001292
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001293* C functions and methods that use
1294 :cfunc:`PyComplex_AsCComplex` will now accept arguments that
1295 have a :meth:`__complex__` method. In particular, the functions in the
1296 :mod:`cmath` module will now accept objects with this method.
1297 This is a backport of a Python 3.0 change.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001298 (Contributed by Mark Dickinson; :issue:`1675423`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001299
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001300 A numerical nicety: when creating a complex number from two floats
1301 on systems that support signed zeros (-0 and +0), the
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001302 :func:`complex` constructor will now preserve the sign
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001303 of the zero. (:issue:`1507`)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001304
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001305* More floating-point features were also added. The :func:`float` function
1306 will now turn the strings ``+nan`` and ``-nan`` into the corresponding
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001307 IEEE 754 Not A Number values, and ``+inf`` and ``-inf`` into
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001308 positive or negative infinity. This works on any platform with
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001309 IEEE 754 semantics. (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001310
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001311 Other functions in the :mod:`math` module, :func:`isinf` and
1312 :func:`isnan`, return true if their floating-point argument is
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001313 infinite or Not A Number. (:issue:`1640`)
Georg Brandle1b8e9c2008-02-20 19:12:36 +00001314
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001315* The :mod:`math` module has seven new functions, and the existing
1316 functions have been improved to give more consistent behaviour
1317 across platforms, especially with respect to handling of
1318 floating-point exceptions and IEEE 754 special values.
1319 The new functions are:
1320
1321 * :func:`isinf` and :func:`isnan` determine whether a given float is
1322 a (positive or negative) infinity or a NaN (Not a Number),
1323 respectively.
1324
1325 * ``copysign(x, y)`` copies the sign bit of an IEEE 754 number,
1326 returning the absolute value of *x* combined with the sign bit of
1327 *y*. For example, ``math.copysign(1, -0.0)`` returns -1.0.
1328 (Contributed by Christian Heimes.)
1329
1330 * The inverse hyperbolic functions :func:`acosh`, :func:`asinh` and
1331 :func:`atanh`.
1332
1333 * The function :func:`log1p`, returning the natural logarithm of
1334 *1+x* (base *e*).
1335
1336 There's also a new :func:`trunc` function as a result of the
1337 backport of `PEP 3141's type hierarchy for numbers <#pep-3141>`__.
1338
1339 The existing math functions have been modified to follow the
1340 recommendations of the C99 standard with respect to special values
1341 whenever possible. For example, ``sqrt(-1.)`` should now give a
1342 :exc:`ValueError` across (nearly) all platforms, while
1343 ``sqrt(float('NaN'))`` should return a NaN on all IEEE 754
1344 platforms. Where Annex 'F' of the C99 standard recommends signaling
1345 'divide-by-zero' or 'invalid', Python will raise :exc:`ValueError`.
1346 Where Annex 'F' of the C99 standard recommends signaling 'overflow',
1347 Python will raise :exc:`OverflowError`. (See :issue:`711019`,
1348 :issue:`1640`.)
1349
1350 (Contributed by Christian Heimes and Mark Dickinson.)
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001351
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001352* Changes to the :class:`Exception` interface
1353 as dictated by :pep:`352` continue to be made. For 2.6,
1354 the :attr:`message` attribute is being deprecated in favor of the
1355 :attr:`args` attribute.
1356
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001357* The :exc:`GeneratorExit` exception now subclasses
1358 :exc:`BaseException` instead of :exc:`Exception`. This means
1359 that an exception handler that does ``except Exception:``
1360 will not inadvertently catch :exc:`GeneratorExit`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001361 (Contributed by Chad Austin; :issue:`1537`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001362
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001363* Generator objects now have a :attr:`gi_code` attribute that refers to
1364 the original code object backing the generator.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001365 (Contributed by Collin Winter; :issue:`1473257`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001366
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001367* The :func:`compile` built-in function now accepts keyword arguments
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001368 as well as positional parameters. (Contributed by Thomas Wouters;
1369 :issue:`1444529`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001370
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001371* The :func:`complex` constructor now accepts strings containing
1372 parenthesized complex numbers, letting ``complex(repr(cmplx))``
1373 will now round-trip values. For example, ``complex('(3+4j)')``
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001374 now returns the value (3+4j). (:issue:`1491866`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001375
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001376* The string :meth:`translate` method now accepts ``None`` as the
1377 translation table parameter, which is treated as the identity
1378 transformation. This makes it easier to carry out operations
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001379 that only delete characters. (Contributed by Bengt Richter;
1380 :issue:`1193128`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001381
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001382* The built-in :func:`dir` function now checks for a :meth:`__dir__`
1383 method on the objects it receives. This method must return a list
1384 of strings containing the names of valid attributes for the object,
1385 and lets the object control the value that :func:`dir` produces.
1386 Objects that have :meth:`__getattr__` or :meth:`__getattribute__`
Facundo Batistabd5b6232007-12-03 19:49:54 +00001387 methods can use this to advertise pseudo-attributes they will honor.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001388 (:issue:`1591665`)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001389
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001390* Instance method objects have new attributes for the object and function
1391 comprising the method; the new synonym for :attr:`im_self` is
1392 :attr:`__self__`, and :attr:`im_func` is also available as :attr:`__func__`.
1393 The old names are still supported in Python 2.6; they're gone in 3.0.
1394
Georg Brandl8ec7f652007-08-15 14:28:01 +00001395* An obscure change: when you use the the :func:`locals` function inside a
1396 :keyword:`class` statement, the resulting dictionary no longer returns free
1397 variables. (Free variables, in this case, are variables referred to in the
1398 :keyword:`class` statement that aren't attributes of the class.)
1399
Georg Brandlb19be572007-12-29 10:57:00 +00001400.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001401
1402
1403Optimizations
1404-------------
1405
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001406* The :mod:`warnings` module has been rewritten in C. This makes
1407 it possible to invoke warnings from the parser, and may also
1408 make the interpreter's startup faster.
1409 (Contributed by Neal Norwitz and Brett Cannon; :issue:`1631171`.)
1410
Georg Brandlaf30b282008-01-15 06:55:56 +00001411* Type objects now have a cache of methods that can reduce
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001412 the amount of work required to find the correct method implementation
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001413 for a particular class; once cached, the interpreter doesn't need to
1414 traverse base classes to figure out the right method to call.
1415 The cache is cleared if a base class or the class itself is modified,
1416 so the cache should remain correct even in the face of Python's dynamic
1417 nature.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001418 (Original optimization implemented by Armin Rigo, updated for
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001419 Python 2.6 by Kevin Jacobs; :issue:`1700288`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001420
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001421* All of the functions in the :mod:`struct` module have been rewritten in
1422 C, thanks to work at the Need For Speed sprint.
1423 (Contributed by Raymond Hettinger.)
1424
Georg Brandl8ec7f652007-08-15 14:28:01 +00001425* Internally, a bit is now set in type objects to indicate some of the standard
1426 built-in types. This speeds up checking if an object is a subclass of one of
1427 these types. (Contributed by Neal Norwitz.)
1428
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001429* Unicode strings now use faster code for detecting
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001430 whitespace and line breaks; this speeds up the :meth:`split` method
1431 by about 25% and :meth:`splitlines` by 35%.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001432 (Contributed by Antoine Pitrou.) Memory usage is reduced
1433 by using pymalloc for the Unicode string's data.
1434
1435* The ``with`` statement now stores the :meth:`__exit__` method on the stack,
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001436 producing a small speedup. (Implemented by Jeffrey Yasskin.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001437
1438* To reduce memory usage, the garbage collector will now clear internal
1439 free lists when garbage-collecting the highest generation of objects.
1440 This may return memory to the OS sooner.
1441
Georg Brandl8ec7f652007-08-15 14:28:01 +00001442The net result of the 2.6 optimizations is that Python 2.6 runs the pystone
1443benchmark around XX% faster than Python 2.5.
1444
Georg Brandlb19be572007-12-29 10:57:00 +00001445.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001446
Benjamin Peterson037d8292008-04-13 02:20:05 +00001447.. _new-26-interactive:
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001448
1449Interactive Interpreter Changes
1450-------------------------------
1451
1452Two command-line options have been reserved for use by other Python
1453implementations. The :option:`-J` switch has been reserved for use by
1454Jython for Jython-specific options, such as ones that are passed to
1455the underlying JVM. :option:`-X` has been reserved for options
1456specific to a particular implementation of Python such as CPython,
1457Jython, or IronPython. If either option is used with Python 2.6, the
1458interpreter will report that the option isn't currently used.
1459
1460.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001461
1462New, Improved, and Deprecated Modules
1463=====================================
1464
1465As usual, Python's standard library received a number of enhancements and bug
1466fixes. Here's a partial list of the most notable changes, sorted alphabetically
1467by module name. Consult the :file:`Misc/NEWS` file in the source tree for a more
Benjamin Peterson7b5151c2008-05-15 22:41:16 +00001468complete list of changes, or look through the Subversion logs for all the
1469details.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001470
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001471* (3.0-warning mode) Python 3.0 will feature a reorganized standard
Benjamin Peterson7b5151c2008-05-15 22:41:16 +00001472 library; many outdated modules are being dropped,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001473 and some modules are being renamed or moved into packages.
1474 Python 2.6 running in 3.0-warning mode will warn about these modules
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001475 when they are imported.
1476 The list of deprecated modules is:
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001477 :mod:`_builtinSuites`,
1478 :mod:`aepack`,
1479 :mod:`aetools`,
1480 :mod:`aetypes`,
1481 :mod:`applesingle`,
1482 :mod:`appletrawmain`,
1483 :mod:`appletrunner`,
1484 :mod:`argvemulator`,
1485 :mod:`Audio_mac`,
1486 :mod:`audiodev`,
1487 :mod:`autoGIL`,
1488 :mod:`bgenlocations`,
1489 :mod:`buildtools`,
1490 :mod:`bundlebuilder`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001491 :mod:`Canvas`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001492 :mod:`Carbon`,
1493 :mod:`cfmfile`,
1494 :mod:`CodeWarrior`,
1495 :mod:`ColorPicker`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001496 :mod:`compiler`,
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001497 :mod:`cd`,
1498 :mod:`cddb`,
1499 :mod:`cdplayer`,
1500 :mod:`CL` and :mod:`cl`,
1501 :mod:`cd`,
1502 :mod:`cd`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001503 :mod:`dircache`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001504 :mod:`dl`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001505 :mod:`EasyDialogs`,
1506 :mod:`Explorer`,
1507 :mod:`Finder`,
1508 :mod:`FrameWork`,
1509 :mod:`findertools`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001510 :mod:`fpformat`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001511 :mod:`gensuitemodule`,
1512 :mod:`ic`,
1513 :mod:`icglue`,
1514 :mod:`icopen`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001515 :mod:`ihooks`,
1516 :mod:`imageop`,
1517 :mod:`linuxaudiodev`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001518 :mod:`macerrors`,
1519 :mod:`MacOS`,
1520 :mod:`macostools`,
1521 :mod:`macresource`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001522 :mod:`mhlib`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001523 :mod:`MiniAEFrame`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001524 :mod:`multifile`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001525 :mod:`Nav`,
1526 :mod:`Netscape`,
1527 :mod:`new`,
1528 :mod:`OSATerminology`,
1529 :mod:`pimp`,
1530 :mod:`PixMapWrapper`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001531 :mod:`popen2`,
1532 :mod:`pure`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001533 :mod:`StdSuites`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001534 :mod:`sv`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001535 :mod:`SystemEvents`,
1536 :mod:`Terminal`,
1537 :mod:`terminalcommand`,
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001538 :mod:`test.testall`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001539 :mod:`toaiff`,
1540 :mod:`videoreader`.
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001541
1542 The modules that have been renamed are:
1543
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001544 * :mod:`ConfigParser` has become :mod:`configparser`.
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001545 * :mod:`copy_reg` has become :mod:`copyreg`.
1546 * :mod:`SocketServer` has become :mod:`socketserver`.
1547 * :mod:`Queue` has become :mod:`queue`.
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00001548
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001549* The :mod:`bsddb.dbshelve` module now uses the highest pickling protocol
1550 available, instead of restricting itself to protocol 1.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001551 (Contributed by W. Barnes; :issue:`1551443`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001552
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001553* The :mod:`cmath` module underwent an extensive set of revisions,
1554 thanks to Mark Dickinson and Christian Heimes, that added some new
1555 features and greatly improved the accuracy of the computations.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001556
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001557 Five new functions were added:
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001558
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001559 * :func:`polar` converts a complex number to polar form, returning
1560 the modulus and argument of that complex number.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001561
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001562 * :func:`rect` does the opposite, turning a (modulus, argument) pair
1563 back into the corresponding complex number.
1564
1565 * :func:`phase` returns the phase or argument of a complex number.
1566
1567 * :func:`isnan` returns True if either
1568 the real or imaginary part of its argument is a NaN.
1569
1570 * :func:`isinf` returns True if either the real or imaginary part of
1571 its argument is infinite.
1572
1573 The revisions also improved the numerical soundness of the
1574 :mod:`cmath` module. For all functions, the real and imaginary
1575 parts of the results are accurate to within a few units of least
1576 precision (ulps) whenever possible. See :issue:`1381` for the
1577 details. The branch cuts for :func:`asinh`, :func:`atanh`: and
1578 :func:`atan` have also been corrected.
1579
1580 The tests for the module have been greatly expanded; nearly 2000 new
1581 test cases exercise the algebraic functions.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001582
1583 On IEEE 754 platforms, the :mod:`cmath` module now handles IEEE 754
1584 special values and floating-point exceptions in a manner consistent
1585 with Annex 'G' of the C99 standard.
1586
Andrew M. Kuchling6d57c822007-10-23 20:55:47 +00001587* A new data type in the :mod:`collections` module: :class:`namedtuple(typename,
Georg Brandl8ec7f652007-08-15 14:28:01 +00001588 fieldnames)` is a factory function that creates subclasses of the standard tuple
1589 whose fields are accessible by name as well as index. For example::
1590
Andrew M. Kuchling6d57c822007-10-23 20:55:47 +00001591 >>> var_type = collections.namedtuple('variable',
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001592 ... 'id name type size')
1593 # Names are separated by spaces or commas.
1594 # 'id, name, type, size' would also work.
Raymond Hettinger366523c2007-12-14 18:12:21 +00001595 >>> var_type._fields
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001596 ('id', 'name', 'type', 'size')
Georg Brandl8ec7f652007-08-15 14:28:01 +00001597
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001598 >>> var = var_type(1, 'frequency', 'int', 4)
1599 >>> print var[0], var.id # Equivalent
1600 1 1
1601 >>> print var[2], var.type # Equivalent
1602 int int
Raymond Hettinger366523c2007-12-14 18:12:21 +00001603 >>> var._asdict()
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001604 {'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'}
Raymond Hettingere9b9b352008-02-15 21:21:25 +00001605 >>> v2 = var._replace(name='amplitude')
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001606 >>> v2
1607 variable(id=1, name='amplitude', type='int', size=4)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001608
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001609 Where the new :class:`namedtuple` type proved suitable, the standard
1610 library has been modified to return them. For example,
1611 the :meth:`Decimal.as_tuple` method now returns a named tuple with
1612 :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
1613
Georg Brandl8ec7f652007-08-15 14:28:01 +00001614 (Contributed by Raymond Hettinger.)
1615
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001616* Another change to the :mod:`collections` module is that the
Georg Brandle7d118a2007-12-08 11:05:05 +00001617 :class:`deque` type now supports an optional *maxlen* parameter;
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001618 if supplied, the deque's size will be restricted to no more
Georg Brandle7d118a2007-12-08 11:05:05 +00001619 than *maxlen* items. Adding more items to a full deque causes
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001620 old items to be discarded.
1621
1622 ::
1623
1624 >>> from collections import deque
1625 >>> dq=deque(maxlen=3)
1626 >>> dq
1627 deque([], maxlen=3)
1628 >>> dq.append(1) ; dq.append(2) ; dq.append(3)
1629 >>> dq
1630 deque([1, 2, 3], maxlen=3)
1631 >>> dq.append(4)
1632 >>> dq
1633 deque([2, 3, 4], maxlen=3)
1634
1635 (Contributed by Raymond Hettinger.)
1636
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001637* The :mod:`ctypes` module now supports a :class:`c_bool` datatype
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001638 that represents the C99 ``bool`` type. (Contributed by David Remahl;
1639 :issue:`1649190`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001640
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001641 The :mod:`ctypes` string, buffer and array types also have improved
1642 support for extended slicing syntax,
1643 where various combinations of ``(start, stop, step)`` are supplied.
1644 (Implemented by Thomas Wouters.)
1645
Georg Brandlb19be572007-12-29 10:57:00 +00001646 .. Revision 57769
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001647
Georg Brandl8ec7f652007-08-15 14:28:01 +00001648* A new method in the :mod:`curses` module: for a window, :meth:`chgat` changes
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001649 the display characters for a certain number of characters on a single line.
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001650 (Contributed by Fabian Kreutz.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001651 ::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001652
1653 # Boldface text starting at y=0,x=21
1654 # and affecting the rest of the line.
1655 stdscr.chgat(0,21, curses.A_BOLD)
1656
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001657 The :class:`Textbox` class in the :mod:`curses.textpad` module
1658 now supports editing in insert mode as well as overwrite mode.
1659 Insert mode is enabled by supplying a true value for the *insert_mode*
1660 parameter when creating the :class:`Textbox` instance.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001661
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001662* The :mod:`datetime` module's :meth:`strftime` methods now support a
1663 ``%f`` format code that expands to the number of microseconds in the
1664 object, zero-padded on
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001665 the left to six places. (Contributed by Skip Montanaro; :issue:`1158`.)
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001666
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001667* The :mod:`decimal` module was updated to version 1.66 of
1668 `the General Decimal Specification <http://www2.hursley.ibm.com/decimal/decarith.html>`__. New features
1669 include some methods for some basic mathematical functions such as
1670 :meth:`exp` and :meth:`log10`::
1671
1672 >>> Decimal(1).exp()
1673 Decimal("2.718281828459045235360287471")
1674 >>> Decimal("2.7182818").ln()
1675 Decimal("0.9999999895305022877376682436")
1676 >>> Decimal(1000).log10()
1677 Decimal("3")
1678
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001679 The :meth:`as_tuple` method of :class:`Decimal` objects now returns a
1680 named tuple with :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
1681
1682 (Implemented by Facundo Batista and Mark Dickinson. Named tuple
1683 support added by Raymond Hettinger.)
1684
1685* The :mod:`difflib` module's :class:`SequenceMatcher` class
1686 now returns named tuples representing matches.
1687 In addition to behaving like tuples, the returned values
1688 also have :attr:`a`, :attr:`b`, and :attr:`size` attributes.
1689 (Contributed by Raymond Hettinger.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001690
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001691* An optional ``timeout`` parameter was added to the
1692 :class:`ftplib.FTP` class constructor as well as the :meth:`connect`
1693 method, specifying a timeout measured in seconds. (Added by Facundo
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001694 Batista.) Also, the :class:`FTP` class's
1695 :meth:`storbinary` and :meth:`storlines`
1696 now take an optional *callback* parameter that will be called with
1697 each block of data after the data has been sent.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001698 (Contributed by Phil Schwartz; :issue:`1221598`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001699
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001700* The :func:`reduce` built-in function is also available in the
1701 :mod:`functools` module. In Python 3.0, the built-in is dropped and it's
1702 only available from :mod:`functools`; currently there are no plans
1703 to drop the built-in in the 2.x series. (Patched by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001704 Christian Heimes; :issue:`1739906`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001705
Georg Brandl8ec7f652007-08-15 14:28:01 +00001706* The :func:`glob.glob` function can now return Unicode filenames if
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001707 a Unicode path was used and Unicode filenames are matched within the
1708 directory. (:issue:`1001604`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001709
1710* The :mod:`gopherlib` module has been removed.
1711
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001712* A new function in the :mod:`heapq` module: ``merge(iter1, iter2, ...)``
1713 takes any number of iterables that return data *in sorted
1714 order*, and returns a new iterator that returns the contents of all
1715 the iterators, also in sorted order. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001716
1717 heapq.merge([1, 3, 5, 9], [2, 8, 16]) ->
1718 [1, 2, 3, 5, 8, 9, 16]
1719
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001720 Another new function, ``heappushpop(heap, item)``,
1721 pushes *item* onto *heap*, then pops off and returns the smallest item.
1722 This is more efficient than making a call to :func:`heappush` and then
1723 :func:`heappop`.
1724
Georg Brandl8ec7f652007-08-15 14:28:01 +00001725 (Contributed by Raymond Hettinger.)
1726
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001727* An optional ``timeout`` parameter was added to the
1728 :class:`httplib.HTTPConnection` and :class:`HTTPSConnection`
1729 class constructors, specifying a timeout measured in seconds.
1730 (Added by Facundo Batista.)
1731
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001732* Most of the :mod:`inspect` module's functions, such as
1733 :func:`getmoduleinfo` and :func:`getargs`, now return named tuples.
1734 In addition to behaving like tuples, the elements of the return value
1735 can also be accessed as attributes.
1736 (Contributed by Raymond Hettinger.)
1737
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001738 Some new functions in the module include
1739 :func:`isgenerator`, :func:`isgeneratorfunction`,
1740 and :func:`isabstract`.
1741
1742* The :mod:`itertools` module gained several new functions.
1743
1744 ``izip_longest(iter1, iter2, ...[, fillvalue])`` makes tuples from
1745 each of the elements; if some of the iterables are shorter than
1746 others, the missing values are set to *fillvalue*. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001747
1748 itertools.izip_longest([1,2,3], [1,2,3,4,5]) ->
1749 [(1, 1), (2, 2), (3, 3), (None, 4), (None, 5)]
1750
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001751 ``product(iter1, iter2, ..., [repeat=N])`` returns the Cartesian product
1752 of the supplied iterables, a set of tuples containing
1753 every possible combination of the elements returned from each iterable. ::
1754
1755 itertools.product([1,2,3], [4,5,6]) ->
1756 [(1, 4), (1, 5), (1, 6),
1757 (2, 4), (2, 5), (2, 6),
1758 (3, 4), (3, 5), (3, 6)]
1759
1760 The optional *repeat* keyword argument is used for taking the
1761 product of an iterable or a set of iterables with themselves,
1762 repeated *N* times. With a single iterable argument, *N*-tuples
1763 are returned::
1764
1765 itertools.product([1,2], repeat=3)) ->
1766 [(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
1767 (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]
1768
1769 With two iterables, *2N*-tuples are returned. ::
1770
1771 itertools(product([1,2], [3,4], repeat=2) ->
1772 [(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
1773 (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
1774 (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
1775 (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]
1776
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001777 ``combinations(iterable, r)`` returns sub-sequences of length *r* from
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001778 the elements of *iterable*. ::
1779
1780 itertools.combinations('123', 2) ->
1781 [('1', '2'), ('1', '3'), ('2', '3')]
1782
1783 itertools.combinations('123', 3) ->
1784 [('1', '2', '3')]
1785
1786 itertools.combinations('1234', 3) ->
1787 [('1', '2', '3'), ('1', '2', '4'), ('1', '3', '4'),
1788 ('2', '3', '4')]
1789
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001790 ``permutations(iter[, r])`` returns all the permutations of length *r* of
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001791 the iterable's elements. If *r* is not specified, it will default to the
Georg Brandlcb635652008-05-05 20:59:05 +00001792 number of elements produced by the iterable. ::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001793
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001794 itertools.permutations([1,2,3,4], 2) ->
1795 [(1, 2), (1, 3), (1, 4),
1796 (2, 1), (2, 3), (2, 4),
1797 (3, 1), (3, 2), (3, 4),
1798 (4, 1), (4, 2), (4, 3)]
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001799
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001800 ``itertools.chain(*iterables)`` is an existing function in
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001801 :mod:`itertools` that gained a new constructor in Python 2.6.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001802 ``itertools.chain.from_iterable(iterable)`` takes a single
1803 iterable that should return other iterables. :func:`chain` will
1804 then return all the elements of the first iterable, then
1805 all the elements of the second, and so on. ::
1806
1807 chain.from_iterable([[1,2,3], [4,5,6]]) ->
1808 [1, 2, 3, 4, 5, 6]
1809
1810 (All contributed by Raymond Hettinger.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001811
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001812* The :mod:`logging` module's :class:`FileHandler` class
1813 and its subclasses :class:`WatchedFileHandler`, :class:`RotatingFileHandler`,
1814 and :class:`TimedRotatingFileHandler` now
1815 have an optional *delay* parameter to its constructor. If *delay*
1816 is true, opening of the log file is deferred until the first
1817 :meth:`emit` call is made. (Contributed by Vinay Sajip.)
1818
Georg Brandl8ec7f652007-08-15 14:28:01 +00001819* The :mod:`macfs` module has been removed. This in turn required the
1820 :func:`macostools.touched` function to be removed because it depended on the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001821 :mod:`macfs` module. (:issue:`1490190`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001822
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001823* :class:`mmap` objects now have a :meth:`rfind` method that finds
1824 a substring, beginning at the end of the string and searching
1825 backwards. The :meth:`find` method
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001826 also gained an *end* parameter containing the index at which to stop
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001827 the forward search.
1828 (Contributed by John Lenton.)
1829
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001830* The :mod:`operator` module gained a
1831 :func:`methodcaller` function that takes a name and an optional
1832 set of arguments, returning a callable that will call
1833 the named function on any arguments passed to it. For example::
1834
1835 >>> # Equivalent to lambda s: s.replace('old', 'new')
1836 >>> replacer = operator.methodcaller('replace', 'old', 'new')
1837 >>> replacer('old wine in old bottles')
1838 'new wine in new bottles'
1839
Georg Brandl27504da2008-03-04 07:25:54 +00001840 (Contributed by Georg Brandl, after a suggestion by Gregory Petrosyan.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001841
1842 The :func:`attrgetter` function now accepts dotted names and performs
1843 the corresponding attribute lookups::
1844
1845 >>> inst_name = operator.attrgetter('__class__.__name__')
1846 >>> inst_name('')
1847 'str'
1848 >>> inst_name(help)
1849 '_Helper'
1850
Georg Brandl27504da2008-03-04 07:25:54 +00001851 (Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001852
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001853* New functions in the :mod:`os` module include
1854 ``fchmod(fd, mode)``, ``fchown(fd, uid, gid)``,
1855 and ``lchmod(path, mode)``, on operating systems that support these
1856 functions. :func:`fchmod` and :func:`fchown` let you change the mode
1857 and ownership of an opened file, and :func:`lchmod` changes the mode
1858 of a symlink.
1859
1860 (Contributed by Georg Brandl and Christian Heimes.)
1861
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001862* The :func:`os.walk` function now has a ``followlinks`` parameter. If
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001863 set to True, it will follow symlinks pointing to directories and
1864 visit the directory's contents. For backward compatibility, the
1865 parameter's default value is false. Note that the function can fall
1866 into an infinite recursion if there's a symlink that points to a
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001867 parent directory. (:issue:`1273829`)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001868
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001869* The ``os.environ`` object's :meth:`clear` method will now unset the
1870 environment variables using :func:`os.unsetenv` in addition to clearing
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001871 the object's keys. (Contributed by Martin Horcicka; :issue:`1181`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001872
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001873* In the :mod:`os.path` module, the :func:`splitext` function
1874 has been changed to not split on leading period characters.
1875 This produces better results when operating on Unix's dot-files.
1876 For example, ``os.path.splitext('.ipython')``
1877 now returns ``('.ipython', '')`` instead of ``('', '.ipython')``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001878 (:issue:`115886`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001879
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001880 A new function, :func:`relpath(path, start)` returns a relative path
1881 from the ``start`` path, if it's supplied, or from the current
1882 working directory to the destination ``path``. (Contributed by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001883 Richard Barran; :issue:`1339796`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001884
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001885 On Windows, :func:`os.path.expandvars` will now expand environment variables
1886 in the form "%var%", and "~user" will be expanded into the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001887 user's home directory path. (Contributed by Josiah Carlson;
1888 :issue:`957650`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001889
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001890* The Python debugger provided by the :mod:`pdb` module
1891 gained a new command: "run" restarts the Python program being debugged,
1892 and can optionally take new command-line arguments for the program.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001893 (Contributed by Rocky Bernstein; :issue:`1393667`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001894
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001895 The :func:`post_mortem` function, used to enter debugging of a
1896 traceback, will now use the traceback returned by :func:`sys.exc_info`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001897 if no traceback is supplied. (Contributed by Facundo Batista;
1898 :issue:`1106316`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001899
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001900* The :mod:`pickletools` module now has an :func:`optimize` function
1901 that takes a string containing a pickle and removes some unused
1902 opcodes, returning a shorter pickle that contains the same data structure.
1903 (Contributed by Raymond Hettinger.)
1904
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001905* A :func:`get_data` function was added to the :mod:`pkgutil`
1906 module that returns the contents of resource files included
1907 with an installed Python package. For example::
1908
Benjamin Peterson60ffcbe2008-04-21 22:57:00 +00001909 >>> import pkgutil
1910 >>> pkgutil.get_data('test', 'exception_hierarchy.txt')
1911 'BaseException
1912 +-- SystemExit
1913 +-- KeyboardInterrupt
1914 +-- GeneratorExit
1915 +-- Exception
1916 +-- StopIteration
1917 +-- StandardError
1918 ...'
1919 >>>
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001920
1921 (Contributed by Paul Moore; :issue:`2439`.)
1922
Georg Brandl8ec7f652007-08-15 14:28:01 +00001923* New functions in the :mod:`posix` module: :func:`chflags` and :func:`lchflags`
1924 are wrappers for the corresponding system calls (where they're available).
1925 Constants for the flag values are defined in the :mod:`stat` module; some
1926 possible values include :const:`UF_IMMUTABLE` to signal the file may not be
1927 changed and :const:`UF_APPEND` to indicate that data can only be appended to the
1928 file. (Contributed by M. Levinson.)
1929
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001930 ``os.closerange(*low*, *high*)`` efficiently closes all file descriptors
1931 from *low* to *high*, ignoring any errors and not including *high* itself.
1932 This function is now used by the :mod:`subprocess` module to make starting
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001933 processes faster. (Contributed by Georg Brandl; :issue:`1663329`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001934
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00001935* The :mod:`pyexpat` module's :class:`Parser` objects now allow setting
1936 their :attr:`buffer_size` attribute to change the size of the buffer
1937 used to hold character data.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001938 (Contributed by Achim Gaedke; :issue:`1137`.)
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00001939
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001940* The :mod:`Queue` module now provides queue classes that retrieve entries
1941 in different orders. The :class:`PriorityQueue` class stores
1942 queued items in a heap and retrieves them in priority order,
1943 and :class:`LifoQueue` retrieves the most recently added entries first,
1944 meaning that it behaves like a stack.
1945 (Contributed by Raymond Hettinger.)
1946
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001947* The :mod:`random` module's :class:`Random` objects can
1948 now be pickled on a 32-bit system and unpickled on a 64-bit
1949 system, and vice versa. Unfortunately, this change also means
1950 that Python 2.6's :class:`Random` objects can't be unpickled correctly
1951 on earlier versions of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001952 (Contributed by Shawn Ligocki; :issue:`1727780`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001953
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001954 The new ``triangular(low, high, mode)`` function returns random
1955 numbers following a triangular distribution. The returned values
1956 are between *low* and *high*, not including *high* itself, and
1957 with *mode* as the mode, the most frequently occurring value
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001958 in the distribution. (Contributed by Wladmir van der Laan and
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001959 Raymond Hettinger; :issue:`1681432`.)
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001960
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001961* Long regular expression searches carried out by the :mod:`re`
1962 module will now check for signals being delivered, so especially
1963 long searches can now be interrupted.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001964 (Contributed by Josh Hoyt and Ralf Schmitt; :issue:`846388`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001965
Georg Brandl8ec7f652007-08-15 14:28:01 +00001966* The :mod:`rgbimg` module has been removed.
1967
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001968* The :mod:`sched` module's :class:`scheduler` instances now
1969 have a read-only :attr:`queue` attribute that returns the
1970 contents of the scheduler's queue, represented as a list of
Georg Brandl225163d2008-03-05 07:10:35 +00001971 named tuples with the fields ``(time, priority, action, argument)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001972 (Contributed by Raymond Hettinger; :issue:`1861`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001973
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001974* The :mod:`select` module now has wrapper functions
1975 for the Linux :cfunc:`epoll` and BSD :cfunc:`kqueue` system calls.
1976 Also, a :meth:`modify` method was added to the existing :class:`poll`
1977 objects; ``pollobj.modify(fd, eventmask)`` takes a file descriptor
1978 or file object and an event mask,
1979
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001980 (Contributed by Christian Heimes; :issue:`1657`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001981
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00001982* The :mod:`sets` module has been deprecated; it's better to
1983 use the built-in :class:`set` and :class:`frozenset` types.
1984
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00001985* Integrating signal handling with GUI handling event loops
1986 like those used by Tkinter or GTk+ has long been a problem; most
Georg Brandle1b8e9c2008-02-20 19:12:36 +00001987 software ends up polling, waking up every fraction of a second.
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00001988 The :mod:`signal` module can now make this more efficient.
1989 Calling ``signal.set_wakeup_fd(fd)`` sets a file descriptor
1990 to be used; when a signal is received, a byte is written to that
1991 file descriptor. There's also a C-level function,
1992 :cfunc:`PySignal_SetWakeupFd`, for setting the descriptor.
1993
1994 Event loops will use this by opening a pipe to create two descriptors,
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001995 one for reading and one for writing. The writable descriptor
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00001996 will be passed to :func:`set_wakeup_fd`, and the readable descriptor
1997 will be added to the list of descriptors monitored by the event loop via
1998 :cfunc:`select` or :cfunc:`poll`.
1999 On receiving a signal, a byte will be written and the main event loop
2000 will be woken up, without the need to poll.
2001
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002002 (Contributed by Adam Olsen; :issue:`1583`.)
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002003
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002004 The :func:`siginterrupt` function is now available from Python code,
2005 and allows changing whether signals can interrupt system calls or not.
2006 (Contributed by Ralf Schmitt.)
2007
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002008 The :func:`setitimer` and :func:`getitimer` functions have also been
2009 added on systems that support these system calls. :func:`setitimer`
2010 allows setting interval timers that will cause a signal to be
2011 delivered to the process after a specified time, measured in
2012 wall-clock time, consumed process time, or combined process+system
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002013 time. (Contributed by Guilherme Polo; :issue:`2240`.)
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002014
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002015* The :mod:`smtplib` module now supports SMTP over SSL thanks to the
2016 addition of the :class:`SMTP_SSL` class. This class supports an
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002017 interface identical to the existing :class:`SMTP` class. Both
2018 class constructors also have an optional ``timeout`` parameter
2019 that specifies a timeout for the initial connection attempt, measured in
2020 seconds.
2021
2022 An implementation of the LMTP protocol (:rfc:`2033`) was also added to
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002023 the module. LMTP is used in place of SMTP when transferring e-mail
2024 between agents that don't manage a mail queue.
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002025
2026 (SMTP over SSL contributed by Monty Taylor; timeout parameter
2027 added by Facundo Batista; LMTP implemented by Leif
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002028 Hedstrom; :issue:`957003`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002029
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00002030* In the :mod:`smtplib` module, SMTP.starttls() now complies with :rfc:`3207`
2031 and forgets any knowledge obtained from the server not obtained from
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002032 the TLS negotiation itself. (Patch contributed by Bill Fenner;
2033 :issue:`829951`.)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00002034
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002035* The :mod:`socket` module now supports TIPC (http://tipc.sf.net),
2036 a high-performance non-IP-based protocol designed for use in clustered
2037 environments. TIPC addresses are 4- or 5-tuples.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002038 (Contributed by Alberto Bertogli; :issue:`1646`.)
Andrew M. Kuchlingf60b6412008-01-19 16:34:09 +00002039
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002040 A new function, :func:`create_connection`, takes an address
2041 and connects to it using an optional timeout value, returning
2042 the connected socket object.
2043
Andrew M. Kuchlingf60b6412008-01-19 16:34:09 +00002044* The base classes in the :mod:`SocketServer` module now support
2045 calling a :meth:`handle_timeout` method after a span of inactivity
2046 specified by the server's :attr:`timeout` attribute. (Contributed
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002047 by Michael Pomraning.) The :meth:`serve_forever` method
2048 now takes an optional poll interval measured in seconds,
2049 controlling how often the server will check for a shutdown request.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002050 (Contributed by Pedro Werneck and Jeffrey Yasskin;
2051 :issue:`742598`, :issue:`1193577`.)
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002052
2053* The :mod:`struct` module now supports the C99 :ctype:`_Bool` type,
2054 using the format character ``'?'``.
2055 (Contributed by David Remahl.)
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002056
2057* The :class:`Popen` objects provided by the :mod:`subprocess` module
2058 now have :meth:`terminate`, :meth:`kill`, and :meth:`send_signal` methods.
2059 On Windows, :meth:`send_signal` only supports the :const:`SIGTERM`
2060 signal, and all these methods are aliases for the Win32 API function
2061 :cfunc:`TerminateProcess`.
2062 (Contributed by Christian Heimes.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002063
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002064* A new variable in the :mod:`sys` module,
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002065 :attr:`float_info`, is an object
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002066 containing information about the platform's floating-point support
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002067 derived from the :file:`float.h` file. Attributes of this object
2068 include
2069 :attr:`mant_dig` (number of digits in the mantissa), :attr:`epsilon`
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002070 (smallest difference between 1.0 and the next largest value
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002071 representable), and several others. (Contributed by Christian Heimes;
2072 :issue:`1534`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002073
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00002074 Another new variable, :attr:`dont_write_bytecode`, controls whether Python
2075 writes any :file:`.pyc` or :file:`.pyo` files on importing a module.
2076 If this variable is true, the compiled files are not written. The
2077 variable is initially set on start-up by supplying the :option:`-B`
2078 switch to the Python interpreter, or by setting the
2079 :envvar:`PYTHONDONTWRITEBYTECODE` environment variable before
2080 running the interpreter. Python code can subsequently
2081 change the value of this variable to control whether bytecode files
2082 are written or not.
2083 (Contributed by Neal Norwitz and Georg Brandl.)
2084
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002085 Information about the command-line arguments supplied to the Python
2086 interpreter are available as attributes of a ``sys.flags`` named
2087 tuple. For example, the :attr:`verbose` attribute is true if Python
2088 was executed in verbose mode, :attr:`debug` is true in debugging mode, etc.
2089 These attributes are all read-only.
2090 (Contributed by Christian Heimes.)
2091
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002092 It's now possible to determine the current profiler and tracer functions
2093 by calling :func:`sys.getprofile` and :func:`sys.gettrace`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002094 (Contributed by Georg Brandl; :issue:`1648`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002095
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002096* The :mod:`tarfile` module now supports POSIX.1-2001 (pax) and
2097 POSIX.1-1988 (ustar) format tarfiles, in addition to the GNU tar
2098 format that was already supported. The default format
2099 is GNU tar; specify the ``format`` parameter to open a file
2100 using a different format::
2101
2102 tar = tarfile.open("output.tar", "w", format=tarfile.PAX_FORMAT)
2103
2104 The new ``errors`` parameter lets you specify an error handling
2105 scheme for character conversions: the three standard ways Python can
2106 handle errors ``'strict'``, ``'ignore'``, ``'replace'`` , or the
2107 special value ``'utf-8'``, which replaces bad characters with their
2108 UTF-8 representation. Character conversions occur because the PAX
2109 format supports Unicode filenames, defaulting to UTF-8 encoding.
2110
2111 The :meth:`TarFile.add` method now accepts a ``exclude`` argument that's
2112 a function that can be used to exclude certain filenames from
2113 an archive.
2114 The function must take a filename and return true if the file
2115 should be excluded or false if it should be archived.
2116 The function is applied to both the name initially passed to :meth:`add`
2117 and to the names of files in recursively-added directories.
2118
2119 (All changes contributed by Lars Gustäbel).
2120
2121* An optional ``timeout`` parameter was added to the
2122 :class:`telnetlib.Telnet` class constructor, specifying a timeout
2123 measured in seconds. (Added by Facundo Batista.)
2124
2125* The :class:`tempfile.NamedTemporaryFile` class usually deletes
2126 the temporary file it created when the file is closed. This
2127 behaviour can now be changed by passing ``delete=False`` to the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002128 constructor. (Contributed by Damien Miller; :issue:`1537850`.)
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002129
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002130 A new class, :class:`SpooledTemporaryFile`, behaves like
2131 a temporary file but stores its data in memory until a maximum size is
2132 exceeded. On reaching that limit, the contents will be written to
2133 an on-disk temporary file. (Contributed by Dustin J. Mitchell.)
2134
2135 The :class:`NamedTemporaryFile` and :class:`SpooledTemporaryFile` classes
2136 both work as context managers, so you can write
2137 ``with tempfile.NamedTemporaryFile() as tmp: ...``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002138 (Contributed by Alexander Belopolsky; :issue:`2021`.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002139
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002140* The :mod:`test.test_support` module now contains a
2141 :func:`EnvironmentVarGuard`
2142 context manager that supports temporarily changing environment variables and
2143 automatically restores them to their old values.
2144
2145 Another context manager, :class:`TransientResource`, can surround calls
2146 to resources that may or may not be available; it will catch and
2147 ignore a specified list of exceptions. For example,
2148 a network test may ignore certain failures when connecting to an
2149 external web site::
2150
2151 with test_support.TransientResource(IOError, errno=errno.ETIMEDOUT):
2152 f = urllib.urlopen('https://sf.net')
2153 ...
2154
2155 (Contributed by Brett Cannon.)
2156
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002157* The :mod:`textwrap` module can now preserve existing whitespace
2158 at the beginnings and ends of the newly-created lines
2159 by specifying ``drop_whitespace=False``
2160 as an argument::
2161
2162 >>> S = """This sentence has a bunch of extra whitespace."""
2163 >>> print textwrap.fill(S, width=15)
2164 This sentence
2165 has a bunch
2166 of extra
2167 whitespace.
2168 >>> print textwrap.fill(S, drop_whitespace=False, width=15)
2169 This sentence
2170 has a bunch
2171 of extra
2172 whitespace.
2173 >>>
2174
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002175 (Contributed by Dwayne Bailey; :issue:`1581073`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002176
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002177* The :mod:`timeit` module now accepts callables as well as strings
2178 for the statement being timed and for the setup code.
2179 Two convenience functions were added for creating
2180 :class:`Timer` instances:
2181 ``repeat(stmt, setup, time, repeat, number)`` and
2182 ``timeit(stmt, setup, time, number)`` create an instance and call
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002183 the corresponding method. (Contributed by Erik Demaine;
2184 :issue:`1533909`.)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002185
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002186* An optional ``timeout`` parameter was added to the
2187 :func:`urllib.urlopen` function and the
2188 :class:`urllib.ftpwrapper` class constructor, as well as the
2189 :func:`urllib2.urlopen` function. The parameter specifies a timeout
2190 measured in seconds. For example::
2191
2192 >>> u = urllib2.urlopen("http://slow.example.com", timeout=3)
2193 Traceback (most recent call last):
2194 ...
2195 urllib2.URLError: <urlopen error timed out>
2196 >>>
2197
2198 (Added by Facundo Batista.)
2199
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002200* The :mod:`warnings` module's :func:`formatwarning` and :func:`showwarning`
2201 gained an optional *line* argument that can be used to supply the
2202 line of source code. (Added as part of :issue:`1631171`, which re-implemented
2203 part of the :mod:`warnings` module in C code.)
2204
2205* The XML-RPC :class:`SimpleXMLRPCServer` and :class:`DocXMLRPCServer`
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002206 classes can now be prevented from immediately opening and binding to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002207 their socket by passing True as the ``bind_and_activate``
2208 constructor parameter. This can be used to modify the instance's
2209 :attr:`allow_reuse_address` attribute before calling the
2210 :meth:`server_bind` and :meth:`server_activate` methods to
2211 open the socket and begin listening for connections.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002212 (Contributed by Peter Parente; :issue:`1599845`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002213
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002214 :class:`SimpleXMLRPCServer` also has a :attr:`_send_traceback_header`
2215 attribute; if true, the exception and formatted traceback are returned
2216 as HTTP headers "X-Exception" and "X-Traceback". This feature is
2217 for debugging purposes only and should not be used on production servers
2218 because the tracebacks could possibly reveal passwords or other sensitive
2219 information. (Contributed by Alan McIntyre as part of his
2220 project for Google's Summer of Code 2007.)
2221
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002222* The :mod:`xmlrpclib` module no longer automatically converts
2223 :class:`datetime.date` and :class:`datetime.time` to the
2224 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2225 not necessarily correct for all applications. Code using
2226 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
2227 instances. (:issue:`1330538`) The code can also handle
2228 dates before 1900. (Contributed by Ralf Schmitt; :issue:`2014`.)
2229
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002230* The :mod:`zipfile` module's :class:`ZipFile` class now has
2231 :meth:`extract` and :meth:`extractall` methods that will unpack
2232 a single file or all the files in the archive to the current directory, or
2233 to a specified directory::
2234
2235 z = zipfile.ZipFile('python-251.zip')
2236
2237 # Unpack a single file, writing it relative to the /tmp directory.
2238 z.extract('Python/sysmodule.c', '/tmp')
2239
2240 # Unpack all the files in the archive.
2241 z.extractall()
2242
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002243 (Contributed by Alan McIntyre; :issue:`467924`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002244
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002245 Also, :mod:`zipfile` now supports using Unicode filenames
2246 for archived files. (Contributed by Alexey Borzenkov; :issue:`1734346`.)
2247
Georg Brandlb19be572007-12-29 10:57:00 +00002248.. ======================================================================
2249.. whole new modules get described in subsections here
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002250
Brett Cannon4b964f92008-05-05 20:21:38 +00002251The :mod:`json` module
2252----------------------
2253
2254The new :mod:`json` module supports the encoding and decoding of Python types in
2255JSON (Javascript Object Notation). JSON is a lightweight interchange format
2256often used in web applications. For more information about JSON, see
2257http://www.json.org.
2258
2259:mod:`json` comes with support for decoding and encoding most builtin Python
2260types. The following example encodes and decodes a dictionary::
2261
2262 >>> import json
2263 >>> data = {"spam" : "foo", "parrot" : 42}
2264 >>> in_json = json.dumps(data) # Encode the data
2265 >>> in_json
2266 '{"parrot": 42, "spam": "foo"}'
2267 >>> json.loads(in_json) # Decode into a Python object
2268 {"spam" : "foo", "parrot" : 42}
2269
2270It is also possible to write your own decoders and encoders to support more
2271types. Pretty-printing of the JSON strings is also supported.
2272
2273:mod:`json` (originally called simplejson) was written by Bob Ippolito.
2274
2275
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002276Improved SSL Support
Andrew M. Kuchling27a44982007-10-20 19:39:35 +00002277--------------------------------------------------
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002278
2279Bill Janssen made extensive improvements to Python 2.6's support for
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002280the Secure Sockets Layer by adding a new module, :mod:`ssl`, on top of
2281the `OpenSSL <http://www.openssl.org/>`__ library. This new module
2282provides more control over the protocol negotiated, the X.509
2283certificates used, and has better support for writing SSL servers (as
2284opposed to clients) in Python. The existing SSL support in the
2285:mod:`socket` module hasn't been removed and continues to work,
2286though it will be removed in Python 3.0.
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002287
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002288To use the new module, first you must create a TCP connection in the
2289usual way and then pass it to the :func:`ssl.wrap_socket` function.
Andrew M. Kuchling805cdd82008-04-29 02:03:54 +00002290It's possible to specify whether a certificate is required, and to
2291obtain certificate info by calling the :meth:`getpeercert` method.
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002292
2293.. seealso::
2294
Andrew M. Kuchling805cdd82008-04-29 02:03:54 +00002295 The documentation for the :mod:`ssl` module.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002296
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002297
2298.. ======================================================================
2299
2300plistlib: A Property-List Parser
2301--------------------------------------------------
2302
2303A commonly-used format on MacOS X is the ``.plist`` format,
2304which stores basic data types (numbers, strings, lists,
2305and dictionaries) and serializes them into an XML-based format.
2306(It's a lot like the XML-RPC serialization of data types.)
2307
2308Despite being primarily used on MacOS X, the format
2309has nothing Mac-specific about it and the Python implementation works
2310on any platform that Python supports, so the :mod:`plistlib` module
2311has been promoted to the standard library.
2312
2313Using the module is simple::
2314
2315 import sys
2316 import plistlib
2317 import datetime
2318
2319 # Create data structure
2320 data_struct = dict(lastAccessed=datetime.datetime.now(),
2321 version=1,
2322 categories=('Personal', 'Shared', 'Private'))
2323
2324 # Create string containing XML.
2325 plist_str = plistlib.writePlistToString(data_struct)
2326 new_struct = plistlib.readPlistFromString(plist_str)
2327 print data_struct
2328 print new_struct
2329
2330 # Write data structure to a file and read it back.
2331 plistlib.writePlist(data_struct, '/tmp/customizations.plist')
2332 new_struct = plistlib.readPlist('/tmp/customizations.plist')
2333
2334 # read/writePlist accepts file-like objects as well as paths.
2335 plistlib.writePlist(data_struct, sys.stdout)
2336
2337
Georg Brandlb19be572007-12-29 10:57:00 +00002338.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002339
2340
2341Build and C API Changes
2342=======================
2343
2344Changes to Python's build process and to the C API include:
2345
Andrew M. Kuchlingf7b462f2007-11-23 13:37:39 +00002346* Python 2.6 can be built with Microsoft Visual Studio 2008.
2347 See the :file:`PCbuild9` directory for the build files.
2348 (Implemented by Christian Heimes.)
2349
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002350* Python now can only be compiled with C89 compilers (after 19
2351 years!). This means that the Python source tree can now drop its
2352 own implementations of :cfunc:`memmove` and :cfunc:`strerror`, which
2353 are in the C89 standard library.
2354
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002355* The BerkeleyDB module now has a C API object, available as
2356 ``bsddb.db.api``. This object can be used by other C extensions
2357 that wish to use the :mod:`bsddb` module for their own purposes.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002358 (Contributed by Duncan Grisby; :issue:`1551895`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002359
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002360* The new buffer interface, previously described in
2361 `the PEP 3118 section <#pep-3118-revised-buffer-protocol>`__,
2362 adds :cfunc:`PyObject_GetBuffer` and :cfunc:`PyObject_ReleaseBuffer`,
2363 as well as a few other functions.
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002364
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002365* Python's use of the C stdio library is now thread-safe, or at least
2366 as thread-safe as the underlying library is. A long-standing potential
2367 bug occurred if one thread closed a file object while another thread
2368 was reading from or writing to the object. In 2.6 file objects
2369 have a reference count, manipulated by the
2370 :cfunc:`PyFile_IncUseCount` and :cfunc:`PyFile_DecUseCount`
2371 functions. File objects can't be closed unless the reference count
2372 is zero. :cfunc:`PyFile_IncUseCount` should be called while the GIL
2373 is still held, before carrying out an I/O operation using the
2374 ``FILE *`` pointer, and :cfunc:`PyFile_DecUseCount` should be called
2375 immediately after the GIL is re-acquired.
2376 (Contributed by Antoine Pitrou and Gregory P. Smith.)
2377
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002378* Importing modules simultaneously in two different threads no longer
2379 deadlocks; it will now raise an :exc:`ImportError`. A new API
2380 function, :cfunc:`PyImport_ImportModuleNoBlock`, will look for a
2381 module in ``sys.modules`` first, then try to import it after
2382 acquiring an import lock. If the import lock is held by another
2383 thread, the :exc:`ImportError` is raised.
2384 (Contributed by Christian Heimes.)
2385
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002386* Several functions return information about the platform's
2387 floating-point support. :cfunc:`PyFloat_GetMax` returns
2388 the maximum representable floating point value,
2389 and :cfunc:`PyFloat_GetMin` returns the minimum
2390 positive value. :cfunc:`PyFloat_GetInfo` returns a dictionary
2391 containing more information from the :file:`float.h` file, such as
2392 ``"mant_dig"`` (number of digits in the mantissa), ``"epsilon"``
2393 (smallest difference between 1.0 and the next largest value
2394 representable), and several others.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002395 (Contributed by Christian Heimes; :issue:`1534`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002396
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002397* Python's C API now includes two functions for case-insensitive string
Georg Brandl907a7202008-02-22 12:31:45 +00002398 comparisons, ``PyOS_stricmp(char*, char*)``
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002399 and ``PyOS_strnicmp(char*, char*, Py_ssize_t)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002400 (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002401
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002402* Many C extensions define their own little macro for adding
2403 integers and strings to the module's dictionary in the
2404 ``init*`` function. Python 2.6 finally defines standard macros
2405 for adding values to a module, :cmacro:`PyModule_AddStringMacro`
2406 and :cmacro:`PyModule_AddIntMacro()`. (Contributed by
2407 Christian Heimes.)
2408
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002409* Some macros were renamed in both 3.0 and 2.6 to make it clearer that
2410 they are macros,
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00002411 not functions. :cmacro:`Py_Size()` became :cmacro:`Py_SIZE()`,
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002412 :cmacro:`Py_Type()` became :cmacro:`Py_TYPE()`, and
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002413 :cmacro:`Py_Refcnt()` became :cmacro:`Py_REFCNT()`.
2414 The mixed-case macros are still available
2415 in Python 2.6 for backward compatibility.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002416 (:issue:`1629`)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002417
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002418* Distutils now places C extensions it builds in a
2419 different directory when running on a debug version of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002420 (Contributed by Collin Winter; :issue:`1530959`.)
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002421
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002422* Several basic data types, such as integers and strings, maintain
2423 internal free lists of objects that can be re-used. The data
2424 structures for these free lists now follow a naming convention: the
2425 variable is always named ``free_list``, the counter is always named
2426 ``numfree``, and a macro :cmacro:`Py<typename>_MAXFREELIST` is
2427 always defined.
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002428
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002429* A new Makefile target, "make check", prepares the Python source tree
2430 for making a patch: it fixes trailing whitespace in all modified
2431 ``.py`` files, checks whether the documentation has been changed,
2432 and reports whether the :file:`Misc/ACKS` and :file:`Misc/NEWS` files
2433 have been updated.
2434 (Contributed by Brett Cannon.)
2435
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002436 Another new target, "make profile-opt", compiles a Python binary
2437 using GCC's profile-guided optimization. It compiles Python with
2438 profiling enabled, runs the test suite to obtain a set of profiling
2439 results, and then compiles using these results for optimization.
2440 (Contributed by Gregory P. Smith.)
2441
2442
Georg Brandlb19be572007-12-29 10:57:00 +00002443.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002444
2445
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002446Port-Specific Changes: Windows
2447-----------------------------------
2448
Christian Heimes7e3ab452008-05-04 11:50:53 +00002449* The support for Windows 95, 98, ME and NT4 has been dropped.
2450 Python 2.6 requires at least Windows 2000 SP4.
2451
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002452* The :mod:`msvcrt` module now supports
2453 both the normal and wide char variants of the console I/O
2454 API. The :func:`getwch` function reads a keypress and returns a Unicode
2455 value, as does the :func:`getwche` function. The :func:`putwch` function
2456 takes a Unicode character and writes it to the console.
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002457 (Contributed by Christian Heimes.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002458
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00002459* :func:`os.path.expandvars` will now expand environment variables
2460 in the form "%var%", and "~user" will be expanded into the
2461 user's home directory path. (Contributed by Josiah Carlson.)
2462
2463* The :mod:`socket` module's socket objects now have an
2464 :meth:`ioctl` method that provides a limited interface to the
2465 :cfunc:`WSAIoctl` system interface.
2466
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002467* The :mod:`_winreg` module now has a function,
2468 :func:`ExpandEnvironmentStrings`,
2469 that expands environment variable references such as ``%NAME%``
2470 in an input string. The handle objects provided by this
2471 module now support the context protocol, so they can be used
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002472 in :keyword:`with` statements. (Contributed by Christian Heimes.)
2473
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002474 :mod:`_winreg` also has better support for x64 systems,
2475 exposing the :func:`DisableReflectionKey`, :func:`EnableReflectionKey`,
2476 and :func:`QueryReflectionKey` functions, which enable and disable
2477 registry reflection for 32-bit processes running on 64-bit systems.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002478 (:issue:`1753245`)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002479
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002480* The new default compiler on Windows is Visual Studio 2008 (VS 9.0). The
2481 build directories for Visual Studio 2003 (VS7.1) and 2005 (VS8.0)
2482 were moved into the PC/ directory. The new PCbuild directory supports
2483 cross compilation for X64, debug builds and Profile Guided Optimization
2484 (PGO). PGO builds are roughly 10% faster than normal builds.
2485 (Contributed by Christian Heimes with help from Amaury Forgeot d'Arc and
2486 Martin von Loewis.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002487
Georg Brandlb19be572007-12-29 10:57:00 +00002488.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002489
2490
2491.. _section-other:
2492
2493Other Changes and Fixes
2494=======================
2495
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002496As usual, there were a bunch of other improvements and bugfixes
2497scattered throughout the source tree. A search through the change
2498logs finds there were XXX patches applied and YYY bugs fixed between
2499Python 2.5 and 2.6. Both figures are likely to be underestimates.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002500
2501Some of the more notable changes are:
2502
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002503* It's now possible to prevent Python from writing any :file:`.pyc`
2504 or :file:`.pyo` files by either supplying the :option:`-B` switch
2505 or setting the :envvar:`PYTHONDONTWRITEBYTECODE` environment variable
2506 to any non-empty string when running the Python interpreter. These
Georg Brandlca9c6e42008-01-15 06:58:15 +00002507 are also used to set the :data:`sys.dont_write_bytecode` attribute;
2508 Python code can change this variable to control whether bytecode
2509 files are subsequently written.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002510 (Contributed by Neal Norwitz and Georg Brandl.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002511
Georg Brandlb19be572007-12-29 10:57:00 +00002512.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002513
2514
2515Porting to Python 2.6
2516=====================
2517
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002518This section lists previously described changes and other bugfixes
2519that may require changes to your code:
Georg Brandl8ec7f652007-08-15 14:28:01 +00002520
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00002521* The :meth:`__init__` method of :class:`collections.deque`
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002522 now clears any existing contents of the deque
2523 before adding elements from the iterable. This change makes the
2524 behavior match that of ``list.__init__()``.
2525
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002526* The :class:`Decimal` constructor now accepts leading and trailing
2527 whitespace when passed a string. Previously it would raise an
2528 :exc:`InvalidOperation` exception. On the other hand, the
2529 :meth:`create_decimal` method of :class:`Context` objects now
2530 explicitly disallows extra whitespace, raising a
2531 :exc:`ConversionSyntax` exception.
2532
2533* Due to an implementation accident, if you passed a file path to
2534 the built-in :func:`__import__` function, it would actually import
2535 the specified file. This was never intended to work, however, and
2536 the implementation now explicitly checks for this case and raises
2537 an :exc:`ImportError`.
2538
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002539* C API: the :cfunc:`PyImport_Import` and :cfunc:`PyImport_ImportModule`
2540 functions now default to absolute imports, not relative imports.
2541 This will affect C extensions that import other modules.
2542
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002543* The :mod:`socket` module exception :exc:`socket.error` now inherits
2544 from :exc:`IOError`. Previously it wasn't a subclass of
2545 :exc:`StandardError` but now it is, through :exc:`IOError`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002546 (Implemented by Gregory P. Smith; :issue:`1706815`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002547
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002548* The :mod:`xmlrpclib` module no longer automatically converts
2549 :class:`datetime.date` and :class:`datetime.time` to the
2550 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2551 not necessarily correct for all applications. Code using
2552 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002553 instances. (:issue:`1330538`)
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002554
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002555* (3.0-warning mode) The :class:`Exception` class now warns
2556 when accessed using slicing or index access; having
2557 :class:`Exception` behave like a tuple is being phased out.
2558
2559* (3.0-warning mode) inequality comparisons between two dictionaries
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002560 or two objects that don't implement comparison methods are reported
2561 as warnings. ``dict1 == dict2`` still works, but ``dict1 < dict2``
2562 is being phased out.
2563
2564 Comparisons between cells, which are an implementation detail of Python's
2565 scoping rules, also cause warnings because such comparisons are forbidden
2566 entirely in 3.0.
2567
Georg Brandlb19be572007-12-29 10:57:00 +00002568.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002569
2570
2571.. _acks:
2572
2573Acknowledgements
2574================
2575
2576The author would like to thank the following people for offering suggestions,
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002577corrections and assistance with various drafts of this article:
2578Georg Brandl, Jim Jewett.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002579