blob: c4d040e3761b40ae4d327fc8fea0373c61da8c32 [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001****************************
2 What's New in Python 2.6
3****************************
4
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00005.. XXX add trademark info for Apple, Microsoft, SourceForge.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00006
Georg Brandl8ec7f652007-08-15 14:28:01 +00007:Author: A.M. Kuchling
8:Release: |release|
9:Date: |today|
10
Georg Brandlb19be572007-12-29 10:57:00 +000011.. $Id: whatsnew26.tex 55746 2007-06-02 18:33:53Z neal.norwitz $
12 Rules for maintenance:
13
14 * Anyone can add text to this document. Do not spend very much time
15 on the wording of your changes, because your text will probably
16 get rewritten to some degree.
17
18 * The maintainer will go through Misc/NEWS periodically and add
19 changes; it's therefore more important to add your changes to
20 Misc/NEWS than to this file.
21
22 * This is not a complete list of every single change; completeness
23 is the purpose of Misc/NEWS. Some changes I consider too small
24 or esoteric to include. If such a change is added to the text,
25 I'll just remove it. (This is another reason you shouldn't spend
26 too much time on writing your addition.)
27
28 * If you want to draw your new text to the attention of the
29 maintainer, add 'XXX' to the beginning of the paragraph or
30 section.
31
32 * It's OK to just add a fragmentary note about a change. For
33 example: "XXX Describe the transmogrify() function added to the
34 socket module." The maintainer will research the change and
35 write the necessary text.
36
37 * You can comment out your additions if you like, but it's not
38 necessary (especially when a final release is some months away).
39
40 * Credit the author of a patch or bugfix. Just the name is
41 sufficient; the e-mail address isn't necessary.
42
Andrew M. Kuchling17f84292008-04-10 21:29:01 +000043 * It's helpful to add the bug/patch number in an parenthetical
Georg Brandlb19be572007-12-29 10:57:00 +000044
Georg Brandlb19be572007-12-29 10:57:00 +000045 XXX Describe the transmogrify() function added to the socket
46 module.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +000047 (Contributed by P.Y. Developer; :issue:`12345`.)
Georg Brandlb19be572007-12-29 10:57:00 +000048
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +000049 This saves the maintainer the effort of 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
52This article explains the new features in Python 2.6. No release date for
53Python 2.6 has been set; it will probably be released in mid 2008.
54
Andrew M. Kuchling17f84292008-04-10 21:29:01 +000055This article doesn't attempt to provide a complete specification of
56the new features, but instead provides a convenient overview. For
57full details, you should refer to the documentation for Python 2.6. If
58you want to understand the complete implementation and design
59rationale, refer to the PEP for a particular new feature. For smaller
60changes, this edition of "What's New in Python" links to the bug/patch
61item for each change whenever possible.
Georg Brandl8ec7f652007-08-15 14:28:01 +000062
Georg Brandlb19be572007-12-29 10:57:00 +000063.. Compare with previous release in 2 - 3 sentences here.
64 add hyperlink when the documentation becomes available online.
Georg Brandl8ec7f652007-08-15 14:28:01 +000065
Georg Brandlb19be572007-12-29 10:57:00 +000066.. ========================================================================
67.. Large, PEP-level features and changes should be described here.
68.. Should there be a new section here for 3k migration?
69.. Or perhaps a more general section describing module changes/deprecation?
70.. ========================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +000071
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +000072Python 3.0
73================
74
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +000075The development cycle for Python 2.6 also saw the release of the first
76alphas of Python 3.0, and the development of 3.0 has influenced
77a number of features in 2.6.
78
79Python 3.0 is a far-ranging redesign of Python that breaks
80compatibility with the 2.x series. This means that existing Python
81code will need a certain amount of conversion in order to run on
82Python 3.0. However, not all the changes in 3.0 necessarily break
83compatibility. In cases where new features won't cause existing code
84to break, they've been backported to 2.6 and are described in this
85document in the appropriate place. Some of the 3.0-derived features
86are:
87
88* A :meth:`__complex__` method for converting objects to a complex number.
89* Alternate syntax for catching exceptions: ``except TypeError as exc``.
90* The addition of :func:`functools.reduce` as a synonym for the built-in
91 :func:`reduce` function.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +000092
93A new command-line switch, :option:`-3`, enables warnings
94about features that will be removed in Python 3.0. You can run code
95with this switch to see how much work will be necessary to port
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +000096code to 3.0. The value of this switch is available
Georg Brandld5b635f2008-03-25 08:29:14 +000097to Python code as the boolean variable :data:`sys.py3kwarning`,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +000098and to C extension code as :cdata:`Py_Py3kWarningFlag`.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +000099
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000100Python 3.0 adds several new built-in functions and change the
101semantics of some existing built-ins. Entirely new functions such as
102:func:`bin` have simply been added to Python 2.6, but existing
103built-ins haven't been changed; instead, the :mod:`future_builtins`
104module has versions with the new 3.0 semantics. Code written to be
105compatible with 3.0 can do ``from future_builtins import hex, map``
106as necessary.
107
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000108.. seealso::
109
110 The 3xxx series of PEPs, which describes the development process for
111 Python 3.0 and various features that have been accepted, rejected,
112 or are still under consideration.
113
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000114
115Development Changes
116==================================================
117
118While 2.6 was being developed, the Python development process
119underwent two significant changes: the developer group
120switched from SourceForge's issue tracker to a customized
121Roundup installation, and the documentation was converted from
122LaTeX to reStructured Text.
123
124
125New Issue Tracker: Roundup
126--------------------------------------------------
127
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000128For a long time, the Python developers have been growing increasingly
129annoyed by SourceForge's bug tracker. SourceForge's hosted solution
130doesn't permit much customization; for example, it wasn't possible to
131customize the life cycle of issues.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000132
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000133The infrastructure committee of the Python Software Foundation
134therefore posted a call for issue trackers, asking volunteers to set
135up different products and import some of the bugs and patches from
136SourceForge. Four different trackers were examined: Atlassian's `Jira
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000137<http://www.atlassian.com/software/jira/>`__,
138`Launchpad <http://www.launchpad.net>`__,
139`Roundup <http://roundup.sourceforge.net/>`__, and
140Trac <http://trac.edgewall.org/>`__.
141The committee eventually settled on Jira
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000142and Roundup as the two candidates. Jira is a commercial product that
143offers a no-cost hosted instance to free-software projects; Roundup
144is an open-source project that requires volunteers
145to administer it and a server to host it.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000146
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000147After posting a call for volunteers, a new Roundup installation was
148set up at http://bugs.python.org. One installation of Roundup can
149host multiple trackers, and this server now also hosts issue trackers
150for Jython and for the Python web site. It will surely find
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000151other uses in the future. Where possible,
152this edition of "What's New in Python" links to the bug/patch
153item for each change.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000154
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000155Hosting is kindly provided by
156`Upfront Systems <http://www.upfrontsystems.co.za/>`__
157of Stellenbosch, South Africa. Martin von Loewis put a
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000158lot of effort into importing existing bugs and patches from
159SourceForge; his scripts for this import operation are at
160http://svn.python.org/view/tracker/importer/.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000161
162.. seealso::
163
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000164 http://bugs.python.org
165 The Python bug tracker.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000166
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000167 http://bugs.jython.org:
168 The Jython bug tracker.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000169
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000170 http://roundup.sourceforge.net/
171 Roundup downloads and documentation.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000172
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000173
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000174New Documentation Format: ReStructured Text Using Sphinx
175-----------------------------------------------------------
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000176
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000177Since the Python project's inception around 1989, the documentation
178had been written using LaTeX. At that time, most documentation was
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000179printed out for later study, not viewed online. LaTeX was widely used
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000180because it provided attractive printed output while remaining
181straightforward to write, once the basic rules of the markup have been
182learned.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000183
184LaTeX is still used today for writing technical publications destined
185for printing, but the landscape for programming tools has shifted. We
186no longer print out reams of documentation; instead, we browse through
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000187it online and HTML has become the most important format to support.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000188Unfortunately, converting LaTeX to HTML is fairly complicated, and
189Fred L. Drake Jr., the Python documentation editor for many years,
190spent a lot of time wrestling the conversion process into shape.
191Occasionally people would suggest converting the documentation into
192SGML or, later, XML, but performing a good conversion is a major task
193and no one pursued the task to completion.
194
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000195During the 2.6 development cycle, Georg Brandl put a substantial
196effort into building a new toolchain for processing the documentation.
197The resulting package is called Sphinx, and is available from
198http://sphinx.pocoo.org/. The input format is reStructured Text, a
199markup commonly used in the Python community that supports custom
200extensions and directives. Sphinx concentrates on HTML output,
201producing attractively styled and modern HTML, though printed output
202is still supported through conversion to LaTeX. Sphinx is a
203standalone package that can be used in documenting other projects.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000204
205.. seealso::
206
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000207 :ref:`documenting-index`
208 Describes how to write for Python's documentation.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000209
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000210 `Sphinx <http://sphinx.pocoo.org/>`__
211 Documentation and code for the Sphinx toolchain.
212
213 `Docutils <http://docutils.sf.net>`__
214 The underlying reStructured Text parser and toolset.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000215
216
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000217PEP 343: The 'with' statement
218=============================
219
220The previous version, Python 2.5, added the ':keyword:`with`'
221statement an optional feature, to be enabled by a ``from __future__
Andrew M. Kuchling6e751f42007-12-03 21:28:41 +0000222import with_statement`` directive. In 2.6 the statement no longer needs to
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000223be specially enabled; this means that :keyword:`with` is now always a
224keyword. The rest of this section is a copy of the corresponding
225section from "What's New in Python 2.5" document; if you read
226it back when Python 2.5 came out, you can skip the rest of this
227section.
228
229The ':keyword:`with`' statement clarifies code that previously would use
230``try...finally`` blocks to ensure that clean-up code is executed. In this
231section, I'll discuss the statement as it will commonly be used. In the next
232section, I'll examine the implementation details and show how to write objects
233for use with this statement.
234
235The ':keyword:`with`' statement is a new control-flow structure whose basic
236structure is::
237
238 with expression [as variable]:
239 with-block
240
241The expression is evaluated, and it should result in an object that supports the
242context management protocol (that is, has :meth:`__enter__` and :meth:`__exit__`
243methods.
244
245The object's :meth:`__enter__` is called before *with-block* is executed and
246therefore can run set-up code. It also may return a value that is bound to the
247name *variable*, if given. (Note carefully that *variable* is *not* assigned
248the result of *expression*.)
249
250After execution of the *with-block* is finished, the object's :meth:`__exit__`
251method is called, even if the block raised an exception, and can therefore run
252clean-up code.
253
254Some standard Python objects now support the context management protocol and can
255be used with the ':keyword:`with`' statement. File objects are one example::
256
257 with open('/etc/passwd', 'r') as f:
258 for line in f:
259 print line
260 ... more processing code ...
261
262After this statement has executed, the file object in *f* will have been
263automatically closed, even if the :keyword:`for` loop raised an exception part-
264way through the block.
265
266.. note::
267
268 In this case, *f* is the same object created by :func:`open`, because
269 :meth:`file.__enter__` returns *self*.
270
271The :mod:`threading` module's locks and condition variables also support the
272':keyword:`with`' statement::
273
274 lock = threading.Lock()
275 with lock:
276 # Critical section of code
277 ...
278
279The lock is acquired before the block is executed and always released once the
280block is complete.
281
282The new :func:`localcontext` function in the :mod:`decimal` module makes it easy
283to save and restore the current decimal context, which encapsulates the desired
284precision and rounding characteristics for computations::
285
286 from decimal import Decimal, Context, localcontext
287
288 # Displays with default precision of 28 digits
289 v = Decimal('578')
290 print v.sqrt()
291
292 with localcontext(Context(prec=16)):
293 # All code in this block uses a precision of 16 digits.
294 # The original context is restored on exiting the block.
295 print v.sqrt()
296
297
298.. _new-26-context-managers:
299
300Writing Context Managers
301------------------------
302
303Under the hood, the ':keyword:`with`' statement is fairly complicated. Most
304people will only use ':keyword:`with`' in company with existing objects and
305don't need to know these details, so you can skip the rest of this section if
306you like. Authors of new objects will need to understand the details of the
307underlying implementation and should keep reading.
308
309A high-level explanation of the context management protocol is:
310
311* The expression is evaluated and should result in an object called a "context
312 manager". The context manager must have :meth:`__enter__` and :meth:`__exit__`
313 methods.
314
315* The context manager's :meth:`__enter__` method is called. The value returned
Georg Brandld41b8dc2007-12-16 23:15:07 +0000316 is assigned to *VAR*. If no ``as VAR`` clause is present, the value is simply
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000317 discarded.
318
319* The code in *BLOCK* is executed.
320
321* If *BLOCK* raises an exception, the :meth:`__exit__(type, value, traceback)`
322 is called with the exception details, the same values returned by
323 :func:`sys.exc_info`. The method's return value controls whether the exception
324 is re-raised: any false value re-raises the exception, and ``True`` will result
325 in suppressing it. You'll only rarely want to suppress the exception, because
326 if you do the author of the code containing the ':keyword:`with`' statement will
327 never realize anything went wrong.
328
329* If *BLOCK* didn't raise an exception, the :meth:`__exit__` method is still
330 called, but *type*, *value*, and *traceback* are all ``None``.
331
332Let's think through an example. I won't present detailed code but will only
333sketch the methods necessary for a database that supports transactions.
334
335(For people unfamiliar with database terminology: a set of changes to the
336database are grouped into a transaction. Transactions can be either committed,
337meaning that all the changes are written into the database, or rolled back,
338meaning that the changes are all discarded and the database is unchanged. See
339any database textbook for more information.)
340
341Let's assume there's an object representing a database connection. Our goal will
342be to let the user write code like this::
343
344 db_connection = DatabaseConnection()
345 with db_connection as cursor:
346 cursor.execute('insert into ...')
347 cursor.execute('delete from ...')
348 # ... more operations ...
349
350The transaction should be committed if the code in the block runs flawlessly or
351rolled back if there's an exception. Here's the basic interface for
352:class:`DatabaseConnection` that I'll assume::
353
354 class DatabaseConnection:
355 # Database interface
Georg Brandl9f72d232007-12-16 23:13:29 +0000356 def cursor(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000357 "Returns a cursor object and starts a new transaction"
Georg Brandl9f72d232007-12-16 23:13:29 +0000358 def commit(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000359 "Commits current transaction"
Georg Brandl9f72d232007-12-16 23:13:29 +0000360 def rollback(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000361 "Rolls back current transaction"
362
363The :meth:`__enter__` method is pretty easy, having only to start a new
364transaction. For this application the resulting cursor object would be a useful
365result, so the method will return it. The user can then add ``as cursor`` to
366their ':keyword:`with`' statement to bind the cursor to a variable name. ::
367
368 class DatabaseConnection:
369 ...
Georg Brandl9f72d232007-12-16 23:13:29 +0000370 def __enter__(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000371 # Code to start a new transaction
372 cursor = self.cursor()
373 return cursor
374
375The :meth:`__exit__` method is the most complicated because it's where most of
376the work has to be done. The method has to check if an exception occurred. If
377there was no exception, the transaction is committed. The transaction is rolled
378back if there was an exception.
379
380In the code below, execution will just fall off the end of the function,
381returning the default value of ``None``. ``None`` is false, so the exception
382will be re-raised automatically. If you wished, you could be more explicit and
383add a :keyword:`return` statement at the marked location. ::
384
385 class DatabaseConnection:
386 ...
Georg Brandl9f72d232007-12-16 23:13:29 +0000387 def __exit__(self, type, value, tb):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000388 if tb is None:
389 # No exception, so commit
390 self.commit()
391 else:
392 # Exception occurred, so rollback.
393 self.rollback()
394 # return False
395
396
397.. _module-contextlib:
398
399The contextlib module
400---------------------
401
402The new :mod:`contextlib` module provides some functions and a decorator that
403are useful for writing objects for use with the ':keyword:`with`' statement.
404
405The decorator is called :func:`contextmanager`, and lets you write a single
406generator function instead of defining a new class. The generator should yield
407exactly one value. The code up to the :keyword:`yield` will be executed as the
408:meth:`__enter__` method, and the value yielded will be the method's return
409value that will get bound to the variable in the ':keyword:`with`' statement's
410:keyword:`as` clause, if any. The code after the :keyword:`yield` will be
411executed in the :meth:`__exit__` method. Any exception raised in the block will
412be raised by the :keyword:`yield` statement.
413
414Our database example from the previous section could be written using this
415decorator as::
416
417 from contextlib import contextmanager
418
419 @contextmanager
Georg Brandl9f72d232007-12-16 23:13:29 +0000420 def db_transaction(connection):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000421 cursor = connection.cursor()
422 try:
423 yield cursor
424 except:
425 connection.rollback()
426 raise
427 else:
428 connection.commit()
429
430 db = DatabaseConnection()
431 with db_transaction(db) as cursor:
432 ...
433
434The :mod:`contextlib` module also has a :func:`nested(mgr1, mgr2, ...)` function
435that combines a number of context managers so you don't need to write nested
436':keyword:`with`' statements. In this example, the single ':keyword:`with`'
437statement both starts a database transaction and acquires a thread lock::
438
439 lock = threading.Lock()
440 with nested (db_transaction(db), lock) as (cursor, locked):
441 ...
442
443Finally, the :func:`closing(object)` function returns *object* so that it can be
444bound to a variable, and calls ``object.close`` at the end of the block. ::
445
446 import urllib, sys
447 from contextlib import closing
448
449 with closing(urllib.urlopen('http://www.yahoo.com')) as f:
450 for line in f:
451 sys.stdout.write(line)
452
453
454.. seealso::
455
456 :pep:`343` - The "with" statement
457 PEP written by Guido van Rossum and Nick Coghlan; implemented by Mike Bland,
458 Guido van Rossum, and Neal Norwitz. The PEP shows the code generated for a
459 ':keyword:`with`' statement, which can be helpful in learning how the statement
460 works.
461
462 The documentation for the :mod:`contextlib` module.
463
Georg Brandlb19be572007-12-29 10:57:00 +0000464.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000465
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000466.. _pep-0366:
467
468PEP 366: Explicit Relative Imports From a Main Module
469============================================================
470
471Python's :option:`-m` switch allows running a module as a script.
472When you ran a module that was located inside a package, relative
473imports didn't work correctly.
474
475The fix in Python 2.6 adds a :attr:`__package__` attribute to modules.
476When present, relative imports will be relative to the value of this
477attribute instead of the :attr:`__name__` attribute. PEP 302-style
478importers can then set :attr:`__package__`. The :mod:`runpy` module
479that implements the :option:`-m` switch now does this, so relative imports
480can now be used in scripts running from inside a package.
481
Georg Brandlb19be572007-12-29 10:57:00 +0000482.. ======================================================================
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000483
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000484.. ::
485
486 .. _pep-0370:
487
488 PEP 370: XXX
489 =====================================================
490
491 When you run Python, the module search page ``sys.modules`` usually
492 includes a directory whose path ends in ``"site-packages"``. This
493 directory is intended to hold locally-installed packages available to
494 all users on a machine or using a particular site installation.
495
496 Python 2.6 introduces a convention for user-specific site directories.
497
498 .. seealso::
499
500 :pep:`370` - XXX
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000501 PEP written by XXX; implemented by Christian Heimes.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000502
503
504.. ======================================================================
505
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000506.. _pep-3101:
507
508PEP 3101: Advanced String Formatting
509=====================================================
510
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000511In Python 3.0, the `%` operator is supplemented by a more powerful
512string formatting method, :meth:`format`. Support for the
513:meth:`format` method has been backported to Python 2.6.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000514
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000515In 2.6, both 8-bit and Unicode strings have a `.format()` method that
516treats the string as a template and takes the arguments to be formatted.
517The formatting template uses curly brackets (`{`, `}`) as special characters::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000518
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000519 # Substitute positional argument 0 into the string.
520 "User ID: {0}".format("root") -> "User ID: root"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000521
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000522 # Use the named keyword arguments
523 uid = 'root'
524
525 'User ID: {uid} Last seen: {last_login}'.format(uid='root',
526 last_login = '5 Mar 2008 07:20') ->
527 'User ID: root Last seen: 5 Mar 2008 07:20'
528
529Curly brackets can be escaped by doubling them::
530
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000531 format("Empty dict: {{}}") -> "Empty dict: {}"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000532
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000533Field names can be integers indicating positional arguments, such as
534``{0}``, ``{1}``, etc. or names of keyword arguments. You can also
535supply compound field names that read attributes or access dictionary keys::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000536
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000537 import sys
538 'Platform: {0.platform}\nPython version: {0.version}'.format(sys) ->
539 'Platform: darwin\n
540 Python version: 2.6a1+ (trunk:61261M, Mar 5 2008, 20:29:41) \n
541 [GCC 4.0.1 (Apple Computer, Inc. build 5367)]'
542
543 import mimetypes
544 'Content-type: {0[.mp4]}'.format(mimetypes.types_map) ->
545 'Content-type: video/mp4'
546
547Note that when using dictionary-style notation such as ``[.mp4]``, you
548don't need to put any quotation marks around the string; it will look
549up the value using ``.mp4`` as the key. Strings beginning with a
550number will be converted to an integer. You can't write more
551complicated expressions inside a format string.
552
553So far we've shown how to specify which field to substitute into the
554resulting string. The precise formatting used is also controllable by
Georg Brandl859043c2008-03-21 17:19:29 +0000555adding a colon followed by a format specifier. For example::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000556
557 # Field 0: left justify, pad to 15 characters
558 # Field 1: right justify, pad to 6 characters
559 fmt = '{0:15} ${1:>6}'
560 fmt.format('Registration', 35) ->
561 'Registration $ 35'
562 fmt.format('Tutorial', 50) ->
563 'Tutorial $ 50'
564 fmt.format('Banquet', 125) ->
565 'Banquet $ 125'
566
Georg Brandl859043c2008-03-21 17:19:29 +0000567Format specifiers can reference other fields through nesting::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000568
569 fmt = '{0:{1}}'
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000570 fmt.format('Invoice #1234', 15) ->
571 'Invoice #1234 '
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000572 width = 35
573 fmt.format('Invoice #1234', width) ->
574 'Invoice #1234 '
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000575
576The alignment of a field within the desired width can be specified:
577
578================ ============================================
579Character Effect
580================ ============================================
581< (default) Left-align
582> Right-align
583^ Center
584= (For numeric types only) Pad after the sign.
585================ ============================================
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000586
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000587Format specifiers can also include a presentation type, which
588controls how the value is formatted. For example, floating-point numbers
589can be formatted as a general number or in exponential notation:
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000590
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000591 >>> '{0:g}'.format(3.75)
592 '3.75'
593 >>> '{0:e}'.format(3.75)
594 '3.750000e+00'
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000595
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000596A variety of presentation types are available. Consult the 2.6
597documentation for a complete list (XXX add link, once it's in the 2.6
598docs), but here's a sample::
599
600 'b' - Binary. Outputs the number in base 2.
601 'c' - Character. Converts the integer to the corresponding
602 Unicode character before printing.
603 'd' - Decimal Integer. Outputs the number in base 10.
604 'o' - Octal format. Outputs the number in base 8.
605 'x' - Hex format. Outputs the number in base 16, using lower-
606 case letters for the digits above 9.
607 'e' - Exponent notation. Prints the number in scientific
608 notation using the letter 'e' to indicate the exponent.
609 'g' - General format. This prints the number as a fixed-point
610 number, unless the number is too large, in which case
611 it switches to 'e' exponent notation.
612 'n' - Number. This is the same as 'g', except that it uses the
613 current locale setting to insert the appropriate
614 number separator characters.
615 '%' - Percentage. Multiplies the number by 100 and displays
616 in fixed ('f') format, followed by a percent sign.
617
618Classes and types can define a __format__ method to control how they're
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000619formatted. It receives a single argument, the format specifier::
620
621 def __format__(self, format_spec):
622 if isinstance(format_spec, unicode):
623 return unicode(str(self))
624 else:
625 return str(self)
626
627There's also a format() built-in that will format a single value. It calls
628the type's :meth:`__format__` method with the provided specifier::
629
630 >>> format(75.6564, '.2f')
631 '75.66'
632
633.. seealso::
634
635 :pep:`3101` - Advanced String Formatting
636 PEP written by Talin.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000637
638.. ======================================================================
639
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000640.. _pep-3105:
641
642PEP 3105: ``print`` As a Function
643=====================================================
644
645The ``print`` statement becomes the :func:`print` function in Python 3.0.
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000646Making :func:`print` a function makes it easier to change
647by doing 'def print(...)' or importing a new function from somewhere else.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000648
649Python 2.6 has a ``__future__`` import that removes ``print`` as language
650syntax, letting you use the functional form instead. For example::
651
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000652 from __future__ import print_function
653 print('# of entries', len(dictionary), file=sys.stderr)
654
655The signature of the new function is::
656
657 def print(*args, sep=' ', end='\n', file=None)
658
659The parameters are:
660
661 * **args**: positional arguments whose values will be printed out.
662 * **sep**: the separator, which will be printed between arguments.
663 * **end**: the ending text, which will be printed after all of the
664 arguments have been output.
665 * **file**: the file object to which the output will be sent.
666
667.. seealso::
668
Eric Smith33dd0942008-03-20 23:04:04 +0000669 :pep:`3105` - Make print a function
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000670 PEP written by Georg Brandl.
671
672.. ======================================================================
673
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000674.. _pep-3110:
675
676PEP 3110: Exception-Handling Changes
677=====================================================
678
679One error that Python programmers occasionally make
680is the following::
681
682 try:
683 ...
684 except TypeError, ValueError:
685 ...
686
687The author is probably trying to catch both
688:exc:`TypeError` and :exc:`ValueError` exceptions, but this code
689actually does something different: it will catch
690:exc:`TypeError` and bind the resulting exception object
691to the local name ``"ValueError"``. The correct code
692would have specified a tuple::
693
694 try:
695 ...
696 except (TypeError, ValueError):
697 ...
698
699This error is possible because the use of the comma here is ambiguous:
700does it indicate two different nodes in the parse tree, or a single
701node that's a tuple.
702
703Python 3.0 changes the syntax to make this unambiguous by replacing
704the comma with the word "as". To catch an exception and store the
705exception object in the variable ``exc``, you must write::
706
707 try:
708 ...
709 except TypeError as exc:
710 ...
711
712Python 3.0 will only support the use of "as", and therefore interprets
713the first example as catching two different exceptions. Python 2.6
714supports both the comma and "as", so existing code will continue to
715work.
716
717.. seealso::
718
719 :pep:`3110` - Catching Exceptions in Python 3000
720 PEP written and implemented by Collin Winter.
721
Georg Brandlb19be572007-12-29 10:57:00 +0000722.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000723
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000724.. _pep-3112:
725
726PEP 3112: Byte Literals
727=====================================================
728
729Python 3.0 adopts Unicode as the language's fundamental string type, and
730denotes 8-bit literals differently, either as ``b'string'``
731or using a :class:`bytes` constructor. For future compatibility,
732Python 2.6 adds :class:`bytes` as a synonym for the :class:`str` type,
733and it also supports the ``b''`` notation.
734
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000735There's also a ``__future__`` import that causes all string literals
736to become Unicode strings. This means that ``\u`` escape sequences
737can be used to include Unicode characters.
738
Andrew M. Kuchlingda950eb2008-04-13 22:39:12 +0000739 from __future__ import unicode_literals
740
741 s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
742 '\u3081\u3000\u751f\u305f\u307e\u3054')
743
744 print len(s) # 12 Unicode characters
745
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000746
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000747.. seealso::
748
749 :pep:`3112` - Bytes literals in Python 3000
750 PEP written by Jason Orendorff; backported to 2.6 by Christian Heimes.
751
752.. ======================================================================
753
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000754.. _pep-3116:
755
756PEP 3116: New I/O Library
757=====================================================
758
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +0000759Python's built-in file objects support a number of methods, but
760file-like objects don't necessarily support all of them. Objects that
761imitate files usually support :meth:`read` and :meth:`write`, but they
762may not support :meth:`readline`. Python 3.0 introduces a layered I/O
763library in the :mod:`io` module that separates buffering and
764text-handling features from the fundamental read and write operations.
765
766There are three levels of abstract base classes provided by
767the :mod:`io` module:
768
769* :class:`RawIOBase`: defines raw I/O operations: :meth:`read`,
770 :meth:`readinto`,
771 :meth:`write`, :meth:`seek`, :meth:`tell`, :meth:`truncate`,
772 and :meth:`close`.
773 Most of the methods of this class will often map to a single system call.
774 There are also :meth:`readable`, :meth:`writable`, and :meth:`seekable`
775 methods for determining what operations a given object will allow.
776
777 Python 3.0 has concrete implementations of this class for files and
778 sockets, but Python 2.6 hasn't restructured its file and socket objects
779 in this way.
780
781 .. XXX should 2.6 register them in io.py?
782
783* :class:`BufferedIOBase`: is an abstract base class that
784 buffers data in memory to reduce the number of
785 system calls used, making I/O processing more efficient.
786 It supports all of the methods of :class:`RawIOBase`,
787 and adds a :attr:`raw` attribute holding the underlying raw object.
788
789 There are four concrete classes implementing this ABC:
790 :class:`BufferedWriter` and
791 :class:`BufferedReader` for objects that only support
792 writing or reading and don't support random access,
793 :class:`BufferedRandom` for objects that support the :meth:`seek` method
794 for random access,
795 and :class:`BufferedRWPair` for objects such as TTYs that have
796 both read and write operations that act upon unconnected streams of data.
797
798* :class:`TextIOBase`: Provides functions for reading and writing
799 strings (remember, strings will be Unicode in Python 3.0),
800 and supporting universal newlines. :class:`TextIOBase` defines
801 the :meth:`readline` method and supports iteration upon
802 objects.
803
804 There are two concrete implementations. :class:`TextIOWrapper`
805 wraps a buffered I/O object, supporting all of the methods for
806 text I/O and adding a :attr:`buffer` attribute for access
807 to the underlying object. :class:`StringIO` simply buffers
808 everything in memory without ever writing anything to disk.
809
810 (In current 2.6 alpha releases, :class:`io.StringIO` is implemented in
811 pure Python, so it's pretty slow. You should therefore stick with the
812 existing :mod:`StringIO` module or :mod:`cStringIO` for now. At some
813 point Python 3.0's :mod:`io` module will be rewritten into C for speed,
814 and perhaps the C implementation will be backported to the 2.x releases.)
815
816 .. XXX check before final release: is io.py still written in Python?
817
818In Python 2.6, the underlying implementations haven't been
819restructured to build on top of the :mod:`io` module's classes. The
820module is being provided to make it easier to write code that's
821forward-compatible with 3.0, and to save developers the effort of writing
822their own implementations of buffering and text I/O.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000823
824.. seealso::
825
826 :pep:`3116` - New I/O
827 PEP written by Daniel Stutzbach, Mike Verdone, and Guido van Rossum.
Andrew M. Kuchling04f58762008-04-15 02:24:15 +0000828 Code by Guido van Rossum, Georg Brandl, Walter Doerwald,
829 Jeremy Hylton, Martin von Loewis, Tony Lownds, and others.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000830
831.. ======================================================================
832
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000833.. _pep-3118:
834
835PEP 3118: Revised Buffer Protocol
836=====================================================
837
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000838The buffer protocol is a C-level API that lets Python types
839exchange pointers into their internal representations. A
840memory-mapped file can be viewed as a buffer of characters, for
841example, and this lets another module such as :mod:`re`
842treat memory-mapped files as a string of characters to be searched.
843
844The primary users of the buffer protocol are numeric-processing
845packages such as NumPy, which can expose the internal representation
846of arrays so that callers can write data directly into an array instead
847of going through a slower API. This PEP updates the buffer protocol in light of experience
848from NumPy development, adding a number of new features
849such as indicating the shape of an array,
850locking memory .
851
852The most important new C API function is
853``PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)``, which
854takes an object and a set of flags, and fills in the
855``Py_buffer`` structure with information
856about the object's memory representation. Objects
857can use this operation to lock memory in place
858while an external caller could be modifying the contents,
859so there's a corresponding
860``PyObject_ReleaseBuffer(PyObject *obj, Py_buffer *view)`` to
861indicate that the external caller is done.
862
863The **flags** argument to :cfunc:`PyObject_GetBuffer` specifies
864constraints upon the memory returned. Some examples are:
865
866 * :const:`PyBUF_WRITABLE` indicates that the memory must be writable.
867
868 * :const:`PyBUF_LOCK` requests a read-only or exclusive lock on the memory.
869
870 * :const:`PyBUF_C_CONTIGUOUS` and :const:`PyBUF_F_CONTIGUOUS`
871 requests a C-contiguous (last dimension varies the fastest) or
872 Fortran-contiguous (first dimension varies the fastest) layout.
873
874.. XXX this feature is not in 2.6 docs yet
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000875
876.. seealso::
877
878 :pep:`3118` - Revising the buffer protocol
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000879 PEP written by Travis Oliphant and Carl Banks; implemented by
880 Travis Oliphant.
881
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000882
883.. ======================================================================
884
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000885.. _pep-3119:
886
887PEP 3119: Abstract Base Classes
888=====================================================
889
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000890Some object-oriented languages such as Java support interfaces: declarations
891that a class has a given set of methods or supports a given access protocol.
892Abstract Base Classes (or ABCs) are an equivalent feature for Python. The ABC
893support consists of an :mod:`abc` module containing a metaclass called
894:class:`ABCMeta`, special handling
895of this metaclass by the :func:`isinstance` and :func:`issubclass` built-ins,
896and a collection of basic ABCs that the Python developers think will be widely
897useful.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000898
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000899Let's say you have a particular class and wish to know whether it supports
900dictionary-style access. The phrase "dictionary-style" is vague, however.
901It probably means that accessing items with ``obj[1]`` works.
902Does it imply that setting items with ``obj[2] = value`` works?
903Or that the object will have :meth:`keys`, :meth:`values`, and :meth:`items`
904methods? What about the iterative variants such as :meth:`iterkeys`? :meth:`copy`
905and :meth:`update`? Iterating over the object with :func:`iter`?
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000906
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000907Python 2.6 includes a number of different ABCs in the :mod:`collections`
908module. :class:`Iterable` indicates that a class defines :meth:`__iter__`,
909and :class:`Container` means the class supports ``x in y`` expressions
910by defining a :meth:`__contains__` method. The basic dictionary interface of
911getting items, setting items, and
912:meth:`keys`, :meth:`values`, and :meth:`items`, is defined by the
913:class:`MutableMapping` ABC.
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000914
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000915You can derive your own classes from a particular ABC
916to indicate they support that ABC's interface::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000917
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000918 import collections
919
920 class Storage(collections.MutableMapping):
921 ...
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000922
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000923
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000924Alternatively, you could write the class without deriving from
925the desired ABC and instead register the class by
926calling the ABC's :meth:`register` method::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +0000927
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000928 import collections
929
930 class Storage:
931 ...
932
933 collections.MutableMapping.register(Storage)
934
935For classes that you write, deriving from the ABC is probably clearer.
936The :meth:`register` method is useful when you've written a new
937ABC that can describe an existing type or class, or if you want
938to declare that some third-party class implements an ABC.
939For example, if you defined a :class:`PrintableType` ABC,
940it's legal to do:
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +0000941
Andrew M. Kuchling21852412008-04-05 18:15:30 +0000942 # Register Python's types
943 PrintableType.register(int)
944 PrintableType.register(float)
945 PrintableType.register(str)
946
947Classes should obey the semantics specified by an ABC, but
948Python can't check this; it's up to the class author to
949understand the ABC's requirements and to implement the code accordingly.
950
951To check whether an object supports a particular interface, you can
952now write::
953
954 def func(d):
955 if not isinstance(d, collections.MutableMapping):
956 raise ValueError("Mapping object expected, not %r" % d)
957
958(Don't feel that you must now begin writing lots of checks as in the
959above example. Python has a strong tradition of duck-typing, where
960explicit type-checking isn't done and code simply calls methods on
961an object, trusting that those methods will be there and raising an
962exception if they aren't. Be judicious in checking for ABCs
963and only do it where it helps.)
964
965You can write your own ABCs by using ``abc.ABCMeta`` as the
966metaclass in a class definition::
967
968 from abc import ABCMeta
969
970 class Drawable():
971 __metaclass__ = ABCMeta
972
973 def draw(self, x, y, scale=1.0):
974 pass
975
976 def draw_doubled(self, x, y):
977 self.draw(x, y, scale=2.0)
978
979
980 class Square(Drawable):
981 def draw(self, x, y, scale):
982 ...
983
984
985In the :class:`Drawable` ABC above, the :meth:`draw_doubled` method
986renders the object at twice its size and can be implemented in terms
987of other methods described in :class:`Drawable`. Classes implementing
988this ABC therefore don't need to provide their own implementation
989of :meth:`draw_doubled`, though they can do so. An implementation
990of :meth:`draw` is necessary, though; the ABC can't provide
991a useful generic implementation. You
992can apply the ``@abstractmethod`` decorator to methods such as
993:meth:`draw` that must be implemented; Python will
994then raise an exception for classes that
995don't define the method::
996
997 class Drawable():
998 __metaclass__ = ABCMeta
999
1000 @abstractmethod
1001 def draw(self, x, y, scale):
1002 pass
1003
1004Note that the exception is only raised when you actually
1005try to create an instance of a subclass without the method::
1006
1007 >>> s=Square()
1008 Traceback (most recent call last):
1009 File "<stdin>", line 1, in <module>
1010 TypeError: Can't instantiate abstract class Square with abstract methods draw
1011 >>>
1012
1013Abstract data attributes can be declared using the ``@abstractproperty`` decorator::
1014
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001015 @abstractproperty
1016 def readonly(self):
1017 return self._x
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001018
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001019Subclasses must then define a :meth:`readonly` property
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001020
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001021.. seealso::
1022
1023 :pep:`3119` - Introducing Abstract Base Classes
1024 PEP written by Guido van Rossum and Talin.
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001025 Implemented by Guido van Rossum.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001026 Backported to 2.6 by Benjamin Aranguren, with Alex Martelli.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001027
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001028.. ======================================================================
1029
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001030.. _pep-3127:
1031
1032PEP 3127: Integer Literal Support and Syntax
1033=====================================================
1034
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001035Python 3.0 changes the syntax for octal (base-8) integer literals,
1036which are now prefixed by "0o" or "0O" instead of a leading zero, and
1037adds support for binary (base-2) integer literals, signalled by a "0b"
1038or "0B" prefix.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001039
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001040Python 2.6 doesn't drop support for a leading 0 signalling
1041an octal number, but it does add support for "0o" and "0b"::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001042
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001043 >>> 0o21, 2*8 + 1
1044 (17, 17)
1045 >>> 0b101111
1046 47
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001047
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001048The :func:`oct` built-in still returns numbers
1049prefixed with a leading zero, and a new :func:`bin`
1050built-in returns the binary representation for a number::
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001051
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001052 >>> oct(42)
1053 '052'
1054 >>> bin(173)
1055 '0b10101101'
1056
1057The :func:`int` and :func:`long` built-ins will now accept the "0o"
1058and "0b" prefixes when base-8 or base-2 are requested, or when the
1059**base** argument is zero (meaning the base used is determined from
1060the string):
1061
1062 >>> int ('0o52', 0)
1063 42
1064 >>> int('1101', 2)
1065 13
1066 >>> int('0b1101', 2)
1067 13
1068 >>> int('0b1101', 0)
1069 13
1070
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001071
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001072.. seealso::
1073
1074 :pep:`3127` - Integer Literal Support and Syntax
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001075 PEP written by Patrick Maupin; backported to 2.6 by
1076 Eric Smith.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001077
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001078.. ======================================================================
1079
1080.. _pep-3129:
1081
1082PEP 3129: Class Decorators
1083=====================================================
1084
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001085Decorators have been extended from functions to classes. It's now legal to
1086write::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001087
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001088 @foo
1089 @bar
1090 class A:
1091 pass
1092
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001093This is equivalent to::
1094
1095 class A:
1096 pass
1097
1098 A = foo(bar(A))
1099
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001100.. seealso::
1101
1102 :pep:`3129` - Class Decorators
1103 PEP written by Collin Winter.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001104
1105.. ======================================================================
1106
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001107.. _pep-3141:
1108
1109PEP 3141: A Type Hierarchy for Numbers
1110=====================================================
1111
1112In Python 3.0, several abstract base classes for numeric types,
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001113inspired by Scheme's numeric tower, are being added.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001114This change was backported to 2.6 as the :mod:`numbers` module.
1115
1116The most general ABC is :class:`Number`. It defines no operations at
1117all, and only exists to allow checking if an object is a number by
1118doing ``isinstance(obj, Number)``.
1119
1120Numbers are further divided into :class:`Exact` and :class:`Inexact`.
1121Exact numbers can represent values precisely and operations never
1122round off the results or introduce tiny errors that may break the
Georg Brandl907a7202008-02-22 12:31:45 +00001123commutativity and associativity properties; inexact numbers may
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001124perform such rounding or introduce small errors. Integers, long
1125integers, and rational numbers are exact, while floating-point
1126and complex numbers are inexact.
1127
1128:class:`Complex` is a subclass of :class:`Number`. Complex numbers
1129can undergo the basic operations of addition, subtraction,
1130multiplication, division, and exponentiation, and you can retrieve the
1131real and imaginary parts and obtain a number's conjugate. Python's built-in
1132complex type is an implementation of :class:`Complex`.
1133
1134:class:`Real` further derives from :class:`Complex`, and adds
1135operations that only work on real numbers: :func:`floor`, :func:`trunc`,
1136rounding, taking the remainder mod N, floor division,
1137and comparisons.
1138
1139:class:`Rational` numbers derive from :class:`Real`, have
1140:attr:`numerator` and :attr:`denominator` properties, and can be
Mark Dickinsond058cd22008-02-10 21:29:51 +00001141converted to floats. Python 2.6 adds a simple rational-number class,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001142:class:`Fraction`, in the :mod:`fractions` module. (It's called
1143:class:`Fraction` instead of :class:`Rational` to avoid
1144a name clash with :class:`numbers.Rational`.)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001145
1146:class:`Integral` numbers derive from :class:`Rational`, and
1147can be shifted left and right with ``<<`` and ``>>``,
1148combined using bitwise operations such as ``&`` and ``|``,
1149and can be used as array indexes and slice boundaries.
1150
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001151In Python 3.0, the PEP slightly redefines the existing built-ins
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001152:func:`round`, :func:`math.floor`, :func:`math.ceil`, and adds a new
1153one, :func:`math.trunc`, that's been backported to Python 2.6.
1154:func:`math.trunc` rounds toward zero, returning the closest
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001155:class:`Integral` that's between the function's argument and zero.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001156
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001157.. seealso::
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001158
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001159 :pep:`3141` - A Type Hierarchy for Numbers
1160 PEP written by Jeffrey Yasskin.
1161
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001162 `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 +00001163
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001164 `Scheme's number datatypes <http://schemers.org/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2>`__ from the R5RS Scheme specification.
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001165
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001166
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001167The :mod:`fractions` Module
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001168--------------------------------------------------
1169
1170To fill out the hierarchy of numeric types, a rational-number class
Mark Dickinsond058cd22008-02-10 21:29:51 +00001171has been added as the :mod:`fractions` module. Rational numbers are
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001172represented as a fraction, and can exactly represent
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001173numbers such as two-thirds that floating-point numbers can only
1174approximate.
1175
Mark Dickinsond058cd22008-02-10 21:29:51 +00001176The :class:`Fraction` constructor takes two :class:`Integral` values
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001177that will be the numerator and denominator of the resulting fraction. ::
1178
Mark Dickinsond058cd22008-02-10 21:29:51 +00001179 >>> from fractions import Fraction
1180 >>> a = Fraction(2, 3)
1181 >>> b = Fraction(2, 5)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001182 >>> float(a), float(b)
1183 (0.66666666666666663, 0.40000000000000002)
1184 >>> a+b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001185 Fraction(16, 15)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001186 >>> a/b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001187 Fraction(5, 3)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001188
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001189To help in converting floating-point numbers to rationals,
1190the float type now has a :meth:`as_integer_ratio()` method that returns
1191the numerator and denominator for a fraction that evaluates to the same
1192floating-point value::
1193
1194 >>> (2.5) .as_integer_ratio()
1195 (5, 2)
1196 >>> (3.1415) .as_integer_ratio()
1197 (7074029114692207L, 2251799813685248L)
1198 >>> (1./3) .as_integer_ratio()
1199 (6004799503160661L, 18014398509481984L)
1200
1201Note that values that can only be approximated by floating-point
1202numbers, such as 1./3, are not simplified to the number being
1203approximated; the fraction attempts to match the floating-point value
1204**exactly**.
1205
Mark Dickinsond058cd22008-02-10 21:29:51 +00001206The :mod:`fractions` module is based upon an implementation by Sjoerd
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001207Mullender that was in Python's :file:`Demo/classes/` directory for a
1208long time. This implementation was significantly updated by Jeffrey
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001209Yasskin.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001210
Georg Brandl8ec7f652007-08-15 14:28:01 +00001211Other Language Changes
1212======================
1213
1214Here are all of the changes that Python 2.6 makes to the core Python language.
1215
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001216* When calling a function using the ``**`` syntax to provide keyword
1217 arguments, you are no longer required to use a Python dictionary;
1218 any mapping will now work::
1219
1220 >>> def f(**kw):
1221 ... print sorted(kw)
1222 ...
1223 >>> ud=UserDict.UserDict()
1224 >>> ud['a'] = 1
1225 >>> ud['b'] = 'string'
1226 >>> f(**ud)
1227 ['a', 'b']
1228
Andrew M. Kuchlingc157c9c2008-04-09 22:28:43 +00001229 (Contributed by Alexander Belopolsky; :issue:`1686487`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001230
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001231* Tuples now have an :meth:`index` method matching the list type's
1232 :meth:`index` method::
1233
1234 >>> t = (0,1,2,3,4)
1235 >>> t.index(3)
1236 3
1237
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001238* The built-in types now have improved support for extended slicing syntax,
1239 where various combinations of ``(start, stop, step)`` are supplied.
1240 Previously, the support was partial and certain corner cases wouldn't work.
1241 (Implemented by Thomas Wouters.)
1242
Georg Brandlb19be572007-12-29 10:57:00 +00001243 .. Revision 57619
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001244
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001245* Properties now have three attributes, :attr:`getter`,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001246 :attr:`setter` and :attr:`deleter`, that are useful shortcuts for
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001247 adding or modifying a getter, setter or deleter function to an
1248 existing property. You would use them like this::
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001249
1250 class C(object):
1251 @property
1252 def x(self):
1253 return self._x
1254
1255 @x.setter
1256 def x(self, value):
1257 self._x = value
1258
1259 @x.deleter
1260 def x(self):
1261 del self._x
1262
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001263 class D(C):
1264 @C.x.getter
1265 def x(self):
1266 return self._x * 2
1267
1268 @x.setter
1269 def x(self, value):
1270 self._x = value / 2
1271
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001272
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001273* C functions and methods that use
1274 :cfunc:`PyComplex_AsCComplex` will now accept arguments that
1275 have a :meth:`__complex__` method. In particular, the functions in the
1276 :mod:`cmath` module will now accept objects with this method.
1277 This is a backport of a Python 3.0 change.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001278 (Contributed by Mark Dickinson; :issue:`1675423`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001279
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001280 A numerical nicety: when creating a complex number from two floats
1281 on systems that support signed zeros (-0 and +0), the
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001282 :func:`complex` constructor will now preserve the sign
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001283 of the zero. (:issue:`1507`)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001284
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001285* More floating-point features were also added. The :func:`float` function
1286 will now turn the strings ``+nan`` and ``-nan`` into the corresponding
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001287 IEEE 754 Not A Number values, and ``+inf`` and ``-inf`` into
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001288 positive or negative infinity. This works on any platform with
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001289 IEEE 754 semantics. (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001290
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001291 Other functions in the :mod:`math` module, :func:`isinf` and
1292 :func:`isnan`, return true if their floating-point argument is
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001293 infinite or Not A Number. (:issue:`1640`)
Georg Brandle1b8e9c2008-02-20 19:12:36 +00001294
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001295* The :mod:`math` module has seven new functions, and the existing
1296 functions have been improved to give more consistent behaviour
1297 across platforms, especially with respect to handling of
1298 floating-point exceptions and IEEE 754 special values.
1299 The new functions are:
1300
1301 * :func:`isinf` and :func:`isnan` determine whether a given float is
1302 a (positive or negative) infinity or a NaN (Not a Number),
1303 respectively.
1304
1305 * ``copysign(x, y)`` copies the sign bit of an IEEE 754 number,
1306 returning the absolute value of *x* combined with the sign bit of
1307 *y*. For example, ``math.copysign(1, -0.0)`` returns -1.0.
1308 (Contributed by Christian Heimes.)
1309
1310 * The inverse hyperbolic functions :func:`acosh`, :func:`asinh` and
1311 :func:`atanh`.
1312
1313 * The function :func:`log1p`, returning the natural logarithm of
1314 *1+x* (base *e*).
1315
1316 There's also a new :func:`trunc` function as a result of the
1317 backport of `PEP 3141's type hierarchy for numbers <#pep-3141>`__.
1318
1319 The existing math functions have been modified to follow the
1320 recommendations of the C99 standard with respect to special values
1321 whenever possible. For example, ``sqrt(-1.)`` should now give a
1322 :exc:`ValueError` across (nearly) all platforms, while
1323 ``sqrt(float('NaN'))`` should return a NaN on all IEEE 754
1324 platforms. Where Annex 'F' of the C99 standard recommends signaling
1325 'divide-by-zero' or 'invalid', Python will raise :exc:`ValueError`.
1326 Where Annex 'F' of the C99 standard recommends signaling 'overflow',
1327 Python will raise :exc:`OverflowError`. (See :issue:`711019`,
1328 :issue:`1640`.)
1329
1330 (Contributed by Christian Heimes and Mark Dickinson.)
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001331
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001332* Changes to the :class:`Exception` interface
1333 as dictated by :pep:`352` continue to be made. For 2.6,
1334 the :attr:`message` attribute is being deprecated in favor of the
1335 :attr:`args` attribute.
1336
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001337* The :exc:`GeneratorExit` exception now subclasses
1338 :exc:`BaseException` instead of :exc:`Exception`. This means
1339 that an exception handler that does ``except Exception:``
1340 will not inadvertently catch :exc:`GeneratorExit`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001341 (Contributed by Chad Austin; :issue:`1537`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001342
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001343* Generator objects now have a :attr:`gi_code` attribute that refers to
1344 the original code object backing the generator.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001345 (Contributed by Collin Winter; :issue:`1473257`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001346
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001347* The :func:`compile` built-in function now accepts keyword arguments
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001348 as well as positional parameters. (Contributed by Thomas Wouters;
1349 :issue:`1444529`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001350
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001351* The :func:`complex` constructor now accepts strings containing
1352 parenthesized complex numbers, letting ``complex(repr(cmplx))``
1353 will now round-trip values. For example, ``complex('(3+4j)')``
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001354 now returns the value (3+4j). (:issue:`1491866`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001355
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001356* The string :meth:`translate` method now accepts ``None`` as the
1357 translation table parameter, which is treated as the identity
1358 transformation. This makes it easier to carry out operations
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001359 that only delete characters. (Contributed by Bengt Richter;
1360 :issue:`1193128`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001361
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001362* The built-in :func:`dir` function now checks for a :meth:`__dir__`
1363 method on the objects it receives. This method must return a list
1364 of strings containing the names of valid attributes for the object,
1365 and lets the object control the value that :func:`dir` produces.
1366 Objects that have :meth:`__getattr__` or :meth:`__getattribute__`
Facundo Batistabd5b6232007-12-03 19:49:54 +00001367 methods can use this to advertise pseudo-attributes they will honor.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001368 (:issue:`1591665`)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001369
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001370* Instance method objects have new attributes for the object and function
1371 comprising the method; the new synonym for :attr:`im_self` is
1372 :attr:`__self__`, and :attr:`im_func` is also available as :attr:`__func__`.
1373 The old names are still supported in Python 2.6; they're gone in 3.0.
1374
Georg Brandl8ec7f652007-08-15 14:28:01 +00001375* An obscure change: when you use the the :func:`locals` function inside a
1376 :keyword:`class` statement, the resulting dictionary no longer returns free
1377 variables. (Free variables, in this case, are variables referred to in the
1378 :keyword:`class` statement that aren't attributes of the class.)
1379
Georg Brandlb19be572007-12-29 10:57:00 +00001380.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001381
1382
1383Optimizations
1384-------------
1385
Georg Brandlaf30b282008-01-15 06:55:56 +00001386* Type objects now have a cache of methods that can reduce
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001387 the amount of work required to find the correct method implementation
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001388 for a particular class; once cached, the interpreter doesn't need to
1389 traverse base classes to figure out the right method to call.
1390 The cache is cleared if a base class or the class itself is modified,
1391 so the cache should remain correct even in the face of Python's dynamic
1392 nature.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001393 (Original optimization implemented by Armin Rigo, updated for
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001394 Python 2.6 by Kevin Jacobs; :issue:`1700288`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001395
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001396* All of the functions in the :mod:`struct` module have been rewritten in
1397 C, thanks to work at the Need For Speed sprint.
1398 (Contributed by Raymond Hettinger.)
1399
Georg Brandl8ec7f652007-08-15 14:28:01 +00001400* Internally, a bit is now set in type objects to indicate some of the standard
1401 built-in types. This speeds up checking if an object is a subclass of one of
1402 these types. (Contributed by Neal Norwitz.)
1403
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001404* Unicode strings now uses faster code for detecting
1405 whitespace and line breaks; this speeds up the :meth:`split` method
1406 by about 25% and :meth:`splitlines` by 35%.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001407 (Contributed by Antoine Pitrou.) Memory usage is reduced
1408 by using pymalloc for the Unicode string's data.
1409
1410* The ``with`` statement now stores the :meth:`__exit__` method on the stack,
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001411 producing a small speedup. (Implemented by Jeffrey Yasskin.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001412
1413* To reduce memory usage, the garbage collector will now clear internal
1414 free lists when garbage-collecting the highest generation of objects.
1415 This may return memory to the OS sooner.
1416
Georg Brandl8ec7f652007-08-15 14:28:01 +00001417The net result of the 2.6 optimizations is that Python 2.6 runs the pystone
1418benchmark around XX% faster than Python 2.5.
1419
Georg Brandlb19be572007-12-29 10:57:00 +00001420.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001421
Benjamin Peterson037d8292008-04-13 02:20:05 +00001422.. _new-26-interactive:
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001423
1424Interactive Interpreter Changes
1425-------------------------------
1426
1427Two command-line options have been reserved for use by other Python
1428implementations. The :option:`-J` switch has been reserved for use by
1429Jython for Jython-specific options, such as ones that are passed to
1430the underlying JVM. :option:`-X` has been reserved for options
1431specific to a particular implementation of Python such as CPython,
1432Jython, or IronPython. If either option is used with Python 2.6, the
1433interpreter will report that the option isn't currently used.
1434
1435.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001436
1437New, Improved, and Deprecated Modules
1438=====================================
1439
1440As usual, Python's standard library received a number of enhancements and bug
1441fixes. Here's a partial list of the most notable changes, sorted alphabetically
1442by module name. Consult the :file:`Misc/NEWS` file in the source tree for a more
1443complete list of changes, or look through the CVS logs for all the details.
1444
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001445* The :mod:`bsddb.dbshelve` module now uses the highest pickling protocol
1446 available, instead of restricting itself to protocol 1.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001447 (Contributed by W. Barnes; :issue:`1551443`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001448
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001449* The :mod:`cmath` module underwent an extensive set of revisions,
1450 thanks to Mark Dickinson and Christian Heimes, that added some new
1451 features and greatly improved the accuracy of the computations.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001452
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001453 Five new functions were added:
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001454
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001455 * :func:`polar` converts a complex number to polar form, returning
1456 the modulus and argument of that complex number.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001457
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001458 * :func:`rect` does the opposite, turning a (modulus, argument) pair
1459 back into the corresponding complex number.
1460
1461 * :func:`phase` returns the phase or argument of a complex number.
1462
1463 * :func:`isnan` returns True if either
1464 the real or imaginary part of its argument is a NaN.
1465
1466 * :func:`isinf` returns True if either the real or imaginary part of
1467 its argument is infinite.
1468
1469 The revisions also improved the numerical soundness of the
1470 :mod:`cmath` module. For all functions, the real and imaginary
1471 parts of the results are accurate to within a few units of least
1472 precision (ulps) whenever possible. See :issue:`1381` for the
1473 details. The branch cuts for :func:`asinh`, :func:`atanh`: and
1474 :func:`atan` have also been corrected.
1475
1476 The tests for the module have been greatly expanded; nearly 2000 new
1477 test cases exercise the algebraic functions.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001478
1479 On IEEE 754 platforms, the :mod:`cmath` module now handles IEEE 754
1480 special values and floating-point exceptions in a manner consistent
1481 with Annex 'G' of the C99 standard.
1482
Andrew M. Kuchling6d57c822007-10-23 20:55:47 +00001483* A new data type in the :mod:`collections` module: :class:`namedtuple(typename,
Georg Brandl8ec7f652007-08-15 14:28:01 +00001484 fieldnames)` is a factory function that creates subclasses of the standard tuple
1485 whose fields are accessible by name as well as index. For example::
1486
Andrew M. Kuchling6d57c822007-10-23 20:55:47 +00001487 >>> var_type = collections.namedtuple('variable',
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001488 ... 'id name type size')
1489 # Names are separated by spaces or commas.
1490 # 'id, name, type, size' would also work.
Raymond Hettinger366523c2007-12-14 18:12:21 +00001491 >>> var_type._fields
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001492 ('id', 'name', 'type', 'size')
Georg Brandl8ec7f652007-08-15 14:28:01 +00001493
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001494 >>> var = var_type(1, 'frequency', 'int', 4)
1495 >>> print var[0], var.id # Equivalent
1496 1 1
1497 >>> print var[2], var.type # Equivalent
1498 int int
Raymond Hettinger366523c2007-12-14 18:12:21 +00001499 >>> var._asdict()
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001500 {'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'}
Raymond Hettingere9b9b352008-02-15 21:21:25 +00001501 >>> v2 = var._replace(name='amplitude')
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001502 >>> v2
1503 variable(id=1, name='amplitude', type='int', size=4)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001504
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001505 Where the new :class:`namedtuple` type proved suitable, the standard
1506 library has been modified to return them. For example,
1507 the :meth:`Decimal.as_tuple` method now returns a named tuple with
1508 :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
1509
Georg Brandl8ec7f652007-08-15 14:28:01 +00001510 (Contributed by Raymond Hettinger.)
1511
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001512* Another change to the :mod:`collections` module is that the
Georg Brandle7d118a2007-12-08 11:05:05 +00001513 :class:`deque` type now supports an optional *maxlen* parameter;
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001514 if supplied, the deque's size will be restricted to no more
Georg Brandle7d118a2007-12-08 11:05:05 +00001515 than *maxlen* items. Adding more items to a full deque causes
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001516 old items to be discarded.
1517
1518 ::
1519
1520 >>> from collections import deque
1521 >>> dq=deque(maxlen=3)
1522 >>> dq
1523 deque([], maxlen=3)
1524 >>> dq.append(1) ; dq.append(2) ; dq.append(3)
1525 >>> dq
1526 deque([1, 2, 3], maxlen=3)
1527 >>> dq.append(4)
1528 >>> dq
1529 deque([2, 3, 4], maxlen=3)
1530
1531 (Contributed by Raymond Hettinger.)
1532
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001533* The :mod:`ctypes` module now supports a :class:`c_bool` datatype
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001534 that represents the C99 ``bool`` type. (Contributed by David Remahl;
1535 :issue:`1649190`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001536
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001537 The :mod:`ctypes` string, buffer and array types also have improved
1538 support for extended slicing syntax,
1539 where various combinations of ``(start, stop, step)`` are supplied.
1540 (Implemented by Thomas Wouters.)
1541
Georg Brandlb19be572007-12-29 10:57:00 +00001542 .. Revision 57769
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001543
Georg Brandl8ec7f652007-08-15 14:28:01 +00001544* A new method in the :mod:`curses` module: for a window, :meth:`chgat` changes
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001545 the display characters for a certain number of characters on a single line.
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001546 (Contributed by Fabian Kreutz.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001547 ::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001548
1549 # Boldface text starting at y=0,x=21
1550 # and affecting the rest of the line.
1551 stdscr.chgat(0,21, curses.A_BOLD)
1552
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001553 The :class:`Textbox` class in the :mod:`curses.textpad` module
1554 now supports editing in insert mode as well as overwrite mode.
1555 Insert mode is enabled by supplying a true value for the *insert_mode*
1556 parameter when creating the :class:`Textbox` instance.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001557
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001558* The :mod:`datetime` module's :meth:`strftime` methods now support a
1559 ``%f`` format code that expands to the number of microseconds in the
1560 object, zero-padded on
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001561 the left to six places. (Contributed by Skip Montanaro; :issue:`1158`.)
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001562
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001563* The :mod:`decimal` module was updated to version 1.66 of
1564 `the General Decimal Specification <http://www2.hursley.ibm.com/decimal/decarith.html>`__. New features
1565 include some methods for some basic mathematical functions such as
1566 :meth:`exp` and :meth:`log10`::
1567
1568 >>> Decimal(1).exp()
1569 Decimal("2.718281828459045235360287471")
1570 >>> Decimal("2.7182818").ln()
1571 Decimal("0.9999999895305022877376682436")
1572 >>> Decimal(1000).log10()
1573 Decimal("3")
1574
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001575 The :meth:`as_tuple` method of :class:`Decimal` objects now returns a
1576 named tuple with :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
1577
1578 (Implemented by Facundo Batista and Mark Dickinson. Named tuple
1579 support added by Raymond Hettinger.)
1580
1581* The :mod:`difflib` module's :class:`SequenceMatcher` class
1582 now returns named tuples representing matches.
1583 In addition to behaving like tuples, the returned values
1584 also have :attr:`a`, :attr:`b`, and :attr:`size` attributes.
1585 (Contributed by Raymond Hettinger.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001586
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001587* An optional ``timeout`` parameter was added to the
1588 :class:`ftplib.FTP` class constructor as well as the :meth:`connect`
1589 method, specifying a timeout measured in seconds. (Added by Facundo
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001590 Batista.) Also, the :class:`FTP` class's
1591 :meth:`storbinary` and :meth:`storlines`
1592 now take an optional *callback* parameter that will be called with
1593 each block of data after the data has been sent.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001594 (Contributed by Phil Schwartz; :issue:`1221598`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001595
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001596* The :func:`reduce` built-in function is also available in the
1597 :mod:`functools` module. In Python 3.0, the built-in is dropped and it's
1598 only available from :mod:`functools`; currently there are no plans
1599 to drop the built-in in the 2.x series. (Patched by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001600 Christian Heimes; :issue:`1739906`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001601
Georg Brandl8ec7f652007-08-15 14:28:01 +00001602* The :func:`glob.glob` function can now return Unicode filenames if
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001603 a Unicode path was used and Unicode filenames are matched within the
1604 directory. (:issue:`1001604`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001605
1606* The :mod:`gopherlib` module has been removed.
1607
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001608* A new function in the :mod:`heapq` module: ``merge(iter1, iter2, ...)``
1609 takes any number of iterables that return data *in sorted
1610 order*, and returns a new iterator that returns the contents of all
1611 the iterators, also in sorted order. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001612
1613 heapq.merge([1, 3, 5, 9], [2, 8, 16]) ->
1614 [1, 2, 3, 5, 8, 9, 16]
1615
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001616 Another new function, ``heappushpop(heap, item)``,
1617 pushes *item* onto *heap*, then pops off and returns the smallest item.
1618 This is more efficient than making a call to :func:`heappush` and then
1619 :func:`heappop`.
1620
Georg Brandl8ec7f652007-08-15 14:28:01 +00001621 (Contributed by Raymond Hettinger.)
1622
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001623* An optional ``timeout`` parameter was added to the
1624 :class:`httplib.HTTPConnection` and :class:`HTTPSConnection`
1625 class constructors, specifying a timeout measured in seconds.
1626 (Added by Facundo Batista.)
1627
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001628* Most of the :mod:`inspect` module's functions, such as
1629 :func:`getmoduleinfo` and :func:`getargs`, now return named tuples.
1630 In addition to behaving like tuples, the elements of the return value
1631 can also be accessed as attributes.
1632 (Contributed by Raymond Hettinger.)
1633
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001634 Some new functions in the module include
1635 :func:`isgenerator`, :func:`isgeneratorfunction`,
1636 and :func:`isabstract`.
1637
1638* The :mod:`itertools` module gained several new functions.
1639
1640 ``izip_longest(iter1, iter2, ...[, fillvalue])`` makes tuples from
1641 each of the elements; if some of the iterables are shorter than
1642 others, the missing values are set to *fillvalue*. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001643
1644 itertools.izip_longest([1,2,3], [1,2,3,4,5]) ->
1645 [(1, 1), (2, 2), (3, 3), (None, 4), (None, 5)]
1646
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001647 ``product(iter1, iter2, ..., [repeat=N])`` returns the Cartesian product
1648 of the supplied iterables, a set of tuples containing
1649 every possible combination of the elements returned from each iterable. ::
1650
1651 itertools.product([1,2,3], [4,5,6]) ->
1652 [(1, 4), (1, 5), (1, 6),
1653 (2, 4), (2, 5), (2, 6),
1654 (3, 4), (3, 5), (3, 6)]
1655
1656 The optional *repeat* keyword argument is used for taking the
1657 product of an iterable or a set of iterables with themselves,
1658 repeated *N* times. With a single iterable argument, *N*-tuples
1659 are returned::
1660
1661 itertools.product([1,2], repeat=3)) ->
1662 [(1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
1663 (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)]
1664
1665 With two iterables, *2N*-tuples are returned. ::
1666
1667 itertools(product([1,2], [3,4], repeat=2) ->
1668 [(1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
1669 (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
1670 (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
1671 (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)]
1672
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001673 ``combinations(iterable, r)`` returns sub-sequences of length *r* from
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001674 the elements of *iterable*. ::
1675
1676 itertools.combinations('123', 2) ->
1677 [('1', '2'), ('1', '3'), ('2', '3')]
1678
1679 itertools.combinations('123', 3) ->
1680 [('1', '2', '3')]
1681
1682 itertools.combinations('1234', 3) ->
1683 [('1', '2', '3'), ('1', '2', '4'), ('1', '3', '4'),
1684 ('2', '3', '4')]
1685
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001686 ``permutations(iter[, r])`` returns all the permutations of length *r* of
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001687 the iterable's elements. If *r* is not specified, it will default to the
1688 number of elements produced by the iterable.
1689
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001690 itertools.permutations([1,2,3,4], 2) ->
1691 [(1, 2), (1, 3), (1, 4),
1692 (2, 1), (2, 3), (2, 4),
1693 (3, 1), (3, 2), (3, 4),
1694 (4, 1), (4, 2), (4, 3)]
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001695
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001696 ``itertools.chain(*iterables)`` is an existing function in
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001697 :mod:`itertools` that gained a new constructor in Python 2.6.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001698 ``itertools.chain.from_iterable(iterable)`` takes a single
1699 iterable that should return other iterables. :func:`chain` will
1700 then return all the elements of the first iterable, then
1701 all the elements of the second, and so on. ::
1702
1703 chain.from_iterable([[1,2,3], [4,5,6]]) ->
1704 [1, 2, 3, 4, 5, 6]
1705
1706 (All contributed by Raymond Hettinger.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001707
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001708* The :mod:`logging` module's :class:`FileHandler` class
1709 and its subclasses :class:`WatchedFileHandler`, :class:`RotatingFileHandler`,
1710 and :class:`TimedRotatingFileHandler` now
1711 have an optional *delay* parameter to its constructor. If *delay*
1712 is true, opening of the log file is deferred until the first
1713 :meth:`emit` call is made. (Contributed by Vinay Sajip.)
1714
Georg Brandl8ec7f652007-08-15 14:28:01 +00001715* The :mod:`macfs` module has been removed. This in turn required the
1716 :func:`macostools.touched` function to be removed because it depended on the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001717 :mod:`macfs` module. (:issue:`1490190`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001718
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001719* :class:`mmap` objects now have a :meth:`rfind` method that finds
1720 a substring, beginning at the end of the string and searching
1721 backwards. The :meth:`find` method
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001722 also gained an *end* parameter containing the index at which to stop
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00001723 the forward search.
1724 (Contributed by John Lenton.)
1725
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001726* (3.0-warning mode) The :mod:`new` module has been removed from
1727 Python 3.0. Importing it therefore triggers a warning message.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001728
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001729* The :mod:`operator` module gained a
1730 :func:`methodcaller` function that takes a name and an optional
1731 set of arguments, returning a callable that will call
1732 the named function on any arguments passed to it. For example::
1733
1734 >>> # Equivalent to lambda s: s.replace('old', 'new')
1735 >>> replacer = operator.methodcaller('replace', 'old', 'new')
1736 >>> replacer('old wine in old bottles')
1737 'new wine in new bottles'
1738
Georg Brandl27504da2008-03-04 07:25:54 +00001739 (Contributed by Georg Brandl, after a suggestion by Gregory Petrosyan.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001740
1741 The :func:`attrgetter` function now accepts dotted names and performs
1742 the corresponding attribute lookups::
1743
1744 >>> inst_name = operator.attrgetter('__class__.__name__')
1745 >>> inst_name('')
1746 'str'
1747 >>> inst_name(help)
1748 '_Helper'
1749
Georg Brandl27504da2008-03-04 07:25:54 +00001750 (Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001751
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001752* New functions in the :mod:`os` module include
1753 ``fchmod(fd, mode)``, ``fchown(fd, uid, gid)``,
1754 and ``lchmod(path, mode)``, on operating systems that support these
1755 functions. :func:`fchmod` and :func:`fchown` let you change the mode
1756 and ownership of an opened file, and :func:`lchmod` changes the mode
1757 of a symlink.
1758
1759 (Contributed by Georg Brandl and Christian Heimes.)
1760
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001761* The :func:`os.walk` function now has a ``followlinks`` parameter. If
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001762 set to True, it will follow symlinks pointing to directories and
1763 visit the directory's contents. For backward compatibility, the
1764 parameter's default value is false. Note that the function can fall
1765 into an infinite recursion if there's a symlink that points to a
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001766 parent directory. (:issue:`1273829`)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001767
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001768* The ``os.environ`` object's :meth:`clear` method will now unset the
1769 environment variables using :func:`os.unsetenv` in addition to clearing
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001770 the object's keys. (Contributed by Martin Horcicka; :issue:`1181`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001771
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001772* In the :mod:`os.path` module, the :func:`splitext` function
1773 has been changed to not split on leading period characters.
1774 This produces better results when operating on Unix's dot-files.
1775 For example, ``os.path.splitext('.ipython')``
1776 now returns ``('.ipython', '')`` instead of ``('', '.ipython')``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001777 (:issue:`115886`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001778
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001779 A new function, :func:`relpath(path, start)` returns a relative path
1780 from the ``start`` path, if it's supplied, or from the current
1781 working directory to the destination ``path``. (Contributed by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001782 Richard Barran; :issue:`1339796`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001783
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001784 On Windows, :func:`os.path.expandvars` will now expand environment variables
1785 in the form "%var%", and "~user" will be expanded into the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001786 user's home directory path. (Contributed by Josiah Carlson;
1787 :issue:`957650`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001788
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001789* The Python debugger provided by the :mod:`pdb` module
1790 gained a new command: "run" restarts the Python program being debugged,
1791 and can optionally take new command-line arguments for the program.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001792 (Contributed by Rocky Bernstein; :issue:`1393667`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001793
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001794 The :func:`post_mortem` function, used to enter debugging of a
1795 traceback, will now use the traceback returned by :func:`sys.exc_info`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001796 if no traceback is supplied. (Contributed by Facundo Batista;
1797 :issue:`1106316`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001798
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001799* The :mod:`pickletools` module now has an :func:`optimize` function
1800 that takes a string containing a pickle and removes some unused
1801 opcodes, returning a shorter pickle that contains the same data structure.
1802 (Contributed by Raymond Hettinger.)
1803
Georg Brandl8ec7f652007-08-15 14:28:01 +00001804* New functions in the :mod:`posix` module: :func:`chflags` and :func:`lchflags`
1805 are wrappers for the corresponding system calls (where they're available).
1806 Constants for the flag values are defined in the :mod:`stat` module; some
1807 possible values include :const:`UF_IMMUTABLE` to signal the file may not be
1808 changed and :const:`UF_APPEND` to indicate that data can only be appended to the
1809 file. (Contributed by M. Levinson.)
1810
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001811 ``os.closerange(*low*, *high*)`` efficiently closes all file descriptors
1812 from *low* to *high*, ignoring any errors and not including *high* itself.
1813 This function is now used by the :mod:`subprocess` module to make starting
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001814 processes faster. (Contributed by Georg Brandl; :issue:`1663329`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001815
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00001816* The :mod:`pyexpat` module's :class:`Parser` objects now allow setting
1817 their :attr:`buffer_size` attribute to change the size of the buffer
1818 used to hold character data.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001819 (Contributed by Achim Gaedke; :issue:`1137`.)
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00001820
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00001821* The :mod:`Queue` module now provides queue classes that retrieve entries
1822 in different orders. The :class:`PriorityQueue` class stores
1823 queued items in a heap and retrieves them in priority order,
1824 and :class:`LifoQueue` retrieves the most recently added entries first,
1825 meaning that it behaves like a stack.
1826 (Contributed by Raymond Hettinger.)
1827
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001828* The :mod:`random` module's :class:`Random` objects can
1829 now be pickled on a 32-bit system and unpickled on a 64-bit
1830 system, and vice versa. Unfortunately, this change also means
1831 that Python 2.6's :class:`Random` objects can't be unpickled correctly
1832 on earlier versions of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001833 (Contributed by Shawn Ligocki; :issue:`1727780`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001834
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001835 The new ``triangular(low, high, mode)`` function returns random
1836 numbers following a triangular distribution. The returned values
1837 are between *low* and *high*, not including *high* itself, and
1838 with *mode* as the mode, the most frequently occurring value
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001839 in the distribution. (Contributed by Wladmir van der Laan and
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001840 Raymond Hettinger; :issue:`1681432`.)
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001841
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001842* Long regular expression searches carried out by the :mod:`re`
1843 module will now check for signals being delivered, so especially
1844 long searches can now be interrupted.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001845 (Contributed by Josh Hoyt and Ralf Schmitt; :issue:`846388`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001846
Georg Brandl8ec7f652007-08-15 14:28:01 +00001847* The :mod:`rgbimg` module has been removed.
1848
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001849* The :mod:`sched` module's :class:`scheduler` instances now
1850 have a read-only :attr:`queue` attribute that returns the
1851 contents of the scheduler's queue, represented as a list of
Georg Brandl225163d2008-03-05 07:10:35 +00001852 named tuples with the fields ``(time, priority, action, argument)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001853 (Contributed by Raymond Hettinger; :issue:`1861`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001854
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001855* The :mod:`select` module now has wrapper functions
1856 for the Linux :cfunc:`epoll` and BSD :cfunc:`kqueue` system calls.
1857 Also, a :meth:`modify` method was added to the existing :class:`poll`
1858 objects; ``pollobj.modify(fd, eventmask)`` takes a file descriptor
1859 or file object and an event mask,
1860
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001861 (Contributed by Christian Heimes; :issue:`1657`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001862
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00001863* The :mod:`sets` module has been deprecated; it's better to
1864 use the built-in :class:`set` and :class:`frozenset` types.
1865
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00001866* Integrating signal handling with GUI handling event loops
1867 like those used by Tkinter or GTk+ has long been a problem; most
Georg Brandle1b8e9c2008-02-20 19:12:36 +00001868 software ends up polling, waking up every fraction of a second.
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00001869 The :mod:`signal` module can now make this more efficient.
1870 Calling ``signal.set_wakeup_fd(fd)`` sets a file descriptor
1871 to be used; when a signal is received, a byte is written to that
1872 file descriptor. There's also a C-level function,
1873 :cfunc:`PySignal_SetWakeupFd`, for setting the descriptor.
1874
1875 Event loops will use this by opening a pipe to create two descriptors,
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001876 one for reading and one for writing. The writable descriptor
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00001877 will be passed to :func:`set_wakeup_fd`, and the readable descriptor
1878 will be added to the list of descriptors monitored by the event loop via
1879 :cfunc:`select` or :cfunc:`poll`.
1880 On receiving a signal, a byte will be written and the main event loop
1881 will be woken up, without the need to poll.
1882
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001883 (Contributed by Adam Olsen; :issue:`1583`.)
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00001884
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001885 The :func:`siginterrupt` function is now available from Python code,
1886 and allows changing whether signals can interrupt system calls or not.
1887 (Contributed by Ralf Schmitt.)
1888
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001889 The :func:`setitimer` and :func:`getitimer` functions have also been
1890 added on systems that support these system calls. :func:`setitimer`
1891 allows setting interval timers that will cause a signal to be
1892 delivered to the process after a specified time, measured in
1893 wall-clock time, consumed process time, or combined process+system
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001894 time. (Contributed by Guilherme Polo; :issue:`2240`.)
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001895
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001896* The :mod:`smtplib` module now supports SMTP over SSL thanks to the
1897 addition of the :class:`SMTP_SSL` class. This class supports an
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001898 interface identical to the existing :class:`SMTP` class. Both
1899 class constructors also have an optional ``timeout`` parameter
1900 that specifies a timeout for the initial connection attempt, measured in
1901 seconds.
1902
1903 An implementation of the LMTP protocol (:rfc:`2033`) was also added to
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001904 the module. LMTP is used in place of SMTP when transferring e-mail
1905 between agents that don't manage a mail queue.
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001906
1907 (SMTP over SSL contributed by Monty Taylor; timeout parameter
1908 added by Facundo Batista; LMTP implemented by Leif
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001909 Hedstrom; :issue:`957003`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001910
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00001911* In the :mod:`smtplib` module, SMTP.starttls() now complies with :rfc:`3207`
1912 and forgets any knowledge obtained from the server not obtained from
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001913 the TLS negotiation itself. (Patch contributed by Bill Fenner;
1914 :issue:`829951`.)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00001915
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001916* The :mod:`socket` module now supports TIPC (http://tipc.sf.net),
1917 a high-performance non-IP-based protocol designed for use in clustered
1918 environments. TIPC addresses are 4- or 5-tuples.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001919 (Contributed by Alberto Bertogli; :issue:`1646`.)
Andrew M. Kuchlingf60b6412008-01-19 16:34:09 +00001920
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00001921 A new function, :func:`create_connection`, takes an address
1922 and connects to it using an optional timeout value, returning
1923 the connected socket object.
1924
Andrew M. Kuchlingf60b6412008-01-19 16:34:09 +00001925* The base classes in the :mod:`SocketServer` module now support
1926 calling a :meth:`handle_timeout` method after a span of inactivity
1927 specified by the server's :attr:`timeout` attribute. (Contributed
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00001928 by Michael Pomraning.) The :meth:`serve_forever` method
1929 now takes an optional poll interval measured in seconds,
1930 controlling how often the server will check for a shutdown request.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001931 (Contributed by Pedro Werneck and Jeffrey Yasskin;
1932 :issue:`742598`, :issue:`1193577`.)
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00001933
1934* The :mod:`struct` module now supports the C99 :ctype:`_Bool` type,
1935 using the format character ``'?'``.
1936 (Contributed by David Remahl.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001937
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001938* A new variable in the :mod:`sys` module,
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00001939 :attr:`float_info`, is an object
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001940 containing information about the platform's floating-point support
Andrew M. Kuchling5d8b3792008-01-14 14:48:43 +00001941 derived from the :file:`float.h` file. Attributes of this object
1942 include
1943 :attr:`mant_dig` (number of digits in the mantissa), :attr:`epsilon`
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001944 (smallest difference between 1.0 and the next largest value
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001945 representable), and several others. (Contributed by Christian Heimes;
1946 :issue:`1534`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001947
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00001948 Another new variable, :attr:`dont_write_bytecode`, controls whether Python
1949 writes any :file:`.pyc` or :file:`.pyo` files on importing a module.
1950 If this variable is true, the compiled files are not written. The
1951 variable is initially set on start-up by supplying the :option:`-B`
1952 switch to the Python interpreter, or by setting the
1953 :envvar:`PYTHONDONTWRITEBYTECODE` environment variable before
1954 running the interpreter. Python code can subsequently
1955 change the value of this variable to control whether bytecode files
1956 are written or not.
1957 (Contributed by Neal Norwitz and Georg Brandl.)
1958
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001959 Information about the command-line arguments supplied to the Python
1960 interpreter are available as attributes of a ``sys.flags`` named
1961 tuple. For example, the :attr:`verbose` attribute is true if Python
1962 was executed in verbose mode, :attr:`debug` is true in debugging mode, etc.
1963 These attributes are all read-only.
1964 (Contributed by Christian Heimes.)
1965
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001966 It's now possible to determine the current profiler and tracer functions
1967 by calling :func:`sys.getprofile` and :func:`sys.gettrace`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001968 (Contributed by Georg Brandl; :issue:`1648`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001969
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00001970* The :mod:`tarfile` module now supports POSIX.1-2001 (pax) and
1971 POSIX.1-1988 (ustar) format tarfiles, in addition to the GNU tar
1972 format that was already supported. The default format
1973 is GNU tar; specify the ``format`` parameter to open a file
1974 using a different format::
1975
1976 tar = tarfile.open("output.tar", "w", format=tarfile.PAX_FORMAT)
1977
1978 The new ``errors`` parameter lets you specify an error handling
1979 scheme for character conversions: the three standard ways Python can
1980 handle errors ``'strict'``, ``'ignore'``, ``'replace'`` , or the
1981 special value ``'utf-8'``, which replaces bad characters with their
1982 UTF-8 representation. Character conversions occur because the PAX
1983 format supports Unicode filenames, defaulting to UTF-8 encoding.
1984
1985 The :meth:`TarFile.add` method now accepts a ``exclude`` argument that's
1986 a function that can be used to exclude certain filenames from
1987 an archive.
1988 The function must take a filename and return true if the file
1989 should be excluded or false if it should be archived.
1990 The function is applied to both the name initially passed to :meth:`add`
1991 and to the names of files in recursively-added directories.
1992
1993 (All changes contributed by Lars Gustäbel).
1994
1995* An optional ``timeout`` parameter was added to the
1996 :class:`telnetlib.Telnet` class constructor, specifying a timeout
1997 measured in seconds. (Added by Facundo Batista.)
1998
1999* The :class:`tempfile.NamedTemporaryFile` class usually deletes
2000 the temporary file it created when the file is closed. This
2001 behaviour can now be changed by passing ``delete=False`` to the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002002 constructor. (Contributed by Damien Miller; :issue:`1537850`.)
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002003
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002004 A new class, :class:`SpooledTemporaryFile`, behaves like
2005 a temporary file but stores its data in memory until a maximum size is
2006 exceeded. On reaching that limit, the contents will be written to
2007 an on-disk temporary file. (Contributed by Dustin J. Mitchell.)
2008
2009 The :class:`NamedTemporaryFile` and :class:`SpooledTemporaryFile` classes
2010 both work as context managers, so you can write
2011 ``with tempfile.NamedTemporaryFile() as tmp: ...``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002012 (Contributed by Alexander Belopolsky; :issue:`2021`.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002013
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002014* The :mod:`test.test_support` module now contains a
2015 :func:`EnvironmentVarGuard`
2016 context manager that supports temporarily changing environment variables and
2017 automatically restores them to their old values.
2018
2019 Another context manager, :class:`TransientResource`, can surround calls
2020 to resources that may or may not be available; it will catch and
2021 ignore a specified list of exceptions. For example,
2022 a network test may ignore certain failures when connecting to an
2023 external web site::
2024
2025 with test_support.TransientResource(IOError, errno=errno.ETIMEDOUT):
2026 f = urllib.urlopen('https://sf.net')
2027 ...
2028
2029 (Contributed by Brett Cannon.)
2030
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002031* The :mod:`textwrap` module can now preserve existing whitespace
2032 at the beginnings and ends of the newly-created lines
2033 by specifying ``drop_whitespace=False``
2034 as an argument::
2035
2036 >>> S = """This sentence has a bunch of extra whitespace."""
2037 >>> print textwrap.fill(S, width=15)
2038 This sentence
2039 has a bunch
2040 of extra
2041 whitespace.
2042 >>> print textwrap.fill(S, drop_whitespace=False, width=15)
2043 This sentence
2044 has a bunch
2045 of extra
2046 whitespace.
2047 >>>
2048
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002049 (Contributed by Dwayne Bailey; :issue:`1581073`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002050
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002051* The :mod:`timeit` module now accepts callables as well as strings
2052 for the statement being timed and for the setup code.
2053 Two convenience functions were added for creating
2054 :class:`Timer` instances:
2055 ``repeat(stmt, setup, time, repeat, number)`` and
2056 ``timeit(stmt, setup, time, number)`` create an instance and call
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002057 the corresponding method. (Contributed by Erik Demaine;
2058 :issue:`1533909`.)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002059
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002060* An optional ``timeout`` parameter was added to the
2061 :func:`urllib.urlopen` function and the
2062 :class:`urllib.ftpwrapper` class constructor, as well as the
2063 :func:`urllib2.urlopen` function. The parameter specifies a timeout
2064 measured in seconds. For example::
2065
2066 >>> u = urllib2.urlopen("http://slow.example.com", timeout=3)
2067 Traceback (most recent call last):
2068 ...
2069 urllib2.URLError: <urlopen error timed out>
2070 >>>
2071
2072 (Added by Facundo Batista.)
2073
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002074* The XML-RPC classes :class:`SimpleXMLRPCServer` and :class:`DocXMLRPCServer`
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002075 classes can now be prevented from immediately opening and binding to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002076 their socket by passing True as the ``bind_and_activate``
2077 constructor parameter. This can be used to modify the instance's
2078 :attr:`allow_reuse_address` attribute before calling the
2079 :meth:`server_bind` and :meth:`server_activate` methods to
2080 open the socket and begin listening for connections.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002081 (Contributed by Peter Parente; :issue:`1599845`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002082
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002083 :class:`SimpleXMLRPCServer` also has a :attr:`_send_traceback_header`
2084 attribute; if true, the exception and formatted traceback are returned
2085 as HTTP headers "X-Exception" and "X-Traceback". This feature is
2086 for debugging purposes only and should not be used on production servers
2087 because the tracebacks could possibly reveal passwords or other sensitive
2088 information. (Contributed by Alan McIntyre as part of his
2089 project for Google's Summer of Code 2007.)
2090
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002091* The :mod:`zipfile` module's :class:`ZipFile` class now has
2092 :meth:`extract` and :meth:`extractall` methods that will unpack
2093 a single file or all the files in the archive to the current directory, or
2094 to a specified directory::
2095
2096 z = zipfile.ZipFile('python-251.zip')
2097
2098 # Unpack a single file, writing it relative to the /tmp directory.
2099 z.extract('Python/sysmodule.c', '/tmp')
2100
2101 # Unpack all the files in the archive.
2102 z.extractall()
2103
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002104 (Contributed by Alan McIntyre; :issue:`467924`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002105
Georg Brandlb19be572007-12-29 10:57:00 +00002106.. ======================================================================
2107.. whole new modules get described in subsections here
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002108
2109Improved SSL Support
Andrew M. Kuchling27a44982007-10-20 19:39:35 +00002110--------------------------------------------------
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002111
2112Bill Janssen made extensive improvements to Python 2.6's support for
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002113the Secure Sockets Layer by adding a new module, :mod:`ssl`, on top of
2114the `OpenSSL <http://www.openssl.org/>`__ library. This new module
2115provides more control over the protocol negotiated, the X.509
2116certificates used, and has better support for writing SSL servers (as
2117opposed to clients) in Python. The existing SSL support in the
2118:mod:`socket` module hasn't been removed and continues to work,
2119though it will be removed in Python 3.0.
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002120
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002121To use the new module, first you must create a TCP connection in the
2122usual way and then pass it to the :func:`ssl.wrap_socket` function.
2123XXX describe parameters.
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002124
2125XXX Can specify if certificate is required, and obtain certificate info
2126by calling getpeercert method.
2127
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002128XXX Certain features require the OpenSSL package to be installed, notably
2129 the 'openssl' binary.
2130
2131.. seealso::
2132
2133 SSL module documentation.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002134
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002135
2136.. ======================================================================
2137
2138plistlib: A Property-List Parser
2139--------------------------------------------------
2140
2141A commonly-used format on MacOS X is the ``.plist`` format,
2142which stores basic data types (numbers, strings, lists,
2143and dictionaries) and serializes them into an XML-based format.
2144(It's a lot like the XML-RPC serialization of data types.)
2145
2146Despite being primarily used on MacOS X, the format
2147has nothing Mac-specific about it and the Python implementation works
2148on any platform that Python supports, so the :mod:`plistlib` module
2149has been promoted to the standard library.
2150
2151Using the module is simple::
2152
2153 import sys
2154 import plistlib
2155 import datetime
2156
2157 # Create data structure
2158 data_struct = dict(lastAccessed=datetime.datetime.now(),
2159 version=1,
2160 categories=('Personal', 'Shared', 'Private'))
2161
2162 # Create string containing XML.
2163 plist_str = plistlib.writePlistToString(data_struct)
2164 new_struct = plistlib.readPlistFromString(plist_str)
2165 print data_struct
2166 print new_struct
2167
2168 # Write data structure to a file and read it back.
2169 plistlib.writePlist(data_struct, '/tmp/customizations.plist')
2170 new_struct = plistlib.readPlist('/tmp/customizations.plist')
2171
2172 # read/writePlist accepts file-like objects as well as paths.
2173 plistlib.writePlist(data_struct, sys.stdout)
2174
2175
Georg Brandlb19be572007-12-29 10:57:00 +00002176.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002177
2178
2179Build and C API Changes
2180=======================
2181
2182Changes to Python's build process and to the C API include:
2183
Andrew M. Kuchlingf7b462f2007-11-23 13:37:39 +00002184* Python 2.6 can be built with Microsoft Visual Studio 2008.
2185 See the :file:`PCbuild9` directory for the build files.
2186 (Implemented by Christian Heimes.)
2187
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002188* Python now can only be compiled with C89 compilers (after 19
2189 years!). This means that the Python source tree can now drop its
2190 own implementations of :cfunc:`memmove` and :cfunc:`strerror`, which
2191 are in the C89 standard library.
2192
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002193* The BerkeleyDB module now has a C API object, available as
2194 ``bsddb.db.api``. This object can be used by other C extensions
2195 that wish to use the :mod:`bsddb` module for their own purposes.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002196 (Contributed by Duncan Grisby; :issue:`1551895`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002197
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002198* The new buffer interface, previously described in
2199 `the PEP 3118 section <#pep-3118-revised-buffer-protocol>`__,
2200 adds :cfunc:`PyObject_GetBuffer` and :cfunc:`PyObject_ReleaseBuffer`,
2201 as well as a few other functions.
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002202
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002203* Python's use of the C stdio library is now thread-safe, or at least
2204 as thread-safe as the underlying library is. A long-standing potential
2205 bug occurred if one thread closed a file object while another thread
2206 was reading from or writing to the object. In 2.6 file objects
2207 have a reference count, manipulated by the
2208 :cfunc:`PyFile_IncUseCount` and :cfunc:`PyFile_DecUseCount`
2209 functions. File objects can't be closed unless the reference count
2210 is zero. :cfunc:`PyFile_IncUseCount` should be called while the GIL
2211 is still held, before carrying out an I/O operation using the
2212 ``FILE *`` pointer, and :cfunc:`PyFile_DecUseCount` should be called
2213 immediately after the GIL is re-acquired.
2214 (Contributed by Antoine Pitrou and Gregory P. Smith.)
2215
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002216* Importing modules simultaneously in two different threads no longer
2217 deadlocks; it will now raise an :exc:`ImportError`. A new API
2218 function, :cfunc:`PyImport_ImportModuleNoBlock`, will look for a
2219 module in ``sys.modules`` first, then try to import it after
2220 acquiring an import lock. If the import lock is held by another
2221 thread, the :exc:`ImportError` is raised.
2222 (Contributed by Christian Heimes.)
2223
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002224* Several functions return information about the platform's
2225 floating-point support. :cfunc:`PyFloat_GetMax` returns
2226 the maximum representable floating point value,
2227 and :cfunc:`PyFloat_GetMin` returns the minimum
2228 positive value. :cfunc:`PyFloat_GetInfo` returns a dictionary
2229 containing more information from the :file:`float.h` file, such as
2230 ``"mant_dig"`` (number of digits in the mantissa), ``"epsilon"``
2231 (smallest difference between 1.0 and the next largest value
2232 representable), and several others.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002233 (Contributed by Christian Heimes; :issue:`1534`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002234
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002235* Python's C API now includes two functions for case-insensitive string
Georg Brandl907a7202008-02-22 12:31:45 +00002236 comparisons, ``PyOS_stricmp(char*, char*)``
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002237 and ``PyOS_strnicmp(char*, char*, Py_ssize_t)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002238 (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002239
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002240* Many C extensions define their own little macro for adding
2241 integers and strings to the module's dictionary in the
2242 ``init*`` function. Python 2.6 finally defines standard macros
2243 for adding values to a module, :cmacro:`PyModule_AddStringMacro`
2244 and :cmacro:`PyModule_AddIntMacro()`. (Contributed by
2245 Christian Heimes.)
2246
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002247* Some macros were renamed in both 3.0 and 2.6 to make it clearer that
2248 they are macros,
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00002249 not functions. :cmacro:`Py_Size()` became :cmacro:`Py_SIZE()`,
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002250 :cmacro:`Py_Type()` became :cmacro:`Py_TYPE()`, and
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002251 :cmacro:`Py_Refcnt()` became :cmacro:`Py_REFCNT()`.
2252 The mixed-case macros are still available
2253 in Python 2.6 for backward compatibility.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002254 (:issue:`1629`)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002255
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002256* Distutils now places C extensions it builds in a
2257 different directory when running on a debug version of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002258 (Contributed by Collin Winter; :issue:`1530959`.)
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002259
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002260* Several basic data types, such as integers and strings, maintain
2261 internal free lists of objects that can be re-used. The data
2262 structures for these free lists now follow a naming convention: the
2263 variable is always named ``free_list``, the counter is always named
2264 ``numfree``, and a macro :cmacro:`Py<typename>_MAXFREELIST` is
2265 always defined.
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002266
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002267* A new Makefile target, "make check", prepares the Python source tree
2268 for making a patch: it fixes trailing whitespace in all modified
2269 ``.py`` files, checks whether the documentation has been changed,
2270 and reports whether the :file:`Misc/ACKS` and :file:`Misc/NEWS` files
2271 have been updated.
2272 (Contributed by Brett Cannon.)
2273
Georg Brandlb19be572007-12-29 10:57:00 +00002274.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002275
2276
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002277Port-Specific Changes: Windows
2278-----------------------------------
2279
2280* The :mod:`msvcrt` module now supports
2281 both the normal and wide char variants of the console I/O
2282 API. The :func:`getwch` function reads a keypress and returns a Unicode
2283 value, as does the :func:`getwche` function. The :func:`putwch` function
2284 takes a Unicode character and writes it to the console.
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002285 (Contributed by Christian Heimes.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002286
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00002287* :func:`os.path.expandvars` will now expand environment variables
2288 in the form "%var%", and "~user" will be expanded into the
2289 user's home directory path. (Contributed by Josiah Carlson.)
2290
2291* The :mod:`socket` module's socket objects now have an
2292 :meth:`ioctl` method that provides a limited interface to the
2293 :cfunc:`WSAIoctl` system interface.
2294
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002295* The :mod:`_winreg` module now has a function,
2296 :func:`ExpandEnvironmentStrings`,
2297 that expands environment variable references such as ``%NAME%``
2298 in an input string. The handle objects provided by this
2299 module now support the context protocol, so they can be used
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002300 in :keyword:`with` statements. (Contributed by Christian Heimes.)
2301
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002302 :mod:`_winreg` also has better support for x64 systems,
2303 exposing the :func:`DisableReflectionKey`, :func:`EnableReflectionKey`,
2304 and :func:`QueryReflectionKey` functions, which enable and disable
2305 registry reflection for 32-bit processes running on 64-bit systems.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002306 (:issue:`1753245`)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002307
Christian Heimesff6cc6b2008-01-17 23:01:44 +00002308* The new default compiler on Windows is Visual Studio 2008 (VS 9.0). The
2309 build directories for Visual Studio 2003 (VS7.1) and 2005 (VS8.0)
2310 were moved into the PC/ directory. The new PCbuild directory supports
2311 cross compilation for X64, debug builds and Profile Guided Optimization
2312 (PGO). PGO builds are roughly 10% faster than normal builds.
2313 (Contributed by Christian Heimes with help from Amaury Forgeot d'Arc and
2314 Martin von Loewis.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002315
Georg Brandlb19be572007-12-29 10:57:00 +00002316.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002317
2318
2319.. _section-other:
2320
2321Other Changes and Fixes
2322=======================
2323
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002324As usual, there were a bunch of other improvements and bugfixes
2325scattered throughout the source tree. A search through the change
2326logs finds there were XXX patches applied and YYY bugs fixed between
2327Python 2.5 and 2.6. Both figures are likely to be underestimates.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002328
2329Some of the more notable changes are:
2330
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002331* It's now possible to prevent Python from writing any :file:`.pyc`
2332 or :file:`.pyo` files by either supplying the :option:`-B` switch
2333 or setting the :envvar:`PYTHONDONTWRITEBYTECODE` environment variable
2334 to any non-empty string when running the Python interpreter. These
Georg Brandlca9c6e42008-01-15 06:58:15 +00002335 are also used to set the :data:`sys.dont_write_bytecode` attribute;
2336 Python code can change this variable to control whether bytecode
2337 files are subsequently written.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002338 (Contributed by Neal Norwitz and Georg Brandl.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002339
Georg Brandlb19be572007-12-29 10:57:00 +00002340.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002341
2342
2343Porting to Python 2.6
2344=====================
2345
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002346This section lists previously described changes and other bugfixes
2347that may require changes to your code:
Georg Brandl8ec7f652007-08-15 14:28:01 +00002348
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00002349* The :meth:`__init__` method of :class:`collections.deque`
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002350 now clears any existing contents of the deque
2351 before adding elements from the iterable. This change makes the
2352 behavior match that of ``list.__init__()``.
2353
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002354* The :class:`Decimal` constructor now accepts leading and trailing
2355 whitespace when passed a string. Previously it would raise an
2356 :exc:`InvalidOperation` exception. On the other hand, the
2357 :meth:`create_decimal` method of :class:`Context` objects now
2358 explicitly disallows extra whitespace, raising a
2359 :exc:`ConversionSyntax` exception.
2360
2361* Due to an implementation accident, if you passed a file path to
2362 the built-in :func:`__import__` function, it would actually import
2363 the specified file. This was never intended to work, however, and
2364 the implementation now explicitly checks for this case and raises
2365 an :exc:`ImportError`.
2366
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002367* C API: the :cfunc:`PyImport_Import` and :cfunc:`PyImport_ImportModule`
2368 functions now default to absolute imports, not relative imports.
2369 This will affect C extensions that import other modules.
2370
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002371* The :mod:`socket` module exception :exc:`socket.error` now inherits
2372 from :exc:`IOError`. Previously it wasn't a subclass of
2373 :exc:`StandardError` but now it is, through :exc:`IOError`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002374 (Implemented by Gregory P. Smith; :issue:`1706815`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002375
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002376* The :mod:`xmlrpclib` module no longer automatically converts
2377 :class:`datetime.date` and :class:`datetime.time` to the
2378 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2379 not necessarily correct for all applications. Code using
2380 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002381 instances. (:issue:`1330538`)
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00002382
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002383* (3.0-warning mode) The :class:`Exception` class now warns
2384 when accessed using slicing or index access; having
2385 :class:`Exception` behave like a tuple is being phased out.
2386
2387* (3.0-warning mode) inequality comparisons between two dictionaries
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002388 or two objects that don't implement comparison methods are reported
2389 as warnings. ``dict1 == dict2`` still works, but ``dict1 < dict2``
2390 is being phased out.
2391
2392 Comparisons between cells, which are an implementation detail of Python's
2393 scoping rules, also cause warnings because such comparisons are forbidden
2394 entirely in 3.0.
2395
Georg Brandlb19be572007-12-29 10:57:00 +00002396.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002397
2398
2399.. _acks:
2400
2401Acknowledgements
2402================
2403
2404The author would like to thank the following people for offering suggestions,
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002405corrections and assistance with various drafts of this article:
2406Georg Brandl, Jim Jewett.
Georg Brandl8ec7f652007-08-15 14:28:01 +00002407