Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 1 | **************************** |
| 2 | What's New In Python 3.4 |
| 3 | **************************** |
| 4 | |
Georg Brandl | 3b80d34 | 2012-10-28 13:37:54 +0100 | [diff] [blame] | 5 | .. :Author: Someone <email> |
| 6 | (uncomment if there is a principal author) |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 7 | |
| 8 | .. Rules for maintenance: |
| 9 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 10 | * 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 Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 14 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 15 | * 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 Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 24 | |
| 25 | * This is not a complete list of every single change; completeness |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 26 | 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 Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 34 | |
| 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 Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 39 | * 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 Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 46 | |
| 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 Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 55 | The :ref:`~socket.transmogrify()` function was added to the |
| 56 | :mod:`socket` module. (Contributed by P.Y. Developer in :issue:`12345`.) |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 57 | |
| 58 | This saves the maintainer the effort of going through the Mercurial log |
| 59 | when researching a change. |
| 60 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 61 | * Cross referencing tip: :ref:`mod.attr` will display as ``mod.attr``, |
| 62 | while :ref:`~mod.attr` will display as ``attr``. |
| 63 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 64 | This article explains the new features in Python 3.4, compared to 3.3. |
| 65 | |
Nick Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 66 | .. Python 3.4 was released on TBD. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 67 | |
Ezio Melotti | 25bbe5e | 2012-11-17 19:30:48 +0200 | [diff] [blame] | 68 | For full details, see the |
| 69 | `changelog <http://docs.python.org/3.4/whatsnew/changelog.html>`_. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 70 | |
| 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 Coghlan | 03074fd | 2012-09-30 18:51:53 +0530 | [diff] [blame] | 78 | .. :pep:`4XX` - Python 3.4 Release Schedule |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 79 | |
| 80 | |
| 81 | Summary -- Release highlights |
| 82 | ============================= |
| 83 | |
Kristjan Valur Jonsson | a1e8244 | 2013-03-26 13:56:14 +0000 | [diff] [blame] | 84 | .. This section singles out the most important changes in Python 3.4. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 85 | Brevity is key. |
| 86 | |
| 87 | New syntax features: |
| 88 | |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 89 | * No new syntax features are planned for Python 3.4. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 90 | |
| 91 | New library modules: |
| 92 | |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 93 | * :mod:`asyncio`: New provisonal API for asynchronous IO (:pep:`3156`). |
| 94 | * :mod:`enum`: Support for enumeration types (:pep:`435`). |
Victor Stinner | 4aea4a0 | 2013-09-04 20:30:34 +0200 | [diff] [blame] | 95 | * :mod:`selectors`: High-level and efficient I/O multiplexing, built upon the |
| 96 | :mod:`select` module primitives. |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 97 | * :mod:`statistics`: A basic numerically stable statistics library (:pep:`450`). |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 98 | |
| 99 | New built-in features: |
| 100 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 101 | * :ref:`PEP 442: Safe object finalization <pep-442>`. |
| 102 | * :ref:`PEP 445: Configurable memory allocators <pep-445>`. |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 103 | * :ref:`PEP 446: Make newly created file descriptors non-inheritable <pep-446>`. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 104 | |
| 105 | Implementation improvements: |
| 106 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 107 | * A more efficient :mod:`marshal` format (:issue:`16475`). |
| 108 | * Improve finalization of Python modules to avoid setting their globals |
| 109 | to None, in most cases (:issue:`18214`). |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 110 | * "Argument Clinic", providing improved introspection support for builtin |
| 111 | and standard library extension types implemented in C (:pep:`436`) |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 112 | |
| 113 | Significantly Improved Library Modules: |
| 114 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 115 | * Single-dispatch generic functions (:pep:`443`) |
| 116 | * SHA-3 (Keccak) support for :mod:`hashlib`. |
| 117 | * TLSv1.1 and TLSv1.2 support for :mod:`ssl`. |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 118 | * :mod:`multiprocessing` now has option to avoid using :func:`os.fork` |
| 119 | on Unix (:issue:`8713`). |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 120 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 121 | Security improvements: |
| 122 | |
Christian Heimes | ad73a9c | 2013-08-10 16:36:18 +0200 | [diff] [blame] | 123 | * command line option for :ref:`isolated mode <using-on-misc-options>`, |
| 124 | :issue:`16499`. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 125 | |
| 126 | Please read on for a comprehensive list of user-facing changes. |
| 127 | |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 128 | .. _pep-446: |
| 129 | |
| 130 | PEP 446: Make newly created file descriptors non-inheritable |
| 131 | ============================================================ |
| 132 | |
Georg Brandl | 5642ff9 | 2013-09-15 10:37:57 +0200 | [diff] [blame] | 133 | The :pep:`446` makes newly created file descriptors :ref:`non-inheritable |
| 134 | <fd_inheritance>`. New functions and methods: |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 135 | |
| 136 | * :func:`os.get_inheritable`, :func:`os.set_inheritable` |
| 137 | * :func:`os.get_handle_inheritable`, :func:`os.set_handle_inheritable` |
| 138 | * :meth:`socket.socket.get_inheritable`, :meth:`socket.socket.set_inheritable` |
| 139 | |
| 140 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 141 | .. _pep-445: |
| 142 | |
| 143 | PEP 445: Add new APIs to customize Python memory allocators |
| 144 | =========================================================== |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 145 | |
Victor Stinner | 0507bf5 | 2013-07-07 02:05:46 +0200 | [diff] [blame] | 146 | The :pep:`445` adds new Application Programming Interfaces (API) to customize |
| 147 | Python memory allocators. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 148 | |
| 149 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 150 | .. _pep-442: |
| 151 | |
| 152 | PEP 442: Safe object finalization |
| 153 | ================================= |
| 154 | |
| 155 | This PEP removes the current limitations and quirks of object finalization. |
| 156 | With it, objects with :meth:`__del__` methods, as well as generators |
| 157 | with :keyword:`finally` clauses, can be finalized when they are part of a |
| 158 | reference cycle. |
| 159 | |
Nick Coghlan | be57ab8 | 2013-09-22 21:26:30 +1000 | [diff] [blame] | 160 | As part of this change, module globals are no longer forcibly set to |
| 161 | :const:`None` during interpreter shutdown, instead relying on the normal |
| 162 | operation of the cyclic garbage collector. |
| 163 | |
Antoine Pitrou | 796564c | 2013-07-30 19:59:21 +0200 | [diff] [blame] | 164 | .. seealso:: |
| 165 | |
| 166 | :pep:`442` - Safe object finalization |
| 167 | PEP written and implemented by Antoine Pitrou |
| 168 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 169 | |
| 170 | Other Language Changes |
| 171 | ====================== |
| 172 | |
| 173 | Some smaller changes made to the core Python language are: |
| 174 | |
Ezio Melotti | 34808e2 | 2013-10-12 16:36:13 +0300 | [diff] [blame] | 175 | * Unicode database updated to UCD version 6.3. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 176 | |
R David Murray | 9a2f139 | 2013-06-28 13:31:19 -0400 | [diff] [blame] | 177 | * :func:`min` and :func:`max` now accept a *default* argument that can be used |
| 178 | to specify the value they return if the iterable they are evaluating has no |
| 179 | elements. Contributed by Julian Berman in :issue:`18111`. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 180 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 181 | * Module objects are now :mod:`weakref`'able. |
| 182 | |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 183 | * Module ``__file__`` attributes (and related values) should now always |
| 184 | contain absolute paths by default, with the sole exception of |
| 185 | ``__main__.__file__`` when a script has been executed directly using |
| 186 | a relative path (Contributed by Brett Cannon in :issue:`18416`). |
| 187 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 188 | |
| 189 | New Modules |
| 190 | =========== |
| 191 | |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 192 | |
| 193 | asyncio |
| 194 | ------- |
| 195 | |
| 196 | The new :mod:`asyncio` module (defined in :pep:`3156`) provides a standard |
| 197 | pluggable event loop model for Python, providing solid asynchronous IO |
| 198 | support in the standard library, and making it easier for other event loop |
| 199 | implementations to interoperate with the standard library and each other. |
| 200 | |
| 201 | For Python 3.4, this module is considered a :term:`provisional API`. |
| 202 | |
| 203 | enum |
| 204 | ---- |
| 205 | |
| 206 | The new :mod:`enum` module provides a standard implementation of enumeration |
| 207 | types, allowing other modules (such as :mod:`socket`) to provide more |
| 208 | informative error messages and better debugging support by replacing opaque |
| 209 | integer constants with backwards compatible enumeration values. |
| 210 | |
| 211 | |
Charles-François Natali | 243d8d8 | 2013-09-04 19:02:49 +0200 | [diff] [blame] | 212 | selectors |
| 213 | --------- |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 214 | |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 215 | The new :mod:`selectors` module (created as part of implementing :pep:`3156`) |
| 216 | allows high-level and efficient I/O multiplexing, built upon the |
| 217 | :mod:`select` module primitives. |
| 218 | |
| 219 | |
| 220 | statistics |
| 221 | ---------- |
| 222 | |
| 223 | The new :mod:`statistics` module (defined in :pep:`450`) offers some core |
| 224 | statistics functionality directly in the standard library. This module |
| 225 | supports calculation of the mean, median, mode, variance and standard |
| 226 | deviation of a data series. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 227 | |
| 228 | |
| 229 | Improved Modules |
| 230 | ================ |
| 231 | |
Antoine Pitrou | d6cbd34 | 2013-08-12 20:48:15 +0200 | [diff] [blame] | 232 | aifc |
| 233 | ---- |
| 234 | |
| 235 | The :meth:`~aifc.getparams` method now returns a namedtuple rather than a |
| 236 | plain tuple. (Contributed by Claudiu Popa in :issue:`17818`.) |
| 237 | |
| 238 | |
Serhiy Storchaka | eaea5e9 | 2013-10-19 21:10:46 +0300 | [diff] [blame] | 239 | audioop |
| 240 | ------- |
| 241 | |
| 242 | Added support for 24-bit samples (:issue:`12866`). |
| 243 | |
| 244 | |
Nick Coghlan | e206b6e | 2013-10-14 00:55:46 +1000 | [diff] [blame] | 245 | codecs |
| 246 | ------ |
| 247 | |
| 248 | The :meth:`codecs.encode` and :meth:`codecs.decode` convenience functions are |
| 249 | now properly documented. These functions have existed in the :mod:`codecs` |
| 250 | module since ~2004, but were previously only discoverable through runtime |
| 251 | introspection. |
| 252 | |
| 253 | Unlike the convenience methods on :class:`str`, :class:`bytes` and |
| 254 | :class:`bytearray`, these convenience functions support arbitrary codecs, |
| 255 | rather than being limited to Unicode text encodings. |
| 256 | |
| 257 | |
Antoine Pitrou | d6cbd34 | 2013-08-12 20:48:15 +0200 | [diff] [blame] | 258 | colorsys |
| 259 | -------- |
| 260 | |
| 261 | The number of digits in the coefficients for the RGB --- YIQ conversions have |
| 262 | been expanded so that they match the FCC NTSC versions. The change in |
| 263 | results should be less than 1% and may better match results found elsewhere. |
| 264 | |
R David Murray | 8e37d5d | 2013-04-13 14:49:48 -0400 | [diff] [blame] | 265 | |
Nick Coghlan | b4534ae | 2013-10-13 23:23:08 +1000 | [diff] [blame] | 266 | contextlib |
| 267 | ---------- |
| 268 | |
Nick Coghlan | 240f86d | 2013-10-17 23:40:57 +1000 | [diff] [blame] | 269 | The new :class:`contextlib.suppress` context manager helps to clarify the |
| 270 | intent of code that deliberately suppresses exceptions from a single |
| 271 | statement. (Contributed by Raymond Hettinger in :issue:`15806` and |
| 272 | Zero Piraeus in :issue:`19266`) |
| 273 | |
Victor Stinner | 6633c39 | 2013-10-21 13:27:11 +0200 | [diff] [blame] | 274 | The new :func:`contextlib.redirect_stdout` context manager makes it easier |
Nick Coghlan | b4534ae | 2013-10-13 23:23:08 +1000 | [diff] [blame] | 275 | for utility scripts to handle inflexible APIs that don't provide any |
| 276 | options to retrieve their output as a string or direct it to somewhere |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 277 | other than :data:`sys.stdout`. In conjunction with :class:`io.StringIO`, |
| 278 | this context manager is also useful for checking expected output from |
| 279 | command line utilities. (Contribute by Raymond Hettinger in :issue:`15805`) |
| 280 | |
| 281 | The :mod:`contextlib` documentation has also been updated to include a |
| 282 | :ref:`discussion <single-use-reusable-and-reentrant-cms>` of the |
| 283 | differences between single use, reusable and reentrant context managers. |
Nick Coghlan | b4534ae | 2013-10-13 23:23:08 +1000 | [diff] [blame] | 284 | |
| 285 | |
Nick Coghlan | b39fd0c | 2013-05-06 23:59:20 +1000 | [diff] [blame] | 286 | dis |
| 287 | --- |
| 288 | |
Serhiy Storchaka | 98b28fd | 2013-10-13 23:12:09 +0300 | [diff] [blame] | 289 | The :mod:`dis` module is now built around an :class:`~dis.Instruction` class |
| 290 | that provides details of individual bytecode operations and a |
| 291 | :func:`~dis.get_instructions` iterator that emits the Instruction stream for a |
Nick Coghlan | b39fd0c | 2013-05-06 23:59:20 +1000 | [diff] [blame] | 292 | given piece of Python code. The various display tools in the :mod:`dis` |
| 293 | module have been updated to be based on these new components. |
| 294 | |
| 295 | The new :class:`dis.Bytecode` class provides an object-oriented API for |
| 296 | inspecting bytecode, both in human-readable form and for iterating over |
| 297 | instructions. |
| 298 | |
| 299 | (Contributed by Nick Coghlan, Ryan Kelly and Thomas Kluyver in :issue:`11816`) |
| 300 | |
Antoine Pitrou | d6cbd34 | 2013-08-12 20:48:15 +0200 | [diff] [blame] | 301 | |
R David Murray | 5a9d706 | 2012-11-21 15:09:21 -0500 | [diff] [blame] | 302 | doctest |
| 303 | ------- |
| 304 | |
R David Murray | 5707d50 | 2013-06-23 14:24:13 -0400 | [diff] [blame] | 305 | Added :data:`~doctest.FAIL_FAST` flag to halt test running as soon as the first |
| 306 | failure is detected. (Contributed by R. David Murray and Daniel Urban in |
| 307 | :issue:`16522`.) |
| 308 | |
| 309 | Updated the doctest command line interface to use :mod:`argparse`, and added |
| 310 | ``-o`` and ``-f`` options to the interface. ``-o`` allows doctest options to |
| 311 | be specified on the command line, and ``-f`` is a shorthand for ``-o |
| 312 | FAIL_FAST`` (to parallel the similar option supported by the :mod:`unittest` |
| 313 | CLI). (Contributed by R. David Murray in :issue:`11390`.) |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 314 | |
R David Murray | 8e37d5d | 2013-04-13 14:49:48 -0400 | [diff] [blame] | 315 | |
R David Murray | bb17d2b | 2013-08-09 16:15:28 -0400 | [diff] [blame] | 316 | email |
| 317 | ----- |
| 318 | |
| 319 | :meth:`~email.message.Message.as_string` now accepts a *policy* argument to |
| 320 | override the default policy of the message when generating a string |
| 321 | representation of it. This means that ``as_string`` can now be used in more |
| 322 | circumstances, instead of having to create and use a :mod:`~email.generator` in |
| 323 | order to pass formatting parameters to its ``flatten`` method. |
| 324 | |
| 325 | New method :meth:`~email.message.Message.as_bytes` added to produce a bytes |
| 326 | representation of the message in a fashion similar to how ``as_string`` |
| 327 | produces a string representation. It does not accept the *maxheaderlen* |
| 328 | argument, but does accept the *unixfrom* and *policy* arguments. The |
| 329 | :class:`~email.message.Message` :meth:`~email.message.Message.__bytes__` method |
| 330 | calls it, meaning that ``bytes(mymsg)`` will now produce the intuitive |
| 331 | result: a bytes object containing the fully formatted message. |
| 332 | |
| 333 | (Contributed by R. David Murray in :issue:`18600`.) |
| 334 | |
R David Murray | 3da240f | 2013-10-16 22:48:40 -0400 | [diff] [blame] | 335 | A pair of new subclasses of :class:`~email.message.Message` have been added, |
| 336 | along with a new sub-module, :mod:`~email.contentmanager`. All documentation |
| 337 | is currently in the new module, which is being added as part of the new |
Nick Coghlan | 240f86d | 2013-10-17 23:40:57 +1000 | [diff] [blame] | 338 | :term:`provisional <provisional package>` email API. These classes provide a |
R David Murray | 3da240f | 2013-10-16 22:48:40 -0400 | [diff] [blame] | 339 | number of new methods that make extracting content from and inserting content |
| 340 | into email messages much easier. See the :mod:`~email.contentmanager` |
| 341 | documentation for details. |
| 342 | |
| 343 | These API additions complete the bulk of the work that was planned as part of |
| 344 | the email6 project. The currently provisional API is scheduled to become final |
| 345 | in Python 3.5 (possibly with a few minor additions in the area of error |
| 346 | handling). |
| 347 | |
| 348 | (Contributed by R. David Murray in :issue:`18891`.) |
| 349 | |
R David Murray | bb17d2b | 2013-08-09 16:15:28 -0400 | [diff] [blame] | 350 | |
Victor Stinner | 854ffcb | 2013-06-21 00:36:30 +0200 | [diff] [blame] | 351 | functools |
| 352 | --------- |
| 353 | |
| 354 | New :func:`functools.singledispatch` decorator: see the :pep:`443`. |
| 355 | |
Nick Coghlan | e8c45d6 | 2013-07-28 20:00:01 +1000 | [diff] [blame] | 356 | |
Christian Heimes | e92ef13 | 2013-10-13 00:52:43 +0200 | [diff] [blame] | 357 | hashlib |
| 358 | ------- |
| 359 | |
| 360 | New :func:`hashlib.pbkdf2_hmac` function. |
| 361 | |
| 362 | (Contributed by Christian Heimes in :issue:`18582`) |
| 363 | |
| 364 | |
Antoine Pitrou | d6cbd34 | 2013-08-12 20:48:15 +0200 | [diff] [blame] | 365 | inspect |
| 366 | ------- |
| 367 | |
Nick Coghlan | f94a16b | 2013-09-22 22:46:49 +1000 | [diff] [blame] | 368 | |
| 369 | The inspect module now offers a basic command line interface to quickly |
| 370 | display source code and other information for modules, classes and |
| 371 | functions. |
| 372 | |
Antoine Pitrou | d6cbd34 | 2013-08-12 20:48:15 +0200 | [diff] [blame] | 373 | :func:`~inspect.unwrap` makes it easy to unravel wrapper function chains |
| 374 | created by :func:`functools.wraps` (and any other API that sets the |
| 375 | ``__wrapped__`` attribute on a wrapper function). |
| 376 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 377 | mmap |
| 378 | ---- |
| 379 | |
| 380 | mmap objects can now be weakref'ed. |
| 381 | |
| 382 | (Contributed by Valerie Lambert in :issue:`4885`.) |
| 383 | |
| 384 | |
Richard Oudkerk | 84ed9a6 | 2013-08-14 15:35:41 +0100 | [diff] [blame] | 385 | multiprocessing |
| 386 | --------------- |
| 387 | |
| 388 | On Unix two new *start methods* have been added for starting processes |
| 389 | using :mod:`multiprocessing`. These make the mixing of processes with |
| 390 | threads more robust. See :issue:`8713`. |
| 391 | |
| 392 | Also, except when using the old *fork* start method, child processes |
| 393 | will no longer inherit unneeded handles/file descriptors from their parents. |
| 394 | |
| 395 | |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 396 | os |
| 397 | -- |
| 398 | |
Georg Brandl | c6ebbef | 2013-09-16 04:03:12 +0200 | [diff] [blame] | 399 | New functions to get and set the :ref:`inheritable flag <fd_inheritance>` of a file |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 400 | descriptors or a Windows handle: |
| 401 | |
| 402 | * :func:`os.get_inheritable`, :func:`os.set_inheritable` |
| 403 | * :func:`os.get_handle_inheritable`, :func:`os.set_handle_inheritable` |
| 404 | |
| 405 | |
R David Murray | 78d692f | 2013-10-10 17:23:26 -0400 | [diff] [blame] | 406 | pdb |
| 407 | --- |
| 408 | |
| 409 | The ``print`` command has been removed from :mod:`pdb`, restoring access to the |
| 410 | ``print`` function. |
| 411 | |
| 412 | Rationale: Python2's ``pdb`` did not have a ``print`` command; instead, |
| 413 | entering ``print`` executed the ``print`` statement. In Python3 ``print`` was |
| 414 | mistakenly made an alias for the pdb :pdbcmd:`p` command. ``p``, however, |
| 415 | prints the ``repr`` of its argument, not the ``str`` like the Python2 ``print`` |
| 416 | command did. Worse, the Python3 ``pdb print`` command shadowed the Python3 |
| 417 | ``print`` function, making it inaccessible at the ``pdb`` prompt. |
| 418 | |
| 419 | (Contributed by Connor Osborn in :issue:`18764`.) |
| 420 | |
| 421 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 422 | poplib |
| 423 | ------ |
| 424 | |
| 425 | New :meth:`~poplib.POP3.stls` method to switch a clear-text POP3 session into |
| 426 | an encrypted POP3 session. |
| 427 | |
| 428 | New :meth:`~poplib.POP3.capa` method to query the capabilities advertised by the |
| 429 | POP3 server. |
| 430 | |
| 431 | (Contributed by Lorenzo Catucci in :issue:`4473`.) |
| 432 | |
| 433 | |
Serhiy Storchaka | 7c411a4 | 2013-10-02 11:56:18 +0300 | [diff] [blame] | 434 | pprint |
| 435 | ------ |
| 436 | |
Christian Heimes | e1bfd3e | 2013-10-21 12:32:21 +0200 | [diff] [blame] | 437 | The :mod:`pprint` module now supports *compact* mode for formatting long |
Serhiy Storchaka | 7c411a4 | 2013-10-02 11:56:18 +0300 | [diff] [blame] | 438 | sequences (:issue:`19132`). |
| 439 | |
| 440 | |
Christian Heimes | b7bd5df | 2013-10-22 11:21:54 +0200 | [diff] [blame] | 441 | resource |
| 442 | -------- |
| 443 | |
| 444 | New :func:`resource.prlimit` function and Linux specific constants. |
| 445 | (Contributed by Christian Heimes in :issue:`16595` and :issue:`19324`.) |
| 446 | |
R David Murray | 8e37d5d | 2013-04-13 14:49:48 -0400 | [diff] [blame] | 447 | smtplib |
| 448 | ------- |
| 449 | |
R David Murray | 8a34596 | 2013-04-14 06:46:35 -0400 | [diff] [blame] | 450 | :exc:`~smtplib.SMTPException` is now a subclass of :exc:`OSError`, which allows |
R David Murray | 8e37d5d | 2013-04-13 14:49:48 -0400 | [diff] [blame] | 451 | both socket level errors and SMTP protocol level errors to be caught in one |
| 452 | try/except statement by code that only cares whether or not an error occurred. |
| 453 | (:issue:`2118`). |
| 454 | |
Antoine Pitrou | d6cbd34 | 2013-08-12 20:48:15 +0200 | [diff] [blame] | 455 | |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 456 | socket |
| 457 | ------ |
| 458 | |
Georg Brandl | 5642ff9 | 2013-09-15 10:37:57 +0200 | [diff] [blame] | 459 | Socket objects have new methods to get or set their :ref:`inheritable flag |
| 460 | <fd_inheritance>`: |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 461 | |
| 462 | * :meth:`socket.socket.get_inheritable`, :meth:`socket.socket.set_inheritable` |
| 463 | |
Eli Bendersky | 34567ec | 2013-08-31 15:18:48 -0700 | [diff] [blame] | 464 | The ``socket.AF_*`` and ``socket.SOCK_*`` constants are enumeration values, |
| 465 | using the new :mod:`enum` module. This allows descriptive reporting during |
| 466 | debugging, instead of seeing integer "magic numbers". |
Victor Stinner | daf4555 | 2013-08-28 00:53:59 +0200 | [diff] [blame] | 467 | |
Christian Heimes | 24cd4cf | 2013-06-22 19:31:58 +0200 | [diff] [blame] | 468 | ssl |
| 469 | --- |
| 470 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 471 | TLSv1.1 and TLSv1.2 support. |
Christian Heimes | 70833a8 | 2013-06-22 19:34:17 +0200 | [diff] [blame] | 472 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 473 | (Contributed by Michele Orrù and Antoine Pitrou in :issue:`16692`) |
Christian Heimes | 24cd4cf | 2013-06-22 19:31:58 +0200 | [diff] [blame] | 474 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 475 | * New diagnostic functions :func:`~ssl.get_default_verify_paths`, |
| 476 | :meth:`~ssl.SSLContext.cert_store_stats` and |
| 477 | :meth:`~ssl.SSLContext.get_ca_certs` |
| 478 | |
| 479 | * Add :func:`ssl.enum_cert_store` to retrieve certificates and CRL from Windows' |
| 480 | cert store. |
Christian Heimes | 24cd4cf | 2013-06-22 19:31:58 +0200 | [diff] [blame] | 481 | |
| 482 | (Contributed by Christian Heimes in :issue:`18143`, :issue:`18147` and |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 483 | :issue:`17134`.) |
| 484 | |
| 485 | Support for server-side SNI using the new |
| 486 | :meth:`ssl.SSLContext.set_servername_callback` method. |
| 487 | |
| 488 | (Contributed by Daniel Black in :issue:`8109`.) |
| 489 | |
| 490 | |
Antoine Pitrou | d6cbd34 | 2013-08-12 20:48:15 +0200 | [diff] [blame] | 491 | stat |
| 492 | ---- |
| 493 | |
| 494 | The :mod:`stat` module is now backed by a C implementation in :mod:`_stat`. A C |
| 495 | implementation is required as most of the values aren't standardized and |
| 496 | platform-dependent. (Contributed by Christian Heimes in :issue:`11016`.) |
| 497 | |
| 498 | The module supports new file types: door, event port and whiteout. |
| 499 | |
| 500 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 501 | struct |
| 502 | ------ |
| 503 | |
| 504 | Streaming struct unpacking using :func:`struct.iter_unpack`. |
| 505 | |
| 506 | (Contributed by Antoine Pitrou in :issue:`17804`.) |
| 507 | |
| 508 | |
Serhiy Storchaka | e06a896 | 2013-09-04 00:43:03 +0300 | [diff] [blame] | 509 | sunau |
| 510 | ----- |
| 511 | |
| 512 | The :meth:`~sunau.getparams` method now returns a namedtuple rather than a |
| 513 | plain tuple. (Contributed by Claudiu Popa in :issue:`18901`.) |
| 514 | |
Serhiy Storchaka | 34d2013 | 2013-09-05 17:01:53 +0300 | [diff] [blame] | 515 | :meth:`sunau.open` now supports the context manager protocol (:issue:`18878`). |
| 516 | |
Serhiy Storchaka | e06a896 | 2013-09-04 00:43:03 +0300 | [diff] [blame] | 517 | |
Andrew Kuchling | 173a157 | 2013-09-15 18:15:56 -0400 | [diff] [blame] | 518 | traceback |
| 519 | --------- |
| 520 | |
| 521 | A new :func:`traceback.clear_frames` function takes a traceback object |
| 522 | and clears the local variables in all of the frames it references, |
| 523 | reducing the amount of memory consumed (:issue:`1565525`). |
| 524 | |
| 525 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 526 | urllib |
| 527 | ------ |
| 528 | |
| 529 | Add support.for ``data:`` URLs in :mod:`urllib.request`. |
| 530 | |
| 531 | (Contributed by Mathias Panzenböck in :issue:`16423`.) |
| 532 | |
| 533 | |
| 534 | unittest |
| 535 | -------- |
| 536 | |
| 537 | Support for easy dynamically-generated subtests using the |
| 538 | :meth:`~unittest.TestCase.subTest` context manager. |
| 539 | |
| 540 | (Contributed by Antoine Pitrou in :issue:`16997`.) |
| 541 | |
R David Murray | 8e37d5d | 2013-04-13 14:49:48 -0400 | [diff] [blame] | 542 | |
R David Murray | 671cd32 | 2013-04-10 12:31:43 -0400 | [diff] [blame] | 543 | wave |
| 544 | ---- |
| 545 | |
| 546 | The :meth:`~wave.getparams` method now returns a namedtuple rather than a |
| 547 | plain tuple. (Contributed by Claudiu Popa in :issue:`17487`.) |
| 548 | |
R David Murray | c91d5ee | 2013-07-31 13:46:08 -0400 | [diff] [blame] | 549 | :meth:`wave.open` now supports the context manager protocol. (Contributed |
| 550 | by Claudiu Popa in :issue:`17616`.) |
| 551 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 552 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 553 | weakref |
| 554 | ------- |
| 555 | |
| 556 | New :class:`~weakref.WeakMethod` class simulates weak references to bound |
Nick Coghlan | be57ab8 | 2013-09-22 21:26:30 +1000 | [diff] [blame] | 557 | methods. (Contributed by Antoine Pitrou in :issue:`14631`.) |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 558 | |
Nick Coghlan | be57ab8 | 2013-09-22 21:26:30 +1000 | [diff] [blame] | 559 | New :class:`~weakref.finalize` class makes it possible to register a callback |
| 560 | to be invoked when an object is garbage collected, without needing to |
| 561 | carefully manage the lifecycle of the weak reference itself. (Contributed by |
| 562 | Richard Oudkerk in :issue:`15528`) |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 563 | |
| 564 | |
| 565 | xml.etree |
| 566 | --------- |
| 567 | |
| 568 | Add an event-driven parser for non-blocking applications, |
Eli Bendersky | b586934 | 2013-08-30 05:51:20 -0700 | [diff] [blame] | 569 | :class:`~xml.etree.ElementTree.XMLPullParser`. |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 570 | |
Eli Bendersky | b586934 | 2013-08-30 05:51:20 -0700 | [diff] [blame] | 571 | (Contributed by Antoine Pitrou in :issue:`17741`.) |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 572 | |
Christian Tismer | 59202e5 | 2013-10-21 03:59:23 +0200 | [diff] [blame] | 573 | |
| 574 | zipfile.PyZipfile |
| 575 | ----------------- |
| 576 | |
| 577 | Add a filter function to ignore some packages (tests for instance), |
| 578 | :meth:`~zipfile.PyZipFile.writepy`. |
| 579 | |
| 580 | (Contributed by Christian Tismer in :issue:`19274`.) |
| 581 | |
| 582 | |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 583 | Other improvements |
| 584 | ================== |
| 585 | |
| 586 | Tab-completion is now enabled by default in the interactive interpreter. |
| 587 | |
| 588 | (Contributed by Antoine Pitrou and Éric Araujo in :issue:`5845`.) |
| 589 | |
Eli Bendersky | 96d848a | 2013-09-06 06:55:58 -0700 | [diff] [blame] | 590 | Python invocation changes |
| 591 | ========================= |
| 592 | |
| 593 | Invoking the Python interpreter with ``--version`` now outputs the version to |
| 594 | standard output instead of standard error (:issue:`18338`). Similar changes |
| 595 | were made to :mod:`argparse` (:issue:`18920`) and other modules that have |
| 596 | script-like invocation capabilities (:issue:`18922`). |
Antoine Pitrou | f89aa9a | 2013-08-12 20:46:47 +0200 | [diff] [blame] | 597 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 598 | Optimizations |
| 599 | ============= |
| 600 | |
| 601 | Major performance enhancements have been added: |
| 602 | |
Victor Stinner | e64322e | 2012-10-30 23:12:47 +0100 | [diff] [blame] | 603 | * The UTF-32 decoder is now 3x to 4x faster. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 604 | |
Raymond Hettinger | c301b55 | 2013-08-19 09:12:20 -0700 | [diff] [blame] | 605 | * The cost of hash collisions for sets is now reduced. Each hash table |
Raymond Hettinger | 8408dc5 | 2013-09-15 14:57:15 -0700 | [diff] [blame] | 606 | probe now checks a series of consecutive, adjacent key/hash pairs before |
| 607 | continuing to make random probes through the hash table. This exploits |
| 608 | cache locality to make collision resolution less expensive. |
| 609 | |
| 610 | The collision resolution scheme can be described as a hybrid of linear |
| 611 | probing and open addressing. The number of additional linear probes |
| 612 | defaults to nine. This can be changed at compile-time by defining |
| 613 | LINEAR_PROBES to be any value. Set LINEAR_PROBES=0 to turn-off |
| 614 | linear probing entirely. |
Raymond Hettinger | c301b55 | 2013-08-19 09:12:20 -0700 | [diff] [blame] | 615 | |
Christian Heimes | 086b1af | 2013-10-22 11:49:34 +0200 | [diff] [blame^] | 616 | (Contributed by Raymond Hettinger in :issue:`18771`.) |
Raymond Hettinger | c301b55 | 2013-08-19 09:12:20 -0700 | [diff] [blame] | 617 | |
Christian Heimes | 17ecd1d | 2013-10-13 03:10:06 +0200 | [diff] [blame] | 618 | * The interpreter starts about 30% faster. A couple of measures lead to the |
Eric V. Smith | 57841dd | 2013-10-13 00:36:08 -0400 | [diff] [blame] | 619 | speedup. The interpreter loads fewer modules on startup, e.g. the :mod:`re`, |
Christian Heimes | 17ecd1d | 2013-10-13 03:10:06 +0200 | [diff] [blame] | 620 | :mod:`collections` and :mod:`locale` modules and their dependencies are no |
| 621 | longer imported by default. The marshal module has been improved to load |
| 622 | compiled Python code faster. |
| 623 | |
| 624 | (Contributed by Antoine Pitrou, Christian Heimes and Victor Stinner in |
| 625 | :issue:`19219`, :issue:`19218`, :issue:`19209`, :issue:`19205` and |
| 626 | :issue:`9548`) |
| 627 | |
| 628 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 629 | Build and C API Changes |
| 630 | ======================= |
| 631 | |
| 632 | Changes to Python's build process and to the C API include: |
| 633 | |
Nick Coghlan | 7d270ee | 2013-10-17 22:35:35 +1000 | [diff] [blame] | 634 | * The new :c:func:`Py_SetStandardStreamEncoding` pre-initialization API |
| 635 | allows applications embedding the CPython interpreter to reliably force |
| 636 | a particular encoding and error handler for the standard streams |
| 637 | (Contributed by Bastien Montagne and Nick Coghlan in :issue:`16129`) |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 638 | |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 639 | * Most Python C APIs that don't mutate string arguments are now correctly |
| 640 | marked as accepting ``const char *`` rather than ``char *`` (Contributed |
| 641 | by Serhiy Storchaka in :issue:`1772673`). |
| 642 | |
| 643 | * "Argument Clinic" (:pep:`436`) is now part of the CPython build process |
| 644 | and can be used to simplify the process of defining and maintaining |
| 645 | accurate signatures for builtins and standard library extension modules |
| 646 | implemented in C. |
| 647 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 648 | |
| 649 | Deprecated |
| 650 | ========== |
| 651 | |
| 652 | Unsupported Operating Systems |
| 653 | ----------------------------- |
| 654 | |
Victor Stinner | f3fd13b | 2013-08-04 10:30:57 +0200 | [diff] [blame] | 655 | * OS/2 |
Victor Stinner | f3fd13b | 2013-08-04 10:30:57 +0200 | [diff] [blame] | 656 | * Windows 2000 |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 657 | |
| 658 | |
| 659 | Deprecated Python modules, functions and methods |
| 660 | ------------------------------------------------ |
| 661 | |
Terry Jan Reedy | 2b6c26e | 2013-03-21 19:36:26 -0400 | [diff] [blame] | 662 | * :meth:`difflib.SequenceMatcher.isbjunk` and |
Andrew Kuchling | 0d0813a | 2013-06-15 13:29:09 -0400 | [diff] [blame] | 663 | :meth:`difflib.SequenceMatcher.isbpopular` were removed: use ``x in sm.bjunk`` and |
| 664 | ``x in sm.bpopular``, where *sm* is a :class:`~difflib.SequenceMatcher` object. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 665 | |
Brett Cannon | 82b3d6a | 2013-06-14 22:37:11 -0400 | [diff] [blame] | 666 | * :func:`importlib.util.module_for_loader` is pending deprecation. Using |
| 667 | :func:`importlib.util.module_to_load` and |
| 668 | :meth:`importlib.abc.Loader.init_module_attrs` allows subclasses of a loader |
| 669 | to more easily customize module loading. |
| 670 | |
Brett Cannon | e4f41de | 2013-06-16 13:13:40 -0400 | [diff] [blame] | 671 | * The :mod:`imp` module is pending deprecation. To keep compatibility with |
| 672 | Python 2/3 code bases, the module's removal is currently not scheduled. |
| 673 | |
Brett Cannon | 1448ecf | 2013-10-04 11:38:59 -0400 | [diff] [blame] | 674 | * The :mod:`formatter` module is pending deprecation and is slated for removal |
| 675 | in Python 3.6. |
| 676 | |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 677 | |
| 678 | Deprecated functions and types of the C API |
| 679 | ------------------------------------------- |
| 680 | |
Victor Stinner | 8d19767 | 2013-10-09 14:53:01 +0200 | [diff] [blame] | 681 | * The ``PyThreadState.tick_counter`` field has been value: its value was meaningless |
| 682 | since Python 3.2 ("new GIL"). |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 683 | |
| 684 | |
| 685 | Deprecated features |
| 686 | ------------------- |
| 687 | |
Nick Coghlan | 0acceb7 | 2013-10-20 13:22:21 +1000 | [diff] [blame] | 688 | * No feature deprecations are planned for Python 3.4. |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 689 | |
| 690 | |
Benjamin Peterson | 88f3b23 | 2012-10-04 12:45:10 -0400 | [diff] [blame] | 691 | Porting to Python 3.4 |
Georg Brandl | b80f511 | 2012-09-30 09:11:58 +0200 | [diff] [blame] | 692 | ===================== |
| 693 | |
| 694 | This section lists previously described changes and other bugfixes |
| 695 | that may require changes to your code. |
| 696 | |
Brett Cannon | 777622b | 2013-04-09 17:03:10 -0400 | [diff] [blame] | 697 | * The ABCs defined in :mod:`importlib.abc` now either raise the appropriate |
| 698 | exception or return a default value instead of raising |
| 699 | :exc:`NotImplementedError` blindly. This will only affect code calling |
| 700 | :func:`super` and falling through all the way to the ABCs. For compatibility, |
| 701 | catch both :exc:`NotImplementedError` or the appropriate exception as needed. |
Brett Cannon | 4c14b5d | 2013-05-04 13:56:58 -0400 | [diff] [blame] | 702 | |
| 703 | * The module type now initializes the :attr:`__package__` and :attr:`__loader__` |
| 704 | attributes to ``None`` by default. To determine if these attributes were set |
| 705 | in a backwards-compatible fashion, use e.g. |
Brett Cannon | 3dc48d6 | 2013-05-28 18:35:54 -0400 | [diff] [blame] | 706 | ``getattr(module, '__loader__', None) is not None``. |
| 707 | |
| 708 | * :meth:`importlib.util.module_for_loader` now sets ``__loader__`` and |
| 709 | ``__package__`` unconditionally to properly support reloading. If this is not |
| 710 | desired then you will need to set these attributes manually. You can use |
Brett Cannon | 028d512 | 2013-05-31 18:02:11 -0400 | [diff] [blame] | 711 | :func:`importlib.util.module_to_load` for module management. |
Brett Cannon | 3e0651b | 2013-05-31 23:18:39 -0400 | [diff] [blame] | 712 | |
| 713 | * Import now resets relevant attributes (e.g. ``__name__``, ``__loader__``, |
| 714 | ``__package__``, ``__file__``, ``__cached__``) unconditionally when reloading. |
| 715 | |
Brett Cannon | 1448ecf | 2013-10-04 11:38:59 -0400 | [diff] [blame] | 716 | * Frozen packages no longer set ``__path__`` to a list containing the package |
| 717 | name but an empty list instead. Determing if a module is a package should be |
| 718 | done using ``hasattr(module, '__path__')``. |
Brett Cannon | 8f5ac51 | 2013-06-12 23:29:18 -0400 | [diff] [blame] | 719 | |
| 720 | * :c:func:`PyErr_SetImportError` now sets :exc:`TypeError` when its **msg** |
Brett Cannon | 82da888 | 2013-07-04 17:48:16 -0400 | [diff] [blame] | 721 | argument is not set. Previously only ``NULL`` was returned with no exception |
| 722 | set. |
Brett Cannon | 33915eb | 2013-06-14 18:33:00 -0400 | [diff] [blame] | 723 | |
| 724 | * :func:`py_compile.compile` now raises :exc:`FileExistsError` if the file path |
| 725 | it would write to is a symlink or a non-regular file. This is to act as a |
| 726 | warning that import will overwrite those files with a regular file regardless |
| 727 | of what type of file path they were originally. |
Brett Cannon | f4375ef | 2013-06-16 18:05:54 -0400 | [diff] [blame] | 728 | |
| 729 | * :meth:`importlib.abc.SourceLoader.get_source` no longer raises |
| 730 | :exc:`ImportError` when the source code being loaded triggers a |
| 731 | :exc:`SyntaxError` or :exc:`UnicodeDecodeError`. As :exc:`ImportError` is |
| 732 | meant to be raised only when source code cannot be found but it should, it was |
| 733 | felt to be over-reaching/overloading of that meaning when the source code is |
| 734 | found but improperly structured. If you were catching ImportError before and |
| 735 | wish to continue to ignore syntax or decoding issues, catch all three |
Victor Stinner | 84e33c8 | 2013-06-21 00:31:55 +0200 | [diff] [blame] | 736 | exceptions now. |
Nick Coghlan | 24c05bc | 2013-07-15 21:13:08 +1000 | [diff] [blame] | 737 | |
| 738 | * :func:`functools.update_wrapper` and :func:`functools.wraps` now correctly |
| 739 | set the ``__wrapped__`` attribute even if the wrapped function had a |
| 740 | wrapped attribute set. This means ``__wrapped__`` attributes now correctly |
| 741 | link a stack of decorated functions rather than every ``__wrapped__`` |
| 742 | attribute in the chain referring to the innermost function. Introspection |
Nick Coghlan | e8c45d6 | 2013-07-28 20:00:01 +1000 | [diff] [blame] | 743 | libraries that assumed the previous behaviour was intentional can use |
| 744 | :func:`inspect.unwrap` to gain equivalent behaviour. |
Victor Stinner | 2fe9bac | 2013-10-10 16:18:20 +0200 | [diff] [blame] | 745 | |
Georg Brandl | c2228c8 | 2013-10-12 13:24:55 +0200 | [diff] [blame] | 746 | * (C API) The result of the :c:data:`PyOS_ReadlineFunctionPointer` callback must |
Victor Stinner | 2fe9bac | 2013-10-10 16:18:20 +0200 | [diff] [blame] | 747 | now be a string allocated by :c:func:`PyMem_RawMalloc` or |
| 748 | :c:func:`PyMem_RawRealloc`, or *NULL* if an error occurred, instead of a |
| 749 | string allocated by :c:func:`PyMem_Malloc` or :c:func:`PyMem_Realloc`. |
| 750 | |
Georg Brandl | 0f5bff2 | 2013-10-19 17:46:38 +0200 | [diff] [blame] | 751 | * :class:`importlib.machinery.PathFinder` now passes on the current working |
Brett Cannon | 27e27f7 | 2013-10-18 11:39:04 -0400 | [diff] [blame] | 752 | directory to objects in :data:`sys.path_hooks` for the empty string. This |
| 753 | results in :data:`sys.path_importer_cache` never containing ``''``, thus |
| 754 | iterating through :data:`sys.path_importer_cache` based on :data:`sys.path` |
| 755 | will not find all keys. A module's ``__file__`` when imported in the current |
| 756 | working directory will also now have an absolute path, including when using |
| 757 | ``-m`` with the interpreter (this does not influence when the path to a file |
| 758 | is specified on the command-line). |
| 759 | |
Georg Brandl | 0f5bff2 | 2013-10-19 17:46:38 +0200 | [diff] [blame] | 760 | * :class:`importlib.machinery.FileFinder` no longer special-cases the empty string |
Brett Cannon | 27e27f7 | 2013-10-18 11:39:04 -0400 | [diff] [blame] | 761 | to be changed to ``'.'``. |