blob: 9410e2219cb1907087ab10a6489f47d52024c7ba [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +00001****************************
Georg Brandle152a772008-05-24 18:31:28 +00002 What's New in Python 2.6
Georg Brandl8ec7f652007-08-15 14:28:01 +00003****************************
4
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00005.. XXX add trademark info for Apple, Microsoft, SourceForge.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00006
Andrew M. Kuchling3e75d232008-09-02 13:08:11 +00007:Author: A.M. Kuchling (amk at amk.ca)
Georg Brandl8ec7f652007-08-15 14:28:01 +00008:Release: |release|
9:Date: |today|
10
Georg Brandlb19be572007-12-29 10:57:00 +000011.. $Id: whatsnew26.tex 55746 2007-06-02 18:33:53Z neal.norwitz $
12 Rules for maintenance:
Georg Brandle152a772008-05-24 18:31:28 +000013
Georg Brandlb19be572007-12-29 10:57:00 +000014 * Anyone can add text to this document. Do not spend very much time
15 on the wording of your changes, because your text will probably
16 get rewritten to some degree.
Georg Brandle152a772008-05-24 18:31:28 +000017
Georg Brandlb19be572007-12-29 10:57:00 +000018 * The maintainer will go through Misc/NEWS periodically and add
19 changes; it's therefore more important to add your changes to
20 Misc/NEWS than to this file.
Georg Brandle152a772008-05-24 18:31:28 +000021
Georg Brandlb19be572007-12-29 10:57:00 +000022 * This is not a complete list of every single change; completeness
23 is the purpose of Misc/NEWS. Some changes I consider too small
24 or esoteric to include. If such a change is added to the text,
25 I'll just remove it. (This is another reason you shouldn't spend
26 too much time on writing your addition.)
Georg Brandle152a772008-05-24 18:31:28 +000027
Georg Brandlb19be572007-12-29 10:57:00 +000028 * If you want to draw your new text to the attention of the
29 maintainer, add 'XXX' to the beginning of the paragraph or
30 section.
Georg Brandle152a772008-05-24 18:31:28 +000031
Georg Brandlb19be572007-12-29 10:57:00 +000032 * It's OK to just add a fragmentary note about a change. For
33 example: "XXX Describe the transmogrify() function added to the
34 socket module." The maintainer will research the change and
35 write the necessary text.
Georg Brandle152a772008-05-24 18:31:28 +000036
Georg Brandlb19be572007-12-29 10:57:00 +000037 * You can comment out your additions if you like, but it's not
38 necessary (especially when a final release is some months away).
Georg Brandle152a772008-05-24 18:31:28 +000039
Georg Brandlb19be572007-12-29 10:57:00 +000040 * Credit the author of a patch or bugfix. Just the name is
41 sufficient; the e-mail address isn't necessary.
Georg Brandle152a772008-05-24 18:31:28 +000042
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000043 * It's helpful to add the bug/patch number in a parenthetical comment.
Georg Brandle152a772008-05-24 18:31:28 +000044
Georg Brandlb19be572007-12-29 10:57:00 +000045 XXX Describe the transmogrify() function added to the socket
46 module.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +000047 (Contributed by P.Y. Developer; :issue:`12345`.)
Georg Brandle152a772008-05-24 18:31:28 +000048
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000049 This saves the maintainer some effort going through the SVN logs
Georg Brandlb19be572007-12-29 10:57:00 +000050 when researching a change.
Georg Brandl8ec7f652007-08-15 14:28:01 +000051
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000052This article explains the new features in Python 2.6. The release
53schedule is described in :pep:`361`; currently the final release is
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +000054scheduled for October 1 2008.
Georg Brandl8ec7f652007-08-15 14:28:01 +000055
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +000056The major theme of Python 2.6 is preparing the migration path to
57Python 3.0, a major redesign of the language. Whenever possible,
58Python 2.6 incorporates new features and syntax from 3.0 while
59remaining compatible with existing code by not removing older features
60or syntax. When it's not possible to do that, Python 2.6 tries to do
61what it can, adding compatibility functions in a
62:mod:`future_builtins` module and a :option:`-3` switch to warn about
63usages that will become unsupported in 3.0.
64
65Some significant new packages have been added to the standard library,
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +000066such as the :mod:`multiprocessing` and :mod:`json` modules, but
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +000067there aren't many new features that aren't related to Python 3.0 in
68some way.
69
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +000070Python 2.6 also sees a number of improvements and bugfixes throughout
Andrew M. Kuchling51eb7a92008-08-31 15:48:44 +000071the source. A search through the change logs finds there were 259
72patches applied and 612 bugs fixed between Python 2.5 and 2.6. Both
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +000073figures are likely to be underestimates.
74
Andrew M. Kuchling17f84292008-04-10 21:29:01 +000075This article doesn't attempt to provide a complete specification of
76the new features, but instead provides a convenient overview. For
77full details, you should refer to the documentation for Python 2.6. If
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +000078you want to understand the rationale for the design and
79implementation, refer to the PEP for a particular new feature.
80Whenever possible, "What's New in Python" links to the bug/patch item
81for each change.
Georg Brandl8ec7f652007-08-15 14:28:01 +000082
Georg Brandlb19be572007-12-29 10:57:00 +000083.. Compare with previous release in 2 - 3 sentences here.
84 add hyperlink when the documentation becomes available online.
Georg Brandl8ec7f652007-08-15 14:28:01 +000085
Georg Brandlb19be572007-12-29 10:57:00 +000086.. ========================================================================
87.. Large, PEP-level features and changes should be described here.
88.. Should there be a new section here for 3k migration?
89.. Or perhaps a more general section describing module changes/deprecation?
90.. ========================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +000091
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +000092Python 3.0
93================
94
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +000095The development cycle for Python versions 2.6 and 3.0 was
96synchronized, with the alpha and beta releases for both versions being
97made on the same days. The development of 3.0 has influenced many
98features in 2.6.
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +000099
100Python 3.0 is a far-ranging redesign of Python that breaks
101compatibility with the 2.x series. This means that existing Python
Andrew M. Kuchling4d028572008-08-31 02:24:08 +0000102code will need some conversion in order to run on
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +0000103Python 3.0. However, not all the changes in 3.0 necessarily break
104compatibility. In cases where new features won't cause existing code
105to break, they've been backported to 2.6 and are described in this
Georg Brandle152a772008-05-24 18:31:28 +0000106document in the appropriate place. Some of the 3.0-derived features
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +0000107are:
108
109* A :meth:`__complex__` method for converting objects to a complex number.
110* Alternate syntax for catching exceptions: ``except TypeError as exc``.
111* The addition of :func:`functools.reduce` as a synonym for the built-in
112 :func:`reduce` function.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000113
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000114Python 3.0 adds several new built-in functions and changes the
115semantics of some existing built-ins. Functions that are new in 3.0
116such as :func:`bin` have simply been added to Python 2.6, but existing
117built-ins haven't been changed; instead, the :mod:`future_builtins`
118module has versions with the new 3.0 semantics. Code written to be
119compatible with 3.0 can do ``from future_builtins import hex, map`` as
120necessary.
121
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000122A new command-line switch, :option:`-3`, enables warnings
123about features that will be removed in Python 3.0. You can run code
124with this switch to see how much work will be necessary to port
Georg Brandle152a772008-05-24 18:31:28 +0000125code to 3.0. The value of this switch is available
Georg Brandld5b635f2008-03-25 08:29:14 +0000126to Python code as the boolean variable :data:`sys.py3kwarning`,
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000127and to C extension code as :cdata:`Py_Py3kWarningFlag`.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000128
129.. seealso::
130
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000131 The 3xxx series of PEPs, which contains proposals for Python 3.0.
132 :pep:`3000` describes the development process for Python 3.0.
133 Start with :pep:`3100` that describes the general goals for Python
134 3.0, and then explore the higher-numbered PEPS that propose
135 specific features.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000136
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000137
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000138Changes to the Development Process
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000139==================================================
140
Georg Brandle152a772008-05-24 18:31:28 +0000141While 2.6 was being developed, the Python development process
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000142underwent two significant changes: we switched from SourceForge's
143issue tracker to a customized Roundup installation, and the
144documentation was converted from LaTeX to reStructuredText.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000145
146
147New Issue Tracker: Roundup
148--------------------------------------------------
149
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000150For a long time, the Python developers had been growing increasingly
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000151annoyed by SourceForge's bug tracker. SourceForge's hosted solution
152doesn't permit much customization; for example, it wasn't possible to
153customize the life cycle of issues.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000154
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000155The infrastructure committee of the Python Software Foundation
156therefore posted a call for issue trackers, asking volunteers to set
157up different products and import some of the bugs and patches from
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000158SourceForge. Four different trackers were examined: `Jira
Georg Brandle152a772008-05-24 18:31:28 +0000159<http://www.atlassian.com/software/jira/>`__,
160`Launchpad <http://www.launchpad.net>`__,
161`Roundup <http://roundup.sourceforge.net/>`__, and
162`Trac <http://trac.edgewall.org/>`__.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000163The committee eventually settled on Jira
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000164and Roundup as the two candidates. Jira is a commercial product that
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000165offers no-cost hosted instances to free-software projects; Roundup
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000166is an open-source project that requires volunteers
167to administer it and a server to host it.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000168
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000169After posting a call for volunteers, a new Roundup installation was
170set up at http://bugs.python.org. One installation of Roundup can
171host multiple trackers, and this server now also hosts issue trackers
Georg Brandle152a772008-05-24 18:31:28 +0000172for Jython and for the Python web site. It will surely find
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000173other uses in the future. Where possible,
174this edition of "What's New in Python" links to the bug/patch
175item for each change.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000176
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000177Hosting of the Python bug tracker is kindly provided by
Georg Brandle152a772008-05-24 18:31:28 +0000178`Upfront Systems <http://www.upfrontsystems.co.za/>`__
Andrew M. Kuchling17f84292008-04-10 21:29:01 +0000179of Stellenbosch, South Africa. Martin von Loewis put a
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +0000180lot of effort into importing existing bugs and patches from
Georg Brandle152a772008-05-24 18:31:28 +0000181SourceForge; his scripts for this import operation are at
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000182http://svn.python.org/view/tracker/importer/ and may be useful to
183other projects wished to move from SourceForge to Roundup.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000184
185.. seealso::
186
Georg Brandle152a772008-05-24 18:31:28 +0000187 http://bugs.python.org
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000188 The Python bug tracker.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000189
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000190 http://bugs.jython.org:
191 The Jython bug tracker.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000192
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000193 http://roundup.sourceforge.net/
194 Roundup downloads and documentation.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000195
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000196 http://svn.python.org/view/tracker/importer/
197 Martin von Loewis's conversion scripts.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000198
Benjamin Peterson56fcb0b2008-05-02 22:12:58 +0000199New Documentation Format: reStructuredText Using Sphinx
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000200-----------------------------------------------------------
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000201
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000202The Python documentation was written using LaTeX since the project
203started around 1989. In the 1980s and early 1990s, most documentation
204was printed out for later study, not viewed online. LaTeX was widely
205used because it provided attractive printed output while remaining
Mark Summerfield0792cbf2008-09-02 07:23:16 +0000206straightforward to write once the basic rules of the markup were
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000207learned.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000208
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000209Today LaTeX is still used for writing publications destined for
210printing, but the landscape for programming tools has shifted. We no
211longer print out reams of documentation; instead, we browse through it
212online and HTML has become the most important format to support.
213Unfortunately, converting LaTeX to HTML is fairly complicated and Fred
214L. Drake Jr., the long-time Python documentation editor, spent a lot
215of time maintaining the conversion process. Occasionally people would
216suggest converting the documentation into SGML and later XML, but
217performing a good conversion is a major task and no one ever committed
218the time required to finish the job.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000219
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000220During the 2.6 development cycle, Georg Brandl put a lot of effort
221into building a new toolchain for processing the documentation. The
222resulting package is called Sphinx, and is available from
223http://sphinx.pocoo.org/.
224
225Sphinx concentrates on HTML output, producing attractively styled and
226modern HTML; printed output is still supported through conversion to
227LaTeX. The input format is reStructuredText, a markup syntax
228supporting custom extensions and directives that is commonly used in
229the Python community.
230
231Sphinx is a standalone package that can be used for writing, and
232almost two dozen other projects
233(`listed on the Sphinx web site <http://sphinx.pocoo.org/examples.html>`__)
234have adopted Sphinx as their documentation tool.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000235
236.. seealso::
237
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000238 :ref:`documenting-index`
239 Describes how to write for Python's documentation.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000240
Andrew M. Kuchling217057f2008-04-05 15:57:46 +0000241 `Sphinx <http://sphinx.pocoo.org/>`__
242 Documentation and code for the Sphinx toolchain.
243
244 `Docutils <http://docutils.sf.net>`__
David Goodger09f57b72008-04-21 14:40:22 +0000245 The underlying reStructuredText parser and toolset.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000246
247
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000248PEP 343: The 'with' statement
249=============================
250
251The previous version, Python 2.5, added the ':keyword:`with`'
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000252statement as an optional feature, to be enabled by a ``from __future__
Andrew M. Kuchling6e751f42007-12-03 21:28:41 +0000253import with_statement`` directive. In 2.6 the statement no longer needs to
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000254be specially enabled; this means that :keyword:`with` is now always a
Georg Brandle152a772008-05-24 18:31:28 +0000255keyword. The rest of this section is a copy of the corresponding
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000256section from the "What's New in Python 2.5" document; if you're
257familiar with the ':keyword:`with`' statement
258from Python 2.5, you can skip this section.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000259
260The ':keyword:`with`' statement clarifies code that previously would use
261``try...finally`` blocks to ensure that clean-up code is executed. In this
262section, I'll discuss the statement as it will commonly be used. In the next
263section, I'll examine the implementation details and show how to write objects
264for use with this statement.
265
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000266The ':keyword:`with`' statement is a control-flow structure whose basic
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000267structure is::
268
269 with expression [as variable]:
270 with-block
271
272The expression is evaluated, and it should result in an object that supports the
273context management protocol (that is, has :meth:`__enter__` and :meth:`__exit__`
274methods.
275
276The object's :meth:`__enter__` is called before *with-block* is executed and
277therefore can run set-up code. It also may return a value that is bound to the
278name *variable*, if given. (Note carefully that *variable* is *not* assigned
279the result of *expression*.)
280
281After execution of the *with-block* is finished, the object's :meth:`__exit__`
282method is called, even if the block raised an exception, and can therefore run
283clean-up code.
284
285Some standard Python objects now support the context management protocol and can
286be used with the ':keyword:`with`' statement. File objects are one example::
287
288 with open('/etc/passwd', 'r') as f:
289 for line in f:
290 print line
291 ... more processing code ...
292
293After this statement has executed, the file object in *f* will have been
294automatically closed, even if the :keyword:`for` loop raised an exception part-
295way through the block.
296
297.. note::
298
299 In this case, *f* is the same object created by :func:`open`, because
300 :meth:`file.__enter__` returns *self*.
301
302The :mod:`threading` module's locks and condition variables also support the
303':keyword:`with`' statement::
304
305 lock = threading.Lock()
306 with lock:
307 # Critical section of code
308 ...
309
310The lock is acquired before the block is executed and always released once the
311block is complete.
312
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000313The :func:`localcontext` function in the :mod:`decimal` module makes it easy
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000314to save and restore the current decimal context, which encapsulates the desired
315precision and rounding characteristics for computations::
316
317 from decimal import Decimal, Context, localcontext
318
319 # Displays with default precision of 28 digits
320 v = Decimal('578')
321 print v.sqrt()
322
323 with localcontext(Context(prec=16)):
324 # All code in this block uses a precision of 16 digits.
325 # The original context is restored on exiting the block.
326 print v.sqrt()
327
328
329.. _new-26-context-managers:
330
331Writing Context Managers
332------------------------
333
334Under the hood, the ':keyword:`with`' statement is fairly complicated. Most
335people will only use ':keyword:`with`' in company with existing objects and
336don't need to know these details, so you can skip the rest of this section if
337you like. Authors of new objects will need to understand the details of the
338underlying implementation and should keep reading.
339
340A high-level explanation of the context management protocol is:
341
342* The expression is evaluated and should result in an object called a "context
343 manager". The context manager must have :meth:`__enter__` and :meth:`__exit__`
344 methods.
345
346* The context manager's :meth:`__enter__` method is called. The value returned
Georg Brandld41b8dc2007-12-16 23:15:07 +0000347 is assigned to *VAR*. If no ``as VAR`` clause is present, the value is simply
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000348 discarded.
349
350* The code in *BLOCK* is executed.
351
352* If *BLOCK* raises an exception, the :meth:`__exit__(type, value, traceback)`
353 is called with the exception details, the same values returned by
354 :func:`sys.exc_info`. The method's return value controls whether the exception
355 is re-raised: any false value re-raises the exception, and ``True`` will result
356 in suppressing it. You'll only rarely want to suppress the exception, because
357 if you do the author of the code containing the ':keyword:`with`' statement will
358 never realize anything went wrong.
359
360* If *BLOCK* didn't raise an exception, the :meth:`__exit__` method is still
361 called, but *type*, *value*, and *traceback* are all ``None``.
362
363Let's think through an example. I won't present detailed code but will only
364sketch the methods necessary for a database that supports transactions.
365
366(For people unfamiliar with database terminology: a set of changes to the
367database are grouped into a transaction. Transactions can be either committed,
368meaning that all the changes are written into the database, or rolled back,
369meaning that the changes are all discarded and the database is unchanged. See
370any database textbook for more information.)
371
372Let's assume there's an object representing a database connection. Our goal will
373be to let the user write code like this::
374
375 db_connection = DatabaseConnection()
376 with db_connection as cursor:
377 cursor.execute('insert into ...')
378 cursor.execute('delete from ...')
379 # ... more operations ...
380
381The transaction should be committed if the code in the block runs flawlessly or
382rolled back if there's an exception. Here's the basic interface for
383:class:`DatabaseConnection` that I'll assume::
384
385 class DatabaseConnection:
386 # Database interface
Georg Brandl9f72d232007-12-16 23:13:29 +0000387 def cursor(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000388 "Returns a cursor object and starts a new transaction"
Georg Brandl9f72d232007-12-16 23:13:29 +0000389 def commit(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000390 "Commits current transaction"
Georg Brandl9f72d232007-12-16 23:13:29 +0000391 def rollback(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000392 "Rolls back current transaction"
393
394The :meth:`__enter__` method is pretty easy, having only to start a new
395transaction. For this application the resulting cursor object would be a useful
396result, so the method will return it. The user can then add ``as cursor`` to
397their ':keyword:`with`' statement to bind the cursor to a variable name. ::
398
399 class DatabaseConnection:
400 ...
Georg Brandl9f72d232007-12-16 23:13:29 +0000401 def __enter__(self):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000402 # Code to start a new transaction
403 cursor = self.cursor()
404 return cursor
405
406The :meth:`__exit__` method is the most complicated because it's where most of
407the work has to be done. The method has to check if an exception occurred. If
408there was no exception, the transaction is committed. The transaction is rolled
409back if there was an exception.
410
411In the code below, execution will just fall off the end of the function,
412returning the default value of ``None``. ``None`` is false, so the exception
413will be re-raised automatically. If you wished, you could be more explicit and
414add a :keyword:`return` statement at the marked location. ::
415
416 class DatabaseConnection:
417 ...
Georg Brandl9f72d232007-12-16 23:13:29 +0000418 def __exit__(self, type, value, tb):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000419 if tb is None:
420 # No exception, so commit
421 self.commit()
422 else:
423 # Exception occurred, so rollback.
424 self.rollback()
425 # return False
426
427
428.. _module-contextlib:
429
430The contextlib module
431---------------------
432
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000433The :mod:`contextlib` module provides some functions and a decorator that
434are useful when writing objects for use with the ':keyword:`with`' statement.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000435
436The decorator is called :func:`contextmanager`, and lets you write a single
437generator function instead of defining a new class. The generator should yield
438exactly one value. The code up to the :keyword:`yield` will be executed as the
439:meth:`__enter__` method, and the value yielded will be the method's return
440value that will get bound to the variable in the ':keyword:`with`' statement's
441:keyword:`as` clause, if any. The code after the :keyword:`yield` will be
442executed in the :meth:`__exit__` method. Any exception raised in the block will
443be raised by the :keyword:`yield` statement.
444
Andrew M. Kuchlinge4964932008-08-30 15:19:57 +0000445Using this decorator, our database example from the previous section
446could be written as::
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000447
448 from contextlib import contextmanager
449
450 @contextmanager
Georg Brandl9f72d232007-12-16 23:13:29 +0000451 def db_transaction(connection):
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000452 cursor = connection.cursor()
453 try:
454 yield cursor
455 except:
456 connection.rollback()
457 raise
458 else:
459 connection.commit()
460
461 db = DatabaseConnection()
462 with db_transaction(db) as cursor:
463 ...
464
465The :mod:`contextlib` module also has a :func:`nested(mgr1, mgr2, ...)` function
466that combines a number of context managers so you don't need to write nested
467':keyword:`with`' statements. In this example, the single ':keyword:`with`'
468statement both starts a database transaction and acquires a thread lock::
469
470 lock = threading.Lock()
471 with nested (db_transaction(db), lock) as (cursor, locked):
472 ...
473
474Finally, the :func:`closing(object)` function returns *object* so that it can be
475bound to a variable, and calls ``object.close`` at the end of the block. ::
476
477 import urllib, sys
478 from contextlib import closing
479
480 with closing(urllib.urlopen('http://www.yahoo.com')) as f:
481 for line in f:
482 sys.stdout.write(line)
483
484
485.. seealso::
486
487 :pep:`343` - The "with" statement
488 PEP written by Guido van Rossum and Nick Coghlan; implemented by Mike Bland,
489 Guido van Rossum, and Neal Norwitz. The PEP shows the code generated for a
490 ':keyword:`with`' statement, which can be helpful in learning how the statement
491 works.
492
493 The documentation for the :mod:`contextlib` module.
494
Georg Brandlb19be572007-12-29 10:57:00 +0000495.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000496
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000497.. _pep-0366:
498
499PEP 366: Explicit Relative Imports From a Main Module
500============================================================
501
502Python's :option:`-m` switch allows running a module as a script.
503When you ran a module that was located inside a package, relative
504imports didn't work correctly.
505
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000506The fix for Python 2.6 adds a :attr:`__package__` attribute to
507modules. When this attribute is present, relative imports will be
508relative to the value of this attribute instead of the
509:attr:`__name__` attribute.
510
511PEP 302-style importers can then set :attr:`__package__` as necessary.
512The :mod:`runpy` module that implements the :option:`-m` switch now
513does this, so relative imports will now work correctly in scripts
514running from inside a package.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000515
Georg Brandlb19be572007-12-29 10:57:00 +0000516.. ======================================================================
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +0000517
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000518.. _pep-0370:
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000519
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000520PEP 370: Per-user ``site-packages`` Directory
521=====================================================
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000522
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000523When you run Python, the module search path ``sys.path`` usually
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000524includes a directory whose path ends in ``"site-packages"``. This
525directory is intended to hold locally-installed packages available to
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000526all users using a machine or a particular site installation.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000527
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000528Python 2.6 introduces a convention for user-specific site directories.
529The directory varies depending on the platform:
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000530
Georg Brandl9af94982008-09-13 17:41:16 +0000531* Unix and Mac OS X: :file:`~/.local/`
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000532* Windows: :file:`%APPDATA%/Python`
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000533
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000534Within this directory, there will be version-specific subdirectories,
Georg Brandl9af94982008-09-13 17:41:16 +0000535such as :file:`lib/python2.6/site-packages` on Unix/Mac OS and
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000536:file:`Python26/site-packages` on Windows.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000537
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +0000538If you don't like the default directory, it can be overridden by an
539environment variable. :envvar:`PYTHONUSERBASE` sets the root
540directory used for all Python versions supporting this feature. On
541Windows, the directory for application-specific data can be changed by
542setting the :envvar:`APPDATA` environment variable. You can also
543modify the :file:`site.py` file for your Python installation.
544
545The feature can be disabled entirely by running Python with the
546:option:`-s` option or setting the :envvar:`PYTHONNOUSERSITE`
547environment variable.
548
549.. seealso::
550
551 :pep:`370` - Per-user ``site-packages`` Directory
552 PEP written and implemented by Christian Heimes.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000553
Georg Brandle152a772008-05-24 18:31:28 +0000554
Andrew M. Kuchling2e463552008-01-15 01:47:32 +0000555.. ======================================================================
556
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000557.. _pep-0371:
558
559PEP 371: The ``multiprocessing`` Package
560=====================================================
561
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000562The new :mod:`multiprocessing` package lets Python programs create new
563processes that will perform a computation and return a result to the
564parent. The parent and child processes can communicate using queues
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000565and pipes, synchronize their operations using locks and semaphores,
566and can share simple arrays of data.
Benjamin Petersona6a72922008-07-01 19:51:54 +0000567
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000568The :mod:`multiprocessing` module started out as an exact emulation of
569the :mod:`threading` module using processes instead of threads. That
570goal was discarded along the path to Python 2.6, but the general
571approach of the module is still similar. The fundamental class
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000572is the :class:`Process`, which is passed a callable object and
573a collection of arguments. The :meth:`start` method
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000574sets the callable running in a subprocess, after which you can call
575the :meth:`is_alive` method to check whether the subprocess is still running
576and the :meth:`join` method to wait for the process to exit.
Benjamin Petersona6a72922008-07-01 19:51:54 +0000577
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000578Here's a simple example where the subprocess will calculate a
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000579factorial. The function doing the calculation is written strangely so
580that it takes significantly longer when the input argument is a
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000581multiple of 4.
Benjamin Petersona6a72922008-07-01 19:51:54 +0000582
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000583::
Benjamin Petersona6a72922008-07-01 19:51:54 +0000584
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000585 import time
586 from multiprocessing import Process, Queue
Benjamin Petersona6a72922008-07-01 19:51:54 +0000587
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000588
589 def factorial(queue, N):
590 "Compute a factorial."
591 # If N is a multiple of 4, this function will take much longer.
592 if (N % 4) == 0:
593 time.sleep(.05 * N/4)
594
595 # Calculate the result
596 fact = 1L
597 for i in range(1, N+1):
598 fact = fact * i
599
600 # Put the result on the queue
601 queue.put(fact)
602
603 if __name__ == '__main__':
604 queue = Queue()
605
606 N = 5
607
608 p = Process(target=factorial, args=(queue, N))
609 p.start()
610 p.join()
611
612 result = queue.get()
613 print 'Factorial', N, '=', result
614
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000615A :class:`Queue` is used to communicate the input parameter *N* and
616the result. The :class:`Queue` object is stored in a global variable.
617The child process will use the value of the variable when the child
618was created; because it's a :class:`Queue`, parent and child can use
619the object to communicate. (If the parent were to change the value of
620the global variable, the child's value would be unaffected, and vice
621versa.)
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000622
623Two other classes, :class:`Pool` and :class:`Manager`, provide
624higher-level interfaces. :class:`Pool` will create a fixed number of
625worker processes, and requests can then be distributed to the workers
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +0000626by calling :meth:`apply` or :meth:`apply_async` to add a single request,
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000627and :meth:`map` or :meth:`map_async` to add a number of
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000628requests. The following code uses a :class:`Pool` to spread requests
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000629across 5 worker processes and retrieve a list of results::
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000630
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000631 from multiprocessing import Pool
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000632
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000633 def factorial(N, dictionary):
634 "Compute a factorial."
635 ...
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000636 p = Pool(5)
637 result = p.map(factorial, range(1, 1000, 10))
638 for v in result:
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000639 print v
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000640
641This produces the following output::
642
643 1
644 39916800
645 51090942171709440000
646 8222838654177922817725562880000000
647 33452526613163807108170062053440751665152000000000
648 ...
649
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000650The other high-level interface, the :class:`Manager` class, creates a
651separate server process that can hold master copies of Python data
652structures. Other processes can then access and modify these data
653structures using proxy objects. The following example creates a
654shared dictionary by calling the :meth:`dict` method; the worker
655processes then insert values into the dictionary. (Locking is not
656done for you automatically, which doesn't matter in this example.
657:class:`Manager`'s methods also include :meth:`Lock`, :meth:`RLock`,
658and :meth:`Semaphore` to create shared locks.)
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000659
660::
661
662 import time
663 from multiprocessing import Pool, Manager
664
665 def factorial(N, dictionary):
666 "Compute a factorial."
667 # Calculate the result
668 fact = 1L
669 for i in range(1, N+1):
670 fact = fact * i
671
672 # Store result in dictionary
673 dictionary[N] = fact
674
675 if __name__ == '__main__':
676 p = Pool(5)
677 mgr = Manager()
678 d = mgr.dict() # Create shared dictionary
679
680 # Run tasks using the pool
681 for N in range(1, 1000, 10):
682 p.apply_async(factorial, (N, d))
683
684 # Mark pool as closed -- no more tasks can be added.
685 p.close()
686
687 # Wait for tasks to exit
688 p.join()
689
690 # Output results
691 for k, v in sorted(d.items()):
692 print k, v
693
694This will produce the output::
695
696 1 1
697 11 39916800
698 21 51090942171709440000
699 31 8222838654177922817725562880000000
700 41 33452526613163807108170062053440751665152000000000
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000701 51 15511187532873822802242430164693032110632597200169861120000...
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000702
703.. seealso::
704
Andrew M. Kuchling4ec0c272008-07-14 01:18:31 +0000705 The documentation for the :mod:`multiprocessing` module.
706
Benjamin Peterson2b917c92008-06-24 02:41:08 +0000707 :pep:`371` - Addition of the multiprocessing package
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000708 PEP written by Jesse Noller and Richard Oudkerk;
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +0000709 implemented by Richard Oudkerk and Jesse Noller.
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000710
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000711
Andrew M. Kuchlinga809c982008-06-11 12:53:14 +0000712.. ======================================================================
713
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000714.. _pep-3101:
715
716PEP 3101: Advanced String Formatting
717=====================================================
718
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000719In Python 3.0, the `%` operator is supplemented by a more powerful string
720formatting method, :meth:`format`. Support for the :meth:`str.format` method
721has been backported to Python 2.6.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000722
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000723In 2.6, both 8-bit and Unicode strings have a `.format()` method that
724treats the string as a template and takes the arguments to be formatted.
725The formatting template uses curly brackets (`{`, `}`) as special characters::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000726
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000727 # Substitute positional argument 0 into the string.
728 "User ID: {0}".format("root") -> "User ID: root"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000729
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000730 # Use the named keyword arguments
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000731 'User ID: {uid} Last seen: {last_login}'.format(
732 uid='root',
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000733 last_login = '5 Mar 2008 07:20') ->
734 'User ID: root Last seen: 5 Mar 2008 07:20'
735
736Curly brackets can be escaped by doubling them::
737
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000738 format("Empty dict: {{}}") -> "Empty dict: {}"
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000739
Georg Brandle152a772008-05-24 18:31:28 +0000740Field names can be integers indicating positional arguments, such as
741``{0}``, ``{1}``, etc. or names of keyword arguments. You can also
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000742supply compound field names that read attributes or access dictionary keys::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000743
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000744 import sys
745 'Platform: {0.platform}\nPython version: {0.version}'.format(sys) ->
746 'Platform: darwin\n
747 Python version: 2.6a1+ (trunk:61261M, Mar 5 2008, 20:29:41) \n
748 [GCC 4.0.1 (Apple Computer, Inc. build 5367)]'
749
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000750 import mimetypes
751 'Content-type: {0[.mp4]}'.format(mimetypes.types_map) ->
752 'Content-type: video/mp4'
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000753
754Note that when using dictionary-style notation such as ``[.mp4]``, you
755don't need to put any quotation marks around the string; it will look
756up the value using ``.mp4`` as the key. Strings beginning with a
757number will be converted to an integer. You can't write more
758complicated expressions inside a format string.
759
760So far we've shown how to specify which field to substitute into the
761resulting string. The precise formatting used is also controllable by
Georg Brandl859043c2008-03-21 17:19:29 +0000762adding a colon followed by a format specifier. For example::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000763
764 # Field 0: left justify, pad to 15 characters
765 # Field 1: right justify, pad to 6 characters
766 fmt = '{0:15} ${1:>6}'
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000767
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000768 fmt.format('Registration', 35) ->
769 'Registration $ 35'
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000770
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000771 fmt.format('Tutorial', 50) ->
772 'Tutorial $ 50'
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000773
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000774 fmt.format('Banquet', 125) ->
775 'Banquet $ 125'
776
Georg Brandl859043c2008-03-21 17:19:29 +0000777Format specifiers can reference other fields through nesting::
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000778
779 fmt = '{0:{1}}'
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000780
781 width = 15
782 fmt.format('Invoice #1234', width) ->
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000783 'Invoice #1234 '
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000784
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000785 width = 35
786 fmt.format('Invoice #1234', width) ->
787 'Invoice #1234 '
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000788
789The alignment of a field within the desired width can be specified:
790
791================ ============================================
792Character Effect
793================ ============================================
794< (default) Left-align
795> Right-align
796^ Center
797= (For numeric types only) Pad after the sign.
798================ ============================================
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000799
Georg Brandle152a772008-05-24 18:31:28 +0000800Format specifiers can also include a presentation type, which
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000801controls how the value is formatted. For example, floating-point numbers
802can be formatted as a general number or in exponential notation:
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000803
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000804 >>> '{0:g}'.format(3.75)
805 '3.75'
806 >>> '{0:e}'.format(3.75)
807 '3.750000e+00'
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000808
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000809A variety of presentation types are available. Consult the 2.6
Georg Brandle321c2f2008-05-12 16:45:43 +0000810documentation for a :ref:`complete list <formatstrings>`; here's a sample::
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000811
812 'b' - Binary. Outputs the number in base 2.
813 'c' - Character. Converts the integer to the corresponding
814 Unicode character before printing.
815 'd' - Decimal Integer. Outputs the number in base 10.
816 'o' - Octal format. Outputs the number in base 8.
817 'x' - Hex format. Outputs the number in base 16, using lower-
818 case letters for the digits above 9.
819 'e' - Exponent notation. Prints the number in scientific
820 notation using the letter 'e' to indicate the exponent.
821 'g' - General format. This prints the number as a fixed-point
822 number, unless the number is too large, in which case
823 it switches to 'e' exponent notation.
Eric Smith103f19d2008-05-12 14:00:01 +0000824 'n' - Number. This is the same as 'g' (for floats) or 'd' (for
825 integers), except that it uses the current locale setting to
826 insert the appropriate number separator characters.
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +0000827 '%' - Percentage. Multiplies the number by 100 and displays
828 in fixed ('f') format, followed by a percent sign.
829
Andrew M. Kuchlingb2793a42008-08-07 01:47:34 +0000830Classes and types can define a :meth:`__format__` method to control how they're
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000831formatted. It receives a single argument, the format specifier::
832
833 def __format__(self, format_spec):
834 if isinstance(format_spec, unicode):
835 return unicode(str(self))
836 else:
837 return str(self)
838
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000839There's also a :func:`format` built-in that will format a single
840value. It calls the type's :meth:`__format__` method with the
841provided specifier::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000842
843 >>> format(75.6564, '.2f')
844 '75.66'
845
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +0000846
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000847.. seealso::
848
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000849 :ref:`formatstrings`
Andrew M. Kuchling5f2dc0b2008-08-30 16:44:54 +0000850 The reference documentation for format fields.
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000851
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000852 :pep:`3101` - Advanced String Formatting
Benjamin Petersonc3cb6832008-05-26 12:29:46 +0000853 PEP written by Talin. Implemented by Eric Smith.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +0000854
855.. ======================================================================
856
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000857.. _pep-3105:
858
859PEP 3105: ``print`` As a Function
860=====================================================
861
862The ``print`` statement becomes the :func:`print` function in Python 3.0.
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000863Making :func:`print` a function makes it possible to replace the function
864by doing ``def print(...)`` or importing a new function from somewhere else.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000865
Georg Brandle152a772008-05-24 18:31:28 +0000866Python 2.6 has a ``__future__`` import that removes ``print`` as language
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000867syntax, letting you use the functional form instead. For example::
868
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000869 from __future__ import print_function
870 print('# of entries', len(dictionary), file=sys.stderr)
871
872The signature of the new function is::
873
874 def print(*args, sep=' ', end='\n', file=None)
875
876The parameters are:
877
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000878 * *args*: positional arguments whose values will be printed out.
879 * *sep*: the separator, which will be printed between arguments.
880 * *end*: the ending text, which will be printed after all of the
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000881 arguments have been output.
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000882 * *file*: the file object to which the output will be sent.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000883
884.. seealso::
885
Eric Smith33dd0942008-03-20 23:04:04 +0000886 :pep:`3105` - Make print a function
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +0000887 PEP written by Georg Brandl.
888
889.. ======================================================================
890
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000891.. _pep-3110:
892
893PEP 3110: Exception-Handling Changes
894=====================================================
895
Georg Brandle152a772008-05-24 18:31:28 +0000896One error that Python programmers occasionally make
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000897is writing the following code::
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000898
899 try:
900 ...
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000901 except TypeError, ValueError: # Wrong!
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000902 ...
903
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000904The author is probably trying to catch both :exc:`TypeError` and
905:exc:`ValueError` exceptions, but this code actually does something
906different: it will catch :exc:`TypeError` and bind the resulting
907exception object to the local name ``"ValueError"``. The
908:exc:`ValueError` exception will not be caught at all. The correct
909code specifies a tuple of exceptions::
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000910
911 try:
912 ...
913 except (TypeError, ValueError):
914 ...
915
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000916This error happens because the use of the comma here is ambiguous:
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000917does it indicate two different nodes in the parse tree, or a single
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000918node that's a tuple?
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000919
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000920Python 3.0 makes this unambiguous by replacing the comma with the word
921"as". To catch an exception and store the exception object in the
922variable ``exc``, you must write::
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000923
924 try:
925 ...
926 except TypeError as exc:
927 ...
928
929Python 3.0 will only support the use of "as", and therefore interprets
930the first example as catching two different exceptions. Python 2.6
931supports both the comma and "as", so existing code will continue to
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +0000932work. We therefore suggest using "as" when writing new Python code
933that will only be executed with 2.6.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000934
935.. seealso::
936
937 :pep:`3110` - Catching Exceptions in Python 3000
938 PEP written and implemented by Collin Winter.
939
Georg Brandlb19be572007-12-29 10:57:00 +0000940.. ======================================================================
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +0000941
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000942.. _pep-3112:
943
944PEP 3112: Byte Literals
945=====================================================
946
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000947Python 3.0 adopts Unicode as the language's fundamental string type and
Georg Brandle152a772008-05-24 18:31:28 +0000948denotes 8-bit literals differently, either as ``b'string'``
949or using a :class:`bytes` constructor. For future compatibility,
Andrew M. Kuchling3710a132008-03-05 00:44:41 +0000950Python 2.6 adds :class:`bytes` as a synonym for the :class:`str` type,
951and it also supports the ``b''`` notation.
952
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000953There's also a ``__future__`` import that causes all string literals
Georg Brandle152a772008-05-24 18:31:28 +0000954to become Unicode strings. This means that ``\u`` escape sequences
Benjamin Peterson83343302008-05-04 03:05:49 +0000955can be used to include Unicode characters::
956
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000957
Andrew M. Kuchlingda950eb2008-04-13 22:39:12 +0000958 from __future__ import unicode_literals
959
960 s = ('\u751f\u3080\u304e\u3000\u751f\u3054'
961 '\u3081\u3000\u751f\u305f\u307e\u3054')
962
963 print len(s) # 12 Unicode characters
964
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000965At the C level, Python 3.0 will rename the existing 8-bit
966string type, called :ctype:`PyStringObject` in Python 2.x,
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000967to :ctype:`PyBytesObject`. Python 2.6 uses ``#define``
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000968to support using the names :cfunc:`PyBytesObject`,
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000969:cfunc:`PyBytes_Check`, :cfunc:`PyBytes_FromStringAndSize`,
970and all the other functions and macros used with strings.
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +0000971
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000972Instances of the :class:`bytes` type are immutable just
973as strings are. A new :class:`bytearray` type stores a mutable
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000974sequence of bytes::
975
976 >>> bytearray([65, 66, 67])
977 bytearray(b'ABC')
978 >>> b = bytearray(u'\u21ef\u3244', 'utf-8')
979 >>> b
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +0000980 bytearray(b'\xe2\x87\xaf\xe3\x89\x84')
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000981 >>> b[0] = '\xe3'
982 >>> b
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +0000983 bytearray(b'\xe3\x87\xaf\xe3\x89\x84')
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000984 >>> unicode(str(b), 'utf-8')
985 u'\u31ef \u3244'
986
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000987Byte arrays support most of the methods of string types, such as
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000988:meth:`startswith`/:meth:`endswith`, :meth:`find`/:meth:`rfind`,
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +0000989and some of the methods of lists, such as :meth:`append`,
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +0000990:meth:`pop`, and :meth:`reverse`.
991
992 >>> b = bytearray('ABC')
993 >>> b.append('d')
994 >>> b.append(ord('e'))
995 >>> b
996 bytearray(b'ABCde')
Benjamin Peterson83343302008-05-04 03:05:49 +0000997
Andrew M. Kuchling488a4f02008-08-27 02:12:18 +0000998There's also a corresponding C API, with
999:cfunc:`PyByteArray_FromObject`,
1000:cfunc:`PyByteArray_FromStringAndSize`,
1001and various other functions.
1002
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001003.. seealso::
1004
1005 :pep:`3112` - Bytes literals in Python 3000
1006 PEP written by Jason Orendorff; backported to 2.6 by Christian Heimes.
1007
1008.. ======================================================================
1009
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001010.. _pep-3116:
1011
1012PEP 3116: New I/O Library
1013=====================================================
1014
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001015Python's built-in file objects support a number of methods, but
1016file-like objects don't necessarily support all of them. Objects that
1017imitate files usually support :meth:`read` and :meth:`write`, but they
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001018may not support :meth:`readline`, for example. Python 3.0 introduces
1019a layered I/O library in the :mod:`io` module that separates buffering
1020and text-handling features from the fundamental read and write
1021operations.
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001022
1023There are three levels of abstract base classes provided by
1024the :mod:`io` module:
1025
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001026* :class:`RawIOBase` defines raw I/O operations: :meth:`read`,
Georg Brandle152a772008-05-24 18:31:28 +00001027 :meth:`readinto`,
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001028 :meth:`write`, :meth:`seek`, :meth:`tell`, :meth:`truncate`,
1029 and :meth:`close`.
1030 Most of the methods of this class will often map to a single system call.
1031 There are also :meth:`readable`, :meth:`writable`, and :meth:`seekable`
1032 methods for determining what operations a given object will allow.
1033
1034 Python 3.0 has concrete implementations of this class for files and
1035 sockets, but Python 2.6 hasn't restructured its file and socket objects
1036 in this way.
1037
1038 .. XXX should 2.6 register them in io.py?
1039
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001040* :class:`BufferedIOBase` is an abstract base class that
Georg Brandle152a772008-05-24 18:31:28 +00001041 buffers data in memory to reduce the number of
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001042 system calls used, making I/O processing more efficient.
Georg Brandle152a772008-05-24 18:31:28 +00001043 It supports all of the methods of :class:`RawIOBase`,
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001044 and adds a :attr:`raw` attribute holding the underlying raw object.
1045
Andrew M. Kuchling488a4f02008-08-27 02:12:18 +00001046 There are five concrete classes implementing this ABC.
1047 :class:`BufferedWriter` and :class:`BufferedReader` are for objects
Andrew M. Kuchling3ffe5632008-08-30 15:25:47 +00001048 that support write-only or read-only usage that have a :meth:`seek`
1049 method for random access. :class:`BufferedRandom` objects support
1050 read and write access upon the same underlying stream, and
1051 :class:`BufferedRWPair` is for objects such as TTYs that have both
1052 read and write operations acting upon unconnected streams of data.
1053 The :class:`BytesIO` class supports reading, writing, and seeking
1054 over an in-memory buffer.
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001055
1056* :class:`TextIOBase`: Provides functions for reading and writing
1057 strings (remember, strings will be Unicode in Python 3.0),
Georg Brandle152a772008-05-24 18:31:28 +00001058 and supporting universal newlines. :class:`TextIOBase` defines
1059 the :meth:`readline` method and supports iteration upon
1060 objects.
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001061
1062 There are two concrete implementations. :class:`TextIOWrapper`
1063 wraps a buffered I/O object, supporting all of the methods for
Georg Brandle152a772008-05-24 18:31:28 +00001064 text I/O and adding a :attr:`buffer` attribute for access
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001065 to the underlying object. :class:`StringIO` simply buffers
1066 everything in memory without ever writing anything to disk.
1067
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001068 (In Python 2.6, :class:`io.StringIO` is implemented in
Georg Brandle152a772008-05-24 18:31:28 +00001069 pure Python, so it's pretty slow. You should therefore stick with the
1070 existing :mod:`StringIO` module or :mod:`cStringIO` for now. At some
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001071 point Python 3.0's :mod:`io` module will be rewritten into C for speed,
1072 and perhaps the C implementation will be backported to the 2.x releases.)
1073
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001074In Python 2.6, the underlying implementations haven't been
1075restructured to build on top of the :mod:`io` module's classes. The
Georg Brandle152a772008-05-24 18:31:28 +00001076module is being provided to make it easier to write code that's
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00001077forward-compatible with 3.0, and to save developers the effort of writing
1078their own implementations of buffering and text I/O.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001079
1080.. seealso::
1081
1082 :pep:`3116` - New I/O
1083 PEP written by Daniel Stutzbach, Mike Verdone, and Guido van Rossum.
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00001084 Code by Guido van Rossum, Georg Brandl, Walter Doerwald,
1085 Jeremy Hylton, Martin von Loewis, Tony Lownds, and others.
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001086
1087.. ======================================================================
1088
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001089.. _pep-3118:
1090
1091PEP 3118: Revised Buffer Protocol
1092=====================================================
1093
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001094The buffer protocol is a C-level API that lets Python types
Georg Brandle152a772008-05-24 18:31:28 +00001095exchange pointers into their internal representations. A
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001096memory-mapped file can be viewed as a buffer of characters, for
1097example, and this lets another module such as :mod:`re`
1098treat memory-mapped files as a string of characters to be searched.
1099
1100The primary users of the buffer protocol are numeric-processing
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001101packages such as NumPy, which expose the internal representation
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001102of arrays so that callers can write data directly into an array instead
Georg Brandle152a772008-05-24 18:31:28 +00001103of going through a slower API. This PEP updates the buffer protocol in light of experience
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001104from NumPy development, adding a number of new features
Andrew M. Kuchlingc9b41102008-08-27 00:45:02 +00001105such as indicating the shape of an array or locking a memory region.
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001106
Georg Brandle152a772008-05-24 18:31:28 +00001107The most important new C API function is
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001108``PyObject_GetBuffer(PyObject *obj, Py_buffer *view, int flags)``, which
1109takes an object and a set of flags, and fills in the
Georg Brandle152a772008-05-24 18:31:28 +00001110``Py_buffer`` structure with information
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001111about the object's memory representation. Objects
Georg Brandle152a772008-05-24 18:31:28 +00001112can use this operation to lock memory in place
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001113while an external caller could be modifying the contents,
Andrew M. Kuchlingc9b41102008-08-27 00:45:02 +00001114so there's a corresponding ``PyBuffer_Release(Py_buffer *view)`` to
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001115indicate that the external caller is done.
1116
Andrew M. Kuchlingc9b41102008-08-27 00:45:02 +00001117.. XXX PyObject_GetBuffer not documented in c-api
1118
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001119The *flags* argument to :cfunc:`PyObject_GetBuffer` specifies
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001120constraints upon the memory returned. Some examples are:
1121
1122 * :const:`PyBUF_WRITABLE` indicates that the memory must be writable.
Georg Brandle152a772008-05-24 18:31:28 +00001123
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001124 * :const:`PyBUF_LOCK` requests a read-only or exclusive lock on the memory.
1125
1126 * :const:`PyBUF_C_CONTIGUOUS` and :const:`PyBUF_F_CONTIGUOUS`
1127 requests a C-contiguous (last dimension varies the fastest) or
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001128 Fortran-contiguous (first dimension varies the fastest) array layout.
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001129
Andrew M. Kuchlingc9b41102008-08-27 00:45:02 +00001130Two new argument codes for :cfunc:`PyArg_ParseTuple`,
1131``s*`` and ``z*``, return locked buffer objects for a parameter.
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001132
1133.. seealso::
1134
1135 :pep:`3118` - Revising the buffer protocol
Andrew M. Kuchling217057f2008-04-05 15:57:46 +00001136 PEP written by Travis Oliphant and Carl Banks; implemented by
1137 Travis Oliphant.
Georg Brandle152a772008-05-24 18:31:28 +00001138
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001139
1140.. ======================================================================
1141
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001142.. _pep-3119:
1143
1144PEP 3119: Abstract Base Classes
1145=====================================================
1146
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001147Some object-oriented languages such as Java support interfaces,
1148declaring that a class has a given set of methods or supports a given
1149access protocol. Abstract Base Classes (or ABCs) are an equivalent
1150feature for Python. The ABC support consists of an :mod:`abc` module
1151containing a metaclass called :class:`ABCMeta`, special handling of
1152this metaclass by the :func:`isinstance` and :func:`issubclass`
1153built-ins, and a collection of basic ABCs that the Python developers
1154think will be widely useful. Future versions of Python will probably
1155add more ABCs.
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001156
Georg Brandle152a772008-05-24 18:31:28 +00001157Let's say you have a particular class and wish to know whether it supports
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001158dictionary-style access. The phrase "dictionary-style" is vague, however.
Georg Brandle152a772008-05-24 18:31:28 +00001159It probably means that accessing items with ``obj[1]`` works.
1160Does it imply that setting items with ``obj[2] = value`` works?
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001161Or that the object will have :meth:`keys`, :meth:`values`, and :meth:`items`
1162methods? What about the iterative variants such as :meth:`iterkeys`? :meth:`copy`
1163and :meth:`update`? Iterating over the object with :func:`iter`?
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001164
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001165The Python 2.6 :mod:`collections` module includes a number of
1166different ABCs that represent these distinctions. :class:`Iterable`
1167indicates that a class defines :meth:`__iter__`, and
1168:class:`Container` means the class defines a :meth:`__contains__`
1169method and therefore supports ``x in y`` expressions. The basic
1170dictionary interface of getting items, setting items, and
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001171:meth:`keys`, :meth:`values`, and :meth:`items`, is defined by the
1172:class:`MutableMapping` ABC.
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001173
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001174You can derive your own classes from a particular ABC
1175to indicate they support that ABC's interface::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001176
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001177 import collections
Georg Brandle152a772008-05-24 18:31:28 +00001178
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001179 class Storage(collections.MutableMapping):
1180 ...
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001181
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001182
Georg Brandle152a772008-05-24 18:31:28 +00001183Alternatively, you could write the class without deriving from
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001184the desired ABC and instead register the class by
1185calling the ABC's :meth:`register` method::
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001186
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001187 import collections
Georg Brandle152a772008-05-24 18:31:28 +00001188
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001189 class Storage:
1190 ...
Georg Brandle152a772008-05-24 18:31:28 +00001191
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001192 collections.MutableMapping.register(Storage)
Georg Brandle152a772008-05-24 18:31:28 +00001193
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001194For classes that you write, deriving from the ABC is probably clearer.
1195The :meth:`register` method is useful when you've written a new
1196ABC that can describe an existing type or class, or if you want
1197to declare that some third-party class implements an ABC.
1198For example, if you defined a :class:`PrintableType` ABC,
Benjamin Peterson8e234c62008-07-24 02:31:28 +00001199it's legal to do::
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001200
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001201 # Register Python's types
1202 PrintableType.register(int)
1203 PrintableType.register(float)
1204 PrintableType.register(str)
1205
Georg Brandle152a772008-05-24 18:31:28 +00001206Classes should obey the semantics specified by an ABC, but
1207Python can't check this; it's up to the class author to
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001208understand the ABC's requirements and to implement the code accordingly.
1209
1210To check whether an object supports a particular interface, you can
1211now write::
1212
1213 def func(d):
1214 if not isinstance(d, collections.MutableMapping):
Georg Brandle152a772008-05-24 18:31:28 +00001215 raise ValueError("Mapping object expected, not %r" % d)
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001216
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001217Don't feel that you must now begin writing lots of checks as in the
Georg Brandle152a772008-05-24 18:31:28 +00001218above example. Python has a strong tradition of duck-typing, where
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001219explicit type-checking is never done and code simply calls methods on
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001220an object, trusting that those methods will be there and raising an
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001221exception if they aren't. Be judicious in checking for ABCs and only
1222do it where it's absolutely necessary.
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001223
1224You can write your own ABCs by using ``abc.ABCMeta`` as the
1225metaclass in a class definition::
1226
Andrew M. Kuchling8315da42008-09-02 13:06:00 +00001227 from abc import ABCMeta, abstractmethod
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001228
1229 class Drawable():
1230 __metaclass__ = ABCMeta
Georg Brandle152a772008-05-24 18:31:28 +00001231
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001232 @abstractmethod
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001233 def draw(self, x, y, scale=1.0):
1234 pass
1235
1236 def draw_doubled(self, x, y):
1237 self.draw(x, y, scale=2.0)
1238
Georg Brandle152a772008-05-24 18:31:28 +00001239
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001240 class Square(Drawable):
1241 def draw(self, x, y, scale):
1242 ...
1243
Georg Brandle152a772008-05-24 18:31:28 +00001244
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001245In the :class:`Drawable` ABC above, the :meth:`draw_doubled` method
1246renders the object at twice its size and can be implemented in terms
1247of other methods described in :class:`Drawable`. Classes implementing
Georg Brandle152a772008-05-24 18:31:28 +00001248this ABC therefore don't need to provide their own implementation
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001249of :meth:`draw_doubled`, though they can do so. An implementation
Georg Brandle152a772008-05-24 18:31:28 +00001250of :meth:`draw` is necessary, though; the ABC can't provide
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001251a useful generic implementation.
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001252
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001253You can apply the ``@abstractmethod`` decorator to methods such as
1254:meth:`draw` that must be implemented; Python will then raise an
1255exception for classes that don't define the method.
Georg Brandle152a772008-05-24 18:31:28 +00001256Note that the exception is only raised when you actually
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001257try to create an instance of a subclass lacking the method::
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001258
Andrew M. Kuchling8315da42008-09-02 13:06:00 +00001259 >>> class Circle(Drawable):
1260 ... pass
1261 ...
1262 >>> c=Circle()
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001263 Traceback (most recent call last):
1264 File "<stdin>", line 1, in <module>
Andrew M. Kuchling8315da42008-09-02 13:06:00 +00001265 TypeError: Can't instantiate abstract class Circle with abstract methods draw
Georg Brandle152a772008-05-24 18:31:28 +00001266 >>>
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001267
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001268Abstract data attributes can be declared using the
1269``@abstractproperty`` decorator::
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001270
Andrew M. Kuchling8315da42008-09-02 13:06:00 +00001271 from abc import abstractproperty
1272 ...
1273
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00001274 @abstractproperty
1275 def readonly(self):
1276 return self._x
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001277
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001278Subclasses must then define a :meth:`readonly` property.
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001279
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001280.. seealso::
1281
1282 :pep:`3119` - Introducing Abstract Base Classes
1283 PEP written by Guido van Rossum and Talin.
Andrew M. Kuchling21852412008-04-05 18:15:30 +00001284 Implemented by Guido van Rossum.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001285 Backported to 2.6 by Benjamin Aranguren, with Alex Martelli.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001286
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001287.. ======================================================================
1288
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001289.. _pep-3127:
1290
1291PEP 3127: Integer Literal Support and Syntax
1292=====================================================
1293
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001294Python 3.0 changes the syntax for octal (base-8) integer literals,
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001295prefixing them with "0o" or "0O" instead of a leading zero, and adds
1296support for binary (base-2) integer literals, signalled by a "0b" or
1297"0B" prefix.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001298
Georg Brandle152a772008-05-24 18:31:28 +00001299Python 2.6 doesn't drop support for a leading 0 signalling
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001300an octal number, but it does add support for "0o" and "0b"::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001301
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001302 >>> 0o21, 2*8 + 1
1303 (17, 17)
1304 >>> 0b101111
1305 47
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001306
Georg Brandle152a772008-05-24 18:31:28 +00001307The :func:`oct` built-in still returns numbers
1308prefixed with a leading zero, and a new :func:`bin`
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001309built-in returns the binary representation for a number::
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001310
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001311 >>> oct(42)
1312 '052'
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001313 >>> future_builtins.oct(42)
1314 '0o52'
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001315 >>> bin(173)
1316 '0b10101101'
1317
1318The :func:`int` and :func:`long` built-ins will now accept the "0o"
1319and "0b" prefixes when base-8 or base-2 are requested, or when the
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001320*base* argument is zero (signalling that the base used should be
1321determined from the string):
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001322
1323 >>> int ('0o52', 0)
1324 42
1325 >>> int('1101', 2)
1326 13
1327 >>> int('0b1101', 2)
1328 13
1329 >>> int('0b1101', 0)
1330 13
1331
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001332
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001333.. seealso::
1334
1335 :pep:`3127` - Integer Literal Support and Syntax
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001336 PEP written by Patrick Maupin; backported to 2.6 by
1337 Eric Smith.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001338
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001339.. ======================================================================
1340
1341.. _pep-3129:
1342
1343PEP 3129: Class Decorators
1344=====================================================
1345
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001346Decorators have been extended from functions to classes. It's now legal to
1347write::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001348
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001349 @foo
1350 @bar
1351 class A:
1352 pass
1353
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001354This is equivalent to::
1355
1356 class A:
1357 pass
1358
1359 A = foo(bar(A))
1360
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001361.. seealso::
1362
1363 :pep:`3129` - Class Decorators
1364 PEP written by Collin Winter.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001365
1366.. ======================================================================
1367
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001368.. _pep-3141:
1369
1370PEP 3141: A Type Hierarchy for Numbers
1371=====================================================
1372
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001373Python 3.0 adds several abstract base classes for numeric types
1374inspired by Scheme's numeric tower. These classes were backported to
13752.6 as the :mod:`numbers` module.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001376
1377The most general ABC is :class:`Number`. It defines no operations at
1378all, and only exists to allow checking if an object is a number by
1379doing ``isinstance(obj, Number)``.
1380
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001381:class:`Complex` is a subclass of :class:`Number`. Complex numbers
1382can undergo the basic operations of addition, subtraction,
1383multiplication, division, and exponentiation, and you can retrieve the
Georg Brandle152a772008-05-24 18:31:28 +00001384real and imaginary parts and obtain a number's conjugate. Python's built-in
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001385complex type is an implementation of :class:`Complex`.
1386
Georg Brandle152a772008-05-24 18:31:28 +00001387:class:`Real` further derives from :class:`Complex`, and adds
1388operations that only work on real numbers: :func:`floor`, :func:`trunc`,
1389rounding, taking the remainder mod N, floor division,
1390and comparisons.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001391
1392:class:`Rational` numbers derive from :class:`Real`, have
1393:attr:`numerator` and :attr:`denominator` properties, and can be
Mark Dickinsond058cd22008-02-10 21:29:51 +00001394converted to floats. Python 2.6 adds a simple rational-number class,
Georg Brandle152a772008-05-24 18:31:28 +00001395:class:`Fraction`, in the :mod:`fractions` module. (It's called
1396:class:`Fraction` instead of :class:`Rational` to avoid
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001397a name clash with :class:`numbers.Rational`.)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001398
1399:class:`Integral` numbers derive from :class:`Rational`, and
Georg Brandle152a772008-05-24 18:31:28 +00001400can be shifted left and right with ``<<`` and ``>>``,
1401combined using bitwise operations such as ``&`` and ``|``,
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001402and can be used as array indexes and slice boundaries.
1403
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001404In Python 3.0, the PEP slightly redefines the existing built-ins
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001405:func:`round`, :func:`math.floor`, :func:`math.ceil`, and adds a new
Georg Brandle152a772008-05-24 18:31:28 +00001406one, :func:`math.trunc`, that's been backported to Python 2.6.
1407:func:`math.trunc` rounds toward zero, returning the closest
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001408:class:`Integral` that's between the function's argument and zero.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001409
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00001410.. seealso::
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001411
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001412 :pep:`3141` - A Type Hierarchy for Numbers
1413 PEP written by Jeffrey Yasskin.
1414
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001415 `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 +00001416
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00001417 `Scheme's number datatypes <http://schemers.org/Documents/Standards/R5RS/HTML/r5rs-Z-H-9.html#%_sec_6.2>`__ from the R5RS Scheme specification.
Georg Brandle152a772008-05-24 18:31:28 +00001418
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001419
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001420The :mod:`fractions` Module
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001421--------------------------------------------------
1422
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001423To fill out the hierarchy of numeric types, the :mod:`fractions`
1424module provides a rational-number class. Rational numbers store their
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001425values as a numerator and denominator forming a fraction, and can
1426exactly represent numbers such as ``2/3`` that floating-point numbers
1427can only approximate.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001428
Mark Dickinsond058cd22008-02-10 21:29:51 +00001429The :class:`Fraction` constructor takes two :class:`Integral` values
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001430that will be the numerator and denominator of the resulting fraction. ::
1431
Mark Dickinsond058cd22008-02-10 21:29:51 +00001432 >>> from fractions import Fraction
1433 >>> a = Fraction(2, 3)
1434 >>> b = Fraction(2, 5)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001435 >>> float(a), float(b)
1436 (0.66666666666666663, 0.40000000000000002)
1437 >>> a+b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001438 Fraction(16, 15)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001439 >>> a/b
Mark Dickinsoncd873fc2008-02-11 03:11:55 +00001440 Fraction(5, 3)
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001441
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001442For converting floating-point numbers to rationals,
1443the float type now has an :meth:`as_integer_ratio()` method that returns
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001444the numerator and denominator for a fraction that evaluates to the same
1445floating-point value::
1446
1447 >>> (2.5) .as_integer_ratio()
1448 (5, 2)
1449 >>> (3.1415) .as_integer_ratio()
1450 (7074029114692207L, 2251799813685248L)
1451 >>> (1./3) .as_integer_ratio()
1452 (6004799503160661L, 18014398509481984L)
1453
1454Note that values that can only be approximated by floating-point
1455numbers, such as 1./3, are not simplified to the number being
1456approximated; the fraction attempts to match the floating-point value
1457**exactly**.
1458
Mark Dickinsond058cd22008-02-10 21:29:51 +00001459The :mod:`fractions` module is based upon an implementation by Sjoerd
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001460Mullender that was in Python's :file:`Demo/classes/` directory for a
1461long time. This implementation was significantly updated by Jeffrey
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001462Yasskin.
Andrew M. Kuchlingaa355542008-01-16 03:17:25 +00001463
Brett Cannon4b964f92008-05-05 20:21:38 +00001464
Georg Brandl8ec7f652007-08-15 14:28:01 +00001465Other Language Changes
1466======================
1467
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001468Some smaller changes made to the core Python language are:
Georg Brandl8ec7f652007-08-15 14:28:01 +00001469
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00001470* The :func:`hasattr` function was catching and ignoring all errors,
Benjamin Peterson77cec6e2008-06-28 13:18:14 +00001471 under the assumption that they meant a :meth:`__getattr__` method
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001472 was failing somehow and the return value of :func:`hasattr` would
Benjamin Peterson77cec6e2008-06-28 13:18:14 +00001473 therefore be ``False``. This logic shouldn't be applied to
1474 :exc:`KeyboardInterrupt` and :exc:`SystemExit`, however; Python 2.6
1475 will no longer discard such exceptions when :func:`hasattr`
1476 encounters them. (Fixed by Benjamin Peterson; :issue:`2196`.)
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00001477
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001478* When calling a function using the ``**`` syntax to provide keyword
1479 arguments, you are no longer required to use a Python dictionary;
1480 any mapping will now work::
1481
1482 >>> def f(**kw):
1483 ... print sorted(kw)
Georg Brandle152a772008-05-24 18:31:28 +00001484 ...
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001485 >>> ud=UserDict.UserDict()
1486 >>> ud['a'] = 1
1487 >>> ud['b'] = 'string'
1488 >>> f(**ud)
1489 ['a', 'b']
1490
Andrew M. Kuchlingc157c9c2008-04-09 22:28:43 +00001491 (Contributed by Alexander Belopolsky; :issue:`1686487`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001492
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001493 It's also become legal to provide keyword arguments after a ``*args`` argument
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00001494 to a function call.
1495
1496 >>> def f(*args, **kw):
1497 ... print args, kw
1498 ...
1499 >>> f(1,2,3, *(4,5,6), keyword=13)
1500 (1, 2, 3, 4, 5, 6) {'keyword': 13}
1501
1502 Previously this would have been a syntax error.
1503 (Contributed by Amaury Forgeot d'Arc; :issue:`3473`.)
1504
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001505* A new built-in, ``next(iterator, [default])`` returns the next item
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001506 from the specified iterator. If the *default* argument is supplied,
1507 it will be returned if *iterator* has been exhausted; otherwise,
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001508 the :exc:`StopIteration` exception will be raised. (Backported
1509 in :issue:`2719`.)
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001510
Raymond Hettinger340383c2008-07-22 19:00:47 +00001511* Tuples now have :meth:`index` and :meth:`count` methods matching the
1512 list type's :meth:`index` and :meth:`count` methods::
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001513
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001514 >>> t = (0,1,2,3,4,0,1,2)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001515 >>> t.index(3)
1516 3
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001517 >>> t.count(0)
1518 2
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00001519
Raymond Hettinger340383c2008-07-22 19:00:47 +00001520 (Contributed by Raymond Hettinger)
1521
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001522* The built-in types now have improved support for extended slicing syntax,
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001523 accepting various combinations of ``(start, stop, step)``.
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001524 Previously, the support was partial and certain corner cases wouldn't work.
1525 (Implemented by Thomas Wouters.)
1526
Georg Brandlb19be572007-12-29 10:57:00 +00001527 .. Revision 57619
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001528
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001529* Properties now have three attributes, :attr:`getter`, :attr:`setter`
1530 and :attr:`deleter`, that are decorators providing useful shortcuts
1531 for adding a getter, setter or deleter function to an existing
1532 property. You would use them like this::
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001533
1534 class C(object):
Georg Brandle152a772008-05-24 18:31:28 +00001535 @property
1536 def x(self):
1537 return self._x
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001538
Georg Brandle152a772008-05-24 18:31:28 +00001539 @x.setter
1540 def x(self, value):
1541 self._x = value
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001542
Georg Brandle152a772008-05-24 18:31:28 +00001543 @x.deleter
1544 def x(self):
1545 del self._x
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001546
Christian Heimesff6cc6b2008-01-17 23:01:44 +00001547 class D(C):
1548 @C.x.getter
1549 def x(self):
1550 return self._x * 2
1551
1552 @x.setter
1553 def x(self, value):
1554 self._x = value / 2
1555
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001556* Several methods of the built-in set types now accept multiple iterables:
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00001557 :meth:`intersection`,
1558 :meth:`intersection_update`,
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001559 :meth:`union`, :meth:`update`,
1560 :meth:`difference` and :meth:`difference_update`.
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001561
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001562 ::
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001563
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001564 >>> s=set('1234567890')
1565 >>> s.intersection('abc123', 'cdf246') # Intersection between all inputs
1566 set(['2'])
1567 >>> s.difference('246', '789')
1568 set(['1', '0', '3', '5'])
1569
1570 (Contributed by Raymond Hettinger.)
1571
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001572* Many floating-point features were added. The :func:`float` function
Mark Dickinsonc72b7872008-06-24 11:08:58 +00001573 will now turn the string ``nan`` into an
1574 IEEE 754 Not A Number value, and ``+inf`` and ``-inf`` into
Georg Brandle152a772008-05-24 18:31:28 +00001575 positive or negative infinity. This works on any platform with
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001576 IEEE 754 semantics. (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00001577
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001578 Other functions in the :mod:`math` module, :func:`isinf` and
1579 :func:`isnan`, return true if their floating-point argument is
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001580 infinite or Not A Number. (:issue:`1640`)
Georg Brandle1b8e9c2008-02-20 19:12:36 +00001581
Andrew M. Kuchlingb2793a42008-08-07 01:47:34 +00001582 Conversion functions were added to convert floating-point numbers
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001583 into hexadecimal strings (:issue:`3008`). These functions
Andrew M. Kuchlingb2793a42008-08-07 01:47:34 +00001584 convert floats to and from a string representation without
1585 introducing rounding errors from the conversion between decimal and
1586 binary. Floats have a :meth:`hex` method that returns a string
1587 representation, and the ``float.fromhex()`` method converts a string
1588 back into a number::
1589
1590 >>> a = 3.75
1591 >>> a.hex()
1592 '0x1.e000000000000p+1'
1593 >>> float.fromhex('0x1.e000000000000p+1')
1594 3.75
1595 >>> b=1./3
1596 >>> b.hex()
1597 '0x1.5555555555555p-2'
Mark Dickinson7103aa42008-07-15 19:08:33 +00001598
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001599* A numerical nicety: when creating a complex number from two floats
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001600 on systems that support signed zeros (-0 and +0), the
1601 :func:`complex` constructor will now preserve the sign
1602 of the zero. (Fixed by Mark T. Dickinson; :issue:`1507`.)
1603
Andrew M. Kuchling86533772008-09-02 01:13:42 +00001604* Classes that inherit a :meth:`__hash__` method from a parent class
1605 can set ``__hash__ = None`` to indicate that the class isn't
1606 hashable. This will make ``hash(obj)`` raise a :exc:`TypeError`
1607 and the class will not be indicated as implementing the
1608 :class:`Hashable` ABC.
1609
1610 You should do this when you've defined a :meth:`__cmp__` or
1611 :meth:`__eq__` method that compares objects by their value rather
1612 than by identity. All objects have a default hash method that uses
1613 ``id(obj)`` as the hash value. There's no tidy way to remove the
1614 :meth:`__hash__` method inherited from a parent class, so
1615 assigning ``None`` was implemented as an override. At the
1616 C level, extensions can set ``tp_hash`` to
1617 :cfunc:`PyObject_HashNotImplemented`.
1618 (Fixed by Nick Coghlan and Amaury Forgeot d'Arc; :issue:`2235`.)
1619
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001620* Changes to the :class:`Exception` interface
Georg Brandle152a772008-05-24 18:31:28 +00001621 as dictated by :pep:`352` continue to be made. For 2.6,
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001622 the :attr:`message` attribute is being deprecated in favor of the
1623 :attr:`args` attribute.
1624
Georg Brandle152a772008-05-24 18:31:28 +00001625* The :exc:`GeneratorExit` exception now subclasses
1626 :exc:`BaseException` instead of :exc:`Exception`. This means
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001627 that an exception handler that does ``except Exception:``
Georg Brandle152a772008-05-24 18:31:28 +00001628 will not inadvertently catch :exc:`GeneratorExit`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001629 (Contributed by Chad Austin; :issue:`1537`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00001630
Georg Brandle152a772008-05-24 18:31:28 +00001631* Generator objects now have a :attr:`gi_code` attribute that refers to
1632 the original code object backing the generator.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001633 (Contributed by Collin Winter; :issue:`1473257`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00001634
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001635* The :func:`compile` built-in function now accepts keyword arguments
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001636 as well as positional parameters. (Contributed by Thomas Wouters;
1637 :issue:`1444529`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001638
Georg Brandle152a772008-05-24 18:31:28 +00001639* The :func:`complex` constructor now accepts strings containing
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001640 parenthesized complex numbers, meaning that ``complex(repr(cplx))``
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001641 will now round-trip values. For example, ``complex('(3+4j)')``
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001642 now returns the value (3+4j). (:issue:`1491866`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00001643
Georg Brandle152a772008-05-24 18:31:28 +00001644* The string :meth:`translate` method now accepts ``None`` as the
1645 translation table parameter, which is treated as the identity
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001646 transformation. This makes it easier to carry out operations
Raymond Hettingerd8dd86c2008-07-22 19:18:50 +00001647 that only delete characters. (Contributed by Bengt Richter and
1648 implemented by Raymond Hettinger; :issue:`1193128`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001649
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001650* The built-in :func:`dir` function now checks for a :meth:`__dir__`
1651 method on the objects it receives. This method must return a list
1652 of strings containing the names of valid attributes for the object,
1653 and lets the object control the value that :func:`dir` produces.
Georg Brandle152a772008-05-24 18:31:28 +00001654 Objects that have :meth:`__getattr__` or :meth:`__getattribute__`
Facundo Batistabd5b6232007-12-03 19:49:54 +00001655 methods can use this to advertise pseudo-attributes they will honor.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001656 (:issue:`1591665`)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001657
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001658* Instance method objects have new attributes for the object and function
1659 comprising the method; the new synonym for :attr:`im_self` is
1660 :attr:`__self__`, and :attr:`im_func` is also available as :attr:`__func__`.
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001661 The old names are still supported in Python 2.6, but are gone in 3.0.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001662
Georg Brandl8ec7f652007-08-15 14:28:01 +00001663* An obscure change: when you use the the :func:`locals` function inside a
1664 :keyword:`class` statement, the resulting dictionary no longer returns free
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001665 variables. (Free variables, in this case, are variables referenced in the
Georg Brandl8ec7f652007-08-15 14:28:01 +00001666 :keyword:`class` statement that aren't attributes of the class.)
1667
Georg Brandlb19be572007-12-29 10:57:00 +00001668.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001669
1670
1671Optimizations
1672-------------
1673
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001674* The :mod:`warnings` module has been rewritten in C. This makes
1675 it possible to invoke warnings from the parser, and may also
1676 make the interpreter's startup faster.
1677 (Contributed by Neal Norwitz and Brett Cannon; :issue:`1631171`.)
1678
Georg Brandlaf30b282008-01-15 06:55:56 +00001679* Type objects now have a cache of methods that can reduce
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001680 the work required to find the correct method implementation
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001681 for a particular class; once cached, the interpreter doesn't need to
Georg Brandle152a772008-05-24 18:31:28 +00001682 traverse base classes to figure out the right method to call.
1683 The cache is cleared if a base class or the class itself is modified,
1684 so the cache should remain correct even in the face of Python's dynamic
Andrew M. Kuchlinga01ed032008-01-15 01:55:32 +00001685 nature.
Georg Brandle152a772008-05-24 18:31:28 +00001686 (Original optimization implemented by Armin Rigo, updated for
1687 Python 2.6 by Kevin Jacobs; :issue:`1700288`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001688
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00001689 By default, this change is only applied to types that are included with
1690 the Python core. Extension modules may not necessarily be compatible with
1691 this cache,
1692 so they must explicitly add :cmacro:`Py_TPFLAGS_HAVE_VERSION_TAG`
1693 to the module's ``tp_flags`` field to enable the method cache.
1694 (To be compatible with the method cache, the extension module's code
1695 must not directly access and modify the ``tp_dict`` member of
1696 any of the types it implements. Most modules don't do this,
1697 but it's impossible for the Python interpreter to determine that.
1698 See :issue:`1878` for some discussion.)
1699
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001700* Function calls that use keyword arguments are significantly faster
1701 by doing a quick pointer comparison, usually saving the time of a
1702 full string comparison. (Contributed by Raymond Hettinger, after an
1703 initial implementation by Antoine Pitrou; :issue:`1819`.)
Andrew M. Kuchlingb2793a42008-08-07 01:47:34 +00001704
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00001705* All of the functions in the :mod:`struct` module have been rewritten in
1706 C, thanks to work at the Need For Speed sprint.
1707 (Contributed by Raymond Hettinger.)
1708
Andrew M. Kuchling4d028572008-08-31 02:24:08 +00001709* Some of the standard built-in types now set a bit in their type
1710 objects. This speeds up checking whether an object is a subclass of
1711 one of these types. (Contributed by Neal Norwitz.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001712
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00001713* Unicode strings now use faster code for detecting
Georg Brandle152a772008-05-24 18:31:28 +00001714 whitespace and line breaks; this speeds up the :meth:`split` method
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001715 by about 25% and :meth:`splitlines` by 35%.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001716 (Contributed by Antoine Pitrou.) Memory usage is reduced
1717 by using pymalloc for the Unicode string's data.
1718
1719* The ``with`` statement now stores the :meth:`__exit__` method on the stack,
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00001720 producing a small speedup. (Implemented by Jeffrey Yasskin.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001721
1722* To reduce memory usage, the garbage collector will now clear internal
1723 free lists when garbage-collecting the highest generation of objects.
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001724 This may return memory to the operating system sooner.
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00001725
Georg Brandlb19be572007-12-29 10:57:00 +00001726.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001727
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001728.. _new-26-interpreter:
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001729
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001730Interpreter Changes
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001731-------------------------------
1732
1733Two command-line options have been reserved for use by other Python
1734implementations. The :option:`-J` switch has been reserved for use by
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001735Jython for Jython-specific options, such as switches that are passed to
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001736the underlying JVM. :option:`-X` has been reserved for options
1737specific to a particular implementation of Python such as CPython,
1738Jython, or IronPython. If either option is used with Python 2.6, the
1739interpreter will report that the option isn't currently used.
1740
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001741Python can now be prevented from writing :file:`.pyc` or :file:`.pyo`
1742files by supplying the :option:`-B` switch to the Python interpreter,
1743or by setting the :envvar:`PYTHONDONTWRITEBYTECODE` environment
1744variable before running the interpreter. This setting is available to
1745Python programs as the ``sys.dont_write_bytecode`` variable, and
1746Python code can change the value to modify the interpreter's
1747behaviour. (Contributed by Neal Norwitz and Georg Brandl.)
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00001748
1749The encoding used for standard input, output, and standard error can
1750be specified by setting the :envvar:`PYTHONIOENCODING` environment
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00001751variable before running the interpreter. The value should be a string
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001752in the form ``<encoding>`` or ``<encoding>:<errorhandler>``.
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00001753The *encoding* part specifies the encoding's name, e.g. ``utf-8`` or
1754``latin-1``; the optional *errorhandler* part specifies
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00001755what to do with characters that can't be handled by the encoding,
1756and should be one of "error", "ignore", or "replace". (Contributed
1757by Martin von Loewis.)
1758
Andrew M. Kuchlingc161df62008-04-13 01:05:59 +00001759.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00001760
1761New, Improved, and Deprecated Modules
1762=====================================
1763
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001764As in every release, Python's standard library received a number of
1765enhancements and bug fixes. Here's a partial list of the most notable
1766changes, sorted alphabetically by module name. Consult the
1767:file:`Misc/NEWS` file in the source tree for a more complete list of
1768changes, or look through the Subversion logs for all the details.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001769
Georg Brandle152a772008-05-24 18:31:28 +00001770* (3.0-warning mode) Python 3.0 will feature a reorganized standard
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001771 library that will drop many outdated modules and rename others.
Georg Brandle152a772008-05-24 18:31:28 +00001772 Python 2.6 running in 3.0-warning mode will warn about these modules
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001773 when they are imported.
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001774
Andrew M. Kuchling3a1693a2008-05-15 01:10:24 +00001775 The list of deprecated modules is:
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001776 :mod:`audiodev`,
1777 :mod:`bgenlocations`,
1778 :mod:`buildtools`,
1779 :mod:`bundlebuilder`,
1780 :mod:`Canvas`,
1781 :mod:`compiler`,
1782 :mod:`dircache`,
1783 :mod:`dl`,
1784 :mod:`fpformat`,
1785 :mod:`gensuitemodule`,
1786 :mod:`ihooks`,
1787 :mod:`imageop`,
1788 :mod:`imgfile`,
1789 :mod:`linuxaudiodev`,
1790 :mod:`mhlib`,
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001791 :mod:`mimetools`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001792 :mod:`multifile`,
1793 :mod:`new`,
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001794 :mod:`pure`,
1795 :mod:`statvfs`,
1796 :mod:`sunaudiodev`,
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001797 :mod:`test.testall`, and
Andrew M. Kuchling09ed01f2008-05-19 03:03:46 +00001798 :mod:`toaiff`.
1799
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00001800* The :mod:`asyncore` and :mod:`asynchat` modules are
1801 being actively maintained again, and a number of patches and bugfixes
1802 were applied. (Maintained by Josiah Carlson; see :issue:`1736190` for
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00001803 one patch.)
1804
Benjamin Peterson5f671df2008-09-13 22:54:43 +00001805* The :mod:`bsddb` module also has a new maintainer, Jesús Cea, and the package
1806 is now available as a standalone package. The web page for the package is
1807 `www.jcea.es/programacion/pybsddb.htm
1808 <http://www.jcea.es/programacion/pybsddb.htm>`__.
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001809
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001810* The :mod:`bsddb.dbshelve` module now uses the highest pickling protocol
1811 available, instead of restricting itself to protocol 1.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001812 (Contributed by W. Barnes; :issue:`1551443`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001813
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001814* The :mod:`cgi` module will now read variables from the query string
1815 of an HTTP POST request. This makes it possible to use form actions
1816 with URLs that include query strings such as
1817 "/cgi-bin/add.py?category=1". (Contributed by Alexandre Fiori and
1818 Nubis; :issue:`1817`.)
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00001819
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001820* The :mod:`cmath` module underwent extensive revision,
1821 contributed by Mark Dickinson and Christian Heimes.
Georg Brandle152a772008-05-24 18:31:28 +00001822 Five new functions were added:
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001823
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001824 * :func:`polar` converts a complex number to polar form, returning
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001825 the modulus and argument of the complex number.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001826
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001827 * :func:`rect` does the opposite, turning a modulus, argument pair
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001828 back into the corresponding complex number.
1829
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001830 * :func:`phase` returns the argument (also called the angle) of a complex
1831 number.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001832
1833 * :func:`isnan` returns True if either
Georg Brandle152a772008-05-24 18:31:28 +00001834 the real or imaginary part of its argument is a NaN.
Andrew M. Kuchling2cede392008-04-20 16:54:02 +00001835
1836 * :func:`isinf` returns True if either the real or imaginary part of
1837 its argument is infinite.
1838
1839 The revisions also improved the numerical soundness of the
1840 :mod:`cmath` module. For all functions, the real and imaginary
1841 parts of the results are accurate to within a few units of least
1842 precision (ulps) whenever possible. See :issue:`1381` for the
1843 details. The branch cuts for :func:`asinh`, :func:`atanh`: and
1844 :func:`atan` have also been corrected.
1845
1846 The tests for the module have been greatly expanded; nearly 2000 new
1847 test cases exercise the algebraic functions.
Mark Dickinson53bd2e12008-04-19 20:31:16 +00001848
1849 On IEEE 754 platforms, the :mod:`cmath` module now handles IEEE 754
1850 special values and floating-point exceptions in a manner consistent
1851 with Annex 'G' of the C99 standard.
1852
Andrew M. Kuchling6d57c822007-10-23 20:55:47 +00001853* A new data type in the :mod:`collections` module: :class:`namedtuple(typename,
Georg Brandl8ec7f652007-08-15 14:28:01 +00001854 fieldnames)` is a factory function that creates subclasses of the standard tuple
1855 whose fields are accessible by name as well as index. For example::
1856
Georg Brandle152a772008-05-24 18:31:28 +00001857 >>> var_type = collections.namedtuple('variable',
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001858 ... 'id name type size')
1859 # Names are separated by spaces or commas.
1860 # 'id, name, type, size' would also work.
Raymond Hettinger366523c2007-12-14 18:12:21 +00001861 >>> var_type._fields
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001862 ('id', 'name', 'type', 'size')
Georg Brandl8ec7f652007-08-15 14:28:01 +00001863
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001864 >>> var = var_type(1, 'frequency', 'int', 4)
1865 >>> print var[0], var.id # Equivalent
1866 1 1
1867 >>> print var[2], var.type # Equivalent
1868 int int
Raymond Hettinger366523c2007-12-14 18:12:21 +00001869 >>> var._asdict()
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001870 {'size': 4, 'type': 'int', 'id': 1, 'name': 'frequency'}
Raymond Hettingere9b9b352008-02-15 21:21:25 +00001871 >>> v2 = var._replace(name='amplitude')
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001872 >>> v2
1873 variable(id=1, name='amplitude', type='int', size=4)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001874
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001875 Several places in the standard library that returned tuples have
1876 been modified to return :class:`namedtuple` instances. For example,
Georg Brandle152a772008-05-24 18:31:28 +00001877 the :meth:`Decimal.as_tuple` method now returns a named tuple with
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001878 :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
1879
Georg Brandl8ec7f652007-08-15 14:28:01 +00001880 (Contributed by Raymond Hettinger.)
1881
Georg Brandle152a772008-05-24 18:31:28 +00001882* Another change to the :mod:`collections` module is that the
Georg Brandle7d118a2007-12-08 11:05:05 +00001883 :class:`deque` type now supports an optional *maxlen* parameter;
Georg Brandle152a772008-05-24 18:31:28 +00001884 if supplied, the deque's size will be restricted to no more
Georg Brandle7d118a2007-12-08 11:05:05 +00001885 than *maxlen* items. Adding more items to a full deque causes
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00001886 old items to be discarded.
1887
1888 ::
1889
1890 >>> from collections import deque
1891 >>> dq=deque(maxlen=3)
1892 >>> dq
1893 deque([], maxlen=3)
1894 >>> dq.append(1) ; dq.append(2) ; dq.append(3)
1895 >>> dq
1896 deque([1, 2, 3], maxlen=3)
1897 >>> dq.append(4)
1898 >>> dq
1899 deque([2, 3, 4], maxlen=3)
1900
1901 (Contributed by Raymond Hettinger.)
1902
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001903* A new window method in the :mod:`curses` module,
1904 :meth:`chgat`, changes the display attributes for a certain number of
1905 characters on a single line. (Contributed by Fabian Kreutz.) ::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001906
Georg Brandle152a772008-05-24 18:31:28 +00001907 # Boldface text starting at y=0,x=21
Georg Brandl8ec7f652007-08-15 14:28:01 +00001908 # and affecting the rest of the line.
Georg Brandle152a772008-05-24 18:31:28 +00001909 stdscr.chgat(0,21, curses.A_BOLD)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001910
Andrew M. Kuchling4a2762d2008-01-20 00:00:38 +00001911 The :class:`Textbox` class in the :mod:`curses.textpad` module
1912 now supports editing in insert mode as well as overwrite mode.
1913 Insert mode is enabled by supplying a true value for the *insert_mode*
1914 parameter when creating the :class:`Textbox` instance.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001915
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001916* The :mod:`datetime` module's :meth:`strftime` methods now support a
1917 ``%f`` format code that expands to the number of microseconds in the
1918 object, zero-padded on
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001919 the left to six places. (Contributed by Skip Montanaro; :issue:`1158`.)
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001920
Georg Brandle152a772008-05-24 18:31:28 +00001921* The :mod:`decimal` module was updated to version 1.66 of
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001922 `the General Decimal Specification <http://www2.hursley.ibm.com/decimal/decarith.html>`__. New features
1923 include some methods for some basic mathematical functions such as
1924 :meth:`exp` and :meth:`log10`::
1925
1926 >>> Decimal(1).exp()
1927 Decimal("2.718281828459045235360287471")
1928 >>> Decimal("2.7182818").ln()
1929 Decimal("0.9999999895305022877376682436")
1930 >>> Decimal(1000).log10()
1931 Decimal("3")
1932
Georg Brandle152a772008-05-24 18:31:28 +00001933 The :meth:`as_tuple` method of :class:`Decimal` objects now returns a
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001934 named tuple with :attr:`sign`, :attr:`digits`, and :attr:`exponent` fields.
Georg Brandle152a772008-05-24 18:31:28 +00001935
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001936 (Implemented by Facundo Batista and Mark Dickinson. Named tuple
1937 support added by Raymond Hettinger.)
1938
Georg Brandle152a772008-05-24 18:31:28 +00001939* The :mod:`difflib` module's :class:`SequenceMatcher` class
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001940 now returns named tuples representing matches,
1941 with :attr:`a`, :attr:`b`, and :attr:`size` attributes.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001942 (Contributed by Raymond Hettinger.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001943
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001944* An optional ``timeout`` parameter, specifying a timeout measured in
1945 seconds, was added to the :class:`ftplib.FTP` class constructor as
1946 well as the :meth:`connect` method. (Added by Facundo Batista.)
1947 Also, the :class:`FTP` class's :meth:`storbinary` and
1948 :meth:`storlines` now take an optional *callback* parameter that
1949 will be called with each block of data after the data has been sent.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001950 (Contributed by Phil Schwartz; :issue:`1221598`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00001951
Georg Brandle152a772008-05-24 18:31:28 +00001952* The :func:`reduce` built-in function is also available in the
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001953 :mod:`functools` module. In Python 3.0, the built-in has been
1954 dropped and :func:`reduce` is only available from :mod:`functools`;
1955 currently there are no plans to drop the built-in in the 2.x series.
1956 (Patched by Christian Heimes; :issue:`1739906`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00001957
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001958* When possible, the :mod:`getpass` module will now use
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001959 :file:`/dev/tty` to print a prompt message and read the password,
1960 falling back to standard error and standard input. If the
1961 password may be echoed to the terminal, a warning is printed before
1962 the prompt is displayed. (Contributed by Gregory P. Smith.)
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001963
Georg Brandle152a772008-05-24 18:31:28 +00001964* The :func:`glob.glob` function can now return Unicode filenames if
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00001965 a Unicode path was used and Unicode filenames are matched within the
1966 directory. (:issue:`1001604`)
Georg Brandl8ec7f652007-08-15 14:28:01 +00001967
1968* The :mod:`gopherlib` module has been removed.
1969
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001970* A new function in the :mod:`heapq` module, ``merge(iter1, iter2, ...)``,
1971 takes any number of iterables returning data in sorted
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00001972 order, and returns a new generator that returns the contents of all
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001973 the iterators, also in sorted order. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00001974
1975 heapq.merge([1, 3, 5, 9], [2, 8, 16]) ->
1976 [1, 2, 3, 5, 8, 9, 16]
1977
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001978 Another new function, ``heappushpop(heap, item)``,
Georg Brandle152a772008-05-24 18:31:28 +00001979 pushes *item* onto *heap*, then pops off and returns the smallest item.
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00001980 This is more efficient than making a call to :func:`heappush` and then
1981 :func:`heappop`.
1982
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001983 :mod:`heapq` is now implemented to only use less-than comparison,
1984 instead of the less-than-or-equal comparison it previously used.
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001985 This makes :mod:`heapq`'s usage of a type match the
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00001986 :meth:`list.sort` method.
Georg Brandl8ec7f652007-08-15 14:28:01 +00001987 (Contributed by Raymond Hettinger.)
1988
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00001989* An optional ``timeout`` parameter, specifying a timeout measured in
1990 seconds, was added to the :class:`httplib.HTTPConnection` and
1991 :class:`HTTPSConnection` class constructors. (Added by Facundo
1992 Batista.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00001993
Georg Brandle152a772008-05-24 18:31:28 +00001994* Most of the :mod:`inspect` module's functions, such as
1995 :func:`getmoduleinfo` and :func:`getargs`, now return named tuples.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00001996 In addition to behaving like tuples, the elements of the return value
1997 can also be accessed as attributes.
1998 (Contributed by Raymond Hettinger.)
1999
Georg Brandle152a772008-05-24 18:31:28 +00002000 Some new functions in the module include
2001 :func:`isgenerator`, :func:`isgeneratorfunction`,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002002 and :func:`isabstract`.
2003
2004* The :mod:`itertools` module gained several new functions.
2005
2006 ``izip_longest(iter1, iter2, ...[, fillvalue])`` makes tuples from
2007 each of the elements; if some of the iterables are shorter than
2008 others, the missing values are set to *fillvalue*. For example::
Georg Brandl8ec7f652007-08-15 14:28:01 +00002009
2010 itertools.izip_longest([1,2,3], [1,2,3,4,5]) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002011 (1, 1), (2, 2), (3, 3), (None, 4), (None, 5)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002012
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002013 ``product(iter1, iter2, ..., [repeat=N])`` returns the Cartesian product
2014 of the supplied iterables, a set of tuples containing
2015 every possible combination of the elements returned from each iterable. ::
2016
2017 itertools.product([1,2,3], [4,5,6]) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002018 (1, 4), (1, 5), (1, 6),
Georg Brandle152a772008-05-24 18:31:28 +00002019 (2, 4), (2, 5), (2, 6),
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002020 (3, 4), (3, 5), (3, 6)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002021
2022 The optional *repeat* keyword argument is used for taking the
Georg Brandle152a772008-05-24 18:31:28 +00002023 product of an iterable or a set of iterables with themselves,
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002024 repeated *N* times. With a single iterable argument, *N*-tuples
2025 are returned::
2026
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00002027 itertools.product([1,2], repeat=3) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002028 (1, 1, 1), (1, 1, 2), (1, 2, 1), (1, 2, 2),
2029 (2, 1, 1), (2, 1, 2), (2, 2, 1), (2, 2, 2)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002030
2031 With two iterables, *2N*-tuples are returned. ::
2032
Andrew M. Kuchling60248342008-09-05 15:15:56 +00002033 itertools.product([1,2], [3,4], repeat=2) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002034 (1, 3, 1, 3), (1, 3, 1, 4), (1, 3, 2, 3), (1, 3, 2, 4),
Georg Brandle152a772008-05-24 18:31:28 +00002035 (1, 4, 1, 3), (1, 4, 1, 4), (1, 4, 2, 3), (1, 4, 2, 4),
2036 (2, 3, 1, 3), (2, 3, 1, 4), (2, 3, 2, 3), (2, 3, 2, 4),
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002037 (2, 4, 1, 3), (2, 4, 1, 4), (2, 4, 2, 3), (2, 4, 2, 4)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002038
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00002039 ``combinations(iterable, r)`` returns sub-sequences of length *r* from
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002040 the elements of *iterable*. ::
2041
2042 itertools.combinations('123', 2) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002043 ('1', '2'), ('1', '3'), ('2', '3')
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002044
2045 itertools.combinations('123', 3) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002046 ('1', '2', '3')
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002047
2048 itertools.combinations('1234', 3) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002049 ('1', '2', '3'), ('1', '2', '4'), ('1', '3', '4'),
2050 ('2', '3', '4')
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002051
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002052 ``permutations(iter[, r])`` returns all the permutations of length *r* of
Georg Brandle152a772008-05-24 18:31:28 +00002053 the iterable's elements. If *r* is not specified, it will default to the
Georg Brandlcb635652008-05-05 20:59:05 +00002054 number of elements produced by the iterable. ::
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002055
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002056 itertools.permutations([1,2,3,4], 2) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002057 (1, 2), (1, 3), (1, 4),
Georg Brandle152a772008-05-24 18:31:28 +00002058 (2, 1), (2, 3), (2, 4),
2059 (3, 1), (3, 2), (3, 4),
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002060 (4, 1), (4, 2), (4, 3)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002061
Andrew M. Kuchlingabf8e012008-04-08 21:22:53 +00002062 ``itertools.chain(*iterables)`` is an existing function in
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002063 :mod:`itertools` that gained a new constructor in Python 2.6.
Georg Brandle152a772008-05-24 18:31:28 +00002064 ``itertools.chain.from_iterable(iterable)`` takes a single
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002065 iterable that should return other iterables. :func:`chain` will
2066 then return all the elements of the first iterable, then
2067 all the elements of the second, and so on. ::
2068
2069 chain.from_iterable([[1,2,3], [4,5,6]]) ->
Andrew M. Kuchling48a937a2008-09-06 12:50:05 +00002070 1, 2, 3, 4, 5, 6
Georg Brandle152a772008-05-24 18:31:28 +00002071
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002072 (All contributed by Raymond Hettinger.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002073
Georg Brandle152a772008-05-24 18:31:28 +00002074* The :mod:`logging` module's :class:`FileHandler` class
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002075 and its subclasses :class:`WatchedFileHandler`, :class:`RotatingFileHandler`,
Georg Brandle152a772008-05-24 18:31:28 +00002076 and :class:`TimedRotatingFileHandler` now
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002077 have an optional *delay* parameter to their constructors. If *delay*
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002078 is true, opening of the log file is deferred until the first
2079 :meth:`emit` call is made. (Contributed by Vinay Sajip.)
2080
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002081 :class:`TimedRotatingFileHandler` also has a *utc* constructor
2082 parameter. If the argument is true, UTC time will be used
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002083 in determining when midnight occurs and in generating filenames;
2084 otherwise local time will be used.
2085
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002086* Several new functions were added to the :mod:`math` module:
Georg Brandl8ec7f652007-08-15 14:28:01 +00002087
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002088 * :func:`~math.isinf` and :func:`~math.isnan` determine whether a given float
2089 is a (positive or negative) infinity or a NaN (Not a Number), respectively.
2090
2091 * :func:`~math.copysign` copies the sign bit of an IEEE 754 number,
2092 returning the absolute value of *x* combined with the sign bit of
2093 *y*. For example, ``math.copysign(1, -0.0)`` returns -1.0.
2094 (Contributed by Christian Heimes.)
2095
2096 * :func:`~math.factorial` computes the factorial of a number.
2097 (Contributed by Raymond Hettinger; :issue:`2138`.)
2098
2099 * :func:`~math.fsum` adds up the stream of numbers from an iterable,
2100 and is careful to avoid loss of precision through using partial sums.
2101 (Contributed by Jean Brouwers, Raymond Hettinger, and Mark Dickinson;
2102 :issue:`2819`.)
2103
2104 * :func:`~math.acosh`, :func:`~math.asinh`
2105 and :func:`~math.atanh` compute the inverse hyperbolic functions.
2106
2107 * :func:`~math.log1p` returns the natural logarithm of *1+x*
2108 (base *e*).
2109
2110 * :func:`trunc` rounds a number toward zero, returning the closest
2111 :class:`Integral` that's between the function's argument and zero.
2112 Added as part of the backport of
2113 `PEP 3141's type hierarchy for numbers <#pep-3141>`__.
2114
2115* The :mod:`math` module has been improved to give more consistent
2116 behaviour across platforms, especially with respect to handling of
2117 floating-point exceptions and IEEE 754 special values.
2118
2119 Whenever possible, the module follows the recommendations of the C99
2120 standard about 754's special values. For example, ``sqrt(-1.)``
2121 should now give a :exc:`ValueError` across almost all platforms,
2122 while ``sqrt(float('NaN'))`` should return a NaN on all IEEE 754
2123 platforms. Where Annex 'F' of the C99 standard recommends signaling
2124 'divide-by-zero' or 'invalid', Python will raise :exc:`ValueError`.
2125 Where Annex 'F' of the C99 standard recommends signaling 'overflow',
2126 Python will raise :exc:`OverflowError`. (See :issue:`711019` and
2127 :issue:`1640`.)
2128
2129 (Contributed by Christian Heimes and Mark Dickinson.)
2130
Andrew M. Kuchling026bcce2008-09-17 12:57:04 +00002131* The :mod:`MimeWriter` module and :mod:`mimify` module
2132 have been deprecated; use the :mod:`email`
Georg Brandl4da1da02008-09-17 08:45:54 +00002133 package instead.
2134
Andrew M. Kuchling026bcce2008-09-17 12:57:04 +00002135* The :mod:`md5` module has been deprecated; use the :mod:`hashlib` module
Georg Brandl4da1da02008-09-17 08:45:54 +00002136 instead.
2137
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002138* :class:`mmap` objects now have a :meth:`rfind` method that searches for a
2139 substring beginning at the end of the string and searching
2140 backwards. The :meth:`find` method also gained an *end* parameter
2141 giving an index at which to stop searching.
Andrew M. Kuchling2686f4d2008-01-19 19:14:05 +00002142 (Contributed by John Lenton.)
2143
Georg Brandle152a772008-05-24 18:31:28 +00002144* The :mod:`operator` module gained a
2145 :func:`methodcaller` function that takes a name and an optional
2146 set of arguments, returning a callable that will call
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002147 the named function on any arguments passed to it. For example::
2148
2149 >>> # Equivalent to lambda s: s.replace('old', 'new')
2150 >>> replacer = operator.methodcaller('replace', 'old', 'new')
2151 >>> replacer('old wine in old bottles')
2152 'new wine in new bottles'
Georg Brandle152a772008-05-24 18:31:28 +00002153
Georg Brandl27504da2008-03-04 07:25:54 +00002154 (Contributed by Georg Brandl, after a suggestion by Gregory Petrosyan.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002155
2156 The :func:`attrgetter` function now accepts dotted names and performs
2157 the corresponding attribute lookups::
2158
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002159 >>> inst_name = operator.attrgetter(
2160 ... '__class__.__name__')
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002161 >>> inst_name('')
2162 'str'
2163 >>> inst_name(help)
2164 '_Helper'
2165
Georg Brandl27504da2008-03-04 07:25:54 +00002166 (Contributed by Georg Brandl, after a suggestion by Barry Warsaw.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002167
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002168* The :mod:`os` module now wraps several new system calls.
2169 ``fchmod(fd, mode)`` and ``fchown(fd, uid, gid)`` change the mode
2170 and ownership of an opened file, and ``lchmod(path, mode)`` changes
2171 the mode of a symlink. (Contributed by Georg Brandl and Christian
2172 Heimes.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002173
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002174 :func:`chflags` and :func:`lchflags` are wrappers for the
2175 corresponding system calls (where they're available), changing the
2176 flags set on a file. Constants for the flag values are defined in
2177 the :mod:`stat` module; some possible values include
2178 :const:`UF_IMMUTABLE` to signal the file may not be changed and
2179 :const:`UF_APPEND` to indicate that data can only be appended to the
2180 file. (Contributed by M. Levinson.)
2181
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00002182 ``os.closerange(low, high)`` efficiently closes all file descriptors
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002183 from *low* to *high*, ignoring any errors and not including *high* itself.
2184 This function is now used by the :mod:`subprocess` module to make starting
2185 processes faster. (Contributed by Georg Brandl; :issue:`1663329`.)
2186
2187* The ``os.environ`` object's :meth:`clear` method will now unset the
2188 environment variables using :func:`os.unsetenv` in addition to clearing
2189 the object's keys. (Contributed by Martin Horcicka; :issue:`1181`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002190
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002191* The :func:`os.walk` function now has a ``followlinks`` parameter. If
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002192 set to True, it will follow symlinks pointing to directories and
2193 visit the directory's contents. For backward compatibility, the
2194 parameter's default value is false. Note that the function can fall
2195 into an infinite recursion if there's a symlink that points to a
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002196 parent directory. (:issue:`1273829`)
Georg Brandle152a772008-05-24 18:31:28 +00002197
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002198* In the :mod:`os.path` module, the :func:`splitext` function
2199 has been changed to not split on leading period characters.
2200 This produces better results when operating on Unix's dot-files.
2201 For example, ``os.path.splitext('.ipython')``
2202 now returns ``('.ipython', '')`` instead of ``('', '.ipython')``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002203 (:issue:`115886`)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002204
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002205 A new function, ``os.path.relpath(path, start='.')``, returns a relative path
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002206 from the ``start`` path, if it's supplied, or from the current
2207 working directory to the destination ``path``. (Contributed by
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002208 Richard Barran; :issue:`1339796`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002209
Georg Brandle152a772008-05-24 18:31:28 +00002210 On Windows, :func:`os.path.expandvars` will now expand environment variables
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002211 given in the form "%var%", and "~user" will be expanded into the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002212 user's home directory path. (Contributed by Josiah Carlson;
2213 :issue:`957650`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002214
Georg Brandle152a772008-05-24 18:31:28 +00002215* The Python debugger provided by the :mod:`pdb` module
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002216 gained a new command: "run" restarts the Python program being debugged
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002217 and can optionally take new command-line arguments for the program.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002218 (Contributed by Rocky Bernstein; :issue:`1393667`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002219
Georg Brandl4da1da02008-09-17 08:45:54 +00002220* The :mod:`posixfile` module has been deprecated; :func:`fcntl.lockf`
2221 provides better locking.
2222
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002223 The :func:`post_mortem` function, used to begin debugging a
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002224 traceback, will now use the traceback returned by :func:`sys.exc_info`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002225 if no traceback is supplied. (Contributed by Facundo Batista;
2226 :issue:`1106316`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002227
Georg Brandle152a772008-05-24 18:31:28 +00002228* The :mod:`pickletools` module now has an :func:`optimize` function
2229 that takes a string containing a pickle and removes some unused
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002230 opcodes, returning a shorter pickle that contains the same data structure.
2231 (Contributed by Raymond Hettinger.)
2232
Andrew M. Kuchling026bcce2008-09-17 12:57:04 +00002233* The :mod:`popen2` module has been deprecated; use the :mod:`subprocess`
Georg Brandl4da1da02008-09-17 08:45:54 +00002234 module.
2235
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002236* A :func:`get_data` function was added to the :mod:`pkgutil`
2237 module that returns the contents of resource files included
2238 with an installed Python package. For example::
2239
Benjamin Peterson60ffcbe2008-04-21 22:57:00 +00002240 >>> import pkgutil
2241 >>> pkgutil.get_data('test', 'exception_hierarchy.txt')
2242 'BaseException
2243 +-- SystemExit
2244 +-- KeyboardInterrupt
2245 +-- GeneratorExit
2246 +-- Exception
2247 +-- StopIteration
2248 +-- StandardError
2249 ...'
Georg Brandle152a772008-05-24 18:31:28 +00002250 >>>
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002251
2252 (Contributed by Paul Moore; :issue:`2439`.)
2253
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002254* The :mod:`pyexpat` module's :class:`Parser` objects now allow setting
Georg Brandle152a772008-05-24 18:31:28 +00002255 their :attr:`buffer_size` attribute to change the size of the buffer
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002256 used to hold character data.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002257 (Contributed by Achim Gaedke; :issue:`1137`.)
Andrew M. Kuchlinge0a49b62008-01-08 14:30:55 +00002258
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002259* The :mod:`Queue` module now provides queue variants that retrieve entries
Georg Brandle152a772008-05-24 18:31:28 +00002260 in different orders. The :class:`PriorityQueue` class stores
2261 queued items in a heap and retrieves them in priority order,
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002262 and :class:`LifoQueue` retrieves the most recently added entries first,
2263 meaning that it behaves like a stack.
2264 (Contributed by Raymond Hettinger.)
2265
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002266* The :mod:`random` module's :class:`Random` objects can
2267 now be pickled on a 32-bit system and unpickled on a 64-bit
2268 system, and vice versa. Unfortunately, this change also means
2269 that Python 2.6's :class:`Random` objects can't be unpickled correctly
2270 on earlier versions of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002271 (Contributed by Shawn Ligocki; :issue:`1727780`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002272
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002273 The new ``triangular(low, high, mode)`` function returns random
2274 numbers following a triangular distribution. The returned values
Georg Brandle152a772008-05-24 18:31:28 +00002275 are between *low* and *high*, not including *high* itself, and
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002276 with *mode* as the most frequently occurring value
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002277 in the distribution. (Contributed by Wladmir van der Laan and
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002278 Raymond Hettinger; :issue:`1681432`.)
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002279
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002280* Long regular expression searches carried out by the :mod:`re`
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002281 module will check for signals being delivered, so
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002282 time-consuming searches can now be interrupted.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002283 (Contributed by Josh Hoyt and Ralf Schmitt; :issue:`846388`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002284
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002285 The regular expression module is implemented by compiling bytecodes
2286 for a tiny regex-specific virtual machine. Untrusted code
2287 could create malicious strings of bytecode directly and cause crashes,
2288 so Python 2.6 includes a verifier for the regex bytecode.
2289 (Contributed by Guido van Rossum from work for Google App Engine;
2290 :issue:`3487`.)
2291
Georg Brandl8ec7f652007-08-15 14:28:01 +00002292* The :mod:`rgbimg` module has been removed.
2293
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002294* The :mod:`rlcompleter` module's :meth:`Completer.complete()` method
2295 will now ignore exceptions triggered while evaluating a name.
2296 (Fixed by Lorenz Quack; :issue:`2250`.)
2297
Georg Brandle152a772008-05-24 18:31:28 +00002298* The :mod:`sched` module's :class:`scheduler` instances now
2299 have a read-only :attr:`queue` attribute that returns the
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002300 contents of the scheduler's queue, represented as a list of
Georg Brandl225163d2008-03-05 07:10:35 +00002301 named tuples with the fields ``(time, priority, action, argument)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002302 (Contributed by Raymond Hettinger; :issue:`1861`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002303
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002304* The :mod:`select` module now has wrapper functions
2305 for the Linux :cfunc:`epoll` and BSD :cfunc:`kqueue` system calls.
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002306 :meth:`modify` method was added to the existing :class:`poll`
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00002307 objects; ``pollobj.modify(fd, eventmask)`` takes a file descriptor
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002308 or file object and an event mask, modifying the recorded event mask
2309 for that file.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002310 (Contributed by Christian Heimes; :issue:`1657`.)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002311
Georg Brandle152a772008-05-24 18:31:28 +00002312* The :mod:`sets` module has been deprecated; it's better to
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002313 use the built-in :class:`set` and :class:`frozenset` types.
2314
Andrew M. Kuchlingb34c3f42008-09-17 13:04:53 +00002315* The :mod:`sha` module has been deprecated; use the :mod:`hashlib` module
2316 instead.
2317
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00002318* The :func:`shutil.copytree` function now has an optional *ignore* argument
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00002319 that takes a callable object. This callable will receive each directory path
2320 and a list of the directory's contents, and returns a list of names that
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002321 will be ignored, not copied.
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00002322
2323 The :mod:`shutil` module also provides an :func:`ignore_patterns`
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00002324 function for use with this new parameter. :func:`ignore_patterns`
2325 takes an arbitrary number of glob-style patterns and returns a
2326 callable that will ignore any files and directories that match any
2327 of these patterns. The following example copies a directory tree,
2328 but skips both :file:`.svn` directories and Emacs backup files,
2329 which have names ending with '~'::
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00002330
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002331 shutil.copytree('Doc/library', '/tmp/library',
Andrew M. Kuchling10cf7d92008-07-07 16:51:09 +00002332 ignore=shutil.ignore_patterns('*~', '.svn'))
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00002333
2334 (Contributed by Tarek Ziadé; :issue:`2663`.)
2335
Georg Brandle152a772008-05-24 18:31:28 +00002336* Integrating signal handling with GUI handling event loops
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002337 like those used by Tkinter or GTk+ has long been a problem; most
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002338 software ends up polling, waking up every fraction of a second to check
2339 if any GUI events have occurred.
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002340 The :mod:`signal` module can now make this more efficient.
2341 Calling ``signal.set_wakeup_fd(fd)`` sets a file descriptor
Georg Brandle152a772008-05-24 18:31:28 +00002342 to be used; when a signal is received, a byte is written to that
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002343 file descriptor. There's also a C-level function,
2344 :cfunc:`PySignal_SetWakeupFd`, for setting the descriptor.
2345
2346 Event loops will use this by opening a pipe to create two descriptors,
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002347 one for reading and one for writing. The writable descriptor
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002348 will be passed to :func:`set_wakeup_fd`, and the readable descriptor
2349 will be added to the list of descriptors monitored by the event loop via
2350 :cfunc:`select` or :cfunc:`poll`.
Georg Brandle152a772008-05-24 18:31:28 +00002351 On receiving a signal, a byte will be written and the main event loop
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002352 will be woken up, avoiding the need to poll.
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002353
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002354 (Contributed by Adam Olsen; :issue:`1583`.)
Andrew M. Kuchling2d60cf72007-12-22 17:27:02 +00002355
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002356 The :func:`siginterrupt` function is now available from Python code,
2357 and allows changing whether signals can interrupt system calls or not.
2358 (Contributed by Ralf Schmitt.)
2359
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002360 The :func:`setitimer` and :func:`getitimer` functions have also been
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002361 added (where they're available). :func:`setitimer`
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002362 allows setting interval timers that will cause a signal to be
2363 delivered to the process after a specified time, measured in
2364 wall-clock time, consumed process time, or combined process+system
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002365 time. (Contributed by Guilherme Polo; :issue:`2240`.)
Andrew M. Kuchlingb2ff8a72008-04-05 03:38:39 +00002366
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002367* The :mod:`smtplib` module now supports SMTP over SSL thanks to the
2368 addition of the :class:`SMTP_SSL` class. This class supports an
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002369 interface identical to the existing :class:`SMTP` class.
2370 (Contributed by Monty Taylor.) Both class constructors also have an
2371 optional ``timeout`` parameter that specifies a timeout for the
2372 initial connection attempt, measured in seconds. (Contributed by
2373 Facundo Batista.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002374
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002375 An implementation of the LMTP protocol (:rfc:`2033`) was also added
2376 to the module. LMTP is used in place of SMTP when transferring
2377 e-mail between agents that don't manage a mail queue. (LMTP
2378 implemented by Leif Hedstrom; :issue:`957003`.)
Andrew M. Kuchlingb4c62952007-09-01 21:18:31 +00002379
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002380 SMTP.starttls() now complies with :rfc:`3207` and forgets any
2381 knowledge obtained from the server not obtained from the TLS
2382 negotiation itself. (Patch contributed by Bill Fenner;
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002383 :issue:`829951`.)
Gregory P. Smith63bfc1d2008-01-17 07:43:20 +00002384
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002385* The :mod:`socket` module now supports TIPC (http://tipc.sf.net),
2386 a high-performance non-IP-based protocol designed for use in clustered
2387 environments. TIPC addresses are 4- or 5-tuples.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002388 (Contributed by Alberto Bertogli; :issue:`1646`.)
Andrew M. Kuchlingf60b6412008-01-19 16:34:09 +00002389
Georg Brandle152a772008-05-24 18:31:28 +00002390 A new function, :func:`create_connection`, takes an address
2391 and connects to it using an optional timeout value, returning
Andrew M. Kuchling04f58762008-04-15 02:24:15 +00002392 the connected socket object.
2393
Georg Brandle152a772008-05-24 18:31:28 +00002394* The base classes in the :mod:`SocketServer` module now support
2395 calling a :meth:`handle_timeout` method after a span of inactivity
2396 specified by the server's :attr:`timeout` attribute. (Contributed
2397 by Michael Pomraning.) The :meth:`serve_forever` method
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00002398 now takes an optional poll interval measured in seconds,
2399 controlling how often the server will check for a shutdown request.
Georg Brandle152a772008-05-24 18:31:28 +00002400 (Contributed by Pedro Werneck and Jeffrey Yasskin;
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002401 :issue:`742598`, :issue:`1193577`.)
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002402
Andrew M. Kuchlingb34c3f42008-09-17 13:04:53 +00002403* The :mod:`sqlite3` module, maintained by Gerhard Haering,
2404 has been updated from version 2.3.2 in Python 2.5 to
2405 version 2.4.1.
2406
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002407* The :mod:`struct` module now supports the C99 :ctype:`_Bool` type,
Georg Brandle152a772008-05-24 18:31:28 +00002408 using the format character ``'?'``.
Andrew M. Kuchling1d136bb2008-03-06 01:36:27 +00002409 (Contributed by David Remahl.)
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002410
2411* The :class:`Popen` objects provided by the :mod:`subprocess` module
2412 now have :meth:`terminate`, :meth:`kill`, and :meth:`send_signal` methods.
2413 On Windows, :meth:`send_signal` only supports the :const:`SIGTERM`
2414 signal, and all these methods are aliases for the Win32 API function
Georg Brandle152a772008-05-24 18:31:28 +00002415 :cfunc:`TerminateProcess`.
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002416 (Contributed by Christian Heimes.)
Georg Brandle152a772008-05-24 18:31:28 +00002417
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002418* A new variable in the :mod:`sys` module, :attr:`float_info`, is an
2419 object containing information derived from the :file:`float.h` file
2420 about the platform's floating-point support. Attributes of this
2421 object include :attr:`mant_dig` (number of digits in the mantissa),
2422 :attr:`epsilon` (smallest difference between 1.0 and the next
2423 largest value representable), and several others. (Contributed by
2424 Christian Heimes; :issue:`1534`.)
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002425
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00002426 Another new variable, :attr:`dont_write_bytecode`, controls whether Python
2427 writes any :file:`.pyc` or :file:`.pyo` files on importing a module.
2428 If this variable is true, the compiled files are not written. The
2429 variable is initially set on start-up by supplying the :option:`-B`
2430 switch to the Python interpreter, or by setting the
2431 :envvar:`PYTHONDONTWRITEBYTECODE` environment variable before
Georg Brandle152a772008-05-24 18:31:28 +00002432 running the interpreter. Python code can subsequently
Andrew M. Kuchling7b1e9172008-01-15 14:38:05 +00002433 change the value of this variable to control whether bytecode files
2434 are written or not.
2435 (Contributed by Neal Norwitz and Georg Brandl.)
2436
Georg Brandle152a772008-05-24 18:31:28 +00002437 Information about the command-line arguments supplied to the Python
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002438 interpreter is available by reading attributes of a named
2439 tuple available as ``sys.flags``. For example, the :attr:`verbose`
2440 attribute is true if Python
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002441 was executed in verbose mode, :attr:`debug` is true in debugging mode, etc.
2442 These attributes are all read-only.
2443 (Contributed by Christian Heimes.)
2444
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002445 A new function, :func:`getsizeof`, takes a Python object and returns
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002446 the amount of memory used by the object, measured in bytes. Built-in
2447 objects return correct results; third-party extensions may not,
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002448 but can define a :meth:`__sizeof__` method to return the
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002449 object's size.
2450 (Contributed by Robert Schuppenies; :issue:`2898`.)
2451
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002452 It's now possible to determine the current profiler and tracer functions
Georg Brandle152a772008-05-24 18:31:28 +00002453 by calling :func:`sys.getprofile` and :func:`sys.gettrace`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002454 (Contributed by Georg Brandl; :issue:`1648`.)
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002455
Lars Gustäbel55760912008-09-19 12:39:23 +00002456* The :mod:`tarfile` module now supports POSIX.1-2001 (pax) tarfiles in
2457 addition to the POSIX.1-1988 (ustar) and GNU tar formats that were
2458 already supported. The default format is GNU tar; specify the
2459 ``format`` parameter to open a file using a different format::
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002460
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002461 tar = tarfile.open("output.tar", "w",
2462 format=tarfile.PAX_FORMAT)
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002463
Lars Gustäbel55760912008-09-19 12:39:23 +00002464 The new ``encoding`` and ``errors`` parameters specify an encoding and
2465 an error handling scheme for character conversions. ``'strict'``,
2466 ``'ignore'``, and ``'replace'`` are the three standard ways Python can
2467 handle errors,;
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002468 ``'utf-8'`` is a special value that replaces bad characters with
2469 their UTF-8 representation. (Character conversions occur because the
2470 PAX format supports Unicode filenames, defaulting to UTF-8 encoding.)
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002471
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002472 The :meth:`TarFile.add` method now accepts an ``exclude`` argument that's
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002473 a function that can be used to exclude certain filenames from
Georg Brandle152a772008-05-24 18:31:28 +00002474 an archive.
2475 The function must take a filename and return true if the file
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002476 should be excluded or false if it should be archived.
2477 The function is applied to both the name initially passed to :meth:`add`
2478 and to the names of files in recursively-added directories.
Georg Brandle152a772008-05-24 18:31:28 +00002479
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002480 (All changes contributed by Lars Gustäbel).
2481
2482* An optional ``timeout`` parameter was added to the
2483 :class:`telnetlib.Telnet` class constructor, specifying a timeout
2484 measured in seconds. (Added by Facundo Batista.)
2485
Georg Brandle152a772008-05-24 18:31:28 +00002486* The :class:`tempfile.NamedTemporaryFile` class usually deletes
2487 the temporary file it created when the file is closed. This
2488 behaviour can now be changed by passing ``delete=False`` to the
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002489 constructor. (Contributed by Damien Miller; :issue:`1537850`.)
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002490
Georg Brandle152a772008-05-24 18:31:28 +00002491 A new class, :class:`SpooledTemporaryFile`, behaves like
2492 a temporary file but stores its data in memory until a maximum size is
2493 exceeded. On reaching that limit, the contents will be written to
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002494 an on-disk temporary file. (Contributed by Dustin J. Mitchell.)
2495
2496 The :class:`NamedTemporaryFile` and :class:`SpooledTemporaryFile` classes
Georg Brandle152a772008-05-24 18:31:28 +00002497 both work as context managers, so you can write
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002498 ``with tempfile.NamedTemporaryFile() as tmp: ...``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002499 (Contributed by Alexander Belopolsky; :issue:`2021`.)
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00002500
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002501* The :mod:`test.test_support` module now contains an
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002502 :func:`EnvironmentVarGuard`
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002503 context manager that temporarily changes environment variables and
Georg Brandle152a772008-05-24 18:31:28 +00002504 automatically restores them to their old values.
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002505
2506 Another context manager, :class:`TransientResource`, can surround calls
2507 to resources that may or may not be available; it will catch and
2508 ignore a specified list of exceptions. For example,
2509 a network test may ignore certain failures when connecting to an
2510 external web site::
2511
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002512 with test_support.TransientResource(IOError,
2513 errno=errno.ETIMEDOUT):
Georg Brandle152a772008-05-24 18:31:28 +00002514 f = urllib.urlopen('https://sf.net')
Andrew M. Kuchlingde37a8c2007-09-18 01:36:16 +00002515 ...
2516
2517 (Contributed by Brett Cannon.)
2518
Georg Brandle152a772008-05-24 18:31:28 +00002519* The :mod:`textwrap` module can now preserve existing whitespace
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002520 at the beginnings and ends of the newly-created lines
2521 by specifying ``drop_whitespace=False``
2522 as an argument::
2523
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002524 >>> S = """This sentence has a bunch of
2525 ... extra whitespace."""
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002526 >>> print textwrap.fill(S, width=15)
2527 This sentence
2528 has a bunch
2529 of extra
2530 whitespace.
2531 >>> print textwrap.fill(S, drop_whitespace=False, width=15)
2532 This sentence
2533 has a bunch
2534 of extra
2535 whitespace.
Georg Brandle152a772008-05-24 18:31:28 +00002536 >>>
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002537
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002538 (Contributed by Dwayne Bailey; :issue:`1581073`.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002539
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00002540* The :mod:`threading` module API is being changed to use properties
2541 such as :attr:`daemon` instead of :meth:`setDaemon` and
2542 :meth:`isDaemon` methods, and some methods have been renamed to use
2543 underscores instead of camel-case; for example, the
2544 :meth:`activeCount` method is renamed to :meth:`active_count`. Both
2545 the 2.6 and 3.0 versions of the module support the same properties
2546 and renamed methods, but don't remove the old methods. No date has been set
2547 for the deprecation of the old APIs in Python 3.x; the old APIs won't
2548 be removed in any 2.x version.
Benjamin Petersoncde6dc92008-09-03 21:48:20 +00002549 (Carried out by several people, most notably Benjamin Peterson.)
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002550
2551 The :mod:`threading` module's :class:`Thread` objects
2552 gained an :attr:`ident` property that returns the thread's
2553 identifier, a nonzero integer. (Contributed by Gregory P. Smith;
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002554 :issue:`2871`.)
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002555
Georg Brandle152a772008-05-24 18:31:28 +00002556* The :mod:`timeit` module now accepts callables as well as strings
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002557 for the statement being timed and for the setup code.
Georg Brandle152a772008-05-24 18:31:28 +00002558 Two convenience functions were added for creating
2559 :class:`Timer` instances:
2560 ``repeat(stmt, setup, time, repeat, number)`` and
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002561 ``timeit(stmt, setup, time, number)`` create an instance and call
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002562 the corresponding method. (Contributed by Erik Demaine;
2563 :issue:`1533909`.)
Andrew M. Kuchling6c066dd2007-09-01 20:43:36 +00002564
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002565* The :mod:`Tkinter` module now accepts lists and tuples for options,
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002566 separating the elements by spaces before passing the resulting value to
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002567 Tcl/Tk.
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00002568 (Contributed by Guilherme Polo; :issue:`2906`.)
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002569
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002570* The :mod:`turtle` module for turtle graphics was greatly enhanced by
2571 Gregor Lingl. New features in the module include:
2572
2573 * Better animation of turtle movement and rotation.
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002574 * Control over turtle movement using the new :meth:`delay`,
2575 :meth:`tracer`, and :meth:`speed` methods.
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002576 * The ability to set new shapes for the turtle, and to
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002577 define a new coordinate system.
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002578 * Turtles now have an :meth:`undo()` method that can roll back actions.
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002579 * Simple support for reacting to input events such as mouse and keyboard
2580 activity, making it possible to write simple games.
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002581 * A :file:`turtle.cfg` file can be used to customize the starting appearance
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002582 of the turtle's screen.
2583 * The module's docstrings can be replaced by new docstrings that have been
2584 translated into another language.
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002585
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002586 (:issue:`1513695`)
2587
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002588* An optional ``timeout`` parameter was added to the
2589 :func:`urllib.urlopen` function and the
Georg Brandle152a772008-05-24 18:31:28 +00002590 :class:`urllib.ftpwrapper` class constructor, as well as the
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002591 :func:`urllib2.urlopen` function. The parameter specifies a timeout
2592 measured in seconds. For example::
2593
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002594 >>> u = urllib2.urlopen("http://slow.example.com",
2595 timeout=3)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002596 Traceback (most recent call last):
2597 ...
2598 urllib2.URLError: <urlopen error timed out>
Georg Brandle152a772008-05-24 18:31:28 +00002599 >>>
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002600
Georg Brandle152a772008-05-24 18:31:28 +00002601 (Added by Facundo Batista.)
Andrew M. Kuchlingf10878b2007-09-13 22:49:34 +00002602
Georg Brandle152a772008-05-24 18:31:28 +00002603* The :mod:`warnings` module's :func:`formatwarning` and :func:`showwarning`
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002604 gained an optional *line* argument that can be used to supply the
2605 line of source code. (Added as part of :issue:`1631171`, which re-implemented
2606 part of the :mod:`warnings` module in C code.)
2607
2608* The XML-RPC :class:`SimpleXMLRPCServer` and :class:`DocXMLRPCServer`
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002609 classes can now be prevented from immediately opening and binding to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002610 their socket by passing True as the ``bind_and_activate``
2611 constructor parameter. This can be used to modify the instance's
Georg Brandle152a772008-05-24 18:31:28 +00002612 :attr:`allow_reuse_address` attribute before calling the
2613 :meth:`server_bind` and :meth:`server_activate` methods to
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002614 open the socket and begin listening for connections.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002615 (Contributed by Peter Parente; :issue:`1599845`.)
Andrew M. Kuchling99479eb2007-09-25 00:09:42 +00002616
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002617 :class:`SimpleXMLRPCServer` also has a :attr:`_send_traceback_header`
Georg Brandle152a772008-05-24 18:31:28 +00002618 attribute; if true, the exception and formatted traceback are returned
2619 as HTTP headers "X-Exception" and "X-Traceback". This feature is
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002620 for debugging purposes only and should not be used on production servers
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002621 because the tracebacks might reveal passwords or other sensitive
Georg Brandle152a772008-05-24 18:31:28 +00002622 information. (Contributed by Alan McIntyre as part of his
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002623 project for Google's Summer of Code 2007.)
2624
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002625* The :mod:`xmlrpclib` module no longer automatically converts
Georg Brandle152a772008-05-24 18:31:28 +00002626 :class:`datetime.date` and :class:`datetime.time` to the
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00002627 :class:`xmlrpclib.DateTime` type; the conversion semantics were
2628 not necessarily correct for all applications. Code using
Georg Brandle152a772008-05-24 18:31:28 +00002629 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
2630 instances. (:issue:`1330538`) The code can also handle
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002631 dates before 1900 (contributed by Ralf Schmitt; :issue:`2014`)
2632 and 64-bit integers represented by using ``<i8>`` in XML-RPC responses
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002633 (contributed by Riku Lindblad; :issue:`2985`).
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002634
Georg Brandle152a772008-05-24 18:31:28 +00002635* The :mod:`zipfile` module's :class:`ZipFile` class now has
2636 :meth:`extract` and :meth:`extractall` methods that will unpack
2637 a single file or all the files in the archive to the current directory, or
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002638 to a specified directory::
2639
2640 z = zipfile.ZipFile('python-251.zip')
2641
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00002642 # Unpack a single file, writing it relative
2643 # to the /tmp directory.
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002644 z.extract('Python/sysmodule.c', '/tmp')
2645
2646 # Unpack all the files in the archive.
2647 z.extractall()
2648
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002649 (Contributed by Alan McIntyre; :issue:`467924`.)
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00002650
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002651 The :meth:`open`, :meth:`read` and :meth:`extract` methods can now
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002652 take either a filename or a :class:`ZipInfo` object. This is useful when an
2653 archive accidentally contains a duplicated filename.
2654 (Contributed by Graham Horler; :issue:`1775025`.)
Andrew M. Kuchlingba290db2008-05-09 11:46:05 +00002655
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00002656 Finally, :mod:`zipfile` now supports using Unicode filenames
2657 for archived files. (Contributed by Alexey Borzenkov; :issue:`1734346`.)
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002658
Georg Brandlb19be572007-12-29 10:57:00 +00002659.. ======================================================================
2660.. whole new modules get described in subsections here
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00002661
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002662The :mod:`ast` module
2663----------------------
2664
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002665The :mod:`ast` module provides an Abstract Syntax Tree
2666representation of Python code, and Armin Ronacher
2667contributed a set of helper functions that perform a variety of
2668common tasks. These will be useful for HTML templating
2669packages, code analyzers, and similar tools that process
2670Python code.
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002671
2672The :func:`parse` function takes an expression and returns an AST.
2673The :func:`dump` function outputs a representation of a tree, suitable
2674for debugging::
2675
2676 import ast
2677
2678 t = ast.parse("""
2679 d = {}
2680 for i in 'abcdefghijklm':
2681 d[i + i] = ord(i) - ord('a') + 1
2682 print d
2683 """)
2684 print ast.dump(t)
2685
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002686This outputs a deeply nested tree::
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002687
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002688 Module(body=[
2689 Assign(targets=[
2690 Name(id='d', ctx=Store())
2691 ], value=Dict(keys=[], values=[]))
2692 For(target=Name(id='i', ctx=Store()),
2693 iter=Str(s='abcdefghijklm'), body=[
2694 Assign(targets=[
2695 Subscript(value=
2696 Name(id='d', ctx=Load()),
2697 slice=
2698 Index(value=
2699 BinOp(left=Name(id='i', ctx=Load()), op=Add(),
2700 right=Name(id='i', ctx=Load()))), ctx=Store())
2701 ], value=
2702 BinOp(left=
2703 BinOp(left=
2704 Call(func=
2705 Name(id='ord', ctx=Load()), args=[
2706 Name(id='i', ctx=Load())
2707 ], keywords=[], starargs=None, kwargs=None),
2708 op=Sub(), right=Call(func=
2709 Name(id='ord', ctx=Load()), args=[
2710 Str(s='a')
2711 ], keywords=[], starargs=None, kwargs=None)),
2712 op=Add(), right=Num(n=1)))
2713 ], orelse=[])
2714 Print(dest=None, values=[
2715 Name(id='d', ctx=Load())
2716 ], nl=True)
2717 ])
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002718
2719The :func:`literal_eval` method takes a string or an AST
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002720representing a literal expression, parses and evaluates it, and
2721returns the resulting value. A literal expression is a Python
2722expression containing only strings, numbers, dictionaries,
2723etc. but no statements or function calls. If you need to
2724evaluate an expression but accept the security risk of using an
2725:func:`eval` call, :func:`literal_eval` will handle it safely::
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002726
2727 >>> literal = '("a", "b", {2:4, 3:8, 1:2})'
2728 >>> print ast.literal_eval(literal)
2729 ('a', 'b', {1: 2, 2: 4, 3: 8})
2730 >>> print ast.literal_eval('"a" + "b"')
2731 Traceback (most recent call last):
2732 ...
2733 ValueError: malformed string
2734
Andrew M. Kuchlingaaca9782008-07-06 17:44:17 +00002735The module also includes :class:`NodeVisitor` and
2736:class:`NodeTransformer` classes for traversing and modifying an AST,
2737and functions for common transformations such as changing line
2738numbers.
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002739
2740.. ======================================================================
2741
2742The :mod:`future_builtins` module
2743--------------------------------------
2744
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002745Python 3.0 makes many changes to the repertoire of built-in
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002746functions, and most of the changes can't be introduced in the Python
27472.x series because they would break compatibility.
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002748The :mod:`future_builtins` module provides versions
2749of these built-in functions that can be imported when writing
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +000027503.0-compatible code.
2751
2752The functions in this module currently include:
2753
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00002754* ``ascii(obj)``: equivalent to :func:`repr`. In Python 3.0,
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002755 :func:`repr` will return a Unicode string, while :func:`ascii` will
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002756 return a pure ASCII bytestring.
2757
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00002758* ``filter(predicate, iterable)``,
2759 ``map(func, iterable1, ...)``: the 3.0 versions
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002760 return iterators, unlike the 2.x built-ins which return lists.
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002761
Andrew M. Kuchling3ff22752008-09-04 13:26:24 +00002762* ``hex(value)``, ``oct(value)``: instead of calling the
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002763 :meth:`__hex__` or :meth:`__oct__` methods, these versions will
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002764 call the :meth:`__index__` method and convert the result to hexadecimal
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002765 or octal. :func:`oct` will use the new ``0o`` notation for its
2766 result.
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002767
2768.. ======================================================================
2769
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002770The :mod:`json` module: JavaScript Object Notation
2771--------------------------------------------------------------------
Brett Cannon4b964f92008-05-05 20:21:38 +00002772
2773The new :mod:`json` module supports the encoding and decoding of Python types in
2774JSON (Javascript Object Notation). JSON is a lightweight interchange format
2775often used in web applications. For more information about JSON, see
2776http://www.json.org.
2777
2778:mod:`json` comes with support for decoding and encoding most builtin Python
2779types. The following example encodes and decodes a dictionary::
2780
2781 >>> import json
2782 >>> data = {"spam" : "foo", "parrot" : 42}
2783 >>> in_json = json.dumps(data) # Encode the data
2784 >>> in_json
2785 '{"parrot": 42, "spam": "foo"}'
2786 >>> json.loads(in_json) # Decode into a Python object
2787 {"spam" : "foo", "parrot" : 42}
2788
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002789It's also possible to write your own decoders and encoders to support
2790more types. Pretty-printing of the JSON strings is also supported.
Brett Cannon4b964f92008-05-05 20:21:38 +00002791
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002792:mod:`json` (originally called simplejson) was written by Bob
2793Ippolito.
Brett Cannon4b964f92008-05-05 20:21:38 +00002794
2795
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002796.. ======================================================================
2797
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002798The :mod:`plistlib` module: A Property-List Parser
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002799--------------------------------------------------
2800
Georg Brandl9af94982008-09-13 17:41:16 +00002801The ``.plist`` format is commonly used on Mac OS X to
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002802store basic data types (numbers, strings, lists,
2803and dictionaries) by serializing them into an XML-based format.
2804It resembles the XML-RPC serialization of data types.
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002805
Georg Brandl9af94982008-09-13 17:41:16 +00002806Despite being primarily used on Mac OS X, the format
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002807has nothing Mac-specific about it and the Python implementation works
2808on any platform that Python supports, so the :mod:`plistlib` module
2809has been promoted to the standard library.
2810
2811Using the module is simple::
2812
2813 import sys
2814 import plistlib
2815 import datetime
2816
2817 # Create data structure
2818 data_struct = dict(lastAccessed=datetime.datetime.now(),
2819 version=1,
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002820 categories=('Personal','Shared','Private'))
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002821
2822 # Create string containing XML.
2823 plist_str = plistlib.writePlistToString(data_struct)
2824 new_struct = plistlib.readPlistFromString(plist_str)
2825 print data_struct
2826 print new_struct
2827
2828 # Write data structure to a file and read it back.
2829 plistlib.writePlist(data_struct, '/tmp/customizations.plist')
2830 new_struct = plistlib.readPlist('/tmp/customizations.plist')
2831
2832 # read/writePlist accepts file-like objects as well as paths.
2833 plistlib.writePlist(data_struct, sys.stdout)
Georg Brandle152a772008-05-24 18:31:28 +00002834
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002835.. ======================================================================
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00002836
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +00002837ctypes Enhancements
2838--------------------------------------------------
2839
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002840Thomas Heller continued to maintain and enhance the
2841:mod:`ctypes` module.
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +00002842
2843:mod:`ctypes` now supports a :class:`c_bool` datatype
2844that represents the C99 ``bool`` type. (Contributed by David Remahl;
2845:issue:`1649190`.)
2846
2847The :mod:`ctypes` string, buffer and array types have improved
2848support for extended slicing syntax,
2849where various combinations of ``(start, stop, step)`` are supplied.
2850(Implemented by Thomas Wouters.)
2851
2852.. Revision 57769
2853
Andrew M. Kuchling488a4f02008-08-27 02:12:18 +00002854All :mod:`ctypes` data types now support
2855:meth:`from_buffer` and :meth:`from_buffer_copy`
2856methods that create a ctypes instance based on a
2857provided buffer object. :meth:`from_buffer_copy` copies
2858the contents of the object,
2859while :meth:`from_buffer` will share the same memory area.
2860
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +00002861A new calling convention tells :mod:`ctypes` to clear the ``errno`` or
2862Win32 LastError variables at the outset of each wrapped call.
2863(Implemented by Thomas Heller; :issue:`1798`.)
2864
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002865You can now retrieve the Unix ``errno`` variable after a function
2866call. When creating a wrapped function, you can supply
2867``use_errno=True`` as a keyword parameter to the :func:`DLL` function
2868and then call the module-level methods :meth:`set_errno` and
2869:meth:`get_errno` to set and retrieve the error value.
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +00002870
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002871The Win32 LastError variable is similarly supported by
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +00002872the :func:`DLL`, :func:`OleDLL`, and :func:`WinDLL` functions.
2873You supply ``use_last_error=True`` as a keyword parameter
2874and then call the module-level methods :meth:`set_last_error`
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002875and :meth:`get_last_error`.
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +00002876
2877The :func:`byref` function, used to retrieve a pointer to a ctypes
Andrew M. Kuchlingeaa29bb2008-08-30 22:56:54 +00002878instance, now has an optional *offset* parameter that is a byte
Andrew M. Kuchlingb93dc5f2008-07-13 21:43:52 +00002879count that will be added to the returned pointer.
2880
2881.. ======================================================================
2882
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002883Improved SSL Support
2884--------------------------------------------------
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002885
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002886Bill Janssen made extensive improvements to Python 2.6's support for
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002887the Secure Sockets Layer by adding a new module, :mod:`ssl`, that's
2888built atop the `OpenSSL <http://www.openssl.org/>`__ library.
2889This new module provides more control over the protocol negotiated,
2890the X.509 certificates used, and has better support for writing SSL
2891servers (as opposed to clients) in Python. The existing SSL support
2892in the :mod:`socket` module hasn't been removed and continues to work,
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002893though it will be removed in Python 3.0.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002894
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002895To use the new module, you must first create a TCP connection in the
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002896usual way and then pass it to the :func:`ssl.wrap_socket` function.
2897It's possible to specify whether a certificate is required, and to
2898obtain certificate info by calling the :meth:`getpeercert` method.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002899
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002900.. seealso::
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002901
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00002902 The documentation for the :mod:`ssl` module.
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002903
Georg Brandlb19be572007-12-29 10:57:00 +00002904.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00002905
2906
2907Build and C API Changes
2908=======================
2909
2910Changes to Python's build process and to the C API include:
2911
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002912* Python now must be compiled with C89 compilers (after 19
2913 years!). This means that the Python source tree has dropped its
2914 own implementations of :cfunc:`memmove` and :cfunc:`strerror`, which
2915 are in the C89 standard library.
2916
2917* Python 2.6 can be built with Microsoft Visual Studio 2008 (version
2918 9.0), and this is the new default compiler. See the
2919 :file:`PCbuild` directory for the build files. (Implemented by
2920 Christian Heimes.)
Andrew M. Kuchlingf7b462f2007-11-23 13:37:39 +00002921
Georg Brandl9af94982008-09-13 17:41:16 +00002922* On Mac OS X, Python 2.6 can be compiled as a 4-way universal build.
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00002923 The :program:`configure` script
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002924 can take a :option:`--with-universal-archs=[32-bit|64-bit|all]`
2925 switch, controlling whether the binaries are built for 32-bit
2926 architectures (x86, PowerPC), 64-bit (x86-64 and PPC-64), or both.
2927 (Contributed by Ronald Oussoren.)
2928
Georg Brandle152a772008-05-24 18:31:28 +00002929* The BerkeleyDB module now has a C API object, available as
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002930 ``bsddb.db.api``. This object can be used by other C extensions
2931 that wish to use the :mod:`bsddb` module for their own purposes.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002932 (Contributed by Duncan Grisby; :issue:`1551895`.)
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002933
Georg Brandle152a772008-05-24 18:31:28 +00002934* The new buffer interface, previously described in
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002935 `the PEP 3118 section <#pep-3118-revised-buffer-protocol>`__,
Martin v. Löwisf91d46a2008-08-12 14:49:50 +00002936 adds :cfunc:`PyObject_GetBuffer` and :cfunc:`PyBuffer_Release`,
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002937 as well as a few other functions.
Andrew M. Kuchling6edff592007-10-16 22:58:03 +00002938
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002939* Python's use of the C stdio library is now thread-safe, or at least
2940 as thread-safe as the underlying library is. A long-standing potential
Georg Brandle152a772008-05-24 18:31:28 +00002941 bug occurred if one thread closed a file object while another thread
2942 was reading from or writing to the object. In 2.6 file objects
2943 have a reference count, manipulated by the
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002944 :cfunc:`PyFile_IncUseCount` and :cfunc:`PyFile_DecUseCount`
Georg Brandle152a772008-05-24 18:31:28 +00002945 functions. File objects can't be closed unless the reference count
2946 is zero. :cfunc:`PyFile_IncUseCount` should be called while the GIL
2947 is still held, before carrying out an I/O operation using the
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002948 ``FILE *`` pointer, and :cfunc:`PyFile_DecUseCount` should be called
2949 immediately after the GIL is re-acquired.
2950 (Contributed by Antoine Pitrou and Gregory P. Smith.)
2951
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002952* Importing modules simultaneously in two different threads no longer
2953 deadlocks; it will now raise an :exc:`ImportError`. A new API
2954 function, :cfunc:`PyImport_ImportModuleNoBlock`, will look for a
2955 module in ``sys.modules`` first, then try to import it after
2956 acquiring an import lock. If the import lock is held by another
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002957 thread, an :exc:`ImportError` is raised.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002958 (Contributed by Christian Heimes.)
2959
Georg Brandle152a772008-05-24 18:31:28 +00002960* Several functions return information about the platform's
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002961 floating-point support. :cfunc:`PyFloat_GetMax` returns
2962 the maximum representable floating point value,
Georg Brandle152a772008-05-24 18:31:28 +00002963 and :cfunc:`PyFloat_GetMin` returns the minimum
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00002964 positive value. :cfunc:`PyFloat_GetInfo` returns an object
Andrew M. Kuchlingd5865592007-12-19 02:02:04 +00002965 containing more information from the :file:`float.h` file, such as
2966 ``"mant_dig"`` (number of digits in the mantissa), ``"epsilon"``
2967 (smallest difference between 1.0 and the next largest value
2968 representable), and several others.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002969 (Contributed by Christian Heimes; :issue:`1534`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00002970
Andrew M. Kuchlingd6b1eaf2008-06-20 02:05:57 +00002971* C functions and methods that use
2972 :cfunc:`PyComplex_AsCComplex` will now accept arguments that
2973 have a :meth:`__complex__` method. In particular, the functions in the
2974 :mod:`cmath` module will now accept objects with this method.
2975 This is a backport of a Python 3.0 change.
2976 (Contributed by Mark Dickinson; :issue:`1675423`.)
2977
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002978* Python's C API now includes two functions for case-insensitive string
Georg Brandl907a7202008-02-22 12:31:45 +00002979 comparisons, ``PyOS_stricmp(char*, char*)``
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002980 and ``PyOS_strnicmp(char*, char*, Py_ssize_t)``.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002981 (Contributed by Christian Heimes; :issue:`1635`.)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002982
Georg Brandle152a772008-05-24 18:31:28 +00002983* Many C extensions define their own little macro for adding
2984 integers and strings to the module's dictionary in the
2985 ``init*`` function. Python 2.6 finally defines standard macros
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002986 for adding values to a module, :cmacro:`PyModule_AddStringMacro`
Georg Brandle152a772008-05-24 18:31:28 +00002987 and :cmacro:`PyModule_AddIntMacro()`. (Contributed by
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00002988 Christian Heimes.)
2989
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002990* Some macros were renamed in both 3.0 and 2.6 to make it clearer that
2991 they are macros,
Andrew M. Kuchling3b554702008-01-04 02:31:40 +00002992 not functions. :cmacro:`Py_Size()` became :cmacro:`Py_SIZE()`,
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002993 :cmacro:`Py_Type()` became :cmacro:`Py_TYPE()`, and
Georg Brandle152a772008-05-24 18:31:28 +00002994 :cmacro:`Py_Refcnt()` became :cmacro:`Py_REFCNT()`.
Andrew M. Kuchling3710a132008-03-05 00:44:41 +00002995 The mixed-case macros are still available
2996 in Python 2.6 for backward compatibility.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00002997 (:issue:`1629`)
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00002998
Georg Brandle152a772008-05-24 18:31:28 +00002999* Distutils now places C extensions it builds in a
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00003000 different directory when running on a debug version of Python.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00003001 (Contributed by Collin Winter; :issue:`1530959`.)
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00003002
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00003003* Several basic data types, such as integers and strings, maintain
3004 internal free lists of objects that can be re-used. The data
3005 structures for these free lists now follow a naming convention: the
3006 variable is always named ``free_list``, the counter is always named
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00003007 ``numfree``, and a macro ``Py<typename>_MAXFREELIST`` is
Andrew M. Kuchling378586a2008-03-04 01:50:32 +00003008 always defined.
Andrew M. Kuchling0c3f1682008-01-26 13:50:51 +00003009
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00003010* A new Makefile target, "make check", prepares the Python source tree
Georg Brandle152a772008-05-24 18:31:28 +00003011 for making a patch: it fixes trailing whitespace in all modified
Andrew M. Kuchlingf68b5532008-04-09 01:08:32 +00003012 ``.py`` files, checks whether the documentation has been changed,
3013 and reports whether the :file:`Misc/ACKS` and :file:`Misc/NEWS` files
3014 have been updated.
3015 (Contributed by Brett Cannon.)
3016
Andrew M. Kuchling57ce0542008-04-21 02:14:24 +00003017 Another new target, "make profile-opt", compiles a Python binary
3018 using GCC's profile-guided optimization. It compiles Python with
3019 profiling enabled, runs the test suite to obtain a set of profiling
3020 results, and then compiles using these results for optimization.
3021 (Contributed by Gregory P. Smith.)
3022
Georg Brandlb19be572007-12-29 10:57:00 +00003023.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00003024
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00003025Port-Specific Changes: Windows
3026-----------------------------------
3027
Christian Heimes7e3ab452008-05-04 11:50:53 +00003028* The support for Windows 95, 98, ME and NT4 has been dropped.
3029 Python 2.6 requires at least Windows 2000 SP4.
3030
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00003031* The new default compiler on Windows is Visual Studio 2008 (version
3032 9.0). The build directories for Visual Studio 2003 (version 7.1) and
3033 2005 (version 8.0) were moved into the PC/ directory. The new
3034 :file:`PCbuild` directory supports cross compilation for X64, debug
3035 builds and Profile Guided Optimization (PGO). PGO builds are roughly
3036 10% faster than normal builds. (Contributed by Christian Heimes
3037 with help from Amaury Forgeot d'Arc and Martin von Loewis.)
3038
Georg Brandle152a772008-05-24 18:31:28 +00003039* The :mod:`msvcrt` module now supports
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00003040 both the normal and wide char variants of the console I/O
Georg Brandle152a772008-05-24 18:31:28 +00003041 API. The :func:`getwch` function reads a keypress and returns a Unicode
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00003042 value, as does the :func:`getwche` function. The :func:`putwch` function
3043 takes a Unicode character and writes it to the console.
Christian Heimesff6cc6b2008-01-17 23:01:44 +00003044 (Contributed by Christian Heimes.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00003045
Andrew M. Kuchlingba40fb42008-08-31 15:41:48 +00003046* :func:`os.path.expandvars` will now expand environment variables in
3047 the form "%var%", and "~user" will be expanded into the user's home
3048 directory path. (Contributed by Josiah Carlson; :issue:`957650`.)
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00003049
Georg Brandle152a772008-05-24 18:31:28 +00003050* The :mod:`socket` module's socket objects now have an
3051 :meth:`ioctl` method that provides a limited interface to the
Andrew M. Kuchlingd2219562008-01-17 12:00:15 +00003052 :cfunc:`WSAIoctl` system interface.
3053
Georg Brandle152a772008-05-24 18:31:28 +00003054* The :mod:`_winreg` module now has a function,
3055 :func:`ExpandEnvironmentStrings`,
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00003056 that expands environment variable references such as ``%NAME%``
3057 in an input string. The handle objects provided by this
Georg Brandle152a772008-05-24 18:31:28 +00003058 module now support the context protocol, so they can be used
Christian Heimesff6cc6b2008-01-17 23:01:44 +00003059 in :keyword:`with` statements. (Contributed by Christian Heimes.)
3060
Georg Brandle152a772008-05-24 18:31:28 +00003061 :mod:`_winreg` also has better support for x64 systems,
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00003062 exposing the :func:`DisableReflectionKey`, :func:`EnableReflectionKey`,
3063 and :func:`QueryReflectionKey` functions, which enable and disable
3064 registry reflection for 32-bit processes running on 64-bit systems.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00003065 (:issue:`1753245`)
Andrew M. Kuchling34be7ce2008-04-07 23:57:07 +00003066
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00003067* The :mod:`msilib` module's :class:`Record` object
3068 gained :meth:`GetInteger` and :meth:`GetString` methods that
3069 return field values as an integer or a string.
Andrew M. Kuchling6ba873c2008-06-20 23:43:12 +00003070 (Contributed by Floris Bruynooghe; :issue:`2125`.)
Andrew M. Kuchling7b2e2df2008-06-20 11:39:54 +00003071
Georg Brandlb19be572007-12-29 10:57:00 +00003072.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00003073
Georg Brandl9af94982008-09-13 17:41:16 +00003074Port-Specific Changes: Mac OS X
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00003075-----------------------------------
3076
Andrew M. Kuchlingd207e232008-08-27 00:27:18 +00003077* When compiling a framework build of Python, you can now specify the
3078 framework name to be used by providing the
3079 :option:`--with-framework-name=` option to the
Andrew M. Kuchlingb5a40dd2008-06-05 23:35:31 +00003080 :program:`configure` script.
3081
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00003082* The :mod:`macfs` module has been removed. This in turn required the
3083 :func:`macostools.touched` function to be removed because it depended on the
3084 :mod:`macfs` module. (:issue:`1490190`)
3085
Georg Brandl9af94982008-09-13 17:41:16 +00003086* Many other Mac OS modules have been deprecated and will removed in
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00003087 Python 3.0:
3088 :mod:`_builtinSuites`,
3089 :mod:`aepack`,
3090 :mod:`aetools`,
3091 :mod:`aetypes`,
3092 :mod:`applesingle`,
3093 :mod:`appletrawmain`,
3094 :mod:`appletrunner`,
3095 :mod:`argvemulator`,
3096 :mod:`Audio_mac`,
3097 :mod:`autoGIL`,
3098 :mod:`Carbon`,
3099 :mod:`cfmfile`,
3100 :mod:`CodeWarrior`,
3101 :mod:`ColorPicker`,
3102 :mod:`EasyDialogs`,
3103 :mod:`Explorer`,
3104 :mod:`Finder`,
3105 :mod:`FrameWork`,
3106 :mod:`findertools`,
3107 :mod:`ic`,
3108 :mod:`icglue`,
3109 :mod:`icopen`,
3110 :mod:`macerrors`,
3111 :mod:`MacOS`,
3112 :mod:`macfs`,
3113 :mod:`macostools`,
3114 :mod:`macresource`,
3115 :mod:`MiniAEFrame`,
3116 :mod:`Nav`,
3117 :mod:`Netscape`,
3118 :mod:`OSATerminology`,
3119 :mod:`pimp`,
3120 :mod:`PixMapWrapper`,
3121 :mod:`StdSuites`,
3122 :mod:`SystemEvents`,
3123 :mod:`Terminal`, and
3124 :mod:`terminalcommand`.
3125
3126.. ======================================================================
3127
3128Port-Specific Changes: IRIX
3129-----------------------------------
3130
3131A number of old IRIX-specific modules were deprecated and will
3132be removed in Python 3.0:
3133:mod:`al` and :mod:`AL`,
3134:mod:`cd`,
3135:mod:`cddb`,
3136:mod:`cdplayer`,
3137:mod:`CL` and :mod:`cl`,
3138:mod:`DEVICE`,
3139:mod:`ERRNO`,
3140:mod:`FILE`,
3141:mod:`FL` and :mod:`fl`,
3142:mod:`flp`,
3143:mod:`fm`,
3144:mod:`GET`,
3145:mod:`GLWS`,
3146:mod:`GL` and :mod:`gl`,
3147:mod:`IN`,
3148:mod:`IOCTL`,
3149:mod:`jpeg`,
3150:mod:`panelparser`,
3151:mod:`readcd`,
3152:mod:`SV` and :mod:`sv`,
3153:mod:`torgb`,
3154:mod:`videoreader`, and
3155:mod:`WAIT`.
3156
Georg Brandlb19be572007-12-29 10:57:00 +00003157.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00003158
3159
3160Porting to Python 2.6
3161=====================
3162
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00003163This section lists previously described changes and other bugfixes
3164that may require changes to your code:
Georg Brandl8ec7f652007-08-15 14:28:01 +00003165
Andrew M. Kuchling86533772008-09-02 01:13:42 +00003166* Classes that aren't supposed to be hashable should
3167 set ``__hash__ = None`` in their definitions to indicate
3168 the fact.
3169
Andrew M. Kuchling73835bd2008-01-04 18:24:41 +00003170* The :meth:`__init__` method of :class:`collections.deque`
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00003171 now clears any existing contents of the deque
3172 before adding elements from the iterable. This change makes the
Andrew M. Kuchlingfa881f22008-08-31 14:29:31 +00003173 behavior match ``list.__init__()``.
Andrew M. Kuchling654ede72008-01-04 01:16:12 +00003174
Andrew M. Kuchling687dfd22008-09-15 13:08:32 +00003175* :meth:`object.__init__` previously accepted arbitrary arguments and
3176 keyword arguments, ignoring them. In Python 2.6, this is no longer
3177 allowed and will result in a :exc:`TypeError`. This will affect
3178 :meth:`__init__` methods that end up calling the corresponding
3179 method on :class:`object` (perhaps through using :func:`super`).
3180 See :issue:`1683368` for discussion.
Benjamin Petersonc2723622008-09-15 02:53:23 +00003181
Georg Brandle152a772008-05-24 18:31:28 +00003182* The :class:`Decimal` constructor now accepts leading and trailing
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00003183 whitespace when passed a string. Previously it would raise an
3184 :exc:`InvalidOperation` exception. On the other hand, the
3185 :meth:`create_decimal` method of :class:`Context` objects now
Georg Brandle152a772008-05-24 18:31:28 +00003186 explicitly disallows extra whitespace, raising a
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00003187 :exc:`ConversionSyntax` exception.
3188
Georg Brandle152a772008-05-24 18:31:28 +00003189* Due to an implementation accident, if you passed a file path to
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00003190 the built-in :func:`__import__` function, it would actually import
Georg Brandle152a772008-05-24 18:31:28 +00003191 the specified file. This was never intended to work, however, and
3192 the implementation now explicitly checks for this case and raises
Andrew M. Kuchling2e463552008-01-15 01:47:32 +00003193 an :exc:`ImportError`.
3194
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00003195* C API: the :cfunc:`PyImport_Import` and :cfunc:`PyImport_ImportModule`
Georg Brandle152a772008-05-24 18:31:28 +00003196 functions now default to absolute imports, not relative imports.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00003197 This will affect C extensions that import other modules.
3198
Andrew M. Kuchling86533772008-09-02 01:13:42 +00003199* C API: extension data types that shouldn't be hashable
3200 should define their ``tp_hash`` slot to
3201 :cfunc:`PyObject_HashNotImplemented`.
3202
Andrew M. Kuchlinge34d2892007-10-20 19:35:18 +00003203* The :mod:`socket` module exception :exc:`socket.error` now inherits
3204 from :exc:`IOError`. Previously it wasn't a subclass of
3205 :exc:`StandardError` but now it is, through :exc:`IOError`.
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00003206 (Implemented by Gregory P. Smith; :issue:`1706815`.)
Georg Brandl8ec7f652007-08-15 14:28:01 +00003207
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00003208* The :mod:`xmlrpclib` module no longer automatically converts
Georg Brandle152a772008-05-24 18:31:28 +00003209 :class:`datetime.date` and :class:`datetime.time` to the
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00003210 :class:`xmlrpclib.DateTime` type; the conversion semantics were
3211 not necessarily correct for all applications. Code using
Georg Brandle152a772008-05-24 18:31:28 +00003212 :mod:`xmlrpclib` should convert :class:`date` and :class:`time`
Andrew M. Kuchling17f84292008-04-10 21:29:01 +00003213 instances. (:issue:`1330538`)
Andrew M. Kuchling085f75a2008-02-23 16:23:05 +00003214
Georg Brandle152a772008-05-24 18:31:28 +00003215* (3.0-warning mode) The :class:`Exception` class now warns
3216 when accessed using slicing or index access; having
Andrew M. Kuchling7c29aae2008-03-26 00:30:02 +00003217 :class:`Exception` behave like a tuple is being phased out.
3218
3219* (3.0-warning mode) inequality comparisons between two dictionaries
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00003220 or two objects that don't implement comparison methods are reported
3221 as warnings. ``dict1 == dict2`` still works, but ``dict1 < dict2``
3222 is being phased out.
Georg Brandle152a772008-05-24 18:31:28 +00003223
Andrew M. Kuchling9cf2f5d2008-03-20 22:49:26 +00003224 Comparisons between cells, which are an implementation detail of Python's
3225 scoping rules, also cause warnings because such comparisons are forbidden
3226 entirely in 3.0.
3227
Georg Brandlb19be572007-12-29 10:57:00 +00003228.. ======================================================================
Georg Brandl8ec7f652007-08-15 14:28:01 +00003229
3230
3231.. _acks:
3232
3233Acknowledgements
3234================
3235
Andrew M. Kuchling60248342008-09-05 15:15:56 +00003236The author would like to thank the following people for offering
3237suggestions, corrections and assistance with various drafts of this
3238article: Georg Brandl, Steve Brown, Nick Coghlan, Jim Jewett, Kent
3239Johnson, Chris Lambacher, Antoine Pitrou.
Georg Brandl8ec7f652007-08-15 14:28:01 +00003240