blob: 6db3d63d3db66ad9efd0242ec153c45530a5d8dd [file] [log] [blame]
Georg Brandlb80f5112012-09-30 09:11:58 +02001****************************
2 What's New In Python 3.4
3****************************
4
Georg Brandl3b80d342012-10-28 13:37:54 +01005.. :Author: Someone <email>
6 (uncomment if there is a principal author)
Georg Brandlb80f5112012-09-30 09:11:58 +02007
8.. Rules for maintenance:
9
Nick Coghlan03074fd2012-09-30 18:51:53 +053010 * Anyone can add text to this document, but the maintainer reserves the
11 right to rewrite any additions. In particular, for obscure or esoteric
12 features, the maintainer may reduce any addition to a simple reference to
13 the new documentation rather than explaining the feature inline.
Georg Brandlb80f5112012-09-30 09:11:58 +020014
Nick Coghlan03074fd2012-09-30 18:51:53 +053015 * While the maintainer will periodically go through Misc/NEWS
16 and add changes, it's best not to rely on this. We know from experience
17 that any changes that aren't in the What's New documentation around the
18 time of the original release will remain largely unknown to the community
19 for years, even if they're added later. We also know from experience that
20 other priorities can arise, and the maintainer will run out of time to do
21 updates - in such cases, end users will be much better served by partial
22 notifications that at least give a hint about new features to
23 investigate.
Georg Brandlb80f5112012-09-30 09:11:58 +020024
25 * This is not a complete list of every single change; completeness
Nick Coghlan03074fd2012-09-30 18:51:53 +053026 is the purpose of Misc/NEWS. The What's New should focus on changes that
27 are visible to Python *users* and that *require* a feature release (i.e.
28 most bug fixes should only be recorded in Misc/NEWS)
29
30 * PEPs should not be marked Final until they have an entry in What's New.
31 A placeholder entry that is just a section header and a link to the PEP
32 (e.g ":pep:`397` has been implemented") is acceptable. If a PEP has been
33 implemented and noted in What's New, don't forget to mark it as Final!
Georg Brandlb80f5112012-09-30 09:11:58 +020034
35 * If you want to draw your new text to the attention of the
36 maintainer, add 'XXX' to the beginning of the paragraph or
37 section.
38
Nick Coghlan03074fd2012-09-30 18:51:53 +053039 * It's OK to add just a very brief note about a change. For
40 example: "The :ref:`~socket.transmogrify()` function was added to the
41 :mod:`socket` module." The maintainer will research the change and
42 write the necessary text (if appropriate). The advantage of doing this
43 is that even if no more descriptive text is ever added, readers will at
44 least have a notification that the new feature exists and a link to the
45 relevant documentation.
Georg Brandlb80f5112012-09-30 09:11:58 +020046
47 * You can comment out your additions if you like, but it's not
48 necessary (especially when a final release is some months away).
49
50 * Credit the author of a patch or bugfix. Just the name is
51 sufficient; the e-mail address isn't necessary.
52
53 * It's helpful to add the bug/patch number as a comment:
54
Nick Coghlan03074fd2012-09-30 18:51:53 +053055 The :ref:`~socket.transmogrify()` function was added to the
56 :mod:`socket` module. (Contributed by P.Y. Developer in :issue:`12345`.)
Georg Brandlb80f5112012-09-30 09:11:58 +020057
58 This saves the maintainer the effort of going through the Mercurial log
59 when researching a change.
60
Nick Coghlan03074fd2012-09-30 18:51:53 +053061 * Cross referencing tip: :ref:`mod.attr` will display as ``mod.attr``,
62 while :ref:`~mod.attr` will display as ``attr``.
63
Georg Brandlb80f5112012-09-30 09:11:58 +020064This article explains the new features in Python 3.4, compared to 3.3.
65
Nick Coghlan03074fd2012-09-30 18:51:53 +053066.. Python 3.4 was released on TBD.
Georg Brandlb80f5112012-09-30 09:11:58 +020067
Ezio Melotti25bbe5e2012-11-17 19:30:48 +020068For full details, see the
69`changelog <http://docs.python.org/3.4/whatsnew/changelog.html>`_.
Georg Brandlb80f5112012-09-30 09:11:58 +020070
71.. note:: Prerelease users should be aware that this document is currently in
72 draft form. It will be updated substantially as Python 3.4 moves towards
73 release, so it's worth checking back even after reading earlier versions.
74
75
76.. seealso::
77
Nick Coghlan367df122013-10-27 01:57:34 +100078 :pep:`429` - Python 3.4 Release Schedule
Georg Brandlb80f5112012-09-30 09:11:58 +020079
80
81Summary -- Release highlights
82=============================
83
Kristjan Valur Jonssona1e82442013-03-26 13:56:14 +000084.. This section singles out the most important changes in Python 3.4.
Georg Brandlb80f5112012-09-30 09:11:58 +020085 Brevity is key.
86
87New syntax features:
88
Nick Coghlan0acceb72013-10-20 13:22:21 +100089* No new syntax features are planned for Python 3.4.
Georg Brandlb80f5112012-09-30 09:11:58 +020090
91New library modules:
92
Nick Coghlan0acceb72013-10-20 13:22:21 +100093* :mod:`asyncio`: New provisonal API for asynchronous IO (:pep:`3156`).
94* :mod:`enum`: Support for enumeration types (:pep:`435`).
Nick Coghland0cf0632013-11-11 22:11:55 +100095* :mod:`ensurepip`: Bootstrapping the pip installer (:pep:`453`).
Victor Stinner4aea4a02013-09-04 20:30:34 +020096* :mod:`selectors`: High-level and efficient I/O multiplexing, built upon the
97 :mod:`select` module primitives.
Nick Coghlan0acceb72013-10-20 13:22:21 +100098* :mod:`statistics`: A basic numerically stable statistics library (:pep:`450`).
Georg Brandlb80f5112012-09-30 09:11:58 +020099
Nick Coghlan367df122013-10-27 01:57:34 +1000100New expected features for Python implementations:
Georg Brandlb80f5112012-09-30 09:11:58 +0200101
Victor Stinnerdaf45552013-08-28 00:53:59 +0200102* :ref:`PEP 446: Make newly created file descriptors non-inheritable <pep-446>`.
Nick Coghlan367df122013-10-27 01:57:34 +1000103* command line option for :ref:`isolated mode <using-on-misc-options>`,
104 (:issue:`16499`).
Nick Coghlan8b097b42013-11-13 23:49:21 +1000105* improvements to handling of non-Unicode codecs
Georg Brandlb80f5112012-09-30 09:11:58 +0200106
107Significantly Improved Library Modules:
108
Nick Coghlan367df122013-10-27 01:57:34 +1000109* Single-dispatch generic functions in :mod:`functoools` (:pep:`443`)
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200110* SHA-3 (Keccak) support for :mod:`hashlib`.
111* TLSv1.1 and TLSv1.2 support for :mod:`ssl`.
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100112* :mod:`multiprocessing` now has option to avoid using :func:`os.fork`
113 on Unix (:issue:`8713`).
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200114
Nick Coghlan367df122013-10-27 01:57:34 +1000115CPython implementation improvements:
Georg Brandlb80f5112012-09-30 09:11:58 +0200116
Nick Coghlan367df122013-10-27 01:57:34 +1000117* :ref:`PEP 442: Safe object finalization <pep-442>`
118* :ref:`PEP 445: Configurable memory allocators <pep-445>`
Christian Heimes985ecdc2013-11-20 11:46:18 +0100119* :pep:`456` Secure and interchangeable hash algorithm
Nick Coghlan367df122013-10-27 01:57:34 +1000120* Improve finalization of Python modules to avoid setting their globals
121 to None, in most cases (:issue:`18214`).
122* A more efficient :mod:`marshal` format (:issue:`16475`).
123* "Argument Clinic", an initial step towards providing improved introspection
124 support for builtin and standard library extension types implemented in C
125 (:pep:`436`)
Georg Brandlb80f5112012-09-30 09:11:58 +0200126
127Please read on for a comprehensive list of user-facing changes.
128
Nick Coghland0cf0632013-11-11 22:11:55 +1000129
130PEP 453: Explicit bootstrapping of pip in Python installations
131==============================================================
132
133The new :mod:`ensurepip` module (defined in :pep:`453`) provides a standard
134cross-platform mechanism to boostrap the pip installer into Python
135installations and virtual environments.
136
137.. note::
138
139 Only the first phase of PEP 453 has been implemented at this point.
140 This section will be fleshed out with additional details once those
141 other changes are implemented.
142
143 Refer to :issue:`19347` for the progress on additional steps:
144
145 * ``make install`` and ``make altinstall`` integration
146 * Windows installer integration
147 * Mac OS X installer integration
148 * :mod:`venv` module and :command:`pyvenv` integration
149
150.. seealso::
151
152 :pep:`453` - Explicit bootstrapping of pip in Python installations
153 PEP written by Donald Stufft and Nick Coghlan, implemented by
154 Donald Stufft, Nick Coghlan (and ...).
155
156
Victor Stinnerdaf45552013-08-28 00:53:59 +0200157.. _pep-446:
158
159PEP 446: Make newly created file descriptors non-inheritable
160============================================================
161
Nick Coghlan367df122013-10-27 01:57:34 +1000162:pep:`446` makes newly created file descriptors :ref:`non-inheritable
Georg Brandl5642ff92013-09-15 10:37:57 +0200163<fd_inheritance>`. New functions and methods:
Victor Stinnerdaf45552013-08-28 00:53:59 +0200164
165* :func:`os.get_inheritable`, :func:`os.set_inheritable`
166* :func:`os.get_handle_inheritable`, :func:`os.set_handle_inheritable`
167* :meth:`socket.socket.get_inheritable`, :meth:`socket.socket.set_inheritable`
168
Antoine Pitrou796564c2013-07-30 19:59:21 +0200169.. seealso::
170
Nick Coghlan367df122013-10-27 01:57:34 +1000171 :pep:`446` - Make newly created file descriptors non-inheritable
172 PEP written and implemented by Victor Stinner.
Antoine Pitrou796564c2013-07-30 19:59:21 +0200173
Georg Brandlb80f5112012-09-30 09:11:58 +0200174
Nick Coghlan8b097b42013-11-13 23:49:21 +1000175Improvements to handling of non-Unicode codecs
176==============================================
177
178Since it was first introduced, the :mod:`codecs` module has always been
179intended to operate as a type-neutral dynamic encoding and decoding
180system. However, its close coupling with the Python text model, especially
181the type restricted convenience methods on the builtin :class:`str`,
182:class:`bytes` and :class:`bytearray` types, has historically obscured that
183fact.
184
185As a key step in clarifying the situation, the :meth:`codecs.encode` and
186:meth:`codecs.decode` convenience functions are now properly documented in
187Python 2.7, 3.3 and 3.4. These functions have existed in the :mod:`codecs`
188module and have been covered by the regression test suite since Python 2.4,
189but were previously only discoverable through runtime introspection.
190
191Unlike the convenience methods on :class:`str`, :class:`bytes` and
192:class:`bytearray`, these convenience functions support arbitrary codecs
193in both Python 2 and Python 3, rather than being limited to Unicode text
194encodings (in Python 3) or ``basestring`` <-> ``basestring`` conversions
195(in Python 2).
196
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000197In Python 3.4, the interpreter is able to identify the known non-text
198encodings provided in the standard library and direct users towards these
199general purpose convenience functions when appropriate::
Nick Coghlan8b097b42013-11-13 23:49:21 +1000200
201 >>> import codecs
202
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000203 >>> b"abcdef".decode("hex_codec")
Nick Coghlan8b097b42013-11-13 23:49:21 +1000204 Traceback (most recent call last):
205 File "<stdin>", line 1, in <module>
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000206 LookupError: 'hex_codec' is not a text encoding; use codecs.decode() to handle arbitrary codecs
Nick Coghlan8b097b42013-11-13 23:49:21 +1000207
208 >>> "hello".encode("rot_13")
209 Traceback (most recent call last):
210 File "<stdin>", line 1, in <module>
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000211 LookupError: 'rot_13' is not a text encoding; use codecs.encode() to handle arbitrary codecs
Nick Coghlan8b097b42013-11-13 23:49:21 +1000212
213In a related change, whenever it is feasible without breaking backwards
214compatibility, exceptions raised during encoding and decoding operations
215will be wrapped in a chained exception of the same type that mentions the
216name of the codec responsible for producing the error::
217
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000218 >>> codecs.decode(b"abcdefgh", "hex_codec")
219 binascii.Error: Non-hexadecimal digit found
Nick Coghlan8b097b42013-11-13 23:49:21 +1000220
221 The above exception was the direct cause of the following exception:
222
223 Traceback (most recent call last):
224 File "<stdin>", line 1, in <module>
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000225 binascii.Error: decoding with 'hex_codec' codec failed (Error: Non-hexadecimal digit found)
Nick Coghlan8b097b42013-11-13 23:49:21 +1000226
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000227 >>> codecs.encode("hello", "bz2_codec")
Nick Coghlan8b097b42013-11-13 23:49:21 +1000228 TypeError: 'str' does not support the buffer interface
229
230 The above exception was the direct cause of the following exception:
231
232 Traceback (most recent call last):
233 File "<stdin>", line 1, in <module>
234 TypeError: encoding with 'bz2_codec' codec failed (TypeError: 'str' does not support the buffer interface)
235
Nick Coghlan8afc8f62013-11-22 23:00:22 +1000236(Contributed by Nick Coghlan in :issue:`17827`, :issue:`17828` and
237:issue:`19619`)
Nick Coghlan8b097b42013-11-13 23:49:21 +1000238
239
Georg Brandlb80f5112012-09-30 09:11:58 +0200240Other Language Changes
241======================
242
243Some smaller changes made to the core Python language are:
244
Ezio Melotti34808e22013-10-12 16:36:13 +0300245* Unicode database updated to UCD version 6.3.
Georg Brandlb80f5112012-09-30 09:11:58 +0200246
R David Murray9a2f1392013-06-28 13:31:19 -0400247* :func:`min` and :func:`max` now accept a *default* argument that can be used
248 to specify the value they return if the iterable they are evaluating has no
249 elements. Contributed by Julian Berman in :issue:`18111`.
Georg Brandlb80f5112012-09-30 09:11:58 +0200250
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200251* Module objects are now :mod:`weakref`'able.
252
Nick Coghlan0acceb72013-10-20 13:22:21 +1000253* Module ``__file__`` attributes (and related values) should now always
254 contain absolute paths by default, with the sole exception of
255 ``__main__.__file__`` when a script has been executed directly using
256 a relative path (Contributed by Brett Cannon in :issue:`18416`).
257
Serhiy Storchaka58cf6072013-11-19 11:32:41 +0200258* Now all the UTF-\* codecs (except UTF-7) reject surrogates during both
259 encoding and decoding unless the ``surrogatepass`` error handler is used,
260 with the exception of the UTF-16 decoder that accepts valid surrogate pairs,
261 and the UTF-16 encoder that produces them while encoding non-BMP characters.
262 Contributed by Victor Stinner, Kang-Hao (Kenny) Lu and Serhiy Storchaka in
263 :issue:`12892`.
264
Georg Brandlb80f5112012-09-30 09:11:58 +0200265
266New Modules
267===========
268
Nick Coghlan0acceb72013-10-20 13:22:21 +1000269
270asyncio
271-------
272
273The new :mod:`asyncio` module (defined in :pep:`3156`) provides a standard
274pluggable event loop model for Python, providing solid asynchronous IO
275support in the standard library, and making it easier for other event loop
276implementations to interoperate with the standard library and each other.
277
278For Python 3.4, this module is considered a :term:`provisional API`.
279
Nick Coghlan367df122013-10-27 01:57:34 +1000280.. seealso::
281
282 :pep:`3156` - Asynchronous IO Support Rebooted: the "asyncio" Module
283 PEP written and implementation led by Guido van Rossum.
284
Nick Coghlan0acceb72013-10-20 13:22:21 +1000285enum
286----
287
Nick Coghlan367df122013-10-27 01:57:34 +1000288The new :mod:`enum` module (defined in :pep:`435`) provides a standard
289implementation of enumeration types, allowing other modules (such as
290:mod:`socket`) to provide more informative error messages and better
291debugging support by replacing opaque integer constants with backwards
292compatible enumeration values.
293
294.. seealso::
295
296 :pep:`435` - Adding an Enum type to the Python standard library
297 PEP written by Barry Warsaw, Eli Bendersky and Ethan Furman,
298 implemented by Ethan Furman.
Nick Coghlan0acceb72013-10-20 13:22:21 +1000299
300
Charles-François Natali243d8d82013-09-04 19:02:49 +0200301selectors
302---------
Georg Brandlb80f5112012-09-30 09:11:58 +0200303
Nick Coghlan0acceb72013-10-20 13:22:21 +1000304The new :mod:`selectors` module (created as part of implementing :pep:`3156`)
305allows high-level and efficient I/O multiplexing, built upon the
306:mod:`select` module primitives.
307
308
309statistics
310----------
311
312The new :mod:`statistics` module (defined in :pep:`450`) offers some core
313statistics functionality directly in the standard library. This module
314supports calculation of the mean, median, mode, variance and standard
315deviation of a data series.
Georg Brandlb80f5112012-09-30 09:11:58 +0200316
Nick Coghlan367df122013-10-27 01:57:34 +1000317.. seealso::
318
319 :pep:`450` - Adding A Statistics Module To The Standard Library
320 PEP written and implemented by Steven D'Aprano
321
Georg Brandlb80f5112012-09-30 09:11:58 +0200322
323Improved Modules
324================
325
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200326aifc
327----
328
329The :meth:`~aifc.getparams` method now returns a namedtuple rather than a
330plain tuple. (Contributed by Claudiu Popa in :issue:`17818`.)
331
332
Serhiy Storchakaeaea5e92013-10-19 21:10:46 +0300333audioop
334-------
335
336Added support for 24-bit samples (:issue:`12866`).
337
338
Nick Coghland4fdbcc2013-11-14 00:24:31 +1000339base64
340------
341
342The encoding and decoding functions in :mod:`base64` now accept any
343:term:`bytes-like object` in cases where it previously required a
344:class:`bytes` or :class:`bytearray` instance (:issue`17839`)
345
346
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200347colorsys
348--------
349
350The number of digits in the coefficients for the RGB --- YIQ conversions have
351been expanded so that they match the FCC NTSC versions. The change in
352results should be less than 1% and may better match results found elsewhere.
353
R David Murray8e37d5d2013-04-13 14:49:48 -0400354
Nick Coghlanb4534ae2013-10-13 23:23:08 +1000355contextlib
356----------
357
Nick Coghlan240f86d2013-10-17 23:40:57 +1000358The new :class:`contextlib.suppress` context manager helps to clarify the
359intent of code that deliberately suppresses exceptions from a single
360statement. (Contributed by Raymond Hettinger in :issue:`15806` and
361Zero Piraeus in :issue:`19266`)
362
Victor Stinner6633c392013-10-21 13:27:11 +0200363The new :func:`contextlib.redirect_stdout` context manager makes it easier
Nick Coghlanb4534ae2013-10-13 23:23:08 +1000364for utility scripts to handle inflexible APIs that don't provide any
365options to retrieve their output as a string or direct it to somewhere
Nick Coghlan0acceb72013-10-20 13:22:21 +1000366other than :data:`sys.stdout`. In conjunction with :class:`io.StringIO`,
367this context manager is also useful for checking expected output from
368command line utilities. (Contribute by Raymond Hettinger in :issue:`15805`)
369
370The :mod:`contextlib` documentation has also been updated to include a
371:ref:`discussion <single-use-reusable-and-reentrant-cms>` of the
372differences between single use, reusable and reentrant context managers.
Nick Coghlanb4534ae2013-10-13 23:23:08 +1000373
374
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000375dis
376---
377
Serhiy Storchaka98b28fd2013-10-13 23:12:09 +0300378The :mod:`dis` module is now built around an :class:`~dis.Instruction` class
379that provides details of individual bytecode operations and a
380:func:`~dis.get_instructions` iterator that emits the Instruction stream for a
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000381given piece of Python code. The various display tools in the :mod:`dis`
382module have been updated to be based on these new components.
383
384The new :class:`dis.Bytecode` class provides an object-oriented API for
385inspecting bytecode, both in human-readable form and for iterating over
386instructions.
387
Nick Coghlan50c48b82013-11-23 00:57:00 +1000388(Contributed by Nick Coghlan, Ryan Kelly and Thomas Kluyver in :issue:`11816`
389and Claudiu Popa in :issue:`17916`)
Nick Coghlanb39fd0c2013-05-06 23:59:20 +1000390
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200391
R David Murray5a9d7062012-11-21 15:09:21 -0500392doctest
393-------
394
R David Murray5707d502013-06-23 14:24:13 -0400395Added :data:`~doctest.FAIL_FAST` flag to halt test running as soon as the first
396failure is detected. (Contributed by R. David Murray and Daniel Urban in
397:issue:`16522`.)
398
399Updated the doctest command line interface to use :mod:`argparse`, and added
400``-o`` and ``-f`` options to the interface. ``-o`` allows doctest options to
401be specified on the command line, and ``-f`` is a shorthand for ``-o
402FAIL_FAST`` (to parallel the similar option supported by the :mod:`unittest`
403CLI). (Contributed by R. David Murray in :issue:`11390`.)
Georg Brandlb80f5112012-09-30 09:11:58 +0200404
R David Murray8e37d5d2013-04-13 14:49:48 -0400405
R David Murraybb17d2b2013-08-09 16:15:28 -0400406email
407-----
408
409:meth:`~email.message.Message.as_string` now accepts a *policy* argument to
410override the default policy of the message when generating a string
411representation of it. This means that ``as_string`` can now be used in more
412circumstances, instead of having to create and use a :mod:`~email.generator` in
413order to pass formatting parameters to its ``flatten`` method.
414
415New method :meth:`~email.message.Message.as_bytes` added to produce a bytes
416representation of the message in a fashion similar to how ``as_string``
417produces a string representation. It does not accept the *maxheaderlen*
418argument, but does accept the *unixfrom* and *policy* arguments. The
419:class:`~email.message.Message` :meth:`~email.message.Message.__bytes__` method
420calls it, meaning that ``bytes(mymsg)`` will now produce the intuitive
421result: a bytes object containing the fully formatted message.
422
423(Contributed by R. David Murray in :issue:`18600`.)
424
R David Murray3da240f2013-10-16 22:48:40 -0400425A pair of new subclasses of :class:`~email.message.Message` have been added,
426along with a new sub-module, :mod:`~email.contentmanager`. All documentation
427is currently in the new module, which is being added as part of the new
Nick Coghlan240f86d2013-10-17 23:40:57 +1000428:term:`provisional <provisional package>` email API. These classes provide a
R David Murray3da240f2013-10-16 22:48:40 -0400429number of new methods that make extracting content from and inserting content
430into email messages much easier. See the :mod:`~email.contentmanager`
431documentation for details.
432
433These API additions complete the bulk of the work that was planned as part of
434the email6 project. The currently provisional API is scheduled to become final
435in Python 3.5 (possibly with a few minor additions in the area of error
436handling).
437
438(Contributed by R. David Murray in :issue:`18891`.)
439
R David Murraybb17d2b2013-08-09 16:15:28 -0400440
Victor Stinner854ffcb2013-06-21 00:36:30 +0200441functools
442---------
443
Nick Coghlanf4cb48a2013-11-03 16:41:46 +1000444The new :func:`~functools.partialmethod` descriptor bring partial argument
445application to descriptors, just as :func:`~functools.partial` provides
446for normal callables. The new descriptor also makes it easier to get
447arbitrary callables (including :func:`~functools.partial` instances)
448to behave like normal instance methods when included in a class definition.
449
450(Contributed by Alon Horev and Nick Coghlan in :issue:`4331`)
451
452The new :func:`~functools.singledispatch` decorator brings support for
453single-dispatch generic functions to the Python standard library. Where
454object oriented programming focuses on grouping multiple operations on a
455common set of data into a class, a generic function focuses on grouping
456multiple implementations of an operation that allows it to work with
457*different* kinds of data.
458
459.. seealso::
460
461 :pep:`443` - Single-dispatch generic functions
462 PEP written and implemented by Łukasz Langa.
Victor Stinner854ffcb2013-06-21 00:36:30 +0200463
Nick Coghlane8c45d62013-07-28 20:00:01 +1000464
Christian Heimese92ef132013-10-13 00:52:43 +0200465hashlib
466-------
467
468New :func:`hashlib.pbkdf2_hmac` function.
469
470(Contributed by Christian Heimes in :issue:`18582`)
471
472
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200473inspect
474-------
475
Nick Coghlanf94a16b2013-09-22 22:46:49 +1000476
Nick Coghlan367df122013-10-27 01:57:34 +1000477The inspect module now offers a basic :ref:`command line interface
478<inspect-module-cli>` to quickly display source code and other
479information for modules, classes and functions. (Contributed by Claudiu Popa
480and Nick Coghlan in :issue:`18626`)
Nick Coghlanf94a16b2013-09-22 22:46:49 +1000481
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200482:func:`~inspect.unwrap` makes it easy to unravel wrapper function chains
483created by :func:`functools.wraps` (and any other API that sets the
Nick Coghlan367df122013-10-27 01:57:34 +1000484``__wrapped__`` attribute on a wrapper function). (Contributed by
485Daniel Urban, Aaron Iles and Nick Coghlan in :issue:`13266`)
486
487As part of the implementation of the new :mod:`enum` module, the
488:mod:`inspect` module now has substantially better support for custom
489``__dir__`` methods and dynamic class attributes provided through
490metaclasses (Contributed by Ethan Furman in :issue:`18929` and
491:issue:`19030`)
492
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200493
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200494mmap
495----
496
497mmap objects can now be weakref'ed.
498
499(Contributed by Valerie Lambert in :issue:`4885`.)
500
501
Richard Oudkerk84ed9a62013-08-14 15:35:41 +0100502multiprocessing
503---------------
504
505On Unix two new *start methods* have been added for starting processes
506using :mod:`multiprocessing`. These make the mixing of processes with
507threads more robust. See :issue:`8713`.
508
509Also, except when using the old *fork* start method, child processes
510will no longer inherit unneeded handles/file descriptors from their parents.
511
512
Victor Stinnerdaf45552013-08-28 00:53:59 +0200513os
514--
515
Georg Brandlc6ebbef2013-09-16 04:03:12 +0200516New functions to get and set the :ref:`inheritable flag <fd_inheritance>` of a file
Victor Stinnerdaf45552013-08-28 00:53:59 +0200517descriptors or a Windows handle:
518
519* :func:`os.get_inheritable`, :func:`os.set_inheritable`
520* :func:`os.get_handle_inheritable`, :func:`os.set_handle_inheritable`
521
522
R David Murray78d692f2013-10-10 17:23:26 -0400523pdb
524---
525
526The ``print`` command has been removed from :mod:`pdb`, restoring access to the
527``print`` function.
528
529Rationale: Python2's ``pdb`` did not have a ``print`` command; instead,
530entering ``print`` executed the ``print`` statement. In Python3 ``print`` was
531mistakenly made an alias for the pdb :pdbcmd:`p` command. ``p``, however,
532prints the ``repr`` of its argument, not the ``str`` like the Python2 ``print``
533command did. Worse, the Python3 ``pdb print`` command shadowed the Python3
534``print`` function, making it inaccessible at the ``pdb`` prompt.
535
536(Contributed by Connor Osborn in :issue:`18764`.)
537
538
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200539poplib
540------
541
542New :meth:`~poplib.POP3.stls` method to switch a clear-text POP3 session into
543an encrypted POP3 session.
544
545New :meth:`~poplib.POP3.capa` method to query the capabilities advertised by the
546POP3 server.
547
548(Contributed by Lorenzo Catucci in :issue:`4473`.)
549
550
Serhiy Storchaka7c411a42013-10-02 11:56:18 +0300551pprint
552------
553
Christian Heimese1bfd3e2013-10-21 12:32:21 +0200554The :mod:`pprint` module now supports *compact* mode for formatting long
Serhiy Storchaka7c411a42013-10-02 11:56:18 +0300555sequences (:issue:`19132`).
556
557
Nick Coghlan367df122013-10-27 01:57:34 +1000558pydoc
559-----
560
561While significant changes have not been made to :mod:`pydoc` directly,
562its handling of custom ``__dir__`` methods and various descriptor
563behaviours has been improved substantially by the underlying changes in
564the :mod:`inspect` module.
565
566
Christian Heimesb7bd5df2013-10-22 11:21:54 +0200567resource
568--------
569
570New :func:`resource.prlimit` function and Linux specific constants.
571(Contributed by Christian Heimes in :issue:`16595` and :issue:`19324`.)
572
R David Murray8e37d5d2013-04-13 14:49:48 -0400573smtplib
574-------
575
R David Murray8a345962013-04-14 06:46:35 -0400576:exc:`~smtplib.SMTPException` is now a subclass of :exc:`OSError`, which allows
R David Murray8e37d5d2013-04-13 14:49:48 -0400577both socket level errors and SMTP protocol level errors to be caught in one
578try/except statement by code that only cares whether or not an error occurred.
579(:issue:`2118`).
580
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200581
Victor Stinnerdaf45552013-08-28 00:53:59 +0200582socket
583------
584
Georg Brandl5642ff92013-09-15 10:37:57 +0200585Socket objects have new methods to get or set their :ref:`inheritable flag
586<fd_inheritance>`:
Victor Stinnerdaf45552013-08-28 00:53:59 +0200587
588* :meth:`socket.socket.get_inheritable`, :meth:`socket.socket.set_inheritable`
589
Eli Bendersky34567ec2013-08-31 15:18:48 -0700590The ``socket.AF_*`` and ``socket.SOCK_*`` constants are enumeration values,
591using the new :mod:`enum` module. This allows descriptive reporting during
592debugging, instead of seeing integer "magic numbers".
Victor Stinnerdaf45552013-08-28 00:53:59 +0200593
Christian Heimes24cd4cf2013-06-22 19:31:58 +0200594ssl
595---
596
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200597TLSv1.1 and TLSv1.2 support.
Christian Heimes70833a82013-06-22 19:34:17 +0200598
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200599(Contributed by Michele Orrù and Antoine Pitrou in :issue:`16692`)
Christian Heimes24cd4cf2013-06-22 19:31:58 +0200600
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200601* New diagnostic functions :func:`~ssl.get_default_verify_paths`,
602 :meth:`~ssl.SSLContext.cert_store_stats` and
603 :meth:`~ssl.SSLContext.get_ca_certs`
604
605* Add :func:`ssl.enum_cert_store` to retrieve certificates and CRL from Windows'
606 cert store.
Christian Heimes24cd4cf2013-06-22 19:31:58 +0200607
608(Contributed by Christian Heimes in :issue:`18143`, :issue:`18147` and
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200609 :issue:`17134`.)
610
611Support for server-side SNI using the new
612:meth:`ssl.SSLContext.set_servername_callback` method.
613
614(Contributed by Daniel Black in :issue:`8109`.)
615
616
Antoine Pitroud6cbd342013-08-12 20:48:15 +0200617stat
618----
619
620The :mod:`stat` module is now backed by a C implementation in :mod:`_stat`. A C
621implementation is required as most of the values aren't standardized and
622platform-dependent. (Contributed by Christian Heimes in :issue:`11016`.)
623
624The module supports new file types: door, event port and whiteout.
625
626
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200627struct
628------
629
630Streaming struct unpacking using :func:`struct.iter_unpack`.
631
632(Contributed by Antoine Pitrou in :issue:`17804`.)
633
634
Serhiy Storchakae06a8962013-09-04 00:43:03 +0300635sunau
636-----
637
638The :meth:`~sunau.getparams` method now returns a namedtuple rather than a
639plain tuple. (Contributed by Claudiu Popa in :issue:`18901`.)
640
Serhiy Storchaka34d20132013-09-05 17:01:53 +0300641:meth:`sunau.open` now supports the context manager protocol (:issue:`18878`).
642
Serhiy Storchakae06a8962013-09-04 00:43:03 +0300643
Andrew Kuchling173a1572013-09-15 18:15:56 -0400644traceback
645---------
646
647A new :func:`traceback.clear_frames` function takes a traceback object
648and clears the local variables in all of the frames it references,
649reducing the amount of memory consumed (:issue:`1565525`).
650
651
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200652urllib
653------
654
655Add support.for ``data:`` URLs in :mod:`urllib.request`.
656
657(Contributed by Mathias Panzenböck in :issue:`16423`.)
658
659
660unittest
661--------
662
663Support for easy dynamically-generated subtests using the
664:meth:`~unittest.TestCase.subTest` context manager.
665
666(Contributed by Antoine Pitrou in :issue:`16997`.)
667
R David Murray8e37d5d2013-04-13 14:49:48 -0400668
R David Murray671cd322013-04-10 12:31:43 -0400669wave
670----
671
672The :meth:`~wave.getparams` method now returns a namedtuple rather than a
673plain tuple. (Contributed by Claudiu Popa in :issue:`17487`.)
674
R David Murrayc91d5ee2013-07-31 13:46:08 -0400675:meth:`wave.open` now supports the context manager protocol. (Contributed
676by Claudiu Popa in :issue:`17616`.)
677
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200678
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200679weakref
680-------
681
682New :class:`~weakref.WeakMethod` class simulates weak references to bound
Nick Coghlanbe57ab82013-09-22 21:26:30 +1000683methods. (Contributed by Antoine Pitrou in :issue:`14631`.)
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200684
Nick Coghlanbe57ab82013-09-22 21:26:30 +1000685New :class:`~weakref.finalize` class makes it possible to register a callback
686to be invoked when an object is garbage collected, without needing to
687carefully manage the lifecycle of the weak reference itself. (Contributed by
688Richard Oudkerk in :issue:`15528`)
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200689
690
691xml.etree
692---------
693
694Add an event-driven parser for non-blocking applications,
Eli Benderskyb5869342013-08-30 05:51:20 -0700695:class:`~xml.etree.ElementTree.XMLPullParser`.
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200696
Eli Benderskyb5869342013-08-30 05:51:20 -0700697(Contributed by Antoine Pitrou in :issue:`17741`.)
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200698
Christian Tismer59202e52013-10-21 03:59:23 +0200699
700zipfile.PyZipfile
701-----------------
702
703Add a filter function to ignore some packages (tests for instance),
704:meth:`~zipfile.PyZipFile.writepy`.
705
706(Contributed by Christian Tismer in :issue:`19274`.)
707
708
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200709Other improvements
710==================
711
712Tab-completion is now enabled by default in the interactive interpreter.
713
714(Contributed by Antoine Pitrou and Éric Araujo in :issue:`5845`.)
715
Eli Bendersky96d848a2013-09-06 06:55:58 -0700716Python invocation changes
717=========================
718
719Invoking the Python interpreter with ``--version`` now outputs the version to
720standard output instead of standard error (:issue:`18338`). Similar changes
721were made to :mod:`argparse` (:issue:`18920`) and other modules that have
722script-like invocation capabilities (:issue:`18922`).
Antoine Pitrouf89aa9a2013-08-12 20:46:47 +0200723
Georg Brandlb80f5112012-09-30 09:11:58 +0200724Optimizations
725=============
726
727Major performance enhancements have been added:
728
Victor Stinnere64322e2012-10-30 23:12:47 +0100729* The UTF-32 decoder is now 3x to 4x faster.
Georg Brandlb80f5112012-09-30 09:11:58 +0200730
Raymond Hettingerc301b552013-08-19 09:12:20 -0700731* The cost of hash collisions for sets is now reduced. Each hash table
Raymond Hettinger8408dc52013-09-15 14:57:15 -0700732 probe now checks a series of consecutive, adjacent key/hash pairs before
733 continuing to make random probes through the hash table. This exploits
734 cache locality to make collision resolution less expensive.
735
736 The collision resolution scheme can be described as a hybrid of linear
737 probing and open addressing. The number of additional linear probes
738 defaults to nine. This can be changed at compile-time by defining
739 LINEAR_PROBES to be any value. Set LINEAR_PROBES=0 to turn-off
740 linear probing entirely.
Raymond Hettingerc301b552013-08-19 09:12:20 -0700741
Christian Heimes086b1af2013-10-22 11:49:34 +0200742 (Contributed by Raymond Hettinger in :issue:`18771`.)
Raymond Hettingerc301b552013-08-19 09:12:20 -0700743
Christian Heimes17ecd1d2013-10-13 03:10:06 +0200744* The interpreter starts about 30% faster. A couple of measures lead to the
Eric V. Smith57841dd2013-10-13 00:36:08 -0400745 speedup. The interpreter loads fewer modules on startup, e.g. the :mod:`re`,
Christian Heimes17ecd1d2013-10-13 03:10:06 +0200746 :mod:`collections` and :mod:`locale` modules and their dependencies are no
747 longer imported by default. The marshal module has been improved to load
748 compiled Python code faster.
749
750 (Contributed by Antoine Pitrou, Christian Heimes and Victor Stinner in
751 :issue:`19219`, :issue:`19218`, :issue:`19209`, :issue:`19205` and
752 :issue:`9548`)
753
754
Nick Coghlan367df122013-10-27 01:57:34 +1000755CPython Implementation Changes
756==============================
757
758
759.. _pep-445:
760
761PEP 445: Customization of CPython memory allocators
762---------------------------------------------------
763
764:pep:`445` adds new C level interfaces to customize memory allocation in
765the CPython interpreter.
766
767.. seealso::
768
769 :pep:`445` - Add new APIs to customize Python memory allocators
770 PEP written and implemented by Victor Stinner.
771
772
773.. _pep-442:
774
775PEP 442: Safe object finalization
776---------------------------------
777
778:pep:`442` removes the current limitations and quirks of object finalization
779in CPython. With it, objects with :meth:`__del__` methods, as well as
780generators with :keyword:`finally` clauses, can be finalized when they are
781part of a reference cycle.
782
783As part of this change, module globals are no longer forcibly set to
784:const:`None` during interpreter shutdown in most cases, instead relying
785on the normal operation of the cyclic garbage collector.
786
787.. seealso::
788
789 :pep:`442` - Safe object finalization
790 PEP written and implemented by Antoine Pitrou.
791
792
793Other build and C API changes
794-----------------------------
Georg Brandlb80f5112012-09-30 09:11:58 +0200795
796Changes to Python's build process and to the C API include:
797
Nick Coghlan7d270ee2013-10-17 22:35:35 +1000798* The new :c:func:`Py_SetStandardStreamEncoding` pre-initialization API
799 allows applications embedding the CPython interpreter to reliably force
800 a particular encoding and error handler for the standard streams
801 (Contributed by Bastien Montagne and Nick Coghlan in :issue:`16129`)
Georg Brandlb80f5112012-09-30 09:11:58 +0200802
Nick Coghlan0acceb72013-10-20 13:22:21 +1000803* Most Python C APIs that don't mutate string arguments are now correctly
804 marked as accepting ``const char *`` rather than ``char *`` (Contributed
805 by Serhiy Storchaka in :issue:`1772673`).
806
807* "Argument Clinic" (:pep:`436`) is now part of the CPython build process
808 and can be used to simplify the process of defining and maintaining
809 accurate signatures for builtins and standard library extension modules
810 implemented in C.
811
Nick Coghlan367df122013-10-27 01:57:34 +1000812 .. note::
813 The Argument Clinic PEP is not fully up to date with the state of the
814 implementation. This has been deemed acceptable by the release manager
815 and core development team in this case, as Argument Clinic will not
816 be made available as a public API for third party use in Python 3.4.
817
Georg Brandlb80f5112012-09-30 09:11:58 +0200818
819Deprecated
820==========
821
822Unsupported Operating Systems
823-----------------------------
824
Victor Stinnerf3fd13b2013-08-04 10:30:57 +0200825* OS/2
Victor Stinnerf3fd13b2013-08-04 10:30:57 +0200826* Windows 2000
Georg Brandlb80f5112012-09-30 09:11:58 +0200827
828
829Deprecated Python modules, functions and methods
830------------------------------------------------
831
Terry Jan Reedy2b6c26e2013-03-21 19:36:26 -0400832* :meth:`difflib.SequenceMatcher.isbjunk` and
Andrew Kuchling0d0813a2013-06-15 13:29:09 -0400833 :meth:`difflib.SequenceMatcher.isbpopular` were removed: use ``x in sm.bjunk`` and
834 ``x in sm.bpopular``, where *sm* is a :class:`~difflib.SequenceMatcher` object.
Georg Brandlb80f5112012-09-30 09:11:58 +0200835
Brett Cannon82b3d6a2013-06-14 22:37:11 -0400836* :func:`importlib.util.module_for_loader` is pending deprecation. Using
837 :func:`importlib.util.module_to_load` and
838 :meth:`importlib.abc.Loader.init_module_attrs` allows subclasses of a loader
839 to more easily customize module loading.
840
Brett Cannone4f41de2013-06-16 13:13:40 -0400841* The :mod:`imp` module is pending deprecation. To keep compatibility with
842 Python 2/3 code bases, the module's removal is currently not scheduled.
843
Brett Cannon1448ecf2013-10-04 11:38:59 -0400844* The :mod:`formatter` module is pending deprecation and is slated for removal
845 in Python 3.6.
846
Christian Heimes634919a2013-11-20 17:23:06 +0100847* MD5 as default digestmod for :mod:`hmac` is deprecated. Python 3.6 will
848 require an explicit digest name or constructor as *digestmod* argument.
849
Georg Brandlb80f5112012-09-30 09:11:58 +0200850
851Deprecated functions and types of the C API
852-------------------------------------------
853
Victor Stinner3dd263f2013-10-23 18:54:43 +0200854* The ``PyThreadState.tick_counter`` field has been removed: its value was
855 meaningless since Python 3.2 ("new GIL").
Georg Brandlb80f5112012-09-30 09:11:58 +0200856
857
858Deprecated features
859-------------------
860
Antoine Pitrou3b2f0f02013-10-25 21:39:26 +0200861* The site module adding a "site-python" directory to sys.path, if it
862 exists, is deprecated (:issue:`19375`).
Georg Brandlb80f5112012-09-30 09:11:58 +0200863
864
Benjamin Peterson88f3b232012-10-04 12:45:10 -0400865Porting to Python 3.4
Georg Brandlb80f5112012-09-30 09:11:58 +0200866=====================
867
868This section lists previously described changes and other bugfixes
869that may require changes to your code.
870
Brett Cannon777622b2013-04-09 17:03:10 -0400871* The ABCs defined in :mod:`importlib.abc` now either raise the appropriate
872 exception or return a default value instead of raising
873 :exc:`NotImplementedError` blindly. This will only affect code calling
874 :func:`super` and falling through all the way to the ABCs. For compatibility,
875 catch both :exc:`NotImplementedError` or the appropriate exception as needed.
Brett Cannon4c14b5d2013-05-04 13:56:58 -0400876
877* The module type now initializes the :attr:`__package__` and :attr:`__loader__`
878 attributes to ``None`` by default. To determine if these attributes were set
879 in a backwards-compatible fashion, use e.g.
Brett Cannon3dc48d62013-05-28 18:35:54 -0400880 ``getattr(module, '__loader__', None) is not None``.
881
882* :meth:`importlib.util.module_for_loader` now sets ``__loader__`` and
883 ``__package__`` unconditionally to properly support reloading. If this is not
884 desired then you will need to set these attributes manually. You can use
Brett Cannon028d5122013-05-31 18:02:11 -0400885 :func:`importlib.util.module_to_load` for module management.
Brett Cannon3e0651b2013-05-31 23:18:39 -0400886
887* Import now resets relevant attributes (e.g. ``__name__``, ``__loader__``,
888 ``__package__``, ``__file__``, ``__cached__``) unconditionally when reloading.
889
Brett Cannon1448ecf2013-10-04 11:38:59 -0400890* Frozen packages no longer set ``__path__`` to a list containing the package
891 name but an empty list instead. Determing if a module is a package should be
892 done using ``hasattr(module, '__path__')``.
Brett Cannon8f5ac512013-06-12 23:29:18 -0400893
894* :c:func:`PyErr_SetImportError` now sets :exc:`TypeError` when its **msg**
Brett Cannon82da8882013-07-04 17:48:16 -0400895 argument is not set. Previously only ``NULL`` was returned with no exception
896 set.
Brett Cannon33915eb2013-06-14 18:33:00 -0400897
898* :func:`py_compile.compile` now raises :exc:`FileExistsError` if the file path
899 it would write to is a symlink or a non-regular file. This is to act as a
900 warning that import will overwrite those files with a regular file regardless
901 of what type of file path they were originally.
Brett Cannonf4375ef2013-06-16 18:05:54 -0400902
903* :meth:`importlib.abc.SourceLoader.get_source` no longer raises
904 :exc:`ImportError` when the source code being loaded triggers a
905 :exc:`SyntaxError` or :exc:`UnicodeDecodeError`. As :exc:`ImportError` is
906 meant to be raised only when source code cannot be found but it should, it was
907 felt to be over-reaching/overloading of that meaning when the source code is
908 found but improperly structured. If you were catching ImportError before and
909 wish to continue to ignore syntax or decoding issues, catch all three
Victor Stinner84e33c82013-06-21 00:31:55 +0200910 exceptions now.
Nick Coghlan24c05bc2013-07-15 21:13:08 +1000911
912* :func:`functools.update_wrapper` and :func:`functools.wraps` now correctly
Nick Coghlan367df122013-10-27 01:57:34 +1000913 set the ``__wrapped__`` attribute to the function being wrapper, even if
914 that function also had its ``__wrapped__`` attribute set. This means
915 ``__wrapped__`` attributes now correctly link a stack of decorated
916 functions rather than every ``__wrapped__`` attribute in the chain
917 referring to the innermost function. Introspection libraries that
918 assumed the previous behaviour was intentional can use
919 :func:`inspect.unwrap` to access the first function in the chain that has
920 no ``__wrapped__`` attribute.
Victor Stinner2fe9bac2013-10-10 16:18:20 +0200921
Georg Brandlc2228c82013-10-12 13:24:55 +0200922* (C API) The result of the :c:data:`PyOS_ReadlineFunctionPointer` callback must
Victor Stinner2fe9bac2013-10-10 16:18:20 +0200923 now be a string allocated by :c:func:`PyMem_RawMalloc` or
924 :c:func:`PyMem_RawRealloc`, or *NULL* if an error occurred, instead of a
925 string allocated by :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`.
926
Georg Brandl0f5bff22013-10-19 17:46:38 +0200927* :class:`importlib.machinery.PathFinder` now passes on the current working
Brett Cannon27e27f72013-10-18 11:39:04 -0400928 directory to objects in :data:`sys.path_hooks` for the empty string. This
929 results in :data:`sys.path_importer_cache` never containing ``''``, thus
930 iterating through :data:`sys.path_importer_cache` based on :data:`sys.path`
931 will not find all keys. A module's ``__file__`` when imported in the current
932 working directory will also now have an absolute path, including when using
933 ``-m`` with the interpreter (this does not influence when the path to a file
934 is specified on the command-line).