blob: 6f1f157699ad832da2946824ea4e50afc4e0b7e7 [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001****************************
Georg Brandle152a772008-05-24 18:31:28 +00002 What's New in Python 2.6
Georg Brandl8ec7f652007-08-15 14:28:01 +00003****************************
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:
Georg Brandle152a772008-05-24 18:31:28 +000013
Georg Brandlb19be572007-12-29 10:57:00 +000014 * 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.
Georg Brandle152a772008-05-24 18:31:28 +000017
Georg Brandlb19be572007-12-29 10:57:00 +000018 * 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.
Georg Brandle152a772008-05-24 18:31:28 +000021
Georg Brandlb19be572007-12-29 10:57:00 +000022 * 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.)
Georg Brandle152a772008-05-24 18:31:28 +000027
Georg Brandlb19be572007-12-29 10:57:00 +000028 * 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.
Georg Brandle152a772008-05-24 18:31:28 +000031
Georg Brandlb19be572007-12-29 10:57:00 +000032 * 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.
Georg Brandle152a772008-05-24 18:31:28 +000036
Georg Brandlb19be572007-12-29 10:57:00 +000037 * You can comment out your additions if you like, but it's not
38 necessary (especially when a final release is some months away).
Georg Brandle152a772008-05-24 18:31:28 +000039
Georg Brandlb19be572007-12-29 10:57:00 +000040 * Credit the author of a patch or bugfix. Just the name is
41 sufficient; the e-mail address isn't necessary.
Georg Brandle152a772008-05-24 18:31:28 +000042
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000043 * It's helpful to add the bug/patch number in a parenthetical comment.
Georg Brandle152a772008-05-24 18:31:28 +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 Brandle152a772008-05-24 18:31:28 +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
Georg Brandle152a772008-05-24 18:31:28 +000077alphas of Python 3.0, and the development of 3.0 has influenced
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +000078a 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
Georg Brandle152a772008-05-24 18:31:28 +000086document in the appropriate place. Some of the 3.0-derived features
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +000087are:
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
Georg Brandle152a772008-05-24 18:31:28 +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
Georg Brandle152a772008-05-24 18:31:28 +0000119While 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
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000122Roundup 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
Georg Brandle152a772008-05-24 18:31:28 +0000138<http://www.atlassian.com/software/jira/>`__,
139`Launchpad <http://www.launchpad.net>`__,
140`Roundup <http://roundup.sourceforge.net/>`__, and
141`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
Georg Brandle152a772008-05-24 18:31:28 +0000144offers a no-cost hosted instance to free-software projects; Roundup
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000145is 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
Georg Brandle152a772008-05-24 18:31:28 +0000151for 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
Georg Brandle152a772008-05-24 18:31:28 +0000156Hosting is kindly provided by
157`Upfront Systems <http://www.upfrontsystems.co.za/>`__
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000158of 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
Georg Brandle152a772008-05-24 18:31:28 +0000160SourceForge; his scripts for this import operation are at
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000161http://svn.python.org/view/tracker/importer/.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000162
163.. seealso::
164
Georg Brandle152a772008-05-24 18:31:28 +0000165 http://bugs.python.org
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000166 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.
Georg Brandle152a772008-05-24 18:31:28 +0000192Occasionally people would suggest converting the documentation into
193SGML or, later, XML, but performing a good conversion is a major task
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000194and 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
Georg Brandle152a772008-05-24 18:31:28 +0000225keyword. The rest of this section is a copy of the corresponding
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000226section 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
Georg Brandle152a772008-05-24 18:31:28 +0000521
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000522.. ======================================================================
523
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000524.. _pep-0371:
525
526PEP 371: The ``multiprocessing`` Package
527=====================================================
528
529XXX write this.
530
531.. seealso::
532
Benjamin Peterson2b917c92008-06-24 02:41:08 +0000533 :pep:`371` - Addition of the multiprocessing package
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000534 PEP written by Jesse Noller and Richard Oudkerk;
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +0000535 implemented by Richard Oudkerk and Jesse Noller.
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000536
537.. ======================================================================
538
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000539.. _pep-3101:
540
541PEP 3101: Advanced String Formatting
542=====================================================
543
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000544In Python 3.0, the `%` operator is supplemented by a more powerful string
545formatting method, :meth:`format`. Support for the :meth:`str.format` method
546has been backported to Python 2.6.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000547
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000548In 2.6, both 8-bit and Unicode strings have a `.format()` method that
549treats the string as a template and takes the arguments to be formatted.
550The formatting template uses curly brackets (`{`, `}`) as special characters::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000551
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000552 # Substitute positional argument 0 into the string.
553 "User ID: {0}".format("root") -> "User ID: root"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000554
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000555 # Use the named keyword arguments
556 uid = 'root'
Georg Brandle152a772008-05-24 18:31:28 +0000557
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000558 'User ID: {uid} Last seen: {last_login}'.format(uid='root',
559 last_login = '5 Mar 2008 07:20') ->
560 'User ID: root Last seen: 5 Mar 2008 07:20'
561
562Curly brackets can be escaped by doubling them::
563
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000564 format("Empty dict: {{}}") -> "Empty dict: {}"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000565
Georg Brandle152a772008-05-24 18:31:28 +0000566Field names can be integers indicating positional arguments, such as
567``{0}``, ``{1}``, etc. or names of keyword arguments. You can also
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000568supply compound field names that read attributes or access dictionary keys::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000569
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000570 import sys
571 'Platform: {0.platform}\nPython version: {0.version}'.format(sys) ->
572 'Platform: darwin\n
573 Python version: 2.6a1+ (trunk:61261M, Mar 5 2008, 20:29:41) \n
574 [GCC 4.0.1 (Apple Computer, Inc. build 5367)]'
575
576 import mimetypes
577 'Content-type: {0[.mp4]}'.format(mimetypes.types_map) ->
578 'Content-type: video/mp4'
579
580Note that when using dictionary-style notation such as ``[.mp4]``, you
581don't need to put any quotation marks around the string; it will look
582up the value using ``.mp4`` as the key. Strings beginning with a
583number will be converted to an integer. You can't write more
584complicated expressions inside a format string.
585
586So far we've shown how to specify which field to substitute into the
587resulting string. The precise formatting used is also controllable by
Georg Brandl859043c2008-03-21 17:19:29 +0000588adding a colon followed by a format specifier. For example::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000589
590 # Field 0: left justify, pad to 15 characters
591 # Field 1: right justify, pad to 6 characters
592 fmt = '{0:15} ${1:>6}'
593 fmt.format('Registration', 35) ->
594 'Registration $ 35'
595 fmt.format('Tutorial', 50) ->
596 'Tutorial $ 50'
597 fmt.format('Banquet', 125) ->
598 'Banquet $ 125'
599
Georg Brandl859043c2008-03-21 17:19:29 +0000600Format specifiers can reference other fields through nesting::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000601
602 fmt = '{0:{1}}'
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000603 fmt.format('Invoice #1234', 15) ->
604 'Invoice #1234 '
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000605 width = 35
606 fmt.format('Invoice #1234', width) ->
607 'Invoice #1234 '
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000608
609The alignment of a field within the desired width can be specified:
610
611================ ============================================
612Character Effect
613================ ============================================
614< (default) Left-align
615> Right-align
616^ Center
617= (For numeric types only) Pad after the sign.
618================ ============================================
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000619
Georg Brandle152a772008-05-24 18:31:28 +0000620Format specifiers can also include a presentation type, which
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000621controls how the value is formatted. For example, floating-point numbers
622can be formatted as a general number or in exponential notation:
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000623
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000624 >>> '{0:g}'.format(3.75)
625 '3.75'
626 >>> '{0:e}'.format(3.75)
627 '3.750000e+00'
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000628
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000629A variety of presentation types are available. Consult the 2.6
Georg Brandle321c2f2008-05-12 16:45:43 +0000630documentation for a :ref:`complete list <formatstrings>`; here's a sample::
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000631
632 'b' - Binary. Outputs the number in base 2.
633 'c' - Character. Converts the integer to the corresponding
634 Unicode character before printing.
635 'd' - Decimal Integer. Outputs the number in base 10.
636 'o' - Octal format. Outputs the number in base 8.
637 'x' - Hex format. Outputs the number in base 16, using lower-
638 case letters for the digits above 9.
639 'e' - Exponent notation. Prints the number in scientific
640 notation using the letter 'e' to indicate the exponent.
641 'g' - General format. This prints the number as a fixed-point
642 number, unless the number is too large, in which case
643 it switches to 'e' exponent notation.
Eric Smith103f19d2008-05-12 14:00:01 +0000644 'n' - Number. This is the same as 'g' (for floats) or 'd' (for
645 integers), except that it uses the current locale setting to
646 insert the appropriate number separator characters.
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000647 '%' - Percentage. Multiplies the number by 100 and displays
648 in fixed ('f') format, followed by a percent sign.
649
650Classes and types can define a __format__ method to control how they're
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000651formatted. It receives a single argument, the format specifier::
652
653 def __format__(self, format_spec):
654 if isinstance(format_spec, unicode):
655 return unicode(str(self))
656 else:
657 return str(self)
658
659There's also a format() built-in that will format a single value. It calls
660the type's :meth:`__format__` method with the provided specifier::
661
662 >>> format(75.6564, '.2f')
663 '75.66'
664
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +0000665
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000666.. seealso::
667
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000668 :ref:`formatstrings`
669 The reference format fields.
670
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000671 :pep:`3101` - Advanced String Formatting
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000672 PEP written by Talin. Implemented by Eric Smith.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000673
674.. ======================================================================
675
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000676.. _pep-3105:
677
678PEP 3105: ``print`` As a Function
679=====================================================
680
681The ``print`` statement becomes the :func:`print` function in Python 3.0.
Georg Brandle152a772008-05-24 18:31:28 +0000682Making :func:`print` a function makes it easier to change
683by doing 'def print(...)' or importing a new function from somewhere else.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000684
Georg Brandle152a772008-05-24 18:31:28 +0000685Python 2.6 has a ``__future__`` import that removes ``print`` as language
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000686syntax, letting you use the functional form instead. For example::
687
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000688 from __future__ import print_function
689 print('# of entries', len(dictionary), file=sys.stderr)
690
691The signature of the new function is::
692
693 def print(*args, sep=' ', end='\n', file=None)
694
695The parameters are:
696
697 * **args**: positional arguments whose values will be printed out.
698 * **sep**: the separator, which will be printed between arguments.
Georg Brandle152a772008-05-24 18:31:28 +0000699 * **end**: the ending text, which will be printed after all of the
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000700 arguments have been output.
701 * **file**: the file object to which the output will be sent.
702
703.. seealso::
704
Eric Smith33dd0942008-03-20 23:04:04 +0000705 :pep:`3105` - Make print a function
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000706 PEP written by Georg Brandl.
707
708.. ======================================================================
709
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000710.. _pep-3110:
711
712PEP 3110: Exception-Handling Changes
713=====================================================
714
Georg Brandle152a772008-05-24 18:31:28 +0000715One error that Python programmers occasionally make
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000716is the following::
717
718 try:
719 ...
720 except TypeError, ValueError:
721 ...
722
Georg Brandle152a772008-05-24 18:31:28 +0000723The author is probably trying to catch both
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000724:exc:`TypeError` and :exc:`ValueError` exceptions, but this code
Georg Brandle152a772008-05-24 18:31:28 +0000725actually does something different: it will catch
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000726:exc:`TypeError` and bind the resulting exception object
Georg Brandle152a772008-05-24 18:31:28 +0000727to the local name ``"ValueError"``. The correct code
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000728would have specified a tuple::
729
730 try:
731 ...
732 except (TypeError, ValueError):
733 ...
734
735This error is possible because the use of the comma here is ambiguous:
736does it indicate two different nodes in the parse tree, or a single
737node that's a tuple.
738
739Python 3.0 changes the syntax to make this unambiguous by replacing
Georg Brandle152a772008-05-24 18:31:28 +0000740the comma with the word "as". To catch an exception and store the
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000741exception object in the variable ``exc``, you must write::
742
743 try:
744 ...
745 except TypeError as exc:
746 ...
747
748Python 3.0 will only support the use of "as", and therefore interprets
749the first example as catching two different exceptions. Python 2.6
750supports both the comma and "as", so existing code will continue to
751work.
752
753.. seealso::
754
755 :pep:`3110` - Catching Exceptions in Python 3000
756 PEP written and implemented by Collin Winter.
757
Georg Brandlb19be572007-12-29 10:57:00 +0000758.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000759
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000760.. _pep-3112:
761
762PEP 3112: Byte Literals
763=====================================================
764
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000765Python 3.0 adopts Unicode as the language's fundamental string type and
Georg Brandle152a772008-05-24 18:31:28 +0000766denotes 8-bit literals differently, either as ``b'string'``
767or using a :class:`bytes` constructor. For future compatibility,
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000768Python 2.6 adds :class:`bytes` as a synonym for the :class:`str` type,
769and it also supports the ``b''`` notation.
770
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000771There's also a ``__future__`` import that causes all string literals
Georg Brandle152a772008-05-24 18:31:28 +0000772to become Unicode strings. This means that ``\u`` escape sequences
Benjamin Peterson83343302008-05-04 03:05:49 +0000773can be used to include Unicode characters::
774
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000775
Andrew M. Kuchlingda950eb2008-04-13 22:39:12 +0000776 from __future__ import unicode_literals
777
778 s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
779 '\u3081\u3000\u751f\u305f\u307e\u3054')
780
781 print len(s) # 12 Unicode characters
782
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000783At the C level, Python 3.0 will rename the existing 8-bit
784string type, called :ctype:`PyStringObject` in Python 2.x,
785to :ctype:`PyBytesObject`. Python 2.6 uses ``#define``
786to support using the names :cfunc:`PyBytesObject`,
787:cfunc:`PyBytes_Check`, :cfunc:`PyBytes_FromStringAndSize`,
788and all the other functions and macros used with strings.
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000789
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000790Instances of the :class:`bytes` type are immutable just
791as strings are. A new :class:`bytearray` type stores a mutable
792sequence of bytes::
793
794 >>> bytearray([65, 66, 67])
795 bytearray(b'ABC')
796 >>> b = bytearray(u'\u21ef\u3244', 'utf-8')
797 >>> b
798 bytearray(b'\xe2\x87\xaf \xe3\x89\x84')
799 >>> b[0] = '\xe3'
800 >>> b
801 bytearray(b'\xe3\x87\xaf \xe3\x89\x84')
802 >>> unicode(str(b), 'utf-8')
803 u'\u31ef \u3244'
804
805Byte arrays support most of the methods of string types, such as
806:meth:`startswith`/:meth:`endswith`, :meth:`find`/:meth:`rfind`,
807and some of the methods of lists, such as :meth:`append`,
808:meth:`pop`, and :meth:`reverse`.
809
810 >>> b = bytearray('ABC')
811 >>> b.append('d')
812 >>> b.append(ord('e'))
813 >>> b
814 bytearray(b'ABCde')
Benjamin Peterson83343302008-05-04 03:05:49 +0000815
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000816.. seealso::
817
818 :pep:`3112` - Bytes literals in Python 3000
819 PEP written by Jason Orendorff; backported to 2.6 by Christian Heimes.
820
821.. ======================================================================
822
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000823.. _pep-3116:
824
825PEP 3116: New I/O Library
826=====================================================
827
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000828Python's built-in file objects support a number of methods, but
829file-like objects don't necessarily support all of them. Objects that
830imitate files usually support :meth:`read` and :meth:`write`, but they
831may not support :meth:`readline`. Python 3.0 introduces a layered I/O
832library in the :mod:`io` module that separates buffering and
833text-handling features from the fundamental read and write operations.
834
835There are three levels of abstract base classes provided by
836the :mod:`io` module:
837
838* :class:`RawIOBase`: defines raw I/O operations: :meth:`read`,
Georg Brandle152a772008-05-24 18:31:28 +0000839 :meth:`readinto`,
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000840 :meth:`write`, :meth:`seek`, :meth:`tell`, :meth:`truncate`,
841 and :meth:`close`.
842 Most of the methods of this class will often map to a single system call.
843 There are also :meth:`readable`, :meth:`writable`, and :meth:`seekable`
844 methods for determining what operations a given object will allow.
845
846 Python 3.0 has concrete implementations of this class for files and
847 sockets, but Python 2.6 hasn't restructured its file and socket objects
848 in this way.
849
850 .. XXX should 2.6 register them in io.py?
851
Georg Brandle152a772008-05-24 18:31:28 +0000852* :class:`BufferedIOBase`: is an abstract base class that
853 buffers data in memory to reduce the number of
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000854 system calls used, making I/O processing more efficient.
Georg Brandle152a772008-05-24 18:31:28 +0000855 It supports all of the methods of :class:`RawIOBase`,
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000856 and adds a :attr:`raw` attribute holding the underlying raw object.
857
858 There are four concrete classes implementing this ABC:
Georg Brandle152a772008-05-24 18:31:28 +0000859 :class:`BufferedWriter` and
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000860 :class:`BufferedReader` for objects that only support
861 writing or reading and don't support random access,
862 :class:`BufferedRandom` for objects that support the :meth:`seek` method
863 for random access,
Georg Brandle152a772008-05-24 18:31:28 +0000864 and :class:`BufferedRWPair` for objects such as TTYs that have
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000865 both read and write operations that act upon unconnected streams of data.
866
867* :class:`TextIOBase`: Provides functions for reading and writing
868 strings (remember, strings will be Unicode in Python 3.0),
Georg Brandle152a772008-05-24 18:31:28 +0000869 and supporting universal newlines. :class:`TextIOBase` defines
870 the :meth:`readline` method and supports iteration upon
871 objects.
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000872
873 There are two concrete implementations. :class:`TextIOWrapper`
874 wraps a buffered I/O object, supporting all of the methods for
Georg Brandle152a772008-05-24 18:31:28 +0000875 text I/O and adding a :attr:`buffer` attribute for access
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000876 to the underlying object. :class:`StringIO` simply buffers
877 everything in memory without ever writing anything to disk.
878
879 (In current 2.6 alpha releases, :class:`io.StringIO` is implemented in
Georg Brandle152a772008-05-24 18:31:28 +0000880 pure Python, so it's pretty slow. You should therefore stick with the
881 existing :mod:`StringIO` module or :mod:`cStringIO` for now. At some
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000882 point Python 3.0's :mod:`io` module will be rewritten into C for speed,
883 and perhaps the C implementation will be backported to the 2.x releases.)
884
885 .. XXX check before final release: is io.py still written in Python?
886
887In Python 2.6, the underlying implementations haven't been
888restructured to build on top of the :mod:`io` module's classes. The
Georg Brandle152a772008-05-24 18:31:28 +0000889module is being provided to make it easier to write code that's
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000890forward-compatible with 3.0, and to save developers the effort of writing
891their own implementations of buffering and text I/O.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000892
893.. seealso::
894
895 :pep:`3116` - New I/O
896 PEP written by Daniel Stutzbach, Mike Verdone, and Guido van Rossum.
Andrew M. Kuchling04f58762008-04-15 02:24:15 +0000897 Code by Guido van Rossum, Georg Brandl, Walter Doerwald,
898 Jeremy Hylton, Martin von Loewis, Tony Lownds, and others.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000899
900.. ======================================================================
901
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000902.. _pep-3118:
903
904PEP 3118: Revised Buffer Protocol
905=====================================================
906
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000907The buffer protocol is a C-level API that lets Python types
Georg Brandle152a772008-05-24 18:31:28 +0000908exchange pointers into their internal representations. A
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000909memory-mapped file can be viewed as a buffer of characters, for
910example, and this lets another module such as :mod:`re`
911treat memory-mapped files as a string of characters to be searched.
912
913The primary users of the buffer protocol are numeric-processing
914packages such as NumPy, which can expose the internal representation
915of arrays so that callers can write data directly into an array instead
Georg Brandle152a772008-05-24 18:31:28 +0000916of going through a slower API. This PEP updates the buffer protocol in light of experience
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000917from NumPy development, adding a number of new features
Georg Brandle152a772008-05-24 18:31:28 +0000918such as indicating the shape of an array,
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000919locking memory .
920
Georg Brandle152a772008-05-24 18:31:28 +0000921The most important new C API function is
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000922``PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)``, which
923takes an object and a set of flags, and fills in the
Georg Brandle152a772008-05-24 18:31:28 +0000924``Py_buffer`` structure with information
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000925about the object's memory representation. Objects
Georg Brandle152a772008-05-24 18:31:28 +0000926can use this operation to lock memory in place
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000927while an external caller could be modifying the contents,
Georg Brandle152a772008-05-24 18:31:28 +0000928so there's a corresponding
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000929``PyObject_ReleaseBuffer(PyObject *obj, Py_buffer *view)`` to
930indicate that the external caller is done.
931
932The **flags** argument to :cfunc:`PyObject_GetBuffer` specifies
933constraints upon the memory returned. Some examples are:
934
935 * :const:`PyBUF_WRITABLE` indicates that the memory must be writable.
Georg Brandle152a772008-05-24 18:31:28 +0000936
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000937 * :const:`PyBUF_LOCK` requests a read-only or exclusive lock on the memory.
938
939 * :const:`PyBUF_C_CONTIGUOUS` and :const:`PyBUF_F_CONTIGUOUS`
940 requests a C-contiguous (last dimension varies the fastest) or
941 Fortran-contiguous (first dimension varies the fastest) layout.
942
943.. XXX this feature is not in 2.6 docs yet
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000944
945.. seealso::
946
947 :pep:`3118` - Revising the buffer protocol
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000948 PEP written by Travis Oliphant and Carl Banks; implemented by
949 Travis Oliphant.
Georg Brandle152a772008-05-24 18:31:28 +0000950
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000951
952.. ======================================================================
953
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000954.. _pep-3119:
955
956PEP 3119: Abstract Base Classes
957=====================================================
958
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000959Some object-oriented languages such as Java support interfaces: declarations
960that a class has a given set of methods or supports a given access protocol.
961Abstract Base Classes (or ABCs) are an equivalent feature for Python. The ABC
Georg Brandle152a772008-05-24 18:31:28 +0000962support consists of an :mod:`abc` module containing a metaclass called
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000963:class:`ABCMeta`, special handling
964of this metaclass by the :func:`isinstance` and :func:`issubclass` built-ins,
965and a collection of basic ABCs that the Python developers think will be widely
966useful.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000967
Georg Brandle152a772008-05-24 18:31:28 +0000968Let's say you have a particular class and wish to know whether it supports
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000969dictionary-style access. The phrase "dictionary-style" is vague, however.
Georg Brandle152a772008-05-24 18:31:28 +0000970It probably means that accessing items with ``obj[1]`` works.
971Does it imply that setting items with ``obj[2] = value`` works?
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000972Or that the object will have :meth:`keys`, :meth:`values`, and :meth:`items`
973methods? What about the iterative variants such as :meth:`iterkeys`? :meth:`copy`
974and :meth:`update`? Iterating over the object with :func:`iter`?
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000975
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000976Python 2.6 includes a number of different ABCs in the :mod:`collections`
977module. :class:`Iterable` indicates that a class defines :meth:`__iter__`,
978and :class:`Container` means the class supports ``x in y`` expressions
979by defining a :meth:`__contains__` method. The basic dictionary interface of
Georg Brandle152a772008-05-24 18:31:28 +0000980getting items, setting items, and
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000981:meth:`keys`, :meth:`values`, and :meth:`items`, is defined by the
982:class:`MutableMapping` ABC.
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000983
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000984You can derive your own classes from a particular ABC
985to indicate they support that ABC's interface::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000986
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000987 import collections
Georg Brandle152a772008-05-24 18:31:28 +0000988
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000989 class Storage(collections.MutableMapping):
990 ...
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000991
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000992
Georg Brandle152a772008-05-24 18:31:28 +0000993Alternatively, you could write the class without deriving from
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000994the desired ABC and instead register the class by
995calling the ABC's :meth:`register` method::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000996
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000997 import collections
Georg Brandle152a772008-05-24 18:31:28 +0000998
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000999 class Storage:
1000 ...
Georg Brandle152a772008-05-24 18:31:28 +00001001
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001002 collections.MutableMapping.register(Storage)
Georg Brandle152a772008-05-24 18:31:28 +00001003
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001004For classes that you write, deriving from the ABC is probably clearer.
1005The :meth:`register` method is useful when you've written a new
1006ABC that can describe an existing type or class, or if you want
1007to declare that some third-party class implements an ABC.
1008For example, if you defined a :class:`PrintableType` ABC,
1009it's legal to do:
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001010
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001011 # Register Python's types
1012 PrintableType.register(int)
1013 PrintableType.register(float)
1014 PrintableType.register(str)
1015
Georg Brandle152a772008-05-24 18:31:28 +00001016Classes should obey the semantics specified by an ABC, but
1017Python can't check this; it's up to the class author to
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001018understand the ABC's requirements and to implement the code accordingly.
1019
1020To check whether an object supports a particular interface, you can
1021now write::
1022
1023 def func(d):
1024 if not isinstance(d, collections.MutableMapping):
Georg Brandle152a772008-05-24 18:31:28 +00001025 raise ValueError("Mapping object expected, not %r" % d)
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001026
Georg Brandle152a772008-05-24 18:31:28 +00001027(Don't feel that you must now begin writing lots of checks as in the
1028above example. Python has a strong tradition of duck-typing, where
1029explicit type-checking isn't done and code simply calls methods on
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001030an object, trusting that those methods will be there and raising an
1031exception if they aren't. Be judicious in checking for ABCs
1032and only do it where it helps.)
1033
1034You can write your own ABCs by using ``abc.ABCMeta`` as the
1035metaclass in a class definition::
1036
1037 from abc import ABCMeta
1038
1039 class Drawable():
1040 __metaclass__ = ABCMeta
Georg Brandle152a772008-05-24 18:31:28 +00001041
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001042 def draw(self, x, y, scale=1.0):
1043 pass
1044
1045 def draw_doubled(self, x, y):
1046 self.draw(x, y, scale=2.0)
1047
Georg Brandle152a772008-05-24 18:31:28 +00001048
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001049 class Square(Drawable):
1050 def draw(self, x, y, scale):
1051 ...
1052
Georg Brandle152a772008-05-24 18:31:28 +00001053
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001054In the :class:`Drawable` ABC above, the :meth:`draw_doubled` method
1055renders the object at twice its size and can be implemented in terms
1056of other methods described in :class:`Drawable`. Classes implementing
Georg Brandle152a772008-05-24 18:31:28 +00001057this ABC therefore don't need to provide their own implementation
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001058of :meth:`draw_doubled`, though they can do so. An implementation
Georg Brandle152a772008-05-24 18:31:28 +00001059of :meth:`draw` is necessary, though; the ABC can't provide
1060a useful generic implementation. You
1061can apply the ``@abstractmethod`` decorator to methods such as
1062:meth:`draw` that must be implemented; Python will
1063then raise an exception for classes that
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001064don't define the method::
1065
1066 class Drawable():
1067 __metaclass__ = ABCMeta
Georg Brandle152a772008-05-24 18:31:28 +00001068
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001069 @abstractmethod
1070 def draw(self, x, y, scale):
1071 pass
1072
Georg Brandle152a772008-05-24 18:31:28 +00001073Note that the exception is only raised when you actually
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001074try to create an instance of a subclass without the method::
1075
1076 >>> s=Square()
1077 Traceback (most recent call last):
1078 File "<stdin>", line 1, in <module>
1079 TypeError: Can't instantiate abstract class Square with abstract methods draw
Georg Brandle152a772008-05-24 18:31:28 +00001080 >>>
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001081
1082Abstract data attributes can be declared using the ``@abstractproperty`` decorator::
1083
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001084 @abstractproperty
1085 def readonly(self):
1086 return self._x
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001087
Georg Brandle152a772008-05-24 18:31:28 +00001088Subclasses must then define a :meth:`readonly` property
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001089
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001090.. seealso::
1091
1092 :pep:`3119` - Introducing Abstract Base Classes
1093 PEP written by Guido van Rossum and Talin.
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001094 Implemented by Guido van Rossum.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001095 Backported to 2.6 by Benjamin Aranguren, with Alex Martelli.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001096
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001097.. ======================================================================
1098
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001099.. _pep-3127:
1100
1101PEP 3127: Integer Literal Support and Syntax
1102=====================================================
1103
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001104Python 3.0 changes the syntax for octal (base-8) integer literals,
1105which are now prefixed by "0o" or "0O" instead of a leading zero, and
1106adds support for binary (base-2) integer literals, signalled by a "0b"
1107or "0B" prefix.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001108
Georg Brandle152a772008-05-24 18:31:28 +00001109Python 2.6 doesn't drop support for a leading 0 signalling
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001110an octal number, but it does add support for "0o" and "0b"::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001111
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001112 >>> 0o21, 2*8 + 1
1113 (17, 17)
1114 >>> 0b101111
1115 47
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001116
Georg Brandle152a772008-05-24 18:31:28 +00001117The :func:`oct` built-in still returns numbers
1118prefixed with a leading zero, and a new :func:`bin`
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001119built-in returns the binary representation for a number::
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001120
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001121 >>> oct(42)
1122 '052'
1123 >>> bin(173)
1124 '0b10101101'
1125
1126The :func:`int` and :func:`long` built-ins will now accept the "0o"
1127and "0b" prefixes when base-8 or base-2 are requested, or when the
1128**base** argument is zero (meaning the base used is determined from
1129the string):
1130
1131 >>> int ('0o52', 0)
1132 42
1133 >>> int('1101', 2)
1134 13
1135 >>> int('0b1101', 2)
1136 13
1137 >>> int('0b1101', 0)
1138 13
1139
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001140
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001141.. seealso::
1142
1143 :pep:`3127` - Integer Literal Support and Syntax
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001144 PEP written by Patrick Maupin; backported to 2.6 by
1145 Eric Smith.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001146
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001147.. ======================================================================
1148
1149.. _pep-3129:
1150
1151PEP 3129: Class Decorators
1152=====================================================
1153
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001154Decorators have been extended from functions to classes. It's now legal to
1155write::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001156
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001157 @foo
1158 @bar
1159 class A:
1160 pass
1161
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001162This is equivalent to::
1163
1164 class A:
1165 pass
1166
1167 A = foo(bar(A))
1168
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001169.. seealso::
1170
1171 :pep:`3129` - Class Decorators
1172 PEP written by Collin Winter.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001173
1174.. ======================================================================
1175
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001176.. _pep-3141:
1177
1178PEP 3141: A Type Hierarchy for Numbers
1179=====================================================
1180
1181In Python 3.0, several abstract base classes for numeric types,
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001182inspired by Scheme's numeric tower, are being added.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001183This change was backported to 2.6 as the :mod:`numbers` module.
1184
1185The most general ABC is :class:`Number`. It defines no operations at
1186all, and only exists to allow checking if an object is a number by
1187doing ``isinstance(obj, Number)``.
1188
1189Numbers are further divided into :class:`Exact` and :class:`Inexact`.
1190Exact numbers can represent values precisely and operations never
1191round off the results or introduce tiny errors that may break the
Georg Brandl907a7202008-02-22 12:31:45 +00001192commutativity and associativity properties; inexact numbers may
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001193perform such rounding or introduce small errors. Integers, long
Georg Brandle152a772008-05-24 18:31:28 +00001194integers, and rational numbers are exact, while floating-point
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001195and complex numbers are inexact.
1196
1197:class:`Complex` is a subclass of :class:`Number`. Complex numbers
1198can undergo the basic operations of addition, subtraction,
1199multiplication, division, and exponentiation, and you can retrieve the
Georg Brandle152a772008-05-24 18:31:28 +00001200real and imaginary parts and obtain a number's conjugate. Python's built-in
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001201complex type is an implementation of :class:`Complex`.
1202
Georg Brandle152a772008-05-24 18:31:28 +00001203:class:`Real` further derives from :class:`Complex`, and adds
1204operations that only work on real numbers: :func:`floor`, :func:`trunc`,
1205rounding, taking the remainder mod N, floor division,
1206and comparisons.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001207
1208:class:`Rational` numbers derive from :class:`Real`, have
1209:attr:`numerator` and :attr:`denominator` properties, and can be
Mark Dickinsond058cd22008-02-10 21:29:51 +00001210converted to floats. Python 2.6 adds a simple rational-number class,
Georg Brandle152a772008-05-24 18:31:28 +00001211:class:`Fraction`, in the :mod:`fractions` module. (It's called
1212:class:`Fraction` instead of :class:`Rational` to avoid
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001213a name clash with :class:`numbers.Rational`.)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001214
1215:class:`Integral` numbers derive from :class:`Rational`, and
Georg Brandle152a772008-05-24 18:31:28 +00001216can be shifted left and right with ``<<`` and ``>>``,
1217combined using bitwise operations such as ``&`` and ``|``,
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001218and can be used as array indexes and slice boundaries.
1219
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001220In Python 3.0, the PEP slightly redefines the existing built-ins
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001221:func:`round`, :func:`math.floor`, :func:`math.ceil`, and adds a new
Georg Brandle152a772008-05-24 18:31:28 +00001222one, :func:`math.trunc`, that's been backported to Python 2.6.
1223:func:`math.trunc` rounds toward zero, returning the closest
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001224:class:`Integral` that's between the function's argument and zero.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001225
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001226.. seealso::
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001227
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001228 :pep:`3141` - A Type Hierarchy for Numbers
1229 PEP written by Jeffrey Yasskin.
1230
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001231 `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 +00001232
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001233 `Scheme's number datatypes <http://schemers.org/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2>`__ from the R5RS Scheme specification.
Georg Brandle152a772008-05-24 18:31:28 +00001234
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001235
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001236The :mod:`fractions` Module
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001237--------------------------------------------------
1238
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001239To fill out the hierarchy of numeric types, a rational-number class is
1240provided by the :mod:`fractions` module. Rational numbers store their
1241values as a numerator and denominator forming a fraction, and can
1242exactly represent numbers such as ``2/3`` that floating-point numbers
1243can only approximate.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001244
Mark Dickinsond058cd22008-02-10 21:29:51 +00001245The :class:`Fraction` constructor takes two :class:`Integral` values
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001246that will be the numerator and denominator of the resulting fraction. ::
1247
Mark Dickinsond058cd22008-02-10 21:29:51 +00001248 >>> from fractions import Fraction
1249 >>> a = Fraction(2, 3)
1250 >>> b = Fraction(2, 5)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001251 >>> float(a), float(b)
1252 (0.66666666666666663, 0.40000000000000002)
1253 >>> a+b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001254 Fraction(16, 15)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001255 >>> a/b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001256 Fraction(5, 3)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001257
Georg Brandle152a772008-05-24 18:31:28 +00001258To help in converting floating-point numbers to rationals,
1259the float type now has a :meth:`as_integer_ratio()` method that returns
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001260the numerator and denominator for a fraction that evaluates to the same
1261floating-point value::
1262
1263 >>> (2.5) .as_integer_ratio()
1264 (5, 2)
1265 >>> (3.1415) .as_integer_ratio()
1266 (7074029114692207L, 2251799813685248L)
1267 >>> (1./3) .as_integer_ratio()
1268 (6004799503160661L, 18014398509481984L)
1269
1270Note that values that can only be approximated by floating-point
1271numbers, such as 1./3, are not simplified to the number being
1272approximated; the fraction attempts to match the floating-point value
1273**exactly**.
1274
Mark Dickinsond058cd22008-02-10 21:29:51 +00001275The :mod:`fractions` module is based upon an implementation by Sjoerd
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001276Mullender that was in Python's :file:`Demo/classes/` directory for a
1277long time. This implementation was significantly updated by Jeffrey
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001278Yasskin.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001279
Brett Cannon4b964f92008-05-05 20:21:38 +00001280
Georg Brandl8ec7f652007-08-15 14:28:01 +00001281Other Language Changes
1282======================
1283
1284Here are all of the changes that Python 2.6 makes to the core Python language.
1285
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00001286* The :func:`hasattr` function was catching and ignoring all errors,
1287 under the assumption that they meant a :meth:`__getattr__` method has
1288 failing somewhere and the return value of :func:`hasattr` would therefore
1289 be ``False``. This logic shouldn't be applied to
1290 :exc:`KeyboardInterrupt` and :exc:`SystemExit`, however; Python 2.6 will
1291 no longer discard such exceptions when :func:`hasattr` encounters them.
1292 (Fixed by Benjamin Peterson; :issue:`2196`.)
1293
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001294* When calling a function using the ``**`` syntax to provide keyword
1295 arguments, you are no longer required to use a Python dictionary;
1296 any mapping will now work::
1297
1298 >>> def f(**kw):
1299 ... print sorted(kw)
Georg Brandle152a772008-05-24 18:31:28 +00001300 ...
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001301 >>> ud=UserDict.UserDict()
1302 >>> ud['a'] = 1
1303 >>> ud['b'] = 'string'
1304 >>> f(**ud)
1305 ['a', 'b']
1306
Andrew M. Kuchlingc157c9c2008-04-09 22:28:43 +00001307 (Contributed by Alexander Belopolsky; :issue:`1686487`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001308
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001309* A new built-in, ``next(*iterator*, [*default*])`` returns the next item
1310 from the specified iterator. If the *default* argument is supplied,
1311 it will be returned if *iterator* has been exhausted; otherwise,
1312 the :exc:`StopIteration` exception will be raised. (:issue:`2719`)
1313
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001314* Tuples now have an :meth:`index` method matching the list type's
1315 :meth:`index` method::
1316
1317 >>> t = (0,1,2,3,4)
1318 >>> t.index(3)
1319 3
1320
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001321* The built-in types now have improved support for extended slicing syntax,
1322 where various combinations of ``(start, stop, step)`` are supplied.
1323 Previously, the support was partial and certain corner cases wouldn't work.
1324 (Implemented by Thomas Wouters.)
1325
Georg Brandlb19be572007-12-29 10:57:00 +00001326 .. Revision 57619
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001327
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001328* Properties now have three attributes, :attr:`getter`,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001329 :attr:`setter` and :attr:`deleter`, that are useful shortcuts for
Georg Brandle152a772008-05-24 18:31:28 +00001330 adding or modifying a getter, setter or deleter function to an
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001331 existing property. You would use them like this::
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001332
1333 class C(object):
Georg Brandle152a772008-05-24 18:31:28 +00001334 @property
1335 def x(self):
1336 return self._x
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001337
Georg Brandle152a772008-05-24 18:31:28 +00001338 @x.setter
1339 def x(self, value):
1340 self._x = value
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001341
Georg Brandle152a772008-05-24 18:31:28 +00001342 @x.deleter
1343 def x(self):
1344 del self._x
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001345
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001346 class D(C):
1347 @C.x.getter
1348 def x(self):
1349 return self._x * 2
1350
1351 @x.setter
1352 def x(self, value):
1353 self._x = value / 2
1354
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001355* Several methods of the built-in set types now accept multiple iterables:
1356 :meth:`intersection`,
1357 :meth:`intersection_update`,
1358 :meth:`union`, :meth:`update`,
1359 :meth:`difference` and :meth:`difference_update`.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001360
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001361 ::
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001362
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001363 >>> s=set('1234567890')
1364 >>> s.intersection('abc123', 'cdf246') # Intersection between all inputs
1365 set(['2'])
1366 >>> s.difference('246', '789')
1367 set(['1', '0', '3', '5'])
1368
1369 (Contributed by Raymond Hettinger.)
1370
1371* A numerical nicety: when creating a complex number from two floats
Georg Brandle152a772008-05-24 18:31:28 +00001372 on systems that support signed zeros (-0 and +0), the
1373 :func:`complex` constructor will now preserve the sign
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001374 of the zero. (Fixed by Mark T. Dickinson; :issue:`1507`)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001375
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001376* More floating-point features were also added. The :func:`float` function
1377 will now turn the strings ``+nan`` and ``-nan`` into the corresponding
Georg Brandle152a772008-05-24 18:31:28 +00001378 IEEE 754 Not A Number values, and ``+inf`` and ``-inf`` into
1379 positive or negative infinity. This works on any platform with
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001380 IEEE 754 semantics. (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001381
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001382 Other functions in the :mod:`math` module, :func:`isinf` and
1383 :func:`isnan`, return true if their floating-point argument is
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001384 infinite or Not A Number. (:issue:`1640`)
Georg Brandle1b8e9c2008-02-20 19:12:36 +00001385
Mark Dickinsond3035782008-06-20 15:17:41 +00001386* The :mod:`math` module has a number of new functions, and the existing
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001387 functions have been improved to give more consistent behaviour
1388 across platforms, especially with respect to handling of
1389 floating-point exceptions and IEEE 754 special values.
Georg Brandle152a772008-05-24 18:31:28 +00001390 The new functions are:
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001391
Georg Brandlf91c70a2008-06-20 19:28:18 +00001392 * :func:`~math.isinf` and :func:`~math.isnan` determine whether a given float
1393 is a (positive or negative) infinity or a NaN (Not a Number), respectively.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001394
Georg Brandlf91c70a2008-06-20 19:28:18 +00001395 * :func:`~math.copysign` copies the sign bit of an IEEE 754 number,
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001396 returning the absolute value of *x* combined with the sign bit of
1397 *y*. For example, ``math.copysign(1, -0.0)`` returns -1.0.
1398 (Contributed by Christian Heimes.)
1399
Georg Brandlf91c70a2008-06-20 19:28:18 +00001400 * :func:`~math.factorial` computes the factorial of a number.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001401 (Contributed by Raymond Hettinger; :issue:`2138`.)
1402
Georg Brandlf91c70a2008-06-20 19:28:18 +00001403 * :func:`~math.sum` adds up the stream of numbers from an iterable,
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001404 and is careful to avoid loss of precision by calculating partial sums.
1405 (Contributed by Jean Brouwers; :issue:`2819`.)
1406
Georg Brandlf91c70a2008-06-20 19:28:18 +00001407 * The inverse hyperbolic functions :func:`~math.acosh`, :func:`~math.asinh`
1408 and :func:`~math.atanh`.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001409
Georg Brandlf91c70a2008-06-20 19:28:18 +00001410 * The function :func:`~math.log1p`, returning the natural logarithm of *1+x*
1411 (base *e*).
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001412
Georg Brandlf91c70a2008-06-20 19:28:18 +00001413 There's also a new :func:`trunc` built-in function as a result of the
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001414 backport of `PEP 3141's type hierarchy for numbers <#pep-3141>`__.
1415
1416 The existing math functions have been modified to follow the
1417 recommendations of the C99 standard with respect to special values
1418 whenever possible. For example, ``sqrt(-1.)`` should now give a
1419 :exc:`ValueError` across (nearly) all platforms, while
1420 ``sqrt(float('NaN'))`` should return a NaN on all IEEE 754
1421 platforms. Where Annex 'F' of the C99 standard recommends signaling
1422 'divide-by-zero' or 'invalid', Python will raise :exc:`ValueError`.
1423 Where Annex 'F' of the C99 standard recommends signaling 'overflow',
1424 Python will raise :exc:`OverflowError`. (See :issue:`711019`,
1425 :issue:`1640`.)
1426
1427 (Contributed by Christian Heimes and Mark Dickinson.)
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001428
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001429* Changes to the :class:`Exception` interface
Georg Brandle152a772008-05-24 18:31:28 +00001430 as dictated by :pep:`352` continue to be made. For 2.6,
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001431 the :attr:`message` attribute is being deprecated in favor of the
1432 :attr:`args` attribute.
1433
Georg Brandle152a772008-05-24 18:31:28 +00001434* The :exc:`GeneratorExit` exception now subclasses
1435 :exc:`BaseException` instead of :exc:`Exception`. This means
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001436 that an exception handler that does ``except Exception:``
Georg Brandle152a772008-05-24 18:31:28 +00001437 will not inadvertently catch :exc:`GeneratorExit`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001438 (Contributed by Chad Austin; :issue:`1537`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001439
Georg Brandle152a772008-05-24 18:31:28 +00001440* Generator objects now have a :attr:`gi_code` attribute that refers to
1441 the original code object backing the generator.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001442 (Contributed by Collin Winter; :issue:`1473257`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001443
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001444* The :func:`compile` built-in function now accepts keyword arguments
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001445 as well as positional parameters. (Contributed by Thomas Wouters;
1446 :issue:`1444529`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001447
Georg Brandle152a772008-05-24 18:31:28 +00001448* The :func:`complex` constructor now accepts strings containing
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001449 parenthesized complex numbers, letting ``complex(repr(cmplx))``
1450 will now round-trip values. For example, ``complex('(3+4j)')``
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001451 now returns the value (3+4j). (:issue:`1491866`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001452
Georg Brandle152a772008-05-24 18:31:28 +00001453* The string :meth:`translate` method now accepts ``None`` as the
1454 translation table parameter, which is treated as the identity
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001455 transformation. This makes it easier to carry out operations
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001456 that only delete characters. (Contributed by Bengt Richter;
1457 :issue:`1193128`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001458
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001459* The built-in :func:`dir` function now checks for a :meth:`__dir__`
1460 method on the objects it receives. This method must return a list
1461 of strings containing the names of valid attributes for the object,
1462 and lets the object control the value that :func:`dir` produces.
Georg Brandle152a772008-05-24 18:31:28 +00001463 Objects that have :meth:`__getattr__` or :meth:`__getattribute__`
Facundo Batistabd5b6232007-12-03 19:49:54 +00001464 methods can use this to advertise pseudo-attributes they will honor.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001465 (:issue:`1591665`)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001466
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001467* Instance method objects have new attributes for the object and function
1468 comprising the method; the new synonym for :attr:`im_self` is
1469 :attr:`__self__`, and :attr:`im_func` is also available as :attr:`__func__`.
1470 The old names are still supported in Python 2.6; they're gone in 3.0.
1471
Georg Brandl8ec7f652007-08-15 14:28:01 +00001472* An obscure change: when you use the the :func:`locals` function inside a
1473 :keyword:`class` statement, the resulting dictionary no longer returns free
1474 variables. (Free variables, in this case, are variables referred to in the
1475 :keyword:`class` statement that aren't attributes of the class.)
1476
Georg Brandlb19be572007-12-29 10:57:00 +00001477.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001478
1479
1480Optimizations
1481-------------
1482
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001483* The :mod:`warnings` module has been rewritten in C. This makes
1484 it possible to invoke warnings from the parser, and may also
1485 make the interpreter's startup faster.
1486 (Contributed by Neal Norwitz and Brett Cannon; :issue:`1631171`.)
1487
Georg Brandlaf30b282008-01-15 06:55:56 +00001488* Type objects now have a cache of methods that can reduce
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001489 the amount of work required to find the correct method implementation
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001490 for a particular class; once cached, the interpreter doesn't need to
Georg Brandle152a772008-05-24 18:31:28 +00001491 traverse base classes to figure out the right method to call.
1492 The cache is cleared if a base class or the class itself is modified,
1493 so the cache should remain correct even in the face of Python's dynamic
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001494 nature.
Georg Brandle152a772008-05-24 18:31:28 +00001495 (Original optimization implemented by Armin Rigo, updated for
1496 Python 2.6 by Kevin Jacobs; :issue:`1700288`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001497
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001498* All of the functions in the :mod:`struct` module have been rewritten in
1499 C, thanks to work at the Need For Speed sprint.
1500 (Contributed by Raymond Hettinger.)
1501
Georg Brandl8ec7f652007-08-15 14:28:01 +00001502* Internally, a bit is now set in type objects to indicate some of the standard
1503 built-in types. This speeds up checking if an object is a subclass of one of
1504 these types. (Contributed by Neal Norwitz.)
1505
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001506* Unicode strings now use faster code for detecting
Georg Brandle152a772008-05-24 18:31:28 +00001507 whitespace and line breaks; this speeds up the :meth:`split` method
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001508 by about 25% and :meth:`splitlines` by 35%.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001509 (Contributed by Antoine Pitrou.) Memory usage is reduced
1510 by using pymalloc for the Unicode string's data.
1511
1512* The ``with`` statement now stores the :meth:`__exit__` method on the stack,
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001513 producing a small speedup. (Implemented by Jeffrey Yasskin.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001514
1515* To reduce memory usage, the garbage collector will now clear internal
1516 free lists when garbage-collecting the highest generation of objects.
1517 This may return memory to the OS sooner.
1518
Georg Brandl8ec7f652007-08-15 14:28:01 +00001519The net result of the 2.6 optimizations is that Python 2.6 runs the pystone
1520benchmark around XX% faster than Python 2.5.
1521
Georg Brandlb19be572007-12-29 10:57:00 +00001522.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001523
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001524.. _new-26-interpreter:
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001525
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001526Interpreter Changes
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001527-------------------------------
1528
1529Two command-line options have been reserved for use by other Python
1530implementations. The :option:`-J` switch has been reserved for use by
1531Jython for Jython-specific options, such as ones that are passed to
1532the underlying JVM. :option:`-X` has been reserved for options
1533specific to a particular implementation of Python such as CPython,
1534Jython, or IronPython. If either option is used with Python 2.6, the
1535interpreter will report that the option isn't currently used.
1536
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00001537It's now possible to prevent Python from writing :file:`.pyc` or
1538:file:`.pyo` files on importing a module by supplying the :option:`-B`
1539switch to the Python interpreter, or by setting the
1540:envvar:`PYTHONDONTWRITEBYTECODE` environment variable before running
1541the interpreter. This setting is available to Python programs as the
1542``sys.dont_write_bytecode`` variable, and can be changed by Python
1543code to modify the interpreter's behaviour. (Contributed by Neal
1544Norwitz and Georg Brandl.)
1545
1546The encoding used for standard input, output, and standard error can
1547be specified by setting the :envvar:`PYTHONIOENCODING` environment
1548variable before running the interpreter. The value should be a string
1549in the form ``**encoding**`` or ``**encoding**:**errorhandler**``.
1550The **encoding** part specifies the encoding's name, e.g. ``utf-8`` or
1551``latin-1``; the optional **errorhandler** part specifies
1552what to do with characters that can't be handled by the encoding,
1553and should be one of "error", "ignore", or "replace". (Contributed
1554by Martin von Loewis.)
1555
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001556.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001557
1558New, Improved, and Deprecated Modules
1559=====================================
1560
1561As usual, Python's standard library received a number of enhancements and bug
1562fixes. Here's a partial list of the most notable changes, sorted alphabetically
1563by module name. Consult the :file:`Misc/NEWS` file in the source tree for a more
Benjamin Peterson7b5151c2008-05-15 22:41:16 +00001564complete list of changes, or look through the Subversion logs for all the
1565details.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001566
Georg Brandle152a772008-05-24 18:31:28 +00001567* (3.0-warning mode) Python 3.0 will feature a reorganized standard
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001568 library; many outdated modules are being dropped.
Georg Brandle152a772008-05-24 18:31:28 +00001569 Python 2.6 running in 3.0-warning mode will warn about these modules
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001570 when they are imported.
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001571
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001572 The list of deprecated modules is:
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001573 :mod:`audiodev`,
1574 :mod:`bgenlocations`,
1575 :mod:`buildtools`,
1576 :mod:`bundlebuilder`,
1577 :mod:`Canvas`,
1578 :mod:`compiler`,
1579 :mod:`dircache`,
1580 :mod:`dl`,
1581 :mod:`fpformat`,
1582 :mod:`gensuitemodule`,
1583 :mod:`ihooks`,
1584 :mod:`imageop`,
1585 :mod:`imgfile`,
1586 :mod:`linuxaudiodev`,
1587 :mod:`mhlib`,
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001588 :mod:`mimetools`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001589 :mod:`multifile`,
1590 :mod:`new`,
1591 :mod:`popen2`,
1592 :mod:`pure`,
1593 :mod:`statvfs`,
1594 :mod:`sunaudiodev`,
1595 :mod:`test.testall`,
1596 :mod:`toaiff`.
1597
Benjamin Peterson36d879b2008-05-19 11:55:54 +00001598 Various MacOS modules have been removed:
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001599 :mod:`_builtinSuites`,
1600 :mod:`aepack`,
1601 :mod:`aetools`,
1602 :mod:`aetypes`,
1603 :mod:`applesingle`,
1604 :mod:`appletrawmain`,
1605 :mod:`appletrunner`,
1606 :mod:`argvemulator`,
1607 :mod:`Audio_mac`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001608 :mod:`autoGIL`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001609 :mod:`Carbon`,
1610 :mod:`cfmfile`,
1611 :mod:`CodeWarrior`,
1612 :mod:`ColorPicker`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001613 :mod:`EasyDialogs`,
1614 :mod:`Explorer`,
1615 :mod:`Finder`,
1616 :mod:`FrameWork`,
1617 :mod:`findertools`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001618 :mod:`ic`,
1619 :mod:`icglue`,
1620 :mod:`icopen`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001621 :mod:`macerrors`,
1622 :mod:`MacOS`,
1623 :mod:`macostools`,
1624 :mod:`macresource`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001625 :mod:`MiniAEFrame`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001626 :mod:`Nav`,
1627 :mod:`Netscape`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001628 :mod:`OSATerminology`,
1629 :mod:`pimp`,
1630 :mod:`PixMapWrapper`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001631 :mod:`StdSuites`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001632 :mod:`SystemEvents`,
1633 :mod:`Terminal`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001634 :mod:`terminalcommand`.
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001635
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001636 A number of old IRIX-specific modules were deprecated:
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001637 :mod:`al` and :mod:`AL`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001638 :mod:`cd`,
1639 :mod:`cddb`,
1640 :mod:`cdplayer`,
1641 :mod:`CL` and :mod:`cl`,
1642 :mod:`DEVICE`,
1643 :mod:`ERRNO`,
1644 :mod:`FILE`,
1645 :mod:`FL` and :mod:`fl`,
1646 :mod:`flp`,
1647 :mod:`fm`,
1648 :mod:`GET`,
1649 :mod:`GLWS`,
1650 :mod:`GL` and :mod:`gl`,
1651 :mod:`IN`,
1652 :mod:`IOCTL`,
1653 :mod:`jpeg`,
1654 :mod:`panelparser`,
1655 :mod:`readcd`,
1656 :mod:`SV` and :mod:`sv`,
1657 :mod:`torgb`,
1658 :mod:`videoreader`,
1659 :mod:`WAIT`.
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00001660
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001661* The :mod:`asyncore` and :mod:`asynchat` modules are
1662 being actively maintained again, and a number of patches and bugfixes
1663 were applied. (Maintained by Josiah Carlson; see :issue:`1736190` for
1664 one patch.)
1665
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001666* The :mod:`bsddb.dbshelve` module now uses the highest pickling protocol
1667 available, instead of restricting itself to protocol 1.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001668 (Contributed by W. Barnes; :issue:`1551443`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001669
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001670* The :mod:`cmath` module underwent an extensive set of revisions,
1671 thanks to Mark Dickinson and Christian Heimes, that added some new
1672 features and greatly improved the accuracy of the computations.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001673
Georg Brandle152a772008-05-24 18:31:28 +00001674 Five new functions were added:
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001675
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001676 * :func:`polar` converts a complex number to polar form, returning
Georg Brandle152a772008-05-24 18:31:28 +00001677 the modulus and argument of that complex number.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001678
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001679 * :func:`rect` does the opposite, turning a (modulus, argument) pair
1680 back into the corresponding complex number.
1681
Georg Brandle152a772008-05-24 18:31:28 +00001682 * :func:`phase` returns the phase or argument of a complex number.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001683
1684 * :func:`isnan` returns True if either
Georg Brandle152a772008-05-24 18:31:28 +00001685 the real or imaginary part of its argument is a NaN.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001686
1687 * :func:`isinf` returns True if either the real or imaginary part of
1688 its argument is infinite.
1689
1690 The revisions also improved the numerical soundness of the
1691 :mod:`cmath` module. For all functions, the real and imaginary
1692 parts of the results are accurate to within a few units of least
1693 precision (ulps) whenever possible. See :issue:`1381` for the
1694 details. The branch cuts for :func:`asinh`, :func:`atanh`: and
1695 :func:`atan` have also been corrected.
1696
1697 The tests for the module have been greatly expanded; nearly 2000 new
1698 test cases exercise the algebraic functions.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001699
1700 On IEEE 754 platforms, the :mod:`cmath` module now handles IEEE 754
1701 special values and floating-point exceptions in a manner consistent
1702 with Annex 'G' of the C99 standard.
1703
Andrew M. Kuchling6d57c822007-10-23 20:55:47 +00001704* A new data type in the :mod:`collections` module: :class:`namedtuple(typename,
Georg Brandl8ec7f652007-08-15 14:28:01 +00001705 fieldnames)` is a factory function that creates subclasses of the standard tuple
1706 whose fields are accessible by name as well as index. For example::
1707
Georg Brandle152a772008-05-24 18:31:28 +00001708 >>> var_type = collections.namedtuple('variable',
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001709 ... 'id name type size')
1710 # Names are separated by spaces or commas.
1711 # 'id, name, type, size' would also work.
Raymond Hettinger366523c2007-12-14 18:12:21 +00001712 >>> var_type._fields
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001713 ('id', 'name', 'type', 'size')
Georg Brandl8ec7f652007-08-15 14:28:01 +00001714
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001715 >>> var = var_type(1, 'frequency', 'int', 4)
1716 >>> print var[0], var.id # Equivalent
1717 1 1
1718 >>> print var[2], var.type # Equivalent
1719 int int
Raymond Hettinger366523c2007-12-14 18:12:21 +00001720 >>> var._asdict()
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001721 {'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'}
Raymond Hettingere9b9b352008-02-15 21:21:25 +00001722 >>> v2 = var._replace(name='amplitude')
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001723 >>> v2
1724 variable(id=1, name='amplitude', type='int', size=4)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001725
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001726 Where the new :class:`namedtuple` type proved suitable, the standard
Georg Brandle152a772008-05-24 18:31:28 +00001727 library has been modified to return them. For example,
1728 the :meth:`Decimal.as_tuple` method now returns a named tuple with
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001729 :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
1730
Georg Brandl8ec7f652007-08-15 14:28:01 +00001731 (Contributed by Raymond Hettinger.)
1732
Georg Brandle152a772008-05-24 18:31:28 +00001733* Another change to the :mod:`collections` module is that the
Georg Brandle7d118a2007-12-08 11:05:05 +00001734 :class:`deque` type now supports an optional *maxlen* parameter;
Georg Brandle152a772008-05-24 18:31:28 +00001735 if supplied, the deque's size will be restricted to no more
Georg Brandle7d118a2007-12-08 11:05:05 +00001736 than *maxlen* items. Adding more items to a full deque causes
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001737 old items to be discarded.
1738
1739 ::
1740
1741 >>> from collections import deque
1742 >>> dq=deque(maxlen=3)
1743 >>> dq
1744 deque([], maxlen=3)
1745 >>> dq.append(1) ; dq.append(2) ; dq.append(3)
1746 >>> dq
1747 deque([1, 2, 3], maxlen=3)
1748 >>> dq.append(4)
1749 >>> dq
1750 deque([2, 3, 4], maxlen=3)
1751
1752 (Contributed by Raymond Hettinger.)
1753
Thomas Hellerfb0117e2008-06-06 18:42:11 +00001754* XXX Describe the new ctypes calling convention that allows safe
1755 access to errno.
1756 (Implemented by Thomas Heller; :issue:`1798`.)
1757
Georg Brandle152a772008-05-24 18:31:28 +00001758* The :mod:`ctypes` module now supports a :class:`c_bool` datatype
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001759 that represents the C99 ``bool`` type. (Contributed by David Remahl;
1760 :issue:`1649190`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001761
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001762 The :mod:`ctypes` string, buffer and array types also have improved
1763 support for extended slicing syntax,
1764 where various combinations of ``(start, stop, step)`` are supplied.
1765 (Implemented by Thomas Wouters.)
1766
Georg Brandlb19be572007-12-29 10:57:00 +00001767 .. Revision 57769
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001768
Georg Brandl8ec7f652007-08-15 14:28:01 +00001769* A new method in the :mod:`curses` module: for a window, :meth:`chgat` changes
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001770 the display characters for a certain number of characters on a single line.
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001771 (Contributed by Fabian Kreutz.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001772 ::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001773
Georg Brandle152a772008-05-24 18:31:28 +00001774 # Boldface text starting at y=0,x=21
Georg Brandl8ec7f652007-08-15 14:28:01 +00001775 # and affecting the rest of the line.
Georg Brandle152a772008-05-24 18:31:28 +00001776 stdscr.chgat(0,21, curses.A_BOLD)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001777
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001778 The :class:`Textbox` class in the :mod:`curses.textpad` module
1779 now supports editing in insert mode as well as overwrite mode.
1780 Insert mode is enabled by supplying a true value for the *insert_mode*
1781 parameter when creating the :class:`Textbox` instance.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001782
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001783* The :mod:`datetime` module's :meth:`strftime` methods now support a
1784 ``%f`` format code that expands to the number of microseconds in the
1785 object, zero-padded on
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001786 the left to six places. (Contributed by Skip Montanaro; :issue:`1158`.)
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001787
Georg Brandle152a772008-05-24 18:31:28 +00001788* The :mod:`decimal` module was updated to version 1.66 of
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001789 `the General Decimal Specification <http://www2.hursley.ibm.com/decimal/decarith.html>`__. New features
1790 include some methods for some basic mathematical functions such as
1791 :meth:`exp` and :meth:`log10`::
1792
1793 >>> Decimal(1).exp()
1794 Decimal("2.718281828459045235360287471")
1795 >>> Decimal("2.7182818").ln()
1796 Decimal("0.9999999895305022877376682436")
1797 >>> Decimal(1000).log10()
1798 Decimal("3")
1799
Georg Brandle152a772008-05-24 18:31:28 +00001800 The :meth:`as_tuple` method of :class:`Decimal` objects now returns a
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001801 named tuple with :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
Georg Brandle152a772008-05-24 18:31:28 +00001802
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001803 (Implemented by Facundo Batista and Mark Dickinson. Named tuple
1804 support added by Raymond Hettinger.)
1805
Georg Brandle152a772008-05-24 18:31:28 +00001806* The :mod:`difflib` module's :class:`SequenceMatcher` class
1807 now returns named tuples representing matches.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001808 In addition to behaving like tuples, the returned values
1809 also have :attr:`a`, :attr:`b`, and :attr:`size` attributes.
1810 (Contributed by Raymond Hettinger.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001811
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001812* An optional ``timeout`` parameter was added to the
1813 :class:`ftplib.FTP` class constructor as well as the :meth:`connect`
1814 method, specifying a timeout measured in seconds. (Added by Facundo
Georg Brandle152a772008-05-24 18:31:28 +00001815 Batista.) Also, the :class:`FTP` class's
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001816 :meth:`storbinary` and :meth:`storlines`
Georg Brandle152a772008-05-24 18:31:28 +00001817 now take an optional *callback* parameter that will be called with
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001818 each block of data after the data has been sent.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001819 (Contributed by Phil Schwartz; :issue:`1221598`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001820
Georg Brandle152a772008-05-24 18:31:28 +00001821* The :func:`reduce` built-in function is also available in the
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001822 :mod:`functools` module. In Python 3.0, the built-in is dropped and it's
1823 only available from :mod:`functools`; currently there are no plans
Georg Brandle152a772008-05-24 18:31:28 +00001824 to drop the built-in in the 2.x series. (Patched by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001825 Christian Heimes; :issue:`1739906`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001826
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001827* When possible, the :mod:`getpass` module will now use
1828 :file:`/dev/tty` (when available) to print
1829 a prompting message and read the password, falling back to using
1830 standard error and standard input. If the password may be echoed to
1831 the terminal, a warning is printed before the prompt is displayed.
1832 (Contributed by Gregory P. Smith.)
1833
Georg Brandle152a772008-05-24 18:31:28 +00001834* The :func:`glob.glob` function can now return Unicode filenames if
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001835 a Unicode path was used and Unicode filenames are matched within the
1836 directory. (:issue:`1001604`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001837
1838* The :mod:`gopherlib` module has been removed.
1839
Georg Brandle152a772008-05-24 18:31:28 +00001840* A new function in the :mod:`heapq` module: ``merge(iter1, iter2, ...)``
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001841 takes any number of iterables that return data *in sorted
1842 order*, and returns a new iterator that returns the contents of all
1843 the iterators, also in sorted order. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001844
1845 heapq.merge([1, 3, 5, 9], [2, 8, 16]) ->
1846 [1, 2, 3, 5, 8, 9, 16]
1847
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001848 Another new function, ``heappushpop(heap, item)``,
Georg Brandle152a772008-05-24 18:31:28 +00001849 pushes *item* onto *heap*, then pops off and returns the smallest item.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001850 This is more efficient than making a call to :func:`heappush` and then
1851 :func:`heappop`.
1852
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001853 :mod:`heapq` is now implemented to only use less-than comparison,
1854 instead of the less-than-or-equal comparison it previously used.
1855 This makes :mod:`heapq`'s usage of a type match that of the
1856 :meth:`list.sort` method.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001857 (Contributed by Raymond Hettinger.)
1858
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001859* An optional ``timeout`` parameter was added to the
Georg Brandle152a772008-05-24 18:31:28 +00001860 :class:`httplib.HTTPConnection` and :class:`HTTPSConnection`
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001861 class constructors, specifying a timeout measured in seconds.
1862 (Added by Facundo Batista.)
1863
Georg Brandle152a772008-05-24 18:31:28 +00001864* Most of the :mod:`inspect` module's functions, such as
1865 :func:`getmoduleinfo` and :func:`getargs`, now return named tuples.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001866 In addition to behaving like tuples, the elements of the return value
1867 can also be accessed as attributes.
1868 (Contributed by Raymond Hettinger.)
1869
Georg Brandle152a772008-05-24 18:31:28 +00001870 Some new functions in the module include
1871 :func:`isgenerator`, :func:`isgeneratorfunction`,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001872 and :func:`isabstract`.
1873
1874* The :mod:`itertools` module gained several new functions.
1875
1876 ``izip_longest(iter1, iter2, ...[, fillvalue])`` makes tuples from
1877 each of the elements; if some of the iterables are shorter than
1878 others, the missing values are set to *fillvalue*. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001879
1880 itertools.izip_longest([1,2,3], [1,2,3,4,5]) ->
1881 [(1, 1), (2, 2), (3, 3), (None, 4), (None, 5)]
1882
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001883 ``product(iter1, iter2, ..., [repeat=N])`` returns the Cartesian product
1884 of the supplied iterables, a set of tuples containing
1885 every possible combination of the elements returned from each iterable. ::
1886
1887 itertools.product([1,2,3], [4,5,6]) ->
Georg Brandle152a772008-05-24 18:31:28 +00001888 [(1, 4), (1, 5), (1, 6),
1889 (2, 4), (2, 5), (2, 6),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001890 (3, 4), (3, 5), (3, 6)]
1891
1892 The optional *repeat* keyword argument is used for taking the
Georg Brandle152a772008-05-24 18:31:28 +00001893 product of an iterable or a set of iterables with themselves,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001894 repeated *N* times. With a single iterable argument, *N*-tuples
1895 are returned::
1896
1897 itertools.product([1,2], repeat=3)) ->
Georg Brandle152a772008-05-24 18:31:28 +00001898 [(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001899 (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]
1900
1901 With two iterables, *2N*-tuples are returned. ::
1902
1903 itertools(product([1,2], [3,4], repeat=2) ->
Georg Brandle152a772008-05-24 18:31:28 +00001904 [(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
1905 (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
1906 (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001907 (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]
1908
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001909 ``combinations(iterable, r)`` returns sub-sequences of length *r* from
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001910 the elements of *iterable*. ::
1911
1912 itertools.combinations('123', 2) ->
1913 [('1', '2'), ('1', '3'), ('2', '3')]
1914
1915 itertools.combinations('123', 3) ->
1916 [('1', '2', '3')]
1917
1918 itertools.combinations('1234', 3) ->
Georg Brandle152a772008-05-24 18:31:28 +00001919 [('1', '2', '3'), ('1', '2', '4'), ('1', '3', '4'),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001920 ('2', '3', '4')]
1921
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001922 ``permutations(iter[, r])`` returns all the permutations of length *r* of
Georg Brandle152a772008-05-24 18:31:28 +00001923 the iterable's elements. If *r* is not specified, it will default to the
Georg Brandlcb635652008-05-05 20:59:05 +00001924 number of elements produced by the iterable. ::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001925
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001926 itertools.permutations([1,2,3,4], 2) ->
Georg Brandle152a772008-05-24 18:31:28 +00001927 [(1, 2), (1, 3), (1, 4),
1928 (2, 1), (2, 3), (2, 4),
1929 (3, 1), (3, 2), (3, 4),
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001930 (4, 1), (4, 2), (4, 3)]
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001931
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001932 ``itertools.chain(*iterables)`` is an existing function in
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001933 :mod:`itertools` that gained a new constructor in Python 2.6.
Georg Brandle152a772008-05-24 18:31:28 +00001934 ``itertools.chain.from_iterable(iterable)`` takes a single
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001935 iterable that should return other iterables. :func:`chain` will
1936 then return all the elements of the first iterable, then
1937 all the elements of the second, and so on. ::
1938
1939 chain.from_iterable([[1,2,3], [4,5,6]]) ->
1940 [1, 2, 3, 4, 5, 6]
Georg Brandle152a772008-05-24 18:31:28 +00001941
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001942 (All contributed by Raymond Hettinger.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001943
Georg Brandle152a772008-05-24 18:31:28 +00001944* The :mod:`logging` module's :class:`FileHandler` class
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001945 and its subclasses :class:`WatchedFileHandler`, :class:`RotatingFileHandler`,
Georg Brandle152a772008-05-24 18:31:28 +00001946 and :class:`TimedRotatingFileHandler` now
1947 have an optional *delay* parameter to its constructor. If *delay*
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001948 is true, opening of the log file is deferred until the first
1949 :meth:`emit` call is made. (Contributed by Vinay Sajip.)
1950
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001951 :class:`TimedRotatingFileHandler` also has a *utc* constructor
1952 parameter. If the argument is true, UTC time will be used
1953 in determining when midnight occurs and in generating filenames;
1954 otherwise local time will be used.
1955
Georg Brandl8ec7f652007-08-15 14:28:01 +00001956* The :mod:`macfs` module has been removed. This in turn required the
1957 :func:`macostools.touched` function to be removed because it depended on the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001958 :mod:`macfs` module. (:issue:`1490190`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001959
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001960* :class:`mmap` objects now have a :meth:`rfind` method that finds
1961 a substring, beginning at the end of the string and searching
1962 backwards. The :meth:`find` method
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001963 also gained an *end* parameter containing the index at which to stop
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001964 the forward search.
1965 (Contributed by John Lenton.)
1966
Georg Brandle152a772008-05-24 18:31:28 +00001967* The :mod:`operator` module gained a
1968 :func:`methodcaller` function that takes a name and an optional
1969 set of arguments, returning a callable that will call
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001970 the named function on any arguments passed to it. For example::
1971
1972 >>> # Equivalent to lambda s: s.replace('old', 'new')
1973 >>> replacer = operator.methodcaller('replace', 'old', 'new')
1974 >>> replacer('old wine in old bottles')
1975 'new wine in new bottles'
Georg Brandle152a772008-05-24 18:31:28 +00001976
Georg Brandl27504da2008-03-04 07:25:54 +00001977 (Contributed by Georg Brandl, after a suggestion by Gregory Petrosyan.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001978
1979 The :func:`attrgetter` function now accepts dotted names and performs
1980 the corresponding attribute lookups::
1981
1982 >>> inst_name = operator.attrgetter('__class__.__name__')
1983 >>> inst_name('')
1984 'str'
1985 >>> inst_name(help)
1986 '_Helper'
1987
Georg Brandl27504da2008-03-04 07:25:54 +00001988 (Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001989
Georg Brandle152a772008-05-24 18:31:28 +00001990* New functions in the :mod:`os` module include
1991 ``fchmod(fd, mode)``, ``fchown(fd, uid, gid)``,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001992 and ``lchmod(path, mode)``, on operating systems that support these
1993 functions. :func:`fchmod` and :func:`fchown` let you change the mode
1994 and ownership of an opened file, and :func:`lchmod` changes the mode
1995 of a symlink.
1996
1997 (Contributed by Georg Brandl and Christian Heimes.)
1998
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001999* The :func:`os.walk` function now has a ``followlinks`` parameter. If
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002000 set to True, it will follow symlinks pointing to directories and
2001 visit the directory's contents. For backward compatibility, the
2002 parameter's default value is false. Note that the function can fall
2003 into an infinite recursion if there's a symlink that points to a
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002004 parent directory. (:issue:`1273829`)
Georg Brandle152a772008-05-24 18:31:28 +00002005
2006* The ``os.environ`` object's :meth:`clear` method will now unset the
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002007 environment variables using :func:`os.unsetenv` in addition to clearing
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002008 the object's keys. (Contributed by Martin Horcicka; :issue:`1181`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002009
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002010* In the :mod:`os.path` module, the :func:`splitext` function
2011 has been changed to not split on leading period characters.
2012 This produces better results when operating on Unix's dot-files.
2013 For example, ``os.path.splitext('.ipython')``
2014 now returns ``('.ipython', '')`` instead of ``('', '.ipython')``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002015 (:issue:`115886`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002016
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002017 A new function, :func:`relpath(path, start)` returns a relative path
2018 from the ``start`` path, if it's supplied, or from the current
2019 working directory to the destination ``path``. (Contributed by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002020 Richard Barran; :issue:`1339796`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002021
Georg Brandle152a772008-05-24 18:31:28 +00002022 On Windows, :func:`os.path.expandvars` will now expand environment variables
2023 in the form "%var%", and "~user" will be expanded into the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002024 user's home directory path. (Contributed by Josiah Carlson;
2025 :issue:`957650`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002026
Georg Brandle152a772008-05-24 18:31:28 +00002027* The Python debugger provided by the :mod:`pdb` module
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002028 gained a new command: "run" restarts the Python program being debugged,
2029 and can optionally take new command-line arguments for the program.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002030 (Contributed by Rocky Bernstein; :issue:`1393667`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002031
Georg Brandle152a772008-05-24 18:31:28 +00002032 The :func:`post_mortem` function, used to enter debugging of a
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002033 traceback, will now use the traceback returned by :func:`sys.exc_info`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002034 if no traceback is supplied. (Contributed by Facundo Batista;
2035 :issue:`1106316`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002036
Georg Brandle152a772008-05-24 18:31:28 +00002037* The :mod:`pickletools` module now has an :func:`optimize` function
2038 that takes a string containing a pickle and removes some unused
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002039 opcodes, returning a shorter pickle that contains the same data structure.
2040 (Contributed by Raymond Hettinger.)
2041
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002042* A :func:`get_data` function was added to the :mod:`pkgutil`
2043 module that returns the contents of resource files included
2044 with an installed Python package. For example::
2045
Benjamin Peterson60ffcbe2008-04-21 22:57:00 +00002046 >>> import pkgutil
2047 >>> pkgutil.get_data('test', 'exception_hierarchy.txt')
2048 'BaseException
2049 +-- SystemExit
2050 +-- KeyboardInterrupt
2051 +-- GeneratorExit
2052 +-- Exception
2053 +-- StopIteration
2054 +-- StandardError
2055 ...'
Georg Brandle152a772008-05-24 18:31:28 +00002056 >>>
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002057
2058 (Contributed by Paul Moore; :issue:`2439`.)
2059
Georg Brandl8ec7f652007-08-15 14:28:01 +00002060* New functions in the :mod:`posix` module: :func:`chflags` and :func:`lchflags`
2061 are wrappers for the corresponding system calls (where they're available).
2062 Constants for the flag values are defined in the :mod:`stat` module; some
2063 possible values include :const:`UF_IMMUTABLE` to signal the file may not be
2064 changed and :const:`UF_APPEND` to indicate that data can only be appended to the
2065 file. (Contributed by M. Levinson.)
2066
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002067 ``os.closerange(*low*, *high*)`` efficiently closes all file descriptors
2068 from *low* to *high*, ignoring any errors and not including *high* itself.
2069 This function is now used by the :mod:`subprocess` module to make starting
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002070 processes faster. (Contributed by Georg Brandl; :issue:`1663329`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002071
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002072* The :mod:`pyexpat` module's :class:`Parser` objects now allow setting
Georg Brandle152a772008-05-24 18:31:28 +00002073 their :attr:`buffer_size` attribute to change the size of the buffer
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002074 used to hold character data.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002075 (Contributed by Achim Gaedke; :issue:`1137`.)
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002076
Georg Brandla6168f92008-05-25 07:20:14 +00002077* The :mod:`Queue` module now provides queue classes that retrieve entries
Georg Brandle152a772008-05-24 18:31:28 +00002078 in different orders. The :class:`PriorityQueue` class stores
2079 queued items in a heap and retrieves them in priority order,
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002080 and :class:`LifoQueue` retrieves the most recently added entries first,
2081 meaning that it behaves like a stack.
2082 (Contributed by Raymond Hettinger.)
2083
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002084* The :mod:`random` module's :class:`Random` objects can
2085 now be pickled on a 32-bit system and unpickled on a 64-bit
2086 system, and vice versa. Unfortunately, this change also means
2087 that Python 2.6's :class:`Random` objects can't be unpickled correctly
2088 on earlier versions of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002089 (Contributed by Shawn Ligocki; :issue:`1727780`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002090
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002091 The new ``triangular(low, high, mode)`` function returns random
2092 numbers following a triangular distribution. The returned values
Georg Brandle152a772008-05-24 18:31:28 +00002093 are between *low* and *high*, not including *high* itself, and
2094 with *mode* as the mode, the most frequently occurring value
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002095 in the distribution. (Contributed by Wladmir van der Laan and
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002096 Raymond Hettinger; :issue:`1681432`.)
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002097
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002098* Long regular expression searches carried out by the :mod:`re`
2099 module will now check for signals being delivered, so especially
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002100 time-consuming searches can now be interrupted.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002101 (Contributed by Josh Hoyt and Ralf Schmitt; :issue:`846388`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002102
Georg Brandl8ec7f652007-08-15 14:28:01 +00002103* The :mod:`rgbimg` module has been removed.
2104
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002105* The :mod:`rlcompleter` module's :meth:`Completer.complete()` method
2106 will now ignore exceptions triggered while evaluating a name.
2107 (Fixed by Lorenz Quack; :issue:`2250`.)
2108
Georg Brandle152a772008-05-24 18:31:28 +00002109* The :mod:`sched` module's :class:`scheduler` instances now
2110 have a read-only :attr:`queue` attribute that returns the
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002111 contents of the scheduler's queue, represented as a list of
Georg Brandl225163d2008-03-05 07:10:35 +00002112 named tuples with the fields ``(time, priority, action, argument)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002113 (Contributed by Raymond Hettinger; :issue:`1861`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002114
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002115* The :mod:`select` module now has wrapper functions
2116 for the Linux :cfunc:`epoll` and BSD :cfunc:`kqueue` system calls.
2117 Also, a :meth:`modify` method was added to the existing :class:`poll`
2118 objects; ``pollobj.modify(fd, eventmask)`` takes a file descriptor
Georg Brandle152a772008-05-24 18:31:28 +00002119 or file object and an event mask,
2120
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002121 (Contributed by Christian Heimes; :issue:`1657`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002122
Georg Brandle152a772008-05-24 18:31:28 +00002123* The :mod:`sets` module has been deprecated; it's better to
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002124 use the built-in :class:`set` and :class:`frozenset` types.
2125
Georg Brandle152a772008-05-24 18:31:28 +00002126* Integrating signal handling with GUI handling event loops
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002127 like those used by Tkinter or GTk+ has long been a problem; most
Georg Brandle1b8e9c2008-02-20 19:12:36 +00002128 software ends up polling, waking up every fraction of a second.
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002129 The :mod:`signal` module can now make this more efficient.
2130 Calling ``signal.set_wakeup_fd(fd)`` sets a file descriptor
Georg Brandle152a772008-05-24 18:31:28 +00002131 to be used; when a signal is received, a byte is written to that
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002132 file descriptor. There's also a C-level function,
2133 :cfunc:`PySignal_SetWakeupFd`, for setting the descriptor.
2134
2135 Event loops will use this by opening a pipe to create two descriptors,
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002136 one for reading and one for writing. The writable descriptor
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002137 will be passed to :func:`set_wakeup_fd`, and the readable descriptor
2138 will be added to the list of descriptors monitored by the event loop via
2139 :cfunc:`select` or :cfunc:`poll`.
Georg Brandle152a772008-05-24 18:31:28 +00002140 On receiving a signal, a byte will be written and the main event loop
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002141 will be woken up, without the need to poll.
2142
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002143 (Contributed by Adam Olsen; :issue:`1583`.)
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002144
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002145 The :func:`siginterrupt` function is now available from Python code,
2146 and allows changing whether signals can interrupt system calls or not.
2147 (Contributed by Ralf Schmitt.)
2148
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002149 The :func:`setitimer` and :func:`getitimer` functions have also been
2150 added on systems that support these system calls. :func:`setitimer`
2151 allows setting interval timers that will cause a signal to be
2152 delivered to the process after a specified time, measured in
2153 wall-clock time, consumed process time, or combined process+system
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002154 time. (Contributed by Guilherme Polo; :issue:`2240`.)
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002155
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002156* The :mod:`smtplib` module now supports SMTP over SSL thanks to the
2157 addition of the :class:`SMTP_SSL` class. This class supports an
Georg Brandle152a772008-05-24 18:31:28 +00002158 interface identical to the existing :class:`SMTP` class. Both
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002159 class constructors also have an optional ``timeout`` parameter
2160 that specifies a timeout for the initial connection attempt, measured in
2161 seconds.
2162
2163 An implementation of the LMTP protocol (:rfc:`2033`) was also added to
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002164 the module. LMTP is used in place of SMTP when transferring e-mail
2165 between agents that don't manage a mail queue.
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002166
2167 (SMTP over SSL contributed by Monty Taylor; timeout parameter
2168 added by Facundo Batista; LMTP implemented by Leif
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002169 Hedstrom; :issue:`957003`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002170
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00002171* In the :mod:`smtplib` module, SMTP.starttls() now complies with :rfc:`3207`
2172 and forgets any knowledge obtained from the server not obtained from
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002173 the TLS negotiation itself. (Patch contributed by Bill Fenner;
2174 :issue:`829951`.)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00002175
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002176* The :mod:`socket` module now supports TIPC (http://tipc.sf.net),
2177 a high-performance non-IP-based protocol designed for use in clustered
2178 environments. TIPC addresses are 4- or 5-tuples.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002179 (Contributed by Alberto Bertogli; :issue:`1646`.)
Andrew M. Kuchlingf60b6412008-01-19 16:34:09 +00002180
Georg Brandle152a772008-05-24 18:31:28 +00002181 A new function, :func:`create_connection`, takes an address
2182 and connects to it using an optional timeout value, returning
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002183 the connected socket object.
2184
Georg Brandle152a772008-05-24 18:31:28 +00002185* The base classes in the :mod:`SocketServer` module now support
2186 calling a :meth:`handle_timeout` method after a span of inactivity
2187 specified by the server's :attr:`timeout` attribute. (Contributed
2188 by Michael Pomraning.) The :meth:`serve_forever` method
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002189 now takes an optional poll interval measured in seconds,
2190 controlling how often the server will check for a shutdown request.
Georg Brandle152a772008-05-24 18:31:28 +00002191 (Contributed by Pedro Werneck and Jeffrey Yasskin;
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002192 :issue:`742598`, :issue:`1193577`.)
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002193
2194* The :mod:`struct` module now supports the C99 :ctype:`_Bool` type,
Georg Brandle152a772008-05-24 18:31:28 +00002195 using the format character ``'?'``.
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002196 (Contributed by David Remahl.)
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002197
2198* The :class:`Popen` objects provided by the :mod:`subprocess` module
2199 now have :meth:`terminate`, :meth:`kill`, and :meth:`send_signal` methods.
2200 On Windows, :meth:`send_signal` only supports the :const:`SIGTERM`
2201 signal, and all these methods are aliases for the Win32 API function
Georg Brandle152a772008-05-24 18:31:28 +00002202 :cfunc:`TerminateProcess`.
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002203 (Contributed by Christian Heimes.)
Georg Brandle152a772008-05-24 18:31:28 +00002204
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002205* A new variable in the :mod:`sys` module,
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002206 :attr:`float_info`, is an object
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002207 containing information about the platform's floating-point support
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002208 derived from the :file:`float.h` file. Attributes of this object
Georg Brandle152a772008-05-24 18:31:28 +00002209 include
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002210 :attr:`mant_dig` (number of digits in the mantissa), :attr:`epsilon`
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002211 (smallest difference between 1.0 and the next largest value
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002212 representable), and several others. (Contributed by Christian Heimes;
2213 :issue:`1534`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002214
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00002215 Another new variable, :attr:`dont_write_bytecode`, controls whether Python
2216 writes any :file:`.pyc` or :file:`.pyo` files on importing a module.
2217 If this variable is true, the compiled files are not written. The
2218 variable is initially set on start-up by supplying the :option:`-B`
2219 switch to the Python interpreter, or by setting the
2220 :envvar:`PYTHONDONTWRITEBYTECODE` environment variable before
Georg Brandle152a772008-05-24 18:31:28 +00002221 running the interpreter. Python code can subsequently
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00002222 change the value of this variable to control whether bytecode files
2223 are written or not.
2224 (Contributed by Neal Norwitz and Georg Brandl.)
2225
Georg Brandle152a772008-05-24 18:31:28 +00002226 Information about the command-line arguments supplied to the Python
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002227 interpreter is available by reading attributes of a named
2228 tuple available as ``sys.flags``. For example, the :attr:`verbose`
2229 attribute is true if Python
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002230 was executed in verbose mode, :attr:`debug` is true in debugging mode, etc.
2231 These attributes are all read-only.
2232 (Contributed by Christian Heimes.)
2233
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002234 A new function, :func:`getsizeof`, takes a Python object and returns
2235 the amount of memory used by the object, measured in bytes. Built-in
2236 objects return correct results; third-party extensions may not,
2237 but can define a :meth:`__sizeof__` method to return the
2238 object's size.
2239 (Contributed by Robert Schuppenies; :issue:`2898`.)
2240
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002241 It's now possible to determine the current profiler and tracer functions
Georg Brandle152a772008-05-24 18:31:28 +00002242 by calling :func:`sys.getprofile` and :func:`sys.gettrace`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002243 (Contributed by Georg Brandl; :issue:`1648`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002244
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002245* The :mod:`tarfile` module now supports POSIX.1-2001 (pax) and
2246 POSIX.1-1988 (ustar) format tarfiles, in addition to the GNU tar
Georg Brandle152a772008-05-24 18:31:28 +00002247 format that was already supported. The default format
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002248 is GNU tar; specify the ``format`` parameter to open a file
2249 using a different format::
2250
2251 tar = tarfile.open("output.tar", "w", format=tarfile.PAX_FORMAT)
2252
2253 The new ``errors`` parameter lets you specify an error handling
2254 scheme for character conversions: the three standard ways Python can
2255 handle errors ``'strict'``, ``'ignore'``, ``'replace'`` , or the
2256 special value ``'utf-8'``, which replaces bad characters with their
2257 UTF-8 representation. Character conversions occur because the PAX
2258 format supports Unicode filenames, defaulting to UTF-8 encoding.
2259
2260 The :meth:`TarFile.add` method now accepts a ``exclude`` argument that's
2261 a function that can be used to exclude certain filenames from
Georg Brandle152a772008-05-24 18:31:28 +00002262 an archive.
2263 The function must take a filename and return true if the file
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002264 should be excluded or false if it should be archived.
2265 The function is applied to both the name initially passed to :meth:`add`
2266 and to the names of files in recursively-added directories.
Georg Brandle152a772008-05-24 18:31:28 +00002267
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002268 (All changes contributed by Lars Gustäbel).
2269
2270* An optional ``timeout`` parameter was added to the
2271 :class:`telnetlib.Telnet` class constructor, specifying a timeout
2272 measured in seconds. (Added by Facundo Batista.)
2273
Georg Brandle152a772008-05-24 18:31:28 +00002274* The :class:`tempfile.NamedTemporaryFile` class usually deletes
2275 the temporary file it created when the file is closed. This
2276 behaviour can now be changed by passing ``delete=False`` to the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002277 constructor. (Contributed by Damien Miller; :issue:`1537850`.)
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002278
Georg Brandle152a772008-05-24 18:31:28 +00002279 A new class, :class:`SpooledTemporaryFile`, behaves like
2280 a temporary file but stores its data in memory until a maximum size is
2281 exceeded. On reaching that limit, the contents will be written to
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002282 an on-disk temporary file. (Contributed by Dustin J. Mitchell.)
2283
2284 The :class:`NamedTemporaryFile` and :class:`SpooledTemporaryFile` classes
Georg Brandle152a772008-05-24 18:31:28 +00002285 both work as context managers, so you can write
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002286 ``with tempfile.NamedTemporaryFile() as tmp: ...``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002287 (Contributed by Alexander Belopolsky; :issue:`2021`.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002288
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002289* The :mod:`test.test_support` module now contains a
2290 :func:`EnvironmentVarGuard`
2291 context manager that supports temporarily changing environment variables and
Georg Brandle152a772008-05-24 18:31:28 +00002292 automatically restores them to their old values.
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002293
2294 Another context manager, :class:`TransientResource`, can surround calls
2295 to resources that may or may not be available; it will catch and
2296 ignore a specified list of exceptions. For example,
2297 a network test may ignore certain failures when connecting to an
2298 external web site::
2299
2300 with test_support.TransientResource(IOError, errno=errno.ETIMEDOUT):
Georg Brandle152a772008-05-24 18:31:28 +00002301 f = urllib.urlopen('https://sf.net')
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002302 ...
2303
2304 (Contributed by Brett Cannon.)
2305
Georg Brandle152a772008-05-24 18:31:28 +00002306* The :mod:`textwrap` module can now preserve existing whitespace
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002307 at the beginnings and ends of the newly-created lines
2308 by specifying ``drop_whitespace=False``
2309 as an argument::
2310
2311 >>> S = """This sentence has a bunch of extra whitespace."""
2312 >>> print textwrap.fill(S, width=15)
2313 This sentence
2314 has a bunch
2315 of extra
2316 whitespace.
2317 >>> print textwrap.fill(S, drop_whitespace=False, width=15)
2318 This sentence
2319 has a bunch
2320 of extra
2321 whitespace.
Georg Brandle152a772008-05-24 18:31:28 +00002322 >>>
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002323
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002324 (Contributed by Dwayne Bailey; :issue:`1581073`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002325
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002326* The :mod:`threading` module's :class:`Thread` objects
2327 gained a :meth:`getIdent` method that returns the thread's
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002328 identifier, a nonzero integer. (Contributed by Gregory P. Smith;
2329 :issue:`2871`.)
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002330
Georg Brandle152a772008-05-24 18:31:28 +00002331* The :mod:`timeit` module now accepts callables as well as strings
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002332 for the statement being timed and for the setup code.
Georg Brandle152a772008-05-24 18:31:28 +00002333 Two convenience functions were added for creating
2334 :class:`Timer` instances:
2335 ``repeat(stmt, setup, time, repeat, number)`` and
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002336 ``timeit(stmt, setup, time, number)`` create an instance and call
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002337 the corresponding method. (Contributed by Erik Demaine;
2338 :issue:`1533909`.)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002339
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002340* The :mod:`Tkinter` module now accepts lists and tuples for options,
2341 separating the elements by spaces before passing the resulting value to
2342 Tcl/Tk.
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002343 (Contributed by Guilherme Polo; :issue:`2906`.)
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002344
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002345* The :mod:`turtle` module for turtle graphics was greatly enhanced by
2346 Gregor Lingl. New features in the module include:
2347
2348 * Better animation of turtle movement and rotation.
2349 * Control over turtle movement using the new delay(),
2350 tracer(), and speed() methods.
2351 * The ability to set new shapes for the turtle, and to
2352 define a new coordinate system.
2353 * Turtles now have an undo() method that can roll back actions.
2354 * Simple support for reacting to input events such as mouse and keyboard
2355 activity, making it possible to write simple games.
2356 * A :file:`turtle.cfg` file can be used to customize the starting appearance
2357 of the turtle's screen.
2358 * The module's docstrings can be replaced by new docstrings that have been
2359 translated into another language.
2360
2361 (:issue:`1513695`)
2362
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002363* An optional ``timeout`` parameter was added to the
2364 :func:`urllib.urlopen` function and the
Georg Brandle152a772008-05-24 18:31:28 +00002365 :class:`urllib.ftpwrapper` class constructor, as well as the
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002366 :func:`urllib2.urlopen` function. The parameter specifies a timeout
2367 measured in seconds. For example::
2368
2369 >>> u = urllib2.urlopen("http://slow.example.com", timeout=3)
2370 Traceback (most recent call last):
2371 ...
2372 urllib2.URLError: <urlopen error timed out>
Georg Brandle152a772008-05-24 18:31:28 +00002373 >>>
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002374
Georg Brandle152a772008-05-24 18:31:28 +00002375 (Added by Facundo Batista.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002376
Georg Brandle152a772008-05-24 18:31:28 +00002377* The :mod:`warnings` module's :func:`formatwarning` and :func:`showwarning`
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002378 gained an optional *line* argument that can be used to supply the
2379 line of source code. (Added as part of :issue:`1631171`, which re-implemented
2380 part of the :mod:`warnings` module in C code.)
2381
2382* The XML-RPC :class:`SimpleXMLRPCServer` and :class:`DocXMLRPCServer`
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002383 classes can now be prevented from immediately opening and binding to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002384 their socket by passing True as the ``bind_and_activate``
2385 constructor parameter. This can be used to modify the instance's
Georg Brandle152a772008-05-24 18:31:28 +00002386 :attr:`allow_reuse_address` attribute before calling the
2387 :meth:`server_bind` and :meth:`server_activate` methods to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002388 open the socket and begin listening for connections.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002389 (Contributed by Peter Parente; :issue:`1599845`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002390
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002391 :class:`SimpleXMLRPCServer` also has a :attr:`_send_traceback_header`
Georg Brandle152a772008-05-24 18:31:28 +00002392 attribute; if true, the exception and formatted traceback are returned
2393 as HTTP headers "X-Exception" and "X-Traceback". This feature is
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002394 for debugging purposes only and should not be used on production servers
2395 because the tracebacks could possibly reveal passwords or other sensitive
Georg Brandle152a772008-05-24 18:31:28 +00002396 information. (Contributed by Alan McIntyre as part of his
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002397 project for Google's Summer of Code 2007.)
2398
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002399* The :mod:`xmlrpclib` module no longer automatically converts
Georg Brandle152a772008-05-24 18:31:28 +00002400 :class:`datetime.date` and :class:`datetime.time` to the
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002401 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2402 not necessarily correct for all applications. Code using
Georg Brandle152a772008-05-24 18:31:28 +00002403 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
2404 instances. (:issue:`1330538`) The code can also handle
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002405 dates before 1900 (contributed by Ralf Schmitt; :issue:`2014`)
2406 and 64-bit integers represented by using ``<i8>`` in XML-RPC responses
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002407 (contributed by Riku Lindblad; :issue:`2985`).
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002408
Georg Brandle152a772008-05-24 18:31:28 +00002409* The :mod:`zipfile` module's :class:`ZipFile` class now has
2410 :meth:`extract` and :meth:`extractall` methods that will unpack
2411 a single file or all the files in the archive to the current directory, or
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002412 to a specified directory::
2413
2414 z = zipfile.ZipFile('python-251.zip')
2415
2416 # Unpack a single file, writing it relative to the /tmp directory.
2417 z.extract('Python/sysmodule.c', '/tmp')
2418
2419 # Unpack all the files in the archive.
2420 z.extractall()
2421
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002422 (Contributed by Alan McIntyre; :issue:`467924`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002423
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002424 The :meth:`open`, :meth:`read` and :meth:`extract` methods can now
2425 take either a filename or a :class:`ZipInfo` object. This is useful when an
2426 archive accidentally contains a duplicated filename.
2427 (Contributed by Graham Horler; :issue:`1775025`.)
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002428
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002429 Finally, :mod:`zipfile` now supports using Unicode filenames
2430 for archived files. (Contributed by Alexey Borzenkov; :issue:`1734346`.)
2431
Georg Brandlb19be572007-12-29 10:57:00 +00002432.. ======================================================================
2433.. whole new modules get described in subsections here
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002434
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002435The :mod:`ast` module
2436----------------------
2437
2438The :mod:`ast` module provides an Abstract Syntax Tree representation
2439of Python code. For Python 2.6, Armin Ronacher contributed a set of
2440helper functions that perform various common tasks. These will be useful
2441for HTML templating packages, code analyzers, and similar tools that
2442process Python code.
2443
2444The :func:`parse` function takes an expression and returns an AST.
2445The :func:`dump` function outputs a representation of a tree, suitable
2446for debugging::
2447
2448 import ast
2449
2450 t = ast.parse("""
2451 d = {}
2452 for i in 'abcdefghijklm':
2453 d[i + i] = ord(i) - ord('a') + 1
2454 print d
2455 """)
2456 print ast.dump(t)
2457
2458This outputs::
2459
2460 Module(body=[Assign(targets=[Name(id='d', ctx=Store())],
2461 value=Dict(keys=[], values=[])), For(target=Name(id='i',
2462 ctx=Store()), iter=Str(s='abcdefghijklm'),
2463 body=[Assign(targets=[Subscript(value=Name(id='d', ctx=Load()),
2464 slice=Index(value=BinOp(left=Name(id='i', ctx=Load()), op=Add(),
2465 right=Name(id='i', ctx=Load()))), ctx=Store())],
2466 value=BinOp(left=BinOp(left=Call(func=Name(id='ord', ctx=Load()),
2467 args=[Name(id='i', ctx=Load())], keywords=[], starargs=None,
2468 kwargs=None), op=Sub(), right=Call(func=Name(id='ord',
2469 ctx=Load()), args=[Str(s='a')], keywords=[], starargs=None,
2470 kwargs=None)), op=Add(), right=Num(n=1)))], orelse=[]),
2471 Print(dest=None, values=[Name(id='d', ctx=Load())], nl=True)])
2472
2473The :func:`literal_eval` method takes a string or an AST
2474representing a literal expression, one that contains a Python
2475expression containing only strings, numbers, dictionaries, etc. but no
2476statements or function calls, and returns the resulting value. If you
2477need to unserialize an expression but need to worry about security
2478and can't risk using an :func:`eval` call, :func:`literal_eval` will
2479handle it safely::
2480
2481 >>> literal = '("a", "b", {2:4, 3:8, 1:2})'
2482 >>> print ast.literal_eval(literal)
2483 ('a', 'b', {1: 2, 2: 4, 3: 8})
2484 >>> print ast.literal_eval('"a" + "b"')
2485 Traceback (most recent call last):
2486 ...
2487 ValueError: malformed string
2488
2489The module also includes
2490:class:`NodeVisitor` and :class:`NodeTransformer` classes
2491for traversing and modifying an AST, and functions for common transformations such as changing line numbers.
2492
2493.. ======================================================================
2494
2495The :mod:`future_builtins` module
2496--------------------------------------
2497
2498Python 3.0 makes various changes to the repertoire of built-in
2499functions, and most of the changes can't be introduced in the Python
25002.x series because they would break compatibility.
2501The :mod:`future_builtins` module provides versions
2502of these built-in functions that can be imported when writing
25033.0-compatible code.
2504
2505The functions in this module currently include:
2506
2507* ``ascii(**obj**)``: equivalent to :func:`repr`. In Python 3.0,
2508 :func:`repr` will return a Unicode string, while :func:`ascii` will
2509 return a pure ASCII bytestring.
2510
2511* ``filter(**predicate**, **iterable**)``,
2512 ``map(**func**, **iterable1**, ...)``: the 3.0 versions
2513 return iterators, differing from the 2.x built-ins that return lists.
2514
2515* ``hex(**value**)``, ``oct(**value**)``: instead of calling the
2516 :meth:`__hex__` or :meth:`__oct__` methods, these versions will
2517 call the :meth:`__index__` method and convert the result to hexadecimal
2518 or octal.
2519
2520.. ======================================================================
2521
Brett Cannon4b964f92008-05-05 20:21:38 +00002522The :mod:`json` module
2523----------------------
2524
2525The new :mod:`json` module supports the encoding and decoding of Python types in
2526JSON (Javascript Object Notation). JSON is a lightweight interchange format
2527often used in web applications. For more information about JSON, see
2528http://www.json.org.
2529
2530:mod:`json` comes with support for decoding and encoding most builtin Python
2531types. The following example encodes and decodes a dictionary::
2532
2533 >>> import json
2534 >>> data = {"spam" : "foo", "parrot" : 42}
2535 >>> in_json = json.dumps(data) # Encode the data
2536 >>> in_json
2537 '{"parrot": 42, "spam": "foo"}'
2538 >>> json.loads(in_json) # Decode into a Python object
2539 {"spam" : "foo", "parrot" : 42}
2540
2541It is also possible to write your own decoders and encoders to support more
2542types. Pretty-printing of the JSON strings is also supported.
2543
2544:mod:`json` (originally called simplejson) was written by Bob Ippolito.
2545
2546
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002547.. ======================================================================
2548
2549plistlib: A Property-List Parser
2550--------------------------------------------------
2551
Georg Brandle152a772008-05-24 18:31:28 +00002552A commonly-used format on MacOS X is the ``.plist`` format,
2553which stores basic data types (numbers, strings, lists,
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002554and dictionaries) and serializes them into an XML-based format.
2555(It's a lot like the XML-RPC serialization of data types.)
2556
Georg Brandle152a772008-05-24 18:31:28 +00002557Despite being primarily used on MacOS X, the format
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002558has nothing Mac-specific about it and the Python implementation works
2559on any platform that Python supports, so the :mod:`plistlib` module
2560has been promoted to the standard library.
2561
2562Using the module is simple::
2563
2564 import sys
2565 import plistlib
2566 import datetime
2567
2568 # Create data structure
2569 data_struct = dict(lastAccessed=datetime.datetime.now(),
2570 version=1,
2571 categories=('Personal', 'Shared', 'Private'))
2572
2573 # Create string containing XML.
2574 plist_str = plistlib.writePlistToString(data_struct)
2575 new_struct = plistlib.readPlistFromString(plist_str)
2576 print data_struct
2577 print new_struct
2578
2579 # Write data structure to a file and read it back.
2580 plistlib.writePlist(data_struct, '/tmp/customizations.plist')
2581 new_struct = plistlib.readPlist('/tmp/customizations.plist')
2582
2583 # read/writePlist accepts file-like objects as well as paths.
2584 plistlib.writePlist(data_struct, sys.stdout)
Georg Brandle152a772008-05-24 18:31:28 +00002585
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002586.. ======================================================================
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002587
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002588Improved SSL Support
2589--------------------------------------------------
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002590
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002591Bill Janssen made extensive improvements to Python 2.6's support for
2592the Secure Sockets Layer by adding a new module, :mod:`ssl`, on top of
2593the `OpenSSL <http://www.openssl.org/>`__ library. This new module
2594provides more control over the protocol negotiated, the X.509
2595certificates used, and has better support for writing SSL servers (as
2596opposed to clients) in Python. The existing SSL support in the
2597:mod:`socket` module hasn't been removed and continues to work,
2598though it will be removed in Python 3.0.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002599
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002600To use the new module, first you must create a TCP connection in the
2601usual way and then pass it to the :func:`ssl.wrap_socket` function.
2602It's possible to specify whether a certificate is required, and to
2603obtain certificate info by calling the :meth:`getpeercert` method.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002604
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002605.. seealso::
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002606
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002607 The documentation for the :mod:`ssl` module.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002608
Georg Brandlb19be572007-12-29 10:57:00 +00002609.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002610
2611
2612Build and C API Changes
2613=======================
2614
2615Changes to Python's build process and to the C API include:
2616
Andrew M. Kuchlingf7b462f2007-11-23 13:37:39 +00002617* Python 2.6 can be built with Microsoft Visual Studio 2008.
2618 See the :file:`PCbuild9` directory for the build files.
2619 (Implemented by Christian Heimes.)
2620
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002621* On MacOS X, Python 2.6 can be compiled as a 4-way universal build.
2622 The :program:`configure` script
2623 can take a :option:`--with-universal-archs=[32-bit|64-bit|all]`
2624 switch, controlling whether the binaries are built for 32-bit
2625 architectures (x86, PowerPC), 64-bit (x86-64 and PPC-64), or both.
2626 (Contributed by Ronald Oussoren.)
2627
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002628* Python now can only be compiled with C89 compilers (after 19
2629 years!). This means that the Python source tree can now drop its
2630 own implementations of :cfunc:`memmove` and :cfunc:`strerror`, which
2631 are in the C89 standard library.
2632
Georg Brandle152a772008-05-24 18:31:28 +00002633* The BerkeleyDB module now has a C API object, available as
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002634 ``bsddb.db.api``. This object can be used by other C extensions
2635 that wish to use the :mod:`bsddb` module for their own purposes.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002636 (Contributed by Duncan Grisby; :issue:`1551895`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002637
Georg Brandle152a772008-05-24 18:31:28 +00002638* The new buffer interface, previously described in
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002639 `the PEP 3118 section <#pep-3118-revised-buffer-protocol>`__,
2640 adds :cfunc:`PyObject_GetBuffer` and :cfunc:`PyObject_ReleaseBuffer`,
2641 as well as a few other functions.
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002642
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002643* Python's use of the C stdio library is now thread-safe, or at least
2644 as thread-safe as the underlying library is. A long-standing potential
Georg Brandle152a772008-05-24 18:31:28 +00002645 bug occurred if one thread closed a file object while another thread
2646 was reading from or writing to the object. In 2.6 file objects
2647 have a reference count, manipulated by the
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002648 :cfunc:`PyFile_IncUseCount` and :cfunc:`PyFile_DecUseCount`
Georg Brandle152a772008-05-24 18:31:28 +00002649 functions. File objects can't be closed unless the reference count
2650 is zero. :cfunc:`PyFile_IncUseCount` should be called while the GIL
2651 is still held, before carrying out an I/O operation using the
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002652 ``FILE *`` pointer, and :cfunc:`PyFile_DecUseCount` should be called
2653 immediately after the GIL is re-acquired.
2654 (Contributed by Antoine Pitrou and Gregory P. Smith.)
2655
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002656* Importing modules simultaneously in two different threads no longer
2657 deadlocks; it will now raise an :exc:`ImportError`. A new API
2658 function, :cfunc:`PyImport_ImportModuleNoBlock`, will look for a
2659 module in ``sys.modules`` first, then try to import it after
2660 acquiring an import lock. If the import lock is held by another
2661 thread, the :exc:`ImportError` is raised.
2662 (Contributed by Christian Heimes.)
2663
Georg Brandle152a772008-05-24 18:31:28 +00002664* Several functions return information about the platform's
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002665 floating-point support. :cfunc:`PyFloat_GetMax` returns
2666 the maximum representable floating point value,
Georg Brandle152a772008-05-24 18:31:28 +00002667 and :cfunc:`PyFloat_GetMin` returns the minimum
2668 positive value. :cfunc:`PyFloat_GetInfo` returns a dictionary
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002669 containing more information from the :file:`float.h` file, such as
2670 ``"mant_dig"`` (number of digits in the mantissa), ``"epsilon"``
2671 (smallest difference between 1.0 and the next largest value
2672 representable), and several others.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002673 (Contributed by Christian Heimes; :issue:`1534`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002674
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002675* C functions and methods that use
2676 :cfunc:`PyComplex_AsCComplex` will now accept arguments that
2677 have a :meth:`__complex__` method. In particular, the functions in the
2678 :mod:`cmath` module will now accept objects with this method.
2679 This is a backport of a Python 3.0 change.
2680 (Contributed by Mark Dickinson; :issue:`1675423`.)
2681
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002682* Python's C API now includes two functions for case-insensitive string
Georg Brandl907a7202008-02-22 12:31:45 +00002683 comparisons, ``PyOS_stricmp(char*, char*)``
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002684 and ``PyOS_strnicmp(char*, char*, Py_ssize_t)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002685 (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002686
Georg Brandle152a772008-05-24 18:31:28 +00002687* Many C extensions define their own little macro for adding
2688 integers and strings to the module's dictionary in the
2689 ``init*`` function. Python 2.6 finally defines standard macros
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002690 for adding values to a module, :cmacro:`PyModule_AddStringMacro`
Georg Brandle152a772008-05-24 18:31:28 +00002691 and :cmacro:`PyModule_AddIntMacro()`. (Contributed by
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002692 Christian Heimes.)
2693
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002694* Some macros were renamed in both 3.0 and 2.6 to make it clearer that
2695 they are macros,
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00002696 not functions. :cmacro:`Py_Size()` became :cmacro:`Py_SIZE()`,
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002697 :cmacro:`Py_Type()` became :cmacro:`Py_TYPE()`, and
Georg Brandle152a772008-05-24 18:31:28 +00002698 :cmacro:`Py_Refcnt()` became :cmacro:`Py_REFCNT()`.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002699 The mixed-case macros are still available
2700 in Python 2.6 for backward compatibility.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002701 (:issue:`1629`)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002702
Georg Brandle152a772008-05-24 18:31:28 +00002703* Distutils now places C extensions it builds in a
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002704 different directory when running on a debug version of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002705 (Contributed by Collin Winter; :issue:`1530959`.)
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002706
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002707* Several basic data types, such as integers and strings, maintain
2708 internal free lists of objects that can be re-used. The data
2709 structures for these free lists now follow a naming convention: the
2710 variable is always named ``free_list``, the counter is always named
2711 ``numfree``, and a macro :cmacro:`Py<typename>_MAXFREELIST` is
2712 always defined.
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002713
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002714* A new Makefile target, "make check", prepares the Python source tree
Georg Brandle152a772008-05-24 18:31:28 +00002715 for making a patch: it fixes trailing whitespace in all modified
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002716 ``.py`` files, checks whether the documentation has been changed,
2717 and reports whether the :file:`Misc/ACKS` and :file:`Misc/NEWS` files
2718 have been updated.
2719 (Contributed by Brett Cannon.)
2720
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002721 Another new target, "make profile-opt", compiles a Python binary
2722 using GCC's profile-guided optimization. It compiles Python with
2723 profiling enabled, runs the test suite to obtain a set of profiling
2724 results, and then compiles using these results for optimization.
2725 (Contributed by Gregory P. Smith.)
2726
Georg Brandlb19be572007-12-29 10:57:00 +00002727.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002728
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002729Port-Specific Changes: Windows
2730-----------------------------------
2731
Christian Heimes7e3ab452008-05-04 11:50:53 +00002732* The support for Windows 95, 98, ME and NT4 has been dropped.
2733 Python 2.6 requires at least Windows 2000 SP4.
2734
Georg Brandle152a772008-05-24 18:31:28 +00002735* The :mod:`msvcrt` module now supports
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002736 both the normal and wide char variants of the console I/O
Georg Brandle152a772008-05-24 18:31:28 +00002737 API. The :func:`getwch` function reads a keypress and returns a Unicode
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002738 value, as does the :func:`getwche` function. The :func:`putwch` function
2739 takes a Unicode character and writes it to the console.
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002740 (Contributed by Christian Heimes.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002741
Georg Brandle152a772008-05-24 18:31:28 +00002742* :func:`os.path.expandvars` will now expand environment variables
2743 in the form "%var%", and "~user" will be expanded into the
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00002744 user's home directory path. (Contributed by Josiah Carlson.)
2745
Georg Brandle152a772008-05-24 18:31:28 +00002746* The :mod:`socket` module's socket objects now have an
2747 :meth:`ioctl` method that provides a limited interface to the
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00002748 :cfunc:`WSAIoctl` system interface.
2749
Georg Brandle152a772008-05-24 18:31:28 +00002750* The :mod:`_winreg` module now has a function,
2751 :func:`ExpandEnvironmentStrings`,
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002752 that expands environment variable references such as ``%NAME%``
2753 in an input string. The handle objects provided by this
Georg Brandle152a772008-05-24 18:31:28 +00002754 module now support the context protocol, so they can be used
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002755 in :keyword:`with` statements. (Contributed by Christian Heimes.)
2756
Georg Brandle152a772008-05-24 18:31:28 +00002757 :mod:`_winreg` also has better support for x64 systems,
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002758 exposing the :func:`DisableReflectionKey`, :func:`EnableReflectionKey`,
2759 and :func:`QueryReflectionKey` functions, which enable and disable
2760 registry reflection for 32-bit processes running on 64-bit systems.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002761 (:issue:`1753245`)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002762
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002763* The :mod:`msilib` module's :class:`Record` object
2764 gained :meth:`GetInteger` and :meth:`GetString` methods that
2765 return field values as an integer or a string.
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002766 (Contributed by Floris Bruynooghe; :issue:`2125`.)
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002767
Georg Brandle152a772008-05-24 18:31:28 +00002768* The new default compiler on Windows is Visual Studio 2008 (VS 9.0). The
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002769 build directories for Visual Studio 2003 (VS7.1) and 2005 (VS8.0)
2770 were moved into the PC/ directory. The new PCbuild directory supports
2771 cross compilation for X64, debug builds and Profile Guided Optimization
2772 (PGO). PGO builds are roughly 10% faster than normal builds.
2773 (Contributed by Christian Heimes with help from Amaury Forgeot d'Arc and
2774 Martin von Loewis.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002775
Georg Brandlb19be572007-12-29 10:57:00 +00002776.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002777
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002778Port-Specific Changes: MacOS X
2779-----------------------------------
2780
2781* When compiling a framework build of Python, you can now specify the
2782 framework name to be used by providing the
2783 :option:`--with-framework-name=` option to the
2784 :program:`configure` script.
2785
2786.. ======================================================================
2787
Georg Brandl8ec7f652007-08-15 14:28:01 +00002788
2789.. _section-other:
2790
2791Other Changes and Fixes
2792=======================
2793
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002794As usual, there were a bunch of other improvements and bugfixes
2795scattered throughout the source tree. A search through the change
2796logs finds there were XXX patches applied and YYY bugs fixed between
2797Python 2.5 and 2.6. Both figures are likely to be underestimates.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002798
2799Some of the more notable changes are:
2800
Georg Brandle152a772008-05-24 18:31:28 +00002801* It's now possible to prevent Python from writing any :file:`.pyc`
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002802 or :file:`.pyo` files by either supplying the :option:`-B` switch
2803 or setting the :envvar:`PYTHONDONTWRITEBYTECODE` environment variable
2804 to any non-empty string when running the Python interpreter. These
Georg Brandlca9c6e42008-01-15 06:58:15 +00002805 are also used to set the :data:`sys.dont_write_bytecode` attribute;
2806 Python code can change this variable to control whether bytecode
2807 files are subsequently written.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002808 (Contributed by Neal Norwitz and Georg Brandl.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002809
Georg Brandlb19be572007-12-29 10:57:00 +00002810.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002811
2812
2813Porting to Python 2.6
2814=====================
2815
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002816This section lists previously described changes and other bugfixes
2817that may require changes to your code:
Georg Brandl8ec7f652007-08-15 14:28:01 +00002818
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00002819* The :meth:`__init__` method of :class:`collections.deque`
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002820 now clears any existing contents of the deque
2821 before adding elements from the iterable. This change makes the
Georg Brandle152a772008-05-24 18:31:28 +00002822 behavior match that of ``list.__init__()``.
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002823
Georg Brandle152a772008-05-24 18:31:28 +00002824* The :class:`Decimal` constructor now accepts leading and trailing
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002825 whitespace when passed a string. Previously it would raise an
2826 :exc:`InvalidOperation` exception. On the other hand, the
2827 :meth:`create_decimal` method of :class:`Context` objects now
Georg Brandle152a772008-05-24 18:31:28 +00002828 explicitly disallows extra whitespace, raising a
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002829 :exc:`ConversionSyntax` exception.
2830
Georg Brandle152a772008-05-24 18:31:28 +00002831* Due to an implementation accident, if you passed a file path to
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002832 the built-in :func:`__import__` function, it would actually import
Georg Brandle152a772008-05-24 18:31:28 +00002833 the specified file. This was never intended to work, however, and
2834 the implementation now explicitly checks for this case and raises
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002835 an :exc:`ImportError`.
2836
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002837* C API: the :cfunc:`PyImport_Import` and :cfunc:`PyImport_ImportModule`
Georg Brandle152a772008-05-24 18:31:28 +00002838 functions now default to absolute imports, not relative imports.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002839 This will affect C extensions that import other modules.
2840
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002841* The :mod:`socket` module exception :exc:`socket.error` now inherits
2842 from :exc:`IOError`. Previously it wasn't a subclass of
2843 :exc:`StandardError` but now it is, through :exc:`IOError`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002844 (Implemented by Gregory P. Smith; :issue:`1706815`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002845
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002846* The :mod:`xmlrpclib` module no longer automatically converts
Georg Brandle152a772008-05-24 18:31:28 +00002847 :class:`datetime.date` and :class:`datetime.time` to the
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002848 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2849 not necessarily correct for all applications. Code using
Georg Brandle152a772008-05-24 18:31:28 +00002850 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002851 instances. (:issue:`1330538`)
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002852
Georg Brandle152a772008-05-24 18:31:28 +00002853* (3.0-warning mode) The :class:`Exception` class now warns
2854 when accessed using slicing or index access; having
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002855 :class:`Exception` behave like a tuple is being phased out.
2856
2857* (3.0-warning mode) inequality comparisons between two dictionaries
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002858 or two objects that don't implement comparison methods are reported
2859 as warnings. ``dict1 == dict2`` still works, but ``dict1 < dict2``
2860 is being phased out.
Georg Brandle152a772008-05-24 18:31:28 +00002861
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002862 Comparisons between cells, which are an implementation detail of Python's
2863 scoping rules, also cause warnings because such comparisons are forbidden
2864 entirely in 3.0.
2865
Georg Brandlb19be572007-12-29 10:57:00 +00002866.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002867
2868
2869.. _acks:
2870
2871Acknowledgements
2872================
2873
2874The author would like to thank the following people for offering suggestions,
Georg Brandle152a772008-05-24 18:31:28 +00002875corrections and assistance with various drafts of this article:
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002876Georg Brandl, Jim Jewett.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002877