blob: eb2a69bbbe462c64cd5863cf80aabef46daeb9ac [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
Benjamin Petersona6a72922008-07-01 19:51:54 +0000529.. XXX I think this still needs help
530
531:mod:`multiprocessing` makes it easy to distribute work over multiple processes.
532Its API is similiar to that of :mod:`threading`. For example::
533
534 from multiprocessing import Process
535
536 def long_hard_task(n):
537 print n * 43
538
539 for i in range(10):
540 Process(target=long_hard_task, args=(i)).start()
541
542will multiply the numbers between 0 and 10 times 43 and print out the result
543concurrently.
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000544
545.. seealso::
546
Benjamin Peterson2b917c92008-06-24 02:41:08 +0000547 :pep:`371` - Addition of the multiprocessing package
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000548 PEP written by Jesse Noller and Richard Oudkerk;
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +0000549 implemented by Richard Oudkerk and Jesse Noller.
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000550
551.. ======================================================================
552
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000553.. _pep-3101:
554
555PEP 3101: Advanced String Formatting
556=====================================================
557
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000558In Python 3.0, the `%` operator is supplemented by a more powerful string
559formatting method, :meth:`format`. Support for the :meth:`str.format` method
560has been backported to Python 2.6.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000561
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000562In 2.6, both 8-bit and Unicode strings have a `.format()` method that
563treats the string as a template and takes the arguments to be formatted.
564The formatting template uses curly brackets (`{`, `}`) as special characters::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000565
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000566 # Substitute positional argument 0 into the string.
567 "User ID: {0}".format("root") -> "User ID: root"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000568
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000569 # Use the named keyword arguments
570 uid = 'root'
Georg Brandle152a772008-05-24 18:31:28 +0000571
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000572 'User ID: {uid} Last seen: {last_login}'.format(uid='root',
573 last_login = '5 Mar 2008 07:20') ->
574 'User ID: root Last seen: 5 Mar 2008 07:20'
575
576Curly brackets can be escaped by doubling them::
577
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000578 format("Empty dict: {{}}") -> "Empty dict: {}"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000579
Georg Brandle152a772008-05-24 18:31:28 +0000580Field names can be integers indicating positional arguments, such as
581``{0}``, ``{1}``, etc. or names of keyword arguments. You can also
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000582supply compound field names that read attributes or access dictionary keys::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000583
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000584 import sys
585 'Platform: {0.platform}\nPython version: {0.version}'.format(sys) ->
586 'Platform: darwin\n
587 Python version: 2.6a1+ (trunk:61261M, Mar 5 2008, 20:29:41) \n
588 [GCC 4.0.1 (Apple Computer, Inc. build 5367)]'
589
590 import mimetypes
591 'Content-type: {0[.mp4]}'.format(mimetypes.types_map) ->
592 'Content-type: video/mp4'
593
594Note that when using dictionary-style notation such as ``[.mp4]``, you
595don't need to put any quotation marks around the string; it will look
596up the value using ``.mp4`` as the key. Strings beginning with a
597number will be converted to an integer. You can't write more
598complicated expressions inside a format string.
599
600So far we've shown how to specify which field to substitute into the
601resulting string. The precise formatting used is also controllable by
Georg Brandl859043c2008-03-21 17:19:29 +0000602adding a colon followed by a format specifier. For example::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000603
604 # Field 0: left justify, pad to 15 characters
605 # Field 1: right justify, pad to 6 characters
606 fmt = '{0:15} ${1:>6}'
607 fmt.format('Registration', 35) ->
608 'Registration $ 35'
609 fmt.format('Tutorial', 50) ->
610 'Tutorial $ 50'
611 fmt.format('Banquet', 125) ->
612 'Banquet $ 125'
613
Georg Brandl859043c2008-03-21 17:19:29 +0000614Format specifiers can reference other fields through nesting::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000615
616 fmt = '{0:{1}}'
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000617 fmt.format('Invoice #1234', 15) ->
618 'Invoice #1234 '
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000619 width = 35
620 fmt.format('Invoice #1234', width) ->
621 'Invoice #1234 '
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000622
623The alignment of a field within the desired width can be specified:
624
625================ ============================================
626Character Effect
627================ ============================================
628< (default) Left-align
629> Right-align
630^ Center
631= (For numeric types only) Pad after the sign.
632================ ============================================
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000633
Georg Brandle152a772008-05-24 18:31:28 +0000634Format specifiers can also include a presentation type, which
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000635controls how the value is formatted. For example, floating-point numbers
636can be formatted as a general number or in exponential notation:
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000637
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000638 >>> '{0:g}'.format(3.75)
639 '3.75'
640 >>> '{0:e}'.format(3.75)
641 '3.750000e+00'
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000642
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000643A variety of presentation types are available. Consult the 2.6
Georg Brandle321c2f2008-05-12 16:45:43 +0000644documentation for a :ref:`complete list <formatstrings>`; here's a sample::
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000645
646 'b' - Binary. Outputs the number in base 2.
647 'c' - Character. Converts the integer to the corresponding
648 Unicode character before printing.
649 'd' - Decimal Integer. Outputs the number in base 10.
650 'o' - Octal format. Outputs the number in base 8.
651 'x' - Hex format. Outputs the number in base 16, using lower-
652 case letters for the digits above 9.
653 'e' - Exponent notation. Prints the number in scientific
654 notation using the letter 'e' to indicate the exponent.
655 'g' - General format. This prints the number as a fixed-point
656 number, unless the number is too large, in which case
657 it switches to 'e' exponent notation.
Eric Smith103f19d2008-05-12 14:00:01 +0000658 'n' - Number. This is the same as 'g' (for floats) or 'd' (for
659 integers), except that it uses the current locale setting to
660 insert the appropriate number separator characters.
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000661 '%' - Percentage. Multiplies the number by 100 and displays
662 in fixed ('f') format, followed by a percent sign.
663
664Classes and types can define a __format__ method to control how they're
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000665formatted. It receives a single argument, the format specifier::
666
667 def __format__(self, format_spec):
668 if isinstance(format_spec, unicode):
669 return unicode(str(self))
670 else:
671 return str(self)
672
673There's also a format() built-in that will format a single value. It calls
674the type's :meth:`__format__` method with the provided specifier::
675
676 >>> format(75.6564, '.2f')
677 '75.66'
678
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +0000679
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000680.. seealso::
681
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000682 :ref:`formatstrings`
683 The reference format fields.
684
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000685 :pep:`3101` - Advanced String Formatting
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000686 PEP written by Talin. Implemented by Eric Smith.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000687
688.. ======================================================================
689
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000690.. _pep-3105:
691
692PEP 3105: ``print`` As a Function
693=====================================================
694
695The ``print`` statement becomes the :func:`print` function in Python 3.0.
Georg Brandle152a772008-05-24 18:31:28 +0000696Making :func:`print` a function makes it easier to change
697by doing 'def print(...)' or importing a new function from somewhere else.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000698
Georg Brandle152a772008-05-24 18:31:28 +0000699Python 2.6 has a ``__future__`` import that removes ``print`` as language
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000700syntax, letting you use the functional form instead. For example::
701
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000702 from __future__ import print_function
703 print('# of entries', len(dictionary), file=sys.stderr)
704
705The signature of the new function is::
706
707 def print(*args, sep=' ', end='\n', file=None)
708
709The parameters are:
710
711 * **args**: positional arguments whose values will be printed out.
712 * **sep**: the separator, which will be printed between arguments.
Georg Brandle152a772008-05-24 18:31:28 +0000713 * **end**: the ending text, which will be printed after all of the
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000714 arguments have been output.
715 * **file**: the file object to which the output will be sent.
716
717.. seealso::
718
Eric Smith33dd0942008-03-20 23:04:04 +0000719 :pep:`3105` - Make print a function
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000720 PEP written by Georg Brandl.
721
722.. ======================================================================
723
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000724.. _pep-3110:
725
726PEP 3110: Exception-Handling Changes
727=====================================================
728
Georg Brandle152a772008-05-24 18:31:28 +0000729One error that Python programmers occasionally make
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000730is the following::
731
732 try:
733 ...
734 except TypeError, ValueError:
735 ...
736
Georg Brandle152a772008-05-24 18:31:28 +0000737The author is probably trying to catch both
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000738:exc:`TypeError` and :exc:`ValueError` exceptions, but this code
Georg Brandle152a772008-05-24 18:31:28 +0000739actually does something different: it will catch
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000740:exc:`TypeError` and bind the resulting exception object
Georg Brandle152a772008-05-24 18:31:28 +0000741to the local name ``"ValueError"``. The correct code
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000742would have specified a tuple::
743
744 try:
745 ...
746 except (TypeError, ValueError):
747 ...
748
749This error is possible because the use of the comma here is ambiguous:
750does it indicate two different nodes in the parse tree, or a single
751node that's a tuple.
752
753Python 3.0 changes the syntax to make this unambiguous by replacing
Georg Brandle152a772008-05-24 18:31:28 +0000754the comma with the word "as". To catch an exception and store the
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000755exception object in the variable ``exc``, you must write::
756
757 try:
758 ...
759 except TypeError as exc:
760 ...
761
762Python 3.0 will only support the use of "as", and therefore interprets
763the first example as catching two different exceptions. Python 2.6
764supports both the comma and "as", so existing code will continue to
765work.
766
767.. seealso::
768
769 :pep:`3110` - Catching Exceptions in Python 3000
770 PEP written and implemented by Collin Winter.
771
Georg Brandlb19be572007-12-29 10:57:00 +0000772.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000773
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000774.. _pep-3112:
775
776PEP 3112: Byte Literals
777=====================================================
778
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000779Python 3.0 adopts Unicode as the language's fundamental string type and
Georg Brandle152a772008-05-24 18:31:28 +0000780denotes 8-bit literals differently, either as ``b'string'``
781or using a :class:`bytes` constructor. For future compatibility,
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000782Python 2.6 adds :class:`bytes` as a synonym for the :class:`str` type,
783and it also supports the ``b''`` notation.
784
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000785There's also a ``__future__`` import that causes all string literals
Georg Brandle152a772008-05-24 18:31:28 +0000786to become Unicode strings. This means that ``\u`` escape sequences
Benjamin Peterson83343302008-05-04 03:05:49 +0000787can be used to include Unicode characters::
788
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000789
Andrew M. Kuchlingda950eb2008-04-13 22:39:12 +0000790 from __future__ import unicode_literals
791
792 s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
793 '\u3081\u3000\u751f\u305f\u307e\u3054')
794
795 print len(s) # 12 Unicode characters
796
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000797At the C level, Python 3.0 will rename the existing 8-bit
798string type, called :ctype:`PyStringObject` in Python 2.x,
799to :ctype:`PyBytesObject`. Python 2.6 uses ``#define``
800to support using the names :cfunc:`PyBytesObject`,
801:cfunc:`PyBytes_Check`, :cfunc:`PyBytes_FromStringAndSize`,
802and all the other functions and macros used with strings.
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000803
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000804Instances of the :class:`bytes` type are immutable just
805as strings are. A new :class:`bytearray` type stores a mutable
806sequence of bytes::
807
808 >>> bytearray([65, 66, 67])
809 bytearray(b'ABC')
810 >>> b = bytearray(u'\u21ef\u3244', 'utf-8')
811 >>> b
812 bytearray(b'\xe2\x87\xaf \xe3\x89\x84')
813 >>> b[0] = '\xe3'
814 >>> b
815 bytearray(b'\xe3\x87\xaf \xe3\x89\x84')
816 >>> unicode(str(b), 'utf-8')
817 u'\u31ef \u3244'
818
819Byte arrays support most of the methods of string types, such as
820:meth:`startswith`/:meth:`endswith`, :meth:`find`/:meth:`rfind`,
821and some of the methods of lists, such as :meth:`append`,
822:meth:`pop`, and :meth:`reverse`.
823
824 >>> b = bytearray('ABC')
825 >>> b.append('d')
826 >>> b.append(ord('e'))
827 >>> b
828 bytearray(b'ABCde')
Benjamin Peterson83343302008-05-04 03:05:49 +0000829
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000830.. seealso::
831
832 :pep:`3112` - Bytes literals in Python 3000
833 PEP written by Jason Orendorff; backported to 2.6 by Christian Heimes.
834
835.. ======================================================================
836
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000837.. _pep-3116:
838
839PEP 3116: New I/O Library
840=====================================================
841
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000842Python's built-in file objects support a number of methods, but
843file-like objects don't necessarily support all of them. Objects that
844imitate files usually support :meth:`read` and :meth:`write`, but they
845may not support :meth:`readline`. Python 3.0 introduces a layered I/O
846library in the :mod:`io` module that separates buffering and
847text-handling features from the fundamental read and write operations.
848
849There are three levels of abstract base classes provided by
850the :mod:`io` module:
851
852* :class:`RawIOBase`: defines raw I/O operations: :meth:`read`,
Georg Brandle152a772008-05-24 18:31:28 +0000853 :meth:`readinto`,
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000854 :meth:`write`, :meth:`seek`, :meth:`tell`, :meth:`truncate`,
855 and :meth:`close`.
856 Most of the methods of this class will often map to a single system call.
857 There are also :meth:`readable`, :meth:`writable`, and :meth:`seekable`
858 methods for determining what operations a given object will allow.
859
860 Python 3.0 has concrete implementations of this class for files and
861 sockets, but Python 2.6 hasn't restructured its file and socket objects
862 in this way.
863
864 .. XXX should 2.6 register them in io.py?
865
Georg Brandle152a772008-05-24 18:31:28 +0000866* :class:`BufferedIOBase`: is an abstract base class that
867 buffers data in memory to reduce the number of
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000868 system calls used, making I/O processing more efficient.
Georg Brandle152a772008-05-24 18:31:28 +0000869 It supports all of the methods of :class:`RawIOBase`,
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000870 and adds a :attr:`raw` attribute holding the underlying raw object.
871
872 There are four concrete classes implementing this ABC:
Georg Brandle152a772008-05-24 18:31:28 +0000873 :class:`BufferedWriter` and
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000874 :class:`BufferedReader` for objects that only support
875 writing or reading and don't support random access,
876 :class:`BufferedRandom` for objects that support the :meth:`seek` method
877 for random access,
Georg Brandle152a772008-05-24 18:31:28 +0000878 and :class:`BufferedRWPair` for objects such as TTYs that have
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000879 both read and write operations that act upon unconnected streams of data.
880
881* :class:`TextIOBase`: Provides functions for reading and writing
882 strings (remember, strings will be Unicode in Python 3.0),
Georg Brandle152a772008-05-24 18:31:28 +0000883 and supporting universal newlines. :class:`TextIOBase` defines
884 the :meth:`readline` method and supports iteration upon
885 objects.
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000886
887 There are two concrete implementations. :class:`TextIOWrapper`
888 wraps a buffered I/O object, supporting all of the methods for
Georg Brandle152a772008-05-24 18:31:28 +0000889 text I/O and adding a :attr:`buffer` attribute for access
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000890 to the underlying object. :class:`StringIO` simply buffers
891 everything in memory without ever writing anything to disk.
892
893 (In current 2.6 alpha releases, :class:`io.StringIO` is implemented in
Georg Brandle152a772008-05-24 18:31:28 +0000894 pure Python, so it's pretty slow. You should therefore stick with the
895 existing :mod:`StringIO` module or :mod:`cStringIO` for now. At some
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000896 point Python 3.0's :mod:`io` module will be rewritten into C for speed,
897 and perhaps the C implementation will be backported to the 2.x releases.)
898
899 .. XXX check before final release: is io.py still written in Python?
900
901In Python 2.6, the underlying implementations haven't been
902restructured to build on top of the :mod:`io` module's classes. The
Georg Brandle152a772008-05-24 18:31:28 +0000903module is being provided to make it easier to write code that's
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000904forward-compatible with 3.0, and to save developers the effort of writing
905their own implementations of buffering and text I/O.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000906
907.. seealso::
908
909 :pep:`3116` - New I/O
910 PEP written by Daniel Stutzbach, Mike Verdone, and Guido van Rossum.
Andrew M. Kuchling04f58762008-04-15 02:24:15 +0000911 Code by Guido van Rossum, Georg Brandl, Walter Doerwald,
912 Jeremy Hylton, Martin von Loewis, Tony Lownds, and others.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000913
914.. ======================================================================
915
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000916.. _pep-3118:
917
918PEP 3118: Revised Buffer Protocol
919=====================================================
920
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000921The buffer protocol is a C-level API that lets Python types
Georg Brandle152a772008-05-24 18:31:28 +0000922exchange pointers into their internal representations. A
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000923memory-mapped file can be viewed as a buffer of characters, for
924example, and this lets another module such as :mod:`re`
925treat memory-mapped files as a string of characters to be searched.
926
927The primary users of the buffer protocol are numeric-processing
928packages such as NumPy, which can expose the internal representation
929of arrays so that callers can write data directly into an array instead
Georg Brandle152a772008-05-24 18:31:28 +0000930of going through a slower API. This PEP updates the buffer protocol in light of experience
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000931from NumPy development, adding a number of new features
Georg Brandle152a772008-05-24 18:31:28 +0000932such as indicating the shape of an array,
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000933locking memory .
934
Georg Brandle152a772008-05-24 18:31:28 +0000935The most important new C API function is
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000936``PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)``, which
937takes an object and a set of flags, and fills in the
Georg Brandle152a772008-05-24 18:31:28 +0000938``Py_buffer`` structure with information
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000939about the object's memory representation. Objects
Georg Brandle152a772008-05-24 18:31:28 +0000940can use this operation to lock memory in place
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000941while an external caller could be modifying the contents,
Georg Brandle152a772008-05-24 18:31:28 +0000942so there's a corresponding
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000943``PyObject_ReleaseBuffer(PyObject *obj, Py_buffer *view)`` to
944indicate that the external caller is done.
945
946The **flags** argument to :cfunc:`PyObject_GetBuffer` specifies
947constraints upon the memory returned. Some examples are:
948
949 * :const:`PyBUF_WRITABLE` indicates that the memory must be writable.
Georg Brandle152a772008-05-24 18:31:28 +0000950
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000951 * :const:`PyBUF_LOCK` requests a read-only or exclusive lock on the memory.
952
953 * :const:`PyBUF_C_CONTIGUOUS` and :const:`PyBUF_F_CONTIGUOUS`
954 requests a C-contiguous (last dimension varies the fastest) or
955 Fortran-contiguous (first dimension varies the fastest) layout.
956
957.. XXX this feature is not in 2.6 docs yet
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000958
959.. seealso::
960
961 :pep:`3118` - Revising the buffer protocol
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000962 PEP written by Travis Oliphant and Carl Banks; implemented by
963 Travis Oliphant.
Georg Brandle152a772008-05-24 18:31:28 +0000964
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000965
966.. ======================================================================
967
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000968.. _pep-3119:
969
970PEP 3119: Abstract Base Classes
971=====================================================
972
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000973Some object-oriented languages such as Java support interfaces: declarations
974that a class has a given set of methods or supports a given access protocol.
975Abstract Base Classes (or ABCs) are an equivalent feature for Python. The ABC
Georg Brandle152a772008-05-24 18:31:28 +0000976support consists of an :mod:`abc` module containing a metaclass called
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000977:class:`ABCMeta`, special handling
978of this metaclass by the :func:`isinstance` and :func:`issubclass` built-ins,
979and a collection of basic ABCs that the Python developers think will be widely
980useful.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000981
Georg Brandle152a772008-05-24 18:31:28 +0000982Let's say you have a particular class and wish to know whether it supports
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000983dictionary-style access. The phrase "dictionary-style" is vague, however.
Georg Brandle152a772008-05-24 18:31:28 +0000984It probably means that accessing items with ``obj[1]`` works.
985Does it imply that setting items with ``obj[2] = value`` works?
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000986Or that the object will have :meth:`keys`, :meth:`values`, and :meth:`items`
987methods? What about the iterative variants such as :meth:`iterkeys`? :meth:`copy`
988and :meth:`update`? Iterating over the object with :func:`iter`?
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000989
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000990Python 2.6 includes a number of different ABCs in the :mod:`collections`
991module. :class:`Iterable` indicates that a class defines :meth:`__iter__`,
992and :class:`Container` means the class supports ``x in y`` expressions
993by defining a :meth:`__contains__` method. The basic dictionary interface of
Georg Brandle152a772008-05-24 18:31:28 +0000994getting items, setting items, and
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000995:meth:`keys`, :meth:`values`, and :meth:`items`, is defined by the
996:class:`MutableMapping` ABC.
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000997
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000998You can derive your own classes from a particular ABC
999to indicate they support that ABC's interface::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001000
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001001 import collections
Georg Brandle152a772008-05-24 18:31:28 +00001002
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001003 class Storage(collections.MutableMapping):
1004 ...
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001005
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001006
Georg Brandle152a772008-05-24 18:31:28 +00001007Alternatively, you could write the class without deriving from
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001008the desired ABC and instead register the class by
1009calling the ABC's :meth:`register` method::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001010
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001011 import collections
Georg Brandle152a772008-05-24 18:31:28 +00001012
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001013 class Storage:
1014 ...
Georg Brandle152a772008-05-24 18:31:28 +00001015
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001016 collections.MutableMapping.register(Storage)
Georg Brandle152a772008-05-24 18:31:28 +00001017
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001018For classes that you write, deriving from the ABC is probably clearer.
1019The :meth:`register` method is useful when you've written a new
1020ABC that can describe an existing type or class, or if you want
1021to declare that some third-party class implements an ABC.
1022For example, if you defined a :class:`PrintableType` ABC,
1023it's legal to do:
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001024
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001025 # Register Python's types
1026 PrintableType.register(int)
1027 PrintableType.register(float)
1028 PrintableType.register(str)
1029
Georg Brandle152a772008-05-24 18:31:28 +00001030Classes should obey the semantics specified by an ABC, but
1031Python can't check this; it's up to the class author to
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001032understand the ABC's requirements and to implement the code accordingly.
1033
1034To check whether an object supports a particular interface, you can
1035now write::
1036
1037 def func(d):
1038 if not isinstance(d, collections.MutableMapping):
Georg Brandle152a772008-05-24 18:31:28 +00001039 raise ValueError("Mapping object expected, not %r" % d)
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001040
Georg Brandle152a772008-05-24 18:31:28 +00001041(Don't feel that you must now begin writing lots of checks as in the
1042above example. Python has a strong tradition of duck-typing, where
1043explicit type-checking isn't done and code simply calls methods on
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001044an object, trusting that those methods will be there and raising an
1045exception if they aren't. Be judicious in checking for ABCs
1046and only do it where it helps.)
1047
1048You can write your own ABCs by using ``abc.ABCMeta`` as the
1049metaclass in a class definition::
1050
1051 from abc import ABCMeta
1052
1053 class Drawable():
1054 __metaclass__ = ABCMeta
Georg Brandle152a772008-05-24 18:31:28 +00001055
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001056 def draw(self, x, y, scale=1.0):
1057 pass
1058
1059 def draw_doubled(self, x, y):
1060 self.draw(x, y, scale=2.0)
1061
Georg Brandle152a772008-05-24 18:31:28 +00001062
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001063 class Square(Drawable):
1064 def draw(self, x, y, scale):
1065 ...
1066
Georg Brandle152a772008-05-24 18:31:28 +00001067
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001068In the :class:`Drawable` ABC above, the :meth:`draw_doubled` method
1069renders the object at twice its size and can be implemented in terms
1070of other methods described in :class:`Drawable`. Classes implementing
Georg Brandle152a772008-05-24 18:31:28 +00001071this ABC therefore don't need to provide their own implementation
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001072of :meth:`draw_doubled`, though they can do so. An implementation
Georg Brandle152a772008-05-24 18:31:28 +00001073of :meth:`draw` is necessary, though; the ABC can't provide
1074a useful generic implementation. You
1075can apply the ``@abstractmethod`` decorator to methods such as
1076:meth:`draw` that must be implemented; Python will
1077then raise an exception for classes that
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001078don't define the method::
1079
1080 class Drawable():
1081 __metaclass__ = ABCMeta
Georg Brandle152a772008-05-24 18:31:28 +00001082
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001083 @abstractmethod
1084 def draw(self, x, y, scale):
1085 pass
1086
Georg Brandle152a772008-05-24 18:31:28 +00001087Note that the exception is only raised when you actually
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001088try to create an instance of a subclass without the method::
1089
1090 >>> s=Square()
1091 Traceback (most recent call last):
1092 File "<stdin>", line 1, in <module>
1093 TypeError: Can't instantiate abstract class Square with abstract methods draw
Georg Brandle152a772008-05-24 18:31:28 +00001094 >>>
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001095
1096Abstract data attributes can be declared using the ``@abstractproperty`` decorator::
1097
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001098 @abstractproperty
1099 def readonly(self):
1100 return self._x
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001101
Georg Brandle152a772008-05-24 18:31:28 +00001102Subclasses must then define a :meth:`readonly` property
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001103
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001104.. seealso::
1105
1106 :pep:`3119` - Introducing Abstract Base Classes
1107 PEP written by Guido van Rossum and Talin.
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001108 Implemented by Guido van Rossum.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001109 Backported to 2.6 by Benjamin Aranguren, with Alex Martelli.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001110
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001111.. ======================================================================
1112
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001113.. _pep-3127:
1114
1115PEP 3127: Integer Literal Support and Syntax
1116=====================================================
1117
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001118Python 3.0 changes the syntax for octal (base-8) integer literals,
1119which are now prefixed by "0o" or "0O" instead of a leading zero, and
1120adds support for binary (base-2) integer literals, signalled by a "0b"
1121or "0B" prefix.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001122
Georg Brandle152a772008-05-24 18:31:28 +00001123Python 2.6 doesn't drop support for a leading 0 signalling
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001124an octal number, but it does add support for "0o" and "0b"::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001125
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001126 >>> 0o21, 2*8 + 1
1127 (17, 17)
1128 >>> 0b101111
1129 47
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001130
Georg Brandle152a772008-05-24 18:31:28 +00001131The :func:`oct` built-in still returns numbers
1132prefixed with a leading zero, and a new :func:`bin`
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001133built-in returns the binary representation for a number::
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001134
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001135 >>> oct(42)
1136 '052'
1137 >>> bin(173)
1138 '0b10101101'
1139
1140The :func:`int` and :func:`long` built-ins will now accept the "0o"
1141and "0b" prefixes when base-8 or base-2 are requested, or when the
1142**base** argument is zero (meaning the base used is determined from
1143the string):
1144
1145 >>> int ('0o52', 0)
1146 42
1147 >>> int('1101', 2)
1148 13
1149 >>> int('0b1101', 2)
1150 13
1151 >>> int('0b1101', 0)
1152 13
1153
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001154
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001155.. seealso::
1156
1157 :pep:`3127` - Integer Literal Support and Syntax
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001158 PEP written by Patrick Maupin; backported to 2.6 by
1159 Eric Smith.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001160
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001161.. ======================================================================
1162
1163.. _pep-3129:
1164
1165PEP 3129: Class Decorators
1166=====================================================
1167
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001168Decorators have been extended from functions to classes. It's now legal to
1169write::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001170
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001171 @foo
1172 @bar
1173 class A:
1174 pass
1175
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001176This is equivalent to::
1177
1178 class A:
1179 pass
1180
1181 A = foo(bar(A))
1182
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001183.. seealso::
1184
1185 :pep:`3129` - Class Decorators
1186 PEP written by Collin Winter.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001187
1188.. ======================================================================
1189
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001190.. _pep-3141:
1191
1192PEP 3141: A Type Hierarchy for Numbers
1193=====================================================
1194
1195In Python 3.0, several abstract base classes for numeric types,
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001196inspired by Scheme's numeric tower, are being added.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001197This change was backported to 2.6 as the :mod:`numbers` module.
1198
1199The most general ABC is :class:`Number`. It defines no operations at
1200all, and only exists to allow checking if an object is a number by
1201doing ``isinstance(obj, Number)``.
1202
1203Numbers are further divided into :class:`Exact` and :class:`Inexact`.
1204Exact numbers can represent values precisely and operations never
1205round off the results or introduce tiny errors that may break the
Georg Brandl907a7202008-02-22 12:31:45 +00001206commutativity and associativity properties; inexact numbers may
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001207perform such rounding or introduce small errors. Integers, long
Georg Brandle152a772008-05-24 18:31:28 +00001208integers, and rational numbers are exact, while floating-point
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001209and complex numbers are inexact.
1210
1211:class:`Complex` is a subclass of :class:`Number`. Complex numbers
1212can undergo the basic operations of addition, subtraction,
1213multiplication, division, and exponentiation, and you can retrieve the
Georg Brandle152a772008-05-24 18:31:28 +00001214real and imaginary parts and obtain a number's conjugate. Python's built-in
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001215complex type is an implementation of :class:`Complex`.
1216
Georg Brandle152a772008-05-24 18:31:28 +00001217:class:`Real` further derives from :class:`Complex`, and adds
1218operations that only work on real numbers: :func:`floor`, :func:`trunc`,
1219rounding, taking the remainder mod N, floor division,
1220and comparisons.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001221
1222:class:`Rational` numbers derive from :class:`Real`, have
1223:attr:`numerator` and :attr:`denominator` properties, and can be
Mark Dickinsond058cd22008-02-10 21:29:51 +00001224converted to floats. Python 2.6 adds a simple rational-number class,
Georg Brandle152a772008-05-24 18:31:28 +00001225:class:`Fraction`, in the :mod:`fractions` module. (It's called
1226:class:`Fraction` instead of :class:`Rational` to avoid
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001227a name clash with :class:`numbers.Rational`.)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001228
1229:class:`Integral` numbers derive from :class:`Rational`, and
Georg Brandle152a772008-05-24 18:31:28 +00001230can be shifted left and right with ``<<`` and ``>>``,
1231combined using bitwise operations such as ``&`` and ``|``,
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001232and can be used as array indexes and slice boundaries.
1233
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001234In Python 3.0, the PEP slightly redefines the existing built-ins
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001235:func:`round`, :func:`math.floor`, :func:`math.ceil`, and adds a new
Georg Brandle152a772008-05-24 18:31:28 +00001236one, :func:`math.trunc`, that's been backported to Python 2.6.
1237:func:`math.trunc` rounds toward zero, returning the closest
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001238:class:`Integral` that's between the function's argument and zero.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001239
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001240.. seealso::
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001241
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001242 :pep:`3141` - A Type Hierarchy for Numbers
1243 PEP written by Jeffrey Yasskin.
1244
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001245 `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 +00001246
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001247 `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 +00001248
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001249
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001250The :mod:`fractions` Module
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001251--------------------------------------------------
1252
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001253To fill out the hierarchy of numeric types, a rational-number class is
1254provided by the :mod:`fractions` module. Rational numbers store their
1255values as a numerator and denominator forming a fraction, and can
1256exactly represent numbers such as ``2/3`` that floating-point numbers
1257can only approximate.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001258
Mark Dickinsond058cd22008-02-10 21:29:51 +00001259The :class:`Fraction` constructor takes two :class:`Integral` values
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001260that will be the numerator and denominator of the resulting fraction. ::
1261
Mark Dickinsond058cd22008-02-10 21:29:51 +00001262 >>> from fractions import Fraction
1263 >>> a = Fraction(2, 3)
1264 >>> b = Fraction(2, 5)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001265 >>> float(a), float(b)
1266 (0.66666666666666663, 0.40000000000000002)
1267 >>> a+b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001268 Fraction(16, 15)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001269 >>> a/b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001270 Fraction(5, 3)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001271
Georg Brandle152a772008-05-24 18:31:28 +00001272To help in converting floating-point numbers to rationals,
1273the float type now has a :meth:`as_integer_ratio()` method that returns
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001274the numerator and denominator for a fraction that evaluates to the same
1275floating-point value::
1276
1277 >>> (2.5) .as_integer_ratio()
1278 (5, 2)
1279 >>> (3.1415) .as_integer_ratio()
1280 (7074029114692207L, 2251799813685248L)
1281 >>> (1./3) .as_integer_ratio()
1282 (6004799503160661L, 18014398509481984L)
1283
1284Note that values that can only be approximated by floating-point
1285numbers, such as 1./3, are not simplified to the number being
1286approximated; the fraction attempts to match the floating-point value
1287**exactly**.
1288
Mark Dickinsond058cd22008-02-10 21:29:51 +00001289The :mod:`fractions` module is based upon an implementation by Sjoerd
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001290Mullender that was in Python's :file:`Demo/classes/` directory for a
1291long time. This implementation was significantly updated by Jeffrey
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001292Yasskin.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001293
Brett Cannon4b964f92008-05-05 20:21:38 +00001294
Georg Brandl8ec7f652007-08-15 14:28:01 +00001295Other Language Changes
1296======================
1297
1298Here are all of the changes that Python 2.6 makes to the core Python language.
1299
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00001300* The :func:`hasattr` function was catching and ignoring all errors,
Benjamin Peterson77cec6e2008-06-28 13:18:14 +00001301 under the assumption that they meant a :meth:`__getattr__` method
1302 was failing somewhere and the return value of :func:`hasattr` would
1303 therefore be ``False``. This logic shouldn't be applied to
1304 :exc:`KeyboardInterrupt` and :exc:`SystemExit`, however; Python 2.6
1305 will no longer discard such exceptions when :func:`hasattr`
1306 encounters them. (Fixed by Benjamin Peterson; :issue:`2196`.)
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00001307
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001308* When calling a function using the ``**`` syntax to provide keyword
1309 arguments, you are no longer required to use a Python dictionary;
1310 any mapping will now work::
1311
1312 >>> def f(**kw):
1313 ... print sorted(kw)
Georg Brandle152a772008-05-24 18:31:28 +00001314 ...
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001315 >>> ud=UserDict.UserDict()
1316 >>> ud['a'] = 1
1317 >>> ud['b'] = 'string'
1318 >>> f(**ud)
1319 ['a', 'b']
1320
Andrew M. Kuchlingc157c9c2008-04-09 22:28:43 +00001321 (Contributed by Alexander Belopolsky; :issue:`1686487`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001322
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001323* A new built-in, ``next(*iterator*, [*default*])`` returns the next item
1324 from the specified iterator. If the *default* argument is supplied,
1325 it will be returned if *iterator* has been exhausted; otherwise,
1326 the :exc:`StopIteration` exception will be raised. (:issue:`2719`)
1327
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001328* Tuples now have an :meth:`index` method matching the list type's
1329 :meth:`index` method::
1330
1331 >>> t = (0,1,2,3,4)
1332 >>> t.index(3)
1333 3
1334
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001335* The built-in types now have improved support for extended slicing syntax,
1336 where various combinations of ``(start, stop, step)`` are supplied.
1337 Previously, the support was partial and certain corner cases wouldn't work.
1338 (Implemented by Thomas Wouters.)
1339
Georg Brandlb19be572007-12-29 10:57:00 +00001340 .. Revision 57619
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001341
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001342* Properties now have three attributes, :attr:`getter`,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001343 :attr:`setter` and :attr:`deleter`, that are useful shortcuts for
Georg Brandle152a772008-05-24 18:31:28 +00001344 adding or modifying a getter, setter or deleter function to an
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001345 existing property. You would use them like this::
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001346
1347 class C(object):
Georg Brandle152a772008-05-24 18:31:28 +00001348 @property
1349 def x(self):
1350 return self._x
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001351
Georg Brandle152a772008-05-24 18:31:28 +00001352 @x.setter
1353 def x(self, value):
1354 self._x = value
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001355
Georg Brandle152a772008-05-24 18:31:28 +00001356 @x.deleter
1357 def x(self):
1358 del self._x
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001359
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001360 class D(C):
1361 @C.x.getter
1362 def x(self):
1363 return self._x * 2
1364
1365 @x.setter
1366 def x(self, value):
1367 self._x = value / 2
1368
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001369* Several methods of the built-in set types now accept multiple iterables:
1370 :meth:`intersection`,
1371 :meth:`intersection_update`,
1372 :meth:`union`, :meth:`update`,
1373 :meth:`difference` and :meth:`difference_update`.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001374
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001375 ::
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001376
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001377 >>> s=set('1234567890')
1378 >>> s.intersection('abc123', 'cdf246') # Intersection between all inputs
1379 set(['2'])
1380 >>> s.difference('246', '789')
1381 set(['1', '0', '3', '5'])
1382
1383 (Contributed by Raymond Hettinger.)
1384
1385* A numerical nicety: when creating a complex number from two floats
Georg Brandle152a772008-05-24 18:31:28 +00001386 on systems that support signed zeros (-0 and +0), the
1387 :func:`complex` constructor will now preserve the sign
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001388 of the zero. (Fixed by Mark T. Dickinson; :issue:`1507`)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001389
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001390* More floating-point features were also added. The :func:`float` function
Mark Dickinsonc72b7872008-06-24 11:08:58 +00001391 will now turn the string ``nan`` into an
1392 IEEE 754 Not A Number value, and ``+inf`` and ``-inf`` into
Georg Brandle152a772008-05-24 18:31:28 +00001393 positive or negative infinity. This works on any platform with
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001394 IEEE 754 semantics. (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001395
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001396 Other functions in the :mod:`math` module, :func:`isinf` and
1397 :func:`isnan`, return true if their floating-point argument is
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001398 infinite or Not A Number. (:issue:`1640`)
Georg Brandle1b8e9c2008-02-20 19:12:36 +00001399
Mark Dickinsond3035782008-06-20 15:17:41 +00001400* The :mod:`math` module has a number of new functions, and the existing
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001401 functions have been improved to give more consistent behaviour
1402 across platforms, especially with respect to handling of
1403 floating-point exceptions and IEEE 754 special values.
Georg Brandle152a772008-05-24 18:31:28 +00001404 The new functions are:
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001405
Georg Brandlf91c70a2008-06-20 19:28:18 +00001406 * :func:`~math.isinf` and :func:`~math.isnan` determine whether a given float
1407 is a (positive or negative) infinity or a NaN (Not a Number), respectively.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001408
Georg Brandlf91c70a2008-06-20 19:28:18 +00001409 * :func:`~math.copysign` copies the sign bit of an IEEE 754 number,
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001410 returning the absolute value of *x* combined with the sign bit of
1411 *y*. For example, ``math.copysign(1, -0.0)`` returns -1.0.
1412 (Contributed by Christian Heimes.)
1413
Georg Brandlf91c70a2008-06-20 19:28:18 +00001414 * :func:`~math.factorial` computes the factorial of a number.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001415 (Contributed by Raymond Hettinger; :issue:`2138`.)
1416
Georg Brandlf91c70a2008-06-20 19:28:18 +00001417 * :func:`~math.sum` adds up the stream of numbers from an iterable,
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001418 and is careful to avoid loss of precision by calculating partial sums.
1419 (Contributed by Jean Brouwers; :issue:`2819`.)
1420
Georg Brandlf91c70a2008-06-20 19:28:18 +00001421 * The inverse hyperbolic functions :func:`~math.acosh`, :func:`~math.asinh`
1422 and :func:`~math.atanh`.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001423
Georg Brandlf91c70a2008-06-20 19:28:18 +00001424 * The function :func:`~math.log1p`, returning the natural logarithm of *1+x*
1425 (base *e*).
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001426
Georg Brandlf91c70a2008-06-20 19:28:18 +00001427 There's also a new :func:`trunc` built-in function as a result of the
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001428 backport of `PEP 3141's type hierarchy for numbers <#pep-3141>`__.
1429
1430 The existing math functions have been modified to follow the
1431 recommendations of the C99 standard with respect to special values
1432 whenever possible. For example, ``sqrt(-1.)`` should now give a
1433 :exc:`ValueError` across (nearly) all platforms, while
1434 ``sqrt(float('NaN'))`` should return a NaN on all IEEE 754
1435 platforms. Where Annex 'F' of the C99 standard recommends signaling
1436 'divide-by-zero' or 'invalid', Python will raise :exc:`ValueError`.
1437 Where Annex 'F' of the C99 standard recommends signaling 'overflow',
1438 Python will raise :exc:`OverflowError`. (See :issue:`711019`,
1439 :issue:`1640`.)
1440
1441 (Contributed by Christian Heimes and Mark Dickinson.)
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001442
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001443* Changes to the :class:`Exception` interface
Georg Brandle152a772008-05-24 18:31:28 +00001444 as dictated by :pep:`352` continue to be made. For 2.6,
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001445 the :attr:`message` attribute is being deprecated in favor of the
1446 :attr:`args` attribute.
1447
Georg Brandle152a772008-05-24 18:31:28 +00001448* The :exc:`GeneratorExit` exception now subclasses
1449 :exc:`BaseException` instead of :exc:`Exception`. This means
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001450 that an exception handler that does ``except Exception:``
Georg Brandle152a772008-05-24 18:31:28 +00001451 will not inadvertently catch :exc:`GeneratorExit`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001452 (Contributed by Chad Austin; :issue:`1537`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001453
Georg Brandle152a772008-05-24 18:31:28 +00001454* Generator objects now have a :attr:`gi_code` attribute that refers to
1455 the original code object backing the generator.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001456 (Contributed by Collin Winter; :issue:`1473257`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001457
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001458* The :func:`compile` built-in function now accepts keyword arguments
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001459 as well as positional parameters. (Contributed by Thomas Wouters;
1460 :issue:`1444529`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001461
Georg Brandle152a772008-05-24 18:31:28 +00001462* The :func:`complex` constructor now accepts strings containing
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001463 parenthesized complex numbers, letting ``complex(repr(cmplx))``
1464 will now round-trip values. For example, ``complex('(3+4j)')``
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001465 now returns the value (3+4j). (:issue:`1491866`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001466
Georg Brandle152a772008-05-24 18:31:28 +00001467* The string :meth:`translate` method now accepts ``None`` as the
1468 translation table parameter, which is treated as the identity
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001469 transformation. This makes it easier to carry out operations
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001470 that only delete characters. (Contributed by Bengt Richter;
1471 :issue:`1193128`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001472
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001473* The built-in :func:`dir` function now checks for a :meth:`__dir__`
1474 method on the objects it receives. This method must return a list
1475 of strings containing the names of valid attributes for the object,
1476 and lets the object control the value that :func:`dir` produces.
Georg Brandle152a772008-05-24 18:31:28 +00001477 Objects that have :meth:`__getattr__` or :meth:`__getattribute__`
Facundo Batistabd5b6232007-12-03 19:49:54 +00001478 methods can use this to advertise pseudo-attributes they will honor.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001479 (:issue:`1591665`)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001480
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001481* Instance method objects have new attributes for the object and function
1482 comprising the method; the new synonym for :attr:`im_self` is
1483 :attr:`__self__`, and :attr:`im_func` is also available as :attr:`__func__`.
1484 The old names are still supported in Python 2.6; they're gone in 3.0.
1485
Georg Brandl8ec7f652007-08-15 14:28:01 +00001486* An obscure change: when you use the the :func:`locals` function inside a
1487 :keyword:`class` statement, the resulting dictionary no longer returns free
1488 variables. (Free variables, in this case, are variables referred to in the
1489 :keyword:`class` statement that aren't attributes of the class.)
1490
Georg Brandlb19be572007-12-29 10:57:00 +00001491.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001492
1493
1494Optimizations
1495-------------
1496
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001497* The :mod:`warnings` module has been rewritten in C. This makes
1498 it possible to invoke warnings from the parser, and may also
1499 make the interpreter's startup faster.
1500 (Contributed by Neal Norwitz and Brett Cannon; :issue:`1631171`.)
1501
Georg Brandlaf30b282008-01-15 06:55:56 +00001502* Type objects now have a cache of methods that can reduce
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001503 the amount of work required to find the correct method implementation
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001504 for a particular class; once cached, the interpreter doesn't need to
Georg Brandle152a772008-05-24 18:31:28 +00001505 traverse base classes to figure out the right method to call.
1506 The cache is cleared if a base class or the class itself is modified,
1507 so the cache should remain correct even in the face of Python's dynamic
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001508 nature.
Georg Brandle152a772008-05-24 18:31:28 +00001509 (Original optimization implemented by Armin Rigo, updated for
1510 Python 2.6 by Kevin Jacobs; :issue:`1700288`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001511
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001512* All of the functions in the :mod:`struct` module have been rewritten in
1513 C, thanks to work at the Need For Speed sprint.
1514 (Contributed by Raymond Hettinger.)
1515
Georg Brandl8ec7f652007-08-15 14:28:01 +00001516* Internally, a bit is now set in type objects to indicate some of the standard
1517 built-in types. This speeds up checking if an object is a subclass of one of
1518 these types. (Contributed by Neal Norwitz.)
1519
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001520* Unicode strings now use faster code for detecting
Georg Brandle152a772008-05-24 18:31:28 +00001521 whitespace and line breaks; this speeds up the :meth:`split` method
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001522 by about 25% and :meth:`splitlines` by 35%.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001523 (Contributed by Antoine Pitrou.) Memory usage is reduced
1524 by using pymalloc for the Unicode string's data.
1525
1526* The ``with`` statement now stores the :meth:`__exit__` method on the stack,
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001527 producing a small speedup. (Implemented by Jeffrey Yasskin.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001528
1529* To reduce memory usage, the garbage collector will now clear internal
1530 free lists when garbage-collecting the highest generation of objects.
1531 This may return memory to the OS sooner.
1532
Georg Brandl8ec7f652007-08-15 14:28:01 +00001533The net result of the 2.6 optimizations is that Python 2.6 runs the pystone
1534benchmark around XX% faster than Python 2.5.
1535
Georg Brandlb19be572007-12-29 10:57:00 +00001536.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001537
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001538.. _new-26-interpreter:
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001539
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001540Interpreter Changes
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001541-------------------------------
1542
1543Two command-line options have been reserved for use by other Python
1544implementations. The :option:`-J` switch has been reserved for use by
1545Jython for Jython-specific options, such as ones that are passed to
1546the underlying JVM. :option:`-X` has been reserved for options
1547specific to a particular implementation of Python such as CPython,
1548Jython, or IronPython. If either option is used with Python 2.6, the
1549interpreter will report that the option isn't currently used.
1550
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00001551It's now possible to prevent Python from writing :file:`.pyc` or
1552:file:`.pyo` files on importing a module by supplying the :option:`-B`
1553switch to the Python interpreter, or by setting the
1554:envvar:`PYTHONDONTWRITEBYTECODE` environment variable before running
1555the interpreter. This setting is available to Python programs as the
1556``sys.dont_write_bytecode`` variable, and can be changed by Python
1557code to modify the interpreter's behaviour. (Contributed by Neal
1558Norwitz and Georg Brandl.)
1559
1560The encoding used for standard input, output, and standard error can
1561be specified by setting the :envvar:`PYTHONIOENCODING` environment
1562variable before running the interpreter. The value should be a string
1563in the form ``**encoding**`` or ``**encoding**:**errorhandler**``.
1564The **encoding** part specifies the encoding's name, e.g. ``utf-8`` or
1565``latin-1``; the optional **errorhandler** part specifies
1566what to do with characters that can't be handled by the encoding,
1567and should be one of "error", "ignore", or "replace". (Contributed
1568by Martin von Loewis.)
1569
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001570.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001571
1572New, Improved, and Deprecated Modules
1573=====================================
1574
1575As usual, Python's standard library received a number of enhancements and bug
1576fixes. Here's a partial list of the most notable changes, sorted alphabetically
1577by module name. Consult the :file:`Misc/NEWS` file in the source tree for a more
Benjamin Peterson7b5151c2008-05-15 22:41:16 +00001578complete list of changes, or look through the Subversion logs for all the
1579details.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001580
Georg Brandle152a772008-05-24 18:31:28 +00001581* (3.0-warning mode) Python 3.0 will feature a reorganized standard
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001582 library; many outdated modules are being dropped.
Georg Brandle152a772008-05-24 18:31:28 +00001583 Python 2.6 running in 3.0-warning mode will warn about these modules
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001584 when they are imported.
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001585
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001586 The list of deprecated modules is:
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001587 :mod:`audiodev`,
1588 :mod:`bgenlocations`,
1589 :mod:`buildtools`,
1590 :mod:`bundlebuilder`,
1591 :mod:`Canvas`,
1592 :mod:`compiler`,
1593 :mod:`dircache`,
1594 :mod:`dl`,
1595 :mod:`fpformat`,
1596 :mod:`gensuitemodule`,
1597 :mod:`ihooks`,
1598 :mod:`imageop`,
1599 :mod:`imgfile`,
1600 :mod:`linuxaudiodev`,
1601 :mod:`mhlib`,
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001602 :mod:`mimetools`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001603 :mod:`multifile`,
1604 :mod:`new`,
1605 :mod:`popen2`,
1606 :mod:`pure`,
1607 :mod:`statvfs`,
1608 :mod:`sunaudiodev`,
1609 :mod:`test.testall`,
1610 :mod:`toaiff`.
1611
Benjamin Peterson36d879b2008-05-19 11:55:54 +00001612 Various MacOS modules have been removed:
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001613 :mod:`_builtinSuites`,
1614 :mod:`aepack`,
1615 :mod:`aetools`,
1616 :mod:`aetypes`,
1617 :mod:`applesingle`,
1618 :mod:`appletrawmain`,
1619 :mod:`appletrunner`,
1620 :mod:`argvemulator`,
1621 :mod:`Audio_mac`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001622 :mod:`autoGIL`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001623 :mod:`Carbon`,
1624 :mod:`cfmfile`,
1625 :mod:`CodeWarrior`,
1626 :mod:`ColorPicker`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001627 :mod:`EasyDialogs`,
1628 :mod:`Explorer`,
1629 :mod:`Finder`,
1630 :mod:`FrameWork`,
1631 :mod:`findertools`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001632 :mod:`ic`,
1633 :mod:`icglue`,
1634 :mod:`icopen`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001635 :mod:`macerrors`,
1636 :mod:`MacOS`,
1637 :mod:`macostools`,
1638 :mod:`macresource`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001639 :mod:`MiniAEFrame`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001640 :mod:`Nav`,
1641 :mod:`Netscape`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001642 :mod:`OSATerminology`,
1643 :mod:`pimp`,
1644 :mod:`PixMapWrapper`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001645 :mod:`StdSuites`,
Benjamin Petersona19f9f92008-05-15 22:34:33 +00001646 :mod:`SystemEvents`,
1647 :mod:`Terminal`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001648 :mod:`terminalcommand`.
Andrew M. Kuchlingc72df332008-05-14 00:46:41 +00001649
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001650 A number of old IRIX-specific modules were deprecated:
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001651 :mod:`al` and :mod:`AL`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001652 :mod:`cd`,
1653 :mod:`cddb`,
1654 :mod:`cdplayer`,
1655 :mod:`CL` and :mod:`cl`,
1656 :mod:`DEVICE`,
1657 :mod:`ERRNO`,
1658 :mod:`FILE`,
1659 :mod:`FL` and :mod:`fl`,
1660 :mod:`flp`,
1661 :mod:`fm`,
1662 :mod:`GET`,
1663 :mod:`GLWS`,
1664 :mod:`GL` and :mod:`gl`,
1665 :mod:`IN`,
1666 :mod:`IOCTL`,
1667 :mod:`jpeg`,
1668 :mod:`panelparser`,
1669 :mod:`readcd`,
1670 :mod:`SV` and :mod:`sv`,
1671 :mod:`torgb`,
1672 :mod:`videoreader`,
1673 :mod:`WAIT`.
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00001674
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001675* The :mod:`asyncore` and :mod:`asynchat` modules are
1676 being actively maintained again, and a number of patches and bugfixes
1677 were applied. (Maintained by Josiah Carlson; see :issue:`1736190` for
1678 one patch.)
1679
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001680* The :mod:`bsddb.dbshelve` module now uses the highest pickling protocol
1681 available, instead of restricting itself to protocol 1.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001682 (Contributed by W. Barnes; :issue:`1551443`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001683
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00001684* The :mod:`cgi` module will now read variables from the query string of an
1685 HTTP POST request. This makes it possible to use form actions with
1686 URLs such as "/cgi-bin/add.py?category=1". (Contributed by
1687 Alexandre Fiori and Nubis; :issue:`1817`.)
1688
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001689* The :mod:`cmath` module underwent an extensive set of revisions,
1690 thanks to Mark Dickinson and Christian Heimes, that added some new
1691 features and greatly improved the accuracy of the computations.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001692
Georg Brandle152a772008-05-24 18:31:28 +00001693 Five new functions were added:
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001694
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001695 * :func:`polar` converts a complex number to polar form, returning
Georg Brandle152a772008-05-24 18:31:28 +00001696 the modulus and argument of that complex number.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001697
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001698 * :func:`rect` does the opposite, turning a (modulus, argument) pair
1699 back into the corresponding complex number.
1700
Georg Brandle152a772008-05-24 18:31:28 +00001701 * :func:`phase` returns the phase or argument of a complex number.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001702
1703 * :func:`isnan` returns True if either
Georg Brandle152a772008-05-24 18:31:28 +00001704 the real or imaginary part of its argument is a NaN.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001705
1706 * :func:`isinf` returns True if either the real or imaginary part of
1707 its argument is infinite.
1708
1709 The revisions also improved the numerical soundness of the
1710 :mod:`cmath` module. For all functions, the real and imaginary
1711 parts of the results are accurate to within a few units of least
1712 precision (ulps) whenever possible. See :issue:`1381` for the
1713 details. The branch cuts for :func:`asinh`, :func:`atanh`: and
1714 :func:`atan` have also been corrected.
1715
1716 The tests for the module have been greatly expanded; nearly 2000 new
1717 test cases exercise the algebraic functions.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001718
1719 On IEEE 754 platforms, the :mod:`cmath` module now handles IEEE 754
1720 special values and floating-point exceptions in a manner consistent
1721 with Annex 'G' of the C99 standard.
1722
Andrew M. Kuchling6d57c822007-10-23 20:55:47 +00001723* A new data type in the :mod:`collections` module: :class:`namedtuple(typename,
Georg Brandl8ec7f652007-08-15 14:28:01 +00001724 fieldnames)` is a factory function that creates subclasses of the standard tuple
1725 whose fields are accessible by name as well as index. For example::
1726
Georg Brandle152a772008-05-24 18:31:28 +00001727 >>> var_type = collections.namedtuple('variable',
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001728 ... 'id name type size')
1729 # Names are separated by spaces or commas.
1730 # 'id, name, type, size' would also work.
Raymond Hettinger366523c2007-12-14 18:12:21 +00001731 >>> var_type._fields
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001732 ('id', 'name', 'type', 'size')
Georg Brandl8ec7f652007-08-15 14:28:01 +00001733
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001734 >>> var = var_type(1, 'frequency', 'int', 4)
1735 >>> print var[0], var.id # Equivalent
1736 1 1
1737 >>> print var[2], var.type # Equivalent
1738 int int
Raymond Hettinger366523c2007-12-14 18:12:21 +00001739 >>> var._asdict()
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001740 {'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'}
Raymond Hettingere9b9b352008-02-15 21:21:25 +00001741 >>> v2 = var._replace(name='amplitude')
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001742 >>> v2
1743 variable(id=1, name='amplitude', type='int', size=4)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001744
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001745 Where the new :class:`namedtuple` type proved suitable, the standard
Georg Brandle152a772008-05-24 18:31:28 +00001746 library has been modified to return them. For example,
1747 the :meth:`Decimal.as_tuple` method now returns a named tuple with
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001748 :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
1749
Georg Brandl8ec7f652007-08-15 14:28:01 +00001750 (Contributed by Raymond Hettinger.)
1751
Georg Brandle152a772008-05-24 18:31:28 +00001752* Another change to the :mod:`collections` module is that the
Georg Brandle7d118a2007-12-08 11:05:05 +00001753 :class:`deque` type now supports an optional *maxlen* parameter;
Georg Brandle152a772008-05-24 18:31:28 +00001754 if supplied, the deque's size will be restricted to no more
Georg Brandle7d118a2007-12-08 11:05:05 +00001755 than *maxlen* items. Adding more items to a full deque causes
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001756 old items to be discarded.
1757
1758 ::
1759
1760 >>> from collections import deque
1761 >>> dq=deque(maxlen=3)
1762 >>> dq
1763 deque([], maxlen=3)
1764 >>> dq.append(1) ; dq.append(2) ; dq.append(3)
1765 >>> dq
1766 deque([1, 2, 3], maxlen=3)
1767 >>> dq.append(4)
1768 >>> dq
1769 deque([2, 3, 4], maxlen=3)
1770
1771 (Contributed by Raymond Hettinger.)
1772
Thomas Hellerfb0117e2008-06-06 18:42:11 +00001773* XXX Describe the new ctypes calling convention that allows safe
1774 access to errno.
1775 (Implemented by Thomas Heller; :issue:`1798`.)
1776
Georg Brandle152a772008-05-24 18:31:28 +00001777* The :mod:`ctypes` module now supports a :class:`c_bool` datatype
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001778 that represents the C99 ``bool`` type. (Contributed by David Remahl;
1779 :issue:`1649190`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001780
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001781 The :mod:`ctypes` string, buffer and array types also have improved
1782 support for extended slicing syntax,
1783 where various combinations of ``(start, stop, step)`` are supplied.
1784 (Implemented by Thomas Wouters.)
1785
Georg Brandlb19be572007-12-29 10:57:00 +00001786 .. Revision 57769
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001787
Georg Brandl8ec7f652007-08-15 14:28:01 +00001788* A new method in the :mod:`curses` module: for a window, :meth:`chgat` changes
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001789 the display characters for a certain number of characters on a single line.
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001790 (Contributed by Fabian Kreutz.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001791 ::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001792
Georg Brandle152a772008-05-24 18:31:28 +00001793 # Boldface text starting at y=0,x=21
Georg Brandl8ec7f652007-08-15 14:28:01 +00001794 # and affecting the rest of the line.
Georg Brandle152a772008-05-24 18:31:28 +00001795 stdscr.chgat(0,21, curses.A_BOLD)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001796
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001797 The :class:`Textbox` class in the :mod:`curses.textpad` module
1798 now supports editing in insert mode as well as overwrite mode.
1799 Insert mode is enabled by supplying a true value for the *insert_mode*
1800 parameter when creating the :class:`Textbox` instance.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001801
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001802* The :mod:`datetime` module's :meth:`strftime` methods now support a
1803 ``%f`` format code that expands to the number of microseconds in the
1804 object, zero-padded on
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001805 the left to six places. (Contributed by Skip Montanaro; :issue:`1158`.)
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001806
Georg Brandle152a772008-05-24 18:31:28 +00001807* The :mod:`decimal` module was updated to version 1.66 of
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001808 `the General Decimal Specification <http://www2.hursley.ibm.com/decimal/decarith.html>`__. New features
1809 include some methods for some basic mathematical functions such as
1810 :meth:`exp` and :meth:`log10`::
1811
1812 >>> Decimal(1).exp()
1813 Decimal("2.718281828459045235360287471")
1814 >>> Decimal("2.7182818").ln()
1815 Decimal("0.9999999895305022877376682436")
1816 >>> Decimal(1000).log10()
1817 Decimal("3")
1818
Georg Brandle152a772008-05-24 18:31:28 +00001819 The :meth:`as_tuple` method of :class:`Decimal` objects now returns a
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001820 named tuple with :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
Georg Brandle152a772008-05-24 18:31:28 +00001821
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001822 (Implemented by Facundo Batista and Mark Dickinson. Named tuple
1823 support added by Raymond Hettinger.)
1824
Georg Brandle152a772008-05-24 18:31:28 +00001825* The :mod:`difflib` module's :class:`SequenceMatcher` class
1826 now returns named tuples representing matches.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001827 In addition to behaving like tuples, the returned values
1828 also have :attr:`a`, :attr:`b`, and :attr:`size` attributes.
1829 (Contributed by Raymond Hettinger.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001830
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001831* An optional ``timeout`` parameter was added to the
1832 :class:`ftplib.FTP` class constructor as well as the :meth:`connect`
1833 method, specifying a timeout measured in seconds. (Added by Facundo
Georg Brandle152a772008-05-24 18:31:28 +00001834 Batista.) Also, the :class:`FTP` class's
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001835 :meth:`storbinary` and :meth:`storlines`
Georg Brandle152a772008-05-24 18:31:28 +00001836 now take an optional *callback* parameter that will be called with
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001837 each block of data after the data has been sent.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001838 (Contributed by Phil Schwartz; :issue:`1221598`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001839
Georg Brandle152a772008-05-24 18:31:28 +00001840* The :func:`reduce` built-in function is also available in the
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001841 :mod:`functools` module. In Python 3.0, the built-in is dropped and it's
1842 only available from :mod:`functools`; currently there are no plans
Georg Brandle152a772008-05-24 18:31:28 +00001843 to drop the built-in in the 2.x series. (Patched by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001844 Christian Heimes; :issue:`1739906`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001845
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001846* When possible, the :mod:`getpass` module will now use
1847 :file:`/dev/tty` (when available) to print
1848 a prompting message and read the password, falling back to using
1849 standard error and standard input. If the password may be echoed to
1850 the terminal, a warning is printed before the prompt is displayed.
1851 (Contributed by Gregory P. Smith.)
1852
Georg Brandle152a772008-05-24 18:31:28 +00001853* The :func:`glob.glob` function can now return Unicode filenames if
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001854 a Unicode path was used and Unicode filenames are matched within the
1855 directory. (:issue:`1001604`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001856
1857* The :mod:`gopherlib` module has been removed.
1858
Georg Brandle152a772008-05-24 18:31:28 +00001859* A new function in the :mod:`heapq` module: ``merge(iter1, iter2, ...)``
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001860 takes any number of iterables that return data *in sorted
1861 order*, and returns a new iterator that returns the contents of all
1862 the iterators, also in sorted order. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001863
1864 heapq.merge([1, 3, 5, 9], [2, 8, 16]) ->
1865 [1, 2, 3, 5, 8, 9, 16]
1866
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001867 Another new function, ``heappushpop(heap, item)``,
Georg Brandle152a772008-05-24 18:31:28 +00001868 pushes *item* onto *heap*, then pops off and returns the smallest item.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001869 This is more efficient than making a call to :func:`heappush` and then
1870 :func:`heappop`.
1871
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001872 :mod:`heapq` is now implemented to only use less-than comparison,
1873 instead of the less-than-or-equal comparison it previously used.
1874 This makes :mod:`heapq`'s usage of a type match that of the
1875 :meth:`list.sort` method.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001876 (Contributed by Raymond Hettinger.)
1877
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001878* An optional ``timeout`` parameter was added to the
Georg Brandle152a772008-05-24 18:31:28 +00001879 :class:`httplib.HTTPConnection` and :class:`HTTPSConnection`
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001880 class constructors, specifying a timeout measured in seconds.
1881 (Added by Facundo Batista.)
1882
Georg Brandle152a772008-05-24 18:31:28 +00001883* Most of the :mod:`inspect` module's functions, such as
1884 :func:`getmoduleinfo` and :func:`getargs`, now return named tuples.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001885 In addition to behaving like tuples, the elements of the return value
1886 can also be accessed as attributes.
1887 (Contributed by Raymond Hettinger.)
1888
Georg Brandle152a772008-05-24 18:31:28 +00001889 Some new functions in the module include
1890 :func:`isgenerator`, :func:`isgeneratorfunction`,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001891 and :func:`isabstract`.
1892
1893* The :mod:`itertools` module gained several new functions.
1894
1895 ``izip_longest(iter1, iter2, ...[, fillvalue])`` makes tuples from
1896 each of the elements; if some of the iterables are shorter than
1897 others, the missing values are set to *fillvalue*. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001898
1899 itertools.izip_longest([1,2,3], [1,2,3,4,5]) ->
1900 [(1, 1), (2, 2), (3, 3), (None, 4), (None, 5)]
1901
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001902 ``product(iter1, iter2, ..., [repeat=N])`` returns the Cartesian product
1903 of the supplied iterables, a set of tuples containing
1904 every possible combination of the elements returned from each iterable. ::
1905
1906 itertools.product([1,2,3], [4,5,6]) ->
Georg Brandle152a772008-05-24 18:31:28 +00001907 [(1, 4), (1, 5), (1, 6),
1908 (2, 4), (2, 5), (2, 6),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001909 (3, 4), (3, 5), (3, 6)]
1910
1911 The optional *repeat* keyword argument is used for taking the
Georg Brandle152a772008-05-24 18:31:28 +00001912 product of an iterable or a set of iterables with themselves,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001913 repeated *N* times. With a single iterable argument, *N*-tuples
1914 are returned::
1915
1916 itertools.product([1,2], repeat=3)) ->
Georg Brandle152a772008-05-24 18:31:28 +00001917 [(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001918 (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]
1919
1920 With two iterables, *2N*-tuples are returned. ::
1921
1922 itertools(product([1,2], [3,4], repeat=2) ->
Georg Brandle152a772008-05-24 18:31:28 +00001923 [(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
1924 (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
1925 (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001926 (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]
1927
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001928 ``combinations(iterable, r)`` returns sub-sequences of length *r* from
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001929 the elements of *iterable*. ::
1930
1931 itertools.combinations('123', 2) ->
1932 [('1', '2'), ('1', '3'), ('2', '3')]
1933
1934 itertools.combinations('123', 3) ->
1935 [('1', '2', '3')]
1936
1937 itertools.combinations('1234', 3) ->
Georg Brandle152a772008-05-24 18:31:28 +00001938 [('1', '2', '3'), ('1', '2', '4'), ('1', '3', '4'),
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001939 ('2', '3', '4')]
1940
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001941 ``permutations(iter[, r])`` returns all the permutations of length *r* of
Georg Brandle152a772008-05-24 18:31:28 +00001942 the iterable's elements. If *r* is not specified, it will default to the
Georg Brandlcb635652008-05-05 20:59:05 +00001943 number of elements produced by the iterable. ::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001944
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001945 itertools.permutations([1,2,3,4], 2) ->
Georg Brandle152a772008-05-24 18:31:28 +00001946 [(1, 2), (1, 3), (1, 4),
1947 (2, 1), (2, 3), (2, 4),
1948 (3, 1), (3, 2), (3, 4),
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001949 (4, 1), (4, 2), (4, 3)]
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001950
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001951 ``itertools.chain(*iterables)`` is an existing function in
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001952 :mod:`itertools` that gained a new constructor in Python 2.6.
Georg Brandle152a772008-05-24 18:31:28 +00001953 ``itertools.chain.from_iterable(iterable)`` takes a single
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001954 iterable that should return other iterables. :func:`chain` will
1955 then return all the elements of the first iterable, then
1956 all the elements of the second, and so on. ::
1957
1958 chain.from_iterable([[1,2,3], [4,5,6]]) ->
1959 [1, 2, 3, 4, 5, 6]
Georg Brandle152a772008-05-24 18:31:28 +00001960
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001961 (All contributed by Raymond Hettinger.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001962
Georg Brandle152a772008-05-24 18:31:28 +00001963* The :mod:`logging` module's :class:`FileHandler` class
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001964 and its subclasses :class:`WatchedFileHandler`, :class:`RotatingFileHandler`,
Georg Brandle152a772008-05-24 18:31:28 +00001965 and :class:`TimedRotatingFileHandler` now
1966 have an optional *delay* parameter to its constructor. If *delay*
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001967 is true, opening of the log file is deferred until the first
1968 :meth:`emit` call is made. (Contributed by Vinay Sajip.)
1969
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001970 :class:`TimedRotatingFileHandler` also has a *utc* constructor
1971 parameter. If the argument is true, UTC time will be used
1972 in determining when midnight occurs and in generating filenames;
1973 otherwise local time will be used.
1974
Georg Brandl8ec7f652007-08-15 14:28:01 +00001975* The :mod:`macfs` module has been removed. This in turn required the
1976 :func:`macostools.touched` function to be removed because it depended on the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001977 :mod:`macfs` module. (:issue:`1490190`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001978
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001979* :class:`mmap` objects now have a :meth:`rfind` method that finds
1980 a substring, beginning at the end of the string and searching
1981 backwards. The :meth:`find` method
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001982 also gained an *end* parameter containing the index at which to stop
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001983 the forward search.
1984 (Contributed by John Lenton.)
1985
Georg Brandle152a772008-05-24 18:31:28 +00001986* The :mod:`operator` module gained a
1987 :func:`methodcaller` function that takes a name and an optional
1988 set of arguments, returning a callable that will call
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001989 the named function on any arguments passed to it. For example::
1990
1991 >>> # Equivalent to lambda s: s.replace('old', 'new')
1992 >>> replacer = operator.methodcaller('replace', 'old', 'new')
1993 >>> replacer('old wine in old bottles')
1994 'new wine in new bottles'
Georg Brandle152a772008-05-24 18:31:28 +00001995
Georg Brandl27504da2008-03-04 07:25:54 +00001996 (Contributed by Georg Brandl, after a suggestion by Gregory Petrosyan.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001997
1998 The :func:`attrgetter` function now accepts dotted names and performs
1999 the corresponding attribute lookups::
2000
2001 >>> inst_name = operator.attrgetter('__class__.__name__')
2002 >>> inst_name('')
2003 'str'
2004 >>> inst_name(help)
2005 '_Helper'
2006
Georg Brandl27504da2008-03-04 07:25:54 +00002007 (Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002008
Georg Brandle152a772008-05-24 18:31:28 +00002009* New functions in the :mod:`os` module include
2010 ``fchmod(fd, mode)``, ``fchown(fd, uid, gid)``,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002011 and ``lchmod(path, mode)``, on operating systems that support these
2012 functions. :func:`fchmod` and :func:`fchown` let you change the mode
2013 and ownership of an opened file, and :func:`lchmod` changes the mode
2014 of a symlink.
2015
2016 (Contributed by Georg Brandl and Christian Heimes.)
2017
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002018* The :func:`os.walk` function now has a ``followlinks`` parameter. If
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002019 set to True, it will follow symlinks pointing to directories and
2020 visit the directory's contents. For backward compatibility, the
2021 parameter's default value is false. Note that the function can fall
2022 into an infinite recursion if there's a symlink that points to a
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002023 parent directory. (:issue:`1273829`)
Georg Brandle152a772008-05-24 18:31:28 +00002024
2025* The ``os.environ`` object's :meth:`clear` method will now unset the
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002026 environment variables using :func:`os.unsetenv` in addition to clearing
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002027 the object's keys. (Contributed by Martin Horcicka; :issue:`1181`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002028
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002029* In the :mod:`os.path` module, the :func:`splitext` function
2030 has been changed to not split on leading period characters.
2031 This produces better results when operating on Unix's dot-files.
2032 For example, ``os.path.splitext('.ipython')``
2033 now returns ``('.ipython', '')`` instead of ``('', '.ipython')``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002034 (:issue:`115886`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002035
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002036 A new function, :func:`relpath(path, start)` returns a relative path
2037 from the ``start`` path, if it's supplied, or from the current
2038 working directory to the destination ``path``. (Contributed by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002039 Richard Barran; :issue:`1339796`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002040
Georg Brandle152a772008-05-24 18:31:28 +00002041 On Windows, :func:`os.path.expandvars` will now expand environment variables
2042 in the form "%var%", and "~user" will be expanded into the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002043 user's home directory path. (Contributed by Josiah Carlson;
2044 :issue:`957650`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002045
Georg Brandle152a772008-05-24 18:31:28 +00002046* The Python debugger provided by the :mod:`pdb` module
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002047 gained a new command: "run" restarts the Python program being debugged,
2048 and can optionally take new command-line arguments for the program.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002049 (Contributed by Rocky Bernstein; :issue:`1393667`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002050
Georg Brandle152a772008-05-24 18:31:28 +00002051 The :func:`post_mortem` function, used to enter debugging of a
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002052 traceback, will now use the traceback returned by :func:`sys.exc_info`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002053 if no traceback is supplied. (Contributed by Facundo Batista;
2054 :issue:`1106316`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002055
Georg Brandle152a772008-05-24 18:31:28 +00002056* The :mod:`pickletools` module now has an :func:`optimize` function
2057 that takes a string containing a pickle and removes some unused
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002058 opcodes, returning a shorter pickle that contains the same data structure.
2059 (Contributed by Raymond Hettinger.)
2060
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002061* A :func:`get_data` function was added to the :mod:`pkgutil`
2062 module that returns the contents of resource files included
2063 with an installed Python package. For example::
2064
Benjamin Peterson60ffcbe2008-04-21 22:57:00 +00002065 >>> import pkgutil
2066 >>> pkgutil.get_data('test', 'exception_hierarchy.txt')
2067 'BaseException
2068 +-- SystemExit
2069 +-- KeyboardInterrupt
2070 +-- GeneratorExit
2071 +-- Exception
2072 +-- StopIteration
2073 +-- StandardError
2074 ...'
Georg Brandle152a772008-05-24 18:31:28 +00002075 >>>
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002076
2077 (Contributed by Paul Moore; :issue:`2439`.)
2078
Georg Brandl8ec7f652007-08-15 14:28:01 +00002079* New functions in the :mod:`posix` module: :func:`chflags` and :func:`lchflags`
2080 are wrappers for the corresponding system calls (where they're available).
2081 Constants for the flag values are defined in the :mod:`stat` module; some
2082 possible values include :const:`UF_IMMUTABLE` to signal the file may not be
2083 changed and :const:`UF_APPEND` to indicate that data can only be appended to the
2084 file. (Contributed by M. Levinson.)
2085
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002086 ``os.closerange(*low*, *high*)`` efficiently closes all file descriptors
2087 from *low* to *high*, ignoring any errors and not including *high* itself.
2088 This function is now used by the :mod:`subprocess` module to make starting
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002089 processes faster. (Contributed by Georg Brandl; :issue:`1663329`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002090
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002091* The :mod:`pyexpat` module's :class:`Parser` objects now allow setting
Georg Brandle152a772008-05-24 18:31:28 +00002092 their :attr:`buffer_size` attribute to change the size of the buffer
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002093 used to hold character data.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002094 (Contributed by Achim Gaedke; :issue:`1137`.)
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002095
Georg Brandla6168f92008-05-25 07:20:14 +00002096* The :mod:`Queue` module now provides queue classes that retrieve entries
Georg Brandle152a772008-05-24 18:31:28 +00002097 in different orders. The :class:`PriorityQueue` class stores
2098 queued items in a heap and retrieves them in priority order,
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002099 and :class:`LifoQueue` retrieves the most recently added entries first,
2100 meaning that it behaves like a stack.
2101 (Contributed by Raymond Hettinger.)
2102
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002103* The :mod:`random` module's :class:`Random` objects can
2104 now be pickled on a 32-bit system and unpickled on a 64-bit
2105 system, and vice versa. Unfortunately, this change also means
2106 that Python 2.6's :class:`Random` objects can't be unpickled correctly
2107 on earlier versions of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002108 (Contributed by Shawn Ligocki; :issue:`1727780`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002109
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002110 The new ``triangular(low, high, mode)`` function returns random
2111 numbers following a triangular distribution. The returned values
Georg Brandle152a772008-05-24 18:31:28 +00002112 are between *low* and *high*, not including *high* itself, and
2113 with *mode* as the mode, the most frequently occurring value
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002114 in the distribution. (Contributed by Wladmir van der Laan and
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002115 Raymond Hettinger; :issue:`1681432`.)
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002116
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002117* Long regular expression searches carried out by the :mod:`re`
2118 module will now check for signals being delivered, so especially
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002119 time-consuming searches can now be interrupted.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002120 (Contributed by Josh Hoyt and Ralf Schmitt; :issue:`846388`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002121
Georg Brandl8ec7f652007-08-15 14:28:01 +00002122* The :mod:`rgbimg` module has been removed.
2123
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002124* The :mod:`rlcompleter` module's :meth:`Completer.complete()` method
2125 will now ignore exceptions triggered while evaluating a name.
2126 (Fixed by Lorenz Quack; :issue:`2250`.)
2127
Georg Brandle152a772008-05-24 18:31:28 +00002128* The :mod:`sched` module's :class:`scheduler` instances now
2129 have a read-only :attr:`queue` attribute that returns the
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002130 contents of the scheduler's queue, represented as a list of
Georg Brandl225163d2008-03-05 07:10:35 +00002131 named tuples with the fields ``(time, priority, action, argument)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002132 (Contributed by Raymond Hettinger; :issue:`1861`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002133
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002134* The :mod:`select` module now has wrapper functions
2135 for the Linux :cfunc:`epoll` and BSD :cfunc:`kqueue` system calls.
2136 Also, a :meth:`modify` method was added to the existing :class:`poll`
2137 objects; ``pollobj.modify(fd, eventmask)`` takes a file descriptor
Georg Brandle152a772008-05-24 18:31:28 +00002138 or file object and an event mask,
2139
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002140 (Contributed by Christian Heimes; :issue:`1657`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002141
Georg Brandle152a772008-05-24 18:31:28 +00002142* The :mod:`sets` module has been deprecated; it's better to
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002143 use the built-in :class:`set` and :class:`frozenset` types.
2144
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00002145* The :func:`shutil.copytree` function now has an optional **ignore** argument
2146 that takes a callable object. This callable will receive each directory path
2147 and a list of the directory's contents, and returns a list of names that
2148 will be ignored, not copied.
2149
2150 The :mod:`shutil` module also provides an :func:`ignore_patterns`
2151 function for use with this new parameter.
2152 :func:`ignore_patterns` takes an arbitrary number of glob-style patterns
2153 and will ignore any files and directories that match this pattern.
2154 The following example copies a directory tree, but skip both SVN's internal
2155 :file:`.svn` directories and Emacs backup
2156 files, which have names ending with '~'::
2157
2158 shutil.copytree('Doc/library', '/tmp/library',
2159 ignore=shutil.ignore_patterns('*~'))
2160
2161 (Contributed by Tarek Ziadé; :issue:`2663`.)
2162
Georg Brandle152a772008-05-24 18:31:28 +00002163* Integrating signal handling with GUI handling event loops
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002164 like those used by Tkinter or GTk+ has long been a problem; most
Georg Brandle1b8e9c2008-02-20 19:12:36 +00002165 software ends up polling, waking up every fraction of a second.
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002166 The :mod:`signal` module can now make this more efficient.
2167 Calling ``signal.set_wakeup_fd(fd)`` sets a file descriptor
Georg Brandle152a772008-05-24 18:31:28 +00002168 to be used; when a signal is received, a byte is written to that
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002169 file descriptor. There's also a C-level function,
2170 :cfunc:`PySignal_SetWakeupFd`, for setting the descriptor.
2171
2172 Event loops will use this by opening a pipe to create two descriptors,
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002173 one for reading and one for writing. The writable descriptor
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002174 will be passed to :func:`set_wakeup_fd`, and the readable descriptor
2175 will be added to the list of descriptors monitored by the event loop via
2176 :cfunc:`select` or :cfunc:`poll`.
Georg Brandle152a772008-05-24 18:31:28 +00002177 On receiving a signal, a byte will be written and the main event loop
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002178 will be woken up, without the need to poll.
2179
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002180 (Contributed by Adam Olsen; :issue:`1583`.)
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002181
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002182 The :func:`siginterrupt` function is now available from Python code,
2183 and allows changing whether signals can interrupt system calls or not.
2184 (Contributed by Ralf Schmitt.)
2185
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002186 The :func:`setitimer` and :func:`getitimer` functions have also been
2187 added on systems that support these system calls. :func:`setitimer`
2188 allows setting interval timers that will cause a signal to be
2189 delivered to the process after a specified time, measured in
2190 wall-clock time, consumed process time, or combined process+system
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002191 time. (Contributed by Guilherme Polo; :issue:`2240`.)
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002192
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002193* The :mod:`smtplib` module now supports SMTP over SSL thanks to the
2194 addition of the :class:`SMTP_SSL` class. This class supports an
Georg Brandle152a772008-05-24 18:31:28 +00002195 interface identical to the existing :class:`SMTP` class. Both
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002196 class constructors also have an optional ``timeout`` parameter
2197 that specifies a timeout for the initial connection attempt, measured in
2198 seconds.
2199
2200 An implementation of the LMTP protocol (:rfc:`2033`) was also added to
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002201 the module. LMTP is used in place of SMTP when transferring e-mail
2202 between agents that don't manage a mail queue.
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002203
2204 (SMTP over SSL contributed by Monty Taylor; timeout parameter
2205 added by Facundo Batista; LMTP implemented by Leif
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002206 Hedstrom; :issue:`957003`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002207
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00002208* In the :mod:`smtplib` module, SMTP.starttls() now complies with :rfc:`3207`
2209 and forgets any knowledge obtained from the server not obtained from
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002210 the TLS negotiation itself. (Patch contributed by Bill Fenner;
2211 :issue:`829951`.)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00002212
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002213* The :mod:`socket` module now supports TIPC (http://tipc.sf.net),
2214 a high-performance non-IP-based protocol designed for use in clustered
2215 environments. TIPC addresses are 4- or 5-tuples.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002216 (Contributed by Alberto Bertogli; :issue:`1646`.)
Andrew M. Kuchlingf60b6412008-01-19 16:34:09 +00002217
Georg Brandle152a772008-05-24 18:31:28 +00002218 A new function, :func:`create_connection`, takes an address
2219 and connects to it using an optional timeout value, returning
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002220 the connected socket object.
2221
Georg Brandle152a772008-05-24 18:31:28 +00002222* The base classes in the :mod:`SocketServer` module now support
2223 calling a :meth:`handle_timeout` method after a span of inactivity
2224 specified by the server's :attr:`timeout` attribute. (Contributed
2225 by Michael Pomraning.) The :meth:`serve_forever` method
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002226 now takes an optional poll interval measured in seconds,
2227 controlling how often the server will check for a shutdown request.
Georg Brandle152a772008-05-24 18:31:28 +00002228 (Contributed by Pedro Werneck and Jeffrey Yasskin;
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002229 :issue:`742598`, :issue:`1193577`.)
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002230
2231* The :mod:`struct` module now supports the C99 :ctype:`_Bool` type,
Georg Brandle152a772008-05-24 18:31:28 +00002232 using the format character ``'?'``.
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002233 (Contributed by David Remahl.)
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002234
2235* The :class:`Popen` objects provided by the :mod:`subprocess` module
2236 now have :meth:`terminate`, :meth:`kill`, and :meth:`send_signal` methods.
2237 On Windows, :meth:`send_signal` only supports the :const:`SIGTERM`
2238 signal, and all these methods are aliases for the Win32 API function
Georg Brandle152a772008-05-24 18:31:28 +00002239 :cfunc:`TerminateProcess`.
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002240 (Contributed by Christian Heimes.)
Georg Brandle152a772008-05-24 18:31:28 +00002241
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002242* A new variable in the :mod:`sys` module,
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002243 :attr:`float_info`, is an object
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002244 containing information about the platform's floating-point support
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002245 derived from the :file:`float.h` file. Attributes of this object
Georg Brandle152a772008-05-24 18:31:28 +00002246 include
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00002247 :attr:`mant_dig` (number of digits in the mantissa), :attr:`epsilon`
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002248 (smallest difference between 1.0 and the next largest value
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002249 representable), and several others. (Contributed by Christian Heimes;
2250 :issue:`1534`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002251
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00002252 Another new variable, :attr:`dont_write_bytecode`, controls whether Python
2253 writes any :file:`.pyc` or :file:`.pyo` files on importing a module.
2254 If this variable is true, the compiled files are not written. The
2255 variable is initially set on start-up by supplying the :option:`-B`
2256 switch to the Python interpreter, or by setting the
2257 :envvar:`PYTHONDONTWRITEBYTECODE` environment variable before
Georg Brandle152a772008-05-24 18:31:28 +00002258 running the interpreter. Python code can subsequently
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00002259 change the value of this variable to control whether bytecode files
2260 are written or not.
2261 (Contributed by Neal Norwitz and Georg Brandl.)
2262
Georg Brandle152a772008-05-24 18:31:28 +00002263 Information about the command-line arguments supplied to the Python
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002264 interpreter is available by reading attributes of a named
2265 tuple available as ``sys.flags``. For example, the :attr:`verbose`
2266 attribute is true if Python
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002267 was executed in verbose mode, :attr:`debug` is true in debugging mode, etc.
2268 These attributes are all read-only.
2269 (Contributed by Christian Heimes.)
2270
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002271 A new function, :func:`getsizeof`, takes a Python object and returns
2272 the amount of memory used by the object, measured in bytes. Built-in
2273 objects return correct results; third-party extensions may not,
2274 but can define a :meth:`__sizeof__` method to return the
2275 object's size.
2276 (Contributed by Robert Schuppenies; :issue:`2898`.)
2277
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002278 It's now possible to determine the current profiler and tracer functions
Georg Brandle152a772008-05-24 18:31:28 +00002279 by calling :func:`sys.getprofile` and :func:`sys.gettrace`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002280 (Contributed by Georg Brandl; :issue:`1648`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002281
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002282* The :mod:`tarfile` module now supports POSIX.1-2001 (pax) and
2283 POSIX.1-1988 (ustar) format tarfiles, in addition to the GNU tar
Georg Brandle152a772008-05-24 18:31:28 +00002284 format that was already supported. The default format
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002285 is GNU tar; specify the ``format`` parameter to open a file
2286 using a different format::
2287
2288 tar = tarfile.open("output.tar", "w", format=tarfile.PAX_FORMAT)
2289
2290 The new ``errors`` parameter lets you specify an error handling
2291 scheme for character conversions: the three standard ways Python can
2292 handle errors ``'strict'``, ``'ignore'``, ``'replace'`` , or the
2293 special value ``'utf-8'``, which replaces bad characters with their
2294 UTF-8 representation. Character conversions occur because the PAX
2295 format supports Unicode filenames, defaulting to UTF-8 encoding.
2296
2297 The :meth:`TarFile.add` method now accepts a ``exclude`` argument that's
2298 a function that can be used to exclude certain filenames from
Georg Brandle152a772008-05-24 18:31:28 +00002299 an archive.
2300 The function must take a filename and return true if the file
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002301 should be excluded or false if it should be archived.
2302 The function is applied to both the name initially passed to :meth:`add`
2303 and to the names of files in recursively-added directories.
Georg Brandle152a772008-05-24 18:31:28 +00002304
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002305 (All changes contributed by Lars Gustäbel).
2306
2307* An optional ``timeout`` parameter was added to the
2308 :class:`telnetlib.Telnet` class constructor, specifying a timeout
2309 measured in seconds. (Added by Facundo Batista.)
2310
Georg Brandle152a772008-05-24 18:31:28 +00002311* The :class:`tempfile.NamedTemporaryFile` class usually deletes
2312 the temporary file it created when the file is closed. This
2313 behaviour can now be changed by passing ``delete=False`` to the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002314 constructor. (Contributed by Damien Miller; :issue:`1537850`.)
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002315
Georg Brandle152a772008-05-24 18:31:28 +00002316 A new class, :class:`SpooledTemporaryFile`, behaves like
2317 a temporary file but stores its data in memory until a maximum size is
2318 exceeded. On reaching that limit, the contents will be written to
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002319 an on-disk temporary file. (Contributed by Dustin J. Mitchell.)
2320
2321 The :class:`NamedTemporaryFile` and :class:`SpooledTemporaryFile` classes
Georg Brandle152a772008-05-24 18:31:28 +00002322 both work as context managers, so you can write
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002323 ``with tempfile.NamedTemporaryFile() as tmp: ...``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002324 (Contributed by Alexander Belopolsky; :issue:`2021`.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002325
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002326* The :mod:`test.test_support` module now contains a
2327 :func:`EnvironmentVarGuard`
2328 context manager that supports temporarily changing environment variables and
Georg Brandle152a772008-05-24 18:31:28 +00002329 automatically restores them to their old values.
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002330
2331 Another context manager, :class:`TransientResource`, can surround calls
2332 to resources that may or may not be available; it will catch and
2333 ignore a specified list of exceptions. For example,
2334 a network test may ignore certain failures when connecting to an
2335 external web site::
2336
2337 with test_support.TransientResource(IOError, errno=errno.ETIMEDOUT):
Georg Brandle152a772008-05-24 18:31:28 +00002338 f = urllib.urlopen('https://sf.net')
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002339 ...
2340
2341 (Contributed by Brett Cannon.)
2342
Georg Brandle152a772008-05-24 18:31:28 +00002343* The :mod:`textwrap` module can now preserve existing whitespace
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002344 at the beginnings and ends of the newly-created lines
2345 by specifying ``drop_whitespace=False``
2346 as an argument::
2347
2348 >>> S = """This sentence has a bunch of extra whitespace."""
2349 >>> print textwrap.fill(S, width=15)
2350 This sentence
2351 has a bunch
2352 of extra
2353 whitespace.
2354 >>> print textwrap.fill(S, drop_whitespace=False, width=15)
2355 This sentence
2356 has a bunch
2357 of extra
2358 whitespace.
Georg Brandle152a772008-05-24 18:31:28 +00002359 >>>
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002360
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002361 (Contributed by Dwayne Bailey; :issue:`1581073`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002362
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002363* The :mod:`threading` module's :class:`Thread` objects
2364 gained a :meth:`getIdent` method that returns the thread's
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002365 identifier, a nonzero integer. (Contributed by Gregory P. Smith;
2366 :issue:`2871`.)
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002367
Georg Brandle152a772008-05-24 18:31:28 +00002368* The :mod:`timeit` module now accepts callables as well as strings
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002369 for the statement being timed and for the setup code.
Georg Brandle152a772008-05-24 18:31:28 +00002370 Two convenience functions were added for creating
2371 :class:`Timer` instances:
2372 ``repeat(stmt, setup, time, repeat, number)`` and
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002373 ``timeit(stmt, setup, time, number)`` create an instance and call
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002374 the corresponding method. (Contributed by Erik Demaine;
2375 :issue:`1533909`.)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002376
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002377* The :mod:`Tkinter` module now accepts lists and tuples for options,
2378 separating the elements by spaces before passing the resulting value to
2379 Tcl/Tk.
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002380 (Contributed by Guilherme Polo; :issue:`2906`.)
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002381
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002382* The :mod:`turtle` module for turtle graphics was greatly enhanced by
2383 Gregor Lingl. New features in the module include:
2384
2385 * Better animation of turtle movement and rotation.
2386 * Control over turtle movement using the new delay(),
2387 tracer(), and speed() methods.
2388 * The ability to set new shapes for the turtle, and to
2389 define a new coordinate system.
2390 * Turtles now have an undo() method that can roll back actions.
2391 * Simple support for reacting to input events such as mouse and keyboard
2392 activity, making it possible to write simple games.
2393 * A :file:`turtle.cfg` file can be used to customize the starting appearance
2394 of the turtle's screen.
2395 * The module's docstrings can be replaced by new docstrings that have been
2396 translated into another language.
2397
2398 (:issue:`1513695`)
2399
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002400* An optional ``timeout`` parameter was added to the
2401 :func:`urllib.urlopen` function and the
Georg Brandle152a772008-05-24 18:31:28 +00002402 :class:`urllib.ftpwrapper` class constructor, as well as the
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002403 :func:`urllib2.urlopen` function. The parameter specifies a timeout
2404 measured in seconds. For example::
2405
2406 >>> u = urllib2.urlopen("http://slow.example.com", timeout=3)
2407 Traceback (most recent call last):
2408 ...
2409 urllib2.URLError: <urlopen error timed out>
Georg Brandle152a772008-05-24 18:31:28 +00002410 >>>
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002411
Georg Brandle152a772008-05-24 18:31:28 +00002412 (Added by Facundo Batista.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002413
Georg Brandle152a772008-05-24 18:31:28 +00002414* The :mod:`warnings` module's :func:`formatwarning` and :func:`showwarning`
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002415 gained an optional *line* argument that can be used to supply the
2416 line of source code. (Added as part of :issue:`1631171`, which re-implemented
2417 part of the :mod:`warnings` module in C code.)
2418
2419* The XML-RPC :class:`SimpleXMLRPCServer` and :class:`DocXMLRPCServer`
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002420 classes can now be prevented from immediately opening and binding to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002421 their socket by passing True as the ``bind_and_activate``
2422 constructor parameter. This can be used to modify the instance's
Georg Brandle152a772008-05-24 18:31:28 +00002423 :attr:`allow_reuse_address` attribute before calling the
2424 :meth:`server_bind` and :meth:`server_activate` methods to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002425 open the socket and begin listening for connections.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002426 (Contributed by Peter Parente; :issue:`1599845`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002427
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002428 :class:`SimpleXMLRPCServer` also has a :attr:`_send_traceback_header`
Georg Brandle152a772008-05-24 18:31:28 +00002429 attribute; if true, the exception and formatted traceback are returned
2430 as HTTP headers "X-Exception" and "X-Traceback". This feature is
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002431 for debugging purposes only and should not be used on production servers
2432 because the tracebacks could possibly reveal passwords or other sensitive
Georg Brandle152a772008-05-24 18:31:28 +00002433 information. (Contributed by Alan McIntyre as part of his
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002434 project for Google's Summer of Code 2007.)
2435
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002436* The :mod:`xmlrpclib` module no longer automatically converts
Georg Brandle152a772008-05-24 18:31:28 +00002437 :class:`datetime.date` and :class:`datetime.time` to the
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002438 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2439 not necessarily correct for all applications. Code using
Georg Brandle152a772008-05-24 18:31:28 +00002440 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
2441 instances. (:issue:`1330538`) The code can also handle
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002442 dates before 1900 (contributed by Ralf Schmitt; :issue:`2014`)
2443 and 64-bit integers represented by using ``<i8>`` in XML-RPC responses
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002444 (contributed by Riku Lindblad; :issue:`2985`).
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002445
Georg Brandle152a772008-05-24 18:31:28 +00002446* The :mod:`zipfile` module's :class:`ZipFile` class now has
2447 :meth:`extract` and :meth:`extractall` methods that will unpack
2448 a single file or all the files in the archive to the current directory, or
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002449 to a specified directory::
2450
2451 z = zipfile.ZipFile('python-251.zip')
2452
2453 # Unpack a single file, writing it relative to the /tmp directory.
2454 z.extract('Python/sysmodule.c', '/tmp')
2455
2456 # Unpack all the files in the archive.
2457 z.extractall()
2458
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002459 (Contributed by Alan McIntyre; :issue:`467924`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002460
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002461 The :meth:`open`, :meth:`read` and :meth:`extract` methods can now
2462 take either a filename or a :class:`ZipInfo` object. This is useful when an
2463 archive accidentally contains a duplicated filename.
2464 (Contributed by Graham Horler; :issue:`1775025`.)
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002465
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002466 Finally, :mod:`zipfile` now supports using Unicode filenames
2467 for archived files. (Contributed by Alexey Borzenkov; :issue:`1734346`.)
2468
Georg Brandlb19be572007-12-29 10:57:00 +00002469.. ======================================================================
2470.. whole new modules get described in subsections here
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002471
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002472The :mod:`ast` module
2473----------------------
2474
2475The :mod:`ast` module provides an Abstract Syntax Tree representation
2476of Python code. For Python 2.6, Armin Ronacher contributed a set of
2477helper functions that perform various common tasks. These will be useful
2478for HTML templating packages, code analyzers, and similar tools that
2479process Python code.
2480
2481The :func:`parse` function takes an expression and returns an AST.
2482The :func:`dump` function outputs a representation of a tree, suitable
2483for debugging::
2484
2485 import ast
2486
2487 t = ast.parse("""
2488 d = {}
2489 for i in 'abcdefghijklm':
2490 d[i + i] = ord(i) - ord('a') + 1
2491 print d
2492 """)
2493 print ast.dump(t)
2494
2495This outputs::
2496
2497 Module(body=[Assign(targets=[Name(id='d', ctx=Store())],
2498 value=Dict(keys=[], values=[])), For(target=Name(id='i',
2499 ctx=Store()), iter=Str(s='abcdefghijklm'),
2500 body=[Assign(targets=[Subscript(value=Name(id='d', ctx=Load()),
2501 slice=Index(value=BinOp(left=Name(id='i', ctx=Load()), op=Add(),
2502 right=Name(id='i', ctx=Load()))), ctx=Store())],
2503 value=BinOp(left=BinOp(left=Call(func=Name(id='ord', ctx=Load()),
2504 args=[Name(id='i', ctx=Load())], keywords=[], starargs=None,
2505 kwargs=None), op=Sub(), right=Call(func=Name(id='ord',
2506 ctx=Load()), args=[Str(s='a')], keywords=[], starargs=None,
2507 kwargs=None)), op=Add(), right=Num(n=1)))], orelse=[]),
2508 Print(dest=None, values=[Name(id='d', ctx=Load())], nl=True)])
2509
2510The :func:`literal_eval` method takes a string or an AST
2511representing a literal expression, one that contains a Python
2512expression containing only strings, numbers, dictionaries, etc. but no
2513statements or function calls, and returns the resulting value. If you
2514need to unserialize an expression but need to worry about security
2515and can't risk using an :func:`eval` call, :func:`literal_eval` will
2516handle it safely::
2517
2518 >>> literal = '("a", "b", {2:4, 3:8, 1:2})'
2519 >>> print ast.literal_eval(literal)
2520 ('a', 'b', {1: 2, 2: 4, 3: 8})
2521 >>> print ast.literal_eval('"a" + "b"')
2522 Traceback (most recent call last):
2523 ...
2524 ValueError: malformed string
2525
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00002526The module also includes :class:`NodeVisitor` and
2527:class:`NodeTransformer` classes for traversing and modifying an AST,
2528and functions for common transformations such as changing line
2529numbers.
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002530
2531.. ======================================================================
2532
2533The :mod:`future_builtins` module
2534--------------------------------------
2535
2536Python 3.0 makes various changes to the repertoire of built-in
2537functions, and most of the changes can't be introduced in the Python
25382.x series because they would break compatibility.
2539The :mod:`future_builtins` module provides versions
2540of these built-in functions that can be imported when writing
25413.0-compatible code.
2542
2543The functions in this module currently include:
2544
2545* ``ascii(**obj**)``: equivalent to :func:`repr`. In Python 3.0,
2546 :func:`repr` will return a Unicode string, while :func:`ascii` will
2547 return a pure ASCII bytestring.
2548
2549* ``filter(**predicate**, **iterable**)``,
2550 ``map(**func**, **iterable1**, ...)``: the 3.0 versions
2551 return iterators, differing from the 2.x built-ins that return lists.
2552
2553* ``hex(**value**)``, ``oct(**value**)``: instead of calling the
2554 :meth:`__hex__` or :meth:`__oct__` methods, these versions will
2555 call the :meth:`__index__` method and convert the result to hexadecimal
2556 or octal.
2557
2558.. ======================================================================
2559
Brett Cannon4b964f92008-05-05 20:21:38 +00002560The :mod:`json` module
2561----------------------
2562
2563The new :mod:`json` module supports the encoding and decoding of Python types in
2564JSON (Javascript Object Notation). JSON is a lightweight interchange format
2565often used in web applications. For more information about JSON, see
2566http://www.json.org.
2567
2568:mod:`json` comes with support for decoding and encoding most builtin Python
2569types. The following example encodes and decodes a dictionary::
2570
2571 >>> import json
2572 >>> data = {"spam" : "foo", "parrot" : 42}
2573 >>> in_json = json.dumps(data) # Encode the data
2574 >>> in_json
2575 '{"parrot": 42, "spam": "foo"}'
2576 >>> json.loads(in_json) # Decode into a Python object
2577 {"spam" : "foo", "parrot" : 42}
2578
2579It is also possible to write your own decoders and encoders to support more
2580types. Pretty-printing of the JSON strings is also supported.
2581
2582:mod:`json` (originally called simplejson) was written by Bob Ippolito.
2583
2584
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002585.. ======================================================================
2586
2587plistlib: A Property-List Parser
2588--------------------------------------------------
2589
Georg Brandle152a772008-05-24 18:31:28 +00002590A commonly-used format on MacOS X is the ``.plist`` format,
2591which stores basic data types (numbers, strings, lists,
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002592and dictionaries) and serializes them into an XML-based format.
2593(It's a lot like the XML-RPC serialization of data types.)
2594
Georg Brandle152a772008-05-24 18:31:28 +00002595Despite being primarily used on MacOS X, the format
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002596has nothing Mac-specific about it and the Python implementation works
2597on any platform that Python supports, so the :mod:`plistlib` module
2598has been promoted to the standard library.
2599
2600Using the module is simple::
2601
2602 import sys
2603 import plistlib
2604 import datetime
2605
2606 # Create data structure
2607 data_struct = dict(lastAccessed=datetime.datetime.now(),
2608 version=1,
2609 categories=('Personal', 'Shared', 'Private'))
2610
2611 # Create string containing XML.
2612 plist_str = plistlib.writePlistToString(data_struct)
2613 new_struct = plistlib.readPlistFromString(plist_str)
2614 print data_struct
2615 print new_struct
2616
2617 # Write data structure to a file and read it back.
2618 plistlib.writePlist(data_struct, '/tmp/customizations.plist')
2619 new_struct = plistlib.readPlist('/tmp/customizations.plist')
2620
2621 # read/writePlist accepts file-like objects as well as paths.
2622 plistlib.writePlist(data_struct, sys.stdout)
Georg Brandle152a772008-05-24 18:31:28 +00002623
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002624.. ======================================================================
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002625
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002626Improved SSL Support
2627--------------------------------------------------
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002628
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002629Bill Janssen made extensive improvements to Python 2.6's support for
2630the Secure Sockets Layer by adding a new module, :mod:`ssl`, on top of
2631the `OpenSSL <http://www.openssl.org/>`__ library. This new module
2632provides more control over the protocol negotiated, the X.509
2633certificates used, and has better support for writing SSL servers (as
2634opposed to clients) in Python. The existing SSL support in the
2635:mod:`socket` module hasn't been removed and continues to work,
2636though it will be removed in Python 3.0.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002637
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002638To use the new module, first you must create a TCP connection in the
2639usual way and then pass it to the :func:`ssl.wrap_socket` function.
2640It's possible to specify whether a certificate is required, and to
2641obtain certificate info by calling the :meth:`getpeercert` method.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002642
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002643.. seealso::
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002644
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002645 The documentation for the :mod:`ssl` module.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002646
Georg Brandlb19be572007-12-29 10:57:00 +00002647.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002648
2649
2650Build and C API Changes
2651=======================
2652
2653Changes to Python's build process and to the C API include:
2654
Andrew M. Kuchlingf7b462f2007-11-23 13:37:39 +00002655* Python 2.6 can be built with Microsoft Visual Studio 2008.
2656 See the :file:`PCbuild9` directory for the build files.
2657 (Implemented by Christian Heimes.)
2658
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002659* On MacOS X, Python 2.6 can be compiled as a 4-way universal build.
2660 The :program:`configure` script
2661 can take a :option:`--with-universal-archs=[32-bit|64-bit|all]`
2662 switch, controlling whether the binaries are built for 32-bit
2663 architectures (x86, PowerPC), 64-bit (x86-64 and PPC-64), or both.
2664 (Contributed by Ronald Oussoren.)
2665
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002666* Python now can only be compiled with C89 compilers (after 19
2667 years!). This means that the Python source tree can now drop its
2668 own implementations of :cfunc:`memmove` and :cfunc:`strerror`, which
2669 are in the C89 standard library.
2670
Georg Brandle152a772008-05-24 18:31:28 +00002671* The BerkeleyDB module now has a C API object, available as
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002672 ``bsddb.db.api``. This object can be used by other C extensions
2673 that wish to use the :mod:`bsddb` module for their own purposes.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002674 (Contributed by Duncan Grisby; :issue:`1551895`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002675
Georg Brandle152a772008-05-24 18:31:28 +00002676* The new buffer interface, previously described in
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002677 `the PEP 3118 section <#pep-3118-revised-buffer-protocol>`__,
2678 adds :cfunc:`PyObject_GetBuffer` and :cfunc:`PyObject_ReleaseBuffer`,
2679 as well as a few other functions.
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002680
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002681* Python's use of the C stdio library is now thread-safe, or at least
2682 as thread-safe as the underlying library is. A long-standing potential
Georg Brandle152a772008-05-24 18:31:28 +00002683 bug occurred if one thread closed a file object while another thread
2684 was reading from or writing to the object. In 2.6 file objects
2685 have a reference count, manipulated by the
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002686 :cfunc:`PyFile_IncUseCount` and :cfunc:`PyFile_DecUseCount`
Georg Brandle152a772008-05-24 18:31:28 +00002687 functions. File objects can't be closed unless the reference count
2688 is zero. :cfunc:`PyFile_IncUseCount` should be called while the GIL
2689 is still held, before carrying out an I/O operation using the
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002690 ``FILE *`` pointer, and :cfunc:`PyFile_DecUseCount` should be called
2691 immediately after the GIL is re-acquired.
2692 (Contributed by Antoine Pitrou and Gregory P. Smith.)
2693
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002694* Importing modules simultaneously in two different threads no longer
2695 deadlocks; it will now raise an :exc:`ImportError`. A new API
2696 function, :cfunc:`PyImport_ImportModuleNoBlock`, will look for a
2697 module in ``sys.modules`` first, then try to import it after
2698 acquiring an import lock. If the import lock is held by another
2699 thread, the :exc:`ImportError` is raised.
2700 (Contributed by Christian Heimes.)
2701
Georg Brandle152a772008-05-24 18:31:28 +00002702* Several functions return information about the platform's
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002703 floating-point support. :cfunc:`PyFloat_GetMax` returns
2704 the maximum representable floating point value,
Georg Brandle152a772008-05-24 18:31:28 +00002705 and :cfunc:`PyFloat_GetMin` returns the minimum
2706 positive value. :cfunc:`PyFloat_GetInfo` returns a dictionary
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002707 containing more information from the :file:`float.h` file, such as
2708 ``"mant_dig"`` (number of digits in the mantissa), ``"epsilon"``
2709 (smallest difference between 1.0 and the next largest value
2710 representable), and several others.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002711 (Contributed by Christian Heimes; :issue:`1534`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002712
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002713* C functions and methods that use
2714 :cfunc:`PyComplex_AsCComplex` will now accept arguments that
2715 have a :meth:`__complex__` method. In particular, the functions in the
2716 :mod:`cmath` module will now accept objects with this method.
2717 This is a backport of a Python 3.0 change.
2718 (Contributed by Mark Dickinson; :issue:`1675423`.)
2719
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002720* Python's C API now includes two functions for case-insensitive string
Georg Brandl907a7202008-02-22 12:31:45 +00002721 comparisons, ``PyOS_stricmp(char*, char*)``
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002722 and ``PyOS_strnicmp(char*, char*, Py_ssize_t)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002723 (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002724
Georg Brandle152a772008-05-24 18:31:28 +00002725* Many C extensions define their own little macro for adding
2726 integers and strings to the module's dictionary in the
2727 ``init*`` function. Python 2.6 finally defines standard macros
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002728 for adding values to a module, :cmacro:`PyModule_AddStringMacro`
Georg Brandle152a772008-05-24 18:31:28 +00002729 and :cmacro:`PyModule_AddIntMacro()`. (Contributed by
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002730 Christian Heimes.)
2731
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002732* Some macros were renamed in both 3.0 and 2.6 to make it clearer that
2733 they are macros,
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00002734 not functions. :cmacro:`Py_Size()` became :cmacro:`Py_SIZE()`,
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002735 :cmacro:`Py_Type()` became :cmacro:`Py_TYPE()`, and
Georg Brandle152a772008-05-24 18:31:28 +00002736 :cmacro:`Py_Refcnt()` became :cmacro:`Py_REFCNT()`.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002737 The mixed-case macros are still available
2738 in Python 2.6 for backward compatibility.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002739 (:issue:`1629`)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002740
Georg Brandle152a772008-05-24 18:31:28 +00002741* Distutils now places C extensions it builds in a
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002742 different directory when running on a debug version of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002743 (Contributed by Collin Winter; :issue:`1530959`.)
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002744
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002745* Several basic data types, such as integers and strings, maintain
2746 internal free lists of objects that can be re-used. The data
2747 structures for these free lists now follow a naming convention: the
2748 variable is always named ``free_list``, the counter is always named
2749 ``numfree``, and a macro :cmacro:`Py<typename>_MAXFREELIST` is
2750 always defined.
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002751
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002752* A new Makefile target, "make check", prepares the Python source tree
Georg Brandle152a772008-05-24 18:31:28 +00002753 for making a patch: it fixes trailing whitespace in all modified
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002754 ``.py`` files, checks whether the documentation has been changed,
2755 and reports whether the :file:`Misc/ACKS` and :file:`Misc/NEWS` files
2756 have been updated.
2757 (Contributed by Brett Cannon.)
2758
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002759 Another new target, "make profile-opt", compiles a Python binary
2760 using GCC's profile-guided optimization. It compiles Python with
2761 profiling enabled, runs the test suite to obtain a set of profiling
2762 results, and then compiles using these results for optimization.
2763 (Contributed by Gregory P. Smith.)
2764
Georg Brandlb19be572007-12-29 10:57:00 +00002765.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002766
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002767Port-Specific Changes: Windows
2768-----------------------------------
2769
Christian Heimes7e3ab452008-05-04 11:50:53 +00002770* The support for Windows 95, 98, ME and NT4 has been dropped.
2771 Python 2.6 requires at least Windows 2000 SP4.
2772
Georg Brandle152a772008-05-24 18:31:28 +00002773* The :mod:`msvcrt` module now supports
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002774 both the normal and wide char variants of the console I/O
Georg Brandle152a772008-05-24 18:31:28 +00002775 API. The :func:`getwch` function reads a keypress and returns a Unicode
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002776 value, as does the :func:`getwche` function. The :func:`putwch` function
2777 takes a Unicode character and writes it to the console.
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002778 (Contributed by Christian Heimes.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002779
Georg Brandle152a772008-05-24 18:31:28 +00002780* :func:`os.path.expandvars` will now expand environment variables
2781 in the form "%var%", and "~user" will be expanded into the
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00002782 user's home directory path. (Contributed by Josiah Carlson.)
2783
Georg Brandle152a772008-05-24 18:31:28 +00002784* The :mod:`socket` module's socket objects now have an
2785 :meth:`ioctl` method that provides a limited interface to the
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00002786 :cfunc:`WSAIoctl` system interface.
2787
Georg Brandle152a772008-05-24 18:31:28 +00002788* The :mod:`_winreg` module now has a function,
2789 :func:`ExpandEnvironmentStrings`,
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002790 that expands environment variable references such as ``%NAME%``
2791 in an input string. The handle objects provided by this
Georg Brandle152a772008-05-24 18:31:28 +00002792 module now support the context protocol, so they can be used
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002793 in :keyword:`with` statements. (Contributed by Christian Heimes.)
2794
Georg Brandle152a772008-05-24 18:31:28 +00002795 :mod:`_winreg` also has better support for x64 systems,
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002796 exposing the :func:`DisableReflectionKey`, :func:`EnableReflectionKey`,
2797 and :func:`QueryReflectionKey` functions, which enable and disable
2798 registry reflection for 32-bit processes running on 64-bit systems.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002799 (:issue:`1753245`)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002800
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002801* The :mod:`msilib` module's :class:`Record` object
2802 gained :meth:`GetInteger` and :meth:`GetString` methods that
2803 return field values as an integer or a string.
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002804 (Contributed by Floris Bruynooghe; :issue:`2125`.)
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002805
Georg Brandle152a772008-05-24 18:31:28 +00002806* The new default compiler on Windows is Visual Studio 2008 (VS 9.0). The
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002807 build directories for Visual Studio 2003 (VS7.1) and 2005 (VS8.0)
2808 were moved into the PC/ directory. The new PCbuild directory supports
2809 cross compilation for X64, debug builds and Profile Guided Optimization
2810 (PGO). PGO builds are roughly 10% faster than normal builds.
2811 (Contributed by Christian Heimes with help from Amaury Forgeot d'Arc and
2812 Martin von Loewis.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002813
Georg Brandlb19be572007-12-29 10:57:00 +00002814.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002815
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002816Port-Specific Changes: MacOS X
2817-----------------------------------
2818
2819* When compiling a framework build of Python, you can now specify the
2820 framework name to be used by providing the
2821 :option:`--with-framework-name=` option to the
2822 :program:`configure` script.
2823
2824.. ======================================================================
2825
Georg Brandl8ec7f652007-08-15 14:28:01 +00002826
2827.. _section-other:
2828
2829Other Changes and Fixes
2830=======================
2831
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002832As usual, there were a bunch of other improvements and bugfixes
2833scattered throughout the source tree. A search through the change
2834logs finds there were XXX patches applied and YYY bugs fixed between
2835Python 2.5 and 2.6. Both figures are likely to be underestimates.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002836
2837Some of the more notable changes are:
2838
Georg Brandle152a772008-05-24 18:31:28 +00002839* It's now possible to prevent Python from writing any :file:`.pyc`
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002840 or :file:`.pyo` files by either supplying the :option:`-B` switch
2841 or setting the :envvar:`PYTHONDONTWRITEBYTECODE` environment variable
2842 to any non-empty string when running the Python interpreter. These
Georg Brandlca9c6e42008-01-15 06:58:15 +00002843 are also used to set the :data:`sys.dont_write_bytecode` attribute;
2844 Python code can change this variable to control whether bytecode
2845 files are subsequently written.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002846 (Contributed by Neal Norwitz and Georg Brandl.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002847
Georg Brandlb19be572007-12-29 10:57:00 +00002848.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002849
2850
2851Porting to Python 2.6
2852=====================
2853
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002854This section lists previously described changes and other bugfixes
2855that may require changes to your code:
Georg Brandl8ec7f652007-08-15 14:28:01 +00002856
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00002857* The :meth:`__init__` method of :class:`collections.deque`
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002858 now clears any existing contents of the deque
2859 before adding elements from the iterable. This change makes the
Georg Brandle152a772008-05-24 18:31:28 +00002860 behavior match that of ``list.__init__()``.
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002861
Georg Brandle152a772008-05-24 18:31:28 +00002862* The :class:`Decimal` constructor now accepts leading and trailing
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002863 whitespace when passed a string. Previously it would raise an
2864 :exc:`InvalidOperation` exception. On the other hand, the
2865 :meth:`create_decimal` method of :class:`Context` objects now
Georg Brandle152a772008-05-24 18:31:28 +00002866 explicitly disallows extra whitespace, raising a
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002867 :exc:`ConversionSyntax` exception.
2868
Georg Brandle152a772008-05-24 18:31:28 +00002869* Due to an implementation accident, if you passed a file path to
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002870 the built-in :func:`__import__` function, it would actually import
Georg Brandle152a772008-05-24 18:31:28 +00002871 the specified file. This was never intended to work, however, and
2872 the implementation now explicitly checks for this case and raises
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002873 an :exc:`ImportError`.
2874
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002875* C API: the :cfunc:`PyImport_Import` and :cfunc:`PyImport_ImportModule`
Georg Brandle152a772008-05-24 18:31:28 +00002876 functions now default to absolute imports, not relative imports.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002877 This will affect C extensions that import other modules.
2878
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002879* The :mod:`socket` module exception :exc:`socket.error` now inherits
2880 from :exc:`IOError`. Previously it wasn't a subclass of
2881 :exc:`StandardError` but now it is, through :exc:`IOError`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002882 (Implemented by Gregory P. Smith; :issue:`1706815`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002883
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002884* The :mod:`xmlrpclib` module no longer automatically converts
Georg Brandle152a772008-05-24 18:31:28 +00002885 :class:`datetime.date` and :class:`datetime.time` to the
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002886 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2887 not necessarily correct for all applications. Code using
Georg Brandle152a772008-05-24 18:31:28 +00002888 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002889 instances. (:issue:`1330538`)
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002890
Georg Brandle152a772008-05-24 18:31:28 +00002891* (3.0-warning mode) The :class:`Exception` class now warns
2892 when accessed using slicing or index access; having
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002893 :class:`Exception` behave like a tuple is being phased out.
2894
2895* (3.0-warning mode) inequality comparisons between two dictionaries
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002896 or two objects that don't implement comparison methods are reported
2897 as warnings. ``dict1 == dict2`` still works, but ``dict1 < dict2``
2898 is being phased out.
Georg Brandle152a772008-05-24 18:31:28 +00002899
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002900 Comparisons between cells, which are an implementation detail of Python's
2901 scoping rules, also cause warnings because such comparisons are forbidden
2902 entirely in 3.0.
2903
Georg Brandlb19be572007-12-29 10:57:00 +00002904.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002905
2906
2907.. _acks:
2908
2909Acknowledgements
2910================
2911
2912The author would like to thank the following people for offering suggestions,
Georg Brandle152a772008-05-24 18:31:28 +00002913corrections and assistance with various drafts of this article:
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002914Georg Brandl, Jim Jewett.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002915