Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1 | **************************** |
| 2 | What's New In Python 3.3 |
| 3 | **************************** |
| 4 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 5 | :Release: |release| |
| 6 | :Date: |today| |
| 7 | |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 8 | .. Rules for maintenance: |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 9 | |
| 10 | * Anyone can add text to this document. Do not spend very much time |
| 11 | on the wording of your changes, because your text will probably |
| 12 | get rewritten to some degree. |
| 13 | |
| 14 | * The maintainer will go through Misc/NEWS periodically and add |
| 15 | changes; it's therefore more important to add your changes to |
| 16 | Misc/NEWS than to this file. |
| 17 | |
| 18 | * This is not a complete list of every single change; completeness |
| 19 | is the purpose of Misc/NEWS. Some changes I consider too small |
| 20 | or esoteric to include. If such a change is added to the text, |
| 21 | I'll just remove it. (This is another reason you shouldn't spend |
| 22 | too much time on writing your addition.) |
| 23 | |
| 24 | * If you want to draw your new text to the attention of the |
| 25 | maintainer, add 'XXX' to the beginning of the paragraph or |
| 26 | section. |
| 27 | |
| 28 | * It's OK to just add a fragmentary note about a change. For |
| 29 | example: "XXX Describe the transmogrify() function added to the |
| 30 | socket module." The maintainer will research the change and |
| 31 | write the necessary text. |
| 32 | |
| 33 | * You can comment out your additions if you like, but it's not |
| 34 | necessary (especially when a final release is some months away). |
| 35 | |
| 36 | * Credit the author of a patch or bugfix. Just the name is |
| 37 | sufficient; the e-mail address isn't necessary. |
| 38 | |
| 39 | * It's helpful to add the bug/patch number as a comment: |
| 40 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 41 | XXX Describe the transmogrify() function added to the socket |
| 42 | module. |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 43 | (Contributed by P.Y. Developer in :issue:`12345`.) |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 44 | |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 45 | This saves the maintainer the effort of going through the Mercurial log |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 46 | when researching a change. |
| 47 | |
| 48 | This article explains the new features in Python 3.3, compared to 3.2. |
Georg Brandl | 1d02173 | 2012-09-29 09:06:10 +0200 | [diff] [blame] | 49 | Python 3.3 was released on September 29, 2012. |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 50 | |
Nick Coghlan | b47b539 | 2012-05-26 01:31:25 +1000 | [diff] [blame] | 51 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 52 | Summary -- Release highlights |
| 53 | ============================= |
Victor Stinner | 636130e | 2012-08-05 16:37:12 +0200 | [diff] [blame] | 54 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 55 | .. This section singles out the most important changes in Python 3.3. |
| 56 | Brevity is key. |
Victor Stinner | 636130e | 2012-08-05 16:37:12 +0200 | [diff] [blame] | 57 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 58 | New syntax features: |
Victor Stinner | 636130e | 2012-08-05 16:37:12 +0200 | [diff] [blame] | 59 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 60 | * New ``yield from`` expression for :ref:`generator delegation <pep-380>`. |
| 61 | * The ``u'unicode'`` syntax is accepted again for :class:`str` objects. |
Victor Stinner | 636130e | 2012-08-05 16:37:12 +0200 | [diff] [blame] | 62 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 63 | New library modules: |
| 64 | |
| 65 | * :mod:`faulthandler` (helps debugging low-level crashes) |
| 66 | * :mod:`ipaddress` (high-level objects representing IP addresses and masks) |
| 67 | * :mod:`lzma` (compress data using the XZ / LZMA algorithm) |
Victor Stinner | 1da769a | 2012-09-18 22:40:03 +0200 | [diff] [blame] | 68 | * :mod:`unittest.mock` (replace parts of your system under test with mock objects) |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 69 | * :mod:`venv` (Python :ref:`virtual environments <pep-405>`, as in the |
| 70 | popular ``virtualenv`` package) |
| 71 | |
| 72 | New built-in features: |
| 73 | |
| 74 | * Reworked :ref:`I/O exception hierarchy <pep-3151>`. |
| 75 | |
| 76 | Implementation improvements: |
| 77 | |
| 78 | * Rewritten :ref:`import machinery <importlib>` based on :mod:`importlib`. |
| 79 | * More compact :ref:`unicode strings <pep-393>`. |
| 80 | * More compact :ref:`attribute dictionaries <pep-412>`. |
| 81 | |
| 82 | Security improvements: |
| 83 | |
| 84 | * Hash randomization is switched on by default. |
| 85 | |
| 86 | Please read on for a comprehensive list of user-facing changes. |
| 87 | |
| 88 | |
| 89 | .. _pep-405: |
Victor Stinner | 636130e | 2012-08-05 16:37:12 +0200 | [diff] [blame] | 90 | |
Éric Araujo | 859aad6 | 2012-06-24 00:07:41 -0400 | [diff] [blame] | 91 | PEP 405: Virtual Environments |
| 92 | ============================= |
Nick Coghlan | b47b539 | 2012-05-26 01:31:25 +1000 | [diff] [blame] | 93 | |
Antoine Pitrou | a5e5797 | 2012-08-21 01:08:17 +0200 | [diff] [blame] | 94 | :pep:`405` - Python Virtual Environments |
| 95 | PEP written by Carl Meyer, implemented by Carl Meyer and Vinay Sajip. |
Nick Coghlan | b47b539 | 2012-05-26 01:31:25 +1000 | [diff] [blame] | 96 | |
Antoine Pitrou | a5e5797 | 2012-08-21 01:08:17 +0200 | [diff] [blame] | 97 | Virtual environments help create separate Python setups while sharing a |
| 98 | system-wide base install, for ease of maintenance. Virtual environments |
| 99 | have their own set of private site packages (i.e. locally-installed |
| 100 | libraries), and are optionally segregated from the system-wide site |
| 101 | packages. Their concept and implementation are inspired by the popular |
| 102 | ``virtualenv`` third-party package, but benefit from tighter integration |
| 103 | with the interpreter core. |
Éric Araujo | 859aad6 | 2012-06-24 00:07:41 -0400 | [diff] [blame] | 104 | |
Antoine Pitrou | a5e5797 | 2012-08-21 01:08:17 +0200 | [diff] [blame] | 105 | This PEP adds the :mod:`venv` module for programmatic access, and the |
| 106 | :ref:`pyvenv <scripts-pyvenv>` script for command-line access and |
| 107 | administration. The Python interpreter becomes aware of a ``pvenv.cfg`` |
| 108 | file whose existence signals the base of a virtual environment's directory |
| 109 | tree. |
Nick Coghlan | b47b539 | 2012-05-26 01:31:25 +1000 | [diff] [blame] | 110 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 111 | |
Éric Araujo | 859aad6 | 2012-06-24 00:07:41 -0400 | [diff] [blame] | 112 | PEP 420: Namespace Packages |
| 113 | =========================== |
| 114 | |
| 115 | Native support for package directories that don't require ``__init__.py`` |
| 116 | marker files and can automatically span multiple path segments (inspired by |
| 117 | various third party approaches to namespace packages, as described in |
| 118 | :pep:`420`) |
| 119 | |
| 120 | |
| 121 | .. _pep-3118-update: |
Nick Coghlan | 98e2070 | 2012-03-06 21:50:13 +1000 | [diff] [blame] | 122 | |
Stefan Krah | 9a2d99e | 2012-02-25 12:24:21 +0100 | [diff] [blame] | 123 | PEP 3118: New memoryview implementation and buffer protocol documentation |
| 124 | ========================================================================= |
| 125 | |
| 126 | :issue:`10181` - memoryview bug fixes and features. |
| 127 | Written by Stefan Krah. |
| 128 | |
| 129 | The new memoryview implementation comprehensively fixes all ownership and |
| 130 | lifetime issues of dynamically allocated fields in the Py_buffer struct |
| 131 | that led to multiple crash reports. Additionally, several functions that |
| 132 | crashed or returned incorrect results for non-contiguous or multi-dimensional |
| 133 | input have been fixed. |
| 134 | |
| 135 | The memoryview object now has a PEP-3118 compliant getbufferproc() |
| 136 | that checks the consumer's request type. Many new features have been |
| 137 | added, most of them work in full generality for non-contiguous arrays |
| 138 | and arrays with suboffsets. |
| 139 | |
| 140 | The documentation has been updated, clearly spelling out responsibilities |
| 141 | for both exporters and consumers. Buffer request flags are grouped into |
| 142 | basic and compound flags. The memory layout of non-contiguous and |
| 143 | multi-dimensional NumPy-style arrays is explained. |
| 144 | |
| 145 | Features |
| 146 | -------- |
| 147 | |
| 148 | * All native single character format specifiers in struct module syntax |
| 149 | (optionally prefixed with '@') are now supported. |
| 150 | |
| 151 | * With some restrictions, the cast() method allows changing of format and |
| 152 | shape of C-contiguous arrays. |
| 153 | |
| 154 | * Multi-dimensional list representations are supported for any array type. |
| 155 | |
| 156 | * Multi-dimensional comparisons are supported for any array type. |
| 157 | |
Stefan Krah | 9e31d36 | 2012-09-08 15:35:01 +0200 | [diff] [blame] | 158 | * One-dimensional memoryviews of hashable (read-only) types with formats B, |
| 159 | b or c are now hashable. (Contributed by Antoine Pitrou in :issue:`13411`) |
Nick Coghlan | 98e2070 | 2012-03-06 21:50:13 +1000 | [diff] [blame] | 160 | |
Stefan Krah | 9a2d99e | 2012-02-25 12:24:21 +0100 | [diff] [blame] | 161 | * Arbitrary slicing of any 1-D arrays type is supported. For example, it |
| 162 | is now possible to reverse a memoryview in O(1) by using a negative step. |
| 163 | |
| 164 | API changes |
| 165 | ----------- |
| 166 | |
| 167 | * The maximum number of dimensions is officially limited to 64. |
| 168 | |
| 169 | * The representation of empty shape, strides and suboffsets is now |
| 170 | an empty tuple instead of None. |
| 171 | |
| 172 | * Accessing a memoryview element with format 'B' (unsigned bytes) |
| 173 | now returns an integer (in accordance with the struct module syntax). |
| 174 | For returning a bytes object the view must be cast to 'c' first. |
| 175 | |
Nick Coghlan | 06e1ab0 | 2012-08-25 17:59:50 +1000 | [diff] [blame] | 176 | * memoryview comparisons now use the logical structure of the operands |
| 177 | and compare all array elements by value. All format strings in struct |
| 178 | module syntax are supported. Views with unrecognised format strings |
| 179 | are still permitted, but will always compare as unequal, regardless |
| 180 | of view contents. |
| 181 | |
Stefan Krah | 54c3203 | 2012-02-29 17:47:21 +0100 | [diff] [blame] | 182 | * For further changes see `Build and C API Changes`_ and `Porting C code`_ . |
Stefan Krah | 9a2d99e | 2012-02-25 12:24:21 +0100 | [diff] [blame] | 183 | |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 184 | .. _pep-393: |
| 185 | |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 186 | PEP 393: Flexible String Representation |
| 187 | ======================================= |
| 188 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 189 | The Unicode string type is changed to support multiple internal |
| 190 | representations, depending on the character with the largest Unicode ordinal |
| 191 | (1, 2, or 4 bytes) in the represented string. This allows a space-efficient |
| 192 | representation in common cases, but gives access to full UCS-4 on all |
| 193 | systems. For compatibility with existing APIs, several representations may |
| 194 | exist in parallel; over time, this compatibility should be phased out. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 195 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 196 | On the Python side, there should be no downside to this change. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 197 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 198 | On the C API side, PEP 393 is fully backward compatible. The legacy API |
| 199 | should remain available at least five years. Applications using the legacy |
| 200 | API will not fully benefit of the memory reduction, or - worse - may use |
| 201 | a bit more memory, because Python may have to maintain two versions of each |
| 202 | string (in the legacy format and in the new efficient storage). |
| 203 | |
Antoine Pitrou | 0599b5b | 2011-11-29 22:45:07 +0100 | [diff] [blame] | 204 | Functionality |
| 205 | ------------- |
| 206 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 207 | Changes introduced by :pep:`393` are the following: |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 208 | |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 209 | * Python now always supports the full range of Unicode codepoints, including |
| 210 | non-BMP ones (i.e. from ``U+0000`` to ``U+10FFFF``). The distinction between |
| 211 | narrow and wide builds no longer exists and Python now behaves like a wide |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 212 | build, even under Windows. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 213 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 214 | * With the death of narrow builds, the problems specific to narrow builds have |
| 215 | also been fixed, for example: |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 216 | |
| 217 | * :func:`len` now always returns 1 for non-BMP characters, |
| 218 | so ``len('\U0010FFFF') == 1``; |
| 219 | |
| 220 | * surrogate pairs are not recombined in string literals, |
| 221 | so ``'\uDBFF\uDFFF' != '\U0010FFFF'``; |
| 222 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 223 | * indexing or slicing non-BMP characters returns the expected value, |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 224 | so ``'\U0010FFFF'[0]`` now returns ``'\U0010FFFF'`` and not ``'\uDBFF'``; |
| 225 | |
Antoine Pitrou | d136aec | 2011-11-17 01:48:06 +0100 | [diff] [blame] | 226 | * all other functions in the standard library now correctly handle |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 227 | non-BMP codepoints. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 228 | |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 229 | * The value of :data:`sys.maxunicode` is now always ``1114111`` (``0x10FFFF`` |
| 230 | in hexadecimal). The :c:func:`PyUnicode_GetMax` function still returns |
| 231 | either ``0xFFFF`` or ``0x10FFFF`` for backward compatibility, and it should |
| 232 | not be used with the new Unicode API (see :issue:`13054`). |
| 233 | |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 234 | * The :file:`./configure` flag ``--with-wide-unicode`` has been removed. |
Victor Stinner | 7d637ab | 2011-09-29 02:56:16 +0200 | [diff] [blame] | 235 | |
Antoine Pitrou | 0599b5b | 2011-11-29 22:45:07 +0100 | [diff] [blame] | 236 | Performance and resource usage |
| 237 | ------------------------------ |
| 238 | |
| 239 | The storage of Unicode strings now depends on the highest codepoint in the string: |
| 240 | |
| 241 | * pure ASCII and Latin1 strings (``U+0000-U+00FF``) use 1 byte per codepoint; |
| 242 | |
| 243 | * BMP strings (``U+0000-U+FFFF``) use 2 bytes per codepoint; |
| 244 | |
| 245 | * non-BMP strings (``U+10000-U+10FFFF``) use 4 bytes per codepoint. |
| 246 | |
Martin v. Löwis | de157cc | 2012-03-06 08:42:17 +0100 | [diff] [blame] | 247 | The net effect is that for most applications, memory usage of string |
| 248 | storage should decrease significantly - especially compared to former |
| 249 | wide unicode builds - as, in many cases, strings will be pure ASCII |
| 250 | even in international contexts (because many strings store non-human |
| 251 | language data, such as XML fragments, HTTP headers, JSON-encoded data, |
| 252 | etc.). We also hope that it will, for the same reasons, increase CPU |
| 253 | cache efficiency on non-trivial applications. The memory usage of |
| 254 | Python 3.3 is two to three times smaller than Python 3.2, and a little |
| 255 | bit better than Python 2.7, on a Django benchmark (see the PEP for |
| 256 | details). |
Antoine Pitrou | 0599b5b | 2011-11-29 22:45:07 +0100 | [diff] [blame] | 257 | |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 258 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 259 | .. _pep-3151: |
| 260 | |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 261 | PEP 3151: Reworking the OS and IO exception hierarchy |
| 262 | ===================================================== |
| 263 | |
| 264 | :pep:`3151` - Reworking the OS and IO exception hierarchy |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 265 | PEP written and implemented by Antoine Pitrou. |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 266 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 267 | The hierarchy of exceptions raised by operating system errors is now both |
| 268 | simplified and finer-grained. |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 269 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 270 | You don't have to worry anymore about choosing the appropriate exception |
| 271 | type between :exc:`OSError`, :exc:`IOError`, :exc:`EnvironmentError`, |
| 272 | :exc:`WindowsError`, :exc:`mmap.error`, :exc:`socket.error` or |
| 273 | :exc:`select.error`. All these exception types are now only one: |
| 274 | :exc:`OSError`. The other names are kept as aliases for compatibility |
| 275 | reasons. |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 276 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 277 | Also, it is now easier to catch a specific error condition. Instead of |
| 278 | inspecting the ``errno`` attribute (or ``args[0]``) for a particular |
| 279 | constant from the :mod:`errno` module, you can catch the adequate |
| 280 | :exc:`OSError` subclass. The available subclasses are the following: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 281 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 282 | * :exc:`BlockingIOError` |
| 283 | * :exc:`ChildProcessError` |
| 284 | * :exc:`ConnectionError` |
| 285 | * :exc:`FileExistsError` |
| 286 | * :exc:`FileNotFoundError` |
| 287 | * :exc:`InterruptedError` |
| 288 | * :exc:`IsADirectoryError` |
| 289 | * :exc:`NotADirectoryError` |
| 290 | * :exc:`PermissionError` |
| 291 | * :exc:`ProcessLookupError` |
| 292 | * :exc:`TimeoutError` |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 293 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 294 | And the :exc:`ConnectionError` itself has finer-grained subclasses: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 295 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 296 | * :exc:`BrokenPipeError` |
| 297 | * :exc:`ConnectionAbortedError` |
| 298 | * :exc:`ConnectionRefusedError` |
| 299 | * :exc:`ConnectionResetError` |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 300 | |
| 301 | Thanks to the new exceptions, common usages of the :mod:`errno` can now be |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 302 | avoided. For example, the following code written for Python 3.2:: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 303 | |
| 304 | from errno import ENOENT, EACCES, EPERM |
| 305 | |
| 306 | try: |
| 307 | with open("document.txt") as f: |
| 308 | content = f.read() |
| 309 | except IOError as err: |
| 310 | if err.errno == ENOENT: |
| 311 | print("document.txt file is missing") |
| 312 | elif err.errno in (EACCES, EPERM): |
| 313 | print("You are not allowed to read document.txt") |
| 314 | else: |
| 315 | raise |
| 316 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 317 | can now be written without the :mod:`errno` import and without manual |
| 318 | inspection of exception attributes:: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 319 | |
| 320 | try: |
| 321 | with open("document.txt") as f: |
| 322 | content = f.read() |
| 323 | except FileNotFoundError: |
| 324 | print("document.txt file is missing") |
| 325 | except PermissionError: |
| 326 | print("You are not allowed to read document.txt") |
| 327 | |
| 328 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 329 | .. _pep-380: |
| 330 | |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 331 | PEP 380: Syntax for Delegating to a Subgenerator |
| 332 | ================================================ |
| 333 | |
Nick Coghlan | ab7bf21 | 2012-02-26 17:49:52 +1000 | [diff] [blame] | 334 | :pep:`380` - Syntax for Delegating to a Subgenerator |
| 335 | PEP written by Greg Ewing. |
| 336 | |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 337 | PEP 380 adds the ``yield from`` expression, allowing a generator to delegate |
| 338 | part of its operations to another generator. This allows a section of code |
| 339 | containing 'yield' to be factored out and placed in another generator. |
| 340 | Additionally, the subgenerator is allowed to return with a value, and the |
| 341 | value is made available to the delegating generator. |
Nick Coghlan | b9b281b | 2012-03-06 22:31:12 +1000 | [diff] [blame] | 342 | |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 343 | While designed primarily for use in delegating to a subgenerator, the ``yield |
| 344 | from`` expression actually allows delegation to arbitrary subiterators. |
| 345 | |
Nick Coghlan | b9b281b | 2012-03-06 22:31:12 +1000 | [diff] [blame] | 346 | For simple iterators, ``yield from iterable`` is essentially just a shortened |
| 347 | form of ``for item in iterable: yield item``:: |
| 348 | |
| 349 | >>> def g(x): |
| 350 | ... yield from range(x, 0, -1) |
| 351 | ... yield from range(x) |
| 352 | ... |
| 353 | >>> list(g(5)) |
| 354 | [5, 4, 3, 2, 1, 0, 1, 2, 3, 4] |
| 355 | |
| 356 | However, unlike an ordinary loop, ``yield from`` allows subgenerators to |
| 357 | receive sent and thrown values directly from the calling scope, and |
| 358 | return a final value to the outer generator:: |
| 359 | |
| 360 | >>> def accumulate(start=0): |
| 361 | ... tally = start |
| 362 | ... while 1: |
| 363 | ... next = yield |
| 364 | ... if next is None: |
| 365 | ... return tally |
| 366 | ... tally += next |
| 367 | ... |
| 368 | >>> def gather_tallies(tallies, start=0): |
| 369 | ... while 1: |
| 370 | ... tally = yield from accumulate() |
| 371 | ... tallies.append(tally) |
| 372 | ... |
| 373 | >>> tallies = [] |
| 374 | >>> acc = gather_tallies(tallies) |
| 375 | >>> next(acc) # Ensure the accumulator is ready to accept values |
| 376 | >>> for i in range(10): |
| 377 | ... acc.send(i) |
| 378 | ... |
| 379 | >>> acc.send(None) # Finish the first tally |
| 380 | >>> for i in range(5): |
| 381 | ... acc.send(i) |
| 382 | ... |
| 383 | >>> acc.send(None) # Finish the second tally |
| 384 | >>> tallies |
| 385 | [45, 10] |
| 386 | |
| 387 | The main principle driving this change is to allow even generators that are |
| 388 | designed to be used with the ``send`` and ``throw`` methods to be split into |
| 389 | multiple subgenerators as easily as a single large function can be split into |
| 390 | multiple subfunctions. |
| 391 | |
Nick Coghlan | 1f7ce62 | 2012-01-13 21:43:40 +1000 | [diff] [blame] | 392 | (Implementation by Greg Ewing, integrated into 3.3 by Renaud Blanch, Ryan |
| 393 | Kelly and Nick Coghlan, documentation by Zbigniew Jędrzejewski-Szmek and |
| 394 | Nick Coghlan) |
| 395 | |
| 396 | |
Nick Coghlan | ab7bf21 | 2012-02-26 17:49:52 +1000 | [diff] [blame] | 397 | PEP 409: Suppressing exception context |
| 398 | ====================================== |
| 399 | |
| 400 | :pep:`409` - Suppressing exception context |
| 401 | PEP written by Ethan Furman, implemented by Ethan Furman and Nick Coghlan. |
| 402 | |
| 403 | PEP 409 introduces new syntax that allows the display of the chained |
| 404 | exception context to be disabled. This allows cleaner error messages in |
| 405 | applications that convert between exception types:: |
| 406 | |
| 407 | >>> class D: |
| 408 | ... def __init__(self, extra): |
| 409 | ... self._extra_attributes = extra |
| 410 | ... def __getattr__(self, attr): |
| 411 | ... try: |
| 412 | ... return self._extra_attributes[attr] |
| 413 | ... except KeyError: |
| 414 | ... raise AttributeError(attr) from None |
| 415 | ... |
| 416 | >>> D({}).x |
| 417 | Traceback (most recent call last): |
| 418 | File "<stdin>", line 1, in <module> |
| 419 | File "<stdin>", line 8, in __getattr__ |
| 420 | AttributeError: x |
| 421 | |
| 422 | Without the ``from None`` suffix to suppress the cause, the original |
| 423 | exception would be displayed by default:: |
| 424 | |
| 425 | >>> class C: |
| 426 | ... def __init__(self, extra): |
| 427 | ... self._extra_attributes = extra |
| 428 | ... def __getattr__(self, attr): |
| 429 | ... try: |
| 430 | ... return self._extra_attributes[attr] |
| 431 | ... except KeyError: |
| 432 | ... raise AttributeError(attr) |
| 433 | ... |
| 434 | >>> C({}).x |
| 435 | Traceback (most recent call last): |
| 436 | File "<stdin>", line 6, in __getattr__ |
| 437 | KeyError: 'x' |
| 438 | |
| 439 | During handling of the above exception, another exception occurred: |
| 440 | |
| 441 | Traceback (most recent call last): |
| 442 | File "<stdin>", line 1, in <module> |
| 443 | File "<stdin>", line 8, in __getattr__ |
| 444 | AttributeError: x |
| 445 | |
| 446 | No debugging capability is lost, as the original exception context remains |
| 447 | available if needed (for example, if an intervening library has incorrectly |
| 448 | suppressed valuable underlying details):: |
| 449 | |
| 450 | >>> try: |
| 451 | ... D({}).x |
| 452 | ... except AttributeError as exc: |
| 453 | ... print(repr(exc.__context__)) |
| 454 | ... |
| 455 | KeyError('x',) |
| 456 | |
| 457 | |
Nick Coghlan | 98e2070 | 2012-03-06 21:50:13 +1000 | [diff] [blame] | 458 | PEP 414: Explicit Unicode literals |
| 459 | ====================================== |
| 460 | |
| 461 | :pep:`414` - Explicit Unicode literals |
| 462 | PEP written by Armin Ronacher. |
| 463 | |
| 464 | To ease the transition from Python 2 for Unicode aware Python applications |
| 465 | that make heavy use of Unicode literals, Python 3.3 once again supports the |
| 466 | "``u``" prefix for string literals. This prefix has no semantic significance |
| 467 | in Python 3, it is provided solely to reduce the number of purely mechanical |
| 468 | changes in migrating to Python 3, making it easier for developers to focus on |
| 469 | the more significant semantic changes (such as the stricter default |
| 470 | separation of binary and text data). |
| 471 | |
| 472 | |
Antoine Pitrou | 6bbd76b | 2011-11-25 19:10:05 +0100 | [diff] [blame] | 473 | PEP 3155: Qualified name for classes and functions |
| 474 | ================================================== |
| 475 | |
| 476 | :pep:`3155` - Qualified name for classes and functions |
| 477 | PEP written and implemented by Antoine Pitrou. |
| 478 | |
| 479 | Functions and class objects have a new ``__qualname__`` attribute representing |
| 480 | the "path" from the module top-level to their definition. For global functions |
| 481 | and classes, this is the same as ``__name__``. For other functions and classes, |
| 482 | it provides better information about where they were actually defined, and |
| 483 | how they might be accessible from the global scope. |
| 484 | |
| 485 | Example with (non-bound) methods:: |
Nick Coghlan | 2dfe6b0 | 2012-01-14 14:19:49 +1000 | [diff] [blame] | 486 | |
Antoine Pitrou | 6bbd76b | 2011-11-25 19:10:05 +0100 | [diff] [blame] | 487 | >>> class C: |
| 488 | ... def meth(self): |
| 489 | ... pass |
| 490 | >>> C.meth.__name__ |
| 491 | 'meth' |
| 492 | >>> C.meth.__qualname__ |
| 493 | 'C.meth' |
| 494 | |
| 495 | Example with nested classes:: |
| 496 | |
| 497 | >>> class C: |
| 498 | ... class D: |
| 499 | ... def meth(self): |
| 500 | ... pass |
| 501 | ... |
| 502 | >>> C.D.__name__ |
| 503 | 'D' |
| 504 | >>> C.D.__qualname__ |
| 505 | 'C.D' |
| 506 | >>> C.D.meth.__name__ |
| 507 | 'meth' |
| 508 | >>> C.D.meth.__qualname__ |
| 509 | 'C.D.meth' |
| 510 | |
| 511 | Example with nested functions:: |
| 512 | |
| 513 | >>> def outer(): |
| 514 | ... def inner(): |
| 515 | ... pass |
| 516 | ... return inner |
| 517 | ... |
| 518 | >>> outer().__name__ |
| 519 | 'inner' |
| 520 | >>> outer().__qualname__ |
| 521 | 'outer.<locals>.inner' |
| 522 | |
Antoine Pitrou | e7ede06 | 2011-11-25 19:11:26 +0100 | [diff] [blame] | 523 | The string representation of those objects is also changed to include the |
Antoine Pitrou | 6bbd76b | 2011-11-25 19:10:05 +0100 | [diff] [blame] | 524 | new, more precise information:: |
| 525 | |
| 526 | >>> str(C.D) |
| 527 | "<class '__main__.C.D'>" |
| 528 | >>> str(C.D.meth) |
| 529 | '<function C.D.meth at 0x7f46b9fe31e0>' |
| 530 | |
| 531 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 532 | .. _pep-412: |
| 533 | |
Antoine Pitrou | d94adb7 | 2012-07-07 17:33:42 +0200 | [diff] [blame] | 534 | PEP 412: Key-Sharing Dictionary |
| 535 | =============================== |
| 536 | |
| 537 | :pep:`412` - Key-Sharing Dictionary |
| 538 | PEP written and implemented by Mark Shannon. |
| 539 | |
| 540 | Dictionaries used for the storage of objects' attributes are now able to |
| 541 | share part of their internal storage between each other (namely, the part |
| 542 | which stores the keys and their respective hashes). This reduces the memory |
| 543 | consumption of programs creating many instances of non-builtin types. |
| 544 | |
| 545 | |
Andrew Svetlov | ac23c9e | 2012-08-13 21:27:56 +0300 | [diff] [blame] | 546 | PEP 362: Function Signature Object |
| 547 | ================================== |
| 548 | |
| 549 | :pep:`362`: - Function Signature Object |
| 550 | PEP written by Brett Cannon, Yury Selivanov, Larry Hastings, Jiwon Seo. |
| 551 | Implemented by Yury Selivanov. |
| 552 | |
| 553 | A new function :func:`inspect.signature` makes introspection of python |
| 554 | callables easy and straightforward. A broad range of callables is supported: |
| 555 | python functions, decorated or not, classes, and :func:`functools.partial` |
| 556 | objects. New classes :class:`inspect.Signature`, :class:`inspect.Parameter` |
| 557 | and :class:`inspect.BoundArguments` hold information about the call signatures, |
| 558 | such as, annotations, default values, parameters kinds, and bound arguments, |
| 559 | which considerably simplifies writing decorators and any code that validates |
| 560 | or amends calling signatures or arguments. |
| 561 | |
| 562 | |
Eric Snow | b2a61e1 | 2012-09-05 22:19:38 -0700 | [diff] [blame] | 563 | PEP 421: Adding sys.implementation |
| 564 | ================================== |
| 565 | |
| 566 | :pep:`421` - Adding sys.implementation |
| 567 | PEP written and implemented by Eric Snow. |
| 568 | |
| 569 | A new attribute on the :mod:`sys` module exposes details specific to the |
| 570 | implementation of the currently running interpreter. The initial set of |
| 571 | attributes on :attr:`sys.implementation` are ``name``, ``version``, |
| 572 | ``hexversion``, and ``cache_tag``. |
| 573 | |
| 574 | The intention of ``sys.implementation`` is to consolidate into one namespace |
| 575 | the implementation-specific data used by the standard library. This allows |
| 576 | different Python implementations to share a single standard library code base |
| 577 | much more easily. In its initial state, ``sys.implementation`` holds only a |
| 578 | small portion of the implementation-specific data. Over time that ratio will |
| 579 | shift in order to make the standard library more portable. |
| 580 | |
| 581 | One example of improved standard library portability is ``cache_tag``. As of |
| 582 | Python 3.3, ``sys.implementation.cache_tag`` is used by :mod:`importlib` to |
| 583 | support :pep:`3147` compliance. Any Python implementation that uses |
| 584 | ``importlib`` for its built-in import system may use ``cache_tag`` to control |
| 585 | the caching behavior for modules. |
| 586 | |
| 587 | SimpleNamespace |
| 588 | --------------- |
| 589 | |
| 590 | The implementation of ``sys.implementation`` also introduces a new type to |
| 591 | Python: :class:`types.SimpleNamespace`. In contrast to a mapping-based |
| 592 | namespace, like :class:`dict`, ``SimpleNamespace`` is attribute-based, like |
| 593 | :class:`object`. However, unlike ``object``, ``SimpleNamespace`` instances |
| 594 | are writable. This means that you can add, remove, and modify the namespace |
| 595 | through normal attribute access. |
| 596 | |
| 597 | |
Antoine Pitrou | c907de9 | 2012-08-21 00:53:06 +0200 | [diff] [blame] | 598 | .. _importlib: |
| 599 | |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 600 | Using importlib as the Implementation of Import |
| 601 | =============================================== |
| 602 | :issue:`2377` - Replace __import__ w/ importlib.__import__ |
| 603 | :issue:`13959` - Re-implement parts of :mod:`imp` in pure Python |
| 604 | :issue:`14605` - Make import machinery explicit |
| 605 | :issue:`14646` - Require loaders set __loader__ and __package__ |
| 606 | |
| 607 | (Written by Brett Cannon) |
| 608 | |
| 609 | The :func:`__import__` function is now powered by :func:`importlib.__import__`. |
| 610 | This work leads to the completion of "phase 2" of :pep:`302`. There are |
| 611 | multiple benefits to this change. First, it has allowed for more of the |
| 612 | machinery powering import to be exposed instead of being implicit and hidden |
| 613 | within the C code. It also provides a single implementation for all Python VMs |
| 614 | supporting Python 3.3 to use, helping to end any VM-specific deviations in |
| 615 | import semantics. And finally it eases the maintenance of import, allowing for |
| 616 | future growth to occur. |
| 617 | |
R David Murray | cff1c6f | 2012-09-29 14:34:43 -0400 | [diff] [blame] | 618 | For the common user, there should be no visible change in semantics. For |
| 619 | those whose code currently manipulates import or calls import |
| 620 | programmatically, the code changes that might possibly be required are covered |
| 621 | in the `Porting Python code`_ section of this document. |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 622 | |
| 623 | New APIs |
| 624 | -------- |
| 625 | One of the large benefits of this work is the exposure of what goes into |
| 626 | making the import statement work. That means the various importers that were |
| 627 | once implicit are now fully exposed as part of the :mod:`importlib` package. |
| 628 | |
Brett Cannon | 077ef45 | 2012-08-02 17:50:06 -0400 | [diff] [blame] | 629 | The abstract base classes defined in :mod:`importlib.abc` have been expanded |
| 630 | to properly delineate between :term:`meta path finders <meta path finder>` |
| 631 | and :term:`path entry finders <path entry finder>` by introducing |
| 632 | :class:`importlib.abc.MetaPathFinder` and |
| 633 | :class:`importlib.abc.PathEntryFinder`, respectively. The old ABC of |
| 634 | :class:`importlib.abc.Finder` is now only provided for backwards-compatibility |
| 635 | and does not enforce any method requirements. |
| 636 | |
| 637 | In terms of finders, :class:`importlib.machinery.FileFinder` exposes the |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 638 | mechanism used to search for source and bytecode files of a module. Previously |
| 639 | this class was an implicit member of :attr:`sys.path_hooks`. |
| 640 | |
| 641 | For loaders, the new abstract base class :class:`importlib.abc.FileLoader` helps |
| 642 | write a loader that uses the file system as the storage mechanism for a module's |
| 643 | code. The loader for source files |
| 644 | (:class:`importlib.machinery.SourceFileLoader`), sourceless bytecode files |
| 645 | (:class:`importlib.machinery.SourcelessFileLoader`), and extension modules |
| 646 | (:class:`importlib.machinery.ExtensionFileLoader`) are now available for |
| 647 | direct use. |
| 648 | |
| 649 | :exc:`ImportError` now has ``name`` and ``path`` attributes which are set when |
| 650 | there is relevant data to provide. The message for failed imports will also |
| 651 | provide the full name of the module now instead of just the tail end of the |
| 652 | module's name. |
| 653 | |
| 654 | The :func:`importlib.invalidate_caches` function will now call the method with |
| 655 | the same name on all finders cached in :attr:`sys.path_importer_cache` to help |
| 656 | clean up any stored state as necessary. |
| 657 | |
| 658 | Visible Changes |
| 659 | --------------- |
| 660 | [For potential required changes to code, see the `Porting Python code`_ |
| 661 | section] |
| 662 | |
| 663 | Beyond the expanse of what :mod:`importlib` now exposes, there are other |
| 664 | visible changes to import. The biggest is that :attr:`sys.meta_path` and |
Brett Cannon | 077ef45 | 2012-08-02 17:50:06 -0400 | [diff] [blame] | 665 | :attr:`sys.path_hooks` now store all of the meta path finders and path entry |
| 666 | hooks used by import. Previously the finders were implicit and hidden within |
| 667 | the C code of import instead of being directly exposed. This means that one can |
| 668 | now easily remove or change the order of the various finders to fit one's needs. |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 669 | |
| 670 | Another change is that all modules have a ``__loader__`` attribute, storing the |
| 671 | loader used to create the module. :pep:`302` has been updated to make this |
| 672 | attribute mandatory for loaders to implement, so in the future once 3rd-party |
| 673 | loaders have been updated people will be able to rely on the existence of the |
| 674 | attribute. Until such time, though, import is setting the module post-load. |
| 675 | |
| 676 | Loaders are also now expected to set the ``__package__`` attribute from |
| 677 | :pep:`366`. Once again, import itself is already setting this on all loaders |
| 678 | from :mod:`importlib` and import itself is setting the attribute post-load. |
| 679 | |
| 680 | ``None`` is now inserted into :attr:`sys.path_importer_cache` when no finder |
| 681 | can be found on :attr:`sys.path_hooks`. Since :class:`imp.NullImporter` is not |
| 682 | directly exposed on :attr:`sys.path_hooks` it could no longer be relied upon to |
| 683 | always be available to use as a value representing no finder found. |
| 684 | |
| 685 | All other changes relate to semantic changes which should be taken into |
| 686 | consideration when updating code for Python 3.3, and thus should be read about |
| 687 | in the `Porting Python code`_ section of this document. |
| 688 | |
| 689 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 690 | Other Language Changes |
| 691 | ====================== |
| 692 | |
| 693 | Some smaller changes made to the core Python language are: |
| 694 | |
Antoine Pitrou | 7b578b3 | 2011-11-29 22:47:11 +0100 | [diff] [blame] | 695 | * Added support for Unicode name aliases and named sequences. |
| 696 | Both :func:`unicodedata.lookup()` and ``'\N{...}'`` now resolve name aliases, |
| 697 | and :func:`unicodedata.lookup()` resolves named sequences too. |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 698 | |
Antoine Pitrou | 7b578b3 | 2011-11-29 22:47:11 +0100 | [diff] [blame] | 699 | (Contributed by Ezio Melotti in :issue:`12753`) |
Ezio Melotti | 931b8aa | 2011-10-21 21:57:36 +0300 | [diff] [blame] | 700 | |
Nick Coghlan | c4bacd3 | 2012-09-27 19:58:31 +1000 | [diff] [blame] | 701 | * Unicode database updated to UCD version 6.1.0 |
| 702 | |
Antoine Pitrou | 7b578b3 | 2011-11-29 22:47:11 +0100 | [diff] [blame] | 703 | * Equality comparisons on :func:`range` objects now return a result reflecting |
| 704 | the equality of the underlying sequences generated by those range objects. |
Ezio Melotti | 931b8aa | 2011-10-21 21:57:36 +0300 | [diff] [blame] | 705 | |
Sandro Tosi | cd89912 | 2012-01-22 12:16:04 +0100 | [diff] [blame] | 706 | (:issue:`13201`) |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 707 | |
Antoine Pitrou | 7b578b3 | 2011-11-29 22:47:11 +0100 | [diff] [blame] | 708 | * The ``count()``, ``find()``, ``rfind()``, ``index()`` and ``rindex()`` |
| 709 | methods of :class:`bytes` and :class:`bytearray` objects now accept an |
| 710 | integer between 0 and 255 as their first argument. |
Mark Dickinson | 3664568 | 2011-10-23 19:53:01 +0100 | [diff] [blame] | 711 | |
Petri Lehtinen | 6c3f1dd | 2012-06-26 10:23:07 +0300 | [diff] [blame] | 712 | (Contributed by Petri Lehtinen in :issue:`12170`) |
Mark Dickinson | 3664568 | 2011-10-23 19:53:01 +0100 | [diff] [blame] | 713 | |
Eli Bendersky | 7add4ea | 2012-03-17 15:14:35 +0200 | [diff] [blame] | 714 | * New methods have been added to :class:`list` and :class:`bytearray`: |
| 715 | ``copy()`` and ``clear()``. |
| 716 | |
| 717 | (:issue:`10516`) |
Petri Lehtinen | 61ea8a0 | 2011-11-24 22:00:46 +0200 | [diff] [blame] | 718 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 719 | * Raw bytes literals can now be written ``rb"..."`` as well as ``br"..."``. |
| 720 | (Contributed by Antoine Pitrou in :issue:`13748`.) |
| 721 | |
| 722 | * :meth:`dict.setdefault` now does only one lookup for the given key, making |
| 723 | it atomic when used with built-in types. |
| 724 | (Contributed by Filip Gruszczyński in :issue:`13521`.) |
| 725 | |
| 726 | |
Benjamin Peterson | e50d6ab | 2012-04-03 00:52:18 -0400 | [diff] [blame] | 727 | .. XXX mention new error messages for passing wrong number of arguments to functions |
| 728 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 729 | |
Antoine Pitrou | 79341e7 | 2012-05-17 21:13:45 +0200 | [diff] [blame] | 730 | A Finer-Grained Import Lock |
| 731 | =========================== |
| 732 | |
| 733 | Previous versions of CPython have always relied on a global import lock. |
| 734 | This led to unexpected annoyances, such as deadlocks when importing a module |
| 735 | would trigger code execution in a different thread as a side-effect. |
| 736 | Clumsy workarounds were sometimes employed, such as the |
| 737 | :c:func:`PyImport_ImportModuleNoBlock` C API function. |
| 738 | |
| 739 | In Python 3.3, importing a module takes a per-module lock. This correctly |
| 740 | serializes importation of a given module from multiple threads (preventing |
| 741 | the exposure of incompletely initialized modules), while eliminating the |
| 742 | aforementioned annoyances. |
| 743 | |
| 744 | (contributed by Antoine Pitrou in :issue:`9260`.) |
| 745 | |
| 746 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 747 | Builtin functions and types |
| 748 | =========================== |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 749 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 750 | * :func:`open` gets a new *opener* parameter: the underlying file descriptor |
| 751 | for the file object is then obtained by calling *opener* with (*file*, |
| 752 | *flags*). It can be used to use custom flags like :data:`os.O_CLOEXEC` for |
| 753 | example. The ``'x'`` mode was added: open for exclusive creation, failing if |
| 754 | the file already exists. |
| 755 | * :func:`print`: added the *flush* keyword argument. If the *flush* keyword |
| 756 | argument is true, the stream is forcibly flushed. |
| 757 | * :func:`hash`: hash randomization is enabled by default, see |
| 758 | :meth:`object.__hash__` and :envvar:`PYTHONHASHSEED`. |
| 759 | * The :class:`str` type gets a new :meth:`~str.casefold` method: return a |
| 760 | casefolded copy of the string, casefolded strings may be used for caseless |
| 761 | matching. For example, ``'ß'.casefold()`` returns ``'ss'``. |
Nick Coghlan | 273069c | 2012-08-20 17:14:07 +1000 | [diff] [blame] | 762 | * The sequence documentation has been substantially rewritten to better |
| 763 | explain the binary/text sequence distinction and to provide specific |
| 764 | documentation sections for the individual builtin sequence types |
| 765 | (:issue:`4966`) |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 766 | |
Victor Stinner | 636130e | 2012-08-05 16:37:12 +0200 | [diff] [blame] | 767 | New Modules |
| 768 | =========== |
| 769 | |
| 770 | faulthandler |
| 771 | ------------ |
| 772 | |
Victor Stinner | 1da769a | 2012-09-18 22:40:03 +0200 | [diff] [blame] | 773 | This new debug module :mod:`faulthandler` contains functions to dump Python tracebacks explicitly, |
Victor Stinner | 636130e | 2012-08-05 16:37:12 +0200 | [diff] [blame] | 774 | on a fault (a crash like a segmentation fault), after a timeout, or on a user |
| 775 | signal. Call :func:`faulthandler.enable` to install fault handlers for the |
| 776 | :const:`SIGSEGV`, :const:`SIGFPE`, :const:`SIGABRT`, :const:`SIGBUS`, and |
| 777 | :const:`SIGILL` signals. You can also enable them at startup by setting the |
| 778 | :envvar:`PYTHONFAULTHANDLER` environment variable or by using :option:`-X` |
| 779 | ``faulthandler`` command line option. |
| 780 | |
| 781 | Example of a segmentation fault on Linux: :: |
| 782 | |
| 783 | $ python -q -X faulthandler |
| 784 | >>> import ctypes |
| 785 | >>> ctypes.string_at(0) |
| 786 | Fatal Python error: Segmentation fault |
| 787 | |
| 788 | Current thread 0x00007fb899f39700: |
| 789 | File "/home/python/cpython/Lib/ctypes/__init__.py", line 486 in string_at |
| 790 | File "<stdin>", line 1 in <module> |
| 791 | Segmentation fault |
| 792 | |
| 793 | |
| 794 | ipaddress |
| 795 | --------- |
| 796 | |
| 797 | The new :mod:`ipaddress` module provides tools for creating and manipulating |
| 798 | objects representing IPv4 and IPv6 addresses, networks and interfaces (i.e. |
| 799 | an IP address associated with a specific IP subnet). |
| 800 | |
| 801 | (Contributed by Google and Peter Moody in :pep:`3144`) |
| 802 | |
| 803 | lzma |
| 804 | ---- |
| 805 | |
| 806 | The newly-added :mod:`lzma` module provides data compression and decompression |
| 807 | using the LZMA algorithm, including support for the ``.xz`` and ``.lzma`` |
| 808 | file formats. |
| 809 | |
| 810 | (Contributed by Nadeem Vawda and Per Øyvind Karlsen in :issue:`6715`) |
| 811 | |
| 812 | |
| 813 | Improved Modules |
| 814 | ================ |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 815 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 816 | abc |
| 817 | --- |
| 818 | |
| 819 | Improved support for abstract base classes containing descriptors composed with |
| 820 | abstract methods. The recommended approach to declaring abstract descriptors is |
| 821 | now to provide :attr:`__isabstractmethod__` as a dynamically updated |
| 822 | property. The built-in descriptors have been updated accordingly. |
| 823 | |
| 824 | * :class:`abc.abstractproperty` has been deprecated, use :class:`property` |
| 825 | with :func:`abc.abstractmethod` instead. |
| 826 | * :class:`abc.abstractclassmethod` has been deprecated, use |
| 827 | :class:`classmethod` with :func:`abc.abstractmethod` instead. |
| 828 | * :class:`abc.abstractstaticmethod` has been deprecated, use |
| 829 | :class:`staticmethod` with :func:`abc.abstractmethod` instead. |
| 830 | |
| 831 | (Contributed by Darren Dale in :issue:`11610`) |
| 832 | |
Meador Inge | c5dbb3d | 2011-09-20 21:48:16 -0500 | [diff] [blame] | 833 | array |
| 834 | ----- |
| 835 | |
| 836 | The :mod:`array` module supports the :c:type:`long long` type using ``q`` and |
| 837 | ``Q`` type codes. |
| 838 | |
| 839 | (Contributed by Oren Tirosh and Hirokazu Yamamoto in :issue:`1172711`) |
| 840 | |
| 841 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 842 | base64, binascii |
| 843 | ---------------- |
| 844 | |
| 845 | ASCII-only Unicode strings are now accepted by the decoding functions of the |
| 846 | modern interface. For example, ``base64.b64decode('YWJj')`` returns ``b'abc'``. |
| 847 | |
| 848 | |
Nadeem Vawda | d7e5c6e | 2012-02-12 01:34:18 +0200 | [diff] [blame] | 849 | bz2 |
| 850 | --- |
| 851 | |
| 852 | The :mod:`bz2` module has been rewritten from scratch. In the process, several |
| 853 | new features have been added: |
| 854 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 855 | * New :func:`bz2.open` function: open a bzip2-compressed file in binary or |
| 856 | text mode. |
| 857 | |
Nadeem Vawda | d7e5c6e | 2012-02-12 01:34:18 +0200 | [diff] [blame] | 858 | * :class:`bz2.BZ2File` can now read from and write to arbitrary file-like |
| 859 | objects, by means of its constructor's *fileobj* argument. |
| 860 | |
| 861 | (Contributed by Nadeem Vawda in :issue:`5863`) |
| 862 | |
| 863 | * :class:`bz2.BZ2File` and :func:`bz2.decompress` can now decompress |
| 864 | multi-stream inputs (such as those produced by the :program:`pbzip2` tool). |
| 865 | :class:`bz2.BZ2File` can now also be used to create this type of file, using |
| 866 | the ``'a'`` (append) mode. |
| 867 | |
| 868 | (Contributed by Nir Aides in :issue:`1625`) |
| 869 | |
| 870 | * :class:`bz2.BZ2File` now implements all of the :class:`io.BufferedIOBase` API, |
| 871 | except for the :meth:`detach` and :meth:`truncate` methods. |
| 872 | |
| 873 | |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 874 | codecs |
| 875 | ------ |
| 876 | |
Antoine Pitrou | 4f86343 | 2012-02-12 02:12:47 +0100 | [diff] [blame] | 877 | The :mod:`~encodings.mbcs` codec has been rewritten to handle correctly |
Georg Brandl | ff962c5 | 2012-02-04 08:55:56 +0100 | [diff] [blame] | 878 | ``replace`` and ``ignore`` error handlers on all Windows versions. The |
| 879 | :mod:`~encodings.mbcs` codec now supports all error handlers, instead of only |
| 880 | ``replace`` to encode and ``ignore`` to decode. |
Victor Stinner | 3a50e70 | 2011-10-18 21:21:00 +0200 | [diff] [blame] | 881 | |
Georg Brandl | ff962c5 | 2012-02-04 08:55:56 +0100 | [diff] [blame] | 882 | A new Windows-only codec has been added: ``cp65001`` (:issue:`13216`). It is the |
| 883 | Windows code page 65001 (Windows UTF-8, ``CP_UTF8``). For example, it is used |
| 884 | by ``sys.stdout`` if the console output code page is set to cp65001 (e.g., using |
| 885 | ``chcp 65001`` command). |
Victor Stinner | 2f3ca9f | 2011-10-27 01:38:56 +0200 | [diff] [blame] | 886 | |
Georg Brandl | ff962c5 | 2012-02-04 08:55:56 +0100 | [diff] [blame] | 887 | Multibyte CJK decoders now resynchronize faster. They only ignore the first |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 888 | byte of an invalid byte sequence. For example, ``b'\xff\n'.decode('gb2312', |
| 889 | 'replace')`` now returns a ``\n`` after the replacement character. |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 890 | |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 891 | (:issue:`12016`) |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 892 | |
Georg Brandl | ff962c5 | 2012-02-04 08:55:56 +0100 | [diff] [blame] | 893 | Incremental CJK codec encoders are no longer reset at each call to their |
| 894 | encode() methods. For example:: |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 895 | |
| 896 | $ ./python -q |
| 897 | >>> import codecs |
| 898 | >>> encoder = codecs.getincrementalencoder('hz')('strict') |
| 899 | >>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.') |
| 900 | b'~{NpJ)l6HK!#~} Bye.' |
| 901 | |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 902 | This example gives ``b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.'`` with older Python |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 903 | versions. |
| 904 | |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 905 | (:issue:`12100`) |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 906 | |
Victor Stinner | 9f4b1e9 | 2011-11-10 20:56:30 +0100 | [diff] [blame] | 907 | The ``unicode_internal`` codec has been deprecated. |
| 908 | |
Éric Araujo | 4f61a2d | 2012-04-04 23:01:01 -0400 | [diff] [blame] | 909 | |
| 910 | collections |
| 911 | ----------- |
| 912 | |
| 913 | Addition of a new :class:`~collections.ChainMap` class to allow treating a |
| 914 | number of mappings as a single unit. |
| 915 | |
| 916 | (Written by Raymond Hettinger for :issue:`11089`, made public in |
| 917 | :issue:`11297`) |
| 918 | |
| 919 | The abstract base classes have been moved in a new :mod:`collections.abc` |
| 920 | module, to better differentiate between the abstract and the concrete |
| 921 | collections classes. Aliases for ABCs are still present in the |
| 922 | :mod:`collections` module to preserve existing imports. |
| 923 | |
| 924 | (:issue:`11085`) |
| 925 | |
| 926 | .. XXX addition of __slots__ to ABCs not recorded here: internal detail |
| 927 | |
| 928 | |
Nick Coghlan | 3267a30 | 2012-05-21 22:54:43 +1000 | [diff] [blame] | 929 | contextlib |
| 930 | ---------- |
| 931 | |
Giampaolo Rodola' | 15c8849 | 2012-09-25 12:00:04 -0700 | [diff] [blame] | 932 | :class:`~contextlib.ExitStack` now provides a solid foundation for |
Nick Coghlan | 3267a30 | 2012-05-21 22:54:43 +1000 | [diff] [blame] | 933 | programmatic manipulation of context managers and similar cleanup |
| 934 | functionality. Unlike the previous ``contextlib.nested`` API (which was |
| 935 | deprecated and removed), the new API is designed to work correctly |
| 936 | regardless of whether context managers acquire their resources in |
Nick Coghlan | 161ea6a | 2012-05-22 23:04:42 +1000 | [diff] [blame] | 937 | their ``__init__`` method (for example, file objects) or in their |
Nick Coghlan | 3267a30 | 2012-05-21 22:54:43 +1000 | [diff] [blame] | 938 | ``__enter__`` method (for example, synchronisation objects from the |
| 939 | :mod:`threading` module). |
| 940 | |
| 941 | (:issue:`13585`) |
| 942 | |
| 943 | |
Éric Araujo | 84b8ed8 | 2011-08-29 21:42:47 +0200 | [diff] [blame] | 944 | crypt |
| 945 | ----- |
| 946 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 947 | Addition of salt and modular crypt format (hashing method) and the :func:`~crypt.mksalt` |
Victor Stinner | c78fb33 | 2011-09-21 03:35:44 +0200 | [diff] [blame] | 948 | function to the :mod:`crypt` module. |
Éric Araujo | 84b8ed8 | 2011-08-29 21:42:47 +0200 | [diff] [blame] | 949 | |
| 950 | (:issue:`10924`) |
| 951 | |
Victor Stinner | a7878b7 | 2011-07-14 23:07:44 +0200 | [diff] [blame] | 952 | curses |
| 953 | ------ |
| 954 | |
Victor Stinner | 0fdfceb | 2011-11-25 22:10:02 +0100 | [diff] [blame] | 955 | * If the :mod:`curses` module is linked to the ncursesw library, use Unicode |
| 956 | functions when Unicode strings or characters are passed (e.g. |
| 957 | :c:func:`waddwstr`), and bytes functions otherwise (e.g. :c:func:`waddstr`). |
| 958 | * Use the locale encoding instead of ``utf-8`` to encode Unicode strings. |
| 959 | * :class:`curses.window` has a new :attr:`curses.window.encoding` attribute. |
Victor Stinner | c78fb33 | 2011-09-21 03:35:44 +0200 | [diff] [blame] | 960 | * The :class:`curses.window` class has a new :meth:`~curses.window.get_wch` |
| 961 | method to get a wide character |
| 962 | * The :mod:`curses` module has a new :meth:`~curses.unget_wch` function to |
| 963 | push a wide character so the next :meth:`~curses.window.get_wch` will return |
| 964 | it |
Victor Stinner | a7878b7 | 2011-07-14 23:07:44 +0200 | [diff] [blame] | 965 | |
Victor Stinner | c78fb33 | 2011-09-21 03:35:44 +0200 | [diff] [blame] | 966 | (Contributed by Iñigo Serna in :issue:`6755`) |
Victor Stinner | a7878b7 | 2011-07-14 23:07:44 +0200 | [diff] [blame] | 967 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 968 | datetime |
| 969 | -------- |
| 970 | |
| 971 | * Equality comparisons between naive and aware :class:`~datetime.datetime` |
Nick Coghlan | 3658cb3 | 2012-09-27 20:07:45 +1000 | [diff] [blame] | 972 | instances now return :const:`False` instead of raising :exc:`TypeError`. |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 973 | * New :meth:`datetime.datetime.timestamp` method: Return POSIX timestamp |
| 974 | corresponding to the :class:`~datetime.datetime` instance. |
| 975 | * The :meth:`datetime.datetime.strftime` method supports formatting years |
| 976 | older than 1000. |
R David Murray | defdb16 | 2012-09-29 10:53:31 -0400 | [diff] [blame] | 977 | * The :meth:`datetime.datetime.astimezone` method can now be |
Alexander Belopolsky | 35d600c | 2012-08-22 23:14:29 -0400 | [diff] [blame] | 978 | called without arguments to convert datetime instance to the system |
| 979 | timezone. |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 980 | |
Stefan Krah | 1919b7e | 2012-03-21 18:25:23 +0100 | [diff] [blame] | 981 | decimal |
| 982 | ------- |
| 983 | |
| 984 | :issue:`7652` - integrate fast native decimal arithmetic. |
| 985 | C-module and libmpdec written by Stefan Krah. |
| 986 | |
| 987 | The new C version of the decimal module integrates the high speed libmpdec |
Stefan Krah | bf80308 | 2012-04-01 13:07:24 +0200 | [diff] [blame] | 988 | library for arbitrary precision correctly-rounded decimal floating point |
| 989 | arithmetic. libmpdec conforms to IBM's General Decimal Arithmetic Specification. |
Stefan Krah | 1919b7e | 2012-03-21 18:25:23 +0100 | [diff] [blame] | 990 | |
Stefan Krah | 0c0914e | 2012-04-09 20:31:15 +0200 | [diff] [blame] | 991 | Performance gains range from 10x for database applications to 100x for |
Stefan Krah | bf80308 | 2012-04-01 13:07:24 +0200 | [diff] [blame] | 992 | numerically intensive applications. These numbers are expected gains |
| 993 | for standard precisions used in decimal floating point arithmetic. Since |
| 994 | the precision is user configurable, the exact figures may vary. For example, |
| 995 | in integer bignum arithmetic the differences can be significantly higher. |
| 996 | |
| 997 | The following table is meant as an illustration. Benchmarks are available |
Georg Brandl | 204e789 | 2012-04-01 13:10:58 +0200 | [diff] [blame] | 998 | at http://www.bytereef.org/mpdecimal/quickstart.html. |
Stefan Krah | 1919b7e | 2012-03-21 18:25:23 +0100 | [diff] [blame] | 999 | |
| 1000 | +---------+-------------+--------------+-------------+ |
| 1001 | | | decimal.py | _decimal | speedup | |
| 1002 | +=========+=============+==============+=============+ |
Stefan Krah | a3f4a16 | 2012-09-01 14:27:51 +0200 | [diff] [blame] | 1003 | | pi | 42.02s | 0.345s | 120x | |
Stefan Krah | 1919b7e | 2012-03-21 18:25:23 +0100 | [diff] [blame] | 1004 | +---------+-------------+--------------+-------------+ |
| 1005 | | telco | 172.19s | 5.68s | 30x | |
| 1006 | +---------+-------------+--------------+-------------+ |
| 1007 | | psycopg | 3.57s | 0.29s | 12x | |
| 1008 | +---------+-------------+--------------+-------------+ |
| 1009 | |
| 1010 | Features |
| 1011 | ~~~~~~~~ |
| 1012 | |
| 1013 | * The :exc:`~decimal.FloatOperation` signal optionally enables stricter |
| 1014 | semantics for mixing floats and Decimals. |
| 1015 | |
| 1016 | * If Python is compiled without threads, the C version automatically |
| 1017 | disables the expensive thread local context machinery. In this case, |
| 1018 | the variable :data:`~decimal.HAVE_THREADS` is set to False. |
| 1019 | |
| 1020 | API changes |
| 1021 | ~~~~~~~~~~~ |
| 1022 | |
| 1023 | * The C module has the following context limits, depending on the machine |
| 1024 | architecture: |
| 1025 | |
| 1026 | +-------------------+---------------------+------------------------------+ |
| 1027 | | | 32-bit | 64-bit | |
| 1028 | +===================+=====================+==============================+ |
| 1029 | | :const:`MAX_PREC` | :const:`425000000` | :const:`999999999999999999` | |
| 1030 | +-------------------+---------------------+------------------------------+ |
| 1031 | | :const:`MAX_EMAX` | :const:`425000000` | :const:`999999999999999999` | |
| 1032 | +-------------------+---------------------+------------------------------+ |
| 1033 | | :const:`MIN_EMIN` | :const:`-425000000` | :const:`-999999999999999999` | |
| 1034 | +-------------------+---------------------+------------------------------+ |
| 1035 | |
| 1036 | * In the context templates (:class:`~decimal.DefaultContext`, |
| 1037 | :class:`~decimal.BasicContext` and :class:`~decimal.ExtendedContext`) |
| 1038 | the magnitude of :attr:`~decimal.Context.Emax` and |
| 1039 | :attr:`~decimal.Context.Emin` has changed to :const:`999999`. |
| 1040 | |
| 1041 | * The :class:`~decimal.Decimal` constructor in decimal.py does not observe |
| 1042 | the context limits and converts values with arbitrary exponents or precision |
| 1043 | exactly. Since the C version has internal limits, the following scheme is |
| 1044 | used: If possible, values are converted exactly, otherwise |
| 1045 | :exc:`~decimal.InvalidOperation` is raised and the result is NaN. In the |
| 1046 | latter case it is always possible to use :meth:`~decimal.Context.create_decimal` |
| 1047 | in order to obtain a rounded or inexact value. |
| 1048 | |
| 1049 | |
| 1050 | * The power function in decimal.py is always correctly-rounded. In the |
| 1051 | C version, it is defined in terms of the correctly-rounded |
| 1052 | :meth:`~decimal.Decimal.exp` and :meth:`~decimal.Decimal.ln` functions, |
| 1053 | but the final result is only "almost always correctly rounded". |
| 1054 | |
| 1055 | |
| 1056 | * In the C version, the context dictionary containing the signals is a |
| 1057 | :class:`~collections.abc.MutableMapping`. For speed reasons, |
| 1058 | :attr:`~decimal.Context.flags` and :attr:`~decimal.Context.traps` always |
| 1059 | refer to the same :class:`~collections.abc.MutableMapping` that the context |
| 1060 | was initialized with. If a new signal dictionary is assigned, |
| 1061 | :attr:`~decimal.Context.flags` and :attr:`~decimal.Context.traps` |
| 1062 | are updated with the new values, but they do not reference the RHS |
| 1063 | dictionary. |
| 1064 | |
| 1065 | |
| 1066 | * Pickling a :class:`~decimal.Context` produces a different output in order |
| 1067 | to have a common interchange format for the Python and C versions. |
| 1068 | |
| 1069 | |
| 1070 | * The order of arguments in the :class:`~decimal.Context` constructor has been |
| 1071 | changed to match the order displayed by :func:`repr`. |
| 1072 | |
| 1073 | |
Stefan Krah | af3f3a7 | 2012-08-30 12:33:55 +0200 | [diff] [blame] | 1074 | * The ``watchexp`` parameter in the :meth:`~decimal.Decimal.quantize` method |
| 1075 | is deprecated. |
| 1076 | |
| 1077 | |
R David Murray | 77ac351 | 2012-09-29 15:43:33 -0400 | [diff] [blame^] | 1078 | email |
| 1079 | ----- |
| 1080 | |
| 1081 | Policy Framework |
| 1082 | ~~~~~~~~~~~~~~~~ |
| 1083 | |
| 1084 | The email package now has a :mod:`~email.policy` framework. A |
| 1085 | :class:`~email.policy.Policy` is an object with several methods and properties |
| 1086 | that control how the email package behaves. The primary policy for Python 3.3 |
| 1087 | is the :class:`~email.policy.Compat32` policy, which provides backward |
| 1088 | compatibility with the email package in Python 3.2. A ``policy`` can be |
| 1089 | specified when an email message is parsed by a :mod:`~email.parser`, or when a |
| 1090 | :class:`~email.message.Message` object is created, or when an email is |
| 1091 | serialized using a :mod:`~email.generator`. Unless overridden, a policy passed |
| 1092 | to a ``parser`` is inherited by all the ``Message`` object and sub-objects |
| 1093 | created by the ``parser``. By default a ``generator`` will use the policy of |
| 1094 | the ``Message`` object it is serializing. The default policy is |
| 1095 | :data:`~email.policy.compat32`. |
| 1096 | |
| 1097 | The minimum set of controls implemented by all ``policy`` objects are: |
| 1098 | |
| 1099 | =============== ======================================================= |
| 1100 | max_line_length The maximum length, excluding the linesep character(s), |
| 1101 | individual lines may have when a ``Message`` is |
| 1102 | serialized. Defaults to 78. |
| 1103 | |
| 1104 | linesep The character used to separate individual lines when a |
| 1105 | ``Message`` is serialized. Defaults to ``\n``. |
| 1106 | |
| 1107 | cte_type ``7bit`` or ``8bit``. ``8bit`` applies only to a |
| 1108 | ``Bytes`` ``generator``, and means that non-ASCII may |
| 1109 | be used where allowed by the protocol (or where it |
| 1110 | exists in the original input). |
| 1111 | |
| 1112 | raise_on_defect Causes a ``parser`` to raise error when defects are |
| 1113 | encountered instead of adding them to the ``Message`` |
| 1114 | object's ``defects`` list. |
| 1115 | =============== ======================================================= |
| 1116 | |
| 1117 | A new policy instance, with new settings, is created using the |
| 1118 | :meth:`~email.policy.Policy.clone` method of policy objects. ``clone`` takes |
| 1119 | any of the above controls as keyword arguments. Any control not specified in |
| 1120 | the call retains its default value. Thus you can create a policy that uses |
| 1121 | ``\r\n`` linesep characters like this:: |
| 1122 | |
| 1123 | mypolicy = compat32.clone(linesep='\r\n') |
| 1124 | |
| 1125 | Policies can be used to make the generation of messages in the format needed by |
| 1126 | your application simpler. Instead of having to remember to specify |
| 1127 | ``linesep='\r\n'`` in all the places you call a ``generator``, you can specify |
| 1128 | it once, when you set the policy used by the ``parser`` or the ``Message``, |
| 1129 | whichever your program uses to create ``Message`` objects. On the other hand, |
| 1130 | if you need to generate messages in multiple forms, you can still specify the |
| 1131 | parameters in the appropriate ``generator`` call. Or you can have custom |
| 1132 | policy instances for your different cases, and pass those in when you create |
| 1133 | the ``generator``. |
| 1134 | |
| 1135 | |
| 1136 | Provisional Policy with New Header API |
| 1137 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 1138 | |
| 1139 | While the policy framework is worthwhile all by itself, the main motivation for |
| 1140 | introducing it is to allow the creation of new policies that implement new |
| 1141 | features for the email package in a way that maintains backward compatibility |
| 1142 | for those who do not use the new policies. Because the new policies introduce a |
| 1143 | new API, we are releasing them in Python 3.3 as a :term:`provisional policy |
| 1144 | <provisional package>`. Backwards incompatible changes (up to and including |
| 1145 | removal of the code) may occur if deemed necessary by the core developers. |
| 1146 | |
| 1147 | The new policies are instances of :class:`~email.policy.EmailPolicy`, |
| 1148 | and add the following additional controls: |
| 1149 | |
| 1150 | =============== ======================================================= |
| 1151 | refold_source Controls whether or not headers parsed by a |
| 1152 | :mod:`~email.parser` are refolded by the |
| 1153 | :mod:`~email.generator`. It can be ``none``, ``long``, |
| 1154 | or ``all``. The default is ``long``, which means that |
| 1155 | source headers with a line longer than |
| 1156 | ``max_line_length`` get refolded. ``none`` means no |
| 1157 | line get refolded, and ``all`` means that all lines |
| 1158 | get refolded. |
| 1159 | |
| 1160 | header_factory A callable that take a ``name`` and ``value`` and |
| 1161 | produces a custom header object. |
| 1162 | =============== ======================================================= |
| 1163 | |
| 1164 | The ``header_factory`` is the key to the new features provided by the new |
| 1165 | policies. When one of the new policies is used, any header retrieved from |
| 1166 | a ``Message`` object is an object produced by the ``header_factory``, and any |
| 1167 | time you set a header on a ``Message`` it becomes an object produced by |
| 1168 | ``header_factory``. All such header objects have a ``name`` attribute equal |
| 1169 | to the header name. Address and Date headers have additional attributes |
| 1170 | that give you access to the parsed data of the header. This means you can now |
| 1171 | do things like this:: |
| 1172 | |
| 1173 | >>> m = Message(policy=SMTP) |
| 1174 | >>> m['To'] = 'Éric <foo@example.com>' |
| 1175 | >>> m['to'] |
| 1176 | 'Éric <foo@example.com>' |
| 1177 | >>> m['to'].addresses |
| 1178 | (Address(display_name='Éric', username='foo', domain='example.com'),) |
| 1179 | >>> m['to'].addresses[0].username |
| 1180 | 'foo' |
| 1181 | >>> m['to'].addresses[0].display_name |
| 1182 | 'Éric' |
| 1183 | >>> m['Date'] = email.utils.localtime() |
| 1184 | >>> m['Date'].datetime |
| 1185 | datetime.datetime(2012, 5, 25, 21, 39, 24, 465484, tzinfo=datetime.timezone(datetime.timedelta(-1, 72000), 'EDT')) |
| 1186 | >>> m['Date'] |
| 1187 | 'Fri, 25 May 2012 21:44:27 -0400' |
| 1188 | >>> print(m) |
| 1189 | To: =?utf-8?q?=C3=89ric?= <foo@example.com> |
| 1190 | Date: Fri, 25 May 2012 21:44:27 -0400 |
| 1191 | |
| 1192 | You will note that the unicode display name is automatically encoded as |
| 1193 | ``utf-8`` when the message is serialized, but that when the header is accessed |
| 1194 | directly, you get the unicode version. This eliminates any need to deal with |
| 1195 | the :mod:`email.header` :meth:`~email.header.decode_header` or |
| 1196 | :meth:`~email.header.make_header` functions. |
| 1197 | |
| 1198 | You can also create addresses from parts:: |
| 1199 | |
| 1200 | >>> m['cc'] = [Group('pals', [Address('Bob', 'bob', 'example.com'), |
| 1201 | ... Address('Sally', 'sally', 'example.com')]), |
| 1202 | ... Address('Bonzo', addr_spec='bonz@laugh.com')] |
| 1203 | >>> print(m) |
| 1204 | To: =?utf-8?q?=C3=89ric?= <foo@example.com> |
| 1205 | Date: Fri, 25 May 2012 21:44:27 -0400 |
| 1206 | cc: pals: Bob <bob@example.com>, Sally <sally@example.com>;, Bonzo <bonz@laugh.com> |
| 1207 | |
| 1208 | Decoding to unicode is done automatically:: |
| 1209 | |
| 1210 | >>> m2 = message_from_string(str(m)) |
| 1211 | >>> m2['to'] |
| 1212 | 'Éric <foo@example.com>' |
| 1213 | |
| 1214 | When you parse a message, you can use the ``addresses`` and ``groups`` |
| 1215 | attributes of the header objects to access the groups and individual |
| 1216 | addresses:: |
| 1217 | |
| 1218 | >>> m2['cc'].addresses |
| 1219 | (Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com'), Address(display_name='Bonzo', username='bonz', domain='laugh.com')) |
| 1220 | >>> m2['cc'].groups |
| 1221 | (Group(display_name='pals', addresses=(Address(display_name='Bob', username='bob', domain='example.com'), Address(display_name='Sally', username='sally', domain='example.com')), Group(display_name=None, addresses=(Address(display_name='Bonzo', username='bonz', domain='laugh.com'),)) |
| 1222 | |
| 1223 | In summary, if you use one of the new policies, header manipulation works the |
| 1224 | way it ought to: your application works with unicode strings, and the email |
| 1225 | package transparently encodes and decodes the unicode to and from the RFC |
| 1226 | standard Content Transfer Encodings. |
| 1227 | |
| 1228 | |
Victor Stinner | 811db3b | 2011-09-21 03:20:03 +0200 | [diff] [blame] | 1229 | ftplib |
| 1230 | ------ |
| 1231 | |
Giampaolo Rodola' | 49379c0 | 2012-09-25 12:32:46 -0700 | [diff] [blame] | 1232 | * The :class:`~ftplib.FTP_TLS` class now provides a new |
| 1233 | :func:`~ftplib.FTP_TLS.ccc` function to revert control channel back to |
| 1234 | plaintext. This can be useful to take advantage of firewalls that know how to |
| 1235 | handle NAT with non-secure FTP without opening fixed ports. |
Victor Stinner | 811db3b | 2011-09-21 03:20:03 +0200 | [diff] [blame] | 1236 | |
Giampaolo Rodola' | 49379c0 | 2012-09-25 12:32:46 -0700 | [diff] [blame] | 1237 | (Contributed by Giampaolo Rodolà in :issue:`12139`) |
Victor Stinner | 811db3b | 2011-09-21 03:20:03 +0200 | [diff] [blame] | 1238 | |
Giampaolo Rodola' | 49379c0 | 2012-09-25 12:32:46 -0700 | [diff] [blame] | 1239 | * Added :meth:`ftplib.FTP.mlsd` method which provides a parsable directory |
| 1240 | listing format and deprecates :meth:`ftplib.FTP.nlst` and |
| 1241 | :meth:`ftplib.FTP.dir`. |
| 1242 | |
| 1243 | (Contributed by Giampaolo Rodolà in :issue:`11072`) |
Victor Stinner | 811db3b | 2011-09-21 03:20:03 +0200 | [diff] [blame] | 1244 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 1245 | gc |
| 1246 | -- |
| 1247 | |
| 1248 | It is now possible to register callbacks invoked by the garbage collector |
Georg Brandl | a81b481 | 2012-08-11 08:43:59 +0200 | [diff] [blame] | 1249 | before and after collection using the new :data:`~gc.callbacks` list. |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 1250 | |
| 1251 | |
Christian Heimes | 3194037 | 2012-06-26 10:16:55 +0200 | [diff] [blame] | 1252 | hmac |
| 1253 | ---- |
| 1254 | |
| 1255 | A new :func:`~hmac.compare_digest` function has been added to prevent |
| 1256 | side channel attacks on digests through timing analysis. |
| 1257 | |
| 1258 | (Contributed by Nick Coghlan and Christian Heimes in issue:`15061`) |
| 1259 | |
| 1260 | |
Ezio Melotti | 461f41d | 2012-09-26 17:43:23 +0300 | [diff] [blame] | 1261 | html.entities |
| 1262 | ------------- |
| 1263 | |
| 1264 | A new :data:`~html.entities.html5` dictionary that maps HTML5 named character |
| 1265 | references to the equivalent Unicode character(s) (e.g. ``html5['gt;'] == '>'``) |
| 1266 | has been added to the :mod:`html.entities` module. The dictionary is now also |
| 1267 | used by :class:`~html.parser.HTMLParser`. |
| 1268 | |
| 1269 | (Contributed by Ezio Melotti in :issue:`11113` and :issue:`15156`) |
| 1270 | |
| 1271 | |
| 1272 | html.parser |
| 1273 | ----------- |
| 1274 | |
| 1275 | :class:`~html.parser.HTMLParser` is now able to parse broken markup without |
| 1276 | raising errors, therefore the *strict* argument of the constructor and the |
| 1277 | :exc:`~html.parser.HTMLParseError` exception are now deprecated. |
| 1278 | The ability to parse broken markup is the result of a number of bug fixes that |
| 1279 | are also available on the latest bug fix releases of Python 2.7/3.2. |
| 1280 | |
| 1281 | (Contributed by Ezio Melotti in :issue:`15114`, and :issue:`14538`, |
| 1282 | :issue:`13993`, :issue:`13960`, :issue:`13358`, :issue:`1745761`, |
| 1283 | :issue:`755670`, :issue:`13357`, :issue:`12629`, :issue:`1200313`, |
| 1284 | :issue:`670664`, :issue:`13273`, :issue:`12888`, :issue:`7311`) |
| 1285 | |
Antoine Pitrou | 5a8bc6f | 2011-11-17 02:20:48 +0100 | [diff] [blame] | 1286 | imaplib |
| 1287 | ------- |
| 1288 | |
| 1289 | The :class:`~imaplib.IMAP4_SSL` constructor now accepts an SSLContext |
| 1290 | parameter to control parameters of the secure channel. |
| 1291 | |
| 1292 | (Contributed by Sijin Joseph in :issue:`8808`) |
| 1293 | |
| 1294 | |
Nick Coghlan | 2f92e54 | 2012-06-23 19:39:55 +1000 | [diff] [blame] | 1295 | inspect |
| 1296 | ------- |
| 1297 | |
| 1298 | A new :func:`~inspect.getclosurevars` function has been added. This function |
| 1299 | reports the current binding of all names referenced from the function body and |
| 1300 | where those names were resolved, making it easier to verify correct internal |
| 1301 | state when testing code that relies on stateful closures. |
| 1302 | |
| 1303 | (Contributed by Meador Inge and Nick Coghlan in :issue:`13062`) |
| 1304 | |
Nick Coghlan | 04e2e3f | 2012-06-23 19:52:05 +1000 | [diff] [blame] | 1305 | A new :func:`~inspect.getgeneratorlocals` function has been added. This |
| 1306 | function reports the current binding of local variables in the generator's |
| 1307 | stack frame, making it easier to verify correct internal state when testing |
| 1308 | generators. |
| 1309 | |
| 1310 | (Contributed by Meador Inge in :issue:`15153`) |
| 1311 | |
Charles-François Natali | dc3044c | 2012-01-09 22:40:02 +0100 | [diff] [blame] | 1312 | io |
| 1313 | -- |
| 1314 | |
Charles-François Natali | d612de1 | 2012-01-14 11:51:00 +0100 | [diff] [blame] | 1315 | The :func:`~io.open` function has a new ``'x'`` mode that can be used to |
| 1316 | exclusively create a new file, and raise a :exc:`FileExistsError` if the file |
| 1317 | already exists. It is based on the C11 'x' mode to fopen(). |
Charles-François Natali | dc3044c | 2012-01-09 22:40:02 +0100 | [diff] [blame] | 1318 | |
| 1319 | (Contributed by David Townshend in :issue:`12760`) |
| 1320 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 1321 | The constructor of the :class:`~io.TextIOWrapper` class has a new |
| 1322 | *write_through* optional argument. If *write_through* is ``True``, calls to |
| 1323 | :meth:`~io.TextIOWrapper.write` are guaranteed not to be buffered: any data |
| 1324 | written on the :class:`~io.TextIOWrapper` object is immediately handled to its |
| 1325 | underlying binary buffer. |
| 1326 | |
Charles-François Natali | dc3044c | 2012-01-09 22:40:02 +0100 | [diff] [blame] | 1327 | |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 1328 | math |
| 1329 | ---- |
| 1330 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1331 | The :mod:`math` module has a new function, :func:`~math.log2`, which returns |
| 1332 | the base-2 logarithm of *x*. |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 1333 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1334 | (Written by Mark Dickinson in :issue:`11888`). |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 1335 | |
| 1336 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1337 | multiprocessing |
| 1338 | --------------- |
| 1339 | |
| 1340 | The new :func:`multiprocessing.connection.wait` function allows to poll |
| 1341 | multiple objects (such as connections, sockets and pipes) with a timeout. |
| 1342 | (Contributed by Richard Oudkerk in :issue:`12328`.) |
| 1343 | |
| 1344 | :class:`multiprocessing.Connection` objects can now be transferred over |
| 1345 | multiprocessing connections. |
| 1346 | (Contributed by Richard Oudkerk in :issue:`4892`.) |
| 1347 | |
| 1348 | |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 1349 | nntplib |
| 1350 | ------- |
| 1351 | |
| 1352 | The :class:`nntplib.NNTP` class now supports the context manager protocol to |
| 1353 | unconditionally consume :exc:`socket.error` exceptions and to close the NNTP |
| 1354 | connection when done:: |
| 1355 | |
| 1356 | >>> from nntplib import NNTP |
Ezio Melotti | 3c14b4e | 2011-07-13 11:44:44 +0300 | [diff] [blame] | 1357 | >>> with NNTP('news.gmane.org') as n: |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 1358 | ... n.group('gmane.comp.python.committers') |
| 1359 | ... |
Ezio Melotti | 04f648c | 2011-07-26 09:37:46 +0300 | [diff] [blame] | 1360 | ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers') |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 1361 | >>> |
| 1362 | |
| 1363 | (Contributed by Giampaolo Rodolà in :issue:`9795`) |
| 1364 | |
| 1365 | |
Giampaolo Rodolà | c9c2c8b | 2011-02-25 14:39:16 +0000 | [diff] [blame] | 1366 | os |
| 1367 | -- |
| 1368 | |
Charles-François Natali | a003af1 | 2011-06-01 20:30:52 +0200 | [diff] [blame] | 1369 | * The :mod:`os` module has a new :func:`~os.pipe2` function that makes it |
| 1370 | possible to create a pipe with :data:`~os.O_CLOEXEC` or |
| 1371 | :data:`~os.O_NONBLOCK` flags set atomically. This is especially useful to |
| 1372 | avoid race conditions in multi-threaded programs. |
| 1373 | |
Giampaolo Rodolà | 18e8bcb | 2011-02-25 20:57:54 +0000 | [diff] [blame] | 1374 | * The :mod:`os` module has a new :func:`~os.sendfile` function which provides |
| 1375 | an efficent "zero-copy" way for copying data from one file (or socket) |
| 1376 | descriptor to another. The phrase "zero-copy" refers to the fact that all of |
| 1377 | the copying of data between the two descriptors is done entirely by the |
| 1378 | kernel, with no copying of data into userspace buffers. :func:`~os.sendfile` |
| 1379 | can be used to efficiently copy data from a file on disk to a network socket, |
| 1380 | e.g. for downloading a file. |
Giampaolo Rodolà | c9c2c8b | 2011-02-25 14:39:16 +0000 | [diff] [blame] | 1381 | |
Giampaolo Rodolà | 18e8bcb | 2011-02-25 20:57:54 +0000 | [diff] [blame] | 1382 | (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in :issue:`10882`.) |
| 1383 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1384 | * To avoid race conditions like symlink attacks and issues with temporary |
| 1385 | files and directories, it is more reliable (and also faster) to manipulate |
| 1386 | file descriptors instead of file names. Python 3.3 enhances existing functions |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 1387 | and introduces new functions to work on file descriptors (:issue:`4761`, |
Larry Hastings | 9471797 | 2012-09-21 09:30:19 -0700 | [diff] [blame] | 1388 | :issue:`10755` and :issue:`14626`). |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1389 | |
| 1390 | - The :mod:`os` module has a new :func:`~os.fwalk` function similar to |
| 1391 | :func:`~os.walk` except that it also yields file descriptors referring to the |
| 1392 | directories visited. This is especially useful to avoid symlink races. |
| 1393 | |
| 1394 | - The following functions get new optional *dir_fd* (:ref:`paths relative to |
| 1395 | directory descriptors <dir_fd>`) and/or *follow_symlinks* (:ref:`not |
| 1396 | following symlinks <follow_symlinks>`): |
| 1397 | :func:`~os.access`, :func:`~os.chflags`, :func:`~os.chmod`, :func:`~os.chown`, |
| 1398 | :func:`~os.link`, :func:`~os.lstat`, :func:`~os.mkdir`, :func:`~os.mkfifo`, |
| 1399 | :func:`~os.mknod`, :func:`~os.open`, :func:`~os.readlink`, :func:`~os.remove`, |
| 1400 | :func:`~os.rename`, :func:`~os.replace`, :func:`~os.rmdir`, :func:`~os.stat`, |
| 1401 | :func:`~os.symlink`, :func:`~os.unlink`, :func:`~os.utime`. |
| 1402 | |
| 1403 | - The following functions now support a file descriptor for their path argument: |
| 1404 | :func:`~os.chdir`, :func:`~os.chmod`, :func:`~os.chown`, |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 1405 | :func:`~os.execve`, :func:`~os.listdir`, :func:`~os.pathconf`, :func:`~os.path.exists`, |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1406 | :func:`~os.stat`, :func:`~os.statvfs`, :func:`~os.utime`. |
| 1407 | |
Giampaolo Rodolà | 18e8bcb | 2011-02-25 20:57:54 +0000 | [diff] [blame] | 1408 | * The :mod:`os` module has two new functions: :func:`~os.getpriority` and |
| 1409 | :func:`~os.setpriority`. They can be used to get or set process |
| 1410 | niceness/priority in a fashion similar to :func:`os.nice` but extended to all |
| 1411 | processes instead of just the current one. |
| 1412 | |
| 1413 | (Patch submitted by Giampaolo Rodolà in :issue:`10784`.) |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1414 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1415 | * The new :func:`os.replace` function allows cross-platform renaming of a |
| 1416 | file with overwriting the destination. With :func:`os.rename`, an existing |
| 1417 | destination file is overwritten under POSIX, but raises an error under |
| 1418 | Windows. |
| 1419 | (Contributed by Antoine Pitrou in :issue:`8828`.) |
| 1420 | |
Larry Hastings | 9471797 | 2012-09-21 09:30:19 -0700 | [diff] [blame] | 1421 | * The stat family of functions (:func:`~os.stat`, :func:`~os.fstat`, |
| 1422 | and :func:`~os.lstat`) now support reading a file's timestamps |
| 1423 | with nanosecond precision. Symmetrically, :func:`~os.utime` |
| 1424 | can now write file timestamps with nanosecond precision. (Contributed by |
| 1425 | Larry Hastings in :issue:`14127`.) |
| 1426 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1427 | * The new :func:`os.get_terminal_size` function queries the size of the |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1428 | terminal attached to a file descriptor. See also |
| 1429 | :func:`shutil.get_terminal_size`. |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1430 | (Contributed by Zbigniew Jędrzejewski-Szmek in :issue:`13609`.) |
| 1431 | |
Georg Brandl | dba3b5c | 2012-06-26 09:36:14 +0200 | [diff] [blame] | 1432 | .. XXX sort out this mess after beta1 |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1433 | |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 1434 | * New functions to support Linux extended attributes (:issue:`12720`): |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1435 | :func:`~os.getxattr`, :func:`~os.listxattr`, :func:`~os.removexattr`, |
| 1436 | :func:`~os.setxattr`. |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1437 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1438 | * New interface to the scheduler. These functions |
| 1439 | control how a process is allocated CPU time by the operating system. New |
| 1440 | functions: |
| 1441 | :func:`~os.sched_get_priority_max`, :func:`~os.sched_get_priority_min`, |
| 1442 | :func:`~os.sched_getaffinity`, :func:`~os.sched_getparam`, |
| 1443 | :func:`~os.sched_getscheduler`, :func:`~os.sched_rr_get_interval`, |
| 1444 | :func:`~os.sched_setaffinity`, :func:`~os.sched_setparam`, |
| 1445 | :func:`~os.sched_setscheduler`, :func:`~os.sched_yield`, |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1446 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1447 | * New functions to control the file system: |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1448 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1449 | * :func:`~os.posix_fadvise`: Announces an intention to access data in a |
| 1450 | specific pattern thus allowing the kernel to make optimizations. |
| 1451 | * :func:`~os.posix_fallocate`: Ensures that enough disk space is allocated |
| 1452 | for a file. |
| 1453 | * :func:`~os.sync`: Force write of everything to disk. |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1454 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1455 | * Add some extra posix functions to the os module: |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1456 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1457 | * :func:`~os.lockf`: Apply, test or remove a POSIX lock on an open file descriptor. |
| 1458 | * :func:`~os.pread`: Read from a file descriptor at an offset, the file |
| 1459 | offset remains unchanged. |
| 1460 | * :func:`~os.pwrite`: Write to a file descriptor from an offset, leaving |
| 1461 | the file offset unchanged. |
| 1462 | * :func:`~os.readv`: Read from a file descriptor into a number of writable buffers. |
| 1463 | * :func:`~os.truncate`: Truncate the file corresponding to *path*, so that |
| 1464 | it is at most *length* bytes in size. |
| 1465 | * :func:`~os.waitid`: Wait for the completion of one or more child processes. |
| 1466 | * :func:`~os.writev`: Write the contents of *buffers* to a file descriptor, |
| 1467 | where *buffers* is an arbitrary sequence of buffers. |
| 1468 | * :func:`~os.getgrouplist` (:issue:`9344`): Return list of group ids that |
| 1469 | specified user belongs to. |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1470 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1471 | * :func:`~os.times` and :func:`~os.uname`: Return type changed from a tuple to |
| 1472 | a tuple-like object with named attributes. |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 1473 | |
Giampaolo Rodolà | 424298a | 2011-03-03 18:34:06 +0000 | [diff] [blame] | 1474 | |
Georg Brandl | 4c7c3c5 | 2012-03-10 22:36:48 +0100 | [diff] [blame] | 1475 | pdb |
| 1476 | --- |
| 1477 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1478 | Tab-completion is now available not only for command names, but also their |
| 1479 | arguments. For example, for the ``break`` command, function and file names |
| 1480 | are completed. |
| 1481 | |
| 1482 | (Contributed by Georg Brandl in :issue:`14210`) |
Georg Brandl | 4c7c3c5 | 2012-03-10 22:36:48 +0100 | [diff] [blame] | 1483 | |
| 1484 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1485 | pickle |
| 1486 | ------ |
| 1487 | |
| 1488 | :class:`pickle.Pickler` objects now have an optional |
| 1489 | :attr:`~pickle.Pickler.dispatch_table` attribute allowing to set per-pickler |
| 1490 | reduction functions. |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1491 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1492 | (Contributed by Richard Oudkerk in :issue:`14166`.) |
| 1493 | |
| 1494 | |
Victor Stinner | 383c3fc | 2011-05-25 01:35:05 +0200 | [diff] [blame] | 1495 | pydoc |
| 1496 | ----- |
| 1497 | |
Victor Stinner | 6daa33c | 2011-05-25 01:41:22 +0200 | [diff] [blame] | 1498 | The Tk GUI and the :func:`~pydoc.serve` function have been removed from the |
| 1499 | :mod:`pydoc` module: ``pydoc -g`` and :func:`~pydoc.serve` have been deprecated |
| 1500 | in Python 3.2. |
Victor Stinner | 383c3fc | 2011-05-25 01:35:05 +0200 | [diff] [blame] | 1501 | |
| 1502 | |
Antoine Pitrou | ad09b5d | 2012-06-24 22:41:33 +0200 | [diff] [blame] | 1503 | re |
| 1504 | -- |
| 1505 | |
| 1506 | :class:`str` regular expressions now support ``\u`` and ``\U`` escapes. |
| 1507 | |
| 1508 | (Contributed by Serhiy Storchaka in :issue:`3665`.) |
| 1509 | |
| 1510 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1511 | sched |
| 1512 | ----- |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 1513 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1514 | * :meth:`~sched.scheduler.run` now accepts a *blocking* parameter which when |
| 1515 | set to False makes the method execute the scheduled events due to expire |
| 1516 | soonest (if any) and then return immediately. |
| 1517 | This is useful in case you want to use the :class:`~sched.scheduler` in |
| 1518 | non-blocking applications. (Contributed by Giampaolo Rodolà in :issue:`13449`) |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 1519 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1520 | * :class:`~sched.scheduler` class can now be safely used in multi-threaded |
| 1521 | environments. (Contributed by Josiah Carlson and Giampaolo Rodolà in |
| 1522 | :issue:`8684`) |
| 1523 | |
| 1524 | * *timefunc* and *delayfunct* parameters of :class:`~sched.scheduler` class |
| 1525 | constructor are now optional and defaults to :func:`time.time` and |
| 1526 | :func:`time.sleep` respectively. (Contributed by Chris Clark in |
| 1527 | :issue:`13245`) |
| 1528 | |
| 1529 | * :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs` |
| 1530 | *argument* parameter is now optional. (Contributed by Chris Clark in |
| 1531 | :issue:`13245`) |
| 1532 | |
| 1533 | * :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs` |
| 1534 | now accept a *kwargs* parameter. (Contributed by Chris Clark in |
| 1535 | :issue:`13245`) |
| 1536 | |
| 1537 | |
R David Murray | aae2583 | 2012-09-29 09:49:05 -0400 | [diff] [blame] | 1538 | shlex |
| 1539 | ----- |
| 1540 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1541 | The previously undocumented helper function ``quote`` from the |
| 1542 | :mod:`pipes` modules has been moved to the :mod:`shlex` module and |
| 1543 | documented. :func:`~shlex.quote` properly escapes all characters in a string |
| 1544 | that might be otherwise given special meaning by the shell. |
R David Murray | aae2583 | 2012-09-29 09:49:05 -0400 | [diff] [blame] | 1545 | |
| 1546 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1547 | shutil |
| 1548 | ------ |
| 1549 | |
| 1550 | * The :mod:`shutil` module has these new fuctions: |
| 1551 | |
| 1552 | * :func:`~shutil.disk_usage`: provides total, used and free disk space |
| 1553 | statistics. (Contributed by Giampaolo Rodolà in :issue:`12442`) |
| 1554 | * :func:`~shutil.chown`: allows one to change user and/or group of the given |
| 1555 | path also specifying the user/group names and not only their numeric |
| 1556 | ids. (Contributed by Sandro Tosi in :issue:`12191`) |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 1557 | |
Larry Hastings | 9471797 | 2012-09-21 09:30:19 -0700 | [diff] [blame] | 1558 | * :func:`~shutil.copy2` and :func:`~shutil.copystat` now preserve file |
| 1559 | timestamps with nanosecond precision on platforms that support it. |
| 1560 | They also preserve file "extended attributes" on Linux. (Contributed |
| 1561 | by Larry Hastings in :issue:`14127` and :issue:`15238`.) |
| 1562 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1563 | * The new :func:`shutil.get_terminal_size` function returns the size of the |
| 1564 | terminal window the interpreter is attached to. |
| 1565 | (Contributed by Zbigniew Jędrzejewski-Szmek in :issue:`13609`.) |
| 1566 | |
| 1567 | * Several functions now take an optional ``symlinks`` argument: when that |
| 1568 | parameter is true, symlinks aren't dereferenced and the operation instead |
| 1569 | acts on the symlink itself (or creates one, if relevant). |
| 1570 | (Contributed by Hynek Schlawack in :issue:`12715`.) |
| 1571 | |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 1572 | * :func:`~shutil.rmtree` is now resistant to symlink attacks on platforms |
| 1573 | which support the new ``dir_fd`` parameter in :func:`os.open` and |
Georg Brandl | dba3b5c | 2012-06-26 09:36:14 +0200 | [diff] [blame] | 1574 | :func:`os.unlink`. (Contributed by Martin von Löwis and Hynek Schlawack |
Nick Coghlan | 5b0eca1 | 2012-06-24 16:43:06 +1000 | [diff] [blame] | 1575 | in :issue:`4489`.) |
| 1576 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1577 | |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 1578 | signal |
| 1579 | ------ |
| 1580 | |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 1581 | * The :mod:`signal` module has new functions: |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 1582 | |
Victor Stinner | b3e7219 | 2011-05-08 01:46:11 +0200 | [diff] [blame] | 1583 | * :func:`~signal.pthread_sigmask`: fetch and/or change the signal mask of the |
| 1584 | calling thread (Contributed by Jean-Paul Calderone in :issue:`8407`) ; |
| 1585 | * :func:`~signal.pthread_kill`: send a signal to a thread ; |
| 1586 | * :func:`~signal.sigpending`: examine pending functions ; |
| 1587 | * :func:`~signal.sigwait`: wait a signal. |
Ross Lagerwall | bc80822 | 2011-06-25 12:13:40 +0200 | [diff] [blame] | 1588 | * :func:`~signal.sigwaitinfo`: wait for a signal, returning detailed |
| 1589 | information about it. |
| 1590 | * :func:`~signal.sigtimedwait`: like :func:`~signal.sigwaitinfo` but with a |
| 1591 | timeout. |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 1592 | |
Victor Stinner | d49b1f1 | 2011-05-08 02:03:15 +0200 | [diff] [blame] | 1593 | * The signal handler writes the signal number as a single byte instead of |
| 1594 | a nul byte into the wakeup file descriptor. So it is possible to wait more |
| 1595 | than one signal and know which signals were raised. |
| 1596 | |
Victor Stinner | 388196e | 2011-05-10 17:13:00 +0200 | [diff] [blame] | 1597 | * :func:`signal.signal` and :func:`signal.siginterrupt` raise an OSError, |
| 1598 | instead of a RuntimeError: OSError has an errno attribute. |
| 1599 | |
R David Murray | 1764c80 | 2012-09-29 11:42:36 -0400 | [diff] [blame] | 1600 | |
| 1601 | smtpd |
| 1602 | ----- |
| 1603 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1604 | The :mod:`smtpd` module now supports :rfc:`5321` (extended SMTP) and :rfc:`1870` |
| 1605 | (size extension). Per the standard, these extensions are enabled if and only |
| 1606 | if the client initiates the session with an ``EHLO`` command. |
R David Murray | 1764c80 | 2012-09-29 11:42:36 -0400 | [diff] [blame] | 1607 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1608 | (Initial ``ELHO`` support by Alberto Trevino. Size extension by Juhana |
| 1609 | Jauhiainen. Substantial additional work on the patch contributed by Michele |
| 1610 | Orrù and Dan Boswell. :issue:`8739`) |
R David Murray | 1764c80 | 2012-09-29 11:42:36 -0400 | [diff] [blame] | 1611 | |
| 1612 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1613 | smtplib |
| 1614 | ------- |
| 1615 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1616 | The :class:`~smtplib.SMTP_SSL` constructor and the :meth:`~smtplib.SMTP.starttls` |
| 1617 | method now accept an SSLContext parameter to control parameters of the secure |
| 1618 | channel. |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1619 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1620 | (Contributed by Kasun Herath in :issue:`8809`) |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1621 | |
| 1622 | |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1623 | socket |
| 1624 | ------ |
| 1625 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1626 | * The :class:`~socket.socket` class now exposes additional methods to process |
| 1627 | ancillary data when supported by the underlying platform: |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1628 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1629 | * :func:`~socket.socket.sendmsg` |
| 1630 | * :func:`~socket.socket.recvmsg` |
| 1631 | * :func:`~socket.socket.recvmsg_into` |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 1632 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 1633 | (Contributed by David Watson in :issue:`6560`, based on an earlier patch by |
| 1634 | Heiko Wundram) |
| 1635 | |
| 1636 | * The :class:`~socket.socket` class now supports the PF_CAN protocol family |
| 1637 | (http://en.wikipedia.org/wiki/Socketcan), on Linux |
| 1638 | (http://lwn.net/Articles/253425). |
| 1639 | |
| 1640 | (Contributed by Matthias Fuchs, updated by Tiago Gonçalves in :issue:`10141`) |
| 1641 | |
Charles-François Natali | 10b8cf4 | 2011-11-10 19:21:37 +0100 | [diff] [blame] | 1642 | * The :class:`~socket.socket` class now supports the PF_RDS protocol family |
| 1643 | (http://en.wikipedia.org/wiki/Reliable_Datagram_Sockets and |
| 1644 | http://oss.oracle.com/projects/rds/). |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 1645 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1646 | |
Victor Stinner | 99c8b16 | 2011-05-24 12:05:19 +0200 | [diff] [blame] | 1647 | ssl |
| 1648 | --- |
| 1649 | |
Antoine Pitrou | 2c0a967 | 2011-11-17 02:09:13 +0100 | [diff] [blame] | 1650 | * The :mod:`ssl` module has two new random generation functions: |
Victor Stinner | 99c8b16 | 2011-05-24 12:05:19 +0200 | [diff] [blame] | 1651 | |
| 1652 | * :func:`~ssl.RAND_bytes`: generate cryptographically strong |
| 1653 | pseudo-random bytes. |
| 1654 | * :func:`~ssl.RAND_pseudo_bytes`: generate pseudo-random bytes. |
| 1655 | |
Antoine Pitrou | 2c0a967 | 2011-11-17 02:09:13 +0100 | [diff] [blame] | 1656 | (Contributed by Victor Stinner in :issue:`12049`) |
| 1657 | |
| 1658 | * The :mod:`ssl` module now exposes a finer-grained exception hierarchy |
| 1659 | in order to make it easier to inspect the various kinds of errors. |
| 1660 | |
| 1661 | (Contributed by Antoine Pitrou in :issue:`11183`) |
| 1662 | |
| 1663 | * :meth:`~ssl.SSLContext.load_cert_chain` now accepts a *password* argument |
| 1664 | to be used if the private key is encrypted. |
| 1665 | |
| 1666 | (Contributed by Adam Simpkins in :issue:`12803`) |
| 1667 | |
Antoine Pitrou | 73fc814 | 2011-12-23 20:58:36 +0100 | [diff] [blame] | 1668 | * Diffie-Hellman key exchange, both regular and Elliptic Curve-based, is |
| 1669 | now supported through the :meth:`~ssl.SSLContext.load_dh_params` and |
| 1670 | :meth:`~ssl.SSLContext.set_ecdh_curve` methods. |
| 1671 | |
| 1672 | (Contributed by Antoine Pitrou in :issue:`13626` and :issue:`13627`) |
| 1673 | |
Antoine Pitrou | 2c0a967 | 2011-11-17 02:09:13 +0100 | [diff] [blame] | 1674 | * SSL sockets have a new :meth:`~ssl.SSLSocket.get_channel_binding` method |
| 1675 | allowing the implementation of certain authentication mechanisms such as |
| 1676 | SCRAM-SHA-1-PLUS. |
| 1677 | |
| 1678 | (Contributed by Jacek Konieczny in :issue:`12551`) |
| 1679 | |
Antoine Pitrou | 73fc814 | 2011-12-23 20:58:36 +0100 | [diff] [blame] | 1680 | * You can query the SSL compression algorithm used by an SSL socket, thanks |
| 1681 | to its new :meth:`~ssl.SSLSocket.compression` method. |
| 1682 | |
| 1683 | (Contributed by Antoine Pitrou in :issue:`13634`) |
| 1684 | |
Antoine Pitrou | 9a86447 | 2012-05-04 23:15:47 +0200 | [diff] [blame] | 1685 | * Support has been added for the Next Procotol Negotiation extension using |
| 1686 | the :meth:`ssl.SSLContext.set_npn_protocols` method. |
| 1687 | |
| 1688 | (Contributed by Colin Marc in :issue:`14204`) |
| 1689 | |
Antoine Pitrou | ad09b5d | 2012-06-24 22:41:33 +0200 | [diff] [blame] | 1690 | * SSL errors can now be introspected more easily thanks to |
| 1691 | :attr:`~ssl.SSLError.library` and :attr:`~ssl.SSLError.reason` attributes. |
| 1692 | |
| 1693 | (Contributed by Antoine Pitrou in :issue:`14837`) |
| 1694 | |
Giampaolo Rodola' | ffa1d0b | 2012-05-15 15:30:25 +0200 | [diff] [blame] | 1695 | stat |
| 1696 | ---- |
| 1697 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1698 | The undocumented tarfile.filemode function has been moved to |
| 1699 | :func:`stat.filemode`. It can be used to convert a file's mode to a string of |
| 1700 | the form '-rwxrwxrwx'. |
Giampaolo Rodola' | ffa1d0b | 2012-05-15 15:30:25 +0200 | [diff] [blame] | 1701 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1702 | (Contributed by Giampaolo Rodolà in :issue:`14807`) |
Antoine Pitrou | 73fc814 | 2011-12-23 20:58:36 +0100 | [diff] [blame] | 1703 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1704 | sys |
| 1705 | --- |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 1706 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1707 | The :mod:`sys` module has a new :data:`~sys.thread_info` :term:`struct |
| 1708 | sequence` holding informations about the thread implementation. |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 1709 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1710 | (:issue:`11223`) |
Giampaolo Rodola' | 096dcb1 | 2011-06-27 11:17:51 +0200 | [diff] [blame] | 1711 | |
Nick Coghlan | 4fae8cd | 2012-06-11 23:07:51 +1000 | [diff] [blame] | 1712 | textwrap |
| 1713 | -------- |
| 1714 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1715 | The :mod:`textwrap` module has a new :func:`~textwrap.indent` that makes |
| 1716 | it straightforward to add a common prefix to selected lines in a block |
| 1717 | of text. |
Nick Coghlan | 4fae8cd | 2012-06-11 23:07:51 +1000 | [diff] [blame] | 1718 | |
R David Murray | 26d15bf | 2012-09-29 15:13:35 -0400 | [diff] [blame] | 1719 | (:issue:`13857`) |
Antoine Pitrou | 5a8bc6f | 2011-11-17 02:20:48 +0100 | [diff] [blame] | 1720 | |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1721 | time |
| 1722 | ---- |
Antoine Pitrou | 5a8bc6f | 2011-11-17 02:20:48 +0100 | [diff] [blame] | 1723 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1724 | The :pep:`418` added new functions to the :mod:`time` module: |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1725 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1726 | * :func:`~time.get_clock_info`: Get information on a clock. |
| 1727 | * :func:`~time.monotonic`: Monotonic clock (cannot go backward), not affected |
| 1728 | by system clock updates. |
| 1729 | * :func:`~time.perf_counter`: Performance counter with the highest available |
| 1730 | resolution to measure a short duration. |
| 1731 | * :func:`~time.process_time`: Sum of the system and user CPU time of the |
| 1732 | current process. |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1733 | |
Victor Stinner | ec89539 | 2012-04-29 02:41:27 +0200 | [diff] [blame] | 1734 | Other new functions: |
| 1735 | |
| 1736 | * :func:`~time.clock_getres`, :func:`~time.clock_gettime` and |
| 1737 | :func:`~time.clock_settime` functions with ``CLOCK_xxx`` constants. |
| 1738 | (Contributed by Victor Stinner in :issue:`10278`) |
Victor Stinner | f4c54ff | 2012-02-08 01:48:34 +0100 | [diff] [blame] | 1739 | |
Antoine Pitrou | 5a8bc6f | 2011-11-17 02:20:48 +0100 | [diff] [blame] | 1740 | |
Victor Stinner | 0db176f | 2012-04-16 00:16:30 +0200 | [diff] [blame] | 1741 | types |
| 1742 | ----- |
| 1743 | |
| 1744 | Add a new :class:`types.MappingProxyType` class: Read-only proxy of a mapping. |
| 1745 | (:issue:`14386`) |
| 1746 | |
| 1747 | |
Nick Coghlan | 7fc570a | 2012-05-20 02:34:13 +1000 | [diff] [blame] | 1748 | The new functions `types.new_class` and `types.prepare_class` provide support |
| 1749 | for PEP 3115 compliant dynamic type creation. (:issue:`14588`) |
| 1750 | |
| 1751 | |
Ezio Melotti | 461f41d | 2012-09-26 17:43:23 +0300 | [diff] [blame] | 1752 | unittest |
| 1753 | -------- |
| 1754 | |
| 1755 | :meth:`.assertRaises`, :meth:`.assertRaisesRegex`, :meth:`.assertWarns`, and |
| 1756 | :meth:`.assertWarnsRegex` now accept a keyword argument *msg* when used as |
| 1757 | context managers. |
| 1758 | |
| 1759 | (Contributed by Ezio Melotti and Winston Ewert in :issue:`10775`) |
| 1760 | |
| 1761 | |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 1762 | urllib |
| 1763 | ------ |
| 1764 | |
| 1765 | The :class:`~urllib.request.Request` class, now accepts a *method* argument |
| 1766 | used by :meth:`~urllib.request.Request.get_method` to determine what HTTP method |
Senthil Kumaran | a41c942 | 2011-10-20 02:37:08 +0800 | [diff] [blame] | 1767 | should be used. For example, this will send a ``'HEAD'`` request:: |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 1768 | |
| 1769 | >>> urlopen(Request('http://www.python.org', method='HEAD')) |
| 1770 | |
| 1771 | (:issue:`1673007`) |
Giampaolo Rodola' | 096dcb1 | 2011-06-27 11:17:51 +0200 | [diff] [blame] | 1772 | |
Giampaolo Rodola' | be55d99 | 2011-11-22 13:33:34 +0100 | [diff] [blame] | 1773 | |
Éric Araujo | 4f61a2d | 2012-04-04 23:01:01 -0400 | [diff] [blame] | 1774 | webbrowser |
| 1775 | ---------- |
| 1776 | |
| 1777 | The :mod:`webbrowser` module supports more browsers: Google Chrome (named |
| 1778 | :program:`chrome`, :program:`chromium`, :program:`chrome-browser` or |
| 1779 | :program:`chromium-browser` depending on the version and operating system) as |
| 1780 | well as the the generic launchers :program:`xdg-open` from the FreeDesktop.org |
| 1781 | project and :program:`gvfs-open` which is the default URI handler for GNOME 3. |
| 1782 | |
| 1783 | (:issue:`13620` and :issue:`14493`) |
| 1784 | |
| 1785 | |
Eli Bendersky | efcaba0 | 2012-08-09 08:20:20 +0300 | [diff] [blame] | 1786 | xml.etree.ElementTree |
| 1787 | --------------------- |
| 1788 | |
| 1789 | The :mod:`xml.etree.ElementTree` module now imports its C accelerator by |
| 1790 | default; there is no longer a need to explicitly import |
| 1791 | :mod:`xml.etree.cElementTree` (this module stays for backwards compatibility, |
| 1792 | but is now deprecated). In addition, the ``iter`` family of methods of |
| 1793 | :class:`~xml.etree.ElementTree.Element` has been optimized (rewritten in C). |
| 1794 | The module's documentation has also been greatly improved with added examples |
| 1795 | and a more detailed reference. |
| 1796 | |
| 1797 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1798 | Optimizations |
| 1799 | ============= |
| 1800 | |
| 1801 | Major performance enhancements have been added: |
| 1802 | |
Éric Araujo | 4f61a2d | 2012-04-04 23:01:01 -0400 | [diff] [blame] | 1803 | * Thanks to :pep:`393`, some operations on Unicode strings have been optimized: |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1804 | |
| 1805 | * the memory footprint is divided by 2 to 4 depending on the text |
Victor Stinner | a996f1e | 2011-11-21 13:14:43 +0100 | [diff] [blame] | 1806 | * encode an ASCII string to UTF-8 doesn't need to encode characters anymore, |
| 1807 | the UTF-8 representation is shared with the ASCII representation |
Victor Stinner | 6099a03 | 2011-12-18 14:22:26 +0100 | [diff] [blame] | 1808 | * the UTF-8 encoder has been optimized |
| 1809 | * repeating a single ASCII letter and getting a substring of a ASCII strings |
| 1810 | is 4 times faster |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1811 | |
Antoine Pitrou | 5d7e1d3 | 2012-06-24 22:38:23 +0200 | [diff] [blame] | 1812 | * UTF-8 is now 2x to 4x faster. UTF-16 encoding is now up to 10x faster. |
Antoine Pitrou | 5cec9d2 | 2012-05-17 17:37:02 +0200 | [diff] [blame] | 1813 | |
Antoine Pitrou | c909296 | 2012-06-15 22:22:18 +0200 | [diff] [blame] | 1814 | (contributed by Serhiy Storchaka, :issue:`14624`, :issue:`14738` and |
| 1815 | :issue:`15026`.) |
Antoine Pitrou | 5cec9d2 | 2012-05-17 17:37:02 +0200 | [diff] [blame] | 1816 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1817 | |
| 1818 | Build and C API Changes |
| 1819 | ======================= |
| 1820 | |
| 1821 | Changes to Python's build process and to the C API include: |
| 1822 | |
Stefan Krah | 95b1ba6 | 2012-02-29 17:27:21 +0100 | [diff] [blame] | 1823 | * New :pep:`3118` related function: |
| 1824 | |
| 1825 | * :c:func:`PyMemoryView_FromMemory` |
| 1826 | |
Éric Araujo | 4f61a2d | 2012-04-04 23:01:01 -0400 | [diff] [blame] | 1827 | * :pep:`393` added new Unicode types, macros and functions: |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1828 | |
Victor Stinner | a996f1e | 2011-11-21 13:14:43 +0100 | [diff] [blame] | 1829 | * High-level API: |
| 1830 | |
| 1831 | * :c:func:`PyUnicode_CopyCharacters` |
| 1832 | * :c:func:`PyUnicode_FindChar` |
| 1833 | * :c:func:`PyUnicode_GetLength`, :c:macro:`PyUnicode_GET_LENGTH` |
| 1834 | * :c:func:`PyUnicode_New` |
| 1835 | * :c:func:`PyUnicode_Substring` |
| 1836 | * :c:func:`PyUnicode_ReadChar`, :c:func:`PyUnicode_WriteChar` |
| 1837 | |
| 1838 | * Low-level API: |
| 1839 | |
| 1840 | * :c:type:`Py_UCS1`, :c:type:`Py_UCS2`, :c:type:`Py_UCS4` types |
| 1841 | * :c:type:`PyASCIIObject` and :c:type:`PyCompactUnicodeObject` structures |
| 1842 | * :c:macro:`PyUnicode_READY` |
| 1843 | * :c:func:`PyUnicode_FromKindAndData` |
| 1844 | * :c:func:`PyUnicode_AsUCS4`, :c:func:`PyUnicode_AsUCS4Copy` |
| 1845 | * :c:macro:`PyUnicode_DATA`, :c:macro:`PyUnicode_1BYTE_DATA`, |
| 1846 | :c:macro:`PyUnicode_2BYTE_DATA`, :c:macro:`PyUnicode_4BYTE_DATA` |
| 1847 | * :c:macro:`PyUnicode_KIND` with :c:type:`PyUnicode_Kind` enum: |
| 1848 | :c:data:`PyUnicode_WCHAR_KIND`, :c:data:`PyUnicode_1BYTE_KIND`, |
| 1849 | :c:data:`PyUnicode_2BYTE_KIND`, :c:data:`PyUnicode_4BYTE_KIND` |
| 1850 | * :c:macro:`PyUnicode_READ`, :c:macro:`PyUnicode_READ_CHAR`, :c:macro:`PyUnicode_WRITE` |
| 1851 | * :c:macro:`PyUnicode_MAX_CHAR_VALUE` |
| 1852 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1853 | |
| 1854 | |
Victor Stinner | d1be878 | 2011-12-09 00:10:41 +0100 | [diff] [blame] | 1855 | Deprecated |
| 1856 | ========== |
| 1857 | |
Georg Brandl | 0cd25c9 | 2011-04-29 13:45:54 +0200 | [diff] [blame] | 1858 | Unsupported Operating Systems |
Victor Stinner | d1be878 | 2011-12-09 00:10:41 +0100 | [diff] [blame] | 1859 | ----------------------------- |
Victor Stinner | b90db4c | 2011-04-26 22:48:24 +0200 | [diff] [blame] | 1860 | |
Brian Curtin | 49a40cd | 2011-05-02 22:30:06 -0500 | [diff] [blame] | 1861 | OS/2 and VMS are no longer supported due to the lack of a maintainer. |
| 1862 | |
| 1863 | Windows 2000 and Windows platforms which set ``COMSPEC`` to ``command.com`` |
| 1864 | are no longer supported due to maintenance burden. |
Victor Stinner | b90db4c | 2011-04-26 22:48:24 +0200 | [diff] [blame] | 1865 | |
| 1866 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1867 | Deprecated Python modules, functions and methods |
Victor Stinner | d1be878 | 2011-12-09 00:10:41 +0100 | [diff] [blame] | 1868 | ------------------------------------------------ |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 1869 | |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 1870 | * The ``unicode_internal`` codec has been deprecated because of the |
Sandro Tosi | cd89912 | 2012-01-22 12:16:04 +0100 | [diff] [blame] | 1871 | :pep:`393`, use UTF-8, UTF-16 (``utf-16-le`` or ``utf-16-be``), or UTF-32 |
| 1872 | (``utf-32-le`` or ``utf-32-be``) |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 1873 | * :meth:`ftplib.FTP.nlst` and :meth:`ftplib.FTP.dir`: use |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1874 | :meth:`ftplib.FTP.mlsd` |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 1875 | * :func:`platform.popen`: use the :mod:`subprocess` module. Check especially |
| 1876 | the :ref:`subprocess-replacements` section. |
| 1877 | * :issue:`13374`: The Windows bytes API has been deprecated in the :mod:`os` |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1878 | module. Use Unicode filenames, instead of bytes filenames, to not depend on |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 1879 | the ANSI code page anymore and to support any filename. |
Florent Xicluna | a72a98f | 2012-02-13 11:03:30 +0100 | [diff] [blame] | 1880 | * :issue:`13988`: The :mod:`xml.etree.cElementTree` module is deprecated. The |
| 1881 | accelerator is used automatically whenever available. |
Victor Stinner | 47620a6 | 2012-04-29 02:52:39 +0200 | [diff] [blame] | 1882 | * The behaviour of :func:`time.clock` depends on the platform: use the new |
| 1883 | :func:`time.perf_counter` or :func:`time.process_time` function instead, |
| 1884 | depending on your requirements, to have a well defined behaviour. |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1885 | * The :func:`os.stat_float_times` function is deprecated. |
Victor Stinner | 8f17c1c | 2012-08-05 16:31:32 +0200 | [diff] [blame] | 1886 | * :mod:`abc` module: |
| 1887 | |
| 1888 | * :class:`abc.abstractproperty` has been deprecated, use :class:`property` |
| 1889 | with :func:`abc.abstractmethod` instead. |
| 1890 | * :class:`abc.abstractclassmethod` has been deprecated, use |
| 1891 | :class:`classmethod` with :func:`abc.abstractmethod` instead. |
| 1892 | * :class:`abc.abstractstaticmethod` has been deprecated, use |
| 1893 | :class:`staticmethod` with :func:`abc.abstractmethod` instead. |
| 1894 | |
Georg Brandl | fc34921 | 2012-09-26 13:11:48 +0200 | [diff] [blame] | 1895 | * :mod:`importlib` package: |
Brett Cannon | 288717a | 2012-09-25 15:23:07 -0400 | [diff] [blame] | 1896 | |
| 1897 | * :meth:`importlib.abc.SourceLoader.path_mtime` is now deprecated in favour of |
| 1898 | :meth:`importlib.abc.SourceLoader.path_stats` as bytecode files now store |
| 1899 | both the modification time and size of the source file the bytecode file was |
| 1900 | compiled from. |
| 1901 | |
| 1902 | |
| 1903 | |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 1904 | |
| 1905 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1906 | Deprecated functions and types of the C API |
Victor Stinner | d1be878 | 2011-12-09 00:10:41 +0100 | [diff] [blame] | 1907 | ------------------------------------------- |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1908 | |
Éric Araujo | 4f61a2d | 2012-04-04 23:01:01 -0400 | [diff] [blame] | 1909 | The :c:type:`Py_UNICODE` has been deprecated by :pep:`393` and will be |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1910 | removed in Python 4. All functions using this type are deprecated: |
| 1911 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1912 | Unicode functions and methods using :c:type:`Py_UNICODE` and |
| 1913 | :c:type:`Py_UNICODE*` types: |
| 1914 | |
R David Murray | f75e65f | 2012-09-29 15:27:53 -0400 | [diff] [blame] | 1915 | * :c:macro:`PyUnicode_FromUnicode`: use :c:func:`PyUnicode_FromWideChar` or |
| 1916 | :c:func:`PyUnicode_FromKindAndData` |
| 1917 | * :c:macro:`PyUnicode_AS_UNICODE`, :c:func:`PyUnicode_AsUnicode`, |
| 1918 | :c:func:`PyUnicode_AsUnicodeAndSize`: use :c:func:`PyUnicode_AsWideCharString` |
| 1919 | * :c:macro:`PyUnicode_AS_DATA`: use :c:macro:`PyUnicode_DATA` with |
| 1920 | :c:macro:`PyUnicode_READ` and :c:macro:`PyUnicode_WRITE` |
| 1921 | * :c:macro:`PyUnicode_GET_SIZE`, :c:func:`PyUnicode_GetSize`: use |
| 1922 | :c:macro:`PyUnicode_GET_LENGTH` or :c:func:`PyUnicode_GetLength` |
| 1923 | * :c:macro:`PyUnicode_GET_DATA_SIZE`: use |
| 1924 | ``PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)`` (only work on ready |
| 1925 | strings) |
| 1926 | * :c:func:`PyUnicode_AsUnicodeCopy`: use :c:func:`PyUnicode_AsUCS4Copy` or |
| 1927 | :c:func:`PyUnicode_AsWideCharString` |
| 1928 | * :c:func:`PyUnicode_GetMax` |
Victor Stinner | ab59594 | 2011-12-17 04:59:06 +0100 | [diff] [blame] | 1929 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1930 | |
Victor Stinner | a996f1e | 2011-11-21 13:14:43 +0100 | [diff] [blame] | 1931 | Functions and macros manipulating Py_UNICODE* strings: |
| 1932 | |
R David Murray | f75e65f | 2012-09-29 15:27:53 -0400 | [diff] [blame] | 1933 | * :c:macro:`Py_UNICODE_strlen`: use :c:func:`PyUnicode_GetLength` or |
| 1934 | :c:macro:`PyUnicode_GET_LENGTH` |
| 1935 | * :c:macro:`Py_UNICODE_strcat`: use :c:func:`PyUnicode_CopyCharacters` or |
| 1936 | :c:func:`PyUnicode_FromFormat` |
| 1937 | * :c:macro:`Py_UNICODE_strcpy`, :c:macro:`Py_UNICODE_strncpy`, |
| 1938 | :c:macro:`Py_UNICODE_COPY`: use :c:func:`PyUnicode_CopyCharacters` or |
| 1939 | :c:func:`PyUnicode_Substring` |
| 1940 | * :c:macro:`Py_UNICODE_strcmp`: use :c:func:`PyUnicode_Compare` |
| 1941 | * :c:macro:`Py_UNICODE_strncmp`: use :c:func:`PyUnicode_Tailmatch` |
| 1942 | * :c:macro:`Py_UNICODE_strchr`, :c:macro:`Py_UNICODE_strrchr`: use |
| 1943 | :c:func:`PyUnicode_FindChar` |
| 1944 | * :c:macro:`Py_UNICODE_FILL`: use :c:func:`PyUnicode_Fill` |
| 1945 | * :c:macro:`Py_UNICODE_MATCH` |
Victor Stinner | a996f1e | 2011-11-21 13:14:43 +0100 | [diff] [blame] | 1946 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1947 | Encoders: |
| 1948 | |
R David Murray | f75e65f | 2012-09-29 15:27:53 -0400 | [diff] [blame] | 1949 | * :c:func:`PyUnicode_Encode`: use :c:func:`PyUnicode_AsEncodedObject` |
| 1950 | * :c:func:`PyUnicode_EncodeUTF7` |
| 1951 | * :c:func:`PyUnicode_EncodeUTF8`: use :c:func:`PyUnicode_AsUTF8` or |
| 1952 | :c:func:`PyUnicode_AsUTF8String` |
| 1953 | * :c:func:`PyUnicode_EncodeUTF32` |
| 1954 | * :c:func:`PyUnicode_EncodeUTF16` |
| 1955 | * :c:func:`PyUnicode_EncodeUnicodeEscape:` use |
| 1956 | :c:func:`PyUnicode_AsUnicodeEscapeString` |
| 1957 | * :c:func:`PyUnicode_EncodeRawUnicodeEscape:` use |
| 1958 | :c:func:`PyUnicode_AsRawUnicodeEscapeString` |
| 1959 | * :c:func:`PyUnicode_EncodeLatin1`: use :c:func:`PyUnicode_AsLatin1String` |
| 1960 | * :c:func:`PyUnicode_EncodeASCII`: use :c:func:`PyUnicode_AsASCIIString` |
| 1961 | * :c:func:`PyUnicode_EncodeCharmap` |
| 1962 | * :c:func:`PyUnicode_TranslateCharmap` |
| 1963 | * :c:func:`PyUnicode_EncodeMBCS`: use :c:func:`PyUnicode_AsMBCSString` or |
| 1964 | :c:func:`PyUnicode_EncodeCodePage` (with ``CP_ACP`` code_page) |
| 1965 | * :c:func:`PyUnicode_EncodeDecimal`, |
| 1966 | :c:func:`PyUnicode_TransformDecimalToASCII` |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 1967 | |
| 1968 | |
Stefan Krah | 029780b | 2012-08-24 20:14:12 +0200 | [diff] [blame] | 1969 | Deprecated features |
| 1970 | ------------------- |
| 1971 | |
| 1972 | The :mod:`array` module's ``'u'`` format code is now deprecated and will be |
| 1973 | removed in Python 4 together with the rest of the (:c:type:`Py_UNICODE`) API. |
| 1974 | |
| 1975 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1976 | Porting to Python 3.3 |
| 1977 | ===================== |
| 1978 | |
| 1979 | This section lists previously described changes and other bugfixes |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 1980 | that may require changes to your code. |
| 1981 | |
Barry Warsaw | c1e721b | 2012-07-30 16:24:12 -0400 | [diff] [blame] | 1982 | .. _portingpythoncode: |
| 1983 | |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 1984 | Porting Python code |
| 1985 | ------------------- |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1986 | |
Victor Stinner | fa0d628 | 2012-08-05 15:56:51 +0200 | [diff] [blame] | 1987 | * Hash randomization is enabled by default. Set the :envvar:`PYTHONHASHSEED` |
| 1988 | environment variable to ``0`` to disable hash randomization. See also the |
| 1989 | :meth:`object.__hash__` method. |
Georg Brandl | d6c4340 | 2012-03-07 08:55:52 +0100 | [diff] [blame] | 1990 | |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 1991 | * :issue:`12326`: On Linux, sys.platform doesn't contain the major version |
Victor Stinner | ff3d939 | 2011-08-20 23:39:26 +0200 | [diff] [blame] | 1992 | anymore. It is now always 'linux', instead of 'linux2' or 'linux3' depending |
| 1993 | on the Linux version used to build Python. Replace sys.platform == 'linux2' |
| 1994 | with sys.platform.startswith('linux'), or directly sys.platform == 'linux' if |
| 1995 | you don't need to support older Python versions. |
Éric Araujo | c09fca6 | 2011-03-23 02:06:24 +0100 | [diff] [blame] | 1996 | |
Victor Stinner | ecc6e66 | 2012-03-14 00:39:29 +0100 | [diff] [blame] | 1997 | * :issue:`13847`, :issue:`14180`: :mod:`time` and :mod:`datetime`: |
| 1998 | :exc:`OverflowError` is now raised instead of :exc:`ValueError` if a |
| 1999 | timestamp is out of range. :exc:`OSError` is now raised if C functions |
| 2000 | :c:func:`gmtime` or :c:func:`localtime` failed. |
| 2001 | |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 2002 | * The default finders used by import now utilize a cache of what is contained |
| 2003 | within a specific directory. If you create a Python source file or sourceless |
| 2004 | bytecode file, make sure to call :func:`importlib.invalidate_caches` to clear |
| 2005 | out the cache for the finders to notice the new file. |
| 2006 | |
| 2007 | * :exc:`ImportError` now uses the full name of the module that was attemped to |
| 2008 | be imported. Doctests that check ImportErrors' message will need to be |
| 2009 | updated to use the full name of the module instead of just the tail of the |
| 2010 | name. |
| 2011 | |
Ezio Melotti | 7598e18 | 2012-09-20 08:33:53 +0300 | [diff] [blame] | 2012 | * The *index* argument to :func:`__import__` now defaults to 0 instead of -1 |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 2013 | and no longer support negative values. It was an oversight when :pep:`328` was |
| 2014 | implemented that the default value remained -1. If you need to continue to |
| 2015 | perform a relative import followed by an absolute import, then perform the |
| 2016 | relative import using an index of 1, followed by another import using an |
| 2017 | index of 0. It is preferred, though, that you use |
| 2018 | :func:`importlib.import_module` rather than call :func:`__import__` directly. |
| 2019 | |
| 2020 | * :func:`__import__` no longer allows one to use an index value other than 0 |
| 2021 | for top-level modules. E.g. ``__import__('sys', level=1)`` is now an error. |
| 2022 | |
| 2023 | * Because :attr:`sys.meta_path` and :attr:`sys.path_hooks` now have finders on |
| 2024 | them by default, you will most likely want to use :meth:`list.insert` instead |
| 2025 | of :meth:`list.append` to add to those lists. |
| 2026 | |
| 2027 | * Because ``None`` is now inserted into :attr:`sys.path_importer_cache`, if you |
| 2028 | are clearing out entries in the dictionary of paths that do not have a |
| 2029 | finder, you will need to remove keys paired with values of ``None`` **and** |
Brett Cannon | 903c27c | 2012-07-09 14:15:32 -0400 | [diff] [blame] | 2030 | :class:`imp.NullImporter` to be backwards-compatible. This will lead to extra |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 2031 | overhead on older versions of Python that re-insert ``None`` into |
| 2032 | :attr:`sys.path_importer_cache` where it repesents the use of implicit |
| 2033 | finders, but semantically it should not change anything. |
| 2034 | |
Brett Cannon | 077ef45 | 2012-08-02 17:50:06 -0400 | [diff] [blame] | 2035 | * :class:`importlib.abc.Finder` no longer specifies a `find_module()` abstract |
| 2036 | method that must be implemented. If you were relying on subclasses to |
| 2037 | implement that method, make sure to check for the method's existence first. |
| 2038 | You will probably want to check for `find_loader()` first, though, in the |
| 2039 | case of working with :term:`path entry finders <path entry finder>`. |
| 2040 | |
Nick Coghlan | 6061000 | 2012-07-15 22:39:39 +1000 | [diff] [blame] | 2041 | * :mod:`pkgutil` has been converted to use :mod:`importlib` internally. This |
| 2042 | eliminates many edge cases where the old behaviour of the PEP 302 import |
| 2043 | emulation failed to match the behaviour of the real import system. The |
| 2044 | import emulation itself is still present, but is now deprecated. The |
| 2045 | :func:`pkgutil.iter_importers` and :func:`pkgutil.walk_packages` functions |
| 2046 | special case the standard import hooks so they are still supported even |
| 2047 | though they do not provide the non-standard ``iter_modules()`` method. |
Brett Cannon | 903c27c | 2012-07-09 14:15:32 -0400 | [diff] [blame] | 2048 | |
Brett Cannon | c204348 | 2012-04-29 20:59:41 -0400 | [diff] [blame] | 2049 | |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 2050 | Porting C code |
| 2051 | -------------- |
| 2052 | |
Stefan Krah | 54c3203 | 2012-02-29 17:47:21 +0100 | [diff] [blame] | 2053 | * In the course of changes to the buffer API the undocumented |
| 2054 | :c:member:`~Py_buffer.smalltable` member of the |
| 2055 | :c:type:`Py_buffer` structure has been removed and the |
| 2056 | layout of the :c:type:`PyMemoryViewObject` has changed. |
| 2057 | |
| 2058 | All extensions relying on the relevant parts in ``memoryobject.h`` |
| 2059 | or ``object.h`` must be rebuilt. |
| 2060 | |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 2061 | * Due to :ref:`PEP 393 <pep-393>`, the :c:type:`Py_UNICODE` type and all |
| 2062 | functions using this type are deprecated (but will stay available for |
| 2063 | at least five years). If you were using low-level Unicode APIs to |
| 2064 | construct and access unicode objects and you want to benefit of the |
Éric Araujo | 4f61a2d | 2012-04-04 23:01:01 -0400 | [diff] [blame] | 2065 | memory footprint reduction provided by PEP 393, you have to convert |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 2066 | your code to the new :doc:`Unicode API <../c-api/unicode>`. |
| 2067 | |
| 2068 | However, if you only have been using high-level functions such as |
| 2069 | :c:func:`PyUnicode_Concat()`, :c:func:`PyUnicode_Join` or |
| 2070 | :c:func:`PyUnicode_FromFormat()`, your code will automatically take |
| 2071 | advantage of the new unicode representations. |
| 2072 | |
Brett Cannon | 77b2abd | 2012-07-09 16:09:00 -0400 | [diff] [blame] | 2073 | * :c:func:`PyImport_GetMagicNumber` now returns -1 upon failure. |
| 2074 | |
Ezio Melotti | 7598e18 | 2012-09-20 08:33:53 +0300 | [diff] [blame] | 2075 | * As a negative value for the *level* argument to :func:`__import__` is no |
Brett Cannon | 522267e | 2012-08-10 18:55:08 -0400 | [diff] [blame] | 2076 | longer valid, the same now holds for :c:func:`PyImport_ImportModuleLevel`. |
Ezio Melotti | 7598e18 | 2012-09-20 08:33:53 +0300 | [diff] [blame] | 2077 | This also means that the value of *level* used by |
Brett Cannon | 522267e | 2012-08-10 18:55:08 -0400 | [diff] [blame] | 2078 | :c:func:`PyImport_ImportModuleEx` is now 0 instead of -1. |
| 2079 | |
Brett Cannon | 77b2abd | 2012-07-09 16:09:00 -0400 | [diff] [blame] | 2080 | |
Antoine Pitrou | c229e6e | 2012-02-20 19:41:11 +0100 | [diff] [blame] | 2081 | Building C extensions |
| 2082 | --------------------- |
| 2083 | |
| 2084 | * The range of possible file names for C extensions has been narrowed. |
| 2085 | Very rarely used spellings have been suppressed: under POSIX, files |
| 2086 | named ``xxxmodule.so``, ``xxxmodule.abi3.so`` and |
| 2087 | ``xxxmodule.cpython-*.so`` are no longer recognized as implementing |
| 2088 | the ``xxx`` module. If you had been generating such files, you have |
| 2089 | to switch to the other spellings (i.e., remove the ``module`` string |
| 2090 | from the file names). |
| 2091 | |
| 2092 | (implemented in :issue:`14040`.) |
| 2093 | |
| 2094 | |
R David Murray | 1764c80 | 2012-09-29 11:42:36 -0400 | [diff] [blame] | 2095 | Command Line Switch Changes |
| 2096 | --------------------------- |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 2097 | |
R David Murray | 1764c80 | 2012-09-29 11:42:36 -0400 | [diff] [blame] | 2098 | * The -Q command-line flag and related artifacts have been removed. Code |
| 2099 | checking sys.flags.division_warning will need updating. |
Éric Araujo | be3bd57 | 2011-03-26 01:55:15 +0100 | [diff] [blame] | 2100 | |
R David Murray | 1764c80 | 2012-09-29 11:42:36 -0400 | [diff] [blame] | 2101 | (:issue:`10998`, contributed by Éric Araujo.) |
| 2102 | |
| 2103 | * When :program:`python` is started with :option:`-S`, ``import site`` |
| 2104 | will no longer add site-specific paths to the module search paths. In |
| 2105 | previous versions, it did. |
| 2106 | |
| 2107 | (:issue:`11591`, contributed by Carl Meyer with editions by Éric Araujo.) |