blob: 560331f39b9e7c9ea7886ccba96d8906e0e00570 [file] [log] [blame]
Giampaolo Rodolà3108f982011-02-24 20:59:48 +00001****************************
2 What's New In Python 3.3
3****************************
4
5:Author: Raymond Hettinger
6:Release: |release|
7:Date: |today|
8
Éric Araujob07b97f2011-10-05 01:03:34 +02009.. Rules for maintenance:
Giampaolo Rodolà3108f982011-02-24 20:59:48 +000010
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à3108f982011-02-24 20:59:48 +000042 XXX Describe the transmogrify() function added to the socket
43 module.
Éric Araujob07b97f2011-10-05 01:03:34 +020044 (Contributed by P.Y. Developer in :issue:`12345`.)
Giampaolo Rodolà3108f982011-02-24 20:59:48 +000045
Éric Araujob07b97f2011-10-05 01:03:34 +020046 This saves the maintainer the effort of going through the Mercurial log
Giampaolo Rodolà3108f982011-02-24 20:59:48 +000047 when researching a change.
48
49This article explains the new features in Python 3.3, compared to 3.2.
50
51
Stefan Krah9a2d99e2012-02-25 12:24:21 +010052.. _pep-3118:
53
54PEP 3118: New memoryview implementation and buffer protocol documentation
55=========================================================================
56
57:issue:`10181` - memoryview bug fixes and features.
58 Written by Stefan Krah.
59
60The new memoryview implementation comprehensively fixes all ownership and
61lifetime issues of dynamically allocated fields in the Py_buffer struct
62that led to multiple crash reports. Additionally, several functions that
63crashed or returned incorrect results for non-contiguous or multi-dimensional
64input have been fixed.
65
66The memoryview object now has a PEP-3118 compliant getbufferproc()
67that checks the consumer's request type. Many new features have been
68added, most of them work in full generality for non-contiguous arrays
69and arrays with suboffsets.
70
71The documentation has been updated, clearly spelling out responsibilities
72for both exporters and consumers. Buffer request flags are grouped into
73basic and compound flags. The memory layout of non-contiguous and
74multi-dimensional NumPy-style arrays is explained.
75
76Features
77--------
78
79* All native single character format specifiers in struct module syntax
80 (optionally prefixed with '@') are now supported.
81
82* With some restrictions, the cast() method allows changing of format and
83 shape of C-contiguous arrays.
84
85* Multi-dimensional list representations are supported for any array type.
86
87* Multi-dimensional comparisons are supported for any array type.
88
89* All array types are hashable if the exporting object is hashable
90 and the view is read-only.
91
92* Arbitrary slicing of any 1-D arrays type is supported. For example, it
93 is now possible to reverse a memoryview in O(1) by using a negative step.
94
95API changes
96-----------
97
98* The maximum number of dimensions is officially limited to 64.
99
100* The representation of empty shape, strides and suboffsets is now
101 an empty tuple instead of None.
102
103* Accessing a memoryview element with format 'B' (unsigned bytes)
104 now returns an integer (in accordance with the struct module syntax).
105 For returning a bytes object the view must be cast to 'c' first.
106
107
Antoine Pitrou037ffbf2011-10-24 00:25:41 +0200108.. _pep-393:
109
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300110PEP 393: Flexible String Representation
111=======================================
112
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200113The Unicode string type is changed to support multiple internal
114representations, depending on the character with the largest Unicode ordinal
115(1, 2, or 4 bytes) in the represented string. This allows a space-efficient
116representation in common cases, but gives access to full UCS-4 on all
117systems. For compatibility with existing APIs, several representations may
118exist in parallel; over time, this compatibility should be phased out.
Ezio Melotti397546a2011-09-29 08:34:36 +0300119
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200120On the Python side, there should be no downside to this change.
Ezio Melotti397546a2011-09-29 08:34:36 +0300121
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200122On the C API side, PEP 393 is fully backward compatible. The legacy API
123should remain available at least five years. Applications using the legacy
124API will not fully benefit of the memory reduction, or - worse - may use
125a bit more memory, because Python may have to maintain two versions of each
126string (in the legacy format and in the new efficient storage).
127
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100128Functionality
129-------------
130
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200131Changes introduced by :pep:`393` are the following:
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300132
Ezio Melotti397546a2011-09-29 08:34:36 +0300133* Python now always supports the full range of Unicode codepoints, including
134 non-BMP ones (i.e. from ``U+0000`` to ``U+10FFFF``). The distinction between
135 narrow and wide builds no longer exists and Python now behaves like a wide
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200136 build, even under Windows.
Ezio Melotti397546a2011-09-29 08:34:36 +0300137
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200138* With the death of narrow builds, the problems specific to narrow builds have
139 also been fixed, for example:
Ezio Melotti397546a2011-09-29 08:34:36 +0300140
141 * :func:`len` now always returns 1 for non-BMP characters,
142 so ``len('\U0010FFFF') == 1``;
143
144 * surrogate pairs are not recombined in string literals,
145 so ``'\uDBFF\uDFFF' != '\U0010FFFF'``;
146
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200147 * indexing or slicing non-BMP characters returns the expected value,
Ezio Melotti397546a2011-09-29 08:34:36 +0300148 so ``'\U0010FFFF'[0]`` now returns ``'\U0010FFFF'`` and not ``'\uDBFF'``;
149
Antoine Pitroud136aec2011-11-17 01:48:06 +0100150 * all other functions in the standard library now correctly handle
Antoine Pitroufd9b4162011-10-24 00:14:43 +0200151 non-BMP codepoints.
Ezio Melotti397546a2011-09-29 08:34:36 +0300152
Ezio Melotti48a2f8f2011-09-29 00:18:19 +0300153* The value of :data:`sys.maxunicode` is now always ``1114111`` (``0x10FFFF``
154 in hexadecimal). The :c:func:`PyUnicode_GetMax` function still returns
155 either ``0xFFFF`` or ``0x10FFFF`` for backward compatibility, and it should
156 not be used with the new Unicode API (see :issue:`13054`).
157
Ezio Melotti397546a2011-09-29 08:34:36 +0300158* The :file:`./configure` flag ``--with-wide-unicode`` has been removed.
Victor Stinner7d637ab2011-09-29 02:56:16 +0200159
Antoine Pitrou0599b5b2011-11-29 22:45:07 +0100160Performance and resource usage
161------------------------------
162
163The storage of Unicode strings now depends on the highest codepoint in the string:
164
165* pure ASCII and Latin1 strings (``U+0000-U+00FF``) use 1 byte per codepoint;
166
167* BMP strings (``U+0000-U+FFFF``) use 2 bytes per codepoint;
168
169* non-BMP strings (``U+10000-U+10FFFF``) use 4 bytes per codepoint.
170
171The net effect is that for most applications, memory usage of string storage
172should decrease significantly - especially compared to former wide unicode
173builds - as, in many cases, strings will be pure ASCII even in international
174contexts (because many strings store non-human language data, such as XML
175fragments, HTTP headers, JSON-encoded data, etc.). We also hope that it
176will, for the same reasons, increase CPU cache efficiency on non-trivial
177applications.
178
179.. The memory usage of Python 3.3 is two to three times smaller than Python 3.2,
180 and a little bit better than Python 2.7, on a `Django benchmark
181 <http://mail.python.org/pipermail/python-dev/2011-September/113714.html>`_.
182 XXX The result should be moved in the PEP and a link to the PEP should
183 be added here.
184
Éric Araujob07b97f2011-10-05 01:03:34 +0200185
Victor Stinnera1bf2982011-10-12 20:35:02 +0200186PEP 3151: Reworking the OS and IO exception hierarchy
187=====================================================
188
189:pep:`3151` - Reworking the OS and IO exception hierarchy
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200190 PEP written and implemented by Antoine Pitrou.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200191
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200192The hierarchy of exceptions raised by operating system errors is now both
193simplified and finer-grained.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200194
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200195You don't have to worry anymore about choosing the appropriate exception
196type between :exc:`OSError`, :exc:`IOError`, :exc:`EnvironmentError`,
197:exc:`WindowsError`, :exc:`mmap.error`, :exc:`socket.error` or
198:exc:`select.error`. All these exception types are now only one:
199:exc:`OSError`. The other names are kept as aliases for compatibility
200reasons.
Victor Stinnera1bf2982011-10-12 20:35:02 +0200201
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200202Also, it is now easier to catch a specific error condition. Instead of
203inspecting the ``errno`` attribute (or ``args[0]``) for a particular
204constant from the :mod:`errno` module, you can catch the adequate
205:exc:`OSError` subclass. The available subclasses are the following:
Victor Stinnera1bf2982011-10-12 20:35:02 +0200206
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200207* :exc:`BlockingIOError`
208* :exc:`ChildProcessError`
209* :exc:`ConnectionError`
210* :exc:`FileExistsError`
211* :exc:`FileNotFoundError`
212* :exc:`InterruptedError`
213* :exc:`IsADirectoryError`
214* :exc:`NotADirectoryError`
215* :exc:`PermissionError`
216* :exc:`ProcessLookupError`
217* :exc:`TimeoutError`
Victor Stinnera1bf2982011-10-12 20:35:02 +0200218
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200219And the :exc:`ConnectionError` itself has finer-grained subclasses:
Victor Stinnera1bf2982011-10-12 20:35:02 +0200220
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200221* :exc:`BrokenPipeError`
222* :exc:`ConnectionAbortedError`
223* :exc:`ConnectionRefusedError`
224* :exc:`ConnectionResetError`
Victor Stinnera1bf2982011-10-12 20:35:02 +0200225
226Thanks to the new exceptions, common usages of the :mod:`errno` can now be
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200227avoided. For example, the following code written for Python 3.2::
Victor Stinnera1bf2982011-10-12 20:35:02 +0200228
229 from errno import ENOENT, EACCES, EPERM
230
231 try:
232 with open("document.txt") as f:
233 content = f.read()
234 except IOError as err:
235 if err.errno == ENOENT:
236 print("document.txt file is missing")
237 elif err.errno in (EACCES, EPERM):
238 print("You are not allowed to read document.txt")
239 else:
240 raise
241
Antoine Pitrou01fd26c2011-10-24 00:07:02 +0200242can now be written without the :mod:`errno` import and without manual
243inspection of exception attributes::
Victor Stinnera1bf2982011-10-12 20:35:02 +0200244
245 try:
246 with open("document.txt") as f:
247 content = f.read()
248 except FileNotFoundError:
249 print("document.txt file is missing")
250 except PermissionError:
251 print("You are not allowed to read document.txt")
252
253
Nick Coghlan1f7ce622012-01-13 21:43:40 +1000254PEP 380: Syntax for Delegating to a Subgenerator
255================================================
256
257PEP 380 adds the ``yield from`` expression, allowing a generator to delegate
258part of its operations to another generator. This allows a section of code
259containing 'yield' to be factored out and placed in another generator.
260Additionally, the subgenerator is allowed to return with a value, and the
261value is made available to the delegating generator.
262While designed primarily for use in delegating to a subgenerator, the ``yield
263from`` expression actually allows delegation to arbitrary subiterators.
264
265(Implementation by Greg Ewing, integrated into 3.3 by Renaud Blanch, Ryan
266Kelly and Nick Coghlan, documentation by Zbigniew Jędrzejewski-Szmek and
267Nick Coghlan)
268
269
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100270PEP 3155: Qualified name for classes and functions
271==================================================
272
273:pep:`3155` - Qualified name for classes and functions
274 PEP written and implemented by Antoine Pitrou.
275
276Functions and class objects have a new ``__qualname__`` attribute representing
277the "path" from the module top-level to their definition. For global functions
278and classes, this is the same as ``__name__``. For other functions and classes,
279it provides better information about where they were actually defined, and
280how they might be accessible from the global scope.
281
282Example with (non-bound) methods::
Nick Coghlan2dfe6b02012-01-14 14:19:49 +1000283
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100284 >>> class C:
285 ... def meth(self):
286 ... pass
287 >>> C.meth.__name__
288 'meth'
289 >>> C.meth.__qualname__
290 'C.meth'
291
292Example with nested classes::
293
294 >>> class C:
295 ... class D:
296 ... def meth(self):
297 ... pass
298 ...
299 >>> C.D.__name__
300 'D'
301 >>> C.D.__qualname__
302 'C.D'
303 >>> C.D.meth.__name__
304 'meth'
305 >>> C.D.meth.__qualname__
306 'C.D.meth'
307
308Example with nested functions::
309
310 >>> def outer():
311 ... def inner():
312 ... pass
313 ... return inner
314 ...
315 >>> outer().__name__
316 'inner'
317 >>> outer().__qualname__
318 'outer.<locals>.inner'
319
Antoine Pitroue7ede062011-11-25 19:11:26 +0100320The string representation of those objects is also changed to include the
Antoine Pitrou6bbd76b2011-11-25 19:10:05 +0100321new, more precise information::
322
323 >>> str(C.D)
324 "<class '__main__.C.D'>"
325 >>> str(C.D.meth)
326 '<function C.D.meth at 0x7f46b9fe31e0>'
327
328
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000329Other Language Changes
330======================
331
332Some smaller changes made to the core Python language are:
333
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100334* Added support for Unicode name aliases and named sequences.
335 Both :func:`unicodedata.lookup()` and ``'\N{...}'`` now resolve name aliases,
336 and :func:`unicodedata.lookup()` resolves named sequences too.
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000337
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100338 (Contributed by Ezio Melotti in :issue:`12753`)
Ezio Melotti931b8aa2011-10-21 21:57:36 +0300339
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100340* Equality comparisons on :func:`range` objects now return a result reflecting
341 the equality of the underlying sequences generated by those range objects.
Ezio Melotti931b8aa2011-10-21 21:57:36 +0300342
Sandro Tosicd899122012-01-22 12:16:04 +0100343 (:issue:`13201`)
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000344
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100345* The ``count()``, ``find()``, ``rfind()``, ``index()`` and ``rindex()``
346 methods of :class:`bytes` and :class:`bytearray` objects now accept an
347 integer between 0 and 255 as their first argument.
Mark Dickinson36645682011-10-23 19:53:01 +0100348
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100349 (:issue:`12170`)
Mark Dickinson36645682011-10-23 19:53:01 +0100350
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100351* Memoryview objects are now hashable when the underlying object is hashable.
Mark Dickinson36645682011-10-23 19:53:01 +0100352
Antoine Pitrou7b578b32011-11-29 22:47:11 +0100353 (Contributed by Antoine Pitrou in :issue:`13411`)
Petri Lehtinen61ea8a02011-11-24 22:00:46 +0200354
355
Victor Stinner46606ce2011-11-20 18:27:55 +0100356New and Improved Modules
357========================
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000358
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100359abc
360---
361
362Improved support for abstract base classes containing descriptors composed with
363abstract methods. The recommended approach to declaring abstract descriptors is
364now to provide :attr:`__isabstractmethod__` as a dynamically updated
365property. The built-in descriptors have been updated accordingly.
366
367 * :class:`abc.abstractproperty` has been deprecated, use :class:`property`
368 with :func:`abc.abstractmethod` instead.
369 * :class:`abc.abstractclassmethod` has been deprecated, use
370 :class:`classmethod` with :func:`abc.abstractmethod` instead.
371 * :class:`abc.abstractstaticmethod` has been deprecated, use
372 :class:`staticmethod` with :func:`abc.abstractmethod` instead.
373
374(Contributed by Darren Dale in :issue:`11610`)
375
Meador Ingec5dbb3d2011-09-20 21:48:16 -0500376array
377-----
378
379The :mod:`array` module supports the :c:type:`long long` type using ``q`` and
380``Q`` type codes.
381
382(Contributed by Oren Tirosh and Hirokazu Yamamoto in :issue:`1172711`)
383
384
Nadeem Vawdad7e5c6e2012-02-12 01:34:18 +0200385bz2
386---
387
388The :mod:`bz2` module has been rewritten from scratch. In the process, several
389new features have been added:
390
391* :class:`bz2.BZ2File` can now read from and write to arbitrary file-like
392 objects, by means of its constructor's *fileobj* argument.
393
394 (Contributed by Nadeem Vawda in :issue:`5863`)
395
396* :class:`bz2.BZ2File` and :func:`bz2.decompress` can now decompress
397 multi-stream inputs (such as those produced by the :program:`pbzip2` tool).
398 :class:`bz2.BZ2File` can now also be used to create this type of file, using
399 the ``'a'`` (append) mode.
400
401 (Contributed by Nir Aides in :issue:`1625`)
402
403* :class:`bz2.BZ2File` now implements all of the :class:`io.BufferedIOBase` API,
404 except for the :meth:`detach` and :meth:`truncate` methods.
405
406
Victor Stinner2cded9c2011-07-08 01:45:13 +0200407codecs
408------
409
Antoine Pitrou4f863432012-02-12 02:12:47 +0100410The :mod:`~encodings.mbcs` codec has been rewritten to handle correctly
Georg Brandlff962c52012-02-04 08:55:56 +0100411``replace`` and ``ignore`` error handlers on all Windows versions. The
412:mod:`~encodings.mbcs` codec now supports all error handlers, instead of only
413``replace`` to encode and ``ignore`` to decode.
Victor Stinner3a50e702011-10-18 21:21:00 +0200414
Georg Brandlff962c52012-02-04 08:55:56 +0100415A new Windows-only codec has been added: ``cp65001`` (:issue:`13216`). It is the
416Windows code page 65001 (Windows UTF-8, ``CP_UTF8``). For example, it is used
417by ``sys.stdout`` if the console output code page is set to cp65001 (e.g., using
418``chcp 65001`` command).
Victor Stinner2f3ca9f2011-10-27 01:38:56 +0200419
Georg Brandlff962c52012-02-04 08:55:56 +0100420Multibyte CJK decoders now resynchronize faster. They only ignore the first
Georg Brandl6c0929b2011-07-09 11:43:33 +0200421byte of an invalid byte sequence. For example, ``b'\xff\n'.decode('gb2312',
422'replace')`` now returns a ``\n`` after the replacement character.
Victor Stinner2cded9c2011-07-08 01:45:13 +0200423
Georg Brandl6c0929b2011-07-09 11:43:33 +0200424(:issue:`12016`)
Victor Stinner2cded9c2011-07-08 01:45:13 +0200425
Georg Brandlff962c52012-02-04 08:55:56 +0100426Incremental CJK codec encoders are no longer reset at each call to their
427encode() methods. For example::
Victor Stinner2cded9c2011-07-08 01:45:13 +0200428
429 $ ./python -q
430 >>> import codecs
431 >>> encoder = codecs.getincrementalencoder('hz')('strict')
432 >>> b''.join(encoder.encode(x) for x in '\u52ff\u65bd\u65bc\u4eba\u3002 Bye.')
433 b'~{NpJ)l6HK!#~} Bye.'
434
Georg Brandl6c0929b2011-07-09 11:43:33 +0200435This example gives ``b'~{Np~}~{J)~}~{l6~}~{HK~}~{!#~} Bye.'`` with older Python
Victor Stinner2cded9c2011-07-08 01:45:13 +0200436versions.
437
Georg Brandl6c0929b2011-07-09 11:43:33 +0200438(:issue:`12100`)
Victor Stinner2cded9c2011-07-08 01:45:13 +0200439
Victor Stinner9f4b1e92011-11-10 20:56:30 +0100440The ``unicode_internal`` codec has been deprecated.
441
Éric Araujo84b8ed82011-08-29 21:42:47 +0200442crypt
443-----
444
Victor Stinnerc78fb332011-09-21 03:35:44 +0200445Addition of salt and modular crypt format and the :func:`~crypt.mksalt`
446function to the :mod:`crypt` module.
Éric Araujo84b8ed82011-08-29 21:42:47 +0200447
448(:issue:`10924`)
449
Victor Stinnera7878b72011-07-14 23:07:44 +0200450curses
451------
452
Victor Stinner0fdfceb2011-11-25 22:10:02 +0100453 * If the :mod:`curses` module is linked to the ncursesw library, use Unicode
454 functions when Unicode strings or characters are passed (e.g.
455 :c:func:`waddwstr`), and bytes functions otherwise (e.g. :c:func:`waddstr`).
456 * Use the locale encoding instead of ``utf-8`` to encode Unicode strings.
457 * :class:`curses.window` has a new :attr:`curses.window.encoding` attribute.
Victor Stinnerc78fb332011-09-21 03:35:44 +0200458 * The :class:`curses.window` class has a new :meth:`~curses.window.get_wch`
459 method to get a wide character
460 * The :mod:`curses` module has a new :meth:`~curses.unget_wch` function to
461 push a wide character so the next :meth:`~curses.window.get_wch` will return
462 it
Victor Stinnera7878b72011-07-14 23:07:44 +0200463
Victor Stinnerc78fb332011-09-21 03:35:44 +0200464(Contributed by Iñigo Serna in :issue:`6755`)
Victor Stinnera7878b72011-07-14 23:07:44 +0200465
Victor Stinner024e37a2011-03-31 01:31:06 +0200466faulthandler
467------------
468
469New module: :mod:`faulthandler`.
470
471 * :envvar:`PYTHONFAULTHANDLER`
472 * :option:`-X` ``faulthandler``
473
Victor Stinner811db3b2011-09-21 03:20:03 +0200474ftplib
475------
476
477The :class:`~ftplib.FTP_TLS` class now provides a new
478:func:`~ftplib.FTP_TLS.ccc` function to revert control channel back to
Florent Xicluna6d57d212011-10-23 22:23:57 +0200479plaintext. This can be useful to take advantage of firewalls that know how to
Victor Stinner811db3b2011-09-21 03:20:03 +0200480handle NAT with non-secure FTP without opening fixed ports.
481
482(Contributed by Giampaolo Rodolà in :issue:`12139`)
483
484
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +0100485imaplib
486-------
487
488The :class:`~imaplib.IMAP4_SSL` constructor now accepts an SSLContext
489parameter to control parameters of the secure channel.
490
491(Contributed by Sijin Joseph in :issue:`8808`)
492
493
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100494io
495--
496
Charles-François Natalid612de12012-01-14 11:51:00 +0100497The :func:`~io.open` function has a new ``'x'`` mode that can be used to
498exclusively create a new file, and raise a :exc:`FileExistsError` if the file
499already exists. It is based on the C11 'x' mode to fopen().
Charles-François Natalidc3044c2012-01-09 22:40:02 +0100500
501(Contributed by David Townshend in :issue:`12760`)
502
503
Nadeem Vawda34599222011-12-09 01:32:46 +0200504lzma
505----
506
507The newly-added :mod:`lzma` module provides data compression and decompression
508using the LZMA algorithm, including support for the ``.xz`` and ``.lzma``
509file formats.
510
511(Contributed by Nadeem Vawda and Per Øyvind Karlsen in :issue:`6715`)
512
513
Victor Stinnerfa0e3d52011-05-09 01:01:09 +0200514math
515----
516
517The :mod:`math` module has a new function:
518
519 * :func:`~math.log2`: return the base-2 logarithm of *x*
520 (Written by Mark Dickinson in :issue:`11888`).
521
522
523nntplib
524-------
525
526The :class:`nntplib.NNTP` class now supports the context manager protocol to
527unconditionally consume :exc:`socket.error` exceptions and to close the NNTP
528connection when done::
529
530 >>> from nntplib import NNTP
Ezio Melotti3c14b4e2011-07-13 11:44:44 +0300531 >>> with NNTP('news.gmane.org') as n:
Victor Stinnerfa0e3d52011-05-09 01:01:09 +0200532 ... n.group('gmane.comp.python.committers')
533 ...
Ezio Melotti04f648c2011-07-26 09:37:46 +0300534 ('211 1755 1 1755 gmane.comp.python.committers', 1755, 1, 1755, 'gmane.comp.python.committers')
Victor Stinnerfa0e3d52011-05-09 01:01:09 +0200535 >>>
536
537(Contributed by Giampaolo Rodolà in :issue:`9795`)
538
539
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000540os
541--
542
Charles-François Natalia003af12011-06-01 20:30:52 +0200543* The :mod:`os` module has a new :func:`~os.pipe2` function that makes it
544 possible to create a pipe with :data:`~os.O_CLOEXEC` or
545 :data:`~os.O_NONBLOCK` flags set atomically. This is especially useful to
546 avoid race conditions in multi-threaded programs.
547
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +0000548* The :mod:`os` module has a new :func:`~os.sendfile` function which provides
549 an efficent "zero-copy" way for copying data from one file (or socket)
550 descriptor to another. The phrase "zero-copy" refers to the fact that all of
551 the copying of data between the two descriptors is done entirely by the
552 kernel, with no copying of data into userspace buffers. :func:`~os.sendfile`
553 can be used to efficiently copy data from a file on disk to a network socket,
554 e.g. for downloading a file.
Giampaolo Rodolàc9c2c8b2011-02-25 14:39:16 +0000555
Giampaolo Rodolà18e8bcb2011-02-25 20:57:54 +0000556 (Patch submitted by Ross Lagerwall and Giampaolo Rodolà in :issue:`10882`.)
557
558* The :mod:`os` module has two new functions: :func:`~os.getpriority` and
559 :func:`~os.setpriority`. They can be used to get or set process
560 niceness/priority in a fashion similar to :func:`os.nice` but extended to all
561 processes instead of just the current one.
562
563 (Patch submitted by Giampaolo Rodolà in :issue:`10784`.)
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000564
Charles-François Natali7372b062012-02-05 15:15:38 +0100565* The :mod:`os` module has a new :func:`~os.fwalk` function similar to
566 :func:`~os.walk` except that it also yields file descriptors referring to the
567 directories visited. This is especially useful to avoid symlink races.
568
Victor Stinnere5064372011-10-14 00:08:29 +0200569* "at" functions (:issue:`4761`):
570
571 * :func:`~os.faccessat`
572 * :func:`~os.fchmodat`
573 * :func:`~os.fchownat`
574 * :func:`~os.fstatat`
575 * :func:`~os.futimesat`
Victor Stinnere5064372011-10-14 00:08:29 +0200576 * :func:`~os.linkat`
577 * :func:`~os.mkdirat`
578 * :func:`~os.mkfifoat`
579 * :func:`~os.mknodat`
580 * :func:`~os.openat`
581 * :func:`~os.readlinkat`
582 * :func:`~os.renameat`
583 * :func:`~os.symlinkat`
584 * :func:`~os.unlinkat`
585 * :func:`~os.utimensat`
Victor Stinnere5064372011-10-14 00:08:29 +0200586
587* extended attributes (:issue:`12720`):
588
589 * :func:`~os.fgetxattr`
590 * :func:`~os.flistxattr`
591 * :func:`~os.fremovexattr`
592 * :func:`~os.fsetxattr`
593 * :func:`~os.getxattr`
594 * :func:`~os.lgetxattr`
595 * :func:`~os.listxattr`
596 * :func:`~os.llistxattr`
597 * :func:`~os.lremovexattr`
598 * :func:`~os.lsetxattr`
599 * :func:`~os.removexattr`
600 * :func:`~os.setxattr`
601
602* Scheduler functions (:issue:`12655`):
603
604 * :func:`~os.sched_get_priority_max`
605 * :func:`~os.sched_get_priority_min`
606 * :func:`~os.sched_getaffinity`
607 * :func:`~os.sched_getparam`
608 * :func:`~os.sched_getscheduler`
609 * :func:`~os.sched_rr_get_interval`
610 * :func:`~os.sched_setaffinity`
611 * :func:`~os.sched_setparam`
612 * :func:`~os.sched_setscheduler`
613 * :func:`~os.sched_yield`
614
615* Add some extra posix functions to the os module (:issue:`10812`):
616
617 * :func:`~os.fexecve`
618 * :func:`~os.futimens`
Victor Stinnere5064372011-10-14 00:08:29 +0200619 * :func:`~os.futimes`
620 * :func:`~os.lockf`
621 * :func:`~os.lutimes`
Victor Stinnere5064372011-10-14 00:08:29 +0200622 * :func:`~os.posix_fadvise`
623 * :func:`~os.posix_fallocate`
624 * :func:`~os.pread`
625 * :func:`~os.pwrite`
626 * :func:`~os.readv`
627 * :func:`~os.sync`
628 * :func:`~os.truncate`
629 * :func:`~os.waitid`
630 * :func:`~os.writev`
631
632* Other new functions:
633
Charles-François Natali77940902012-02-06 19:54:48 +0100634 * :func:`~os.flistdir` (:issue:`10755`)
Victor Stinnere5064372011-10-14 00:08:29 +0200635 * :func:`~os.getgrouplist` (:issue:`9344`)
636
Giampaolo Rodolà424298a2011-03-03 18:34:06 +0000637
Éric Araujo765e94f2011-06-03 17:26:59 +0200638packaging
639---------
640
641:mod:`distutils` has undergone additions and refactoring under a new name,
642:mod:`packaging`, to allow developers to break backward compatibility.
643:mod:`distutils` is still provided in the standard library, but users are
644encouraged to transition to :mod:`packaging`. For older versions of Python, a
645backport compatible with 2.4+ and 3.1+ will be made available on PyPI under the
646name :mod:`distutils2`.
647
648.. TODO add examples and howto to the packaging docs and link to them
649
650
Victor Stinner383c3fc2011-05-25 01:35:05 +0200651pydoc
652-----
653
Victor Stinner6daa33c2011-05-25 01:41:22 +0200654The Tk GUI and the :func:`~pydoc.serve` function have been removed from the
655:mod:`pydoc` module: ``pydoc -g`` and :func:`~pydoc.serve` have been deprecated
656in Python 3.2.
Victor Stinner383c3fc2011-05-25 01:35:05 +0200657
658
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100659sched
660-----
Victor Stinner754851f2011-04-19 23:58:51 +0200661
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100662* :meth:`~sched.scheduler.run` now accepts a *blocking* parameter which when
663 set to False makes the method execute the scheduled events due to expire
664 soonest (if any) and then return immediately.
665 This is useful in case you want to use the :class:`~sched.scheduler` in
666 non-blocking applications. (Contributed by Giampaolo Rodolà in :issue:`13449`)
Victor Stinner754851f2011-04-19 23:58:51 +0200667
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100668* :class:`~sched.scheduler` class can now be safely used in multi-threaded
669 environments. (Contributed by Josiah Carlson and Giampaolo Rodolà in
670 :issue:`8684`)
671
672* *timefunc* and *delayfunct* parameters of :class:`~sched.scheduler` class
673 constructor are now optional and defaults to :func:`time.time` and
674 :func:`time.sleep` respectively. (Contributed by Chris Clark in
675 :issue:`13245`)
676
677* :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs`
678 *argument* parameter is now optional. (Contributed by Chris Clark in
679 :issue:`13245`)
680
681* :meth:`~sched.scheduler.enter` and :meth:`~sched.scheduler.enterabs`
682 now accept a *kwargs* parameter. (Contributed by Chris Clark in
683 :issue:`13245`)
684
685
686shutil
687------
688
689* The :mod:`shutil` module has these new fuctions:
690
691 * :func:`~shutil.disk_usage`: provides total, used and free disk space
692 statistics. (Contributed by Giampaolo Rodolà in :issue:`12442`)
693 * :func:`~shutil.chown`: allows one to change user and/or group of the given
694 path also specifying the user/group names and not only their numeric
695 ids. (Contributed by Sandro Tosi in :issue:`12191`)
Victor Stinnera9293352011-04-30 15:21:58 +0200696
Victor Stinnerfa0e3d52011-05-09 01:01:09 +0200697
Victor Stinnera9293352011-04-30 15:21:58 +0200698signal
699------
700
Victor Stinnerfa0e3d52011-05-09 01:01:09 +0200701* The :mod:`signal` module has new functions:
Victor Stinnera9293352011-04-30 15:21:58 +0200702
Victor Stinnerb3e72192011-05-08 01:46:11 +0200703 * :func:`~signal.pthread_sigmask`: fetch and/or change the signal mask of the
704 calling thread (Contributed by Jean-Paul Calderone in :issue:`8407`) ;
705 * :func:`~signal.pthread_kill`: send a signal to a thread ;
706 * :func:`~signal.sigpending`: examine pending functions ;
707 * :func:`~signal.sigwait`: wait a signal.
Ross Lagerwallbc808222011-06-25 12:13:40 +0200708 * :func:`~signal.sigwaitinfo`: wait for a signal, returning detailed
709 information about it.
710 * :func:`~signal.sigtimedwait`: like :func:`~signal.sigwaitinfo` but with a
711 timeout.
Victor Stinnera9293352011-04-30 15:21:58 +0200712
Victor Stinnerd49b1f12011-05-08 02:03:15 +0200713* The signal handler writes the signal number as a single byte instead of
714 a nul byte into the wakeup file descriptor. So it is possible to wait more
715 than one signal and know which signals were raised.
716
Victor Stinner388196e2011-05-10 17:13:00 +0200717* :func:`signal.signal` and :func:`signal.siginterrupt` raise an OSError,
718 instead of a RuntimeError: OSError has an errno attribute.
719
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100720smtplib
721-------
722
723The :class:`~smtplib.SMTP_SSL` constructor and the :meth:`~smtplib.SMTP.starttls`
724method now accept an SSLContext parameter to control parameters of the secure
725channel.
726
727(Contributed by Kasun Herath in :issue:`8809`)
728
729
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000730socket
731------
732
Charles-François Natali47413c12011-10-06 19:47:44 +0200733* The :class:`~socket.socket` class now exposes additional methods to process
734 ancillary data when supported by the underlying platform:
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000735
Charles-François Natali47413c12011-10-06 19:47:44 +0200736 * :func:`~socket.socket.sendmsg`
737 * :func:`~socket.socket.recvmsg`
738 * :func:`~socket.socket.recvmsg_into`
Nick Coghlan96fe56a2011-08-22 11:55:57 +1000739
Charles-François Natali47413c12011-10-06 19:47:44 +0200740 (Contributed by David Watson in :issue:`6560`, based on an earlier patch by
741 Heiko Wundram)
742
743* The :class:`~socket.socket` class now supports the PF_CAN protocol family
744 (http://en.wikipedia.org/wiki/Socketcan), on Linux
745 (http://lwn.net/Articles/253425).
746
747 (Contributed by Matthias Fuchs, updated by Tiago Gonçalves in :issue:`10141`)
748
Charles-François Natali10b8cf42011-11-10 19:21:37 +0100749* The :class:`~socket.socket` class now supports the PF_RDS protocol family
750 (http://en.wikipedia.org/wiki/Reliable_Datagram_Sockets and
751 http://oss.oracle.com/projects/rds/).
Victor Stinner754851f2011-04-19 23:58:51 +0200752
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100753
Victor Stinner99c8b162011-05-24 12:05:19 +0200754ssl
755---
756
Antoine Pitrou2c0a9672011-11-17 02:09:13 +0100757* The :mod:`ssl` module has two new random generation functions:
Victor Stinner99c8b162011-05-24 12:05:19 +0200758
759 * :func:`~ssl.RAND_bytes`: generate cryptographically strong
760 pseudo-random bytes.
761 * :func:`~ssl.RAND_pseudo_bytes`: generate pseudo-random bytes.
762
Antoine Pitrou2c0a9672011-11-17 02:09:13 +0100763 (Contributed by Victor Stinner in :issue:`12049`)
764
765* The :mod:`ssl` module now exposes a finer-grained exception hierarchy
766 in order to make it easier to inspect the various kinds of errors.
767
768 (Contributed by Antoine Pitrou in :issue:`11183`)
769
770* :meth:`~ssl.SSLContext.load_cert_chain` now accepts a *password* argument
771 to be used if the private key is encrypted.
772
773 (Contributed by Adam Simpkins in :issue:`12803`)
774
Antoine Pitrou73fc8142011-12-23 20:58:36 +0100775* Diffie-Hellman key exchange, both regular and Elliptic Curve-based, is
776 now supported through the :meth:`~ssl.SSLContext.load_dh_params` and
777 :meth:`~ssl.SSLContext.set_ecdh_curve` methods.
778
779 (Contributed by Antoine Pitrou in :issue:`13626` and :issue:`13627`)
780
Antoine Pitrou2c0a9672011-11-17 02:09:13 +0100781* SSL sockets have a new :meth:`~ssl.SSLSocket.get_channel_binding` method
782 allowing the implementation of certain authentication mechanisms such as
783 SCRAM-SHA-1-PLUS.
784
785 (Contributed by Jacek Konieczny in :issue:`12551`)
786
Antoine Pitrou73fc8142011-12-23 20:58:36 +0100787* You can query the SSL compression algorithm used by an SSL socket, thanks
788 to its new :meth:`~ssl.SSLSocket.compression` method.
789
790 (Contributed by Antoine Pitrou in :issue:`13634`)
791
792
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100793sys
794---
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +0200795
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100796* The :mod:`sys` module has a new :data:`~sys.thread_info` :term:`struct
797 sequence` holding informations about the thread implementation.
Giampaolo Rodola'210e7ca2011-07-01 13:55:36 +0200798
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100799 (:issue:`11223`)
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +0200800
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +0100801
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100802time
803----
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +0100804
Victor Stinnerf4c54ff2012-02-08 01:48:34 +0100805The :mod:`time` module has new functions:
806
807* :func:`~time.clock_getres` and :func:`~time.clock_gettime` functions and
808 ``CLOCK_xxx`` constants.
809* :func:`~time.monotonic`: monotonic clock.
810* :func:`~time.wallclock`.
811
812(Contributed by Victor Stinner in :issue:`10278`)
813
Antoine Pitrou5a8bc6f2011-11-17 02:20:48 +0100814
Senthil Kumarande49d642011-10-16 23:54:44 +0800815urllib
816------
817
818The :class:`~urllib.request.Request` class, now accepts a *method* argument
819used by :meth:`~urllib.request.Request.get_method` to determine what HTTP method
Senthil Kumarana41c9422011-10-20 02:37:08 +0800820should be used. For example, this will send a ``'HEAD'`` request::
Senthil Kumarande49d642011-10-16 23:54:44 +0800821
822 >>> urlopen(Request('http://www.python.org', method='HEAD'))
823
824(:issue:`1673007`)
Giampaolo Rodola'096dcb12011-06-27 11:17:51 +0200825
Giampaolo Rodola'be55d992011-11-22 13:33:34 +0100826
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000827Optimizations
828=============
829
830Major performance enhancements have been added:
831
Victor Stinner46606ce2011-11-20 18:27:55 +0100832* Thanks to the :pep:`393`, some operations on Unicode strings has been optimized:
833
834 * the memory footprint is divided by 2 to 4 depending on the text
Victor Stinnera996f1e2011-11-21 13:14:43 +0100835 * encode an ASCII string to UTF-8 doesn't need to encode characters anymore,
836 the UTF-8 representation is shared with the ASCII representation
Victor Stinner6099a032011-12-18 14:22:26 +0100837 * the UTF-8 encoder has been optimized
838 * repeating a single ASCII letter and getting a substring of a ASCII strings
839 is 4 times faster
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000840
841
842Build and C API Changes
843=======================
844
845Changes to Python's build process and to the C API include:
846
Victor Stinner46606ce2011-11-20 18:27:55 +0100847* The :pep:`393` added new Unicode types, macros and functions:
848
Victor Stinnera996f1e2011-11-21 13:14:43 +0100849 * High-level API:
850
851 * :c:func:`PyUnicode_CopyCharacters`
852 * :c:func:`PyUnicode_FindChar`
853 * :c:func:`PyUnicode_GetLength`, :c:macro:`PyUnicode_GET_LENGTH`
854 * :c:func:`PyUnicode_New`
855 * :c:func:`PyUnicode_Substring`
856 * :c:func:`PyUnicode_ReadChar`, :c:func:`PyUnicode_WriteChar`
857
858 * Low-level API:
859
860 * :c:type:`Py_UCS1`, :c:type:`Py_UCS2`, :c:type:`Py_UCS4` types
861 * :c:type:`PyASCIIObject` and :c:type:`PyCompactUnicodeObject` structures
862 * :c:macro:`PyUnicode_READY`
863 * :c:func:`PyUnicode_FromKindAndData`
864 * :c:func:`PyUnicode_AsUCS4`, :c:func:`PyUnicode_AsUCS4Copy`
865 * :c:macro:`PyUnicode_DATA`, :c:macro:`PyUnicode_1BYTE_DATA`,
866 :c:macro:`PyUnicode_2BYTE_DATA`, :c:macro:`PyUnicode_4BYTE_DATA`
867 * :c:macro:`PyUnicode_KIND` with :c:type:`PyUnicode_Kind` enum:
868 :c:data:`PyUnicode_WCHAR_KIND`, :c:data:`PyUnicode_1BYTE_KIND`,
869 :c:data:`PyUnicode_2BYTE_KIND`, :c:data:`PyUnicode_4BYTE_KIND`
870 * :c:macro:`PyUnicode_READ`, :c:macro:`PyUnicode_READ_CHAR`, :c:macro:`PyUnicode_WRITE`
871 * :c:macro:`PyUnicode_MAX_CHAR_VALUE`
872
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000873
874
Victor Stinnerd1be8782011-12-09 00:10:41 +0100875Deprecated
876==========
877
Georg Brandl0cd25c92011-04-29 13:45:54 +0200878Unsupported Operating Systems
Victor Stinnerd1be8782011-12-09 00:10:41 +0100879-----------------------------
Victor Stinnerb90db4c2011-04-26 22:48:24 +0200880
Brian Curtin49a40cd2011-05-02 22:30:06 -0500881OS/2 and VMS are no longer supported due to the lack of a maintainer.
882
883Windows 2000 and Windows platforms which set ``COMSPEC`` to ``command.com``
884are no longer supported due to maintenance burden.
Victor Stinnerb90db4c2011-04-26 22:48:24 +0200885
886
Victor Stinner46606ce2011-11-20 18:27:55 +0100887Deprecated Python modules, functions and methods
Victor Stinnerd1be8782011-12-09 00:10:41 +0100888------------------------------------------------
Victor Stinner19bd0692011-11-16 00:18:57 +0100889
890* The :mod:`packaging` module replaces the :mod:`distutils` module
891* The ``unicode_internal`` codec has been deprecated because of the
Sandro Tosicd899122012-01-22 12:16:04 +0100892 :pep:`393`, use UTF-8, UTF-16 (``utf-16-le`` or ``utf-16-be``), or UTF-32
893 (``utf-32-le`` or ``utf-32-be``)
Victor Stinner19bd0692011-11-16 00:18:57 +0100894* :meth:`ftplib.FTP.nlst` and :meth:`ftplib.FTP.dir`: use
Victor Stinner46606ce2011-11-20 18:27:55 +0100895 :meth:`ftplib.FTP.mlsd`
Victor Stinner19bd0692011-11-16 00:18:57 +0100896* :func:`platform.popen`: use the :mod:`subprocess` module. Check especially
897 the :ref:`subprocess-replacements` section.
898* :issue:`13374`: The Windows bytes API has been deprecated in the :mod:`os`
Victor Stinner46606ce2011-11-20 18:27:55 +0100899 module. Use Unicode filenames, instead of bytes filenames, to not depend on
Victor Stinner19bd0692011-11-16 00:18:57 +0100900 the ANSI code page anymore and to support any filename.
Florent Xiclunaa72a98f2012-02-13 11:03:30 +0100901* :issue:`13988`: The :mod:`xml.etree.cElementTree` module is deprecated. The
902 accelerator is used automatically whenever available.
Victor Stinner19bd0692011-11-16 00:18:57 +0100903
904
Victor Stinner46606ce2011-11-20 18:27:55 +0100905Deprecated functions and types of the C API
Victor Stinnerd1be8782011-12-09 00:10:41 +0100906-------------------------------------------
Victor Stinner46606ce2011-11-20 18:27:55 +0100907
908The :c:type:`Py_UNICODE` has been deprecated by the :pep:`393` and will be
909removed in Python 4. All functions using this type are deprecated:
910
Victor Stinner46606ce2011-11-20 18:27:55 +0100911Unicode functions and methods using :c:type:`Py_UNICODE` and
912:c:type:`Py_UNICODE*` types:
913
914 * :c:macro:`PyUnicode_FromUnicode`: use :c:func:`PyUnicode_FromWideChar` or
915 :c:func:`PyUnicode_FromKindAndData`
916 * :c:macro:`PyUnicode_AS_UNICODE`, :c:func:`PyUnicode_AsUnicode`,
917 :c:func:`PyUnicode_AsUnicodeAndSize`: use :c:func:`PyUnicode_AsWideCharString`
918 * :c:macro:`PyUnicode_AS_DATA`: use :c:macro:`PyUnicode_DATA` with
919 :c:macro:`PyUnicode_READ` and :c:macro:`PyUnicode_WRITE`
920 * :c:macro:`PyUnicode_GET_SIZE`, :c:func:`PyUnicode_GetSize`: use
921 :c:macro:`PyUnicode_GET_LENGTH` or :c:func:`PyUnicode_GetLength`
922 * :c:macro:`PyUnicode_GET_DATA_SIZE`: use
923 ``PyUnicode_GET_LENGTH(str) * PyUnicode_KIND(str)`` (only work on ready
924 strings)
Victor Stinnerbf6e5602011-12-12 01:53:47 +0100925 * :c:func:`PyUnicode_AsUnicodeCopy`: use :c:func:`PyUnicode_AsUCS4Copy` or
926 :c:func:`PyUnicode_AsWideCharString`
Victor Stinnerab595942011-12-17 04:59:06 +0100927 * :c:func:`PyUnicode_GetMax`
928
Victor Stinner46606ce2011-11-20 18:27:55 +0100929
Victor Stinnera996f1e2011-11-21 13:14:43 +0100930Functions and macros manipulating Py_UNICODE* strings:
931
932 * :c:macro:`Py_UNICODE_strlen`: use :c:func:`PyUnicode_GetLength` or
933 :c:macro:`PyUnicode_GET_LENGTH`
934 * :c:macro:`Py_UNICODE_strcat`: use :c:func:`PyUnicode_CopyCharacters` or
935 :c:func:`PyUnicode_FromFormat`
936 * :c:macro:`Py_UNICODE_strcpy`, :c:macro:`Py_UNICODE_strncpy`,
937 :c:macro:`Py_UNICODE_COPY`: use :c:func:`PyUnicode_CopyCharacters` or
938 :c:func:`PyUnicode_Substring`
939 * :c:macro:`Py_UNICODE_strcmp`: use :c:func:`PyUnicode_Compare`
940 * :c:macro:`Py_UNICODE_strncmp`: use :c:func:`PyUnicode_Tailmatch`
941 * :c:macro:`Py_UNICODE_strchr`, :c:macro:`Py_UNICODE_strrchr`: use
942 :c:func:`PyUnicode_FindChar`
Victor Stinner606e19d2012-01-04 03:59:16 +0100943 * :c:macro:`Py_UNICODE_FILL`: use :c:func:`PyUnicode_Fill`
Victor Stinnerab595942011-12-17 04:59:06 +0100944 * :c:macro:`Py_UNICODE_MATCH`
Victor Stinnera996f1e2011-11-21 13:14:43 +0100945
Victor Stinner46606ce2011-11-20 18:27:55 +0100946Encoders:
947
948 * :c:func:`PyUnicode_Encode`: use :c:func:`PyUnicode_AsEncodedObject`
949 * :c:func:`PyUnicode_EncodeUTF7`
Victor Stinnera996f1e2011-11-21 13:14:43 +0100950 * :c:func:`PyUnicode_EncodeUTF8`: use :c:func:`PyUnicode_AsUTF8` or
951 :c:func:`PyUnicode_AsUTF8String`
Victor Stinner46606ce2011-11-20 18:27:55 +0100952 * :c:func:`PyUnicode_EncodeUTF32`
953 * :c:func:`PyUnicode_EncodeUTF16`
954 * :c:func:`PyUnicode_EncodeUnicodeEscape:` use
955 :c:func:`PyUnicode_AsUnicodeEscapeString`
956 * :c:func:`PyUnicode_EncodeRawUnicodeEscape:` use
957 :c:func:`PyUnicode_AsRawUnicodeEscapeString`
958 * :c:func:`PyUnicode_EncodeLatin1`: use :c:func:`PyUnicode_AsLatin1String`
959 * :c:func:`PyUnicode_EncodeASCII`: use :c:func:`PyUnicode_AsASCIIString`
960 * :c:func:`PyUnicode_EncodeCharmap`
961 * :c:func:`PyUnicode_TranslateCharmap`
962 * :c:func:`PyUnicode_EncodeMBCS`: use :c:func:`PyUnicode_AsMBCSString` or
963 :c:func:`PyUnicode_EncodeCodePage` (with ``CP_ACP`` code_page)
964 * :c:func:`PyUnicode_EncodeDecimal`,
965 :c:func:`PyUnicode_TransformDecimalToASCII`
966
967
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000968Porting to Python 3.3
969=====================
970
971This section lists previously described changes and other bugfixes
Antoine Pitrou037ffbf2011-10-24 00:25:41 +0200972that may require changes to your code.
973
974Porting Python code
975-------------------
Giampaolo Rodolà3108f982011-02-24 20:59:48 +0000976
Victor Stinner19bd0692011-11-16 00:18:57 +0100977* :issue:`12326`: On Linux, sys.platform doesn't contain the major version
Victor Stinnerff3d9392011-08-20 23:39:26 +0200978 anymore. It is now always 'linux', instead of 'linux2' or 'linux3' depending
979 on the Linux version used to build Python. Replace sys.platform == 'linux2'
980 with sys.platform.startswith('linux'), or directly sys.platform == 'linux' if
981 you don't need to support older Python versions.
Éric Araujoc09fca62011-03-23 02:06:24 +0100982
Antoine Pitrou037ffbf2011-10-24 00:25:41 +0200983Porting C code
984--------------
985
986* Due to :ref:`PEP 393 <pep-393>`, the :c:type:`Py_UNICODE` type and all
987 functions using this type are deprecated (but will stay available for
988 at least five years). If you were using low-level Unicode APIs to
989 construct and access unicode objects and you want to benefit of the
990 memory footprint reduction provided by the PEP 393, you have to convert
991 your code to the new :doc:`Unicode API <../c-api/unicode>`.
992
993 However, if you only have been using high-level functions such as
994 :c:func:`PyUnicode_Concat()`, :c:func:`PyUnicode_Join` or
995 :c:func:`PyUnicode_FromFormat()`, your code will automatically take
996 advantage of the new unicode representations.
997
Antoine Pitrouc229e6e2012-02-20 19:41:11 +0100998Building C extensions
999---------------------
1000
1001* The range of possible file names for C extensions has been narrowed.
1002 Very rarely used spellings have been suppressed: under POSIX, files
1003 named ``xxxmodule.so``, ``xxxmodule.abi3.so`` and
1004 ``xxxmodule.cpython-*.so`` are no longer recognized as implementing
1005 the ``xxx`` module. If you had been generating such files, you have
1006 to switch to the other spellings (i.e., remove the ``module`` string
1007 from the file names).
1008
1009 (implemented in :issue:`14040`.)
1010
1011
Antoine Pitrou037ffbf2011-10-24 00:25:41 +02001012Other issues
1013------------
1014
Éric Araujoc09fca62011-03-23 02:06:24 +01001015.. Issue #11591: When :program:`python` was started with :option:`-S`,
1016 ``import site`` will not add site-specific paths to the module search
1017 paths. In previous versions, it did. See changeset for doc changes in
1018 various files. Contributed by Carl Meyer with editions by Éric Araujo.
Éric Araujobe3bd572011-03-26 01:55:15 +01001019
Éric Araujobfc97292011-11-14 18:18:15 +01001020.. Issue #10998: the -Q command-line flag and related artifacts have been
Éric Araujobe3bd572011-03-26 01:55:15 +01001021 removed. Code checking sys.flags.division_warning will need updating.
1022 Contributed by Éric Araujo.