Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 1 | **************************** |
| 2 | What's New In Python 3.3 |
| 3 | **************************** |
| 4 | |
| 5 | :Author: Raymond Hettinger |
| 6 | :Release: |release| |
| 7 | :Date: |today| |
| 8 | |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 9 | .. Rules for maintenance: |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 10 | |
| 11 | * Anyone can add text to this document. Do not spend very much time |
| 12 | on the wording of your changes, because your text will probably |
| 13 | get rewritten to some degree. |
| 14 | |
| 15 | * The maintainer will go through Misc/NEWS periodically and add |
| 16 | changes; it's therefore more important to add your changes to |
| 17 | Misc/NEWS than to this file. |
| 18 | |
| 19 | * This is not a complete list of every single change; completeness |
| 20 | is the purpose of Misc/NEWS. Some changes I consider too small |
| 21 | or esoteric to include. If such a change is added to the text, |
| 22 | I'll just remove it. (This is another reason you shouldn't spend |
| 23 | too much time on writing your addition.) |
| 24 | |
| 25 | * If you want to draw your new text to the attention of the |
| 26 | maintainer, add 'XXX' to the beginning of the paragraph or |
| 27 | section. |
| 28 | |
| 29 | * It's OK to just add a fragmentary note about a change. For |
| 30 | example: "XXX Describe the transmogrify() function added to the |
| 31 | socket module." The maintainer will research the change and |
| 32 | write the necessary text. |
| 33 | |
| 34 | * You can comment out your additions if you like, but it's not |
| 35 | necessary (especially when a final release is some months away). |
| 36 | |
| 37 | * Credit the author of a patch or bugfix. Just the name is |
| 38 | sufficient; the e-mail address isn't necessary. |
| 39 | |
| 40 | * It's helpful to add the bug/patch number as a comment: |
| 41 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 42 | XXX Describe the transmogrify() function added to the socket |
| 43 | module. |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 44 | (Contributed by P.Y. Developer in :issue:`12345`.) |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 45 | |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 46 | This saves the maintainer the effort of going through the Mercurial log |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 47 | when researching a change. |
| 48 | |
| 49 | This article explains the new features in Python 3.3, compared to 3.2. |
| 50 | |
| 51 | |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 52 | .. _pep-393: |
| 53 | |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 54 | PEP 393: Flexible String Representation |
| 55 | ======================================= |
| 56 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 57 | The Unicode string type is changed to support multiple internal |
| 58 | representations, depending on the character with the largest Unicode ordinal |
| 59 | (1, 2, or 4 bytes) in the represented string. This allows a space-efficient |
| 60 | representation in common cases, but gives access to full UCS-4 on all |
| 61 | systems. For compatibility with existing APIs, several representations may |
| 62 | exist in parallel; over time, this compatibility should be phased out. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 63 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 64 | On the Python side, there should be no downside to this change. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 65 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 66 | On the C API side, PEP 393 is fully backward compatible. The legacy API |
| 67 | should remain available at least five years. Applications using the legacy |
| 68 | API will not fully benefit of the memory reduction, or - worse - may use |
| 69 | a bit more memory, because Python may have to maintain two versions of each |
| 70 | string (in the legacy format and in the new efficient storage). |
| 71 | |
| 72 | Changes introduced by :pep:`393` are the following: |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 73 | |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 74 | * Python now always supports the full range of Unicode codepoints, including |
| 75 | non-BMP ones (i.e. from ``U+0000`` to ``U+10FFFF``). The distinction between |
| 76 | 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] | 77 | build, even under Windows. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 78 | |
| 79 | * The storage of Unicode strings now depends on the highest codepoint in the string: |
| 80 | |
| 81 | * pure ASCII and Latin1 strings (``U+0000-U+00FF``) use 1 byte per codepoint; |
| 82 | |
| 83 | * BMP strings (``U+0000-U+FFFF``) use 2 bytes per codepoint; |
| 84 | |
| 85 | * non-BMP strings (``U+10000-U+10FFFF``) use 4 bytes per codepoint. |
| 86 | |
Antoine Pitrou | beb7836 | 2011-11-17 01:59:51 +0100 | [diff] [blame] | 87 | The net effect is that for most applications, memory usage of string storage |
| 88 | should decrease significantly - especially compared to former wide unicode |
| 89 | builds - as, in many cases, strings will be pure ASCII even in international |
| 90 | contexts (because many strings store non-human language data, such as XML |
| 91 | fragments, HTTP headers, JSON-encoded data, etc.). We also hope that it |
| 92 | will, for the same reasons, increase CPU cache efficiency on non-trivial |
| 93 | applications. |
| 94 | |
| 95 | .. The memory usage of Python 3.3 is two to three times smaller than Python 3.2, |
| 96 | and a little bit better than Python 2.7, on a `Django benchmark |
| 97 | <http://mail.python.org/pipermail/python-dev/2011-September/113714.html>`_. |
| 98 | XXX The result should be moved in the PEP and a link to the PEP should |
| 99 | be added here. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 100 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 101 | * With the death of narrow builds, the problems specific to narrow builds have |
| 102 | also been fixed, for example: |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 103 | |
| 104 | * :func:`len` now always returns 1 for non-BMP characters, |
| 105 | so ``len('\U0010FFFF') == 1``; |
| 106 | |
| 107 | * surrogate pairs are not recombined in string literals, |
| 108 | so ``'\uDBFF\uDFFF' != '\U0010FFFF'``; |
| 109 | |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 110 | * indexing or slicing non-BMP characters returns the expected value, |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 111 | so ``'\U0010FFFF'[0]`` now returns ``'\U0010FFFF'`` and not ``'\uDBFF'``; |
| 112 | |
Antoine Pitrou | d136aec | 2011-11-17 01:48:06 +0100 | [diff] [blame] | 113 | * all other functions in the standard library now correctly handle |
Antoine Pitrou | fd9b416 | 2011-10-24 00:14:43 +0200 | [diff] [blame] | 114 | non-BMP codepoints. |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 115 | |
Ezio Melotti | 48a2f8f | 2011-09-29 00:18:19 +0300 | [diff] [blame] | 116 | * The value of :data:`sys.maxunicode` is now always ``1114111`` (``0x10FFFF`` |
| 117 | in hexadecimal). The :c:func:`PyUnicode_GetMax` function still returns |
| 118 | either ``0xFFFF`` or ``0x10FFFF`` for backward compatibility, and it should |
| 119 | not be used with the new Unicode API (see :issue:`13054`). |
| 120 | |
Ezio Melotti | 397546a | 2011-09-29 08:34:36 +0300 | [diff] [blame] | 121 | * The :file:`./configure` flag ``--with-wide-unicode`` has been removed. |
Victor Stinner | 7d637ab | 2011-09-29 02:56:16 +0200 | [diff] [blame] | 122 | |
Éric Araujo | b07b97f | 2011-10-05 01:03:34 +0200 | [diff] [blame] | 123 | |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 124 | PEP 3151: Reworking the OS and IO exception hierarchy |
| 125 | ===================================================== |
| 126 | |
| 127 | :pep:`3151` - Reworking the OS and IO exception hierarchy |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 128 | PEP written and implemented by Antoine Pitrou. |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 129 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 130 | The hierarchy of exceptions raised by operating system errors is now both |
| 131 | simplified and finer-grained. |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 132 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 133 | You don't have to worry anymore about choosing the appropriate exception |
| 134 | type between :exc:`OSError`, :exc:`IOError`, :exc:`EnvironmentError`, |
| 135 | :exc:`WindowsError`, :exc:`mmap.error`, :exc:`socket.error` or |
| 136 | :exc:`select.error`. All these exception types are now only one: |
| 137 | :exc:`OSError`. The other names are kept as aliases for compatibility |
| 138 | reasons. |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 139 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 140 | Also, it is now easier to catch a specific error condition. Instead of |
| 141 | inspecting the ``errno`` attribute (or ``args[0]``) for a particular |
| 142 | constant from the :mod:`errno` module, you can catch the adequate |
| 143 | :exc:`OSError` subclass. The available subclasses are the following: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 144 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 145 | * :exc:`BlockingIOError` |
| 146 | * :exc:`ChildProcessError` |
| 147 | * :exc:`ConnectionError` |
| 148 | * :exc:`FileExistsError` |
| 149 | * :exc:`FileNotFoundError` |
| 150 | * :exc:`InterruptedError` |
| 151 | * :exc:`IsADirectoryError` |
| 152 | * :exc:`NotADirectoryError` |
| 153 | * :exc:`PermissionError` |
| 154 | * :exc:`ProcessLookupError` |
| 155 | * :exc:`TimeoutError` |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 156 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 157 | And the :exc:`ConnectionError` itself has finer-grained subclasses: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 158 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 159 | * :exc:`BrokenPipeError` |
| 160 | * :exc:`ConnectionAbortedError` |
| 161 | * :exc:`ConnectionRefusedError` |
| 162 | * :exc:`ConnectionResetError` |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 163 | |
| 164 | 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] | 165 | avoided. For example, the following code written for Python 3.2:: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 166 | |
| 167 | from errno import ENOENT, EACCES, EPERM |
| 168 | |
| 169 | try: |
| 170 | with open("document.txt") as f: |
| 171 | content = f.read() |
| 172 | except IOError as err: |
| 173 | if err.errno == ENOENT: |
| 174 | print("document.txt file is missing") |
| 175 | elif err.errno in (EACCES, EPERM): |
| 176 | print("You are not allowed to read document.txt") |
| 177 | else: |
| 178 | raise |
| 179 | |
Antoine Pitrou | 01fd26c | 2011-10-24 00:07:02 +0200 | [diff] [blame] | 180 | can now be written without the :mod:`errno` import and without manual |
| 181 | inspection of exception attributes:: |
Victor Stinner | a1bf298 | 2011-10-12 20:35:02 +0200 | [diff] [blame] | 182 | |
| 183 | try: |
| 184 | with open("document.txt") as f: |
| 185 | content = f.read() |
| 186 | except FileNotFoundError: |
| 187 | print("document.txt file is missing") |
| 188 | except PermissionError: |
| 189 | print("You are not allowed to read document.txt") |
| 190 | |
| 191 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 192 | Other Language Changes |
| 193 | ====================== |
| 194 | |
| 195 | Some smaller changes made to the core Python language are: |
| 196 | |
| 197 | * Stub |
| 198 | |
Ezio Melotti | 931b8aa | 2011-10-21 21:57:36 +0300 | [diff] [blame] | 199 | Added support for Unicode name aliases and named sequences. |
Ezio Melotti | 2d99dac | 2011-10-24 00:44:03 +0300 | [diff] [blame] | 200 | Both :func:`unicodedata.lookup()` and ``'\N{...}'`` now resolve name aliases, |
Ezio Melotti | 931b8aa | 2011-10-21 21:57:36 +0300 | [diff] [blame] | 201 | and :func:`unicodedata.lookup()` resolves named sequences too. |
| 202 | |
| 203 | (Contributed by Ezio Melotti in :issue:`12753`) |
| 204 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 205 | |
Mark Dickinson | 3664568 | 2011-10-23 19:53:01 +0100 | [diff] [blame] | 206 | Equality comparisons on :func:`range` objects now return a result reflecting |
| 207 | the equality of the underlying sequences generated by those range objects. |
| 208 | |
| 209 | (:issue:`13021`) |
| 210 | |
| 211 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 212 | New and Improved Modules |
| 213 | ======================== |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 214 | |
Meador Inge | c5dbb3d | 2011-09-20 21:48:16 -0500 | [diff] [blame] | 215 | array |
| 216 | ----- |
| 217 | |
| 218 | The :mod:`array` module supports the :c:type:`long long` type using ``q`` and |
| 219 | ``Q`` type codes. |
| 220 | |
| 221 | (Contributed by Oren Tirosh and Hirokazu Yamamoto in :issue:`1172711`) |
| 222 | |
| 223 | |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 224 | codecs |
| 225 | ------ |
| 226 | |
Victor Stinner | 3a50e70 | 2011-10-18 21:21:00 +0200 | [diff] [blame] | 227 | The :mod:`~encodings.mbcs` codec has be rewritten to handle correclty |
| 228 | ``replace`` and ``ignore`` error handlers on all Windows versions. The |
| 229 | :mod:`~encodings.mbcs` codec is now supporting all error handlers, instead of |
| 230 | only ``replace`` to encode and ``ignore`` to decode. |
| 231 | |
Victor Stinner | 7592d05 | 2011-10-27 01:43:48 +0200 | [diff] [blame] | 232 | A new Windows-only codec has been added: ``cp65001`` (:issue:`13216`). It is |
Victor Stinner | 2f3ca9f | 2011-10-27 01:38:56 +0200 | [diff] [blame] | 233 | the Windows code page 65001 (Windows UTF-8, ``CP_UTF8``). For example, it is |
| 234 | used by ``sys.stdout`` if the console output code page is set to cp65001 (e.g. |
| 235 | using ``chcp 65001`` command). |
| 236 | |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 237 | Multibyte CJK decoders now resynchronize faster. They only ignore the first |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 238 | byte of an invalid byte sequence. For example, ``b'\xff\n'.decode('gb2312', |
| 239 | 'replace')`` now returns a ``\n`` after the replacement character. |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 240 | |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 241 | (:issue:`12016`) |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 242 | |
| 243 | Don't reset incremental encoders of CJK codecs at each call to their encode() |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 244 | method anymore. For example:: |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 245 | |
| 246 | $ ./python -q |
| 247 | >>> import codecs |
| 248 | >>> encoder = codecs.getincrementalencoder('hz')('strict') |
| 249 | >>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.') |
| 250 | b'~{NpJ)l6HK!#~} Bye.' |
| 251 | |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 252 | This example gives ``b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.'`` with older Python |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 253 | versions. |
| 254 | |
Georg Brandl | 6c0929b | 2011-07-09 11:43:33 +0200 | [diff] [blame] | 255 | (:issue:`12100`) |
Victor Stinner | 2cded9c | 2011-07-08 01:45:13 +0200 | [diff] [blame] | 256 | |
Victor Stinner | 9f4b1e9 | 2011-11-10 20:56:30 +0100 | [diff] [blame] | 257 | The ``unicode_internal`` codec has been deprecated. |
| 258 | |
Éric Araujo | 84b8ed8 | 2011-08-29 21:42:47 +0200 | [diff] [blame] | 259 | crypt |
| 260 | ----- |
| 261 | |
Victor Stinner | c78fb33 | 2011-09-21 03:35:44 +0200 | [diff] [blame] | 262 | Addition of salt and modular crypt format and the :func:`~crypt.mksalt` |
| 263 | function to the :mod:`crypt` module. |
Éric Araujo | 84b8ed8 | 2011-08-29 21:42:47 +0200 | [diff] [blame] | 264 | |
| 265 | (:issue:`10924`) |
| 266 | |
Victor Stinner | a7878b7 | 2011-07-14 23:07:44 +0200 | [diff] [blame] | 267 | curses |
| 268 | ------ |
| 269 | |
Victor Stinner | c78fb33 | 2011-09-21 03:35:44 +0200 | [diff] [blame] | 270 | * The :class:`curses.window` class has a new :meth:`~curses.window.get_wch` |
| 271 | method to get a wide character |
| 272 | * The :mod:`curses` module has a new :meth:`~curses.unget_wch` function to |
| 273 | push a wide character so the next :meth:`~curses.window.get_wch` will return |
| 274 | it |
Victor Stinner | a7878b7 | 2011-07-14 23:07:44 +0200 | [diff] [blame] | 275 | |
Victor Stinner | c78fb33 | 2011-09-21 03:35:44 +0200 | [diff] [blame] | 276 | (Contributed by Iñigo Serna in :issue:`6755`) |
Victor Stinner | a7878b7 | 2011-07-14 23:07:44 +0200 | [diff] [blame] | 277 | |
Victor Stinner | 024e37a | 2011-03-31 01:31:06 +0200 | [diff] [blame] | 278 | faulthandler |
| 279 | ------------ |
| 280 | |
| 281 | New module: :mod:`faulthandler`. |
| 282 | |
| 283 | * :envvar:`PYTHONFAULTHANDLER` |
| 284 | * :option:`-X` ``faulthandler`` |
| 285 | |
Victor Stinner | e0be423 | 2011-10-25 13:06:09 +0200 | [diff] [blame] | 286 | time |
| 287 | ---- |
| 288 | |
| 289 | * The :mod:`time` module has new :func:`~time.clock_getres` and |
| 290 | :func:`~time.clock_gettime` functions and ``CLOCK_xxx`` constants. |
| 291 | :func:`~time.clock_gettime` can be used with :data:`time.CLOCK_MONOTONIC` to |
| 292 | get a monotonic clock. |
| 293 | |
| 294 | (Contributed by Victor Stinner in :issue:`10278`) |
| 295 | |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 296 | |
Victor Stinner | 811db3b | 2011-09-21 03:20:03 +0200 | [diff] [blame] | 297 | ftplib |
| 298 | ------ |
| 299 | |
| 300 | The :class:`~ftplib.FTP_TLS` class now provides a new |
| 301 | :func:`~ftplib.FTP_TLS.ccc` function to revert control channel back to |
Florent Xicluna | 6d57d21 | 2011-10-23 22:23:57 +0200 | [diff] [blame] | 302 | plaintext. This can be useful to take advantage of firewalls that know how to |
Victor Stinner | 811db3b | 2011-09-21 03:20:03 +0200 | [diff] [blame] | 303 | handle NAT with non-secure FTP without opening fixed ports. |
| 304 | |
| 305 | (Contributed by Giampaolo Rodolà in :issue:`12139`) |
| 306 | |
| 307 | |
Antoine Pitrou | 5a8bc6f | 2011-11-17 02:20:48 +0100 | [diff] [blame] | 308 | imaplib |
| 309 | ------- |
| 310 | |
| 311 | The :class:`~imaplib.IMAP4_SSL` constructor now accepts an SSLContext |
| 312 | parameter to control parameters of the secure channel. |
| 313 | |
| 314 | (Contributed by Sijin Joseph in :issue:`8808`) |
| 315 | |
| 316 | |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 317 | math |
| 318 | ---- |
| 319 | |
| 320 | The :mod:`math` module has a new function: |
| 321 | |
| 322 | * :func:`~math.log2`: return the base-2 logarithm of *x* |
| 323 | (Written by Mark Dickinson in :issue:`11888`). |
| 324 | |
| 325 | |
| 326 | nntplib |
| 327 | ------- |
| 328 | |
| 329 | The :class:`nntplib.NNTP` class now supports the context manager protocol to |
| 330 | unconditionally consume :exc:`socket.error` exceptions and to close the NNTP |
| 331 | connection when done:: |
| 332 | |
| 333 | >>> from nntplib import NNTP |
Ezio Melotti | 3c14b4e | 2011-07-13 11:44:44 +0300 | [diff] [blame] | 334 | >>> with NNTP('news.gmane.org') as n: |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 335 | ... n.group('gmane.comp.python.committers') |
| 336 | ... |
Ezio Melotti | 04f648c | 2011-07-26 09:37:46 +0300 | [diff] [blame] | 337 | ('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] | 338 | >>> |
| 339 | |
| 340 | (Contributed by Giampaolo Rodolà in :issue:`9795`) |
| 341 | |
| 342 | |
Giampaolo Rodolà | c9c2c8b | 2011-02-25 14:39:16 +0000 | [diff] [blame] | 343 | os |
| 344 | -- |
| 345 | |
Charles-François Natali | a003af1 | 2011-06-01 20:30:52 +0200 | [diff] [blame] | 346 | * The :mod:`os` module has a new :func:`~os.pipe2` function that makes it |
| 347 | possible to create a pipe with :data:`~os.O_CLOEXEC` or |
| 348 | :data:`~os.O_NONBLOCK` flags set atomically. This is especially useful to |
| 349 | avoid race conditions in multi-threaded programs. |
| 350 | |
Giampaolo Rodolà | 18e8bcb | 2011-02-25 20:57:54 +0000 | [diff] [blame] | 351 | * The :mod:`os` module has a new :func:`~os.sendfile` function which provides |
| 352 | an efficent "zero-copy" way for copying data from one file (or socket) |
| 353 | descriptor to another. The phrase "zero-copy" refers to the fact that all of |
| 354 | the copying of data between the two descriptors is done entirely by the |
| 355 | kernel, with no copying of data into userspace buffers. :func:`~os.sendfile` |
| 356 | can be used to efficiently copy data from a file on disk to a network socket, |
| 357 | e.g. for downloading a file. |
Giampaolo Rodolà | c9c2c8b | 2011-02-25 14:39:16 +0000 | [diff] [blame] | 358 | |
Giampaolo Rodolà | 18e8bcb | 2011-02-25 20:57:54 +0000 | [diff] [blame] | 359 | (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in :issue:`10882`.) |
| 360 | |
| 361 | * The :mod:`os` module has two new functions: :func:`~os.getpriority` and |
| 362 | :func:`~os.setpriority`. They can be used to get or set process |
| 363 | niceness/priority in a fashion similar to :func:`os.nice` but extended to all |
| 364 | processes instead of just the current one. |
| 365 | |
| 366 | (Patch submitted by Giampaolo Rodolà in :issue:`10784`.) |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 367 | |
Victor Stinner | e506437 | 2011-10-14 00:08:29 +0200 | [diff] [blame] | 368 | * "at" functions (:issue:`4761`): |
| 369 | |
| 370 | * :func:`~os.faccessat` |
| 371 | * :func:`~os.fchmodat` |
| 372 | * :func:`~os.fchownat` |
| 373 | * :func:`~os.fstatat` |
| 374 | * :func:`~os.futimesat` |
| 375 | * :func:`~os.futimesat` |
| 376 | * :func:`~os.linkat` |
| 377 | * :func:`~os.mkdirat` |
| 378 | * :func:`~os.mkfifoat` |
| 379 | * :func:`~os.mknodat` |
| 380 | * :func:`~os.openat` |
| 381 | * :func:`~os.readlinkat` |
| 382 | * :func:`~os.renameat` |
| 383 | * :func:`~os.symlinkat` |
| 384 | * :func:`~os.unlinkat` |
| 385 | * :func:`~os.utimensat` |
| 386 | * :func:`~os.utimensat` |
| 387 | |
| 388 | * extended attributes (:issue:`12720`): |
| 389 | |
| 390 | * :func:`~os.fgetxattr` |
| 391 | * :func:`~os.flistxattr` |
| 392 | * :func:`~os.fremovexattr` |
| 393 | * :func:`~os.fsetxattr` |
| 394 | * :func:`~os.getxattr` |
| 395 | * :func:`~os.lgetxattr` |
| 396 | * :func:`~os.listxattr` |
| 397 | * :func:`~os.llistxattr` |
| 398 | * :func:`~os.lremovexattr` |
| 399 | * :func:`~os.lsetxattr` |
| 400 | * :func:`~os.removexattr` |
| 401 | * :func:`~os.setxattr` |
| 402 | |
| 403 | * Scheduler functions (:issue:`12655`): |
| 404 | |
| 405 | * :func:`~os.sched_get_priority_max` |
| 406 | * :func:`~os.sched_get_priority_min` |
| 407 | * :func:`~os.sched_getaffinity` |
| 408 | * :func:`~os.sched_getparam` |
| 409 | * :func:`~os.sched_getscheduler` |
| 410 | * :func:`~os.sched_rr_get_interval` |
| 411 | * :func:`~os.sched_setaffinity` |
| 412 | * :func:`~os.sched_setparam` |
| 413 | * :func:`~os.sched_setscheduler` |
| 414 | * :func:`~os.sched_yield` |
| 415 | |
| 416 | * Add some extra posix functions to the os module (:issue:`10812`): |
| 417 | |
| 418 | * :func:`~os.fexecve` |
| 419 | * :func:`~os.futimens` |
| 420 | * :func:`~os.futimens` |
| 421 | * :func:`~os.futimes` |
| 422 | * :func:`~os.futimes` |
| 423 | * :func:`~os.lockf` |
| 424 | * :func:`~os.lutimes` |
| 425 | * :func:`~os.lutimes` |
| 426 | * :func:`~os.posix_fadvise` |
| 427 | * :func:`~os.posix_fallocate` |
| 428 | * :func:`~os.pread` |
| 429 | * :func:`~os.pwrite` |
| 430 | * :func:`~os.readv` |
| 431 | * :func:`~os.sync` |
| 432 | * :func:`~os.truncate` |
| 433 | * :func:`~os.waitid` |
| 434 | * :func:`~os.writev` |
| 435 | |
| 436 | * Other new functions: |
| 437 | |
| 438 | * :func:`~os.fdlistdir` (:issue:`10755`) |
| 439 | * :func:`~os.getgrouplist` (:issue:`9344`) |
| 440 | |
Giampaolo Rodolà | 424298a | 2011-03-03 18:34:06 +0000 | [diff] [blame] | 441 | |
Éric Araujo | 765e94f | 2011-06-03 17:26:59 +0200 | [diff] [blame] | 442 | packaging |
| 443 | --------- |
| 444 | |
| 445 | :mod:`distutils` has undergone additions and refactoring under a new name, |
| 446 | :mod:`packaging`, to allow developers to break backward compatibility. |
| 447 | :mod:`distutils` is still provided in the standard library, but users are |
| 448 | encouraged to transition to :mod:`packaging`. For older versions of Python, a |
| 449 | backport compatible with 2.4+ and 3.1+ will be made available on PyPI under the |
| 450 | name :mod:`distutils2`. |
| 451 | |
| 452 | .. TODO add examples and howto to the packaging docs and link to them |
| 453 | |
| 454 | |
Victor Stinner | 383c3fc | 2011-05-25 01:35:05 +0200 | [diff] [blame] | 455 | pydoc |
| 456 | ----- |
| 457 | |
Victor Stinner | 6daa33c | 2011-05-25 01:41:22 +0200 | [diff] [blame] | 458 | The Tk GUI and the :func:`~pydoc.serve` function have been removed from the |
| 459 | :mod:`pydoc` module: ``pydoc -g`` and :func:`~pydoc.serve` have been deprecated |
| 460 | in Python 3.2. |
Victor Stinner | 383c3fc | 2011-05-25 01:35:05 +0200 | [diff] [blame] | 461 | |
| 462 | |
Victor Stinner | d5c355c | 2011-04-30 14:53:09 +0200 | [diff] [blame] | 463 | sys |
| 464 | --- |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 465 | |
Éric Araujo | 84b8ed8 | 2011-08-29 21:42:47 +0200 | [diff] [blame] | 466 | * The :mod:`sys` module has a new :data:`~sys.thread_info` :term:`struct |
Victor Stinner | d5c355c | 2011-04-30 14:53:09 +0200 | [diff] [blame] | 467 | sequence` holding informations about the thread implementation. |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 468 | |
Georg Brandl | 00db582 | 2011-04-30 15:30:03 +0200 | [diff] [blame] | 469 | (:issue:`11223`) |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 470 | |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 471 | |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 472 | signal |
| 473 | ------ |
| 474 | |
Victor Stinner | fa0e3d5 | 2011-05-09 01:01:09 +0200 | [diff] [blame] | 475 | * The :mod:`signal` module has new functions: |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 476 | |
Victor Stinner | b3e7219 | 2011-05-08 01:46:11 +0200 | [diff] [blame] | 477 | * :func:`~signal.pthread_sigmask`: fetch and/or change the signal mask of the |
| 478 | calling thread (Contributed by Jean-Paul Calderone in :issue:`8407`) ; |
| 479 | * :func:`~signal.pthread_kill`: send a signal to a thread ; |
| 480 | * :func:`~signal.sigpending`: examine pending functions ; |
| 481 | * :func:`~signal.sigwait`: wait a signal. |
Ross Lagerwall | bc80822 | 2011-06-25 12:13:40 +0200 | [diff] [blame] | 482 | * :func:`~signal.sigwaitinfo`: wait for a signal, returning detailed |
| 483 | information about it. |
| 484 | * :func:`~signal.sigtimedwait`: like :func:`~signal.sigwaitinfo` but with a |
| 485 | timeout. |
Victor Stinner | a929335 | 2011-04-30 15:21:58 +0200 | [diff] [blame] | 486 | |
Victor Stinner | d49b1f1 | 2011-05-08 02:03:15 +0200 | [diff] [blame] | 487 | * The signal handler writes the signal number as a single byte instead of |
| 488 | a nul byte into the wakeup file descriptor. So it is possible to wait more |
| 489 | than one signal and know which signals were raised. |
| 490 | |
Victor Stinner | 388196e | 2011-05-10 17:13:00 +0200 | [diff] [blame] | 491 | * :func:`signal.signal` and :func:`signal.siginterrupt` raise an OSError, |
| 492 | instead of a RuntimeError: OSError has an errno attribute. |
| 493 | |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 494 | socket |
| 495 | ------ |
| 496 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 497 | * The :class:`~socket.socket` class now exposes additional methods to process |
| 498 | ancillary data when supported by the underlying platform: |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 499 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 500 | * :func:`~socket.socket.sendmsg` |
| 501 | * :func:`~socket.socket.recvmsg` |
| 502 | * :func:`~socket.socket.recvmsg_into` |
Nick Coghlan | 96fe56a | 2011-08-22 11:55:57 +1000 | [diff] [blame] | 503 | |
Charles-François Natali | 47413c1 | 2011-10-06 19:47:44 +0200 | [diff] [blame] | 504 | (Contributed by David Watson in :issue:`6560`, based on an earlier patch by |
| 505 | Heiko Wundram) |
| 506 | |
| 507 | * The :class:`~socket.socket` class now supports the PF_CAN protocol family |
| 508 | (http://en.wikipedia.org/wiki/Socketcan), on Linux |
| 509 | (http://lwn.net/Articles/253425). |
| 510 | |
| 511 | (Contributed by Matthias Fuchs, updated by Tiago Gonçalves in :issue:`10141`) |
| 512 | |
Charles-François Natali | 10b8cf4 | 2011-11-10 19:21:37 +0100 | [diff] [blame] | 513 | * The :class:`~socket.socket` class now supports the PF_RDS protocol family |
| 514 | (http://en.wikipedia.org/wiki/Reliable_Datagram_Sockets and |
| 515 | http://oss.oracle.com/projects/rds/). |
Victor Stinner | 754851f | 2011-04-19 23:58:51 +0200 | [diff] [blame] | 516 | |
Victor Stinner | 99c8b16 | 2011-05-24 12:05:19 +0200 | [diff] [blame] | 517 | ssl |
| 518 | --- |
| 519 | |
Antoine Pitrou | 2c0a967 | 2011-11-17 02:09:13 +0100 | [diff] [blame] | 520 | * The :mod:`ssl` module has two new random generation functions: |
Victor Stinner | 99c8b16 | 2011-05-24 12:05:19 +0200 | [diff] [blame] | 521 | |
| 522 | * :func:`~ssl.RAND_bytes`: generate cryptographically strong |
| 523 | pseudo-random bytes. |
| 524 | * :func:`~ssl.RAND_pseudo_bytes`: generate pseudo-random bytes. |
| 525 | |
Antoine Pitrou | 2c0a967 | 2011-11-17 02:09:13 +0100 | [diff] [blame] | 526 | (Contributed by Victor Stinner in :issue:`12049`) |
| 527 | |
| 528 | * The :mod:`ssl` module now exposes a finer-grained exception hierarchy |
| 529 | in order to make it easier to inspect the various kinds of errors. |
| 530 | |
| 531 | (Contributed by Antoine Pitrou in :issue:`11183`) |
| 532 | |
| 533 | * :meth:`~ssl.SSLContext.load_cert_chain` now accepts a *password* argument |
| 534 | to be used if the private key is encrypted. |
| 535 | |
| 536 | (Contributed by Adam Simpkins in :issue:`12803`) |
| 537 | |
| 538 | * SSL sockets have a new :meth:`~ssl.SSLSocket.get_channel_binding` method |
| 539 | allowing the implementation of certain authentication mechanisms such as |
| 540 | SCRAM-SHA-1-PLUS. |
| 541 | |
| 542 | (Contributed by Jacek Konieczny in :issue:`12551`) |
| 543 | |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 544 | shutil |
| 545 | ------ |
| 546 | |
Sandro Tosi | aec2f21 | 2011-08-23 00:58:21 +0200 | [diff] [blame] | 547 | * The :mod:`shutil` module has these new fuctions: |
Giampaolo Rodola' | 210e7ca | 2011-07-01 13:55:36 +0200 | [diff] [blame] | 548 | |
Sandro Tosi | aec2f21 | 2011-08-23 00:58:21 +0200 | [diff] [blame] | 549 | * :func:`~shutil.disk_usage`: provides total, used and free disk space |
| 550 | statistics. (Contributed by Giampaolo Rodolà in :issue:`12442`) |
| 551 | * :func:`~shutil.chown`: allows one to change user and/or group of the given |
| 552 | path also specifying the user/group names and not only their numeric |
| 553 | ids. (Contributed by Sandro Tosi in :issue:`12191`) |
Giampaolo Rodola' | 096dcb1 | 2011-06-27 11:17:51 +0200 | [diff] [blame] | 554 | |
Antoine Pitrou | 5a8bc6f | 2011-11-17 02:20:48 +0100 | [diff] [blame] | 555 | smtplib |
| 556 | ------- |
| 557 | |
| 558 | The :class:`~smtplib.SMTP_SSL` constructor and the :meth:`~smtplib.SMTP.starttls` |
| 559 | method now accept an SSLContext parameter to control parameters of the secure |
| 560 | channel. |
| 561 | |
| 562 | (Contributed by Kasun Herath in :issue:`8809`) |
| 563 | |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 564 | urllib |
| 565 | ------ |
| 566 | |
| 567 | The :class:`~urllib.request.Request` class, now accepts a *method* argument |
| 568 | 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] | 569 | should be used. For example, this will send a ``'HEAD'`` request:: |
Senthil Kumaran | de49d64 | 2011-10-16 23:54:44 +0800 | [diff] [blame] | 570 | |
| 571 | >>> urlopen(Request('http://www.python.org', method='HEAD')) |
| 572 | |
| 573 | (:issue:`1673007`) |
Giampaolo Rodola' | 096dcb1 | 2011-06-27 11:17:51 +0200 | [diff] [blame] | 574 | |
Giampaolo Rodola' | be55d99 | 2011-11-22 13:33:34 +0100 | [diff] [blame^] | 575 | sched |
| 576 | ----- |
| 577 | |
| 578 | * *timefunc* and *delayfunct* parameters of :class:`~sched.scheduler` class |
| 579 | constructor are now optional and defaults to :func:`time.time` and |
| 580 | :func:`time.sleep` respectively. (Contributed by Matt Mulsow in |
| 581 | :issue:`8809`) |
| 582 | |
| 583 | * :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs` |
| 584 | *argument* parameter is now optional. (Contributed by Matt Mulsow in |
| 585 | :issue:`8809`) |
| 586 | |
| 587 | * :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs` |
| 588 | now accept a *kwargs* parameter. (Contributed by Matt Mulsow in |
| 589 | :issue:`8809`) |
| 590 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 591 | Optimizations |
| 592 | ============= |
| 593 | |
| 594 | Major performance enhancements have been added: |
| 595 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 596 | * Thanks to the :pep:`393`, some operations on Unicode strings has been optimized: |
| 597 | |
| 598 | * 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] | 599 | * encode an ASCII string to UTF-8 doesn't need to encode characters anymore, |
| 600 | the UTF-8 representation is shared with the ASCII representation |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 601 | * getting a substring of a latin1 strings is 4 times faster |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 602 | |
| 603 | |
| 604 | Build and C API Changes |
| 605 | ======================= |
| 606 | |
| 607 | Changes to Python's build process and to the C API include: |
| 608 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 609 | * The :pep:`393` added new Unicode types, macros and functions: |
| 610 | |
Victor Stinner | a996f1e | 2011-11-21 13:14:43 +0100 | [diff] [blame] | 611 | * High-level API: |
| 612 | |
| 613 | * :c:func:`PyUnicode_CopyCharacters` |
| 614 | * :c:func:`PyUnicode_FindChar` |
| 615 | * :c:func:`PyUnicode_GetLength`, :c:macro:`PyUnicode_GET_LENGTH` |
| 616 | * :c:func:`PyUnicode_New` |
| 617 | * :c:func:`PyUnicode_Substring` |
| 618 | * :c:func:`PyUnicode_ReadChar`, :c:func:`PyUnicode_WriteChar` |
| 619 | |
| 620 | * Low-level API: |
| 621 | |
| 622 | * :c:type:`Py_UCS1`, :c:type:`Py_UCS2`, :c:type:`Py_UCS4` types |
| 623 | * :c:type:`PyASCIIObject` and :c:type:`PyCompactUnicodeObject` structures |
| 624 | * :c:macro:`PyUnicode_READY` |
| 625 | * :c:func:`PyUnicode_FromKindAndData` |
| 626 | * :c:func:`PyUnicode_AsUCS4`, :c:func:`PyUnicode_AsUCS4Copy` |
| 627 | * :c:macro:`PyUnicode_DATA`, :c:macro:`PyUnicode_1BYTE_DATA`, |
| 628 | :c:macro:`PyUnicode_2BYTE_DATA`, :c:macro:`PyUnicode_4BYTE_DATA` |
| 629 | * :c:macro:`PyUnicode_KIND` with :c:type:`PyUnicode_Kind` enum: |
| 630 | :c:data:`PyUnicode_WCHAR_KIND`, :c:data:`PyUnicode_1BYTE_KIND`, |
| 631 | :c:data:`PyUnicode_2BYTE_KIND`, :c:data:`PyUnicode_4BYTE_KIND` |
| 632 | * :c:macro:`PyUnicode_READ`, :c:macro:`PyUnicode_READ_CHAR`, :c:macro:`PyUnicode_WRITE` |
| 633 | * :c:macro:`PyUnicode_MAX_CHAR_VALUE` |
| 634 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 635 | |
| 636 | |
Georg Brandl | 0cd25c9 | 2011-04-29 13:45:54 +0200 | [diff] [blame] | 637 | Unsupported Operating Systems |
Victor Stinner | b90db4c | 2011-04-26 22:48:24 +0200 | [diff] [blame] | 638 | ============================= |
| 639 | |
Brian Curtin | 49a40cd | 2011-05-02 22:30:06 -0500 | [diff] [blame] | 640 | OS/2 and VMS are no longer supported due to the lack of a maintainer. |
| 641 | |
| 642 | Windows 2000 and Windows platforms which set ``COMSPEC`` to ``command.com`` |
| 643 | are no longer supported due to maintenance burden. |
Victor Stinner | b90db4c | 2011-04-26 22:48:24 +0200 | [diff] [blame] | 644 | |
| 645 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 646 | Deprecated Python modules, functions and methods |
| 647 | ================================================ |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 648 | |
| 649 | * The :mod:`packaging` module replaces the :mod:`distutils` module |
| 650 | * The ``unicode_internal`` codec has been deprecated because of the |
| 651 | :pep:`393`, use UTF-8, UTF-16 (``utf-16-le`` or ``utf-16-le``), or UTF-32 |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 652 | (``utf-32-le`` or ``utf-32-le``) |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 653 | * :meth:`ftplib.FTP.nlst` and :meth:`ftplib.FTP.dir`: use |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 654 | :meth:`ftplib.FTP.mlsd` |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 655 | * :func:`platform.popen`: use the :mod:`subprocess` module. Check especially |
| 656 | the :ref:`subprocess-replacements` section. |
| 657 | * :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] | 658 | module. Use Unicode filenames, instead of bytes filenames, to not depend on |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 659 | the ANSI code page anymore and to support any filename. |
| 660 | |
| 661 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 662 | Deprecated functions and types of the C API |
| 663 | =========================================== |
| 664 | |
| 665 | The :c:type:`Py_UNICODE` has been deprecated by the :pep:`393` and will be |
| 666 | removed in Python 4. All functions using this type are deprecated: |
| 667 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 668 | Unicode functions and methods using :c:type:`Py_UNICODE` and |
| 669 | :c:type:`Py_UNICODE*` types: |
| 670 | |
| 671 | * :c:macro:`PyUnicode_FromUnicode`: use :c:func:`PyUnicode_FromWideChar` or |
| 672 | :c:func:`PyUnicode_FromKindAndData` |
| 673 | * :c:macro:`PyUnicode_AS_UNICODE`, :c:func:`PyUnicode_AsUnicode`, |
| 674 | :c:func:`PyUnicode_AsUnicodeAndSize`: use :c:func:`PyUnicode_AsWideCharString` |
| 675 | * :c:macro:`PyUnicode_AS_DATA`: use :c:macro:`PyUnicode_DATA` with |
| 676 | :c:macro:`PyUnicode_READ` and :c:macro:`PyUnicode_WRITE` |
| 677 | * :c:macro:`PyUnicode_GET_SIZE`, :c:func:`PyUnicode_GetSize`: use |
| 678 | :c:macro:`PyUnicode_GET_LENGTH` or :c:func:`PyUnicode_GetLength` |
| 679 | * :c:macro:`PyUnicode_GET_DATA_SIZE`: use |
| 680 | ``PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)`` (only work on ready |
| 681 | strings) |
| 682 | * :c:func:`PyUnicode_AsUnicodeCopy`: use :c:func:`PyUnicode_AsUCS4Copy`, |
| 683 | :c:func:`PyUnicode_AsWideCharString` or :c:func:`PyUnicode_Copy` |
| 684 | |
Victor Stinner | a996f1e | 2011-11-21 13:14:43 +0100 | [diff] [blame] | 685 | Functions and macros manipulating Py_UNICODE* strings: |
| 686 | |
| 687 | * :c:macro:`Py_UNICODE_strlen`: use :c:func:`PyUnicode_GetLength` or |
| 688 | :c:macro:`PyUnicode_GET_LENGTH` |
| 689 | * :c:macro:`Py_UNICODE_strcat`: use :c:func:`PyUnicode_CopyCharacters` or |
| 690 | :c:func:`PyUnicode_FromFormat` |
| 691 | * :c:macro:`Py_UNICODE_strcpy`, :c:macro:`Py_UNICODE_strncpy`, |
| 692 | :c:macro:`Py_UNICODE_COPY`: use :c:func:`PyUnicode_CopyCharacters` or |
| 693 | :c:func:`PyUnicode_Substring` |
| 694 | * :c:macro:`Py_UNICODE_strcmp`: use :c:func:`PyUnicode_Compare` |
| 695 | * :c:macro:`Py_UNICODE_strncmp`: use :c:func:`PyUnicode_Tailmatch` |
| 696 | * :c:macro:`Py_UNICODE_strchr`, :c:macro:`Py_UNICODE_strrchr`: use |
| 697 | :c:func:`PyUnicode_FindChar` |
| 698 | * :c:macro:`Py_UNICODE_FILL` |
| 699 | |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 700 | Encoders: |
| 701 | |
| 702 | * :c:func:`PyUnicode_Encode`: use :c:func:`PyUnicode_AsEncodedObject` |
| 703 | * :c:func:`PyUnicode_EncodeUTF7` |
Victor Stinner | a996f1e | 2011-11-21 13:14:43 +0100 | [diff] [blame] | 704 | * :c:func:`PyUnicode_EncodeUTF8`: use :c:func:`PyUnicode_AsUTF8` or |
| 705 | :c:func:`PyUnicode_AsUTF8String` |
Victor Stinner | 46606ce | 2011-11-20 18:27:55 +0100 | [diff] [blame] | 706 | * :c:func:`PyUnicode_EncodeUTF32` |
| 707 | * :c:func:`PyUnicode_EncodeUTF16` |
| 708 | * :c:func:`PyUnicode_EncodeUnicodeEscape:` use |
| 709 | :c:func:`PyUnicode_AsUnicodeEscapeString` |
| 710 | * :c:func:`PyUnicode_EncodeRawUnicodeEscape:` use |
| 711 | :c:func:`PyUnicode_AsRawUnicodeEscapeString` |
| 712 | * :c:func:`PyUnicode_EncodeLatin1`: use :c:func:`PyUnicode_AsLatin1String` |
| 713 | * :c:func:`PyUnicode_EncodeASCII`: use :c:func:`PyUnicode_AsASCIIString` |
| 714 | * :c:func:`PyUnicode_EncodeCharmap` |
| 715 | * :c:func:`PyUnicode_TranslateCharmap` |
| 716 | * :c:func:`PyUnicode_EncodeMBCS`: use :c:func:`PyUnicode_AsMBCSString` or |
| 717 | :c:func:`PyUnicode_EncodeCodePage` (with ``CP_ACP`` code_page) |
| 718 | * :c:func:`PyUnicode_EncodeDecimal`, |
| 719 | :c:func:`PyUnicode_TransformDecimalToASCII` |
| 720 | |
| 721 | |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 722 | Porting to Python 3.3 |
| 723 | ===================== |
| 724 | |
| 725 | This section lists previously described changes and other bugfixes |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 726 | that may require changes to your code. |
| 727 | |
| 728 | Porting Python code |
| 729 | ------------------- |
Giampaolo Rodolà | 3108f98 | 2011-02-24 20:59:48 +0000 | [diff] [blame] | 730 | |
Victor Stinner | 19bd069 | 2011-11-16 00:18:57 +0100 | [diff] [blame] | 731 | * :issue:`12326`: On Linux, sys.platform doesn't contain the major version |
Victor Stinner | ff3d939 | 2011-08-20 23:39:26 +0200 | [diff] [blame] | 732 | anymore. It is now always 'linux', instead of 'linux2' or 'linux3' depending |
| 733 | on the Linux version used to build Python. Replace sys.platform == 'linux2' |
| 734 | with sys.platform.startswith('linux'), or directly sys.platform == 'linux' if |
| 735 | you don't need to support older Python versions. |
Éric Araujo | c09fca6 | 2011-03-23 02:06:24 +0100 | [diff] [blame] | 736 | |
Antoine Pitrou | 037ffbf | 2011-10-24 00:25:41 +0200 | [diff] [blame] | 737 | Porting C code |
| 738 | -------------- |
| 739 | |
| 740 | * Due to :ref:`PEP 393 <pep-393>`, the :c:type:`Py_UNICODE` type and all |
| 741 | functions using this type are deprecated (but will stay available for |
| 742 | at least five years). If you were using low-level Unicode APIs to |
| 743 | construct and access unicode objects and you want to benefit of the |
| 744 | memory footprint reduction provided by the PEP 393, you have to convert |
| 745 | your code to the new :doc:`Unicode API <../c-api/unicode>`. |
| 746 | |
| 747 | However, if you only have been using high-level functions such as |
| 748 | :c:func:`PyUnicode_Concat()`, :c:func:`PyUnicode_Join` or |
| 749 | :c:func:`PyUnicode_FromFormat()`, your code will automatically take |
| 750 | advantage of the new unicode representations. |
| 751 | |
| 752 | Other issues |
| 753 | ------------ |
| 754 | |
Éric Araujo | c09fca6 | 2011-03-23 02:06:24 +0100 | [diff] [blame] | 755 | .. Issue #11591: When :program:`python` was started with :option:`-S`, |
| 756 | ``import site`` will not add site-specific paths to the module search |
| 757 | paths. In previous versions, it did. See changeset for doc changes in |
| 758 | various files. Contributed by Carl Meyer with editions by Éric Araujo. |
Éric Araujo | be3bd57 | 2011-03-26 01:55:15 +0100 | [diff] [blame] | 759 | |
Éric Araujo | bfc9729 | 2011-11-14 18:18:15 +0100 | [diff] [blame] | 760 | .. Issue #10998: the -Q command-line flag and related artifacts have been |
Éric Araujo | be3bd57 | 2011-03-26 01:55:15 +0100 | [diff] [blame] | 761 | removed. Code checking sys.flags.division_warning will need updating. |
| 762 | Contributed by Éric Araujo. |